@iamsergio/qttest-utils 1.4.0 → 2.1.0

package/CONTRIBUTING.md

@@ -26,10 +26,9 @@ cargo install git-cliff
 ## Releasing
 
 (Replace 1.0.0 with actual version used)
-
-export NEW_VERSION=v1.0.0
+- 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
-- Optional: To get a version compatible with semver, run `git cliff --bump`
-- Increase version in package.json and package-lock.json.
+- npm version $NEW_VERSION
 - 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,33 @@
 
 
 
+## [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
+
+## [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
@@ -12,6 +39,10 @@
 
 - When running a qttest, output to stdout
 
+### ⚙️ Miscellaneous Tasks
+
+- Bump version
+
 ## [1.3.0] - 2024-04-23
 
 ### 🚀 Features

package/out/cmake.d.ts

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

package/out/cmake.js

@@ -72,6 +72,39 @@ 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);
+        }
+        let projects = codemodel["projects"];
+        if (!projects)
+            return undefined;
+        for (let project of projects) {
+            let targets = project["targets"];
+            if (!targets)
+                continue;
+            for (let target of targets) {
+                let artifacts = target["artifacts"];
+                if (!artifacts)
+                    continue;
+                for (let artifact of artifacts) {
+                    if (artifact.endsWith(".exe")) {
+                        artifact = artifact.substring(0, artifact.length - 4);
+                    }
+                    if (artifact == executable) {
+                        let name = target["name"];
+                        if (name) {
+                            // We found the target name
+                            return name;
+                        }
+                    }
+                }
+            }
+        }
+        return undefined;
+    }
     // Returns the list of .cpp files for the specified executable
     // codemodel is the CMake codemodel JSON object
     cppFilesForExecutable(executable, codemodel) {
@@ -80,37 +113,34 @@ class CMakeTests {
             executable = executable.substring(0, executable.length - 4);
         }
         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")
                     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) {
+                        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")) {

package/out/qttest.d.ts

@@ -11,6 +11,7 @@ export declare class QtTest {
     vscodeTestItem: any | undefined;
     slots: QtTestSlot[] | null;
     lastExitCode: number;
+    outputFunc: LoggerFunction | undefined;
     constructor(filename: string, buildDirPath: string);
     get id(): string;
     get label(): string;
@@ -30,7 +31,7 @@ export declare class QtTest {
     linksToQtTestLib(): Promise<boolean> | undefined;
     isQtTestViaHelp(): Promise<boolean | undefined>;
     slotByName(name: string): QtTestSlot | undefined;
-    runTest(slot?: QtTestSlot, cwd?: string, outputFunc?: LoggerFunction | undefined): Promise<boolean>;
+    runTest(slot?: QtTestSlot, cwd?: string): Promise<boolean>;
     tapOutputFileName(slot?: QtTestSlot): string;
     txtOutputFileName(slot?: QtTestSlot): string;
     command(): {

package/out/qttest.js

@@ -62,6 +62,8 @@ class QtTest {
         this.slots = null;
         /// Set after running
         this.lastExitCode = 0;
+        /// Allows the caller to receive the output of the test process
+        this.outputFunc = undefined;
         this.filename = filename;
         this.buildDirPath = buildDirPath;
     }
@@ -201,7 +203,7 @@ class QtTest {
         return undefined;
     }
     /// Runs this test
-    runTest(slot, cwd = "", outputFunc = undefined) {
+    runTest(slot, cwd = "") {
         return __awaiter(this, void 0, void 0, function* () {
             let args = [];
             if (slot) {
@@ -219,13 +221,15 @@ class QtTest {
                 let cwdDir = cwd.length > 0 ? cwd : this.buildDirPath;
                 logMessage("Running " + this.filename + " " + args.join(" ") + " with cwd=" + cwdDir);
                 const child = (0, child_process_1.spawn)(this.filename, args, { cwd: cwdDir });
-                if (outputFunc) {
+                if (this.outputFunc) {
                     // Callers wants the process output:
                     child.stdout.on("data", (chunk) => {
-                        outputFunc(chunk.toString());
+                        if (this.outputFunc)
+                            this.outputFunc(chunk.toString());
                     });
                     child.stderr.on("data", (chunk) => {
-                        outputFunc(chunk.toString());
+                        if (this.outputFunc)
+                            this.outputFunc(chunk.toString());
                     });
                 }
                 child.on("exit", (code) => __awaiter(this, void 0, void 0, function* () {

package/out/test.js

@@ -127,6 +127,11 @@ function runCodeModelTests(codeModelFile) {
             console.error("Expected " + expected + ", got " + got);
             process.exit(1);
         }
+        let targetName = cmake.targetNameForExecutable("/vscode-qttest/test/qt_test/build-dev/test1", codemodelJson);
+        if (targetName != "test1") {
+            console.error("Expected test1, got " + targetName);
+            process.exit(1);
+        }
     });
 }
 runTests("test/qt_test/build-dev/");

package/package.json

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