vitest-qase-reporter 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,272 @@
+# Qase TestOps Vitest reporter
+
+Qase Vitest reporter sends test results and metadata to Qase.io.
+It can work in different test automation scenarios:
+
+* Create new test cases in Qase from existing autotests.
+* Report Vitest test results to existing test cases in Qase.
+
+Testing frameworks that use Vitest as a test runner can also be used with Vitest reporter.
+
+To install the latest version, run:
+
+```shell
+npm install --save-dev qase-vitest
+```
+
+# Contents
+
+- [Qase TestOps Vitest reporter](#qase-testops-vitest-reporter)
+- [Contents](#contents)
+  - [Getting started](#getting-started)
+  - [Using Reporter](#using-reporter)
+    - [Metadata](#metadata)
+    - [Advanced Usage with Annotations](#advanced-usage-with-annotations)
+  - [Configuration](#configuration)
+  - [Requirements](#requirements)
+
+## Getting started
+
+To report your tests results to Qase, install `qase-vitest`,
+and add a reporter config in the `vitest.config.ts` file.
+A minimal configuration needs just two things:
+
+* Qase project code, for example, in https://app.qase.io/project/DEMO the code is `DEMO`.
+* Qase API token, created on the [Apps page](https://app.qase.io/apps?app=vitest-reporter).
+
+```typescript
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    reporters: [
+      'default',
+      [
+        'vitest-qase-reporter',
+        {
+          mode: 'testops',
+          testops: {
+            api: {
+              token: 'api_token'
+            },
+            project: 'project_code',
+          },
+        },
+      ],
+    ],
+  },
+});
+```
+
+Now, run the Vitest tests as usual.
+Test results will be reported to a new test run in Qase.
+
+```console
+$ npx vitest run
+Determining test suites to run...
+...
+qase: Project DEMO exists
+qase: Using run 42 to publish test results
+...
+
+Ran all test suites.
+```
+
+## Using Reporter
+
+The Vitest reporter has the ability to auto-generate test cases
+and suites from your test data.
+
+But if necessary, you can independently register the ID of already
+existing test cases from TMS before the executing tests. For example:
+
+### Metadata
+
+- `qase.title` - set the title of the test case
+- `qase.fields` - set the fields of the test case
+- `qase.suite` - set the suite of the test case
+- `qase.comment` - set the comment of the test case
+- `qase.parameters` - set the parameters of the test case
+- `qase.groupParameters` - set the group parameters of the test case
+- `qase.ignore` - ignore the test case in Qase. The test will be executed, but the results will not be sent to Qase.
+- `qase.step` - create a step in the test case
+- `qase.attach` - attach a file to the test case
+
+```typescript
+import { describe, it, test, expect } from 'vitest';
+import { qase, withQase } from 'vitest-qase-reporter/vitest';
+
+describe('My First Test', () => {
+  test(qase([1, 2], 'Several ids'), () => {
+    expect(true).toBe(true);
+  });
+
+  test(qase(3, 'Correct test'), () => {
+    expect(true).toBe(true);
+  });
+
+  test.skip(qase('4', 'Skipped test'), () => {
+    expect(true).toBe(true);
+  });
+
+  test(qase(['5', '6'], 'Failed test'), () => {
+    expect(true).toBe(false);
+  });
+});
+```
+
+### Advanced Usage with Annotations
+
+```typescript
+import { describe, it, expect } from 'vitest';
+import { qase, withQase } from 'vitest-qase-reporter/vitest';
+
+describe('Qase Annotations Example', () => {
+  it(qase(20, 'Basic test with qase ID'), () => {
+    expect(1 + 1).toBe(2);
+  });
+
+  it('Test with qase annotations', withQase(async ({ qase, annotate }) => {
+    // Set test title
+    await qase.title('Advanced Test with Annotations');
+    
+    // Add comment
+    await qase.comment('This test demonstrates qase annotations functionality');
+    
+    // Set suite
+    await qase.suite('Vitest Integration Suite');
+    
+    // Set fields
+    await qase.fields({
+      description: 'Test description for Qase',
+      severity: 'critical',
+      priority: 'high',
+      layer: 'e2e'
+    });
+    
+    // Set parameters
+    await qase.parameters({
+      environment: 'staging',
+      browser: 'chrome',
+      version: '1.0.0'
+    });
+    
+    // Add steps
+    await qase.step('Initialize test data', async () => {
+      expect(true).toBe(true);
+    });
+    
+    await qase.step('Execute main test logic', async () => {
+      expect(2 + 2).toBe(4);
+    });
+    
+    // Add attachment with content
+    await qase.attach({
+      name: 'test-data.json',
+      content: JSON.stringify({ test: 'data' }),
+      type: 'application/json'
+    });
+    
+    // Use regular annotate for custom annotations
+    await annotate('Custom annotation message', 'info');
+    
+    // Final assertion
+    expect(Math.max(1, 2, 3)).toBe(3);
+  }));
+});
+```
+
+To run tests and create a test run, execute the command (for example from folder examples):
+
+```bash
+QASE_MODE=testops npx vitest run
+```
+
+or
+
+```bash
+npm test
+```
+
+A test run will be performed and available at:
+
+```
+https://app.qase.io/run/QASE_PROJECT_CODE
+```
+
+## Configuration
+
+Reporter options (* - required):
+
+- `mode` - `testops`/`off` Enables reporter, default - `off`
+- `debug` - Enables debug logging, default - `false`
+- `environment` - To execute with the sending of the environment information
+- `captureLogs` - Capture console logs, default - `false`
+- `uploadAttachments` - Upload attachments to Qase, default - `false`
+- *`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.api.baseUrl` - Qase API base URL (optional)
+- `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
+- `testops.run.complete` - Whether the run should be completed
+
+Example `vitest.config.ts` config:
+
+```typescript
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    reporters: [
+      'default',
+      [
+        'vitest-qase-reporter',
+        {
+          mode: 'testops',
+          testops: {
+            api: {
+              token: 'api_key'
+            },
+            project: 'project_code',
+            run: {
+              complete: true,
+            },
+            uploadAttachments: true,
+          },
+          debug: true,
+          captureLogs: true,
+        },
+      ],
+    ],
+  },
+});
+```
+
+You can check example configuration with multiple reporters in [example project](../examples/vitest/vitest.config.ts).
+
+Supported ENV variables:
+
+- `QASE_MODE` - Same as `mode`
+- `QASE_DEBUG` - Same as `debug`
+- `QASE_ENVIRONMENT` - Same as `environment`
+- `QASE_TESTOPS_API_TOKEN` - Same as `testops.api.token`
+- `QASE_TESTOPS_PROJECT` - Same as `testops.project`
+- `QASE_TESTOPS_RUN_ID` - Pass Run ID from ENV and override reporter option `testops.run.id`
+- `QASE_TESTOPS_RUN_TITLE` - Same as `testops.run.title`
+- `QASE_TESTOPS_RUN_DESCRIPTION` - Same as `testops.run.description`
+
+## Documentation
+
+For detailed documentation and advanced usage, see [USAGE.md](./docs/usage.md).
+
+## Requirements
+
+We maintain the reporter on LTS versions of Node. You can find the current versions by following
+the [link](https://nodejs.org/en/about/releases/)
+
+`vitest >= 3.0.0`
+
+<!-- references -->
+
+[auth]: https://developers.qase.io/#authentication

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+import type { Reporter } from 'vitest/reporters';
+import type { TestAnnotation } from '@vitest/runner';
+import type { TestCase, TestSuite } from 'vitest/node';
+import { ConfigType } from 'qase-javascript-commons';
+export type VitestQaseOptionsType = ConfigType;
+export declare class VitestQaseReporter implements Reporter {
+    private reporter;
+    private currentSuite;
+    private testMetadata;
+    /**
+   * @type {RegExp}
+   */
+    static qaseIdRegExp: RegExp;
+    /**
+   * @param {string} title
+   * @returns {number[]}
+   * @private
+   */
+    private static getCaseId;
+    /**
+   * @param {string} title
+   * @returns {string}
+   * @private
+   */
+    private static removeQaseIdsFromTitle;
+    constructor(options?: VitestQaseOptionsType);
+    /**
+     * Convert Vitest test result status to Qase TestStatusEnum
+     */
+    private convertStatus;
+    /**
+     * Create TestResultType from Vitest TestCase
+     */
+    private createTestResult;
+    onTestRunStart?(): void;
+    onTestRunEnd?(): Promise<void>;
+    onTestCaseResult?(testCase: TestCase): Promise<void>;
+    onTestCaseAnnotate?(testCase: TestCase, annotation: TestAnnotation): void;
+    onTestSuiteReady?(testSuite: TestSuite): void;
+    onTestSuiteResult?(): void;
+    private extractSuiteFromTestCase;
+}
+export default VitestQaseReporter;