@iamsergio/qttest-utils 2.1.1 → 2.2.1

package/Changelog

@@ -2,6 +2,33 @@
 
 
 
+## [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
+
+## [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
@@ -11,6 +38,7 @@
 ### ⚙️ Miscellaneous Tasks
 
 - Improve CONTRIBUTING.md
+- Bump version
 
 ## [2.1.0] - 2024-04-25
 

package/out/cmake.d.ts

@@ -13,8 +13,9 @@ export declare class CMakeTests {
      */
     tests(): Promise<CMakeTest[] | undefined>;
     private ctestJsonToList;
-    targetNameForExecutable(executable: string, codemodel: any): string | undefined;
-    cppFilesForExecutable(executable: string, codemodel: any): string[];
+    targetNameForExecutable(executable: string, codemodel: any, workaround?: boolean): string | undefined;
+    filenamesAreEqual(file1: string, file2: string, workaround?: boolean): boolean;
+    cppFilesForExecutable(executable: string, codemodel: any, workaround?: boolean): string[];
 }
 export declare class CMakeTest {
     command: string[];

package/out/cmake.js

@@ -74,13 +74,7 @@ class CMakeTests {
     }
     /// Returns the cmake target name for the specified executable
     /// codemodel should have a "projects" key at root.
-    targetNameForExecutable(executable, codemodel) {
-        // simplify:
-        if (executable.endsWith(".exe")) {
-            executable = executable.substring(0, executable.length - 4);
-        }
-        // replace backslashes with forward slashes
-        executable = executable.replace(/\\/g, "/");
+    targetNameForExecutable(executable, codemodel, workaround = false) {
         let projects = codemodel["projects"];
         if (!projects)
             return undefined;
@@ -96,9 +90,7 @@ class CMakeTests {
                     if (artifact.endsWith(".exe")) {
                         artifact = artifact.substring(0, artifact.length - 4);
                     }
-                    // replace backslashes with forward slashes
-                    artifact = artifact.replace(/\\/g, "/");
-                    if (artifact == executable) {
+                    if (this.filenamesAreEqual(executable, artifact, workaround)) {
                         let name = target["name"];
                         if (name) {
                             // We found the target name
@@ -110,16 +102,39 @@ class CMakeTests {
         }
         return undefined;
     }
+    /// Returns whether the two filenames are equal
+    /// 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"))
+            file1 = file1.substring(0, file1.length - 4);
+        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)
+            return true;
+        if (!workaround) {
+            // files aren't equal!
+            return false;
+        }
+        const fs = require('fs');
+        if (fs.existsSync(file2)) {
+            // It's a real file, not bogus.
+            return false;
+        }
+        /// Compare only basename, since path is bogus
+        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
     /// codemodel should have a "projects" key at root.
-    cppFilesForExecutable(executable, codemodel) {
-        // simplify:
-        if (executable.endsWith(".exe")) {
-            executable = executable.substring(0, executable.length - 4);
-        }
-        // replace backslashes with forward slashes
-        executable = executable.replace(/\\/g, "/");
+    /// @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)
             return [];
@@ -141,7 +156,7 @@ class CMakeTests {
                     }
                     // replace backslashes with forward slashes
                     artifact = artifact.replace(/\\/g, "/");
-                    if (artifact == executable) {
+                    if (this.filenamesAreEqual(executable, artifact, workaround)) {
                         let fileGroups = target["fileGroups"];
                         if (!fileGroups)
                             continue;

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,11 @@ 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)
+                        yield this.updateSubTestStates(cwdDir, slot);
+                    }
                     if (code === 0) {
                         resolve(true);
                     }
@@ -255,11 +270,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 +301,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 +347,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);
@@ -143,7 +157,51 @@ function runCodeModelTests(codeModelFile) {
             console.error("Expected test2, got " + targetName);
             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);
+        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);
+        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);
+        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);
+        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.1.1",
+  "version": "2.2.1",
   "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",