update generator-jhipster to 8.8.0 (#50)

mshima · jhipster-bot · web-flow · commit 9c8a948e6e31 · 2024-12-24T01:31:57.000Z
Co-authored-by: JHipster Bot &lt;jhipster-bot@jhipster.tech&gt;
diff --git a/.blueprint/generate-sample/command.mjs b/.blueprint/generate-sample/command.mjs
@@ -17,7 +17,9 @@
  * limitations under the License.
  */
 import { GENERATOR_APP } from 'generator-jhipster/generators';
-import { getGithubSamplesGroup } from 'generator-jhipster/testing';
+import { getGithubSamplesGroup, getGithubSamplesGroups } from 'generator-jhipster/testing';
+
+const DEFAULT_SAMPLES_GROUP = 'samples';
 
 /**
  * @type {import('generator-jhipster').JHipsterCommandDefinition}
@@ -34,15 +36,34 @@ const command = {
       cli: {
         type: String,
       },
-      default: 'samples',
+      scope: 'generator',
+    },
+    samplesGroup: {
+      description: 'Samples group to lookup',
+      cli: {
+        type: String,
+      },
+      prompt: gen => ({
+        when: !gen.all && !gen.sampleName,
+        type: 'list',
+        message: 'which sample group do you want to lookup?',
+        choices: async () => getGithubSamplesGroups(gen.templatePath(gen.samplesFolder ?? '')),
+        default: DEFAULT_SAMPLES_GROUP,
+      }),
+      configure: gen => {
+        gen.samplesGroup = DEFAULT_SAMPLES_GROUP;
+      },
       scope: 'generator',
     },
     sampleName: {
       prompt: gen => ({
         when: !gen.all,
         type: 'list',
         message: 'which sample do you want to generate?',
-        choices: async () => getGithubSamplesGroup(gen.templatePath(gen.samplesFolder)),
+        choices: async answers => {
+          const samples = await getGithubSamplesGroup(gen.templatePath(), answers.samplesFolder ?? gen.samplesFolder);
+          return Object.keys(samples.samples);
+        },
       }),
       scope: 'generator',
     },
diff --git a/.blueprint/generate-sample/generator.mjs b/.blueprint/generate-sample/generator.mjs
@@ -5,9 +5,20 @@ import BaseGenerator from 'generator-jhipster/generators/base';
 import { getGithubSamplesGroup } from 'generator-jhipster/testing';
 
 export default class extends BaseGenerator {
+  /** @type {string | undefined} */
+  samplesFolder;
+  /** @type {string} */
+  samplesGroup;
+  /** @type {string} */
   sampleName;
+  /** @type {boolean} */
   all;
-  samplesFolder;
+  /** @type {string} */
+  sampleType;
+  /** @type {string} */
+  sampleFile;
+  /** @type {any} */
+  generatorOptions;
 
   constructor(args, opts, features) {
     super(args, opts, { ...features, queueCommandTasks: true, jhipsterBootstrap: false });
@@ -16,20 +27,33 @@ export default class extends BaseGenerator {
   get [BaseGenerator.WRITING]() {
     return this.asWritingTaskGroup({
       async copySample() {
-        const { samplesFolder, all, sampleName } = this;
+        const { samplesFolder, samplesGroup, all, sampleName } = this;
+        const samplesPath = samplesFolder ? join(samplesFolder, samplesGroup) : samplesGroup;
         if (all) {
-          this.copyTemplate(`${samplesFolder}/*.jdl`, '');
+          this.copyTemplate(`${samplesPath}/*.jdl`, '');
+          this.sampleType = 'jdl';
         } else if (extname(sampleName) === '.jdl') {
-          this.copyTemplate(join(samplesFolder, sampleName), sampleName, { noGlob: true });
+          this.copyTemplate(join(samplesPath, sampleName), sampleName, { noGlob: true });
+          this.sampleType = 'jdl';
         } else {
-          const { samples } = await getGithubSamplesGroup(this.templatePath(), samplesFolder);
-          const { 'sample-type': sampleType } = samples[sampleName];
+          const { samples } = await getGithubSamplesGroup(this.templatePath(), samplesPath);
+          const {
+            'sample-type': sampleType,
+            'sample-file': sampleFile = sampleName,
+            'sample-folder': sampleFolder = samplesPath,
+            generatorOptions,
+          } = samples[sampleName];
+
+          this.generatorOptions = generatorOptions;
+          this.sampleType = sampleType;
+
           if (sampleType === 'jdl') {
-            const jdlFile = `${sampleName}.jdl`;
-            this.copyTemplate(join(samplesFolder, jdlFile), jdlFile, { noGlob: true });
+            const jdlFile = `${sampleFile}.jdl`;
+            this.copyTemplate(join(sampleFolder, jdlFile), jdlFile, { noGlob: true });
           } else if (sampleType === 'yo-rc') {
-            this.copyTemplate(join(samplesFolder, sampleName, '**'), '', {
-              fromBasePath: this.templatesPath(samplesFolder, sampleName),
+            this.copyTemplate('**', '', {
+              fromBasePath: this.templatePath(sampleFolder, sampleFile),
+              globOptions: { dot: true },
             });
           }
         }
@@ -39,17 +63,23 @@ export default class extends BaseGenerator {
 
   get [BaseGenerator.END]() {
     return this.asEndTaskGroup({
-      async generateSample() {
-        const packageJson = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)));
-        const projectVersion = `${packageJson.version}-git`;
+      async generateYoRcSample() {
+        if (this.sampleType !== 'yo-rc') return;
+
+        const generatorOptions = this.getDefaultComposeOptions();
+        await this.composeWithJHipster('app', { generatorOptions });
+      },
+      async generateJdlSample() {
+        if (this.sampleType !== 'jdl') return;
+
+        const generatorOptions = this.getDefaultComposeOptions();
+        const folderContent = await readdir(this.destinationPath());
+        const jdlFiles = folderContent.filter(file => file.endsWith('.jdl'));
 
         await this.composeWithJHipster('jdl', {
-          generatorArgs: this.all ? await readdir(this.templatePath('samples')) : [this.sampleName],
+          generatorArgs: jdlFiles,
           generatorOptions: {
-            skipJhipsterDependencies: true,
-            insight: false,
-            skipChecks: true,
-            projectVersion,
+            ...generatorOptions,
             ...(this.all ? { workspaces: true, monorepository: true } : { skipInstall: true }),
           },
         });
@@ -59,4 +89,14 @@ export default class extends BaseGenerator {
       },
     });
   }
+
+  getDefaultComposeOptions() {
+    const packageJson = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)));
+    const projectVersion = `${packageJson.version}-git`;
+    return {
+      skipJhipsterDependencies: true,
+      projectVersion,
+      ...this.generatorOptions,
+    };
+  }
 }
diff --git a/.blueprint/github-build-matrix/__snapshots__/generator.spec.mjs.snap b/.blueprint/github-build-matrix/__snapshots__/generator.spec.mjs.snap
@@ -0,0 +1,56 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`generator - github-build-matrix > with samples > should match matrix value 1`] = `
+{
+  "include": [
+    {
+      "default-environment": "prod",
+      "java-version": "17",
+      "job-name": "imperative-gradle",
+      "jwt-secret-key": "ZjY4MTM4YjI5YzMwZjhjYjI2OTNkNTRjMWQ5Y2Q0Y2YwOWNmZTE2NzRmYzU3NTMwM2NjOTE3MTllOTM3MWRkMzcyYTljMjVmNmQ0Y2MxOTUzODc0MDhhMTlkMDIxMzI2YzQzZDM2ZDE3MmQ3NjVkODk3OTVmYzljYTQyZDNmMTQ=",
+      "node-version": "22.12.0",
+      "npm-version": "11.0.0",
+      "os": "ubuntu-latest",
+      "sample": "imperative-gradle",
+      "sample-type": "jdl",
+      "samples-group": "samples",
+    },
+    {
+      "default-environment": "prod",
+      "java-version": "17",
+      "job-name": "imperative-maven",
+      "jwt-secret-key": "ZjY4MTM4YjI5YzMwZjhjYjI2OTNkNTRjMWQ5Y2Q0Y2YwOWNmZTE2NzRmYzU3NTMwM2NjOTE3MTllOTM3MWRkMzcyYTljMjVmNmQ0Y2MxOTUzODc0MDhhMTlkMDIxMzI2YzQzZDM2ZDE3MmQ3NjVkODk3OTVmYzljYTQyZDNmMTQ=",
+      "node-version": "22.12.0",
+      "npm-version": "11.0.0",
+      "os": "ubuntu-latest",
+      "sample": "imperative-maven",
+      "sample-type": "jdl",
+      "samples-group": "samples",
+    },
+    {
+      "default-environment": "prod",
+      "java-version": "17",
+      "job-name": "reactive-gradle",
+      "jwt-secret-key": "ZjY4MTM4YjI5YzMwZjhjYjI2OTNkNTRjMWQ5Y2Q0Y2YwOWNmZTE2NzRmYzU3NTMwM2NjOTE3MTllOTM3MWRkMzcyYTljMjVmNmQ0Y2MxOTUzODc0MDhhMTlkMDIxMzI2YzQzZDM2ZDE3MmQ3NjVkODk3OTVmYzljYTQyZDNmMTQ=",
+      "node-version": "22.12.0",
+      "npm-version": "11.0.0",
+      "os": "ubuntu-latest",
+      "sample": "reactive-gradle",
+      "sample-type": "jdl",
+      "samples-group": "samples",
+    },
+    {
+      "default-environment": "prod",
+      "java-version": "17",
+      "job-name": "reactive-maven",
+      "jwt-secret-key": "ZjY4MTM4YjI5YzMwZjhjYjI2OTNkNTRjMWQ5Y2Q0Y2YwOWNmZTE2NzRmYzU3NTMwM2NjOTE3MTllOTM3MWRkMzcyYTljMjVmNmQ0Y2MxOTUzODc0MDhhMTlkMDIxMzI2YzQzZDM2ZDE3MmQ3NjVkODk3OTVmYzljYTQyZDNmMTQ=",
+      "node-version": "22.12.0",
+      "npm-version": "11.0.0",
+      "os": "ubuntu-latest",
+      "sample": "reactive-maven",
+      "sample-type": "jdl",
+      "samples-group": "samples",
+    },
+  ],
+}
+`;
diff --git a/.blueprint/github-build-matrix/command.mjs b/.blueprint/github-build-matrix/command.mjs
@@ -8,6 +8,13 @@ const command = {
       cli: {
         type: String,
       },
+      scope: 'generator',
+    },
+    samplesGroup: {
+      description: 'Samples Group',
+      argument: {
+        type: String,
+      },
       default: 'samples',
       scope: 'generator',
     },
diff --git a/.blueprint/github-build-matrix/generator.mjs b/.blueprint/github-build-matrix/generator.mjs
@@ -1,9 +1,14 @@
+import { join } from 'node:path';
 import BaseGenerator from 'generator-jhipster/generators/base';
 import { convertToGitHubMatrix, getGithubOutputFile, getGithubSamplesGroup, setGithubTaskOutput } from 'generator-jhipster/testing';
 
 export default class extends BaseGenerator {
   /** @type {string} */
   samplesFolder;
+  /** @type {string} */
+  samplesGroup;
+  /** @type {object} */
+  matrix;
 
   constructor(args, opts, features) {
     super(args, opts, { ...features, queueCommandTasks: true, jhipsterBootstrap: false });
@@ -12,16 +17,18 @@ export default class extends BaseGenerator {
   get [BaseGenerator.WRITING]() {
     return this.asWritingTaskGroup({
       async buildMatrix() {
-        const { samplesFolder } = this;
-        const { samples, warnings } = await getGithubSamplesGroup(this.templatePath('../../generate-sample/templates/'), samplesFolder);
+        const { samplesGroup = 'samples' } = this;
+        const templatePath = this.templatePath('../../generate-sample/templates/');
+        const samplesFolder = this.samplesFolder ? join(templatePath, this.samplesFolder) : templatePath;
+        const { samples, warnings } = await getGithubSamplesGroup(samplesFolder, samplesGroup);
         if (warnings.length > 0) {
-          this.info(warnings.join('\n'));
+          this.log.info(warnings.join('\n'));
         }
-        const matrix = JSON.stringify(convertToGitHubMatrix(samples));
-        const githubOutputFile = getGithubOutputFile(matrix);
-        this.log.info('matrix', matrix);
+        this.matrix = convertToGitHubMatrix(samples);
+        const githubOutputFile = getGithubOutputFile();
+        this.log.info('matrix', this.matrix);
         if (githubOutputFile) {
-          setGithubTaskOutput('matrix', matrix);
+          setGithubTaskOutput('matrix', JSON.stringify(this.matrix));
         }
       },
     });
diff --git a/.blueprint/github-build-matrix/generator.spec.mjs b/.blueprint/github-build-matrix/generator.spec.mjs
@@ -0,0 +1,24 @@
+import { basename, dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import { beforeAll, describe, expect, it } from 'vitest';
+import { getGithubSamplesGroups, defaultHelpers as helpers, runResult } from 'generator-jhipster/testing';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const generator = basename(__dirname);
+
+describe(`generator - ${generator}`, async () => {
+  const groups = await getGithubSamplesGroups(join(__dirname, '../generate-sample/templates/'));
+  for (const workflow of groups.map(sample => sample.split('.')[0])) {
+    describe(`with ${workflow}`, () => {
+      beforeAll(async () => {
+        await helpers.runJHipster(join(__dirname, 'index.mjs'), { useEnvironmentBuilder: true }).withArguments(workflow);
+      });
+
+      it('should match matrix value', () => {
+        expect(runResult.generator.matrix).toMatchSnapshot();
+      });
+    });
+  }
+});
diff --git a/.github/workflows/samples.yml b/.github/workflows/samples.yml
@@ -1,4 +1,8 @@
 name: Verify Sample Projects
+concurrency:
+  # Group PRs by head_ref, push to main branch by commit id, and others branch by ref.
+  group: ${{ github.workflow }}-${{ github.head_ref || (github.ref == 'refs/heads/main' && github.sha) || github.ref }}
+  cancel-in-progress: true
 on:
   push:
     branches:
@@ -11,6 +15,8 @@ on:
       - '*'
 permissions:
   contents: read
+env:
+  FORCE_COLOR: 2
 jobs:
   build-matrix:
     runs-on: ubuntu-latest
@@ -26,8 +32,8 @@ jobs:
           npm install
           ./cli/cli.cjs github-build-matrix
   samples:
-    name: ${{ matrix.job-name || matrix.sample-name }}
-    runs-on: ubuntu-latest
+    name: ${{ matrix.job-name || matrix.sample }}
+    runs-on: ${{ matrix.os }}
     needs: build-matrix
     defaults:
       run:
@@ -50,15 +56,15 @@ jobs:
           binary-dir: ${{ github.workspace }}/generator-jhipster-jooq/cli/
       - run: npm install
         working-directory: ${{ github.workspace }}/generator-jhipster-jooq
-      - run: cli.cjs generate-sample ${{ matrix.sample }}.jdl --skip-jhipster-dependencies --skip-install ${{ matrix.extra-args }}
+      - run: cli.cjs generate-sample ${{ matrix.sample }} --skip-jhipster-dependencies --skip-install ${{ matrix.extra-args }}
       - uses: jhipster/actions/compare-sample@v0
         id: compare
         if: >-
           github.event.pull_request &&
           !contains(github.event.pull_request.labels.*.name, 'pr: disable-compare')
         with:
           generator-path: generator-jhipster-jooq
-          cmd: cli.cjs generate-sample ${{ matrix.sample }}.jdl --skip-jhipster-dependencies --skip-install ${{ matrix.extra-args }}
+          cmd: cli.cjs generate-sample ${{ matrix.sample }} --skip-jhipster-dependencies --skip-install ${{ matrix.extra-args }}
       - run: npm run ci:backend:test
         if: steps.compare.outputs.equals != 'true'
         id: backend
@@ -75,15 +81,15 @@ jobs:
         uses: actions/upload-artifact@v4
         if: always() && steps.backend.outcome == 'failure'
         with:
-          name: log-${{ matrix.sample-name }}
+          name: log-${{ matrix.job-name || matrix.sample }}
           path: |
             ${{ github.workspace }}/app/build/test-results/**/*.xml
             ${{ github.workspace }}/app/target/surefire-reports
       - name: Store cypress screenshots
         uses: actions/upload-artifact@v4
         if: always() && steps.e2e.outcome == 'failure'
         with:
-          name: screenshots-${{ matrix.sample-name }}
+          name: screenshots-${{ matrix.job-name || matrix.sample }}
           path: ${{ github.workspace }}/app/**/cypress/screenshots
       - name: Dump docker logs
         if: always()
diff --git a/.gitignore b/.gitignore
@@ -149,5 +149,8 @@ Desktop.ini
 ######################
 # Code coverage
 ######################
-/coverage/
-/.nyc_output/
+coverage/
+.nyc_output/
+
+# added by generate-blueprint:
+generators/**/package-lock.json
diff --git a/.yo-rc.json b/.yo-rc.json
@@ -20,7 +20,7 @@
       }
     },
     "githubWorkflows": true,
-    "jhipsterVersion": "8.7.3",
+    "jhipsterVersion": "8.8.0",
     "js": false,
     "localBlueprint": false,
     "packageJsonType": "module",
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/vitest.config.ts b/vitest.config.ts
diff --git a/vitest.test-setup.ts b/vitest.test-setup.ts

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`}`
`21`	`21`	`},`
`22`	`22`	`"githubWorkflows": true,`
`23`		`- "jhipsterVersion": "8.7.3",`
	`23`	`+ "jhipsterVersion": "8.8.0",`
`24`	`24`	`"js": false,`
`25`	`25`	`"localBlueprint": false,`
`26`	`26`	`"packageJsonType": "module",`