testit-adapter-jest 1.1.3 → 1.1.4

package/README.md

@@ -1,193 +1,173 @@
-# Test IT TMS adapters for Jest
-![Test IT](https://raw.githubusercontent.com/testit-tms/adapters-js/master/images/banner.png)
-
-## Getting Started
-
-### Installation
-```
-npm install testit-adapter-jest
-```
-
-## Usage
-
-### API client
-
-To use adapter you need to install `testit-api-client`:
-```
-npm install testit-api-client
-```
-
-### Configuration
-
-#### File
-
-1. You need to set custom jest test environment, setup and teardown in `jest.config.js`.
-
-```js
-module.exports = {
-  testEnvironment: 'testit-adapter-jest',
-  globalSetup: 'testit-adapter-jest/dist/globalSetup.js',
-  globalTeardown: 'testit-adapter-jest/dist/globalTeardown.js',
-  testEnvironmentOptions: {
-    url: '<url>',
-    privateToken: '<token>',
-    projectId: '<id>',
-    configurationId: '<id>',
-    testRunId: '<optional id>',
-  },
-};
-```
-
-2. You also can extract environment configuration to external config and launch tests with `jest --config ./testit.jest.config.js`.
-
-```js
-// testit.jest.config.js
-const defaultConfig = require('./jest.config');
-
-module.exports = {
-  ...defaultConfig,
-  testEnvironment: 'testit-adapter-jest',
-  globalSetup: 'testit-adapter-jest/dist/globalSetup.js',
-  globalTeardown: 'testit-adapter-jest/dist/globalTeardown.js',
-  testEnvironmentOptions: {
-    url: '<url>',
-    privateToken: '<token>',
-    projectId: '<id>',
-    configurationId: '<id>',
-    testRunId: '<optional id>',
-    adapterMode: <optional>,
-    automaticCreationTestCases: <optional boolean>
-  },
-};
-```
-
-3. 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.
-
-#### Command line
-
-You can also specify options via cli arguments `jest --testEnvironment testit-adapter-jest --testEnvironmentOptions "{\"url\":\"<url>\",\"privateToken\":\"<token>\",\"projectId\":\"<id>\",\"configurationId\":\"<id>\",\"testRunId\":\"<optional id>\",\"automaticCreationTestCases\": <optional boolean>}" --globalSetup testit-adapter-jest/dist/globalSetup.js --globalTeardown testit-adapter-jest/dist/globalTeardown.js`
-
-
-### Methods
-
-Methods can be used to specify information about autotest.
-
-Description of metadata methods:
-- `testit.workItemIds` - linking an autotest to a test case
-- `testit.displayName` - name of the autotest in the Test IT system (can be replaced with documentation strings)
-- `testit.externalId` - ID of the autotest within the project in the Test IT System
-- `testit.title` - title in the autotest card
-- `testit.description` - description in the autotest card
-- `testit.labels` - tags in the work item
-- `testit.link` - links in the autotest card
-- `testit.nameSpace` - directory in the TMS system (default - directory's name of test)
-- `testit.className` - subdirectory in the TMS system (default - file's name of test)
-
-Description of methods:
-- `testit.addLinks` - links in the autotest result
-- `testit.addAttachments` - uploading files in the autotest result
-- `testit.addMessage` - information about autotest in the autotest result
-
-### Examples
-
-#### Simple test
-```js
-test('All annotations', () => {
-  testit.externalId('all_annotations');
-  testit.displayName('All annotations');
-  testit.title('All annotations title');
-  testit.description('Test with all annotations');
-  testit.labels(['label1', 'label2']);
-
-  testit.addMessage('This is a message');
-  testit.addLinks([
-    {
-      url: 'https://www.google.com',
-      title: 'Google',
-      description: 'This is a link to Google',
-      type: 'Related',
-    },
-  ]);
-
-  testit.addAttachments([join(__dirname, 'attachment1.txt')]);
-  testit.addAttachments('This is a custom attachment', 'custom.txt');
-
-  expect(1).toBe(1);
-});
-```
-
-#### Parameterized test
-```js
-test.each([1, 2, 3, 4])('Primitive params', (number) => {
-  testit.params(number);
-  expect(number).toBe(number);
-});
-
-test.each([
-  {
-    a: 1,
-    b: 2,
-    sum: 3,
-  },
-  {
-    a: 2,
-    b: 3,
-    sum: 5,
-  },
-  {
-    a: 4,
-    b: 3,
-    sum: 5,
-  }
-])('Object params', (params) => {
-  testit.params(params);
-  expect(params.a + params.b).toBe(params.sum);
-});
-```
-
-
-# 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 Jest
+![Test IT](https://raw.githubusercontent.com/testit-tms/adapters-js/master/images/banner.png)
+
+## Getting Started
+
+### Installation
+```
+npm install testit-adapter-jest
+```
+
+## Usage
+
+### API client
+
+To use adapter you need to install `testit-api-client`:
+```
+npm install testit-api-client
+```
+
+### Configuration
+
+| Description                                                                                                                                                                                                                                                                                                                                                                            | Property                   | Environment variable              | CLI argument                  |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|-----------------------------------|-------------------------------|
+| Location of the TMS instance                                                                                                                                                                                                                                                                                                                                                           | url                        | TMS_URL                           | tmsUrl                        |
+| API secret key [How to getting API secret key?](https://github.com/testit-tms/.github/tree/main/configuration#privatetoken)                                                                                                                                                                                                                                                            | privateToken               | TMS_PRIVATE_TOKEN                 | tmsPrivateToken               |
+| ID of project in TMS instance [How to getting project ID?](https://github.com/testit-tms/.github/tree/main/configuration#projectid)                                                                                                                                                                                                                                                    | projectId                  | TMS_PROJECT_ID                    | tmsProjectId                  |
+| ID of configuration in TMS instance [How to getting configuration ID?](https://github.com/testit-tms/.github/tree/main/configuration#configurationid)                                                                                                                                                                                                                                  | configurationId            | TMS_CONFIGURATION_ID              | tmsConfigurationId            |
+| ID of the created test run in TMS instance.<br/>It's necessary for **adapterMode** 0 or 1                                                                                                                                                                                                                                                                                              | testRunId                  | TMS_TEST_RUN_ID                   | tmsTestRunId                  |
+| Parameter for specifying the name of test run in TMS instance (**It's optional**). If it is not provided, it is created automatically                                                                                                                                                                                                                                                  | testRunName                | TMS_TEST_RUN_NAME                 | tmsTestRunName                |
+| Adapter mode. Default value - 0. The adapter supports following modes:<br/>0 - in this mode, the adapter filters tests by test run ID and configuration ID, and sends the results to the test run<br/>1 - in this mode, the adapter sends all results to the test run without filtering<br/>2 - in this mode, the adapter creates a new test run and sends results to the new test run | adapterMode                | TMS_ADAPTER_MODE                  | tmsAdapterMode                |
+| It enables/disables certificate validation (**It's optional**). Default value - true                                                                                                                                                                                                                                                                                                   | certValidation             | TMS_CERT_VALIDATION               | tmsCertValidation             |
+| Mode of automatic creation test cases (**It's optional**). Default value - false. The adapter supports following modes:<br/>true - in this mode, the adapter will create a test case linked to the created autotest (not to the updated autotest)<br/>false - in this mode, the adapter will not create a test case                                                                    | automaticCreationTestCases | TMS_AUTOMATIC_CREATION_TEST_CASES | tmsAutomaticCreationTestCases |
+
+#### File
+
+1. You need to set custom jest test environment, setup and teardown in `jest.config.js`.
+
+```js
+module.exports = {
+  testEnvironment: 'testit-adapter-jest',
+  globalSetup: 'testit-adapter-jest/dist/globalSetup.js',
+  globalTeardown: 'testit-adapter-jest/dist/globalTeardown.js',
+  testEnvironmentOptions: {
+    url: 'URL',
+    privateToken: 'USER_PRIVATE_TOKEN',
+    projectId: 'PROJECT_ID',
+    configurationId: 'CONFIGURATION_ID',
+    testRunId: 'TEST_RUN_ID',
+    adapterMode: ADAPTER_MODE,
+    automaticCreationTestCases: AUTOMATIC_CREATION_TEST_CASES
+  },
+};
+```
+
+2. You also can extract environment configuration to external config and launch tests with `jest --config ./testit.jest.config.js`.
+
+```js
+// testit.jest.config.js
+const defaultConfig = require('./jest.config');
+
+module.exports = {
+  ...defaultConfig,
+  testEnvironment: 'testit-adapter-jest',
+  globalSetup: 'testit-adapter-jest/dist/globalSetup.js',
+  globalTeardown: 'testit-adapter-jest/dist/globalTeardown.js',
+  testEnvironmentOptions: {
+    url: 'URL',
+    privateToken: 'USER_PRIVATE_TOKEN',
+    projectId: 'PROJECT_ID',
+    configurationId: 'CONFIGURATION_ID',
+    testRunId: 'TEST_RUN_ID',
+    adapterMode: ADAPTER_MODE,
+    automaticCreationTestCases: AUTOMATIC_CREATION_TEST_CASES
+  },
+};
+```
+
+#### Command line
+
+You can also specify options via cli arguments `jest --testEnvironment testit-adapter-jest --testEnvironmentOptions "{\"url\":\"URL\",\"privateToken\":\"USER_PRIVATE_TOKEN\",\"projectId\":\"PROJECT_ID\",\"configurationId\":\"CONFIGURATION_ID\",\"testRunId\":\"TEST_RUN_ID\",\"adapterMode\":ADAPTER_MODE,\"automaticCreationTestCases\":AUTOMATIC_CREATION_TEST_CASES}" --globalSetup testit-adapter-jest/dist/globalSetup.js --globalTeardown testit-adapter-jest/dist/globalTeardown.js`
+
+
+### Methods
+
+Methods can be used to specify information about autotest.
+
+Description of metadata methods:
+- `testit.workItemIds` - linking an autotest to a test case
+- `testit.displayName` - name of the autotest in the Test IT system (can be replaced with documentation strings)
+- `testit.externalId` - ID of the autotest within the project in the Test IT System
+- `testit.title` - title in the autotest card
+- `testit.description` - description in the autotest card
+- `testit.labels` - tags in the work item
+- `testit.link` - links in the autotest card
+- `testit.nameSpace` - directory in the TMS system (default - directory's name of test)
+- `testit.className` - subdirectory in the TMS system (default - file's name of test)
+
+Description of methods:
+- `testit.addLinks` - links in the autotest result
+- `testit.addAttachments` - uploading files in the autotest result
+- `testit.addMessage` - information about autotest in the autotest result
+
+### Examples
+
+#### Simple test
+```js
+test('All annotations', () => {
+  testit.externalId('all_annotations');
+  testit.displayName('All annotations');
+  testit.title('All annotations title');
+  testit.description('Test with all annotations');
+  testit.labels(['label1', 'label2']);
+
+  testit.addMessage('This is a message');
+  testit.addLinks([
+    {
+      url: 'https://www.google.com',
+      title: 'Google',
+      description: 'This is a link to Google',
+      type: 'Related',
+    },
+  ]);
+
+  testit.addAttachments([join(__dirname, 'attachment1.txt')]);
+  testit.addAttachments('This is a custom attachment', 'custom.txt');
+
+  expect(1).toBe(1);
+});
+```
+
+#### Parameterized test
+```js
+test.each([1, 2, 3, 4])('Primitive params', (number) => {
+  testit.params(number);
+  expect(number).toBe(number);
+});
+
+test.each([
+  {
+    a: 1,
+    b: 2,
+    sum: 3,
+  },
+  {
+    a: 2,
+    b: 3,
+    sum: 5,
+  },
+  {
+    a: 4,
+    b: 3,
+    sum: 5,
+  }
+])('Object params', (params) => {
+  testit.params(params);
+  expect(params.a + params.b).toBe(params.sum);
+});
+```
+
+
+# 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/dist/config.d.ts

@@ -1 +1 @@
-export type AdapterMode = 0 | 1 | 2;
+export type AdapterMode = 0 | 1 | 2;

package/dist/config.js

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

package/dist/debug.d.ts

@@ -1,2 +1,2 @@
-import d from 'debug';
-export declare const debug: d.Debugger;
+import d from 'debug';
+export declare const debug: d.Debugger;

package/dist/debug.js

@@ -1,8 +1,8 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.debug = void 0;
-const debug_1 = __importDefault(require("debug"));
-exports.debug = (0, debug_1.default)('testit');
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debug = void 0;
+const debug_1 = __importDefault(require("debug"));
+exports.debug = (0, debug_1.default)('testit');

package/dist/globalSetup.d.ts

@@ -1,3 +1,3 @@
-import { Config } from '@jest/reporters';
-declare const _default: (globalConfig: Config.GlobalConfig, projectConfig: Config.ProjectConfig) => Promise<void>;
-export default _default;
+import { Config } from '@jest/reporters';
+declare const _default: (globalConfig: Config.GlobalConfig, projectConfig: Config.ProjectConfig) => Promise<void>;
+export default _default;

package/dist/globalSetup.js

@@ -1,35 +1,35 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const testClient_1 = require("./testClient");
-const utils_1 = require("./utils");
-exports.default = async (globalConfig, projectConfig) => {
-    const adapterMode = projectConfig.testEnvironmentOptions?.adapterMode ?? 0;
-    const automaticCreationTestCases = projectConfig.testEnvironmentOptions?.automaticCreationTestCases ?? false;
-    let testRunId;
-    try {
-        switch (adapterMode) {
-            case 0:
-            case 1: {
-                testRunId = projectConfig.testEnvironmentOptions?.testRunId;
-                if (!testRunId) {
-                    throw new Error('testRunId is required when mode is 1');
-                }
-                globalThis.testClient = new testClient_1.TestClient(projectConfig.testEnvironmentOptions);
-                break;
-            }
-            case 2: {
-                globalThis.testClient = new testClient_1.TestClient(projectConfig.testEnvironmentOptions);
-                testRunId = await globalThis.testClient.createTestRun();
-                break;
-            }
-            default:
-                throw new Error(`Unknown adapter mode ${adapterMode}`);
-        }
-    }
-    catch (err) {
-        console.error('Failed to setup', (0, utils_1.formatError)(err));
-        process.exit(1);
-    }
-    projectConfig.globals['testRunId'] = testRunId;
-    projectConfig.globals['automaticCreationTestCases'] = automaticCreationTestCases;
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const testClient_1 = require("./testClient");
+const utils_1 = require("./utils");
+exports.default = async (globalConfig, projectConfig) => {
+    const adapterMode = projectConfig.testEnvironmentOptions?.adapterMode ?? 0;
+    const automaticCreationTestCases = projectConfig.testEnvironmentOptions?.automaticCreationTestCases ?? false;
+    let testRunId;
+    try {
+        switch (adapterMode) {
+            case 0:
+            case 1: {
+                testRunId = projectConfig.testEnvironmentOptions?.testRunId;
+                if (!testRunId) {
+                    throw new Error('testRunId is required when mode is 1');
+                }
+                globalThis.testClient = new testClient_1.TestClient(projectConfig.testEnvironmentOptions);
+                break;
+            }
+            case 2: {
+                globalThis.testClient = new testClient_1.TestClient(projectConfig.testEnvironmentOptions);
+                testRunId = await globalThis.testClient.createTestRun();
+                break;
+            }
+            default:
+                throw new Error(`Unknown adapter mode ${adapterMode}`);
+        }
+    }
+    catch (err) {
+        console.error('Failed to setup', (0, utils_1.formatError)(err));
+        process.exit(1);
+    }
+    projectConfig.globals['testRunId'] = testRunId;
+    projectConfig.globals['automaticCreationTestCases'] = automaticCreationTestCases;
+};

package/dist/globalTeardown.d.ts

@@ -1,3 +1,3 @@
-import { Config } from '@jest/reporters';
-declare const _default: (globalConfig: Config.GlobalConfig, projectConfig: Config.ProjectConfig) => Promise<void>;
-export default _default;
+import { Config } from '@jest/reporters';
+declare const _default: (globalConfig: Config.GlobalConfig, projectConfig: Config.ProjectConfig) => Promise<void>;
+export default _default;

package/dist/globalTeardown.js

@@ -1,16 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("./utils");
-exports.default = async (globalConfig, projectConfig) => {
-    const testRunId = projectConfig.globals['testRunId'];
-    if (!testRunId) {
-        console.error('Looks like globalSetup was not called');
-        return;
-    }
-    try {
-        await globalThis.testClient.completeTestRun();
-    }
-    catch (err) {
-        console.error('Failed to complete test run', (0, utils_1.formatError)(err));
-    }
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("./utils");
+exports.default = async (globalConfig, projectConfig) => {
+    const testRunId = projectConfig.globals['testRunId'];
+    if (!testRunId) {
+        console.error('Looks like globalSetup was not called');
+        return;
+    }
+    try {
+        await globalThis.testClient.completeTestRun();
+    }
+    catch (err) {
+        console.error('Failed to complete test run', (0, utils_1.formatError)(err));
+    }
+};

package/dist/mappers.d.ts

@@ -1,7 +1,7 @@
-import { AttachmentPut, AttachmentPutModelAutotestStepResults, AutotestStep, Parameters } from 'testit-api-client';
-import { StepData } from './types';
-export declare function mapDate(date: number): string;
-export declare function mapStep(step: StepData): AutotestStep;
-export declare function mapParams(params: any): Parameters;
-export declare function mapStepResult(step: StepData): AttachmentPutModelAutotestStepResults;
-export declare function mapAttachments(attachments: string[]): AttachmentPut[];
+import { AttachmentPut, AttachmentPutModelAutotestStepResults, AutotestStep, Parameters } from 'testit-api-client';
+import { StepData } from './types';
+export declare function mapDate(date: number): string;
+export declare function mapStep(step: StepData): AutotestStep;
+export declare function mapParams(params: any): Parameters;
+export declare function mapStepResult(step: StepData): AttachmentPutModelAutotestStepResults;
+export declare function mapAttachments(attachments: string[]): AttachmentPut[];

package/dist/mappers.js

@@ -1,46 +1,46 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapAttachments = exports.mapStepResult = exports.mapParams = exports.mapStep = exports.mapDate = void 0;
-function mapDate(date) {
-    return new Date(date).toISOString();
-}
-exports.mapDate = mapDate;
-function mapStep(step) {
-    return {
-        title: step.title,
-        description: step.description,
-    };
-}
-exports.mapStep = mapStep;
-function mapParams(params) {
-    switch (typeof params) {
-        case 'string':
-        case 'bigint':
-        case 'number':
-        case 'boolean':
-            return { value: params.toString() };
-        case 'object':
-            if (params === null) {
-                return {};
-            }
-            return Object.keys(params).reduce((acc, key) => {
-                acc[key] = params[key].toString();
-                return acc;
-            }, {});
-        default:
-            return {};
-    }
-}
-exports.mapParams = mapParams;
-function mapStepResult(step) {
-    return {
-        title: step.title,
-        description: step.description,
-        attachments: mapAttachments(step.attachments),
-    };
-}
-exports.mapStepResult = mapStepResult;
-function mapAttachments(attachments) {
-    return attachments.map((id) => ({ id }));
-}
-exports.mapAttachments = mapAttachments;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapAttachments = exports.mapStepResult = exports.mapParams = exports.mapStep = exports.mapDate = void 0;
+function mapDate(date) {
+    return new Date(date).toISOString();
+}
+exports.mapDate = mapDate;
+function mapStep(step) {
+    return {
+        title: step.title,
+        description: step.description,
+    };
+}
+exports.mapStep = mapStep;
+function mapParams(params) {
+    switch (typeof params) {
+        case 'string':
+        case 'bigint':
+        case 'number':
+        case 'boolean':
+            return { value: params.toString() };
+        case 'object':
+            if (params === null) {
+                return {};
+            }
+            return Object.keys(params).reduce((acc, key) => {
+                acc[key] = params[key].toString();
+                return acc;
+            }, {});
+        default:
+            return {};
+    }
+}
+exports.mapParams = mapParams;
+function mapStepResult(step) {
+    return {
+        title: step.title,
+        description: step.description,
+        attachments: mapAttachments(step.attachments),
+    };
+}
+exports.mapStepResult = mapStepResult;
+function mapAttachments(attachments) {
+    return attachments.map((id) => ({ id }));
+}
+exports.mapAttachments = mapAttachments;