yeoman-test 9.0.0 → 9.2.0

package/dist/run-context.d.ts

@@ -69,6 +69,7 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
     private ran;
     private errored;
     private readonly beforePrepareCallbacks;
+    private environmentRun?;
     /**
      * This class provide a run context object to façade the complexity involved in setting
      * up a generator for testing
@@ -153,6 +154,13 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
      * @return {this} run context instance
      */
     withEnvironment(callback: any): this;
+    /**
+     * Customize enviroment run method.
+     *
+     * @param callback
+     * @return {this} run context instance
+     */
+    withEnvironmentRun(callback: (this: this, env: DefaultEnvironmentApi, gen: GeneratorType) => void): this;
     /**
      * Run lookup on the environment.
      *

package/dist/run-context.js

@@ -46,6 +46,7 @@ export class RunContextBase extends EventEmitter {
     ran = false;
     errored = false;
     beforePrepareCallbacks = [];
+    environmentRun;
     /**
      * This class provide a run context object to façade the complexity involved in setting
      * up a generator for testing
@@ -81,7 +82,8 @@ export class RunContextBase extends EventEmitter {
             await this.build();
         }
         try {
-            await this.env.runGenerator(this.generator);
+            const environmentRun = this.environmentRun ?? ((env, generator) => env.runGenerator(generator));
+            await environmentRun.call(this, this.env, this.generator);
         }
         finally {
             this.helpers.restorePrompt(this.env);
@@ -215,6 +217,16 @@ export class RunContextBase extends EventEmitter {
         this.envCB = callback;
         return this;
     }
+    /**
+     * Customize enviroment run method.
+     *
+     * @param callback
+     * @return {this} run context instance
+     */
+    withEnvironmentRun(callback) {
+        this.environmentRun = callback;
+        return this;
+    }
     /**
      * Run lookup on the environment.
      *

package/dist/run-result.d.ts

@@ -1,7 +1,8 @@
+import { type mock } from 'node:test';
 import type { Store } from 'mem-fs';
 import { type MemFsEditor, type MemFsEditorFile } from 'mem-fs-editor';
 import type { BaseEnvironmentOptions, BaseGenerator, GetGeneratorConstructor } from '@yeoman/types';
-import type { DefaultEnvironmentApi, DefaultGeneratorApi } from '../types/type-helpers.js';
+import type { DefaultEnvironmentApi } from '../types/type-helpers.js';
 import { type RunContextSettings } from './run-context.js';
 import { type YeomanTest } from './helpers.js';
 import { type AskedQuestions } from './adapter.js';
@@ -56,7 +57,7 @@ export default class RunResult<GeneratorType extends BaseGenerator = BaseGenerat
      * Create another RunContext reusing the settings.
      * See helpers.create api
      */
-    create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, environmentOptions?: BaseEnvironmentOptions): import("./run-context.js").default<GeneratorType>;
+    create<G extends BaseGenerator = GeneratorType>(GeneratorOrNamespace: string | GetGeneratorConstructor<G>, settings?: RunContextSettings, environmentOptions?: BaseEnvironmentOptions): import("./run-context.js").default<G>;
     getSpawnArgsUsingDefaultImplementation(): unknown[][];
     /**
      * Return an object with fs changes.
@@ -218,4 +219,36 @@ export default class RunResult<GeneratorType extends BaseGenerator = BaseGenerat
      * @param content An object of key/values the file should not contain
      */
     assertNoJsonFileContent(filename: string, content: Record<string, any>): void;
+    /**
+     * Get the generator mock
+     * @param generator - the namespace of the mocked generator
+     * @returns the generator mock
+     */
+    getGeneratorMock(generator: string): ReturnType<typeof mock.fn>['mock'];
+    /**
+     * Get the number of times a mocked generator was composed
+     * @param generator - the namespace of the mocked generator
+     * @returns the number of times the generator was composed
+     */
+    getGeneratorComposeCount(generator: string): number;
+    /**
+     * Assert that a generator was composed
+     * @param generator - the namespace of the mocked generator
+     */
+    assertGeneratorComposed(generator: string): void;
+    /**
+     * Assert that a generator was composed
+     * @param generator - the namespace of the mocked generator
+     */
+    assertGeneratorNotComposed(generator: string): void;
+    /**
+     * Assert that a generator was composed only once
+     * @param generator - the namespace of the mocked generator
+     */
+    assertGeneratorComposedOnce(generator: string): void;
+    /**
+     * Assert that a generator was composed multiple times
+     * @returns an array of the names of the mocked generators that were composed
+     */
+    getComposedGenerators(): string[];
 }

package/dist/run-result.js

@@ -262,4 +262,55 @@ export default class RunResult {
     assertNoJsonFileContent(filename, content) {
         this.assertNoObjectContent(this._readFile(filename, true), content);
     }
+    /**
+     * Get the generator mock
+     * @param generator - the namespace of the mocked generator
+     * @returns the generator mock
+     */
+    getGeneratorMock(generator) {
+        const mockedGenerator = this.mockedGenerators[generator];
+        if (!mockedGenerator) {
+            throw new Error(`Generator ${generator} is not mocked`);
+        }
+        return mockedGenerator.mock;
+    }
+    /**
+     * Get the number of times a mocked generator was composed
+     * @param generator - the namespace of the mocked generator
+     * @returns the number of times the generator was composed
+     */
+    getGeneratorComposeCount(generator) {
+        return this.getGeneratorMock(generator).callCount();
+    }
+    /**
+     * Assert that a generator was composed
+     * @param generator - the namespace of the mocked generator
+     */
+    assertGeneratorComposed(generator) {
+        assert.ok(this.getGeneratorComposeCount(generator) > 0, `Generator ${generator} is not composed`);
+    }
+    /**
+     * Assert that a generator was composed
+     * @param generator - the namespace of the mocked generator
+     */
+    assertGeneratorNotComposed(generator) {
+        const composeCount = this.getGeneratorComposeCount(generator);
+        assert.ok(composeCount === 0, `Generator ${generator} is composed ${composeCount}`);
+    }
+    /**
+     * Assert that a generator was composed only once
+     * @param generator - the namespace of the mocked generator
+     */
+    assertGeneratorComposedOnce(generator) {
+        assert.ok(this.getGeneratorComposeCount(generator) === 1, `Generator ${generator} is not composed`);
+    }
+    /**
+     * Assert that a generator was composed multiple times
+     * @returns an array of the names of the mocked generators that were composed
+     */
+    getComposedGenerators() {
+        return Object.entries(this.mockedGenerators)
+            .filter(([_generator, mockedGenerator]) => mockedGenerator.mock.callCount() > 0)
+            .map(([generator]) => generator);
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-test",
-  "version": "9.0.0",
+  "version": "9.2.0",
   "description": "Test utilities for Yeoman generators",
   "keywords": [
     "yeoman",