testit-api-client 1.0.5 → 1.0.7

package/LICENSE.md

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 Test IT
+   Copyright 2022 TestGear
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/dist/client.d.ts

@@ -10,6 +10,7 @@ export declare class Client implements IClient {
     updateAutotest(autotest: AutotestPut): Promise<void>;
     linkToWorkItem(autotestId: string, workItem: WorkItemId): Promise<void>;
     getTestRun(testRunId: string): TestRunGet;
+    getTestRunById(testRunId: string): Promise<TestRunGet>;
     createTestRun(testRun: TestRunPost): Promise<TestRunGet>;
     startTestRun(testRunId: string): Promise<void>;
     loadTestRunResults(testRunId: string, results: AutotestResultsForTestRun[]): Promise<string[]>;

package/dist/client.js

@@ -22,7 +22,7 @@ const form_data_1 = __importDefault(require("form-data"));
 const path_1 = require("path");
 const validation_1 = require("./validation");
 // TODO: implement via the base client
-const XMLHttpRequest = require("xmlhttprequest").XMLHttpRequest;
+var XMLHttpRequest = require("xmlhttprequest").XMLHttpRequest;
 class Client {
     constructor(config) {
         const { configFile } = config, restConfig = __rest(config, ["configFile"]);
@@ -32,7 +32,7 @@ class Client {
         }
         finalConfig = Client.mergeConfig(finalConfig, this.readEnvConfig());
         finalConfig = Client.mergeConfig(finalConfig, this.readCliConfig());
-        this.config = (0, validation_1.validateConfig)(finalConfig);
+        this.config = (0, validation_1.validateConfig)(config);
         const baseURL = new URL('/api/v2', this.config.url).toString();
         this.axios = axios_1.default.create({
             baseURL,
@@ -48,7 +48,7 @@ class Client {
             await axios_1.default.get(new URL('version.json', this.config.url).toString());
         }
         catch (err) {
-            throw new Error('Cannot connect to TestIt');
+            throw new Error('Cannot connect to TMS');
         }
     }
     // TODO: add query object
@@ -87,6 +87,11 @@ class Client {
         this.request.send(null);
         return JSON.parse(this.request.responseText);
     }
+    async getTestRunById(testRunId) {
+        return this.axios
+            .get(`/testRuns/${testRunId}`)
+            .then((res) => res.data);
+    }
     async createTestRun(testRun) {
         return this.axios
             .post('/testRuns', testRun)
@@ -118,28 +123,30 @@ class Client {
     readCliConfig() {
         const args = (0, minimist_1.default)(process.argv.slice(2));
         let config = {};
-        if (args['testitConfig']) {
-            config = this.readConfigFile(args['testitConfig']);
+        if (args['tmsConfig']) {
+            config = this.readConfigFile(args['tmsConfig']);
         }
         return Client.mergeConfig(config, {
-            url: args['testitUrl'],
-            privateToken: args['testitPrivateToken'],
-            projectId: args['testitProjectId'],
-            configurationId: args['testitConfigurationId'],
-            testRunId: args['testitTestRunId'],
+            url: args['tmsUrl'],
+            privateToken: args['tmsPrivateToken'],
+            projectId: args['tmsProjectId'],
+            configurationId: args['tmsConfigurationId'],
+            testRunId: args['tmsTestRunId'],
+            automaticCreationTestCases: args['tmsAutomaticCreationTestCases'],
         });
     }
     readEnvConfig() {
         let config = {};
-        if (process.env['TESTIT_CONFIG_FILE']) {
-            config = this.readConfigFile(process.env['TESTIT_CONFIG_FILE']);
+        if (process.env['TMS_CONFIG_FILE']) {
+            config = this.readConfigFile(process.env['TMS_CONFIG_FILE']);
         }
         return Client.mergeConfig(config, {
-            url: process.env['TESTIT_URL'],
-            privateToken: process.env['TESTIT_PRIVATE_TOKEN'],
-            projectId: process.env['TESTIT_PROJECT_ID'],
-            configurationId: process.env['TESTIT_CONFIGURATION_ID'],
-            testRunId: process.env['TESTIT_TEST_RUN_ID'],
+            url: process.env['TMS_URL'],
+            privateToken: process.env['TMS_PRIVATE_TOKEN'],
+            projectId: process.env['TMS_PROJECT_ID'],
+            configurationId: process.env['TMS_CONFIGURATION_ID'],
+            testRunId: process.env['TMS_TEST_RUN_ID'],
+            automaticCreationTestCases: process.env['TMS_CREATION_TEST_CASES'] === 'true',
         });
     }
     readConfigFile(path) {
@@ -153,13 +160,14 @@ class Client {
         return config;
     }
     static mergeConfig(oldConfig, newConfig) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f, _g;
         return {
             url: (_a = newConfig.url) !== null && _a !== void 0 ? _a : oldConfig.url,
             privateToken: (_b = newConfig.privateToken) !== null && _b !== void 0 ? _b : oldConfig.privateToken,
             projectId: (_c = newConfig.projectId) !== null && _c !== void 0 ? _c : oldConfig.projectId,
             configurationId: (_d = newConfig.configurationId) !== null && _d !== void 0 ? _d : oldConfig.configurationId,
             testRunId: (_e = newConfig.testRunId) !== null && _e !== void 0 ? _e : oldConfig.testRunId,
+            automaticCreationTestCases: (_g = (_f = newConfig.automaticCreationTestCases) !== null && _f !== void 0 ? _f : oldConfig.automaticCreationTestCases) !== null && _g !== void 0 ? _g : false,
         };
     }
 }

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/types/autotest.d.ts

@@ -22,6 +22,7 @@ export interface AutotestPost {
     title?: string;
     description?: string;
     labels?: LabelPost[];
+    shouldCreateWorkItem?: boolean;
 }
 export interface AutotestPut {
     id?: string;

package/dist/types/autotestResults.d.ts

@@ -12,7 +12,7 @@ export interface AutotestResultsForTestRun {
     message?: string;
     traces?: string;
     startedOn?: string;
-    completeOn?: string;
+    completedOn?: string;
     duration?: number;
     attachments?: AttachmentPut[];
     parameters?: Parameters;

package/dist/types/capabilities.d.ts

@@ -1 +1 @@
-export declare type Capabilities = Record<string, string>;
+export type Capabilities = Record<string, string>;

package/dist/types/client.d.ts

@@ -1,4 +1,4 @@
-import { Attachment, Autotest, AutotestPost, AutotestPut, AutotestQuery, AutotestResultsForTestRun, ClientConfig, TestRunGet, TestRunPost, WorkItemId } from '.';
+import { Attachment, Autotest, AutotestPost, AutotestPut, AutotestQuery, AutotestResultsForTestRun, TestRunGet, TestRunPost, WorkItemId } from '.';
 export interface IClient {
     checkConnection(): Promise<void>;
     getAutotest(query: AutotestQuery): Promise<Autotest[]>;
@@ -6,10 +6,10 @@ export interface IClient {
     updateAutotest(autotest: AutotestPut): Promise<void>;
     linkToWorkItem(autotestId: string, workItem: WorkItemId): Promise<void>;
     getTestRun(testRunId: string): TestRunGet;
+    getTestRunById(testRunId: string): Promise<TestRunGet>;
     createTestRun(testRun: TestRunPost): Promise<TestRunGet>;
     startTestRun(testRunId: string): Promise<void>;
     loadTestRunResults(testRunId: string, results: AutotestResultsForTestRun[]): Promise<string[]>;
     completeTestRun(testRunId: string): Promise<void>;
-    getConfig(): ClientConfig;
     loadAttachment(fileName: string): Promise<Attachment>;
 }

package/dist/types/config.d.ts

@@ -4,6 +4,7 @@ export interface ClientConfig {
     projectId: string;
     configurationId: string;
     testRunId?: string;
+    automaticCreationTestCases?: boolean;
 }
 export interface ClientConfigWithFile extends ClientConfig {
     configFile?: string;

package/dist/types/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/types/link.d.ts

@@ -1,4 +1,4 @@
-export declare type LinkType = 'Related' | 'BlockedBy' | 'Defect' | 'Issue' | 'Requirement' | 'Repository';
+export type LinkType = 'Related' | 'BlockedBy' | 'Defect' | 'Issue' | 'Requirement' | 'Repository';
 export interface LinkPost {
     title?: string;
     url: string;

package/dist/types/outcome.d.ts

@@ -1 +1 @@
-export declare type OutcomeType = 'Passed' | 'Failed' | 'Pending' | 'Blocked' | 'Skipped';
+export type OutcomeType = 'Passed' | 'Failed' | 'Pending' | 'Blocked' | 'Skipped';

package/dist/types/parameters.d.ts

@@ -1 +1 @@
-export declare type Parameters = Record<string, string>;
+export type Parameters = Record<string, string>;

package/dist/types/properties.d.ts

@@ -1 +1 @@
-export declare type Properties = Record<string, string>;
+export type Properties = Record<string, string>;

package/dist/types/testResult.d.ts

@@ -12,7 +12,7 @@ export interface TestResultGet {
     is?: string;
     configurationId?: string;
     workItemVersionId?: string;
-    autotestId?: string;
+    autoTestId?: string;
     message?: string;
     traces?: string;
     startedOn?: string;

package/dist/types/testRun.d.ts

@@ -1,5 +1,5 @@
 import { TestResultGet } from './testResult';
-export declare type TestRunStateType = 'NotStarted' | 'InProgress' | 'Stopped' | 'Completed';
+export type TestRunStateType = 'NotStarted' | 'InProgress' | 'Stopped' | 'Completed';
 export interface TestRunPost {
     projectId: string;
     name?: string;

package/dist/validation.js

@@ -8,6 +8,7 @@ const configSchema = zod_1.z.object({
     projectId: zod_1.z.string().uuid(),
     url: zod_1.z.string().url(),
     testRunId: zod_1.z.string().uuid().optional(),
+    automaticCreationTestCases: zod_1.z.boolean().optional(),
 });
 function validateConfig(config) {
     return configSchema.parse(config);

package/package.json

@@ -1,52 +1,52 @@
-{
-  "name": "testit-api-client",
-  "version": "1.0.5",
-  "description": "Client provides methods for communication with Test IT API.",
-  "main": "dist/index.js",
-  "scripts": {
-    "test": "jest",
-    "build": "tsc",
-    "prebuild": "rimraf dist"
-  },
-  "keywords": [],
-  "author": "Andrey Kiselev",
-  "license": "Apache-2.0",
-  "devDependencies": {
-    "@babel/core": "^7.15.8",
-    "@babel/preset-env": "^7.15.8",
-    "@babel/preset-typescript": "^7.15.0",
-    "@types/jest": "^27.0.2",
-    "@types/minimist": "^1.2.2",
-    "@types/node": "^16.10.2",
-    "@types/uuid": "^8.3.1",
-    "babel-jest": "^27.2.5",
-    "jest": "^27.2.5",
-    "rimraf": "^3.0.2",
-    "ts-node": "^10.2.1",
-    "typescript": "^4.5.5",
-    "uuid": "^8.3.2"
-  },
-  "dependencies": {
-    "axios": "^0.22.0",
-    "form-data": "^4.0.0",
-    "minimist": "^1.2.5",
-    "querystring": "^0.2.1",
-    "zod": "^3.11.6",
-    "xmlhttprequest": "^1.8.0"
-  },
-  "files": [
-    "dist"
-  ],
-  "bugs": {
-    "url": "https://github.com/testit-tms/api-client-js/issues"
-  },
-  "homepage": "https://github.com/testit-tms/api-client-js",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/testit-tms/api-client-js.git"
-  },
-  "types": "./dist\\index.d.ts",
-  "directories": {
-    "test": "test"
-  }
-}
+{
+  "name": "testit-api-client",
+  "version": "1.0.7",
+  "description": "Client provides methods for communication with TMS API.",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "jest",
+    "build": "tsc",
+    "prebuild": "rimraf dist"
+  },
+  "keywords": [],
+  "author": "Integration team",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@babel/core": "^7.15.8",
+    "@babel/preset-env": "^7.15.8",
+    "@babel/preset-typescript": "^7.15.0",
+    "@types/jest": "^27.0.2",
+    "@types/minimist": "^1.2.2",
+    "@types/node": "^16.10.2",
+    "@types/uuid": "^8.3.1",
+    "babel-jest": "^27.2.5",
+    "jest": "^27.2.5",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.5.5",
+    "uuid": "^8.3.2"
+  },
+  "dependencies": {
+    "axios": "^0.22.0",
+    "form-data": "^4.0.0",
+    "minimist": "^1.2.5",
+    "querystring": "^0.2.1",
+    "zod": "^3.11.6",
+    "xmlhttprequest": "^1.8.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "bugs": {
+    "url": "https://github.com/testit-tms/api-client-js/issues"
+  },
+  "homepage": "https://github.com/testit-tms/api-client-js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/testit-tms/api-client-js.git"
+  },
+  "types": "./dist\\index.d.ts",
+  "directories": {
+    "test": "test"
+  }
+}