testGrouping by label

matepek · Mar 29, 2024 · f99f81d · f99f81d
1 parent c76de3f
commit f99f81d
Show file tree

Hide file tree

Showing 9 changed files with 442 additions and 5 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -46,6 +46,23 @@
       "preLaunchTask": "preDebug",
       "postDebugTask": "postDebug"
     },
+    {
+      "type": "extensionHost",
+      "request": "launch",
+      "name": "tmp",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "/Users/matepek/Downloads/testmate",
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--disable-extensions"
+      ],
+      "env": {
+        "TESTMATE_DEBUG": "true"
+      },
+      "outFiles": ["${workspaceFolder}/out/**/*.js"],
+      "preLaunchTask": "preDebug",
+      "postDebugTask": "postDebug"
+    },
     {
       "type": "extensionHost",
       "request": "launch",

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+## [4.12.0]
+
+### Added
+
+- `testGrouping.groupByLabel`. ex.: `"testGrouping": { "groupByLabel": { "label": "Release", "groupByExecutable": {}}}`
+
 ## [4.11.0] - 2024-03-09
 
 ### Changed

diff --git a/documents/configuration/test.advancedExecutables.md b/documents/configuration/test.advancedExecutables.md
@@ -315,6 +315,7 @@ It is undocumented. Contact me by opening an issue or read the code a bit.
 
 | Property            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `groupByLabel`      | Groups tests by the given label. [Detail](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/configuration/test.advancedExecutables.md#testgrouping)                                                                                                                                                                                                                                                                      |
 | `groupByExecutable` | Groups tests by the executable file. [Detail](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/configuration/test.advancedExecutables.md#testgrouping)                                                                                                                                                                                                                                                                  |
 | `groupBySource`     | It sorts the tests by the related source file group. (`${sourceRelPath}`, `${sourceAbsPath}`). [Detail](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/configuration/test.advancedExecutables.md#testgrouping)                                                                                                                                                                                                        |
 | `groupByTags`       | True to group by every exiting combination of the tags. (`{$tag}`) Or it can be an array of tags: `["[tag1]["tag2"]", "tag2", "tag3"]` [Detail](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/configuration/test.advancedExecutables.md#testgrouping)                                                                                                                                                                |

diff --git a/package.json b/package.json
diff --git a/src/ConfigOfExecGroup.ts b/src/ConfigOfExecGroup.ts
@@ -157,6 +157,17 @@ export class ConfigOfExecGroup implements vscode.Disposable {
 
       filePaths = await execWatcher.watched();
 
+      // TODO: we could figure out that it is a symlink and add extra
+      // filePaths.forEach(f => {
+      //   try {
+      //     if (fs.readlinkSync(f)) {
+      //       console.log(`sym ${f}`);
+      //     }
+      //   } catch (e) {
+      //     console.log(`not sym ${f}`);
+      //   }
+      // });
+
       execWatcher.onError((err: Error) => {
         // eslint-disable-next-line
         if ((err as any).code == 'ENOENT') this._shared.log.info('watcher error', err);

diff --git a/src/Configurations.ts b/src/Configurations.ts
@@ -652,9 +652,9 @@ export class Configurations {
     obj?: FrameworkSpecificConfig,
   ): FrameworkSpecificConfig {
     const r: FrameworkSpecificConfig = {};
+    r.testGrouping = defaultTestGrouping;
     if (typeof obj === 'object') {
       if (obj.testGrouping) r.testGrouping = obj.testGrouping;
-      else r.testGrouping = defaultTestGrouping;
 
       if (typeof obj.helpRegex === 'string') r.helpRegex = obj['helpRegex'];
 
@@ -672,7 +672,6 @@ export class Configurations {
 
       if (typeof obj.failIfExceedsLimitNs === 'number') r.failIfExceedsLimitNs = obj.failIfExceedsLimitNs;
     }
-
     return r;
   }
 

diff --git a/src/TestGroupingInterface.ts b/src/TestGroupingInterface.ts
@@ -1,3 +1,8 @@
+export interface GroupByLabel extends TestGroupingConfig {
+  label?: string;
+  description?: string;
+}
+
 export interface GroupByExecutable extends TestGroupingConfig {
   label?: string;
   description?: string;
@@ -34,13 +39,16 @@ export type GroupByRegex = GroupByTagRegex;
 ///
 
 export type TestGroupingType =
+  | 'groupByLabel'
   | 'groupByExecutable'
   | 'groupBySource'
   | 'groupByTags'
   | 'groupByTagRegex'
   | 'groupByRegex';
 
 export interface TestGroupingConfig extends Partial<Record<TestGroupingType, TestGroupingConfig>> {
+  groupByLabel?: GroupByLabel;
+
   groupByExecutable?: GroupByExecutable;
 
   groupBySource?: GroupBySource;
@@ -58,7 +66,10 @@ export function* testGroupIterator(
   testGrouping: TestGroupingConfig,
 ): IterableIterator<[TestGroupingType, TestGroupingConfig]> {
   while (testGrouping) {
-    if (testGrouping.groupByExecutable) {
+    if (testGrouping.groupByLabel) {
+      testGrouping = testGrouping.groupByLabel;
+      yield ['groupByLabel', testGrouping];
+    } else if (testGrouping.groupByExecutable) {
       testGrouping = testGrouping.groupByExecutable;
       yield ['groupByExecutable', testGrouping];
     } else if (testGrouping.groupBySource) {
@@ -82,6 +93,7 @@ export function* testGroupIterator(
 export async function testGroupingForEach(
   testGrouping: TestGroupingConfig,
   callbacks: {
+    groupByLabel: (g: GroupByLabel) => Promise<void>;
     groupByExecutable: (g: GroupByExecutable) => Promise<void>;
     groupBySource: (g: GroupBySource) => Promise<void>;
     groupByTags: (g: GroupByTags) => Promise<void>;
@@ -90,7 +102,10 @@ export async function testGroupingForEach(
   },
 ): Promise<void> {
   while (testGrouping) {
-    if (testGrouping.groupByExecutable) {
+    if (testGrouping.groupByLabel) {
+      testGrouping = testGrouping.groupByLabel;
+      await callbacks.groupByLabel(testGrouping);
+    } else if (testGrouping.groupByExecutable) {
       testGrouping = testGrouping.groupByExecutable;
       await callbacks.groupByExecutable(testGrouping);
     } else if (testGrouping.groupBySource) {

diff --git a/src/framework/AbstractExecutable.ts b/src/framework/AbstractExecutable.ts
@@ -23,6 +23,7 @@ import {
   testGroupingForEach,
   GroupBySource,
   GroupByTags,
+  GroupByLabel,
 } from '../TestGroupingInterface';
 import { isSpawnBusyError } from '../util/FSWrapper';
 import { TestResultBuilder } from '../TestResultBuilder';
@@ -286,6 +287,20 @@ export abstract class AbstractExecutable<TestT extends AbstractTest = AbstractTe
       };
 
       await testGroupingForEach(testGrouping, {
+        groupByLabel: async (g: GroupByLabel): Promise<void> => {
+          const label = g.label ?? '${filename}';
+          const id = label;
+          const description = g.description ?? '${relDirpath}${osPathSep}';
+          itemOfLevel = await this._resolveAndGetOrCreateChildGroup(
+            itemOfLevel,
+            id,
+            label,
+            description,
+            varsToResolve,
+            undefined,
+            undefined,
+          );
+        },
         groupByExecutable: async (g: GroupByExecutable): Promise<void> => {
           this._updateVarsWithTags(g, tags, tagsResolveRule);
 

diff --git a/test/cpp/.vscode/settings.json b/test/cpp/.vscode/settings.json
@@ -2,9 +2,27 @@
     "cmake.configureOnOpen": true,
     "testMate.cpp.test.advancedExecutables": [
         {
-            "pattern":"build/**/*{test,Test,TEST}*",
+            "pattern":"build/**/*gtest*",
             "runTask": {
                 // "before": ["build_all"]
+            },
+            "testGrouping": {
+                "groupByLabel": {
+                    "label": "alma",
+                    "groupByExecutable": {}
+                },
+            }
+        },
+        {
+            "pattern":"build/**/*suite*",
+            "runTask": {
+                // "before": ["build_all"]
+            },
+            "testGrouping": {
+                "groupByLabel": {
+                    "label": "korte",
+                    "groupByExecutable": {}
+                },
             }
         }
     ],