@effectionx/test-adapter 0.3.0 → 0.5.0

package/README.md

@@ -25,9 +25,14 @@ describe("something", () => {
   
   adapter.addSetup(function*() {
     /* do some setup. equivalent of beforeEach() */
-	/* contexts set here will be visible in the test */*
+	/* contexts set here will be visible in the test */
   });
   
+  adapter.addOnetimeSetup(function*() {
+    /* do some setup that will only happen once. equivalent of beforeAll() */
+	/* contexts set here will be visible in the test */
+  });
+
   it("does a thing", async () => {
     await adapter.runTest(function*() {
 	  /* ... the body of the test */

package/esm/mod.d.ts

@@ -1,4 +1,4 @@
-import type { Future, Operation, Scope } from "effection";
+import type { Future, Operation, Result, Scope } from "effection";
 export interface TestOperation {
     (): Operation<void>;
 }
@@ -17,11 +17,6 @@ export interface TestAdapter {
      * ancestors. E.g. `All Tests > File System > write`
      */
     readonly fullname: string;
-    /**
-     * Every test adapter has its own Effection `Scope` which holds the resources necessary
-     * to run this test.
-     */
-    readonly scope: Scope;
     /**
      * A list of this test adapter and every adapter that it descends from.
      */
@@ -30,22 +25,36 @@ export interface TestAdapter {
      * The setup operations that will be run by this test adapter. It only includes those
      * setups that are associated with this adapter, not those of its ancestors.
      */
-    readonly setups: TestOperation[];
+    readonly setup: {
+        all: TestOperation[];
+        each: TestOperation[];
+    };
     /**
      * Add a setup operation to every test that is part of this adapter. In BDD integrations,
      * this is usually called by `beforEach()`
      */
     addSetup(op: TestOperation): void;
+    /**
+     * Add a setup operation that will run exactly once before any tests that are run in this
+     * adapter. In BDD integrations, this is usually called by beforeAll()
+     */
+    addOnetimeSetup(op: TestOperation): void;
     /**
      * Actually run a test. This evaluates all setup operations, and then after those have completed
      * it runs the body of the test itself.
      */
-    runTest(body: TestOperation): Future<void>;
+    runTest(body: TestOperation): Future<Result<void>>;
     /**
      * Teardown this test adapter and all of the task and resources that are running inside it.
      * This basically destroys the Effection `Scope` associated with this adapter.
      */
     destroy(): Future<void>;
+    /**
+     * Used internally to prepare adapters to run test
+     *
+     * @ignore
+     */
+    ["@@init@@"](): Operation<Scope>;
 }
 export interface TestAdapterOptions {
     /**

package/esm/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAG1D,MAAM,WAAW,aAAa;IAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC;IAEjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAE3C;;;OAGG;IACH,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AASD;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,kBAAuB,GAC/B,WAAW,CAwCb"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAGlE,MAAM,WAAW,aAAa;IAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,aAAa,EAAE,CAAC;QAAC,IAAI,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC;IAEhE;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,eAAe,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAEnD;;;OAGG;IACH,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAExB;;;;OAIG;IACH,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AASD;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,kBAAuB,GAC/B,WAAW,CAiFb"}

package/esm/mod.js

@@ -1,4 +1,4 @@
-import { createScope } from "effection";
+import { Err, Ok, run, suspend, useScope, withResolvers } from "effection";
 const anonymousNames = (function* () {
     let count = 1;
     while (true) {
@@ -9,16 +9,18 @@ const anonymousNames = (function* () {
  * Create a new test adapter with the given options.
  */
 export function createTestAdapter(options = {}) {
-    let setups = [];
-    let { parent, name = anonymousNames.next().value } = options;
-    let [scope, destroy] = createScope(parent?.scope);
-    let adapter = {
+    const setup = {
+        all: [],
+        each: [],
+    };
+    const { parent, name = anonymousNames.next().value } = options;
+    let scope = undefined;
+    const adapter = {
         parent,
         name,
-        scope,
-        setups,
+        setup,
         get lineage() {
-            let lineage = [adapter];
+            const lineage = [adapter];
             for (let current = parent; current; current = current.parent) {
                 lineage.unshift(current);
             }
@@ -28,18 +30,53 @@ export function createTestAdapter(options = {}) {
             return adapter.lineage.map((adapter) => adapter.name).join(" > ");
         },
         addSetup(op) {
-            setups.push(op);
+            setup.each.push(op);
+        },
+        addOnetimeSetup(op) {
+            setup.all.push(op);
         },
         runTest(op) {
-            return scope.run(function* () {
-                let allSetups = adapter.lineage.reduce((all, adapter) => all.concat(adapter.setups), []);
-                for (let setup of allSetups) {
-                    yield* setup();
+            return run(() => box(function* () {
+                const setups = adapter.lineage.reduce((all, adapter) => all.concat(adapter.setup.each), []);
+                let scope = yield* adapter["@@init@@"]();
+                let test = yield* scope.spawn(function* () {
+                    for (const setup of setups) {
+                        yield* setup();
+                    }
+                    yield* op();
+                });
+                yield* test;
+            }()));
+        },
+        // no-op that will be replaced once initialze
+        destroy: () => run(function* () { }),
+        *["@@init@@"]() {
+            if (scope) {
+                return scope;
+            }
+            let parentScope = parent
+                ? yield* parent["@@init@@"]()
+                : yield* useScope();
+            let initialized = withResolvers();
+            let task = yield* parentScope.spawn(function* () {
+                scope = yield* useScope();
+                for (let op of setup.all) {
+                    yield* op();
                 }
-                yield* op();
+                initialized.resolve(scope);
+                yield* suspend();
             });
+            adapter.destroy = () => run(task.halt);
+            return yield* initialized.operation;
         },
-        destroy,
     };
     return adapter;
 }
+function* box(op) {
+    try {
+        return Ok(yield* op);
+    }
+    catch (error) {
+        return Err(error);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effectionx/test-adapter",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "author": "engineering@frontside.com",
   "repository": {
     "type": "git",

package/script/mod.d.ts

@@ -1,4 +1,4 @@
-import type { Future, Operation, Scope } from "effection";
+import type { Future, Operation, Result, Scope } from "effection";
 export interface TestOperation {
     (): Operation<void>;
 }
@@ -17,11 +17,6 @@ export interface TestAdapter {
      * ancestors. E.g. `All Tests > File System > write`
      */
     readonly fullname: string;
-    /**
-     * Every test adapter has its own Effection `Scope` which holds the resources necessary
-     * to run this test.
-     */
-    readonly scope: Scope;
     /**
      * A list of this test adapter and every adapter that it descends from.
      */
@@ -30,22 +25,36 @@ export interface TestAdapter {
      * The setup operations that will be run by this test adapter. It only includes those
      * setups that are associated with this adapter, not those of its ancestors.
      */
-    readonly setups: TestOperation[];
+    readonly setup: {
+        all: TestOperation[];
+        each: TestOperation[];
+    };
     /**
      * Add a setup operation to every test that is part of this adapter. In BDD integrations,
      * this is usually called by `beforEach()`
      */
     addSetup(op: TestOperation): void;
+    /**
+     * Add a setup operation that will run exactly once before any tests that are run in this
+     * adapter. In BDD integrations, this is usually called by beforeAll()
+     */
+    addOnetimeSetup(op: TestOperation): void;
     /**
      * Actually run a test. This evaluates all setup operations, and then after those have completed
      * it runs the body of the test itself.
      */
-    runTest(body: TestOperation): Future<void>;
+    runTest(body: TestOperation): Future<Result<void>>;
     /**
      * Teardown this test adapter and all of the task and resources that are running inside it.
      * This basically destroys the Effection `Scope` associated with this adapter.
      */
     destroy(): Future<void>;
+    /**
+     * Used internally to prepare adapters to run test
+     *
+     * @ignore
+     */
+    ["@@init@@"](): Operation<Scope>;
 }
 export interface TestAdapterOptions {
     /**

package/script/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAG1D,MAAM,WAAW,aAAa;IAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC;IAEjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAE3C;;;OAGG;IACH,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AASD;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,kBAAuB,GAC/B,WAAW,CAwCb"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAGlE,MAAM,WAAW,aAAa;IAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,aAAa,EAAE,CAAC;QAAC,IAAI,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC;IAEhE;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,eAAe,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAEnD;;;OAGG;IACH,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAExB;;;;OAIG;IACH,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AASD;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,kBAAuB,GAC/B,WAAW,CAiFb"}

package/script/mod.js

@@ -12,16 +12,18 @@ const anonymousNames = (function* () {
  * Create a new test adapter with the given options.
  */
 function createTestAdapter(options = {}) {
-    let setups = [];
-    let { parent, name = anonymousNames.next().value } = options;
-    let [scope, destroy] = (0, effection_1.createScope)(parent?.scope);
-    let adapter = {
+    const setup = {
+        all: [],
+        each: [],
+    };
+    const { parent, name = anonymousNames.next().value } = options;
+    let scope = undefined;
+    const adapter = {
         parent,
         name,
-        scope,
-        setups,
+        setup,
         get lineage() {
-            let lineage = [adapter];
+            const lineage = [adapter];
             for (let current = parent; current; current = current.parent) {
                 lineage.unshift(current);
             }
@@ -31,18 +33,53 @@ function createTestAdapter(options = {}) {
             return adapter.lineage.map((adapter) => adapter.name).join(" > ");
         },
         addSetup(op) {
-            setups.push(op);
+            setup.each.push(op);
+        },
+        addOnetimeSetup(op) {
+            setup.all.push(op);
         },
         runTest(op) {
-            return scope.run(function* () {
-                let allSetups = adapter.lineage.reduce((all, adapter) => all.concat(adapter.setups), []);
-                for (let setup of allSetups) {
-                    yield* setup();
+            return (0, effection_1.run)(() => box(function* () {
+                const setups = adapter.lineage.reduce((all, adapter) => all.concat(adapter.setup.each), []);
+                let scope = yield* adapter["@@init@@"]();
+                let test = yield* scope.spawn(function* () {
+                    for (const setup of setups) {
+                        yield* setup();
+                    }
+                    yield* op();
+                });
+                yield* test;
+            }()));
+        },
+        // no-op that will be replaced once initialze
+        destroy: () => (0, effection_1.run)(function* () { }),
+        *["@@init@@"]() {
+            if (scope) {
+                return scope;
+            }
+            let parentScope = parent
+                ? yield* parent["@@init@@"]()
+                : yield* (0, effection_1.useScope)();
+            let initialized = (0, effection_1.withResolvers)();
+            let task = yield* parentScope.spawn(function* () {
+                scope = yield* (0, effection_1.useScope)();
+                for (let op of setup.all) {
+                    yield* op();
                 }
-                yield* op();
+                initialized.resolve(scope);
+                yield* (0, effection_1.suspend)();
             });
+            adapter.destroy = () => (0, effection_1.run)(task.halt);
+            return yield* initialized.operation;
         },
-        destroy,
     };
     return adapter;
 }
+function* box(op) {
+    try {
+        return (0, effection_1.Ok)(yield* op);
+    }
+    catch (error) {
+        return (0, effection_1.Err)(error);
+    }
+}