testit-adapter-codecept 1.1.0 → 1.1.2

package/README.md

@@ -1,198 +1,208 @@
-# Test IT TMS adapters for Codecept
-![Test IT](https://raw.githubusercontent.com/testit-tms/adapters-js/master/images/banner.png)
-
-## Getting Started
-
-### Compatibility
-
-| Test IT | Adapter |
-|---------|---------|
-| 3.5     | 1.0     |
-|---------|---------|
-| 4.0     | 1.1     |
-
-### Installation
-```
-npm install testit-adapter-codecept
-```
-
-## Usage
-
-### API client
-
-To use adapter you need to install `testit-api-client`:
-```
-npm install testit-api-client
-```
-
-### Configuration
-
-Add TestITHelper and TestITPlugin to Codecept file configuration 
-
-```ts
-export const config: CodeceptJS.MainConfig = {
-  tests: './**/*_test.ts',
-  output: './output',
-  helpers: {
-    Playwright: {
-      url: 'http://localhost',
-      show: false,
-      browser: 'chromium'
-    },
-    TestITHelper: {
-      require: 'testit-adapter-codecept/build/helper.js'
-    }
-  },
-  plugins: {
-    TestITPlugin: {
-      require: 'testit-adapter-codecept/build/bootstrap.js',
-      enabled: true
-    }
-  },
-  include: {},
-  name: 'codecept-test-it-testing'
-}
-```
-
-Create step.d.ts file and import TestMetadataHelper
-
-```ts
-type TestITHelper = import('testit-adapter-codecept/build/helper').TestMetadataHelper;
-
-declare namespace CodeceptJS {
-  interface SupportObject { I: I, current: any }
-  interface Methods extends Playwright, TestITHelper {}
-  interface I extends WithTranslation<Methods>{}
-  namespace Translation {
-    interface Actions {}
-  }
-}
-```
-
-#### File
-
-1. Create .env config or file config with default name testit-adapter.config.json in the root directory of the project
-
-```json
-{
-  "url": "example-project-url",
-  "projectId": "example-project-id",
-  "testRunId": "example-project-run-id",
-  "configurationId": "example-project-configuration-id",
-  "adapterMode": "example-adapter-mode",
-  "testRunName": "example-test-run-name"
-}
-```
-
-2. Fill parameters with your configuration, where:  
-    * `url` - location of the TMS instance  
-      
-    * `privateToken` - API secret key
-        1. go to the https://{DOMAIN}/user-profile profile
-        2. copy the API secret key
-    
-    * `projectId` - ID of project in TMS instance.
-    
-        1. create a project
-        2. open DevTools -> network
-        3. go to the project https://{DOMAIN}/projects/{PROJECT_ID}/tests
-        4. GET-request project, Preview tab, copy id field  
-    
-    * `configurationId` - ID of configuration in TMS instance.
-    
-        1. create a project  
-        2. open DevTools -> network  
-        3. go to the project https://{DOMAIN}/projects/{PROJECT_ID}/tests  
-        4. GET-request configurations, Preview tab, copy id field  
-    
-    * `testRunId` - id of the created test run in TMS instance. `testRunId` is optional. If it is not provided, it is created automatically.  
-      
-    * `testRunName` - parameter for specifying the name of test run in TMS instance. `testRunName` is optional. If it is not provided, it is created automatically.   
-
-
-### Methods
-
-Methods can be used to specify information about autotest.
-
-Description of metadata methods:
-- `workItemIds` - linking an autotest to a test case
-- `displayName` - name of the autotest in the Test IT system (can be replaced with documentation strings)
-- `externalId` - ID of the autotest within the project in the Test IT System
-- `title` - title in the autotest card
-- `description` - description in the autotest card
-- `labels` - tags in the work item
-- `link` - links in the autotest card
-
-Description of methods:
-- `addLinks` - links in the autotest result
-- `addAttachments` - uploading files in the autotest result
-- `addMessage` - information about autotest in the autotest result
-
-### Examples
-
-#### Simple test
-```ts
-Scenario(
-  'Scenario name',
-  {
-    externalId: '1',
-    displayName: 'Name',
-    title: 'Title',
-    description: 'Description',
-    labels: ['Custom label'],
-    links: [
-      {
-        title: 'Google about this error',
-        description: 'Google documents',
-        url: 'https://google.com',
-        type: 'Requirement',
-        hasInfo: true
-      }
-    ],
-    workitemIds: ['1140']
-  },
-  ({ I }) => {
-    I.amOnPage('https://github.com');
-    I.addLinks([
-      {
-        title: 'Github page',
-        description: 'Github SPA page',
-        url: 'https://github.com',
-        type: 'Repository',
-        hasInfo: true
-      }
-    ])
-    I.addMessage('Hello');
-    I.see('GitHub');
-  });
-
-```
-
-#### Parameterized test
-```ts
-const data = new DataTable(['target', 'element']);
-
-data.add(['https://mail.google.com', '//a[contains(., "Почта")]']);
-data.add(['https://www.wikipedia.org', '//input']);
-data.add(['https://google.com', '//a[contains(., "Google")]']);
-
-Data(data).Scenario('Should render main page for all users', ({ I, current }) => {
-  I.amOnPage(current.target);
-  I.seeElement(current.element);
-})
-```
-
-
-# Contributing
-
-You can help to develop the project. Any contributions are **greatly appreciated**.
-
-* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/testit-tms/adapters-js/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
-* Please make sure you check your spelling and grammar.
-* Create individual PR for each suggestion.
-* Please also read through the [Code Of Conduct](https://github.com/testit-tms/adapters-js/blob/master/CODE_OF_CONDUCT.md) before posting your first idea as well.
-
-# License
-
-Distributed under the Apache-2.0 License. See [LICENSE](https://github.com/testit-tms/adapters-js/blob/master/LICENSE.md) for more information.
-
+# Test IT TMS adapters for Codecept
+![Test IT](https://raw.githubusercontent.com/testit-tms/adapters-js/master/images/banner.png)
+
+## Getting Started
+
+### Compatibility
+
+| Test IT | Adapter |
+|---------|---------|
+| 3.5     | 1.0     |
+| 4.0     | 1.1     |
+
+### Installation
+```
+npm install testit-adapter-codecept
+```
+
+## Usage
+
+### API client
+
+To use adapter you need to install `testit-api-client`:
+```
+npm install testit-api-client
+```
+
+### Configuration
+
+Add TestITHelper and TestITPlugin to Codecept file configuration 
+
+```ts
+export const config: CodeceptJS.MainConfig = {
+  tests: './**/*_test.ts',
+  output: './output',
+  helpers: {
+    Playwright: {
+      url: 'http://localhost',
+      show: false,
+      browser: 'chromium'
+    },
+    TestITHelper: {
+      require: 'testit-adapter-codecept/build/helper.js'
+    }
+  },
+  plugins: {
+    TestITPlugin: {
+      require: 'testit-adapter-codecept/build/bootstrap.js',
+      enabled: true
+    }
+  },
+  include: {},
+  name: 'codecept-test-it-testing'
+}
+```
+
+Create step.d.ts file and import TestMetadataHelper
+
+```ts
+type TestITHelper = import('testit-adapter-codecept/build/helper').TestMetadataHelper;
+
+declare namespace CodeceptJS {
+  interface SupportObject { I: I, current: any }
+  interface Methods extends Playwright, TestITHelper {}
+  interface I extends WithTranslation<Methods>{}
+  namespace Translation {
+    interface Actions {}
+  }
+}
+```
+
+#### File
+
+1. Create .env config or file config with default name testit-adapter.config.json in the root directory of the project
+
+```json
+{
+  "url": "<url>",
+  "privateToken": "<token>",
+  "projectId": "<id>",
+  "configurationId": "<id>",
+  "testRunId": "<id>",
+  "testRunName": "<optional name>",
+  "adapterMode": <optional>,
+  "automaticCreationTestCases": <optional boolean>
+}
+```
+
+2. Fill parameters with your configuration, where:  
+    * `url` - location of the TMS instance  
+      
+    * `privateToken` - API secret key
+        1. go to the https://{DOMAIN}/user-profile profile
+        2. copy the API secret key
+    
+    * `projectId` - ID of project in TMS instance.
+    
+        1. create a project
+        2. open DevTools -> network
+        3. go to the project https://{DOMAIN}/projects/{PROJECT_ID}/tests
+        4. GET-request project, Preview tab, copy id field  
+    
+    * `configurationId` - ID of configuration in TMS instance.
+    
+        1. create a project  
+        2. open DevTools -> network  
+        3. go to the project https://{DOMAIN}/projects/{PROJECT_ID}/tests  
+        4. GET-request configurations, Preview tab, copy id field  
+    
+    * `testRunId` - id of the created test run in TMS instance. `testRunId` is optional. If it is not provided, it is created automatically.  
+      
+    * `testRunName` - parameter for specifying the name of test run in TMS instance. `testRunName` is optional. If it is not provided, it is created automatically.   
+
+    * `adapterMode` - adapter mode. Default value - 0. The adapter supports following modes:
+      * 0 - in this mode, the adapter filters tests by test run ID and configuration ID, and sends the results to the test run.
+      * 1 - in this mode, the adapter sends all results to the test run without filtering.
+      * 2 - in this mode, the adapter creates a new test run and sends results to the new test run.
+
+    * `automaticCreationTestCases` - mode of automatic creation test cases. Default value - false. The adapter supports following modes:
+       * true - in this mode, the adapter will create a test case linked to the created autotest (not to the updated autotest).
+       * false - in this mode, the adapter will not create a test case.
+
+
+### Methods
+
+Methods can be used to specify information about autotest.
+
+Description of metadata methods:
+- `workItemIds` - linking an autotest to a test case
+- `displayName` - name of the autotest in the Test IT system (can be replaced with documentation strings)
+- `externalId` - ID of the autotest within the project in the Test IT System
+- `title` - title in the autotest card
+- `description` - description in the autotest card
+- `labels` - tags in the work item
+- `link` - links in the autotest card
+
+Description of methods:
+- `addLinks` - links in the autotest result
+- `addAttachments` - uploading files in the autotest result
+- `addMessage` - information about autotest in the autotest result
+
+### Examples
+
+#### Simple test
+```ts
+Scenario(
+  'Scenario name',
+  {
+    externalId: '1',
+    displayName: 'Name',
+    title: 'Title',
+    description: 'Description',
+    labels: ['Custom label'],
+    links: [
+      {
+        title: 'Google about this error',
+        description: 'Google documents',
+        url: 'https://google.com',
+        type: 'Requirement',
+        hasInfo: true
+      }
+    ],
+    workitemIds: ['1140']
+  },
+  ({ I }) => {
+    I.amOnPage('https://github.com');
+    I.addLinks([
+      {
+        title: 'Github page',
+        description: 'Github SPA page',
+        url: 'https://github.com',
+        type: 'Repository',
+        hasInfo: true
+      }
+    ])
+    I.addMessage('Hello');
+    I.see('GitHub');
+  });
+
+```
+
+#### Parameterized test
+```ts
+const data = new DataTable(['target', 'element']);
+
+data.add(['https://mail.google.com', '//a[contains(., "Почта")]']);
+data.add(['https://www.wikipedia.org', '//input']);
+data.add(['https://google.com', '//a[contains(., "Google")]']);
+
+Data(data).Scenario('Should render main page for all users', ({ I, current }) => {
+  I.amOnPage(current.target);
+  I.seeElement(current.element);
+})
+```
+
+
+# Contributing
+
+You can help to develop the project. Any contributions are **greatly appreciated**.
+
+* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/testit-tms/adapters-js/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
+* Please make sure you check your spelling and grammar.
+* Create individual PR for each suggestion.
+* Please also read through the [Code Of Conduct](https://github.com/testit-tms/adapters-js/blob/master/CODE_OF_CONDUCT.md) before posting your first idea as well.
+
+# License
+
+Distributed under the Apache-2.0 License. See [LICENSE](https://github.com/testit-tms/adapters-js/blob/master/LICENSE.md) for more information.
+

package/build/common/classes/config.class.js

@@ -42,15 +42,15 @@ class ConfigComposer {
             .toString();
         const file = JSON.parse(buffer);
         if ((file === null || file === void 0 ? void 0 : file.privateToken) || (base === null || base === void 0 ? void 0 : base.privateToken)) {
-            console.warn(`
-        The configuration file specifies a private token. It is not safe. 
-        Use TMS_PRIVATE_TOKEN environment variable
+            console.warn(`
+        The configuration file specifies a private token. It is not safe. 
+        Use TMS_PRIVATE_TOKEN environment variable
       `);
         }
         return this.merge(base, file, environment);
     }
     merge(base, file, environment) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u;
         return {
             url: (_b = (_a = environment === null || environment === void 0 ? void 0 : environment.TMS_URL) !== null && _a !== void 0 ? _a : file.url) !== null && _b !== void 0 ? _b : base === null || base === void 0 ? void 0 : base.url,
             privateToken: (_d = (_c = environment === null || environment === void 0 ? void 0 : environment.TMS_PRIVATE_TOKEN) !== null && _c !== void 0 ? _c : file === null || file === void 0 ? void 0 : file.privateToken) !== null && _d !== void 0 ? _d : base === null || base === void 0 ? void 0 : base.url,
@@ -59,7 +59,8 @@ class ConfigComposer {
             testRunId: (_k = (_j = environment === null || environment === void 0 ? void 0 : environment.TMS_TEST_RUN_ID) !== null && _j !== void 0 ? _j : file === null || file === void 0 ? void 0 : file.testRunId) !== null && _k !== void 0 ? _k : base === null || base === void 0 ? void 0 : base.testRunId,
             testRunName: (_m = (_l = environment === null || environment === void 0 ? void 0 : environment.TMS_TEST_RUN_NAME) !== null && _l !== void 0 ? _l : file === null || file === void 0 ? void 0 : file.testRunName) !== null && _m !== void 0 ? _m : base === null || base === void 0 ? void 0 : base.testRunName,
             adapterMode: (_q = (_p = (_o = environment === null || environment === void 0 ? void 0 : environment.TMS_ADAPTER_MODE) !== null && _o !== void 0 ? _o : file === null || file === void 0 ? void 0 : file.adapterMode) !== null && _p !== void 0 ? _p : base === null || base === void 0 ? void 0 : base.adapterMode) !== null && _q !== void 0 ? _q : 0,
-            __DEV: (_r = file.__DEV) !== null && _r !== void 0 ? _r : false
+            automaticCreationTestCases: (_t = (_s = (_r = environment === null || environment === void 0 ? void 0 : environment.TMS_AUTOMATIC_CREATION_TEST_CASES) !== null && _r !== void 0 ? _r : file === null || file === void 0 ? void 0 : file.automaticCreationTestCases) !== null && _s !== void 0 ? _s : base === null || base === void 0 ? void 0 : base.automaticCreationTestCases) !== null && _t !== void 0 ? _t : false,
+            __DEV: (_u = file.__DEV) !== null && _u !== void 0 ? _u : false
         };
     }
 }

package/build/common/classes/logger.class.js

@@ -17,11 +17,11 @@ class Logger {
     }
     error(error) {
         var _a, _b, _c, _d;
-        this.logger.error(`
-      ${(_a = error.response) === null || _a === void 0 ? void 0 : _a.status},
-      ${(_b = error.config) === null || _b === void 0 ? void 0 : _b.method},
-      ${(_c = error.config) === null || _c === void 0 ? void 0 : _c.url},
-      ${JSON.stringify((_d = error.response) === null || _d === void 0 ? void 0 : _d.data)}
+        this.logger.error(`
+      ${(_a = error.response) === null || _a === void 0 ? void 0 : _a.status},
+      ${(_b = error.config) === null || _b === void 0 ? void 0 : _b.method},
+      ${(_c = error.config) === null || _c === void 0 ? void 0 : _c.url},
+      ${JSON.stringify((_d = error.response) === null || _d === void 0 ? void 0 : _d.data)}
     `);
     }
 }

package/build/services/runs.builder.js

@@ -35,7 +35,7 @@ class RunsBuilder {
             traces: (_h = (_g = test === null || test === void 0 ? void 0 : test.err) === null || _g === void 0 ? void 0 : _g.cliMessage()) !== null && _h !== void 0 ? _h : '',
             teardownResults,
             setupResults,
-            completeOn: (0, to_iso_string_function_1.safetyUseISOString)((test === null || test === void 0 ? void 0 : test.startedAt) + (test === null || test === void 0 ? void 0 : test.duration)),
+            completedOn: (0, to_iso_string_function_1.safetyUseISOString)((test === null || test === void 0 ? void 0 : test.startedAt) + (test === null || test === void 0 ? void 0 : test.duration)),
             message: (_j = metadata === null || metadata === void 0 ? void 0 : metadata.message) !== null && _j !== void 0 ? _j : null,
             outcome: outcome_factory_1.OutcomeFactory.create(test.state),
             stepResults: !outcome_factory_1.OutcomeFactory.isSkipped(test.state) ? this.buildManySteps(test.steps) : null

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

@@ -38,6 +38,7 @@ class BaseStrategy {
         }
     }
     async createTestInOriginSystem(testToOriginSystem, test) {
+        testToOriginSystem.shouldCreateWorkItem = this.config.automaticCreationTestCases;
         const response = await this.http.create(testToOriginSystem);
         if (!response) {
             return;

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

@@ -28,6 +28,7 @@ export declare namespace Origin {
         testRunId?: string;
         testRunName?: string;
         adapterMode?: AdapterMode;
+        automaticCreationTestCases?: boolean;
         configFile?: string;
         __DEV?: boolean;
     }
@@ -39,6 +40,7 @@ export declare namespace Origin {
         TMS_TEST_RUN_ID: string;
         TMS_TEST_RUN_NAME: string;
         TMS_ADAPTER_MODE: AdapterMode;
+        TMS_AUTOMATIC_CREATION_TEST_CASES: boolean;
         TMS_CONFIG_FILE: string;
     }>;
 }

package/package.json

@@ -1,46 +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"
-  }
-}
+{
+  "name": "testit-adapter-codecept",
+  "version": "1.1.2",
+  "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.8"
+  },
+  "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"
+  }
+}