@iamsergio/qttest-utils 0.4.9 → 1.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Tips for contributors
+
+## Prepare your development environment
+
+Just follow `.devcontainer/Dockerfile` to see what's needed.<br?>
+Basically it's just `nodejs` >= v18 `tsc` and `npm`. <br>
+Qt5, cmake and ninja if you want to run the tests.
+
+
+## Running tests
+
+```bash
+tsc
+node out/test.js
+```
+
+Or simply let GitHub actions run the tests for you.<br>
+See `ci.yml` for how we run the tests.
+
+## Install git-cliff
+
+```bash
+cargo install git-cliff
+```
+
+## Releasing
+
+(Replace 1.0.0 with actual version used)
+
+- Make sure Github Actions CI is green
+- Optional: To get a version compatible with semver, run `git cliff --bump`
+- Increase version in package.json and package-lock.json.
+- git cliff --tag 1.0.0 > Changelog
+- git add Changelog package.json package-lock.json && git commit -m "chore: bump version"
+- git tag -a v1.0.0 -m 'v1.0.0'
+- git push --tags
+- npm publish

package/Changelog

@@ -0,0 +1,82 @@
+# Changelog
+
+
+
+## [1.1.0] - 2024-04-07
+
+### 🚀 Features
+
+- Added QtTest.verbose property
+
+### 🧪 Testing
+
+- Add a QBENCHMARK
+- Fix tests on windows
+- Fix more cases of wrong slashes
+- Test linksToQtTestLib too
+
+### ⚙️ Miscellaneous Tasks
+
+- Minor readme comment
+- Update .npmignore
+- Fix typo in README
+- Fix badge urls in README
+- Mention the vscode extension in the README
+- Remove duplicate vscode workspace file
+- Add macOS and Windows to CI
+- Make npm install be verose
+- Trying fixing the path for tsc on macos
+- Update packages
+
+## [1.0.0] - 2024-04-04
+
+### 🧪 Testing
+
+- Add a proper test and add it to cI
+
+### ⚙️ Miscellaneous Tasks
+
+- Add a git-cliff configuration file
+- Add pre-commit support
+- README improvements
+- Add installation instructions to README
+- Add a Dockerfile with nodejs 18
+- *(ci)* Make pre-commit run on master branch
+- Update version in package-lock.json
+- *(docker)* Install npm, Qt5 and typescript
+- *(ci)* Run tsc in ci
+- *(ci)* Fix typo in yml file
+- *(ci)* Bump to checkout v4
+- *(ci)* Bump to setup-node v4
+- *(ci)* Rename main ci job to 'build'
+- *(vscode)* Add a workspace file
+- Formatted some code automatically
+- Fix typo in comment
+- *(ci)* Install Qt and ninja
+- Bump to version 1.0.0
+- Regenerate out/
+- Add a CONTRIBUTING.md file
+- Update changelog
+- Add ci badges to readme
+
+## [0.4.9] - 2023-04-06
+
+### 🧪 Testing
+
+- Make test3 abort at the beginning
+
+## [0.4.7] - 2023-04-02
+
+### 🧪 Testing
+
+- Rename the test slots
+
+### README
+
+- Explain how to run the example
+
+### Minor
+
+- Ran formatting
+- Pass the entire slot
+

package/README.md

@@ -1,17 +1,27 @@
 # nodejs qttest-utils
 
-A nodejs module for listing Qt Test executables and their individual test slots from a CMake build directory.
+![Build Status](https://github.com/KDAB/qttest-utils/actions/workflows/ci.yml/badge.svg)
+![Pre-commit](https://github.com/KDAB/qttest-utils/actions/workflows/pre-commit.yml/badge.svg)
+
+A [nodejs](https://www.npmjs.com/package/@iamsergio/qttest-utils) module for listing Qt Test executables and their individual test slots from a CMake build directory.
 
 To be used by vscode extensions that implement the `Testing API`, but can also be used standalone for whatever reason ;).
 
+Used by [vscode-qttest](https://github.com/KDAB/vscode-qttest) extension.
 
-## Example
+## Installation
 
+```bash
+npm i @iamsergio/qttest-utils
 ```
-$ cd test/qt_test
-$ cmake --preset=dev
-$ cmake --build build-dev/
-$ cd ../..
-$ tsc
-$ node out/example.js test/qt_test/build-dev
+
+## Example
+
+```bash
+cd test/qt_test
+cmake --preset=dev
+cmake --build build-dev/
+cd ../..
+tsc
+node out/example.js test/qt_test/build-dev
 ```

package/out/qttest.d.ts

@@ -7,12 +7,14 @@ export declare function logMessage(message: string): void;
 export declare class QtTest {
     readonly filename: string;
     readonly buildDirPath: string;
+    verbose: boolean;
     vscodeTestItem: any | undefined;
     slots: QtTestSlot[] | null;
     lastExitCode: number;
     constructor(filename: string, buildDirPath: string);
     get id(): string;
     get label(): string;
+    relativeFilename(): string;
     /**
      * Calls "./yourqttest -functions" and stores the results in the slots property.
      */

package/out/qttest.js

@@ -56,6 +56,8 @@ exports.logMessage = logMessage;
  */
 class QtTest {
     constructor(filename, buildDirPath) {
+        /// If true, will print more verbose output
+        this.verbose = false;
         /// The list of individual runnable test slots
         this.slots = null;
         /// Set after running
@@ -69,6 +71,15 @@ class QtTest {
     get label() {
         return path_1.default.basename(this.filename);
     }
+    relativeFilename() {
+        let result = path_1.default.relative(process.cwd(), this.filename);
+        // strip .exe, as we only use this for tests
+        if (result.endsWith(".exe"))
+            result = result.slice(0, -4);
+        // normalize slashes
+        result = result.replace(/\\/g, "/");
+        return result;
+    }
     /**
      * Calls "./yourqttest -functions" and stores the results in the slots property.
      */
@@ -79,7 +90,7 @@ class QtTest {
             let err = "";
             yield new Promise((resolve, reject) => {
                 if (!fs.existsSync(this.filename)) {
-                    reject(new Error("File doesn't exit: " + this.filename));
+                    reject(new Error("qttest: File doesn't exit: " + this.filename));
                     return;
                 }
                 const child = (0, child_process_1.spawn)(this.filename, ["-functions"], { cwd: this.buildDirPath });
@@ -104,7 +115,7 @@ class QtTest {
                         resolve(slotNames);
                     }
                     else {
-                        reject(new Error("Failed to run -functions, stdout=" + output + "; stderr=" + err + "; code=" + code));
+                        reject(new Error("qttest: Failed to run -functions, stdout=" + output + "; stderr=" + err + "; code=" + code));
                     }
                 });
             });
@@ -132,13 +143,15 @@ class QtTest {
                         result = true;
                     }
                 }
+                if (this.verbose)
+                    console.log(chunk.toString());
             });
             child.on("exit", (code) => {
                 if (code === 0) {
                     resolve(result);
                 }
                 else {
-                    reject(new Error("Failed to run ldd"));
+                    reject(new Error("qttest: Failed to run ldd"));
                 }
             });
         });

package/out/test.d.ts

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

package/out/test.js

@@ -0,0 +1,97 @@
+"use strict";
+// SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+// Author: Sergio Martins <sergio.martins@kdab.com>
+// SPDX-License-Identifier: MIT
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const qttest_1 = require("./qttest");
+// Be sure to build the Qt tests with CMake first
+// See .github/workflows/ci.yml
+function runTests(buildDirPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let qt = new qttest_1.QtTests();
+        yield qt.discoverViaCMake(buildDirPath);
+        let expected_executables = [
+            "test/qt_test/build-dev/test1",
+            "test/qt_test/build-dev/test2",
+            "test/qt_test/build-dev/test3"
+        ];
+        if (qt.qtTestExecutables.length != expected_executables.length) {
+            console.error("Expected 3 executables, got " + qt.qtTestExecutables.length);
+            process.exit(1);
+        }
+        yield qt.removeNonLinking();
+        // 1. Test that the executable test names are correct:
+        var i = 0;
+        for (var executable of qt.qtTestExecutables) {
+            let expected = expected_executables[i];
+            if (executable.relativeFilename() != expected) {
+                console.error("Expected executable " + expected + ", got " + executable.relativeFilename());
+                process.exit(1);
+            }
+            i++;
+        }
+        // 2. Test that the discovered slots are correct:
+        yield qt.dumpTestSlots();
+        let expected_slots = {
+            "test/qt_test/build-dev/test1": ["testA", "testB", "testC"],
+            "test/qt_test/build-dev/test2": ["testD", "testE", "testF"],
+            "test/qt_test/build-dev/test3": ["testAbortsEverythig", "testH", "testI"],
+        };
+        for (var executable of qt.qtTestExecutables) {
+            var i = 0;
+            for (let slot of executable.slots) {
+                let expected_slot = expected_slots[executable.relativeFilename()][i];
+                if (slot.name != expected_slot) {
+                    console.error("Expected slot " + expected_slot + ", got " + slot.name);
+                    process.exit(1);
+                }
+                i++;
+            }
+        }
+        // 3. Run the tests:
+        let expected_success = [true, false, false];
+        var i = 0;
+        for (var executable of qt.qtTestExecutables) {
+            yield executable.runTest();
+            let wasSuccess = executable.lastExitCode === 0;
+            if (wasSuccess && !expected_success[i]) {
+                console.error("Expected test to fail: " + executable.filename);
+                process.exit(1);
+            }
+            else if (!wasSuccess && expected_success[i]) {
+                console.error("Expected test to pass: " + executable.filename);
+                process.exit(1);
+            }
+            if (process.platform === "linux") {
+                if (!executable.linksToQtTestLib()) {
+                    console.error("Expected test to link to QtTest: " + executable.filename);
+                    process.exit(1);
+                }
+            }
+            i++;
+        }
+        // 4. Run individual slots:
+        let slot = qt.qtTestExecutables[0].slots[0];
+        yield slot.runTest();
+        if (slot.lastTestFailure) {
+            console.error("Expected test to pass: " + slot.name);
+            process.exit(1);
+        }
+        let slot2 = qt.qtTestExecutables[1].slots[2];
+        yield slot2.runTest();
+        if (!slot2.lastTestFailure) {
+            console.error("Expected test to fail: " + slot2.name);
+            process.exit(1);
+        }
+    });
+}
+runTests("test/qt_test/build-dev/");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iamsergio/qttest-utils",
-  "version": "0.4.9",
+  "version": "1.1.0",
   "description": "API for listing QtTest executables from a build directory and which individual test slots each executable contains. Useful for a Text Explorer VSCode extension.",
   "repository": {
     "type": "git",
@@ -21,6 +21,6 @@
   "devDependencies": {
     "@types/node": "^18.15.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.4.4"
   }
 }