testit-adapter-jest 1.1.0 → 1.1.2

package/README.md

@@ -1,8 +1,6 @@
 # Test IT TMS adapters for Jest
 ![Test IT](https://raw.githubusercontent.com/testit-tms/adapters-js/master/images/banner.png)
 
-# Cucumber
-
 ## Getting Started
 
 ### Compatibility
@@ -10,7 +8,6 @@
 | Test IT | Adapter |
 |---------|---------|
 | 3.5     | 1.0     |
-|---------|---------|
 | 4.0     | 1.1     |
 
 ### Installation
@@ -65,6 +62,8 @@ module.exports = {
     projectId: '<id>',
     configurationId: '<id>',
     testRunId: '<optional id>',
+    adapterMode: <optional>,
+    automaticCreationTestCases: <optional boolean>
   },
 };
 ```
@@ -92,11 +91,20 @@ module.exports = {
     
     * `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.   
+    * `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>\"}" --globalSetup testit-adapter-jest/dist/globalSetup.js --globalTeardown testit-adapter-jest/dist/globalTeardown.js`
+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

package/dist/globalSetup.js

@@ -4,6 +4,7 @@ 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) {
@@ -30,4 +31,5 @@ exports.default = async (globalConfig, projectConfig) => {
         process.exit(1);
     }
     projectConfig.globals['testRunId'] = testRunId;
+    projectConfig.globals['automaticCreationTestCases'] = automaticCreationTestCases;
 };

package/dist/testitEnvironment.d.ts

@@ -14,6 +14,7 @@ export default class TestItEnvironment extends NodeEnvironment {
     private autotests;
     private testPath;
     private attachmentsQueue;
+    private automaticCreationTestCases;
     constructor(config: JestEnvironmentConfig, context: EnvironmentContext);
     setup(): Promise<void>;
     teardown(): Promise<void>;

package/dist/testitEnvironment.js

@@ -36,9 +36,14 @@ class TestItEnvironment extends jest_environment_node_1.default {
         this.autotests = [];
         this.attachmentsQueue = [];
         const testRunId = config.projectConfig.globals['testRunId'];
+        const automaticCreationTestCases = config.projectConfig.globals['automaticCreationTestCases'];
         if (!testRunId || typeof testRunId !== 'string') {
             throw new Error('Looks like globalSetup was not called');
         }
+        if (!automaticCreationTestCases || typeof automaticCreationTestCases !== 'boolean') {
+            throw new Error('Looks like globalSetup was not called');
+        }
+        this.automaticCreationTestCases = automaticCreationTestCases;
         this.testClient = new testClient_1.TestClient({
             ...config.projectConfig.testEnvironmentOptions,
             testRunId,
@@ -193,6 +198,7 @@ class TestItEnvironment extends jest_environment_node_1.default {
                 teardown: teardownSteps.map(mappers_1.mapStep),
                 links: autotest.links,
                 labels: autotest.labels.map((label) => ({ name: label })),
+                shouldCreateWorkItem: this.automaticCreationTestCases,
             };
             if (!result.isFailed) {
                 await this.testClient.loadPassedAutotest(autotestPost);
@@ -224,7 +230,7 @@ class TestItEnvironment extends jest_environment_node_1.default {
                 outcome: result.isFailed ? 'Failed' : 'Passed',
                 startedOn: result.startedAt ? (0, mappers_1.mapDate)(result.startedAt) : undefined,
                 duration: result.duration ? result.duration : undefined,
-                completeOn: result.finishedAt ? (0, mappers_1.mapDate)(result.finishedAt) : undefined,
+                completedOn: result.finishedAt ? (0, mappers_1.mapDate)(result.finishedAt) : undefined,
                 attachments: (0, mappers_1.mapAttachments)(autotest.attachments),
                 message: messages.length > 0 ? messages.join('\n') : undefined,
                 traces: result.trace,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testit-adapter-jest",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "",
   "main": "dist/testitEnvironment.js",
   "scripts": {
@@ -12,7 +12,7 @@
   "license": "ISC",
   "dependencies": {
     "debug": "^4.3.4",
-    "testit-api-client": "^1.0.5"
+    "testit-api-client": "^1.0.8"
   },
   "devDependencies": {
     "@types/debug": "^4.1.7",