testing: add helpers and migrate to JHipster helpers (#27426)

jhipster · Sep 27, 2024 · 05bd6be · 05bd6be
1 parent a3d7994
commit 05bd6be
Show file tree

Hide file tree

Showing 34 changed files with 760 additions and 500 deletions.
diff --git a/cli/cli.spec.mts b/cli/cli.spec.mts
@@ -90,7 +90,7 @@ const cliSharedBlueprintFiles = {
 describe('cli', () => {
   const __filename = fileURLToPath(import.meta.url);
   const jhipsterCli = join(dirname(__filename), '..', 'bin', 'jhipster.cjs');
-  const logger = { verboseInfo: esmocha.fn(), fatal: esmocha.fn(), debug: esmocha.fn() };
+  const logger = { verboseInfo: esmocha.fn(), warn: esmocha.fn(), fatal: esmocha.fn(), debug: esmocha.fn() };
   const getCommand = esmocha.fn();
   let mockCli;
   let argv;

diff --git a/cli/environment-builder.mjs b/cli/environment-builder.mjs
@@ -75,7 +75,7 @@ export default class EnvironmentBuilder {
    * const promise = require('yeoman-test').create('jhipster:app', {}, {createEnv: EnvironmentBuilder.createEnv}).run();
    *
    * @param {...any} args - Arguments passed to Environment.createEnv().
-   * @return {EnvironmentBuilder} envBuilder
+   * @return {Promise<Environment>} envBuilder
    */
   static async createEnv(...args) {
     const builder = await EnvironmentBuilder.createDefaultBuilder(...args);

diff --git a/cli/utils.mjs b/cli/utils.mjs
@@ -19,7 +19,7 @@
 
 import chalk from 'chalk';
 
-import { CLI_LOGGER, createJHipsterLogger } from '../generators/base/support/index.js';
+import { CLI_LOGGER, createJHipsterLogger } from '../lib/utils/logger.js';
 
 export const CLI_NAME = 'jhipster';
 export const GENERATOR_NAME = 'generator-jhipster';

diff --git a/generators/angular/generator.spec.ts b/generators/angular/generator.spec.ts
@@ -1,4 +1,4 @@
-import { basename, dirname, join } from 'path';
+import { basename, dirname } from 'path';
 import { fileURLToPath } from 'url';
 import { before, describe, expect, it } from 'esmocha';
 import { snakeCase } from 'lodash-es';
@@ -14,7 +14,6 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
 const generator = basename(__dirname);
-const generatorFile = join(__dirname, 'index.ts');
 
 const { ANGULAR: clientFramework } = clientFrameworkTypes;
 const commonConfig = { clientFramework, nativeLanguage: 'en', languages: ['fr', 'en'] };
@@ -88,7 +87,7 @@ describe(`generator - ${clientFramework}`, () => {
     describe(name, () => {
       before(async () => {
         await helpers
-          .run(generatorFile)
+          .runJHipster(generator)
           .withJHipsterConfig(sampleConfig, entities)
           .withSharedApplication({ gatewayServicesApiAvailable: sampleConfig.applicationType === 'gateway' })
           .withControl({ getWebappTranslation: () => 'translations' })

diff --git a/generators/base-application/generator.spec.ts b/generators/base-application/generator.spec.ts
@@ -157,27 +157,30 @@ describe(`generator - ${generator}`, () => {
     }
 
     before(async () => {
-      await helpers.run(CustomGenerator as any).withJHipsterConfig({}, [
-        {
-          name: 'One',
-          fields: [{ fieldName: 'id', fieldType: 'Long' }],
-          relationships: [{ relationshipName: 'two', otherEntityName: 'Two', relationshipType: 'many-to-one' }],
-        },
-        {
-          name: 'Two',
-          fields: [
-            { fieldName: 'id', fieldType: 'Long' },
-            { fieldName: 'name', fieldType: 'String' },
-          ],
-          relationships: [
-            { relationshipName: 'one', otherEntityName: 'One', relationshipType: 'many-to-one' },
-            { relationshipName: 'three', otherEntityName: 'Three', relationshipType: 'many-to-one' },
-          ],
-        },
-        {
-          name: 'Three',
-        },
-      ]);
+      await helpers
+        .run(CustomGenerator as any)
+        .withJHipsterGenerators({ useDefaultMocks: true })
+        .withJHipsterConfig({}, [
+          {
+            name: 'One',
+            fields: [{ fieldName: 'id', fieldType: 'Long' }],
+            relationships: [{ relationshipName: 'two', otherEntityName: 'Two', relationshipType: 'many-to-one' }],
+          },
+          {
+            name: 'Two',
+            fields: [
+              { fieldName: 'id', fieldType: 'Long' },
+              { fieldName: 'name', fieldType: 'String' },
+            ],
+            relationships: [
+              { relationshipName: 'one', otherEntityName: 'One', relationshipType: 'many-to-one' },
+              { relationshipName: 'three', otherEntityName: 'Three', relationshipType: 'many-to-one' },
+            ],
+          },
+          {
+            name: 'Three',
+          },
+        ]);
     });
 
     it('should call priorities with correct arguments', async () => {
@@ -397,6 +400,7 @@ describe(`generator - ${generator}`, () => {
     before(async () => {
       await helpers
         .run(CustomGenerator as any)
+        .withJHipsterGenerators({ useDefaultMocks: true })
         .withJHipsterConfig({}, [
           {
             name: 'One',

diff --git a/generators/base-core/generator.ts b/generators/base-core/generator.ts
@@ -721,15 +721,7 @@ You can ignore this error by passing '--skip-checks' to jhipster command.`);
       if (await this.env.get(namespace)) {
         generator = namespace;
       } else {
-        // Keep test compatibility were jhipster lookup does not run.
-        const found = ['/index.js', '/index.cjs', '/index.mjs', '/index.ts', '/index.cts', '/index.mts'].find(extension => {
-          const pathToLook = join(__dirname, `../${generator}${extension}`);
-          return existsSync(pathToLook) ? pathToLook : undefined;
-        });
-        if (!found) {
-          throw new Error(`Generator ${generator} was not found`);
-        }
-        generator = join(__dirname, `../${generator}${found}`);
+        throw new Error(`Generator ${generator} was not found`);
       }
     }
 

diff --git a/generators/base/blueprints.spec.ts b/generators/base/blueprints.spec.ts
@@ -291,7 +291,11 @@ describe('generator - base - local blueprint', () => {
 
   describe('generates application', () => {
     before(async () => {
-      await helpers.run(BLUEPRINT_NS).withFiles({ '.blueprint/app/index.mjs': BLUEPRINT_CONTENTS }).commitFiles().withJHipsterConfig();
+      await helpers
+        .runJHipster(BLUEPRINT_NS, { useEnvironmentBuilder: true })
+        .withFiles({ '.blueprint/app/index.mjs': BLUEPRINT_CONTENTS })
+        .commitFiles()
+        .withJHipsterConfig();
     });
 
     it('creates expected default files', () => {
@@ -486,7 +490,7 @@ describe('generator - base-blueprint', () => {
       before(() => {
         mockedPriorities = createPrioritiesFakes();
         mockBlueprintSubGen = createAllBlueprint(mockedPriorities);
-        return helpers.run(mockBlueprintSubGen);
+        return helpers.run(mockBlueprintSubGen).withJHipsterGenerators({ useDefaultMocks: true });
       });
 
       priorities.forEach((priority, idx) => {
@@ -541,7 +545,7 @@ describe('generator - base-blueprint', () => {
             return super.end;
           }
         };
-        return helpers.create(mockBlueprintSubGen).run();
+        return helpers.run(mockBlueprintSubGen).withJHipsterGenerators({ useDefaultMocks: true });
       });
 
       priorities.forEach(priority => {

diff --git a/generators/base/generator.spec.ts b/generators/base/generator.spec.ts
@@ -81,9 +81,12 @@ describe(`generator - ${generator}`, () => {
     }
 
     before(async () => {
-      await helpers.run(CustomGenerator as any).withOptions({
-        skipPriorities: ['prompting', 'writing', 'postWriting'],
-      });
+      await helpers
+        .run(CustomGenerator as any)
+        .withJHipsterGenerators({ useDefaultMocks: true })
+        .withOptions({
+          skipPriorities: ['prompting', 'writing', 'postWriting'],
+        });
     });
 
     it('should skip priorities', async () => {

diff --git a/generators/client/generator.spec.ts b/generators/client/generator.spec.ts
@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { basename, dirname, join } from 'path';
+import { basename, dirname } from 'path';
 import { fileURLToPath } from 'url';
 import { snakeCase } from 'lodash-es';
 import { before, describe, expect, it } from 'esmocha';
@@ -32,7 +32,6 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
 const generator = basename(__dirname);
-const generatorFile = join(__dirname, 'index.js');
 
 describe(`generator - ${generator}`, () => {
   it('generator-list constant matches folder name', async () => {
@@ -49,7 +48,7 @@ describe(`generator - ${generator}`, () => {
       const options = { enableTranslation: false };
       before(async () => {
         await helpers
-          .run(generatorFile)
+          .runJHipster(generator)
           .withControl({ getWebappTranslation: () => 'translations' })
           .withJHipsterConfig(options)
           .withSkipWritingPriorities()
@@ -68,7 +67,7 @@ describe(`generator - ${generator}`, () => {
       const options = { enableTranslation: true };
       before(async () => {
         await helpers
-          .run(generatorFile)
+          .runJHipster(generator)
           .withControl({ getWebappTranslation: () => 'translations' })
           .withJHipsterConfig(options)
           .withSkipWritingPriorities()
@@ -87,7 +86,7 @@ describe(`generator - ${generator}`, () => {
       const options = { testFrameworks: [] };
       before(async () => {
         await helpers
-          .run(generatorFile)
+          .runJHipster(generator)
           .withControl({ getWebappTranslation: () => 'translations' })
           .withJHipsterConfig(options)
           .withSkipWritingPriorities()
@@ -109,7 +108,7 @@ describe(`generator - ${generator}`, () => {
       const options = { testFrameworks: [CYPRESS] };
       before(async () => {
         await helpers
-          .run(generatorFile)
+          .runJHipster(generator)
           .withControl({ getWebappTranslation: () => 'translations' })
           .withJHipsterConfig(options)
           .withSkipWritingPriorities()
@@ -139,7 +138,7 @@ describe(`generator - ${generator}`, () => {
     ];
     before(async () => {
       await helpers
-        .run(generatorFile)
+        .runJHipster(generator)
         .withControl({ getWebappTranslation: () => 'translations' })
         .withJHipsterConfig({ applicationType: 'microservice' })
         .withSkipWritingPriorities()

diff --git a/generators/common/generator.spec.ts b/generators/common/generator.spec.ts
@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { basename, dirname, join } from 'path';
+import { basename, dirname } from 'path';
 import { fileURLToPath } from 'url';
 import { before, describe, expect, it } from 'esmocha';
 import { snakeCase } from 'lodash-es';
@@ -30,7 +30,6 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
 const generator = basename(__dirname);
-const generatorFile = join(__dirname, 'index.js');
 
 const mockedGenerators = ['jhipster:git'];
 
@@ -45,7 +44,7 @@ describe(`generator - ${generator}`, () => {
   describe('with', () => {
     describe('default config', () => {
       before(async () => {
-        await helpers.run(generatorFile).withJHipsterConfig().withMockedGenerators(mockedGenerators);
+        await helpers.runJHipster(generator).withJHipsterConfig().withMockedGenerators(mockedGenerators);
       });
 
       it('should succeed', () => {
@@ -59,7 +58,7 @@ describe(`generator - ${generator}`, () => {
     describe('Custom prettier', () => {
       before(async () => {
         await basicHelpers
-          .run(generatorFile)
+          .runJHipster(generator)
           .withJHipsterConfig({
             prettierTabWidth: 10,
           })