@iamsergio/qttest-utils 2.1.0 → 2.2.0

package/CONTRIBUTING.md

@@ -29,6 +29,6 @@ cargo install git-cliff
 - Get a version compatible with semver, run ` git cliff --bump | head -n 5`, replace NEW_VERSION
 - export NEW_VERSION=v1.0.0
 - Make sure Github Actions CI is green
-- npm version $NEW_VERSION
+- npm version $NEW_VERSION # ignore the error
 - git cliff --tag $NEW_VERSION > Changelog
 - git add Changelog package.json package-lock.json && git commit -m "chore: bump version" && git tag -a ${NEW_VERSION} -m "${NEW_VERSION}" && git push && git push --tags && npm publish

package/Changelog

@@ -2,6 +2,23 @@
 
 
 
+## [2.2.0] - 2024-04-25
+
+### 🚀 Features
+
+- Allow to workaround microsoft/vscode-cmake-tools-api/issues/7
+
+## [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
@@ -18,6 +35,7 @@
 - Update CONTRIBUTING.md file
 - Fix build on macOS
 - Improve CONTRIBUTING.md
+- Bump version
 
 ## [2.0.0] - 2024-04-24
 

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

@@ -73,11 +73,8 @@ class CMakeTests {
         return tests;
     }
     /// Returns the cmake target name for the specified executable
-    targetNameForExecutable(executable, codemodel) {
-        // simplify:
-        if (executable.endsWith(".exe")) {
-            executable = executable.substring(0, executable.length - 4);
-        }
+    /// codemodel should have a "projects" key at root.
+    targetNameForExecutable(executable, codemodel, workaround = false) {
         let projects = codemodel["projects"];
         if (!projects)
             return undefined;
@@ -93,7 +90,7 @@ class CMakeTests {
                     if (artifact.endsWith(".exe")) {
                         artifact = artifact.substring(0, artifact.length - 4);
                     }
-                    if (artifact == executable) {
+                    if (this.filenamesAreEqual(executable, artifact, workaround)) {
                         let name = target["name"];
                         if (name) {
                             // We found the target name
@@ -105,13 +102,39 @@ class CMakeTests {
         }
         return undefined;
     }
-    // Returns the list of .cpp files for the specified executable
-    // codemodel is the CMake codemodel JSON object
-    cppFilesForExecutable(executable, codemodel) {
-        // simplify:
-        if (executable.endsWith(".exe")) {
-            executable = executable.substring(0, executable.length - 4);
+    /// 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.
+    /// @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 [];
@@ -131,7 +154,9 @@ class CMakeTests {
                     if (artifact.endsWith(".exe")) {
                         artifact = artifact.substring(0, artifact.length - 4);
                     }
-                    if (artifact == executable) {
+                    // replace backslashes with forward slashes
+                    artifact = artifact.replace(/\\/g, "/");
+                    if (this.filenamesAreEqual(executable, artifact, workaround)) {
                         let fileGroups = target["fileGroups"];
                         if (!fileGroups)
                             continue;

package/out/test.js

@@ -132,6 +132,38 @@ function runCodeModelTests(codeModelFile) {
             console.error("Expected test1, got " + targetName);
             process.exit(1);
         }
+        // test windows back slashes:
+        files = cmake.cppFilesForExecutable("/vscode-qttest/test/qt_test/build-dev/test2", codemodelJson);
+        if (files.length != 1) {
+            console.error("Expected 1 file, got " + files.length);
+            process.exit(1);
+        }
+        targetName = cmake.targetNameForExecutable("/vscode-qttest/test/qt_test/build-dev/test2", codemodelJson);
+        if (targetName != "test2") {
+            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);
+        }
     });
 }
 runTests("test/qt_test/build-dev/");

package/package.json

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