add beforeStart

etc/test-helpers.api.md

@@ -9,6 +9,9 @@ import { IFetchComponent } from '@well-known-components/http-server';
 import { Lifecycle } from '@well-known-components/interfaces';
 import { default as sinon_2 } from 'sinon';
 
+// @public (undocumented)
+export type BeforeStartFunction<TestComponents extends Record<string, any> = any> = () => Promise<void> | void;
+
 // @public
 export function createLocalFetchCompoment(configComponent: IConfigComponent): Promise<IFetchComponent>;
 
@@ -27,9 +30,9 @@ export type TestArguments<TestComponents extends Record<string, any>> = {
     stubComponents: {
         readonly [T in keyof TestComponents]: sinon_2.SinonStubbedInstance<TestComponents[T]>;
     };
+    beforeStart(fn: BeforeStartFunction<TestComponents>): void;
 };
 
-
 // (No @packageDocumentation comment for this package)
 
 ```

src/index.ts

@@ -11,8 +11,15 @@ export type TestArguments<TestComponents extends Record<string, any>> = {
   stubComponents: {
     readonly [T in keyof TestComponents]: sinon.SinonStubbedInstance<TestComponents[T]>
   }
+
+  /**
+   * Functions to run before the Lifecycle helpers start the components' lifecycle
+   */
+  beforeStart(fn: BeforeStartFunction<TestComponents>): void
 }
 
+export type BeforeStartFunction<TestComponents extends Record<string, any> = any> = () => Promise<void> | void
+
 export { createLocalFetchCompoment, defaultServerConfig } from "./localFetch"
 
 declare var before: typeof beforeAll
@@ -56,6 +63,8 @@ export function createRunner<TestComponents extends Record<string, any>>(
       return stubComponentInstances.get(key)!
     }
 
+    const beforeStartFunctions: BeforeStartFunction[] = []
+
     const testArgs: TestArguments<TestComponents> = {
       components: new Proxy(
         {},
@@ -73,10 +82,15 @@ export function createRunner<TestComponents extends Record<string, any>>(
           },
         }
       ) as any,
+      beforeStart(fn) {
+        beforeStartFunctions.push(fn)
+      },
     }
 
     describe(name, () => {
       _beforeAll(async () => {
+        jest.resetModules()
+        for (let fn of beforeStartFunctions) await fn()
         program = await Lifecycle.run<TestComponents>(options)
       })
 
@@ -86,10 +100,12 @@ export function createRunner<TestComponents extends Record<string, any>>(
         // reset spy objects
         sinon.reset()
         sinon.resetBehavior()
+        jest.resetAllMocks()
       })
 
       afterEach(() => {
         sandbox.restore()
+        jest.restoreAllMocks()
       })
 
       suite(testArgs)

test/simple-smoke-test/beforeStart.spec.ts

@@ -0,0 +1,38 @@
+import { createRunner } from "../../src"
+
+type Components = {
+  config: {
+    readonly getValue: string
+  }
+}
+
+const AAA_VALUE = Math.random().toString()
+
+const test = createRunner<Components>({
+  async main(program) {
+    await program.startComponents()
+  },
+  async initComponents() {
+    const config = {
+      start() {
+        expect(process.env.AAA).toEqual(AAA_VALUE)
+      },
+      get getValue() {
+        expect(process.env.AAA).toEqual(AAA_VALUE)
+        return process.env.AAA!
+      },
+    }
+
+    return { config }
+  },
+})
+
+test("beforeStart works", ({ beforeStart, components }) => {
+  beforeStart(async () => {
+    process.env.AAA = AAA_VALUE
+  })
+  it("works", () => {
+    expect(components.config.getValue).toEqual(AAA_VALUE)
+    delete process.env.AAA
+  })
+})

tsconfig.json

@@ -5,6 +5,7 @@
     "declaration": true, /* Generates corresponding '.d.ts' file. */
     "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
     "sourceMap": true, /* Generates corresponding '.map' file. */
+    "stripInternal": true,
     "types": [
       "node",
       "jest"