Skip to content

Commit

Permalink
prompt adjusts (#213)
Browse files Browse the repository at this point in the history
* prompt adjusts

* add AbstractAuditingEntity test
  • Loading branch information
mshima committed Oct 15, 2023
1 parent c96ed2b commit 480f0a6
Show file tree
Hide file tree
Showing 6 changed files with 77 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/github-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ jobs:
# Install JHipster and generate project+entities
#----------------------------------------------------------------------
- name: 'PROJECT: generate'
run: 'JHI_PROFILE=${{ matrix.profile }} jhipster-entity-audit generate-sample ${{ matrix.suite }} --build ${{ matrix.build-tool }} --audit-framework ${{ matrix.audit-framework }} --audit-page --no-insight --skip-git --skip-commit-hook --skip-jhipster-dependencies --no-cypress-audit'
run: 'JHI_PROFILE=${{ matrix.profile }} jhipster-entity-audit generate-sample ${{ matrix.suite }} --build ${{ matrix.build-tool }} --audit-framework ${{ matrix.audit-framework }} --audit-page --no-insight --skip-git --skip-commit-hook --skip-jhipster-dependencies --no-cypress-audit --audit-update-type all'
- name: 'TESTS: backend tests'
run: npm run ci:backend:test
- name: 'TESTS: frontend tests'
Expand Down
12 changes: 12 additions & 0 deletions generators/java-audit/__snapshots__/generator.spec.mjs.snap
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,26 @@

exports[`SubGenerator java-audit of entity-audit JHipster blueprint > run > should succeed 1`] = `
{
".jhipster/Audited.json": {
"stateCleared": "modified",
},
".yo-rc.json": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/GeneratedByJHipster.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/domain/Audited.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/domain/package-info.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/package-info.java": {
"stateCleared": "modified",
},
"src/test/java/com/mycompany/myapp/domain/AuditedTest.java": {
"stateCleared": "modified",
},
}
`;
17 changes: 16 additions & 1 deletion generators/java-audit/generator.spec.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,18 @@ describe('SubGenerator java-audit of entity-audit JHipster blueprint', () => {
beforeAll(async function () {
await helpers
.run(SUB_GENERATOR_NAMESPACE)
.withJHipsterConfig()
.withJHipsterConfig({}, [
{
name: 'Audited',
enableAudit: true,
fields: [
{
fieldName: 'name',
fieldType: 'String',
},
],
},
])
.withOptions({
creationTimestamp: '2022-01-01',
ignoreNeedlesError: true,
Expand All @@ -22,5 +33,9 @@ describe('SubGenerator java-audit of entity-audit JHipster blueprint', () => {
it('should succeed', () => {
expect(result.getStateSnapshot()).toMatchSnapshot();
});
it('entities should extend AbstractAuditingEntity', () => {
// TODO remove jhi extension
result.assertFileContent('src/main/java/com/mycompany/myapp/domain/Audited.java.jhi', ' AbstractAuditingEntity<');
});
});
});
33 changes: 33 additions & 0 deletions generators/server/__snapshots__/generator.spec.mjs.snap
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,18 @@ exports[`SubGenerator server of entity-audit JHipster blueprint > run > should s
"src/main/java/com/mycompany/myapp/aop/logging/package-info.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/audit/AsyncEntityAuditEventWriter.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/audit/EntityAuditEventListener.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/audit/EntityAuditEventWriter.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/audit/package-info.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/config/ApplicationProperties.java": {
"stateCleared": "modified",
},
Expand Down Expand Up @@ -173,9 +185,18 @@ exports[`SubGenerator server of entity-audit JHipster blueprint > run > should s
"src/main/java/com/mycompany/myapp/domain/Authority.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/domain/EntityAuditEvent.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/domain/User.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/domain/enumeration/EntityAuditAction.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/domain/enumeration/package-info.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/domain/package-info.java": {
"stateCleared": "modified",
},
Expand All @@ -191,6 +212,9 @@ exports[`SubGenerator server of entity-audit JHipster blueprint > run > should s
"src/main/java/com/mycompany/myapp/repository/AuthorityRepository.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/repository/EntityAuditEventRepository.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/repository/UserRepository.java": {
"stateCleared": "modified",
},
Expand Down Expand Up @@ -263,6 +287,9 @@ exports[`SubGenerator server of entity-audit JHipster blueprint > run > should s
"src/main/java/com/mycompany/myapp/web/rest/AuthenticateController.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/web/rest/EntityAuditResource.java": {
"stateCleared": "modified",
},
"src/main/java/com/mycompany/myapp/web/rest/PublicUserResource.java": {
"stateCleared": "modified",
},
Expand Down Expand Up @@ -326,6 +353,9 @@ exports[`SubGenerator server of entity-audit JHipster blueprint > run > should s
"src/main/resources/config/liquibase/changelog/00000000000000_initial_schema.xml": {
"stateCleared": "modified",
},
"src/main/resources/config/liquibase/changelog/20220101000100_added_entity_EntityAuditEvent.xml": {
"stateCleared": "modified",
},
"src/main/resources/config/liquibase/data/authority.csv": {
"stateCleared": "modified",
},
Expand Down Expand Up @@ -464,6 +494,9 @@ exports[`SubGenerator server of entity-audit JHipster blueprint > run > should s
"src/test/java/com/mycompany/myapp/TechnicalStructureTest.java": {
"stateCleared": "modified",
},
"src/test/java/com/mycompany/myapp/audit/TestEntityAuditEventWriter.java": {
"stateCleared": "modified",
},
"src/test/java/com/mycompany/myapp/config/AsyncSyncConfiguration.java": {
"stateCleared": "modified",
},
Expand Down
12 changes: 8 additions & 4 deletions generators/server/command.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,14 @@ const command = {
},
scope: 'blueprint',
},
updateType: {
auditUpdateType: {
cli: {
type: String,
},
prompt: generator => ({
when: () => generator.blueprintConfig.auditFramework === undefined,
when: answers => (generator.initialRun || generator.options.askAnswered) && ['javers', 'custom'].includes(answers.auditFramework),
type: 'list',
name: 'updateType',
name: 'auditUpdateType',
message: 'Do you want to enable audit for all existing entities?',
choices: [
{ name: 'Yes, update all', value: 'all' },
Expand All @@ -58,10 +61,11 @@ const command = {
type: Array,
},
prompt: gen => ({
when: answers => gen.blueprintConfig.auditFramework === undefined && answers.updateType !== 'all',
when: answers => answers.auditUpdateType === 'selected',
type: 'checkbox',
message: 'Please choose the entities to be audited',
choices: gen.getExistingEntities().map(e => e.name),
default: [],
}),
scope: 'generator',
},
Expand Down
11 changes: 7 additions & 4 deletions generators/server/generator.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,17 @@ import BaseApplicationGenerator from 'generator-jhipster/generators/base-applica
import command from './command.mjs';

export default class extends BaseApplicationGenerator {
initialRun;

constructor(args, opts, features) {
super(args, opts, { ...features, sbsBlueprint: true });
}

get [BaseApplicationGenerator.INITIALIZING]() {
return this.asInitializingTaskGroup({
setInitialRun() {
this.initialRun = this.blueprintConfig.auditFramework === undefined;
},
async initializeOptions() {
this.parseJHipsterCommand(command);
},
Expand All @@ -16,9 +21,7 @@ export default class extends BaseApplicationGenerator {

get [BaseApplicationGenerator.PROMPTING]() {
return this.asPromptingTaskGroup({
async promptingTemplateTask({ control }) {
if (control.existingProject && !this.options.askAnswered) return;

async promptingTemplateTask() {
await this.prompt(this.prepareQuestions(command.configs));
},
});
Expand All @@ -28,7 +31,7 @@ export default class extends BaseApplicationGenerator {
return this.asComposingTaskGroup({
async composingTask() {
if (this.blueprintConfig.auditFramework && this.blueprintConfig.auditFramework !== 'no') {
const auditedEntities = this.updateType === 'all' ? this.getExistingEntities().map(e => e.name) : this.auditedEntities;
const auditedEntities = this.auditUpdateType === 'all' ? this.getExistingEntities().map(e => e.name) : this.auditedEntities;
await this.composeWithJHipster('jhipster-entity-audit:java-audit', { generatorOptions: { auditedEntities } });
}
},
Expand Down

0 comments on commit 480f0a6

Please sign in to comment.