fix(vscode,intellij): escape glob patterns in --suite and --parse-include arguments for discover and executing tests

fix #386

Author: d-biehl

intellij-client/src/main/kotlin/dev/robotcode/robotcode4ij/execution/RobotCodeRunProfileState.kt

@@ -103,7 +103,7 @@ class RobotCodeRunProfileState(private val config: RobotCodeRunConfiguration, en
                 *connection.toTypedArray(),
                 *(if (!debug) arrayOf("--no-debug") else arrayOf()),
                 *(included.toTypedArray())
-            ), noColor = false // extraArgs = arrayOf("-v", "--log", "--log-level", "TRACE")
+            ), noColor = false ,extraArgs = arrayOf("-v", "--log", "--log-level", "TRACE")
 
         )
 

intellij-client/src/main/kotlin/dev/robotcode/robotcode4ij/testing/RobotCodeTestManager.kt

@@ -29,6 +29,7 @@ import dev.robotcode.robotcode4ij.RobotSuiteFileType
 import dev.robotcode.robotcode4ij.buildRobotCodeCommandLine
 import dev.robotcode.robotcode4ij.psi.IRobotFrameworkElementType
 import dev.robotcode.robotcode4ij.psi.RobotSuiteFile
+import dev.robotcode.robotcode4ij.utils.escapeRobotGlob
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
@@ -173,11 +174,11 @@ import java.util.*
                         "--read-from-stdin",
                         "tests",
                         *(if (testItem.needsParseInclude == true && testItem.relSource != null) arrayOf(
-                            "--needs-parse-include", testItem.relSource
+                            "--needs-parse-include", escapeRobotGlob(testItem.relSource)
                         )
                         else arrayOf<String>()),
                         "--suite",
-                        testItem.longname
+                        escapeRobotGlob(testItem.longname)
                     ), format = "json"
                 ).withCharset(Charsets.UTF_8).withWorkDirectory(project.basePath)
 

intellij-client/src/main/kotlin/dev/robotcode/robotcode4ij/utils/RobotUtils.kt

@@ -0,0 +1,8 @@
+package dev.robotcode.robotcode4ij.utils
+
+fun escapeRobotGlob(input: String): String {
+    val globRegex = Regex("([*?\\[\\]])")
+    return globRegex.replace(input) { matchResult ->
+        "[" + matchResult.value + "]"
+    }
+}

vscode-client/extension/debugmanager.ts

@@ -3,7 +3,7 @@ import * as vscode from "vscode";
 import { PythonManager } from "./pythonmanger";
 import { CONFIG_SECTION } from "./config";
 import { LanguageClientsManager, SUPPORTED_LANGUAGES, toVsCodeRange } from "./languageclientsmanger";
-import { WeakValueSet, waitForFile, sleep } from "./utils";
+import { WeakValueSet, waitForFile, sleep, escapeRobotGlobPatterns } from "./utils";
 import * as cp from "child_process";
 import { tmpdir } from "os";
 import { join } from "path";
@@ -496,7 +496,7 @@ export class DebugManager {
     if (needs_parse_include) {
       for (const s of rel_sources) {
         args.push("--parse-include");
-        args.push(s);
+        args.push(escapeRobotGlobPatterns(s));
       }
     }
 
@@ -507,7 +507,7 @@ export class DebugManager {
 
     for (const s of suites) {
       args.push("--suite");
-      args.push(s);
+      args.push(escapeRobotGlobPatterns(s));
     }
 
     if (included.length > 0) {

vscode-client/extension/testcontrollermanager.ts

@@ -4,7 +4,7 @@ import { DebugManager } from "./debugmanager";
 import * as fs from "fs";
 
 import { ClientState, LanguageClientsManager, toVsCodeRange } from "./languageclientsmanger";
-import { filterAsync, Mutex, sleep, truncateAndReplaceNewlines, WeakValueMap } from "./utils";
+import { escapeRobotGlobPatterns, filterAsync, Mutex, sleep, truncateAndReplaceNewlines, WeakValueMap } from "./utils";
 import { CONFIG_SECTION } from "./config";
 import { Range, Diagnostic, DiagnosticSeverity } from "vscode-languageclient/node";
 
@@ -819,10 +819,10 @@ export class TestControllerManager {
         ["discover", "--read-from-stdin", "tests"],
         [
           ...(robotWorkspaceItem?.needsParseInclude && testItem.relSource
-            ? ["--parse-include", testItem.relSource]
+            ? ["--parse-include", escapeRobotGlobPatterns(testItem.relSource)]
             : []),
           "--suite",
-          testItem?.longname,
+          escapeRobotGlobPatterns(testItem.longname),
         ],
         JSON.stringify(o),
         false,

vscode-client/extension/utils.ts

@@ -229,3 +229,8 @@ export function withTimeout<T>(promise: Thenable<T>, ms: number): Promise<T> {
   const timeout = new Promise<never>((_, reject) => setTimeout(() => reject(new Error("Timeout exceeded")), ms));
   return Promise.race([promise, timeout]);
 }
+
+export function escapeRobotGlobPatterns(str: string): string {
+  // Ersetze Zeichen, die in Globs speziell interpretiert werden, durch ihre escaped-Variante
+  return str.replace(/([*?[\]])/g, "[$1]");
+}