@iamsergio/qttest-utils 0.4.8 → 1.0.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,54 @@
+# Changelog
+
+
+
+## [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
+
+## [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,25 @@
 # 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/qttest-utils/actions/workflows/ci.yml/badge.svg
+![Pre-commit](https://github.com/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 ;).
 
+## Installation
+
+```bash
+npm i @iamsergio/qttest-utils
+```
 
 ## Example
 
-```
-$ cd test/qt_test
-$ cmake --preset=dev
-$ cmake --build build-dev/
-$ cd ../..
-$ tsc
-$ node out/example.js test/qt_test/build-dev
+```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/cmake.js

@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CMakeTest = exports.CMakeTests = void 0;
 const child_process_1 = require("child_process");
 const path_1 = __importDefault(require("path"));
+const qttest_1 = require("./qttest");
 /**
  * Represents tests added in cmake (Via add_test())
  *
@@ -40,6 +41,7 @@ class CMakeTests {
                 return undefined;
             }
             return new Promise((resolve, reject) => {
+                (0, qttest_1.logMessage)("Running ctest --show-only=json-v1 with cwd=" + this.buildDirPath);
                 const child = (0, child_process_1.spawn)("ctest", ["--show-only=json-v1"], { "cwd": this.buildDirPath });
                 let output = "";
                 child.stdout.on("data", (chunk) => {

package/out/example.js

@@ -54,6 +54,9 @@ function example() {
                 if (slot.lastTestFailure) {
                     console.log("        failed slot=" + slot.name + "; path=" + slot.lastTestFailure.filePath + "; line=" + slot.lastTestFailure.lineNumber);
                 }
+                else {
+                    console.log("        pass: " + slot.name);
+                }
             }
         }
         // Also run individual slots, just for example purposes:

package/out/qttest.d.ts

@@ -1,4 +1,5 @@
 type LoggerFunction = (arg: string) => void;
+export declare function logMessage(message: string): void;
 /**
  * Represents a single QtTest executable.
  * Supports listing the individual test slots
@@ -12,6 +13,7 @@ export declare class QtTest {
     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

@@ -38,7 +38,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QtTests = exports.QtTestSlot = exports.QtTest = void 0;
+exports.QtTests = exports.QtTestSlot = exports.QtTest = exports.logMessage = void 0;
 const child_process_1 = require("child_process");
 const path_1 = __importDefault(require("path"));
 const fs = __importStar(require("fs"));
@@ -49,6 +49,7 @@ function logMessage(message) {
         gLogFunction(message);
     }
 }
+exports.logMessage = logMessage;
 /**
  * Represents a single QtTest executable.
  * Supports listing the individual test slots
@@ -68,6 +69,10 @@ class QtTest {
     get label() {
         return path_1.default.basename(this.filename);
     }
+    relativeFilename() {
+        let current_dir = process.cwd();
+        return this.filename.replace(current_dir + "/", "");
+    }
     /**
      * Calls "./yourqttest -functions" and stores the results in the slots property.
      */
@@ -178,8 +183,8 @@ class QtTest {
         return undefined;
     }
     /// Runs this test
-    runTest(slot, cwd = "") {
-        return __awaiter(this, void 0, void 0, function* () {
+    runTest(slot_1) {
+        return __awaiter(this, arguments, void 0, function* (slot, cwd = "") {
             let args = [];
             if (slot) {
                 // Runs a single Qt test instead

package/out/test.d.ts

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

package/out/test.js

@@ -0,0 +1,90 @@
+"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);
+        }
+        // 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);
+            }
+            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.8",
+  "version": "1.0.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",