@vr1/be-driven-syntax-sugar 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 vr1org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,16 @@
+# @vr1/be-driven-syntax-sugar
+
+Синтаксический сахар, для того чтобы тесты, такие как pw или jest, писать в виде bdd тестов.
+
+# ограничение
+Тест может быть только асинхронным, хотя шаги могут быть и синхронными.
+
+# пример теста
+```
+test('my test', async () => {
+    await scenario((name, type, func) => test.step(`${type} ${name}`, func))
+      .given(givenStep)
+      .when(whenStep)
+      .then(thenStep);
+});
+```

package/build/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./scenario";
+export * from "./types";

package/build/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./scenario"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,0CAAwB"}

package/build/scenario.d.ts

@@ -0,0 +1,3 @@
+import { StepWrapper } from "./types/StepWrapper";
+import { ScenarioFirstStep } from "@vr1/be-driven-interface";
+export declare function scenario(wrapper: StepWrapper): ScenarioFirstStep;

package/build/scenario.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scenario = scenario;
+const testScenario_1 = require("./testScenario");
+function scenario(wrapper) {
+    return new testScenario_1.TestScenario(wrapper);
+}
+//# sourceMappingURL=scenario.js.map

package/build/scenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scenario.js","sourceRoot":"","sources":["../src/scenario.ts"],"names":[],"mappings":";;AAIA,4BAEC;AALD,iDAA8C;AAG9C,SAAgB,QAAQ,CAAC,OAAoB;IAC3C,OAAO,IAAI,2BAAY,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC"}

package/build/testScenario/TestScenario.d.ts

@@ -0,0 +1,13 @@
+import { Scenario } from "@vr1/be-driven-interface";
+import { StepWrapper } from "../types";
+export declare class TestScenario implements Scenario {
+    private wrapper;
+    private steps;
+    constructor(wrapper: StepWrapper);
+    given<TArgs extends any[], TMnemonic extends (...a: TArgs) => void | Promise<void>>(func: TMnemonic, ...args: TArgs): Scenario;
+    when<TArgs extends any[], TMnemonic extends (...a: TArgs) => void | Promise<void>>(func: TMnemonic, ...args: TArgs): Scenario;
+    then<TArgs extends any[], TMnemonic extends (...a: TArgs) => void | Promise<void>>(func: TMnemonic, ...args: TArgs): Scenario;
+    and<TArgs extends any[], TMnemonic extends (...a: TArgs) => void | Promise<void>>(func: TMnemonic, ...args: TArgs): Scenario;
+    split(): Scenario;
+    run(): Promise<void>;
+}

package/build/testScenario/TestScenario.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestScenario = void 0;
+const be_driven_interface_1 = require("@vr1/be-driven-interface");
+const runTest_1 = require("./runTest");
+class TestScenario {
+    wrapper;
+    steps = [];
+    constructor(wrapper) {
+        this.wrapper = wrapper;
+    }
+    given(func, ...args) {
+        this.steps.push(createStep(func, args, be_driven_interface_1.StepType.Given));
+        return this;
+    }
+    when(func, ...args) {
+        this.steps.push(createStep(func, args, be_driven_interface_1.StepType.When));
+        return this;
+    }
+    then(func, ...args) {
+        this.steps.push(createStep(func, args, be_driven_interface_1.StepType.Then));
+        return this;
+    }
+    and(func, ...args) {
+        this.steps.push(createStep(func, args, this.steps[this.steps.length - 1].type));
+        return this;
+    }
+    split() {
+        throw new Error("Splitting test into several tests is not supported in syntax-sugar mode.");
+    }
+    run() {
+        const steps = this.steps;
+        this.steps = null;
+        return (0, runTest_1.runTest)(this.wrapper, steps);
+    }
+}
+exports.TestScenario = TestScenario;
+function createStep(target, args, type) {
+    const stepType = target.stepType ?? type;
+    if (stepType !== type)
+        throw new Error(`Cannot use ${stepType} type of step, ${type} was expected.`);
+    return {
+        name: createName(target, args),
+        target,
+        type,
+        args,
+    };
+}
+function createName(target, args) {
+    return args.reduce((prev, cur, i) => prev.replace(new RegExp(`\\{${i}\\}`, "g"), cur), target.stepName ?? target.name);
+}
+//# sourceMappingURL=TestScenario.js.map

package/build/testScenario/TestScenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestScenario.js","sourceRoot":"","sources":["../../src/testScenario/TestScenario.ts"],"names":[],"mappings":";;;AACA,kEAA8D;AAG9D,uCAAoC;AAEpC,MAAa,YAAY;IAGH;IAFZ,KAAK,GAAe,EAAE,CAAC;IAE/B,YAAoB,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;IAAI,CAAC;IAEtC,KAAK,CAA+E,IAAe,EAAE,GAAG,IAAW;QACxH,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,8BAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,IAAI,CAA+E,IAAe,EAAE,GAAG,IAAW;QACvH,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,8BAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,IAAI,CAA+E,IAAe,EAAE,GAAG,IAAW;QACvH,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,8BAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,GAAG,CAA+E,IAAe,EAAE,GAAG,IAAW;QACtH,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK;QACV,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;IAC9F,CAAC;IAEM,GAAG;QACR,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,OAAO,IAAA,iBAAO,EAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;CACF;AA/BD,oCA+BC;AAED,SAAS,UAAU,CAAC,MAAW,EAAE,IAAW,EAAE,IAAc;IAC1D,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC;IACzC,IAAI,QAAQ,KAAK,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,cAAc,QAAQ,kBAAkB,IAAI,gBAAgB,CAAC,CAAC;IACrG,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC;QAC9B,MAAM;QACN,IAAI;QACJ,IAAI;KACL,CAAC;AACJ,CAAC;AACD,SAAS,UAAU,CAAC,MAAW,EAAE,IAAW;IAC1C,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;AACzH,CAAC"}

package/build/testScenario/TestStep.d.ts

@@ -0,0 +1,7 @@
+import { StepType } from "@vr1/be-driven-interface";
+export interface TestStep {
+    type: StepType;
+    name: string;
+    target: Function;
+    args: any[];
+}

package/build/testScenario/TestStep.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TestStep.js.map

package/build/testScenario/TestStep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestStep.js","sourceRoot":"","sources":["../../src/testScenario/TestStep.ts"],"names":[],"mappings":""}

package/build/testScenario/index.d.ts

@@ -0,0 +1 @@
+export * from "./TestScenario";

package/build/testScenario/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./TestScenario"), exports);
+//# sourceMappingURL=index.js.map

package/build/testScenario/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/testScenario/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B"}

package/build/testScenario/runTest.d.ts

@@ -0,0 +1,3 @@
+import { StepWrapper } from "../types";
+import { TestStep } from "./TestStep";
+export declare function runTest(wrapper: StepWrapper, steps: TestStep[]): Promise<void>;

package/build/testScenario/runTest.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runTest = runTest;
+async function runTest(wrapper, steps) {
+    const store = {};
+    for (let step of steps) {
+        await wrapper(step.type, step.name, async () => {
+            const stepOutput = await step.target.call(store, ...step.args);
+            Object.assign(store, stepOutput);
+        });
+    }
+}
+//# sourceMappingURL=runTest.js.map

package/build/testScenario/runTest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runTest.js","sourceRoot":"","sources":["../../src/testScenario/runTest.ts"],"names":[],"mappings":";;AAGA,0BASC;AATM,KAAK,UAAU,OAAO,CAAC,OAAoB,EAAE,KAAiB;IACnE,MAAM,KAAK,GAAG,EAAE,CAAC;IAEjB,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;YAC7C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/D,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/build/types/StepWrapper.d.ts

@@ -0,0 +1,2 @@
+import { StepType } from "@vr1/be-driven-interface";
+export type StepWrapper = (type: StepType, name: string, func: () => Promise<void>) => Promise<void>;

package/build/types/StepWrapper.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=StepWrapper.js.map

package/build/types/StepWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StepWrapper.js","sourceRoot":"","sources":["../../src/types/StepWrapper.ts"],"names":[],"mappings":""}

package/build/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./StepWrapper";

package/build/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./StepWrapper"), exports);
+//# sourceMappingURL=index.js.map

package/build/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@vr1/be-driven-syntax-sugar",
+  "version": "1.0.0",
+  "description": "syntax sugar to write pw and jest tests in bdd style ",
+  "repository": {
+    "type": "git",
+    "url": "ssh://git@gitverse.ru:2222/vr1/be-driven-syntax-sugar.git"
+  },
+  "license": "MIT",
+  "author": "Vladimir Repin",
+  "type": "commonjs",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "files": [
+    "src",
+    "build"
+  ],
+  "scripts": {
+    "clean": "rm -rf build",
+    "lint": "npx eslint",
+    "compile": "npm run lint && npx tsc",
+    "build": "npm run lint && npx tsc -p ./tsconfig.build.json",
+    "test": "npm run compile && npx jest --coverage=true ./build/test"
+  },
+  "devDependencies": {
+    "@babel/plugin-proposal-decorators": "^7.25.9",
+    "@babel/preset-env": "^7.26.0",
+    "@types/jest": "^29.5.13",
+    "@types/node": "^22.7.5",
+    "@typescript-eslint/eslint-plugin": "^5.61.0",
+    "@typescript-eslint/eslint-plugin-tslint": "^5.61.0",
+    "@typescript-eslint/parser": "^5.61.0",
+    "babel-jest": "^29.7.0",
+    "eslint": "^8.44.0",
+    "eslint-plugin-jsdoc": "^46.4.3",
+    "eslint-plugin-no-null": "^1.0.2",
+    "gulp": "^5.0.0",
+    "jest": "^29.7.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "@vr1/be-driven-interface": "^1.2.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./scenario";
+export * from "./types";

package/src/scenario.ts

@@ -0,0 +1,8 @@
+import { StepWrapper } from "./types/StepWrapper";
+import { TestScenario } from "./testScenario";
+import { ScenarioFirstStep } from "@vr1/be-driven-interface";
+
+export function scenario(wrapper: StepWrapper): ScenarioFirstStep {
+  return new TestScenario(wrapper);
+}
+

package/src/testScenario/TestScenario.ts

@@ -0,0 +1,53 @@
+
+import { Scenario, StepType } from "@vr1/be-driven-interface";
+import { StepWrapper } from "../types";
+import { TestStep } from "./TestStep";
+import { runTest } from "./runTest";
+
+export class TestScenario implements Scenario {
+  private steps: TestStep[] = [];
+
+  constructor(private wrapper: StepWrapper) { }
+
+  public given<TArgs extends any[], TMnemonic extends (...a: TArgs) => void | Promise<void>>(func: TMnemonic, ...args: TArgs): Scenario {
+    this.steps.push(createStep(func, args, StepType.Given));
+    return this;
+  }
+  public when<TArgs extends any[], TMnemonic extends (...a: TArgs) => void | Promise<void>>(func: TMnemonic, ...args: TArgs): Scenario {
+    this.steps.push(createStep(func, args, StepType.When));
+    return this;
+  }
+  public then<TArgs extends any[], TMnemonic extends (...a: TArgs) => void | Promise<void>>(func: TMnemonic, ...args: TArgs): Scenario {
+    this.steps.push(createStep(func, args, StepType.Then));
+    return this;
+  }
+  public and<TArgs extends any[], TMnemonic extends (...a: TArgs) => void | Promise<void>>(func: TMnemonic, ...args: TArgs): Scenario {
+    this.steps.push(createStep(func, args, this.steps[this.steps.length - 1].type));
+    return this;
+  }
+
+  public split(): Scenario {
+    throw new Error("Splitting test into several tests is not supported in syntax-sugar mode.");
+  }
+
+  public run(): Promise<void> {
+    const steps = this.steps;
+    this.steps = null;
+    return runTest(this.wrapper, steps);
+  }
+}
+
+function createStep(target: any, args: any[], type: StepType): TestStep {
+  const stepType = target.stepType ?? type;
+  if (stepType !== type) throw new Error(`Cannot use ${stepType} type of step, ${type} was expected.`);
+  return {
+    name: createName(target, args),
+    target,
+    type,
+    args,
+  };
+}
+function createName(target: any, args: any[]): string {
+  return args.reduce((prev, cur, i) => prev.replace(new RegExp(`\\{${i}\\}`, "g"), cur), target.stepName ?? target.name);
+}
+

package/src/testScenario/TestStep.ts

@@ -0,0 +1,8 @@
+import { StepType } from "@vr1/be-driven-interface";
+
+export interface TestStep {
+  type: StepType;
+  name: string;
+  target: Function;
+  args: any[];
+}

package/src/testScenario/index.ts

@@ -0,0 +1 @@
+export * from "./TestScenario";

package/src/testScenario/runTest.ts

@@ -0,0 +1,13 @@
+import { StepWrapper } from "../types";
+import { TestStep } from "./TestStep";
+
+export async function runTest(wrapper: StepWrapper, steps: TestStep[]): Promise<void> {
+  const store = {};
+
+  for (let step of steps) {
+    await wrapper(step.type, step.name, async () => {
+      const stepOutput = await step.target.call(store, ...step.args);
+      Object.assign(store, stepOutput);
+    });
+  }
+}

package/src/types/StepWrapper.ts

@@ -0,0 +1,3 @@
+import { StepType } from "@vr1/be-driven-interface";
+
+export type StepWrapper = (type: StepType, name: string, func: () => Promise<void>) => Promise<void>;

package/src/types/index.ts

@@ -0,0 +1 @@
+export * from "./StepWrapper";