@motherofmeow/codeceptjs-qase 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 PeterNgTr <peter.nguyentr@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+##### Qase TSM
+
+Qase integration with CodeceptJS. The test run is created automatically after the test execution.
+
+
+##### Requirement
+
+To use this plugin
+
+```sh
+npm i @motherofmeow/codeceptjs-qase --save
+```
+
+**Note:**
+
+- You should include the test case id to make it works, otherwise, this plugin has no clue which case id to be added to test run on Qaseio.
+- To avoid creating multiple testruns, add `--suites` to `run-workers` command
+
+```sh
+npx codeceptjs run-workers 3 --suites
+```
+
+An example:
+
+```js
+...
+  Scenario('Search function is displayed @C12345', ({I, homePage}) => {
+    I.seeElement(homePage.searchTextbox);
+    I.seeElement(homePage.searchButton);
+  });
+...
+```
+
+**Data driven tests**
+
+If you want to have different Data-driven test cases with different IDs in Qase for each iteration of the test you will need to populate the Data object with your a tag. This works because CodeceptJS extracts tags from test names, and data for Data-driven tests is populated in the test name.
+
+An example:
+
+```js
+...
+  let accounts = new DataTable(['testRailTag', 'user', 'password']);
+  accounts.add(['@C12345', 'davert', '123456']); // add a tag for each user along with their test data
+  accounts.add(['@C45678', 'admin', '123456']);
+  
+  Data(accounts).Scenario('Test Login', ({ I, current }) => {
+    I.fillField('Username', current.login); // current is reserved!
+    I.fillField('Password', current.password);
+    I.click('Sign In');
+    I.see('Welcome '+ current.login);
+  });
+...
+```
+
+A Gherkin example:
+
+```gherkin
+  @smoke
+  @12345
+  Scenario: Search function is displayed
+    Given I am on the home page
+    Then I see search textbox
+    And I see search button
+```
+
+```gherkin
+  @someTag
+  Scenario Outline: Fill some field
+    When I fill some field by text <text>
+    Then I see text <text>
+    
+    Examples:
+      | testRailTag | text      |
+      | @C1234      | someText1 |
+      | @C1235      | someText2 |
+```
+
+##### Configuration
+
+Adding this plugin to CodeceptJS config file:
+  
+```js
+...
+plugins: {
+    qase: {
+        require: "@motherofmeow/codeceptjs-qase", 
+        apiKey: "your api token",
+        projectName: process.env.QASE_PROJECT_NAME,
+        enabled: process.env.QASE_REPORT || false,
+        runId: process.env.TEST_RUN_ID, 
+        testRunTags: ['smoke-tests']
+    }
+}
+...
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const date_fns_1 = require("date-fns");
+const qaseio_1 = require("qaseio");
+const codeceptjs_1 = require("codeceptjs");
+const helpers = codeceptjs_1.container.helpers();
+const supportedHelpers = [
+    'WebDriver',
+    'Appium',
+    'Nightmare',
+    'Puppeteer',
+    'Playwright',
+    'TestCafe',
+    'REST'
+];
+const defaultConfig = {
+    apiKey: '',
+    projectName: '',
+    enabled: false,
+};
+let helper;
+for (const helperName of supportedHelpers) {
+    if (Object.keys(helpers).indexOf(helperName) > -1) {
+        helper = helpers[helperName];
+    }
+}
+module.exports = (config) => {
+    config = Object.assign(defaultConfig, config);
+    if (config.apiKey === '' || config.apiKey === undefined)
+        throw new Error('Please provide proper Qaseio api key');
+    if (config.projectName === '' || config.projectName === undefined)
+        throw new Error('Please provide proper Qaseio project name');
+    const qase = new qaseio_1.QaseApi({ token: config.apiKey });
+    let runId;
+    let failedTests = [];
+    const passedTests = [];
+    const errors = {};
+    const prefixTag = '@C';
+    const defaultElapsedTime = '1000';
+    const ids = [];
+    const runName = config.runName ? config.runName : `New test run on ${(0, date_fns_1.format)(new Date(), 'yyyy-MM-dd\'T\'HH:mm:ss.s')}`;
+    async function _createTestRunResult(projectName, runId, results) {
+        try {
+            const resultCreate = { case_id: results.caseId, status: results.status, time_ms: results.time_ms, stacktrace: results.stacktrace };
+            return qase.results.createResult(projectName, Number(runId), resultCreate);
+        }
+        catch (error) {
+            console.log(`Cannot create test run result due to ${error}`);
+        }
+    }
+    async function _getRuns(projectName) {
+        try {
+            const res = await qase.runs.getRuns(projectName);
+            return res.data.result.entities;
+        }
+        catch (error) {
+            console.log(`Cannot get new test run due to ${JSON.stringify(error)}`);
+        }
+    }
+    async function _addTestRun(projectName, runName, cases, description, testRunTags) {
+        try {
+            const runCreate = { title: runName, cases, description, tags: testRunTags };
+            const res = await qase.runs.createRun(projectName, runCreate);
+            return res.data.result.id;
+        }
+        catch (error) {
+            console.log(`Cannot create new test run due to ${JSON.stringify(error)}`);
+        }
+    }
+    codeceptjs_1.event.dispatcher.on(codeceptjs_1.event.test.started, async (test) => {
+        if (test.body) {
+            if (test.body.includes('addExampleInTable')) {
+                const qaseTag = /"qaseTag":"(@C\d+)"/.exec(test.title);
+                if (qaseTag) {
+                    test.tags.push(qaseTag[1]);
+                }
+            }
+        }
+        test.startTime = Date.now();
+    });
+    const failedTestCaseIds = new Set();
+    codeceptjs_1.event.dispatcher.on(codeceptjs_1.event.test.failed, async (test, err) => {
+        test.endTime = Date.now();
+        test.elapsed = Math.round(test.endTime - test.startTime);
+        test.tags.forEach((tag) => {
+            if (tag.includes(prefixTag)) {
+                const caseId = parseInt(tag.split(prefixTag)[1], 10);
+                if (!failedTestCaseIds.has(caseId)) {
+                    // else it also failed on retry so we shouldnt add in a duplicate
+                    failedTestCaseIds.add(caseId);
+                    failedTests.push({ case_id: caseId, elapsed: test.elapsed === 0 ? defaultElapsedTime : test.elapsed });
+                }
+                errors[tag.split(prefixTag)[1]] = err;
+            }
+        });
+    });
+    codeceptjs_1.event.dispatcher.on(codeceptjs_1.event.test.passed, (test) => {
+        test.endTime = Date.now();
+        test.elapsed = Math.round(test.endTime - test.startTime);
+        test.tags.forEach(tag => {
+            if (tag.includes(prefixTag)) {
+                const caseId = parseInt(tag.split(prefixTag)[1], 10);
+                // remove duplicates caused by retries
+                if (failedTestCaseIds.has(caseId)) {
+                    failedTests = failedTests.filter(({ case_id }) => case_id !== caseId);
+                }
+                passedTests.push({ case_id: caseId, elapsed: test.elapsed === 0 ? defaultElapsedTime : test.elapsed });
+            }
+        });
+    });
+    codeceptjs_1.event.dispatcher.once(codeceptjs_1.event.all.after, async () => {
+        const mergedTests = failedTests.concat(passedTests);
+        mergedTests.forEach(test => {
+            for (const [key, value] of Object.entries(test)) {
+                if (key === 'case_id') {
+                    ids.push(value);
+                }
+            }
+        });
+        try {
+            if (config.runId) {
+                runId = config.runId;
+            }
+            else {
+                const existingRuns = await _getRuns(config.projectName);
+                if (existingRuns.length > 0) {
+                    for (const run of existingRuns) {
+                        if (run.title !== runName) {
+                            runId = await _addTestRun(config.projectName, runName, ids, config.description, config.testRunTags);
+                            break;
+                        }
+                    }
+                }
+                else {
+                    runId = await _addTestRun(config.projectName, runName, ids, config.description, config.testRunTags);
+                }
+            }
+        }
+        catch (error) {
+            console.log(error);
+        }
+        if (ids.length > 0) {
+            passedTests.forEach(test => {
+                try {
+                    _createTestRunResult(config.projectName, runId, { caseId: test.case_id, status: 'passed', time_ms: test.elapsed }).then(() => console.log());
+                }
+                catch (e) {
+                    console.log(e);
+                }
+            });
+            failedTests.forEach(test => {
+                try {
+                    const errorString = errors[test.case_id]['message'] ? errors[test.case_id]['message'].replace(/\u001b\[.*?m/g, '') : errors[test.case_id];
+                    _createTestRunResult(config.projectName, runId, { caseId: test.case_id, status: 'failed', time_ms: test.elapsed, stacktrace: errorString }).then(() => console.log());
+                }
+                catch (e) {
+                    console.log(e);
+                }
+            });
+        }
+        else {
+            console.log('There is no TC, hence no test run is created');
+        }
+    });
+    return this;
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@motherofmeow/codeceptjs-qase",
+  "version": "1.0.0",
+  "description": "CodeceptJS plugin for Qaseio",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MotherOfMeow/codeceptjs-qaseio.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "codeceptJS",
+    "codeceptjs",
+    "qaseio",
+    "qaseio-plugin"
+  ],
+  "author": "Anastasia M <motherofmeow77@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/MotherOfMeow/codeceptjs-qaseio/issues"
+  },
+  "homepage": "https://github.com/MotherOfMeow/codeceptjs-qaseio#readme",
+  "engines": {
+    "node": ">=20.8.1"
+  },
+  "dependencies": {
+    "date-fns": "^4.4.0",
+    "qaseio": "^2.4.3",
+    "typescript": "^5.9.3",
+    "codeceptjs": "^4.1.0"
+  },
+  "scripts": {
+    "lint": "eslint . --fix",
+    "semantic-release": "semantic-release",
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "@types/node": "^20.19",
+    "eslint": "^8.57.1",
+    "playwright": "^1.63.0",
+    "semantic-release": "^24.2.9"
+  },
+  "files": [
+    "dist/*"
+  ]
+}