@iamsergio/qttest-utils 2.3.0 → 2.6.0

package/CHANGELOG.md

@@ -1,5 +1,72 @@
 # Changelog
 
+## [2.6.0](https://github.com/KDAB/qttest-utils/compare/v2.5.0...v2.6.0) (2026-04-05)
+
+
+### Features
+
+* propagate CTest ENVIRONMENT to spawned test processes ([ea24d96](https://github.com/KDAB/qttest-utils/commit/ea24d96545c3ac9d68fc9cfea8ab6b372055b804))
+* propagate CTest ENVIRONMENT to spawned test processes ([6a68cc7](https://github.com/KDAB/qttest-utils/commit/6a68cc7db40f53f3631579477deb780d36b36685))
+
+
+### Bug Fixes
+
+* made eslint pass ([6740d61](https://github.com/KDAB/qttest-utils/commit/6740d618843a9a0a55fd73b7cc9e0c9f2412788e))
+
+## [2.5.0](https://github.com/KDAB/qttest-utils/compare/v2.4.4...v2.5.0) (2026-04-04)
+
+
+### Features
+
+* move to node22 ([9918007](https://github.com/KDAB/qttest-utils/commit/9918007bb7765d0363452afdab06856d8505cf18))
+
+
+### Bug Fixes
+
+* Remove the npm publish stuff from CI ([84069f5](https://github.com/KDAB/qttest-utils/commit/84069f594073c1ea54fe58915aa1beb70353d7e0))
+
+## [2.4.4](https://github.com/KDAB/qttest-utils/compare/v2.4.3...v2.4.4) (2026-04-04)
+
+
+### Bug Fixes
+
+* Add verbose flag to publish ([1db610e](https://github.com/KDAB/qttest-utils/commit/1db610e9a372c88435460140e6e31769649bfcd0))
+
+## [2.4.3](https://github.com/KDAB/qttest-utils/compare/v2.4.2...v2.4.3) (2026-04-04)
+
+
+### Bug Fixes
+
+* normalize repository url for npm provenance ([4c74b4b](https://github.com/KDAB/qttest-utils/commit/4c74b4b47bb170840be6a1b3ae6e7d70ed333b97))
+
+## [2.4.2](https://github.com/KDAB/qttest-utils/compare/v2.4.1...v2.4.2) (2026-04-04)
+
+
+### Bug Fixes
+
+* Testing release process ([01e5b2e](https://github.com/KDAB/qttest-utils/commit/01e5b2e608289f9dc86ff553459276e4fc83a801))
+
+## [2.4.1](https://github.com/KDAB/qttest-utils/compare/v2.4.0...v2.4.1) (2026-04-04)
+
+
+### Bug Fixes
+
+* Remove cliff and update to new release-please action ([7480c13](https://github.com/KDAB/qttest-utils/commit/7480c132962de8274a7ccfaf84b19a8a5f192bfa))
+* Remove unneeded cruft from package ([b33c153](https://github.com/KDAB/qttest-utils/commit/b33c1538da9177ea11c1fd546075e149e32a6738))
+
+## [2.4.0](https://github.com/KDAB/qttest-utils/compare/v2.3.0...v2.4.0) (2026-04-03)
+
+
+### Features
+
+* bump TypeScript target to ES2022 and add engines field ([9d44860](https://github.com/KDAB/qttest-utils/commit/9d44860dc40b48373b3eaed22abf577e191a84c1))
+* rename cmake presets, make Qt6 the default ([#6](https://github.com/KDAB/qttest-utils/issues/6)) ([f60b6e7](https://github.com/KDAB/qttest-utils/commit/f60b6e72fdc1d6b3e86fb840c80aa8498c5bac94))
+
+
+### Bug Fixes
+
+* add rootDir to tsconfig to fix TS5011 with ES2022 target ([d921982](https://github.com/KDAB/qttest-utils/commit/d921982bbbda550f22aa764b6e138bd5fe761771))
+
 ## [2.3.0](https://github.com/KDAB/qttest-utils/compare/v2.2.2...v2.3.0) (2024-06-06)
 
 
@@ -13,3 +80,232 @@
 
 * Fix JSON output from ctest not being received ([9cea2c3](https://github.com/KDAB/qttest-utils/commit/9cea2c3dd4b5798f7f6f0bf382e5eca1694f0eb2))
 * Use tap-parser instead of regexp to parse tap files ([3d9f1f5](https://github.com/KDAB/qttest-utils/commit/3d9f1f5abc77d2af1a57ba6a75b89c8a3ad424ed))
+
+# Changelog
+
+
+
+## [2.2.2] - 2024-05-02
+
+### 🐛 Bug Fixes
+
+- Filter out weird tests
+
+### ⚙️ Miscellaneous Tasks
+
+- Code format cmake.ts
+
+## [2.2.1] - 2024-05-02
+
+### 🐛 Bug Fixes
+
+- Fix running non-Qt tests
+- Harden code against exception when reading .tap file
+
+### 🧪 Testing
+
+- Try fixing tests on macOS/Windows
+- Try harder to fix macOS/Windows tests
+
+### ⚙️ Miscellaneous Tasks
+
+- Ran code format on tests
+- Run codeformat on qttest.ts
+- Bump version
+
+## [2.2.0] - 2024-04-25
+
+### 🚀 Features
+
+- Allow to workaround microsoft/vscode-cmake-tools-api/issues/7
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version
+
+## [2.1.1] - 2024-04-25
+
+### 🐛 Bug Fixes
+
+- Allow for backslashes in the cmake codemodel
+
+### ⚙️ Miscellaneous Tasks
+
+- Improve CONTRIBUTING.md
+- Bump version
+
+## [2.1.0] - 2024-04-25
+
+### 🚀 Features
+
+- Add targetNameForExecutable()
+
+### 🐛 Bug Fixes
+
+- Ignore non-executable targets
+
+### ⚙️ Miscellaneous Tasks
+
+- Coding style improvement
+- Update CONTRIBUTING.md file
+- Fix build on macOS
+- Improve CONTRIBUTING.md
+- Bump version
+
+## [2.0.0] - 2024-04-24
+
+### 🚀 Features
+
+- [**breaking**] Use a member to hold the output function
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version
+
+## [1.4.0] - 2024-04-24
+
+### 🚀 Features
+
+- Allow the caller to pass a output callback
+
+### 🐛 Bug Fixes
+
+- When running a qttest, output to stdout
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version
+
+## [1.3.0] - 2024-04-23
+
+### 🚀 Features
+
+- Add cppFilesForExecutable(executable, codemodel)
+
+### 🧪 Testing
+
+- Add an example cmake code model
+- Normalize paths
+- Simplify some code
+- Fix replacing slashes
+
+### ⚙️ Miscellaneous Tasks
+
+- Add more logging
+- Bump version
+
+## [1.2.0] - 2024-04-22
+
+### 🚀 Features
+
+- Added executablesContainingSlot(name) public method
+
+### 📚 Documentation
+
+- Minor CONTRIBUTIND.md improvement
+- Minor CONTRIBUTIND.md improvement
+
+### 🧪 Testing
+
+- Fix test on windows
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version
+
+## [1.1.2] - 2024-04-07
+
+### ⚙️ Miscellaneous Tasks
+
+- Add more logging
+- Bump version
+
+## [1.1.1] - 2024-04-07
+
+### 🐛 Bug Fixes
+
+- Verbose logging not appearing in vscode
+
+### ⚙️ Miscellaneous Tasks
+
+- Improve CONTRIBUTING.md
+- Bump version
+
+## [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
+- Bump version
+
+## [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/out/cmake.d.ts

@@ -20,6 +20,7 @@ export declare class CMakeTests {
 export declare class CMakeTest {
     command: string[];
     cwd: string;
+    environment: string[];
     id(): string;
     label(): string;
     executablePath(): string;

package/out/cmake.js

@@ -2,15 +2,6 @@
 // SPDX-FileCopyrightText: 2023 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());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -25,6 +16,8 @@ const qttest_1 = require("./qttest");
  * Contains methods to discover Qt Tests via CMake
  */
 class CMakeTests {
+    // The build dir where we'll run
+    buildDirPath;
     constructor(buildDirPath) {
         this.buildDirPath = buildDirPath;
     }
@@ -33,39 +26,37 @@ class CMakeTests {
      *
      * @returns a promise with the list of tests
      */
-    tests() {
-        return __awaiter(this, void 0, void 0, function* () {
-            // TODO: Check if folder exists
-            if (this.buildDirPath.length == 0) {
-                console.error("Could not find out cmake build dir");
-                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) => {
-                    output += chunk.toString();
-                });
-                child.on("close", (code) => {
-                    if (code === 0) {
-                        if (output.length == 0) {
-                            console.error("ctestJsonToList: Empty json output. Command was ctest --show-only=json-v1 , in " +
-                                this.buildDirPath);
-                            reject(new Error("Failed to get ctest JSON output"));
-                        }
-                        else {
-                            resolve(this.ctestJsonToList(output));
-                        }
+    async tests() {
+        // TODO: Check if folder exists
+        if (this.buildDirPath.length === 0) {
+            console.error("Could not find out cmake build dir");
+            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) => {
+                output += chunk.toString();
+            });
+            child.on("close", (code) => {
+                if (code === 0) {
+                    if (output.length === 0) {
+                        console.error("ctestJsonToList: Empty json output. Command was ctest --show-only=json-v1 , in " +
+                            this.buildDirPath);
+                        reject(new Error("Failed to get ctest JSON output"));
                     }
                     else {
-                        reject(new Error("Failed to run ctest"));
+                        resolve(this.ctestJsonToList(output));
                     }
-                });
-                return undefined;
+                }
+                else {
+                    reject(new Error("Failed to run ctest"));
+                }
             });
+            return undefined;
         });
     }
     ctestJsonToList(json) {
@@ -77,20 +68,76 @@ class CMakeTests {
             let test = new CMakeTest();
             test.command = testJSON.command;
             test.cwd = testJSON.cwd;
+            // Extract environment information if present in ctest JSON.
+            // ctest may expose environment as `environment` (string or array),
+            // or embed it into `properties` either as an object or array.
+            try {
+                let envArr = undefined;
+                if (testJSON.environment) {
+                    envArr = Array.isArray(testJSON.environment)
+                        ? testJSON.environment
+                        : [testJSON.environment];
+                }
+                if (!envArr && testJSON.properties) {
+                    const props = testJSON.properties;
+                    // properties might be an object with ENVIRONMENT key or an array of {name,value} entries
+                    if (!Array.isArray(props) && props.ENVIRONMENT) {
+                        const val = props.ENVIRONMENT;
+                        if (typeof val === "string") {
+                            envArr = [val];
+                        }
+                        else if (Array.isArray(val)) {
+                            envArr = val;
+                        }
+                    }
+                    else if (Array.isArray(props)) {
+                        for (const p of props) {
+                            if (!p || !p.name) {
+                                continue;
+                            }
+                            if (p.name === "ENVIRONMENT" || p.name === "Environment") {
+                                const v = p.value;
+                                if (typeof v === "string") {
+                                    envArr = [v];
+                                }
+                                else if (Array.isArray(v)) {
+                                    envArr = v;
+                                }
+                                break;
+                            }
+                        }
+                    }
+                }
+                if (envArr) {
+                    test.environment = envArr;
+                }
+            }
+            catch (e) {
+                try {
+                    (0, qttest_1.logMessage)("ctest: failed to parse environment for test: " +
+                        JSON.stringify(testJSON) +
+                        " error: " +
+                        e);
+                }
+                catch (_) { }
+            }
             return test;
         });
         // filter invalid tests:
         tests = tests.filter((test) => {
             // pretty print test
-            if (!test.command || test.command.length == 0)
+            if (!test.command || test.command.length === 0) {
                 return false;
+            }
             let testExecutablePath = test.executablePath();
             let baseName = path_1.default.basename(testExecutablePath).toLowerCase();
-            if (baseName.endsWith(".exe"))
+            if (baseName.endsWith(".exe")) {
                 baseName = baseName.substring(0, baseName.length - 4);
+            }
             // People doing complicated things in add_test()
-            if (baseName == "ctest" || baseName === "cmake")
+            if (baseName === "ctest" || baseName === "cmake") {
                 return false;
+            }
             return true;
         });
         return tests;
@@ -99,16 +146,19 @@ class CMakeTests {
     /// codemodel should have a "projects" key at root.
     targetNameForExecutable(executable, codemodel, workaround = false) {
         let projects = codemodel["projects"];
-        if (!projects)
+        if (!projects) {
             return undefined;
+        }
         for (let project of projects) {
             let targets = project["targets"];
-            if (!targets)
+            if (!targets) {
                 continue;
+            }
             for (let target of targets) {
                 let artifacts = target["artifacts"];
-                if (!artifacts)
+                if (!artifacts) {
                     continue;
+                }
                 for (let artifact of artifacts) {
                     if (artifact.endsWith(".exe")) {
                         artifact = artifact.substring(0, artifact.length - 4);
@@ -129,18 +179,21 @@ class CMakeTests {
     /// If workaround is true, then we workaround microsoft/vscode-cmake-tools-api/issues/7 where
     /// the basename is correct but the path is bogus, and we only compare the basenames
     filenamesAreEqual(file1, file2, workaround = false) {
-        if (file1.endsWith(".exe"))
+        if (file1.endsWith(".exe")) {
             file1 = file1.substring(0, file1.length - 4);
-        if (file2.endsWith(".exe"))
+        }
+        if (file2.endsWith(".exe")) {
             file2 = file2.substring(0, file2.length - 4);
+        }
         file1 = file1.replace(/\\/g, "/");
         file2 = file2.replace(/\\/g, "/");
         if (process.platform === "win32") {
             file1 = file1.toLowerCase();
             file2 = file2.toLowerCase();
         }
-        if (file1 == file2)
+        if (file1 === file2) {
             return true;
+        }
         if (!workaround) {
             // files aren't equal!
             return false;
@@ -151,7 +204,7 @@ class CMakeTests {
             return false;
         }
         /// Compare only basename, since path is bogus
-        return path_1.default.basename(file1, ".exe") == path_1.default.basename(file2, ".exe");
+        return path_1.default.basename(file1, ".exe") === path_1.default.basename(file2, ".exe");
     }
     /// Returns the list of .cpp files for the specified executable
     /// codemodel is the CMake codemodel JSON object
@@ -159,20 +212,24 @@ class CMakeTests {
     /// @param workaround If true, worksaround https://github.com/microsoft/vscode-cmake-tools-api/issues/7
     cppFilesForExecutable(executable, codemodel, workaround = false) {
         let projects = codemodel["projects"];
-        if (!projects)
+        if (!projects) {
             return [];
+        }
         for (let project of projects) {
             let targets = project["targets"];
-            if (!targets)
+            if (!targets) {
                 continue;
+            }
             for (let target of targets) {
                 let sourceDir = target["sourceDirectory"];
                 let artifacts = target["artifacts"];
-                if (!artifacts || !sourceDir)
+                if (!artifacts || !sourceDir) {
                     continue;
+                }
                 let targetType = target["type"];
-                if (targetType != "EXECUTABLE")
+                if (targetType !== "EXECUTABLE") {
                     continue;
+                }
                 for (let artifact of artifacts) {
                     if (artifact.endsWith(".exe")) {
                         artifact = artifact.substring(0, artifact.length - 4);
@@ -181,14 +238,17 @@ class CMakeTests {
                     artifact = artifact.replace(/\\/g, "/");
                     if (this.filenamesAreEqual(executable, artifact, workaround)) {
                         let fileGroups = target["fileGroups"];
-                        if (!fileGroups)
+                        if (!fileGroups) {
                             continue;
+                        }
                         for (let fileGroup of fileGroups) {
-                            if (fileGroup["language"] != "CXX" || fileGroup["isGenerated"])
+                            if (fileGroup["language"] !== "CXX" || fileGroup["isGenerated"]) {
                                 continue;
+                            }
                             let sources = fileGroup["sources"];
-                            if (!sources)
+                            if (!sources) {
                                 continue;
+                            }
                             let cppFiles = [];
                             for (let source of sources) {
                                 if (!source.endsWith("mocs_compilation.cpp")) {
@@ -209,10 +269,9 @@ class CMakeTests {
 exports.CMakeTests = CMakeTests;
 /// Represents an inividual CTest test
 class CMakeTest {
-    constructor() {
-        this.command = [];
-        this.cwd = "";
-    }
+    command = [];
+    cwd = "";
+    environment = [];
     id() {
         return this.command.join(",");
     }