jest-qase-reporter 2.0.3 → 2.0.4

package/README.md

@@ -142,9 +142,8 @@ Reporter options (* - required):
 - `mode` - `testops`/`off` Enables reporter, default - `off`
 - `debug` - Enables debug logging, default - `false`
 - `environment` - To execute with the sending of the envinroment information
-- *`testops.api.token` - Token for API access, you can find more information
-  [here](https://developers.qase.io/#authentication)
-- *`testops.project` - Qase project code, for example, in https://app.qase.io/project/DEMO the code is `DEMO`
+- *`testops.api.token` - Token for API access, you can generate it [here](https://developers.qase.io/#authentication).
+- *`testops.project` - [Your project's code](https://help.qase.io/en/articles/9787250-how-do-i-find-my-project-code)
 - `testops.run.id` - Qase test run ID, used when the test run was created earlier using CLI or API call.
 - `testops.run.title` - Set custom Run name, when new run is created
 - `testops.run.description` - Set custom Run description, when new run is created

package/changelog.md

@@ -1,3 +1,9 @@
+# jest-qase-reporter@2.0.4
+
+## What's new
+
+Improved test name processing: Qase IDs are now automatically removed when uploading results
+
 # jest-qase-reporter@2.0.3
 
 ## What's new

package/dist/global.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Qase = void 0;
 class Qase {
+    reporter;
     constructor(reporter) {
         this.reporter = reporter;
     }

package/dist/reporter.d.ts

@@ -96,4 +96,10 @@ export declare class JestQaseReporter implements Reporter {
      * @private
      */
     private createEmptyMetadata;
+    /**
+     * @param {string} title
+     * @returns {string}
+     * @private
+     */
+    private removeQaseIdsFromTitle;
 }

package/dist/reporter.js

@@ -14,6 +14,22 @@ const global_1 = require("./global");
  * @implements Reporter
  */
 class JestQaseReporter {
+    /**
+     * @type {Record<Status, TestStatusEnum>}
+     */
+    static statusMap = {
+        passed: qase_javascript_commons_1.TestStatusEnum.passed,
+        failed: qase_javascript_commons_1.TestStatusEnum.failed,
+        skipped: qase_javascript_commons_1.TestStatusEnum.skipped,
+        disabled: qase_javascript_commons_1.TestStatusEnum.disabled,
+        pending: qase_javascript_commons_1.TestStatusEnum.skipped,
+        todo: qase_javascript_commons_1.TestStatusEnum.disabled,
+        focused: qase_javascript_commons_1.TestStatusEnum.passed,
+    };
+    /**
+     * @type {RegExp}
+     */
+    static qaseIdRegExp = /\(Qase ID: ([\d,]+)\)/;
     /**
      * @param {string} title
      * @returns {number[]}
@@ -23,6 +39,16 @@ class JestQaseReporter {
         const [, ids] = title.match(JestQaseReporter.qaseIdRegExp) ?? [];
         return ids ? ids.split(',').map((id) => Number(id)) : [];
     }
+    /**
+     * @type {ReporterInterface}
+     * @private
+     */
+    reporter;
+    /**
+     * @type {Metadata}
+     * @private
+     */
+    metadata;
     /**
      * @param {Config.GlobalConfig} _
      * @param {JestQaseOptionsType} options
@@ -230,7 +256,7 @@ class JestQaseReporter {
             steps: [],
             testops_id: ids.length > 0 ? ids : null,
             id: (0, uuid_1.v4)(),
-            title: value.title,
+            title: this.removeQaseIdsFromTitle(value.title),
         };
     }
     /**
@@ -250,21 +276,17 @@ class JestQaseReporter {
             attachments: [],
         };
     }
+    /**
+     * @param {string} title
+     * @returns {string}
+     * @private
+     */
+    removeQaseIdsFromTitle(title) {
+        const matches = title.match(/\(Qase ID: ([0-9,]+)\)$/i);
+        if (matches) {
+            return title.replace(matches[0], '').trimEnd();
+        }
+        return title;
+    }
 }
 exports.JestQaseReporter = JestQaseReporter;
-/**
- * @type {Record<Status, TestStatusEnum>}
- */
-JestQaseReporter.statusMap = {
-    passed: qase_javascript_commons_1.TestStatusEnum.passed,
-    failed: qase_javascript_commons_1.TestStatusEnum.failed,
-    skipped: qase_javascript_commons_1.TestStatusEnum.skipped,
-    disabled: qase_javascript_commons_1.TestStatusEnum.disabled,
-    pending: qase_javascript_commons_1.TestStatusEnum.skipped,
-    todo: qase_javascript_commons_1.TestStatusEnum.disabled,
-    focused: qase_javascript_commons_1.TestStatusEnum.passed,
-};
-/**
- * @type {RegExp}
- */
-JestQaseReporter.qaseIdRegExp = /\(Qase ID: ([\d,]+)\)/;

package/dist/step.js

@@ -9,10 +9,10 @@ const uuid_1 = require("uuid");
 const path_1 = __importDefault(require("path"));
 // TODO: Move to common, because it's duplicated in qase-wdio/src/step.ts
 class QaseStep {
+    name = '';
+    attachments = [];
+    steps = [];
     constructor(name) {
-        this.name = '';
-        this.attachments = [];
-        this.steps = [];
         this.name = name;
     }
     attach(attach) {

package/docs/usage.md

@@ -0,0 +1,209 @@
+# Qase Syntax
+
+> [**Click here**](../../examples/jest/test) to view Example tests for the following syntax.
+
+Here is the complete list of syntax options available for the reporter:
+- [Qase Id](#qase-id)
+- [Qase Title](#qase-title)
+- [Steps](#steps)
+- [Fields](#fields)
+- [Suite](#suite)
+- [Parameters](#parameters)
+- [Comment](#comment)
+- [Attach](#attach)
+- [Ignore](#ignore)
+
+If you do not use any Qase syntax, the reporter uses the title from the `describe` and `test` functions as the Suite and Test case title respectively, when publishing results.
+
+<br>
+
+### Import Statement
+---
+Add the following statement at the beginning of your spec file, before any tests.
+
+```javascript
+const { qase } = require("jest-qase-reporter/jest");
+```
+<br>
+
+### Qase ID
+---
+
+You can link one or more Qase Ids to a test.
+
+```javascript
+test(qase(1, "A test with Qase Id"), () => {
+    ..
+    
+test(qase(['2', '3'], "A test with multiple Qase Ids"), () => {
+    ..
+```
+
+<br>
+
+### Qase Title
+--- 
+
+The `qase.title()` method is used to set the title of a test case, both when creating a new test case from the result, and when updating the title of an existing test case - *if used with `qase.id()`.*
+
+```javascript
+test("This won't appear in Qase", () => {
+  qase.title("This text will be the title of the test, in Qase");
+    // Test logic here
+});
+```
+
+If you don’t explicitly set a title using this method, the title specified in the `test(..)` function will be used for creating new test cases. However, if this method is defined, it always takes precedence and overrides the title from the `test(..)` function.
+
+<br>
+
+### Steps
+--- 
+
+The reporter uses the title from the `test.step` function as the step title. By providing clear and descriptive step names, you make it easier to understand the test’s flow when reviewing the test case.
+
+Additionally, these steps get their own result in the Qase Test run, offering a well-organized summary of the test flow. This helps quickly identify the cause of any failures.
+
+```javascript
+test('A Test case with steps, updated from code', async () => {
+  await test.step('Initialize the environment', async () => {
+    // Set up test environment
+  });
+  await test.step('Test Core Functionality of the app', async () => {
+    // Exercise core functionality
+  });
+
+  await test.step('Verify Expected Behavior of the app', async () => {
+    // Assert expected behavior
+  });
+});
+```
+<br>
+
+### Fields
+---
+
+You can define the `description`, `pre-conditions`, `post-conditions`, and fields such as `severity`, `priority`, and `layer` using this method, which enables you to specify and maintain the context of the case directly within your code.
+
+```javascript
+test('Maintain your test meta-data from code', async () => {
+  await qase.fields({
+    severity: 'high',
+    priority: 'medium',
+    layer: 'api',
+    precondition: 'add your precondition',
+    postcondition: 'add your postcondition',
+    description: `Code it quick, fix it slow,
+                  Tech debt grows where shortcuts go,
+                  Refactor later? Ha! We know.`
+  });
+    //  test logic here
+});
+```
+
+<br>
+
+
+### Suite 
+---
+
+You can use this method to nest the resulting test cases in a particular suite. There's something to note here – suites, unlike test cases, are not identified uniquely by the Reporter. Therefore, when defining an existing suite - the title of the suite is used for matching.
+
+```js
+test("Test with a defined suite", () => {
+  qase.suite("Suite defined with qase.suite()");
+    /*
+     *  Or, nest multiple levels of suites. 
+     *  `\t` is used for dividing each suite name.
+     */
+     
+test("Test with a nested suite", () => {
+  qase.suite("Application\tAuthentication\tLogin\tEdge_case");
+  //  test logic here
+});
+```
+<br>
+
+### Parameters
+---
+Parameters are a great way to make your tests more dynamic, reusable, and data-driven. By defining parameters in this method, you can ensure only one test case with all the parameters is created in your Qase project, avoiding duplication.
+
+
+```javascript
+const testCases = [
+  { browser: "Chromium", username: "@alice", password: "123" },
+  { browser: "Firefox", username: "@bob", password: "456" },
+  { browser: "Webkit", username: "@charlie", password: "789" },
+];
+
+testCases.forEach(({ browser, username, password,  }) => {
+  test(`Test login with ${browser}`, async () => {
+    qase.title("Verify if page loads on all browsers");
+
+    qase.parameters({ Browser: browser });  // Single parameter
+  // test logic
+
+testCases.forEach(({ username, password }) => {
+  test(`Test login with ${username} using qase.groupParameters`, () => {
+    qase.title("Verify if user is able to login with their username.");
+
+    qase.groupParameters({  // Group parameters
+      Username: username,
+      Password: password,
+    });
+  // test logic
+```
+<br>
+
+### Comment
+---
+In addition to `test.step()`, this method can be used to provide any additional context to your test, it helps maintiain the code by clarifying the expected result of the test.
+
+```js
+test("A test case with qase.comment()", () => {
+    /*
+     * Please note, this comment is added to a Result, not to the Test case.
+     */
+  qase.comment("This comment is added to the result");
+  // test logic here
+});
+```
+<br>
+
+### Attach
+---
+This method can help attach one, or more files to the test's result. You can also add the file's contents directly from code. For example: 
+
+```js
+test('Test result with attachment', async () => {
+
+  test("Test result with attachment", async () => {
+    
+      // To attach a single file
+    await qase.attach({
+      paths: "./attachments/test-file.txt",
+    });
+
+      // Add multiple attachments. 
+    await qase.attach({ paths: ['/path/to/file', '/path/to/another/file'] });
+
+      // Upload file's contents directly from code.
+    await qase.attach({
+      name: "attachment.txt",
+      content: "Hello, world!",
+      contentType: "text/plain",
+    });
+      // test logic here
+});
+```
+<br>
+
+### Ignore
+---
+If this method is added, the reporter will exclude the test’s result from the report sent to Qase. While the test will still executed by jest, its result will not be considered by the reporter.
+
+```js
+test("This test is executed by jest; however, it is NOT reported to Qase", () => {
+  qase.ignore();
+//  test logic here
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-qase-reporter",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Qase TMS Jest Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",