introduce 'robotcode.robot.paths' and 'robotcode.robot.variableFiles' settings and launch properties

d-biehl · d-biehl · commit ef995179ad68 · 2022-03-15T23:31:15.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/package.json b/package.json
@@ -282,7 +282,16 @@
             "items": {
               "type": "string"
             },
-            "description": "Specifies the arguments to be passed to robot module.",
+            "description": "Specifies the arguments to be passed to robot.",
+            "scope": "resource"
+          },
+          "robotcode.robot.paths": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            },
+            "description": "Specifies the paths where robot/robotcode should discover tests. Corresponds to the 'paths' option of robot.",
             "scope": "resource"
           },
           "robotcode.robot.pythonPath": {
@@ -294,7 +303,7 @@
             "items": {
               "type": "string"
             },
-            "description": "Specifies additional python paths to robotframework. Corresponds to the '--pythonpath' option of the robot module.",
+            "description": "Specifies additional python paths for robotframework. Corresponds to the '--pythonpath' option of robot.",
             "scope": "resource"
           },
           "robotcode.robot.env": {
@@ -306,7 +315,16 @@
           "robotcode.robot.variables": {
             "type": "object",
             "default": {},
-            "description": "Specifies the variables for robotframework. Corresponds to the '--variable name:value' option of the robot module.",
+            "description": "Specifies the variables for robotframework. Corresponds to the '--variable name:value' option of robot.",
+            "scope": "resource"
+          },
+          "robotcode.robot.variableFiles": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            },
+            "description": "Specifies the variable files for robotframework. Corresponds to the '--variablefile' option of robot.",
             "scope": "resource"
           },
           "robotcode.robot.outputDir": {
@@ -324,8 +342,8 @@
             ],
             "enumDescriptions": [
               "Mode is got from test/task header in data files.",
-              "Turn on the generic automation mode. Corresponds to the '--rpa' option of the robot module.",
-              "Force test automation mode. Corresponds to the '--norpa' option of the robot module."
+              "Turn on the generic automation mode. Corresponds to the '--rpa' option of robot.",
+              "Force test automation mode. Corresponds to the '--norpa' option of robot."
             ],
             "description": "Specifies robot execution mode.",
             "default": "default",
@@ -514,6 +532,14 @@
                 "description": "The .robot file or a folder containing .robot files to be launched.",
                 "default": "${file}"
               },
+              "paths": {
+                "type": "array",
+                "default": [],
+                "items": {
+                  "type": "string"
+                },
+                "description": "Specifies the paths where robot should discover tests. Corresponds to the 'paths' option of robot."
+              },
               "args": {
                 "type": "array",
                 "description": "Specifies additional command line arguments passed to robot.",
@@ -546,7 +572,7 @@
               },
               "dryRun": {
                 "type": "boolean",
-                "description": "Verifies test data and runs tests so that library keywords are not executed. Corresponds to the '--dryrun' option of the robot module.",
+                "description": "Verifies test data and runs tests so that library keywords are not executed. Corresponds to the '--dryrun' option of robot.",
                 "default": false
               },
               "python": {
@@ -556,7 +582,10 @@
               },
               "robotPythonPath": {
                 "type": "array",
-                "description": "Specifies additional python paths for robotframework. Corresponds to the '--pythonpath' option of the robot module.",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Specifies additional python paths for robotframework. Corresponds to the '--pythonpath' option of robot.",
                 "default": []
               },
               "attachPython": {
@@ -572,7 +601,15 @@
               "variables": {
                 "type": "object",
                 "default": {},
-                "description": "Specifies the variables for robotframework. Corresponds to the '--variable name:value' option of the robot module."
+                "description": "Specifies the variables for robotframework. Corresponds to the '--variable name:value' option of robot."
+              },
+              "variableFiles": {
+                "type": "array",
+                "default": [],
+                "items": {
+                  "type": "string"
+                },
+                "description": "Specifies the variable files for robotframework. Corresponds to the '--variablefile' option of robot."
               },
               "launcherArgs": {
                 "type": "array",
@@ -613,8 +650,8 @@
                 ],
                 "enumDescriptions": [
                   "Mode is got from test/task header in data files.",
-                  "Turn on the generic automation mode. Corresponds to the '--rpa' option of the robot module.",
-                  "Force test automation mode. Corresponds to the '--norpa' option of the robot module."
+                  "Turn on the generic automation mode. Corresponds to the '--rpa' option of robot.",
+                  "Force test automation mode. Corresponds to the '--norpa' option of robot."
                 ],
                 "description": "Specifies robot execution mode.",
                 "default": "default"
diff --git a/robotcode/debugger/launcher/server.py b/robotcode/debugger/launcher/server.py
@@ -125,6 +125,7 @@ async def _launch(
         python: str,
         cwd: str = ".",
         target: Optional[str] = None,
+        paths: Optional[List[str]] = None,
         args: Optional[List[str]] = None,
         env: Optional[Dict[str, Optional[Any]]] = None,
         console: Optional[Literal["internalConsole", "integratedTerminal", "externalTerminal"]] = "integratedTerminal",
@@ -140,9 +141,10 @@ async def _launch(
         outputLog: Optional[bool] = False,
         groupOutput: Optional[bool] = False,
         stopOnEntry: Optional[bool] = False,  # noqa: N803
-        arguments: Optional[LaunchRequestArguments] = None,
         dryRun: Optional[bool] = None,
         mode: Optional[str] = None,
+        variableFiles: Optional[List[str]] = None,
+        arguments: Optional[LaunchRequestArguments] = None,
         *_args: Any,
         **_kwargs: Any,
     ) -> None:
@@ -197,12 +199,20 @@ async def _launch(
             for e in robotPythonPath:
                 run_args += ["-P", e]
 
+        if variableFiles:
+            for v in variableFiles:
+                run_args += ["-V", v]
+
         if variables:
             for k, v in variables.items():
                 run_args += ["-v", f"{k}:{v}"]
 
         run_args += args or []
 
+        if paths:
+            for p in paths:
+                run_args.append(p)
+
         if target:
             run_args.append(target)
 
diff --git a/robotcode/language_server/robotframework/configuration.py b/robotcode/language_server/robotframework/configuration.py
@@ -19,6 +19,7 @@ class RobotConfig(ConfigBase):
     python_path: List[str] = field(default_factory=list)
     env: Dict[str, str] = field(default_factory=dict)
     variables: Dict[str, Any] = field(default_factory=dict)
+    paths: List[str] = field(default_factory=list)
     output_dir: Optional[str] = None
     output_file: Optional[str] = None
     log_file: Optional[str] = None
diff --git a/robotcode/language_server/robotframework/parts/discovering.py b/robotcode/language_server/robotframework/parts/discovering.py
@@ -29,7 +29,7 @@
 @dataclass(repr=False)
 class GetAllTestsParams(Model):
     workspace_folder: str
-    paths: Optional[List[str]]
+    paths: Optional[List[str]] = None
     suites: Optional[List[str]] = None
 
 
@@ -221,7 +221,8 @@ def generate(suite: TestSuite) -> TestItem:
                 children.append(
                     TestItem(
                         type="test",
-                        id=f"{Path(test.source).resolve()};{test.longname};{test.lineno}",
+                        id=f"{Path(test.source).resolve() if test.source is not None else ''};"
+                        f"{test.longname};{test.lineno}",
                         label=test.name,
                         longname=test.longname,
                         uri=str(Uri.from_path(test.source)) if test.source else None,
@@ -238,7 +239,7 @@ def generate(suite: TestSuite) -> TestItem:
 
             return TestItem(
                 type="suite",
-                id=f"{Path(suite.source).resolve()};{suite.longname}",
+                id=f"{Path(suite.source).resolve() if suite.source is not None else ''};{suite.longname}",
                 label=suite.name,
                 longname=suite.longname,
                 uri=str(Uri.from_path(suite.source)) if suite.source else None,
@@ -257,6 +258,9 @@ def generate(suite: TestSuite) -> TestItem:
                 config = await self.get_config(workspace_folder)
                 mode = config.get_mode() if config is not None else None
 
+                if paths is None and config is not None:
+                    paths = config.paths
+
                 if paths and len(paths):
 
                     def normalize_paths(paths: List[str]) -> Iterator[str]:
diff --git a/robotcode/language_server/robotframework/parts/documents_cache.py b/robotcode/language_server/robotframework/parts/documents_cache.py
@@ -305,7 +305,10 @@ async def default_imports_manager(self) -> ImportsManager:
     async def get_imports_manager(self, document: TextDocument) -> ImportsManager:
         folder = self.parent.workspace.get_workspace_folder(document.uri)
         if folder is None:
-            return await self.default_imports_manager
+            if len(self.parent.workspace.workspace_folders) == 1:
+                folder = self.parent.workspace.workspace_folders[0]
+            else:
+                return await self.default_imports_manager
 
         if folder not in self._imports_managers:
             async with self._imports_managers_lock:
diff --git a/tests/robotcode/language_server/robotframework/parts/data/.vscode/settings.json b/tests/robotcode/language_server/robotframework/parts/data/.vscode/settings.json
@@ -27,4 +27,5 @@
     // "robotcode.debug.outputLog": true,
     // "robotcode.debug.outputMessages": true
     //"python.analysis.diagnosticMode": "workspace"
+    "robotcode.robot.paths": ["./tests", "./tests1"]
 }
diff --git a/tests/robotcode/language_server/robotframework/parts/data/tests1/first.robot b/tests/robotcode/language_server/robotframework/parts/data/tests1/first.robot
@@ -0,0 +1,4 @@
+*** Test Cases ***
+first
+    Log    blah
+    Sleep    1s
diff --git a/tests/robotcode/language_server/robotframework/parts/test_references/test_references_robot_034_004_simple_keyword_call_.yml b/tests/robotcode/language_server/robotframework/parts/test_references/test_references_robot_034_004_simple_keyword_call_.yml
@@ -1344,3 +1344,12 @@ result:
       character: 69
       line: 47
   uri: tests/variables.robot
+- !Location
+  range:
+    end:
+      character: 7
+      line: 2
+    start:
+      character: 4
+      line: 2
+  uri: tests1/first.robot
diff --git a/tests/robotcode/language_server/robotframework/parts/test_references/test_references_robot_034_005_simple_keyword_call_.yml b/tests/robotcode/language_server/robotframework/parts/test_references/test_references_robot_034_005_simple_keyword_call_.yml
@@ -1344,3 +1344,12 @@ result:
       character: 69
       line: 47
   uri: tests/variables.robot
+- !Location
+  range:
+    end:
+      character: 7
+      line: 2
+    start:
+      character: 4
+      line: 2
+  uri: tests1/first.robot
diff --git a/tests/robotcode/language_server/robotframework/parts/test_references/test_references_robot_034_006_simple_keyword_call_.yml b/tests/robotcode/language_server/robotframework/parts/test_references/test_references_robot_034_006_simple_keyword_call_.yml
@@ -1344,3 +1344,12 @@ result:
       character: 69
       line: 47
   uri: tests/variables.robot
+- !Location
+  range:
+    end:
+      character: 7
+      line: 2
+    start:
+      character: 4
+      line: 2
+  uri: tests1/first.robot
diff --git a/vscode-client/debugmanager.ts b/vscode-client/debugmanager.ts
@@ -106,6 +106,11 @@ class RobotCodeDebugConfigurationProvider implements vscode.DebugConfigurationPr
 
     debugConfiguration.args = [...config.get<string[]>("robot.args", []), ...(debugConfiguration.args ?? [])];
 
+    debugConfiguration.variableFiles = [
+      ...config.get<string[]>("robot.variableFiles", []),
+      ...(debugConfiguration.variableFiles ?? []),
+    ];
+
     debugConfiguration.variables = {
       ...config.get<{ [Key: string]: unknown }>("robot.variables", {}),
       ...(debugConfiguration.variables ?? {}),
@@ -368,6 +373,7 @@ export class DebugManager {
       args.push(`robotcode.debugger.modifiers.ExcludedByLongName${separator}${excluded.join(separator)}`);
     }
     const template = config.get("debug.defaultConfiguration", {});
+    const paths = config.get("robot.paths", []);
 
     await vscode.debug.startDebugging(
       folder,
@@ -378,7 +384,7 @@ export class DebugManager {
           name: "RobotCode: Run Tests",
           request: "launch",
           cwd: folder?.uri.fsPath,
-          target: ".",
+          paths: paths,
           args: args,
           console: config.get("debug.defaultConsole", "integratedTerminal"),
           runId: runId,
diff --git a/vscode-client/languageclientsmanger.ts b/vscode-client/languageclientsmanger.ts
@@ -241,7 +241,17 @@ export class LanguageClientsManager {
   ): Promise<LanguageClient | undefined> {
     return this.clientsMutex.dispatch(async () => {
       const uri = resource instanceof vscode.Uri ? resource : vscode.Uri.parse(resource);
-      const workspaceFolder = vscode.workspace.getWorkspaceFolder(uri);
+      let workspaceFolder = vscode.workspace.getWorkspaceFolder(uri);
+
+      if (!workspaceFolder || !create) {
+        if (vscode.workspace.workspaceFolders?.length === 1) {
+          workspaceFolder = vscode.workspace.workspaceFolders[0];
+        } else if (vscode.workspace.workspaceFolders?.length == 0) {
+          workspaceFolder = undefined;
+        } else {
+          workspaceFolder = undefined;
+        }
+      }
 
       if (!workspaceFolder || !create) return undefined;
 
@@ -264,9 +274,10 @@ export class LanguageClientsManager {
       let closeHandlerAction = CloseAction.DoNotRestart;
 
       const clientOptions: LanguageClientOptions = {
-        documentSelector: [
-          { scheme: "file", language: "robotframework", pattern: `${workspaceFolder.uri.fsPath}/**/*` },
-        ],
+        documentSelector:
+          vscode.workspace.workspaceFolders?.length === 1
+            ? [{ scheme: "file", language: "robotframework" }]
+            : [{ scheme: "file", language: "robotframework", pattern: `${workspaceFolder.uri.fsPath}/**/*` }],
         synchronize: {
           configurationSection: [CONFIG_SECTION],
         },
@@ -320,7 +331,7 @@ export class LanguageClientsManager {
         if (e.newState == State.Running) {
           closeHandlerAction = CloseAction.Restart;
         } else if (e.newState == State.Stopped) {
-          if (this.clients.get(workspaceFolder.uri.toString()) !== result)
+          if (workspaceFolder && this.clients.get(workspaceFolder.uri.toString()) !== result)
             closeHandlerAction = CloseAction.DoNotRestart;
         }
 
@@ -393,7 +404,11 @@ export class LanguageClientsManager {
     for (const document of vscode.workspace.textDocuments) {
       if (document.languageId === "robotframework") {
         const workspaceFolder = vscode.workspace.getWorkspaceFolder(document.uri);
-        if (workspaceFolder) folders.add(workspaceFolder);
+        if (workspaceFolder) {
+          folders.add(workspaceFolder);
+        } else if (vscode.workspace.workspaceFolders?.length === 1) {
+          folders.add(vscode.workspace.workspaceFolders[0]);
+        }
       }
     }
 
@@ -433,14 +448,14 @@ export class LanguageClientsManager {
             "robot/discovering/getTestsFromWorkspace",
             {
               workspaceFolder: workspaceFolder.uri.toString(),
-              paths: paths ?? ["."],
+              paths: paths,
               suites,
             },
             token
           )
         : await client.sendRequest<RobotTestItem[]>("robot/discovering/getTestsFromWorkspace", {
             workspaceFolder: workspaceFolder.uri.toString(),
-            paths: paths ?? ["."],
+            paths: paths,
           })) ?? undefined
     );
   }
diff --git a/vscode-client/testcontrollermanager.ts b/vscode-client/testcontrollermanager.ts

Original file line number	Diff line number	Diff line change
`@@ -27,4 +27,5 @@`
`27`	`27`	`// "robotcode.debug.outputLog": true,`
`28`	`28`	`// "robotcode.debug.outputMessages": true`
`29`	`29`	`//"python.analysis.diagnosticMode": "workspace"`
	`30`	`+ "robotcode.robot.paths": ["./tests", "./tests1"]`
`30`	`31`	`}`