@iamsergio/qttest-utils 2.2.0 → 2.2.2

package/Changelog

@@ -2,12 +2,44 @@
 
 
 
+## [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

package/out/cmake.js

@@ -42,7 +42,9 @@ class CMakeTests {
             }
             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 });
+                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();
@@ -70,6 +72,20 @@ class CMakeTests {
             test.cwd = testJSON.cwd;
             return test;
         });
+        // filter invalid tests:
+        tests = tests.filter((test) => {
+            // pretty print test
+            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"))
+                baseName = baseName.substring(0, baseName.length - 4);
+            // People doing complicated things in add_test()
+            if (baseName == "ctest" || baseName === "cmake")
+                return false;
+            return true;
+        });
         return tests;
     }
     /// Returns the cmake target name for the specified executable
@@ -122,7 +138,7 @@ class CMakeTests {
             // files aren't equal!
             return false;
         }
-        const fs = require('fs');
+        const fs = require("fs");
         if (fs.existsSync(file2)) {
             // It's a real file, not bogus.
             return false;
@@ -178,7 +194,8 @@ class CMakeTests {
                 }
             }
         }
-        (0, qttest_1.logMessage)("cppFilesForExecutable: Could not find cpp files for executable " + executable);
+        (0, qttest_1.logMessage)("cppFilesForExecutable: Could not find cpp files for executable " +
+            executable);
         return [];
     }
 }

package/out/qttest.js

@@ -102,7 +102,9 @@ class QtTest {
                     reject(new Error("qttest: File doesn't exit: " + this.filename));
                     return;
                 }
-                const child = (0, child_process_1.spawn)(this.filename, ["-functions"], { cwd: this.buildDirPath });
+                const child = (0, child_process_1.spawn)(this.filename, ["-functions"], {
+                    cwd: this.buildDirPath,
+                });
                 child.stdout.on("data", (chunk) => {
                     output += chunk.toString();
                 });
@@ -112,8 +114,8 @@ class QtTest {
                 child.on("exit", (code) => {
                     if (code === 0) {
                         slotNames = slotNames.concat(output.split("\n"));
-                        slotNames = slotNames.map(entry => entry.trim().replace("()", ""));
-                        slotNames = slotNames.filter(entry => entry.length > 0);
+                        slotNames = slotNames.map((entry) => entry.trim().replace("()", ""));
+                        slotNames = slotNames.filter((entry) => entry.length > 0);
                         if (slotNames.length > 0) {
                             this.slots = [];
                             for (var slotName of slotNames) {
@@ -124,7 +126,12 @@ class QtTest {
                         resolve(slotNames);
                     }
                     else {
-                        reject(new Error("qttest: Failed to run -functions, stdout=" + output + "; stderr=" + err + "; code=" + code));
+                        reject(new Error("qttest: Failed to run -functions, stdout=" +
+                            output +
+                            "; stderr=" +
+                            err +
+                            "; code=" +
+                            code));
                     }
                 });
             });
@@ -150,7 +157,8 @@ class QtTest {
             let result = false;
             child.stdout.on("data", (chunk) => {
                 if (!result) {
-                    if (chunk.toString().includes("libQt5Test.so") || chunk.toString().includes("libQt6Test.so")) {
+                    if (chunk.toString().includes("libQt5Test.so") ||
+                        chunk.toString().includes("libQt6Test.so")) {
                         result = true;
                     }
                 }
@@ -219,7 +227,12 @@ class QtTest {
             args = args.concat("-o").concat("-,txt");
             return yield new Promise((resolve, reject) => {
                 let cwdDir = cwd.length > 0 ? cwd : this.buildDirPath;
-                logMessage("Running " + this.filename + " " + args.join(" ") + " with cwd=" + cwdDir);
+                logMessage("Running " +
+                    this.filename +
+                    " " +
+                    args.join(" ") +
+                    " with cwd=" +
+                    cwdDir);
                 const child = (0, child_process_1.spawn)(this.filename, args, { cwd: cwdDir });
                 if (this.outputFunc) {
                     // Callers wants the process output:
@@ -239,9 +252,16 @@ class QtTest {
                     if (!slot) {
                         this.lastExitCode = code;
                     }
-                    /// When running a QtTest executable, let's check which sub-tests failed
-                    /// (So VSCode can show some error icon for each fail)
-                    yield this.updateSubTestStates(cwdDir, slot);
+                    if (this.slots && this.slots.length > 0) {
+                        /// When running a QtTest executable, let's check which sub-tests failed
+                        /// (So VSCode can show some error icon for each fail)
+                        try {
+                            yield this.updateSubTestStates(cwdDir, slot);
+                        }
+                        catch (e) {
+                            logMessage("Failed to update sub-test states: " + e);
+                        }
+                    }
                     if (code === 0) {
                         resolve(true);
                     }
@@ -255,11 +275,11 @@ class QtTest {
     /// Using .tap so we don't have to use a separate XML library
     /// .tap is plain text and a single regexp can catch the failing tests and line number
     tapOutputFileName(slot) {
-        let slotName = slot ? ("_" + slot.name) : "";
+        let slotName = slot ? "_" + slot.name : "";
         return this.label + slotName + ".tap";
     }
     txtOutputFileName(slot) {
-        let slotName = slot ? ("_" + slot.name) : "";
+        let slotName = slot ? "_" + slot.name : "";
         return this.label + slotName + ".txt";
     }
     command() {
@@ -286,7 +306,7 @@ class QtTest {
                         // at: MyTest::testF() (/some/path/qttest-utils/test/qt_test/test2.cpp:13)
                         const pattern = /at:\s+(.+?)::(.+?)\(\)\s+\((.+?):(\d+)\)/gm;
                         const matches = Array.from(data.matchAll(pattern));
-                        const failedResults = matches.map(match => ({
+                        const failedResults = matches.map((match) => ({
                             name: match[2],
                             filePath: match[3],
                             lineNumber: parseInt(match[4]),
@@ -332,7 +352,11 @@ class QtTestSlot {
         });
     }
     command() {
-        return { label: this.name, executablePath: this.absoluteFilePath, args: [this.name] };
+        return {
+            label: this.name,
+            executablePath: this.absoluteFilePath,
+            args: [this.name],
+        };
     }
 }
 exports.QtTestSlot = QtTestSlot;

package/out/test.js

@@ -23,19 +23,33 @@ function runTests(buildDirPath) {
         let expected_executables = [
             "test/qt_test/build-dev/test1",
             "test/qt_test/build-dev/test2",
-            "test/qt_test/build-dev/test3"
+            "test/qt_test/build-dev/test3",
+            "test/qt_test/build-dev/non_qttest",
         ];
         if (qt.qtTestExecutables.length != expected_executables.length) {
             console.error("Expected 3 executables, got " + qt.qtTestExecutables.length);
             process.exit(1);
         }
         yield qt.removeNonLinking();
+        /// On macOS and Windows we don't have ldd or equivalent, so we can't check if the test links to QtTest
+        /// Use the help way instead
+        yield qt.removeByRunningHelp();
+        /// Remove the non-qttest executable from qt.qtTestExecutables
+        qt.qtTestExecutables = qt.qtTestExecutables.filter((e) => !e.filenameWithoutExtension().endsWith("non_qttest"));
+        if (qt.qtTestExecutables.length != 3) {
+            console.error("Expected 3 executables, at this point 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());
+                console.error("Expected executable " +
+                    expected +
+                    ", got " +
+                    executable.relativeFilename());
                 process.exit(1);
             }
             i++;
@@ -112,8 +126,8 @@ function runTests(buildDirPath) {
 }
 function runCodeModelTests(codeModelFile) {
     return __awaiter(this, void 0, void 0, function* () {
-        const fs = require('fs');
-        let codemodelStr = fs.readFileSync(codeModelFile, 'utf8');
+        const fs = require("fs");
+        let codemodelStr = fs.readFileSync(codeModelFile, "utf8");
         let codemodelJson = JSON.parse(codemodelStr);
         let cmake = new cmake_1.CMakeTests("random");
         let files = cmake.cppFilesForExecutable("/vscode-qttest/test/qt_test/build-dev/test1", codemodelJson);
@@ -144,27 +158,50 @@ function runCodeModelTests(codeModelFile) {
             process.exit(1);
         }
         // test workaround for microsoft/vscode-cmake-tools-api/issues/7
-        files = cmake.cppFilesForExecutable("/vscode-qttest/test/qt_test/build-dev/test3", codemodelJson, /*workaround=*/ false);
+        files = cmake.cppFilesForExecutable("/vscode-qttest/test/qt_test/build-dev/test3", codemodelJson, 
+        /*workaround=*/ false);
         if (files.length !== 0) {
             console.error("Expected 0 files, got " + files.length);
             process.exit(1);
         }
-        files = cmake.cppFilesForExecutable("/vscode-qttest/test/qt_test/build-dev/test3", codemodelJson, /*workaround=*/ true);
+        files = cmake.cppFilesForExecutable("/vscode-qttest/test/qt_test/build-dev/test3", codemodelJson, 
+        /*workaround=*/ true);
         if (files.length !== 1) {
             console.error("Expected 0 files, got " + files.length);
             process.exit(1);
         }
-        targetName = cmake.targetNameForExecutable("/vscode-qttest/test/qt_test/build-dev/test3", codemodelJson, /*workaround=*/ false);
+        targetName = cmake.targetNameForExecutable("/vscode-qttest/test/qt_test/build-dev/test3", codemodelJson, 
+        /*workaround=*/ false);
         if (targetName) {
             console.error("Expected null, got " + targetName);
             process.exit(1);
         }
-        targetName = cmake.targetNameForExecutable("/vscode-qttest/test/qt_test/build-dev/test3", codemodelJson, /*workaround=*/ true);
+        targetName = cmake.targetNameForExecutable("/vscode-qttest/test/qt_test/build-dev/test3", codemodelJson, 
+        /*workaround=*/ true);
         if (targetName != "test3") {
             console.error("Expected null, got " + targetName);
             process.exit(1);
         }
     });
 }
+function runNonQtTest(buildDirPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let qt = new qttest_1.QtTests();
+        yield qt.discoverViaCMake(buildDirPath);
+        var nonQtExecutable = undefined;
+        for (let executable of qt.qtTestExecutables) {
+            if (executable.filenameWithoutExtension().endsWith("non_qttest")) {
+                nonQtExecutable = executable;
+                break;
+            }
+        }
+        if (nonQtExecutable === undefined) {
+            console.error("Expected to find non-Qt test executable");
+            process.exit(1);
+        }
+        yield nonQtExecutable.runTest();
+    });
+}
 runTests("test/qt_test/build-dev/");
+runNonQtTest("test/qt_test/build-dev/");
 runCodeModelTests("test/test_cmake_codemodel.json");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iamsergio/qttest-utils",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "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",