testit-adapter-cucumber 1.1.2 → 1.1.4

package/.eslintignore

@@ -1,2 +1,2 @@
-dist/*
+dist/*
 demo/*

package/.eslintrc.json

@@ -1,27 +1,27 @@
-{
-  "env": {
-    "es2021": true,
-    "node": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:prettier/recommended",
-    "prettier"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 12,
-    "sourceType": "module"
-  },
-  "plugins": ["@typescript-eslint", "prettier"],
-  "rules": {
-    "no-unused-vars": "off",
-    "@typescript-eslint/no-unused-vars": [
-      "error",
-      { "argsIgnorePattern": "^_" }
-    ],
-    "prettier/prettier": "warn",
-    "@typescript-eslint/explicit-function-return-type": "error"
-  }
-}
+{
+  "env": {
+    "es2021": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended",
+    "prettier"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint", "prettier"],
+  "rules": {
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      { "argsIgnorePattern": "^_" }
+    ],
+    "prettier/prettier": "warn",
+    "@typescript-eslint/explicit-function-return-type": "error"
+  }
+}

package/.prettierrc

@@ -1,9 +1,9 @@
-{
-  "endOfLine": "lf",
-  "printWidth": 80,
-  "semi": true,
-  "singleQuote": true,
-  "useTabs": false,
-  "trailingComma": "es5",
-  "tabWidth": 2
-}
+{
+  "endOfLine": "lf",
+  "printWidth": 80,
+  "semi": true,
+  "singleQuote": true,
+  "useTabs": false,
+  "trailingComma": "es5",
+  "tabWidth": 2
+}

package/README.md

@@ -1,149 +1,152 @@
-# Test IT TMS adapters for Cucumber
-![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-cucumber
-```
-
-## Usage
-
-### API client
-
-To use adapter you need to install `testit-api-client`:
-```
-npm install testit-api-client
-```
-
-### Configuration
-
-Create `testitFormatter.js` file in the root directory of the project:
-```js
-const { TestItFormatter } = require('testit-adapter-cucumber');
-
-module.exports = class CustomFormatter extends TestItFormatter {
-  constructor(options) {
-    super(options, {
-      url: '<url>',
-      privateToken: '<token>',
-      projectId: '<id>',
-      configurationId: '<id>',
-      testRunId: '<optional id>',
-    });
-  }
-};
-```
-
-And fill object with your configuration. Formatter sends results to Test IT.
-
-> TestRunId is optional. If it's not provided than it create automatically.
-
-Add to `cucumber.js` file
-
-```js
-module.exports = {
-  default:
-    '-f ./testitFormatter.js',
-};
-```
-
-### Tags
-
-Formatter provides additional methods to World:
-
-- addMessage - adds message to autotest
-- addLinks - adds links to autotest
-- addAttachments - uploads specified to Test IT and links to test run
-
-```js
-When('Something happens', function () {
-  this.addMessage('💔');
-  this.addLinks([
-    {
-      url: 'http://github.com',
-    },
-    {
-      url: 'https://wikipedia.org',
-      title: 'Wikipedia',
-      description: 'The free encyclopedia',
-      type: 'Related',
-      hasInfo: true,
-    },
-  ]);
-  this.addAttachments(['path/to/file.txt']);
-});
-```
-
-Cucumber tags can be used to specify information about autotest.
-
-> Only those specified above the `Scenario` are taken into account
-
-- `@ExternalId` - Unique identifier of autotest (Required)
-- `@Title` - Title that is displayed on autotest page
-- `@DisplayName` - Name that is displayed in autotests table
-- `@Description` - Autotest description
-- `@Link` - can be specified either in JSON (`@Link={"url":"http://google.com","hasInfo":true,"description":"GoogleDescription","title":"Google","type":"Defect"}`) or in text (`@Link=http://google.com`)
-- `@Label` - Label that is going to be linked to autotest
-- `@WorkItemId` - Work item's ID to which autotest is going to be linked
-
-### Examples
-
-#### Tags
-```
-Feature: Tags
-  @DisplayName=GoogiliGoogle
-  @Description=Cannot_Write_With_Spaces
-  @ExternalId=344
-  @Link=http://google.com
-  @Link=http://vk.com
-  @Label=Maths
-  @Label=School
-  Scenario: Scenario with links
-    When 2+2
-    Then Result is 4
-  @Title=LINKS
-  @ExternalId=343
-  @Link={"url":"http://google.com","hasInfo":true,"description":"GoogleDescription","title":"Google","type":"Defect"}
-  Scenario: Scenario with link obj
-    When 2+2
-    Then Result is 4
-```
-
-#### Parameterized test
-```
-Feature: Rule
-  Tests that use Rule
-  @ExternalId=999
-  Scenario: Summing
-    When <left>+<right>
-    Then Result is <result>
-
-    Examples: Options
-      Examples show different options
-      | left | right | result |
-      | 1    | 1     | 3      |
-      | 9    | 9     | 18     |
-```
-
-# 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 Cucumber
+![Test IT](https://raw.githubusercontent.com/testit-tms/adapters-js/master/images/banner.png)
+
+## Getting Started
+
+### Installation
+```
+npm install testit-adapter-cucumber
+```
+
+## 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                                                                                                                                                                                                                                                                                              | testRunId                  | TMS_TEST_RUN_ID                   | tmsTestRunId                  |
+
+Create `testitFormatter.js` file in the root directory of the project:
+```js
+const { TestItFormatter } = require('testit-adapter-cucumber');
+
+module.exports = class CustomFormatter extends TestItFormatter {
+  constructor(options) {
+    super(options, {
+      url: 'URL',
+      privateToken: 'USER_PRIVATE_TOKEN',
+      projectId: 'PROJECT_ID',
+      configurationId: 'CONFIGURATION_ID',
+      testRunId: 'TEST_RUN_ID',
+    });
+  }
+};
+```
+
+And fill object with your configuration. Formatter sends results to Test IT.
+
+> TestRunId is optional. If it's not provided than it create automatically.
+
+Add to `cucumber.js` file
+
+```js
+module.exports = {
+  default:
+    '-f ./testitFormatter.js',
+};
+```
+
+### Tags
+
+Formatter provides additional methods to World:
+
+- addMessage - adds message to autotest
+- addLinks - adds links to autotest
+- addAttachments - uploads specified to Test IT and links to test run
+
+```js
+When('Something happens', function () {
+  this.addMessage('💔');
+  this.addLinks([
+    {
+      url: 'http://github.com',
+    },
+    {
+      url: 'https://wikipedia.org',
+      title: 'Wikipedia',
+      description: 'The free encyclopedia',
+      type: 'Related',
+      hasInfo: true,
+    },
+  ]);
+  this.addAttachments(['path/to/file.txt']);
+});
+```
+
+Cucumber tags can be used to specify information about autotest.
+
+> Only those specified above the `Scenario` are taken into account
+
+- `@ExternalId` - Unique identifier of autotest (Required)
+- `@Title` - Title that is displayed on autotest page
+- `@DisplayName` - Name that is displayed in autotests table
+- `@Description` - Autotest description
+- `@Link` - can be specified either in JSON (`@Link={"url":"http://google.com","hasInfo":true,"description":"GoogleDescription","title":"Google","type":"Defect"}`) or in text (`@Link=http://google.com`)
+- `@Label` - Label that is going to be linked to autotest
+- `@WorkItemId` - Work item's ID to which autotest is going to be linked
+- `@NameSpace` - directory in the TMS system
+- `@ClassName` - subdirectory in the TMS system
+
+### Examples
+
+#### Tags
+```
+Feature: Tags
+  @DisplayName=GoogiliGoogle
+  @Description=Cannot_Write_With_Spaces
+  @ExternalId=344
+  @Link=http://google.com
+  @Link=http://vk.com
+  @Label=Maths
+  @Label=School
+  Scenario: Scenario with links
+    When 2+2
+    Then Result is 4
+  @Title=LINKS
+  @ExternalId=343
+  @Link={"url":"http://google.com","hasInfo":true,"description":"GoogleDescription","title":"Google","type":"Defect"}
+  Scenario: Scenario with link obj
+    When 2+2
+    Then Result is 4
+```
+
+#### Parameterized test
+```
+Feature: Rule
+  Tests that use Rule
+  @ExternalId=999
+  Scenario: Summing
+    When <left>+<right>
+    Then Result is <result>
+
+    Examples: Options
+      Examples show different options
+      | left | right | result |
+      | 1    | 1     | 3      |
+      | 9    | 9     | 18     |
+```
+
+# 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/formatter.d.ts

@@ -1,35 +1,35 @@
-import { Formatter, IFormatterOptions } from '@cucumber/cucumber';
-import { GherkinDocument, Pickle, TestCase, TestStepFinished, TestRunFinished, TestCaseStarted, TestCaseFinished, TestStepStarted, Meta } from '@cucumber/messages';
-import { ClientConfigWithFile, IClient, LinkPost } from 'testit-api-client';
-import { IStorage } from './types/storage';
-import { IFormatter } from './types/formatter';
-import { AutotestPostWithWorkItemId } from './mappers';
-export declare class TestItFormatter extends Formatter implements IFormatter {
-    client: IClient;
-    storage: IStorage;
-    currentTestCaseId: string | undefined;
-    resolvedAutotests: Array<string | undefined> | undefined;
-    constructor(options: IFormatterOptions, config: Partial<ClientConfigWithFile>);
-    private testRunId;
-    private testRunStarted;
-    private attachmentsQueue;
-    onMeta(_meta: Meta): void;
-    onGherkinDocument(document: GherkinDocument): void;
-    onPickle(pickle: Pickle): void;
-    onTestCase(testCase: TestCase): void;
-    onTestCaseStarted(testCaseStarted: TestCaseStarted): void;
-    testStepStarted(testStepStarted: TestStepStarted): void;
-    onTestStepFinished(testStepFinished: TestStepFinished): void;
-    testCaseFinished(testCaseFinished: TestCaseFinished): void;
-    onTestRunFinished(_testRunFinished: TestRunFinished): void;
-    loadAutotest(autotestPost: AutotestPostWithWorkItemId): Promise<void>;
-    loadPassedAutotest(autotestPost: AutotestPostWithWorkItemId): Promise<void>;
-    createTestRun(): void;
-    createNewAutotest(autotestPost: AutotestPostWithWorkItemId): Promise<void>;
-    updateAutotest(autotestPost: AutotestPostWithWorkItemId): Promise<void>;
-    linkWorkItem(externalId: string, workItemId: string): Promise<void>;
-    addMessage(message: string): void;
-    addLinks(links: LinkPost[]): void;
-    addAttachments(attachments: string[]): void;
-    private logError;
-}
+import { Formatter, IFormatterOptions } from '@cucumber/cucumber';
+import { GherkinDocument, Pickle, TestCase, TestStepFinished, TestRunFinished, TestCaseStarted, TestCaseFinished, TestStepStarted, Meta } from '@cucumber/messages';
+import { ClientConfigWithFile, IClient, LinkPost } from 'testit-api-client';
+import { IStorage } from './types/storage';
+import { IFormatter } from './types/formatter';
+import { AutotestPostWithWorkItemId } from './mappers';
+export declare class TestItFormatter extends Formatter implements IFormatter {
+    client: IClient;
+    storage: IStorage;
+    currentTestCaseId: string | undefined;
+    resolvedAutotests: Array<string | undefined> | undefined;
+    constructor(options: IFormatterOptions, config: Partial<ClientConfigWithFile>);
+    private testRunId;
+    private testRunStarted;
+    private attachmentsQueue;
+    onMeta(_meta: Meta): void;
+    onGherkinDocument(document: GherkinDocument): void;
+    onPickle(pickle: Pickle): void;
+    onTestCase(testCase: TestCase): void;
+    onTestCaseStarted(testCaseStarted: TestCaseStarted): void;
+    testStepStarted(testStepStarted: TestStepStarted): void;
+    onTestStepFinished(testStepFinished: TestStepFinished): void;
+    testCaseFinished(testCaseFinished: TestCaseFinished): void;
+    onTestRunFinished(_testRunFinished: TestRunFinished): void;
+    loadAutotest(autotestPost: AutotestPostWithWorkItemId): Promise<void>;
+    loadPassedAutotest(autotestPost: AutotestPostWithWorkItemId): Promise<void>;
+    createTestRun(): void;
+    createNewAutotest(autotestPost: AutotestPostWithWorkItemId): Promise<void>;
+    updateAutotest(autotestPost: AutotestPostWithWorkItemId): Promise<void>;
+    linkWorkItem(externalId: string, workItemId: string): Promise<void>;
+    addMessage(message: string): void;
+    addLinks(links: LinkPost[]): void;
+    addAttachments(attachments: string[]): void;
+    private logError;
+}