testit-adapter-codecept 1.1.0

package/build/strategies/default-strategy.class.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultStrategy = void 0;
+const attachments_service_1 = require("../services/attachments.service");
+const base_strategy_class_1 = require("./base-strategy.class");
+class DefaultStrategy extends base_strategy_class_1.BaseStrategy {
+    constructor(http, logger, config) {
+        super(http, logger, config);
+        this.http = http;
+        this.logger = logger;
+        this.config = config;
+        this.attachments = new attachments_service_1.AttachmentsService(this.http);
+    }
+    async bootstrap() {
+        await this.http.startRunIfNeeded(this.config.testRunId);
+    }
+    async teardown() {
+        await this.http.completeRunIfNeeded(this.config.testRunId);
+    }
+    async transferTestsToSystem(suite) {
+        await this.createOrUpdateTests(suite);
+    }
+    async transferRunsToSystem(suite) {
+        var _a, _b, _c;
+        for (const test of suite.tests) {
+            const config = this.box.get(test.id);
+            const screenshot = (_a = test.artifacts) === null || _a === void 0 ? void 0 : _a.screenshot;
+            const clientUrls = (_b = config === null || config === void 0 ? void 0 : config.attachments) !== null && _b !== void 0 ? _b : [];
+            if (screenshot) {
+                clientUrls.push(screenshot);
+            }
+            const attachments = await this.attachments.attach(clientUrls);
+            if (config === null || config === void 0 ? void 0 : config.text) {
+                const attach = await this.attachments
+                    .attachTextLikeFile(config.text.content, (_c = config.text) === null || _c === void 0 ? void 0 : _c.name);
+                attachments.push(attach);
+            }
+            const run = this.runsBuilder.build(test, config, attachments);
+            await this.http.updateRuns(run);
+        }
+        this.logger.log(`Test run - ${this.config.testRunId} transferred to remote system`);
+    }
+}
+exports.DefaultStrategy = DefaultStrategy;

package/build/strategies/partial-startegy.class.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="codeceptjs" />
+import { Logger } from '../common/classes/logger.class';
+import { DefaultHttpClient } from '../http/default-http-client.class';
+import { Codecept } from '../types/codecept.type';
+import { Strategy } from '../types/strategy.type';
+import { Origin } from '../types/origin.type';
+import { BaseStrategy } from './base-strategy.class';
+export declare class PartialStrategy extends BaseStrategy implements Strategy {
+    protected readonly http: DefaultHttpClient;
+    protected readonly logger: Logger;
+    protected readonly config: Origin.Config;
+    private readonly attachments;
+    private readonly testsInRun;
+    constructor(http: DefaultHttpClient, logger: Logger, config: Origin.Config);
+    bootstrap(): Promise<void>;
+    teardown(): Promise<void>;
+    beforeTest(test: Codecept.Test): Promise<void>;
+    transferRunsToSystem(suite: any): Promise<void>;
+    transferTestsToSystem(suite: Mocha.Suite): Promise<void>;
+}

package/build/strategies/partial-startegy.class.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PartialStrategy = void 0;
+const use_hash_function_1 = require("../common/functions/use-hash.function");
+const attachments_service_1 = require("../services/attachments.service");
+const base_strategy_class_1 = require("./base-strategy.class");
+class PartialStrategy extends base_strategy_class_1.BaseStrategy {
+    constructor(http, logger, config) {
+        super(http, logger, config);
+        this.http = http;
+        this.logger = logger;
+        this.config = config;
+        this.attachments = new attachments_service_1.AttachmentsService(this.http);
+        this.testsInRun = this.http.getTestsIdsByRunId(this.config.testRunId);
+    }
+    async bootstrap() {
+        await this.http.startRunIfNeeded(this.config.testRunId);
+    }
+    async teardown() {
+        await this.http.completeRunIfNeeded(this.config.testRunId);
+    }
+    async beforeTest(test) {
+        var _a;
+        const tests = await this.testsInRun;
+        const hash = (_a = (0, use_hash_function_1.useDefaultHash)(test)) !== null && _a !== void 0 ? _a : (0, use_hash_function_1.useCompositeHash)(test);
+        if (!tests.includes(hash.toString())) {
+            test.run = () => test.skip();
+        }
+    }
+    async transferRunsToSystem(suite) {
+        const tests = await this.testsInRun;
+        const data = await Promise.all(suite.tests
+            .filter(test => {
+            var _a;
+            const hash = (_a = (0, use_hash_function_1.useDefaultHash)(test)) !== null && _a !== void 0 ? _a : (0, use_hash_function_1.useCompositeHash)(test);
+            return tests.includes(hash.toString());
+        })
+            .map(async (test) => {
+            var _a, _b, _c;
+            const config = this.box.get(test.id);
+            const screenshot = (_a = test.artifacts) === null || _a === void 0 ? void 0 : _a.screenshot;
+            const clientUrls = (_b = config === null || config === void 0 ? void 0 : config.attachments) !== null && _b !== void 0 ? _b : [];
+            if (screenshot) {
+                clientUrls.push(screenshot);
+            }
+            const attachments = await this.attachments.attach(clientUrls);
+            if (config === null || config === void 0 ? void 0 : config.text) {
+                const attach = await this.attachments
+                    .attachTextLikeFile(config.text.content, (_c = config.text) === null || _c === void 0 ? void 0 : _c.name);
+                attachments.push(attach);
+            }
+            return this.runsBuilder.build(test, config, attachments);
+        }));
+        if (data.length) {
+            await this.http.updateManyRuns(data);
+            this.logger.log(`Test run - ${this.config.testRunId} transferred to remote system`);
+        }
+    }
+    async transferTestsToSystem(suite) {
+        const tests = await this.testsInRun;
+        const suiteWithNeededTests = {
+            ...suite,
+            tests: suite.tests.filter((test) => {
+                var _a;
+                const hash = (_a = (0, use_hash_function_1.useDefaultHash)(test)) !== null && _a !== void 0 ? _a : (0, use_hash_function_1.useCompositeHash)(test);
+                return tests.includes(hash.toString());
+            })
+        };
+        await this.createOrUpdateTests(suiteWithNeededTests);
+    }
+}
+exports.PartialStrategy = PartialStrategy;

package/build/strategies/scratch-strategy.class.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="codeceptjs" />
+import { Logger } from '../common/classes/logger.class';
+import { DefaultHttpClient } from '../http/default-http-client.class';
+import { Strategy } from '../types/strategy.type';
+import { Origin } from '../types/origin.type';
+import { BaseStrategy } from './base-strategy.class';
+export declare class ScratchStrategy extends BaseStrategy implements Strategy {
+    protected readonly http: DefaultHttpClient;
+    protected readonly logger: Logger;
+    protected readonly config: Origin.Config;
+    private readonly attachments;
+    private run;
+    constructor(http: DefaultHttpClient, logger: Logger, config: Origin.Config);
+    bootstrap(): Promise<void>;
+    teardown(): Promise<void>;
+    transferTestsToSystem(suite: Mocha.Suite): Promise<void>;
+    transferRunsToSystem(suite: any): Promise<void>;
+}

package/build/strategies/scratch-strategy.class.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScratchStrategy = void 0;
+const attachments_service_1 = require("../services/attachments.service");
+const base_strategy_class_1 = require("./base-strategy.class");
+class ScratchStrategy extends base_strategy_class_1.BaseStrategy {
+    constructor(http, logger, config) {
+        super(http, logger, config);
+        this.http = http;
+        this.logger = logger;
+        this.config = config;
+        this.attachments = new attachments_service_1.AttachmentsService(this.http);
+    }
+    async bootstrap() {
+        var _a;
+        const run = await this.http.createEmptyRun((_a = this.config.testRunName) !== null && _a !== void 0 ? _a : '');
+        if (run) {
+            await this.http.startRunIfNeeded(run.id);
+            this.run = run;
+        }
+    }
+    async teardown() {
+        await this.http.completeRunIfNeeded(this.run.id);
+    }
+    async transferTestsToSystem(suite) {
+        await this.createOrUpdateTests(suite);
+    }
+    async transferRunsToSystem(suite) {
+        var _a, _b, _c;
+        for (const test of suite.tests) {
+            const config = this.box.get(test.id);
+            const screenshot = (_a = test.artifacts) === null || _a === void 0 ? void 0 : _a.screenshot;
+            const clientUrls = (_b = config === null || config === void 0 ? void 0 : config.attachments) !== null && _b !== void 0 ? _b : [];
+            if (screenshot) {
+                clientUrls.push(screenshot);
+            }
+            const attachments = await this.attachments.attach(clientUrls);
+            if (config === null || config === void 0 ? void 0 : config.text) {
+                const attach = await this.attachments
+                    .attachTextLikeFile(config.text.content, (_c = config.text) === null || _c === void 0 ? void 0 : _c.name);
+                attachments.push(attach);
+            }
+            const data = this.runsBuilder.build(test, config, attachments);
+            await this.http.updateRuns(data, this.run.id);
+        }
+        this.logger.log(`Test run - ${this.run.id} transferred to remote system`);
+    }
+}
+exports.ScratchStrategy = ScratchStrategy;

package/build/strategies/strategy.factory.d.ts

@@ -0,0 +1,8 @@
+import { Logger } from '../common/classes/logger.class';
+import { DefaultHttpClient } from '../http/default-http-client.class';
+import { Strategy } from '../types/strategy.type';
+import { Origin } from '../types/origin.type';
+export type AdapterMode = 0 | 1 | 2;
+export declare class StrategyFactory {
+    static create(http: DefaultHttpClient, logger: Logger, config: Origin.Config): Strategy;
+}

package/build/strategies/strategy.factory.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StrategyFactory = void 0;
+const default_strategy_class_1 = require("./default-strategy.class");
+const partial_startegy_class_1 = require("./partial-startegy.class");
+const scratch_strategy_class_1 = require("./scratch-strategy.class");
+class StrategyFactory {
+    static create(http, logger, config) {
+        var _a;
+        const strategies = {
+            0: () => new partial_startegy_class_1.PartialStrategy(http, logger, config),
+            1: () => new default_strategy_class_1.DefaultStrategy(http, logger, config),
+            2: () => new scratch_strategy_class_1.ScratchStrategy(http, logger, config)
+        };
+        if (!strategies[config === null || config === void 0 ? void 0 : config.adapterMode]) {
+            logger.warn(`This mode ${config === null || config === void 0 ? void 0 : config.adapterMode} is invalid. Use mode 0, 1, 2`);
+        }
+        return strategies[(_a = config === null || config === void 0 ? void 0 : config.adapterMode) !== null && _a !== void 0 ? _a : 0]();
+    }
+}
+exports.StrategyFactory = StrategyFactory;

package/build/types/codecept.type.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="codeceptjs" />
+export declare namespace Codecept {
+    type Status = 'success' | 'failure';
+    interface Step {
+        name: string;
+        args: string[];
+        status: Status;
+        duration: number;
+        startTime: number;
+        endTime: number;
+        finishedAt: number;
+        steps: Step[];
+        startedAt: number;
+    }
+    interface Test<T = any> extends Mocha.Test {
+        id: string;
+        steps: Step[];
+        startedAt: number;
+        config: any;
+        inject: any;
+        artifacts: any;
+        err?: {
+            cliMessage?: () => string;
+        };
+        opts: T;
+    }
+}

package/build/types/codecept.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/types/origin.type.d.ts

@@ -0,0 +1,44 @@
+import { LinkPost } from 'testit-api-client';
+import { AdapterMode } from '../strategies/strategy.factory';
+export declare namespace Origin {
+    interface TestConfig {
+        title?: string;
+        displayName?: string;
+        description?: string;
+        externalId?: string;
+        links: LinkPost[];
+        labels?: string[];
+        workitemIds?: [];
+    }
+    interface TestText {
+        name: string;
+        content: string;
+    }
+    interface TestMetadata {
+        links?: LinkPost[];
+        attachments?: string[];
+        message?: string;
+        text?: TestText;
+    }
+    interface Config {
+        url?: string;
+        privateToken?: string;
+        projectId?: string;
+        configurationId?: string;
+        testRunId?: string;
+        testRunName?: string;
+        adapterMode?: AdapterMode;
+        configFile?: string;
+        __DEV?: boolean;
+    }
+    type EnvironmentsConfig = Partial<{
+        TMS_URL: string;
+        TMS_PRIVATE_TOKEN: string;
+        TMS_PROJECT_ID: string;
+        TMS_CONFIGURATION_ID: string;
+        TMS_TEST_RUN_ID: string;
+        TMS_TEST_RUN_NAME: string;
+        TMS_ADAPTER_MODE: AdapterMode;
+        TMS_CONFIG_FILE: string;
+    }>;
+}

package/build/types/origin.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/types/strategy.type.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="codeceptjs" />
+import { Origin } from './origin.type';
+export interface Strategy {
+    bootstrap(): Promise<any>;
+    teardown(): Promise<any>;
+    beforeTest(test: Mocha.Test): Promise<void>;
+    transferTestsToSystem(suite: Mocha.Suite): Promise<void>;
+    transferRunsToSystem(suite: Mocha.Suite): Promise<void>;
+    collect(id: string, data: Origin.TestMetadata): void;
+}

package/build/types/strategy.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "testit-adapter-codecept",
+  "version": "1.1.0",
+  "description": "Codecept adapter for TestIT",
+  "keywords": [],
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "build": "run-p build:*",
+    "build:main": "tsc -p tsconfig.publish.json",
+    "build:dev": "tsc -p tsconfig.json",
+    "publish:local": "npm run build:main && npm pack --pack-destination ~/Packages",
+    "watch:dev": "tsc -p tsconfig.publish.json -w",
+    "test": "jest"
+  },
+  "dependencies": {
+    "dotenv": "^16.0.3",
+    "npm-run-all": "^4.1.5",
+    "testit-api-client": "^1.0.5"
+  },
+  "devDependencies": {
+    "@codeceptjs/configure": "^0.10.0",
+    "@codeceptjs/examples": "^1.2.1",
+    "@codeceptjs/ui": "^0.4.7",
+    "@types/jest": "^29.2.2",
+    "@types/node": "^18.11.9",
+    "@typescript-eslint/eslint-plugin": "^5.42.0",
+    "@typescript-eslint/parser": "^5.42.0",
+    "codeceptjs": "^3.3.6",
+    "eslint": "^8.27.0",
+    "jest": "^29.2.2",
+    "playwright": "^1.27.1",
+    "prettier": "2.7.1",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4"
+  },
+  "bugs": {
+    "url": "https://github.com/testit-tms/adapters-js/issues"
+  },
+  "homepage": "https://github.com/testit-tms/adapters-js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/testit-tms/adapters-js.git"
+  }
+}