@iamsergio/qttest-utils 1.1.2 → 1.3.0

package/CONTRIBUTING.md

@@ -32,7 +32,4 @@ export NEW_VERSION=v1.0.0
 - Optional: To get a version compatible with semver, run `git cliff --bump`
 - Increase version in package.json and package-lock.json.
 - 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
+- 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,11 +2,48 @@
 
 
 
+## [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
+
+## [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
 

package/out/cmake.d.ts

@@ -13,6 +13,7 @@ export declare class CMakeTests {
      */
     tests(): Promise<CMakeTest[] | undefined>;
     private ctestJsonToList;
+    cppFilesForExecutable(executable: string, codemodel: any): string[];
 }
 export declare class CMakeTest {
     command: string[];

package/out/cmake.js

@@ -72,6 +72,60 @@ class CMakeTests {
         });
         return tests;
     }
+    // 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);
+        }
+        let projects = codemodel["projects"];
+        if (!projects) {
+            return [];
+        }
+        for (let project of projects) {
+            let targets = project["targets"];
+            if (!targets) {
+                continue;
+            }
+            for (let target of targets) {
+                let sourceDir = target["sourceDirectory"];
+                let artifacts = target["artifacts"];
+                if (!artifacts || !sourceDir) {
+                    continue;
+                }
+                for (let artifact of artifacts) {
+                    if (artifact.endsWith(".exe")) {
+                        artifact = artifact.substring(0, artifact.length - 4);
+                    }
+                    if (artifact == executable) {
+                        let fileGroups = target["fileGroups"];
+                        if (!fileGroups) {
+                            continue;
+                        }
+                        for (let fileGroup of fileGroups) {
+                            if (fileGroup["language"] != "CXX" || fileGroup["isGenerated"]) {
+                                continue;
+                            }
+                            let sources = fileGroup["sources"];
+                            if (!sources) {
+                                continue;
+                            }
+                            let cppFiles = [];
+                            for (let source of sources) {
+                                if (!source.endsWith("mocs_compilation.cpp")) {
+                                    cppFiles.push(path_1.default.join(sourceDir, source));
+                                }
+                            }
+                            return cppFiles;
+                        }
+                    }
+                }
+            }
+        }
+        (0, qttest_1.logMessage)("cppFilesForExecutable: Could not find cpp files for executable " + executable);
+        return [];
+    }
 }
 exports.CMakeTests = CMakeTests;
 /// Represents an inividual CTest test

package/out/qttest.d.ts

@@ -15,6 +15,7 @@ export declare class QtTest {
     get id(): string;
     get label(): string;
     relativeFilename(): string;
+    filenameWithoutExtension(): string;
     /**
      * Calls "./yourqttest -functions" and stores the results in the slots property.
      */
@@ -71,6 +72,7 @@ export declare class QtTests {
     maintainMatching(regex: RegExp): void;
     dumpExecutablePaths(): void;
     dumpTestSlots(): Promise<void>;
+    executablesContainingSlot(slotName: string): QtTest[];
 }
 export interface TestFailure {
     name: string;

package/out/qttest.js

@@ -80,6 +80,13 @@ class QtTest {
         result = result.replace(/\\/g, "/");
         return result;
     }
+    /// returns filename without .exe extension
+    filenameWithoutExtension() {
+        let result = this.filename;
+        if (result.endsWith(".exe"))
+            result = result.slice(0, -4);
+        return result;
+    }
     /**
      * Calls "./yourqttest -functions" and stores the results in the slots property.
      */
@@ -134,6 +141,8 @@ class QtTest {
             return undefined;
         }
         return new Promise((resolve, reject) => {
+            if (this.verbose)
+                logMessage("qttest: Running ldd on " + this.filename);
             const child = (0, child_process_1.spawn)("ldd", [this.filename]);
             let output = "";
             let result = false;
@@ -144,7 +153,7 @@ class QtTest {
                     }
                 }
                 if (this.verbose)
-                    console.log(chunk.toString());
+                    logMessage(chunk.toString());
             });
             child.on("exit", (code) => {
                 if (code === 0) {
@@ -390,5 +399,15 @@ class QtTests {
             }
         });
     }
+    /// Returns all executables that contain a Qt test slot with the specified name
+    executablesContainingSlot(slotName) {
+        let result = [];
+        for (let ex of this.qtTestExecutables) {
+            if (ex.slotByName(slotName)) {
+                result.push(ex);
+            }
+        }
+        return result;
+    }
 }
 exports.QtTests = QtTests;

package/out/test.js

@@ -12,6 +12,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const cmake_1 = require("./cmake");
 const qttest_1 = require("./qttest");
 // Be sure to build the Qt tests with CMake first
 // See .github/workflows/ci.yml
@@ -92,6 +93,41 @@ function runTests(buildDirPath) {
             console.error("Expected test to fail: " + slot2.name);
             process.exit(1);
         }
+        // 5. Test executablesContainingSlot
+        let executables = qt.executablesContainingSlot("testB");
+        if (executables.length != 1) {
+            console.error("Expected 1 executable, got " + executables.length);
+            process.exit(1);
+        }
+        if (!executables[0].filenameWithoutExtension().endsWith("test1")) {
+            console.error("Expected filename to end with test1");
+            process.exit(1);
+        }
+        executables = qt.executablesContainingSlot("non_existing");
+        if (executables.length != 0) {
+            console.error("Expected 0 executables, got " + executables.length);
+            process.exit(1);
+        }
+    });
+}
+function runCodeModelTests(codeModelFile) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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);
+        if (files.length != 1) {
+            console.error("Expected 1 file, got " + files.length);
+            process.exit(1);
+        }
+        let expected = "/vscode-qttest/test/qt_test/test1.cpp";
+        let got = files[0].replace(/\\/g, "/");
+        if (got != expected) {
+            console.error("Expected " + expected + ", got " + got);
+            process.exit(1);
+        }
     });
 }
 runTests("test/qt_test/build-dev/");
+runCodeModelTests("test/test_cmake_codemodel.json");

package/package.json

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