feat: Limit number of splits by the delimiter (#4357)

Allow to specify a max number of splits by the delimiter.
See #4355

Author: sandercox

package.json

@@ -2264,6 +2264,12 @@
           "markdownDescription": "%cmake-tools.configuration.cmake.ctest.testSuiteDelimiter.markdownDescription%",
           "scope": "machine-overridable"
         },
+        "cmake.ctest.testSuiteDelimiterMaxOccurrence": {
+          "type": "number",
+          "default": 0,
+          "markdownDescription": "%cmake-tools.configuration.cmake.ctest.testSuiteDelimiterMaxOccurrence.markdownDescription%",
+          "scope": "machine-overridable"
+        },
         "cmake.ctest.debugLaunchTarget": {
           "type": "string",
           "default": null,

package.nls.json

@@ -127,6 +127,9 @@
             "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered."
         ]
     }, 
+    "cmake-tools.configuration.cmake.ctest.testSuiteDelimiterMaxOccurrence.markdownDescription": {
+        "message": "Maximum number of times the delimiter may be used to split the name of the test. `0` means no limit."
+    },
 	"cmake-tools.configuration.cmake.ctest.debugLaunchTarget.description": "Target name from launch.json to start when debugging a test with CTest. By default and in case of a non-existing target, this will show a picker with all available targets.",
     "cmake-tools.configuration.cmake.parseBuildDiagnostics.description": "Parse compiler output for warnings and errors.",
     "cmake-tools.configuration.cmake.enabledOutputParsers.description": {

src/config.ts

@@ -174,7 +174,7 @@ export interface ExtensionConfigurationSettings {
     buildToolArgs: string[];
     parallelJobs: number;
     ctestPath: string;
-    ctest: { parallelJobs: number; allowParallelJobs: boolean; testExplorerIntegrationEnabled: boolean; testSuiteDelimiter: string; debugLaunchTarget: string | null };
+    ctest: { parallelJobs: number; allowParallelJobs: boolean; testExplorerIntegrationEnabled: boolean; testSuiteDelimiter: string; testSuiteDelimiterMaxOccurrence: number; debugLaunchTarget: string | null };
     parseBuildDiagnostics: boolean;
     enabledOutputParsers: string[];
     debugConfig: CppDebugConfiguration;
@@ -394,6 +394,9 @@ export class ConfigurationReader implements vscode.Disposable {
     get testSuiteDelimiter(): string {
         return this.configData.ctest.testSuiteDelimiter;
     }
+    get testSuiteDelimiterMaxOccurrence(): number {
+        return this.configData.ctest.testSuiteDelimiterMaxOccurrence;
+    }
     get ctestDebugLaunchTarget(): string | null {
         return this.configData.ctest.debugLaunchTarget;
     }
@@ -621,7 +624,7 @@ export class ConfigurationReader implements vscode.Disposable {
         parallelJobs: new vscode.EventEmitter<number>(),
         ctestPath: new vscode.EventEmitter<string>(),
         cpackPath: new vscode.EventEmitter<string>(),
-        ctest: new vscode.EventEmitter<{ parallelJobs: number; allowParallelJobs: boolean; testExplorerIntegrationEnabled: boolean; testSuiteDelimiter: string; debugLaunchTarget: string | null }>(),
+        ctest: new vscode.EventEmitter<{ parallelJobs: number; allowParallelJobs: boolean; testExplorerIntegrationEnabled: boolean; testSuiteDelimiter: string; testSuiteDelimiterMaxOccurrence: number; debugLaunchTarget: string | null }>(),
         parseBuildDiagnostics: new vscode.EventEmitter<boolean>(),
         enabledOutputParsers: new vscode.EventEmitter<string[]>(),
         debugConfig: new vscode.EventEmitter<CppDebugConfiguration>(),

src/ctest.ts

@@ -694,10 +694,30 @@ export class CTestDriver implements vscode.Disposable {
         let parentSuiteItem = testExplorerRoot;
         let testLabel = testName;
 
+        function limited_split(regexString: string, subject: string, maxCount: number): string[] {
+            if (maxCount === 0) {
+                maxCount = Number.MAX_SAFE_INTEGER;
+            }
+            const delimiterRegExp = new RegExp(regexString, 'dg');
+            const parts = [];
+            let lastStart = 0;
+            while (parts.length < maxCount) {
+                const match: any = delimiterRegExp.exec(subject);
+                if (match === null || match.indices === null) {
+                    break;
+                }
+
+                parts.push(subject.substring(lastStart, match.indices[0][0]));
+                lastStart = match.indices[0][1];
+            }
+
+            parts.push(subject.substring(lastStart));
+            return parts;
+        }
+
         // If a suite delimiter is set, create a suite tree
         if (this.ws.config.testSuiteDelimiter) {
-            const delimiterRegExp = new RegExp(this.ws.config.testSuiteDelimiter);
-            const parts = testName.split(delimiterRegExp);
+            const parts = limited_split(this.ws.config.testSuiteDelimiter, testName, this.ws.config.testSuiteDelimiterMaxOccurrence);
             testLabel = parts.pop() || testName; // The last part is the test label
 
             // Create a suite item for each suite ID part if it doesn't exist yet at that tree level

test/unit-tests/config.test.ts

@@ -30,6 +30,7 @@ function createConfig(conf: Partial<ExtensionConfigurationSettings>): Configurat
             allowParallelJobs: false,
             testExplorerIntegrationEnabled: true,
             testSuiteDelimiter: '',
+            testSuiteDelimiterMaxOccurrence: 0,
             debugLaunchTarget: null
         },
         parseBuildDiagnostics: true,