@universal-packages/workflows-jest 1.0.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present David De Anda
+
+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,88 @@
+# Workflows Jest
+
+[![npm version](https://badge.fury.io/js/@universal-packages%2Fworkflows-jest.svg)](https://www.npmjs.com/package/@universal-packages/workflows-jest)
+[![Testing](https://github.com/universal-packages/universal-workflows-jest/actions/workflows/testing.yml/badge.svg)](https://github.com/universal-packages/universal-workflows-jest/actions/workflows/testing.yml)
+[![codecov](https://codecov.io/gh/universal-packages/universal-workflows-jest/branch/main/graph/badge.svg?token=CXPJSN8IGL)](https://codecov.io/gh/universal-packages/universal-workflows-jest)
+
+Jest matchers for [Workflows](https://github.com/universal-packages/universal-workflows) testing.
+
+## Install
+
+```shell
+npm install @universal-packages/workflows-jest
+
+npm install @universal-packages/workflows
+```
+
+## Setup
+
+Add the following to your `jest.config.js` or where you configure Jest:
+
+```js
+module.exports = {
+  setupFilesAfterEnv: ['@universal-packages/workflows-jest']
+}
+```
+
+## Matchers
+
+### toHaveFinishWithStatus
+
+```js
+import { Workflows } from '@universal-packages/workflows'
+
+it('should be successful', async () => {
+  const workflow = await workflowsJest.run('my-workflow')
+
+  expect(workflow).toHaveFinishWithStatus('success')
+})
+```
+
+### toHaveBeenBuildAndRun
+
+```js
+import { runApp } from './src'
+
+workflowsJest.mockRuns()
+
+it('should have been build and run', async () => {
+  await runApp({ development: true })
+
+  expect('development-workflow').toHaveBeenBuildAndRun()
+})
+```
+
+### toHaveBeenBuildAndRunWithVariables
+
+```js
+import { runApp } from './src'
+
+workflowsJest.mockRuns()
+
+it('should have been build and run', async () => {
+  await runApp({ development: true, fast: true })
+
+  expect('development-workflow').toHaveBeenBuildAndRunWithVariables({ fast: true })
+})
+```
+
+## Typescript
+
+In order for typescript to see the global types you need to reference the types somewhere in your project, normally `./src/globals.d.ts`.
+
+```ts
+/// <reference types="@universal-packages/workflows-jest" />
+```
+
+This library is developed in TypeScript and shipped fully typed.
+
+## Contributing
+
+The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.
+
+- [Code of Conduct](./CODE_OF_CONDUCT.md)
+- [Contributing Guide](./CONTRIBUTING.md)
+
+### License
+
+[MIT licensed](./LICENSE).

package/globals.d.ts

@@ -0,0 +1,24 @@
+import { BuildFromOptions, Status, Workflow } from '@universal-packages/workflows';
+interface ProcessMockDescriptor {
+    command: string;
+    env?: Record<string, string>;
+    workingDirectory?: string;
+    result: string;
+}
+interface WorkflowJestRunOptions extends BuildFromOptions {
+    targetMockResults?: ProcessMockDescriptor[];
+}
+declare global {
+    namespace workflowsJest {
+        function run(name: string, options?: WorkflowJestRunOptions): Promise<Workflow>;
+        function mockRuns(): void;
+    }
+    namespace jest {
+        interface Matchers<R> {
+            toHaveFinishWithStatus(status: Status): R;
+            toHaveBeenBuildAndRun(): R;
+            toHaveBeenBuildAndRunWithVariables(variables: Record<string, any>): R;
+        }
+    }
+}
+export {};

package/globals.js

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

package/globals.js.map

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

package/index.d.ts

@@ -0,0 +1 @@
+import './globals';

package/index.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const sub_process_1 = require("@universal-packages/sub-process");
+const workflows_1 = require("@universal-packages/workflows");
+require("./globals");
+const WORKFLOWS_JEST = {
+    mocked: false,
+    ranMockedWorkflows: []
+};
+global.workflowsJest = {
+    run: async (name, options) => {
+        if (options?.targetMockResults) {
+            const { targetMockResults } = options;
+            for (let i = 0; i < targetMockResults.length; i++) {
+                const currentTargetMockResult = targetMockResults[i];
+                const commandParts = currentTargetMockResult.command.split(' ');
+                const actualCommand = commandParts[0];
+                const actualArgs = commandParts.slice(1);
+                sub_process_1.TestEngine.mockProcessEvents({
+                    command: actualCommand,
+                    args: actualArgs,
+                    env: currentTargetMockResult.env,
+                    workingDirectory: currentTargetMockResult.workingDirectory,
+                    events: [{ type: 'stdout', data: currentTargetMockResult.result }]
+                });
+            }
+        }
+        const workflow = workflows_1.Workflow.buildFrom(name, options);
+        workflow.on('**', jest.fn());
+        await workflow.run();
+        return workflow;
+    },
+    mockRuns: () => {
+        WORKFLOWS_JEST.mocked = true;
+        workflows_1.Workflow.buildFrom = (name, options) => {
+            return {
+                run: () => {
+                    WORKFLOWS_JEST.ranMockedWorkflows.push({ name, options });
+                }
+            };
+        };
+    }
+};
+beforeEach(() => {
+    sub_process_1.TestEngine.reset();
+    WORKFLOWS_JEST.ranMockedWorkflows = [];
+});
+function toHaveFinishWithStatus(workflow, status) {
+    const pass = workflow.status === status;
+    if (pass) {
+        return {
+            message: () => `expected "${workflow.name || 'Workflow'}" not to have finished with status ${this.utils.printExpected(status)}`,
+            pass
+        };
+    }
+    else {
+        return {
+            message: () => {
+                const received = workflow.status;
+                return `expected "${workflow.name || 'Workflow'}" to have finished with status ${this.utils.printExpected(status)}, but it finished with status ${this.utils.printReceived(received)}`;
+            },
+            pass
+        };
+    }
+}
+function toHaveBeenBuildAndRun(workflow) {
+    const pass = WORKFLOWS_JEST.ranMockedWorkflows.some((ranWorkflow) => ranWorkflow.name === workflow);
+    if (pass) {
+        return {
+            message: () => `expected "${workflow}" not to have been build and run, but it was`,
+            pass
+        };
+    }
+    else {
+        return {
+            message: () => `expected "${workflow}" to have been build and run, but it was not`,
+            pass
+        };
+    }
+}
+function toHaveBeenBuildAndRunWithVariables(workflow, variables) {
+    const runInstances = WORKFLOWS_JEST.ranMockedWorkflows.filter((ranWorkflow) => ranWorkflow.name === workflow);
+    const pass = runInstances.some((ranWorkflow) => this.equals(ranWorkflow.options?.variables, variables));
+    if (pass) {
+        return {
+            message: () => `expected "${workflow}" not to have been build and run with variables ${this.utils.printExpected(variables)}, but it was`,
+            pass
+        };
+    }
+    else {
+        if (runInstances.length === 0) {
+            return {
+                message: () => `expected "${workflow}" to have been build and run with variables ${this.utils.printExpected(variables)}, but it was not build and run at all`,
+                pass
+            };
+        }
+        else {
+            return {
+                message: () => `expected "${workflow}" to have been build and run with variables ${this.utils.printExpected(variables)}, but it was not`,
+                pass
+            };
+        }
+    }
+}
+globals_1.expect.extend({
+    toHaveFinishWithStatus,
+    toHaveBeenBuildAndRun,
+    toHaveBeenBuildAndRunWithVariables
+});
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,2CAAsC;AACtC,iEAA4D;AAC5D,6DAAkF;AAElF,qBAAkB;AAElB,MAAM,cAAc,GAAG;IACrB,MAAM,EAAE,KAAK;IACb,kBAAkB,EAAE,EAAE;CACvB,CAAA;AAED,MAAM,CAAC,aAAa,GAAG;IACrB,GAAG,EAAE,KAAK,EAAE,IAAY,EAAE,OAAQ,EAAqB,EAAE;QACvD,IAAI,OAAO,EAAE,iBAAiB,EAAE;YAC9B,MAAM,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAA;YAErC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACjD,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;gBACpD,MAAM,YAAY,GAAG,uBAAuB,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBAC/D,MAAM,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;gBACrC,MAAM,UAAU,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAExC,wBAAU,CAAC,iBAAiB,CAAC;oBAC3B,OAAO,EAAE,aAAa;oBACtB,IAAI,EAAE,UAAU;oBAChB,GAAG,EAAE,uBAAuB,CAAC,GAAG;oBAChC,gBAAgB,EAAE,uBAAuB,CAAC,gBAAgB;oBAC1D,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,uBAAuB,CAAC,MAAM,EAAE,CAAC;iBACnE,CAAC,CAAA;aACH;SACF;QAED,MAAM,QAAQ,GAAG,oBAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAElD,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;QAE5B,MAAM,QAAQ,CAAC,GAAG,EAAE,CAAA;QAEpB,OAAO,QAAQ,CAAA;IACjB,CAAC;IACD,QAAQ,EAAE,GAAG,EAAE;QACb,cAAc,CAAC,MAAM,GAAG,IAAI,CAAA;QAC5B,oBAAQ,CAAC,SAAS,GAAG,CAAC,IAAY,EAAE,OAAyB,EAAO,EAAE;YACpE,OAAO;gBACL,GAAG,EAAE,GAAG,EAAE;oBACR,cAAc,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;gBAC3D,CAAC;aACF,CAAA;QACH,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED,UAAU,CAAC,GAAG,EAAE;IACd,wBAAU,CAAC,KAAK,EAAE,CAAA;IAClB,cAAc,CAAC,kBAAkB,GAAG,EAAE,CAAA;AACxC,CAAC,CAAC,CAAA;AAEF,SAAS,sBAAsB,CAAC,QAAkB,EAAE,MAAc;IAChE,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAA;IAEvC,IAAI,IAAI,EAAE;QACR,OAAO;YACL,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,QAAQ,CAAC,IAAI,IAAI,UAAU,sCAAsC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE;YAC/H,IAAI;SACL,CAAA;KACF;SAAM;QACL,OAAO;YACL,OAAO,EAAE,GAAG,EAAE;gBACZ,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAA;gBAChC,OAAO,aAAa,QAAQ,CAAC,IAAI,IAAI,UAAU,kCAAkC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,iCAAiC,IAAI,CAAC,KAAK,CAAC,aAAa,CACxK,QAAQ,CACT,EAAE,CAAA;YACL,CAAC;YACD,IAAI;SACL,CAAA;KACF;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,QAAgB;IAC7C,MAAM,IAAI,GAAG,cAAc,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAA;IAEnG,IAAI,IAAI,EAAE;QACR,OAAO;YACL,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,QAAQ,8CAA8C;YAClF,IAAI;SACL,CAAA;KACF;SAAM;QACL,OAAO;YACL,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,QAAQ,8CAA8C;YAClF,IAAI;SACL,CAAA;KACF;AACH,CAAC;AAED,SAAS,kCAAkC,CAAC,QAAgB,EAAE,SAA8B;IAC1F,MAAM,YAAY,GAAG,cAAc,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAA;IAC7G,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAA;IAEvG,IAAI,IAAI,EAAE;QACR,OAAO;YACL,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,QAAQ,mDAAmD,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,cAAc;YACxI,IAAI;SACL,CAAA;KACF;SAAM;QACL,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,OAAO;gBACL,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,QAAQ,+CAA+C,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,uCAAuC;gBAC7J,IAAI;aACL,CAAA;SACF;aAAM;YACL,OAAO;gBACL,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,QAAQ,+CAA+C,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,kBAAkB;gBACxI,IAAI;aACL,CAAA;SACF;KACF;AACH,CAAC;AAED,gBAAM,CAAC,MAAM,CAAC;IACZ,sBAAsB;IACtB,qBAAqB;IACrB,kCAAkC;CACnC,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@universal-packages/workflows-jest",
+  "version": "1.0.0",
+  "description": "Jest matchers for universal workflows",
+  "author": "David De Anda <david@universal-packages.com> (https://github.com/universal-packages)",
+  "license": "MIT",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "repository": "git@github.com:universal-packages/universal-workflows-jest.git",
+  "scripts": {
+    "build": "tsc --p tsconfig.dis.json",
+    "test": "jest --watch",
+    "test:full": "jest --coverage --verbose",
+    "test:clear": "jest --clearCache",
+    "format": "prettier --write \"./{src,tests}/**/*.{ts,tsx,js,jsx,json}\"",
+    "update-dependents": "umaintenance update-dependents"
+  },
+  "peerDependencies": {
+    "@universal-packages/workflows": "^1.6.0"
+  },
+  "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^4.2.0",
+    "@types/jest": "^29.5.5",
+    "@types/node": "^18.11.9",
+    "@universal-packages/maintenance": "^1.2.5",
+    "jest": "^29.7.0",
+    "prettier": "^3.0.3",
+    "strip-ansi": "^6.0.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "collectCoverageFrom": [
+      "src/**/*.ts"
+    ],
+    "setupFilesAfterEnv": [
+      "<rootDir>/tests/setup.ts"
+    ]
+  },
+  "prettier": {
+    "semi": false,
+    "singleQuote": true,
+    "printWidth": 180,
+    "trailingComma": "none",
+    "plugins": [
+      "@trivago/prettier-plugin-sort-imports"
+    ],
+    "importOrder": [
+      "^[./]"
+    ],
+    "importOrderSeparation": true,
+    "importOrderSortSpecifiers": true,
+    "importOrderParserPlugins": [
+      "typescript",
+      "jsx",
+      "classProperties",
+      "decorators-legacy"
+    ]
+  }
+}