feat(profiles): enhanced handling of environment variables in profile settings

This update allows the setting, overriding, and utilization of system environment variables in expressions and conditions within the robot.toml configuration files. This enhancement increases the flexibility and adaptability of profile configurations.

Author: d-biehl

packages/analyze/src/robotcode/analyze/cli.py

@@ -30,17 +30,19 @@ def analyze(app: Application, paths: Tuple[str]) -> Union[str, int, None]:
     config_files, root_folder, _ = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
 
     try:
+        robot_config = (
+            load_robot_config_from_path(*config_files)
+            .combine_profiles(*(app.config.profiles or []))
+            .evaluated_with_env()
+        )
+
         analyzer_config = load_config_from_path(
             AnalyzerConfig,
             *config_files,
             tool_name="robotcode-analyze",
             robot_toml_tool_name="robotcode-analyze",
         ).evaluated()
 
-        robot_config = (
-            load_robot_config_from_path(*config_files).combine_profiles(*(app.config.profiles or [])).evaluated()
-        )
-
     except (TypeError, ValueError) as e:
         raise click.ClickException(str(e)) from e
 

packages/language_server/src/robotcode/language_server/cli.py

@@ -80,7 +80,7 @@ def language_server(
         profile = (
             load_robot_config_from_path(*config_files)
             .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose)
-            .evaluated()
+            .evaluated_with_env()
         )
     except (TypeError, ValueError) as e:
         app.echo(str(e), err=True)

packages/language_server/src/robotcode/language_server/robotframework/protocol.py

@@ -213,9 +213,6 @@ def server_initialized(self, sender: Any) -> None:
         for folder in self.workspace.workspace_folders:
             config: RobotConfig = self.workspace.get_configuration(RobotConfig, folder.uri)
 
-            for k, v in (self.robot_profile.env or {}).items():
-                os.environ[k] = str(v)
-
             for p in self.robot_profile.python_path or []:
                 pa = Path(str(p))
                 if not pa.is_absolute():

packages/plugin/src/robotcode/plugin/__init__.py

@@ -100,15 +100,15 @@ def verbose(
         self,
         message: Union[str, Callable[[], Any], None],
         file: Optional[IO[AnyStr]] = None,
-        nl: bool = True,
-        err: bool = True,
+        nl: Optional[bool] = True,
+        err: Optional[bool] = True,
     ) -> None:
         if self.config.verbose:
             click.secho(
                 message() if callable(message) else message,
                 file=file,
-                nl=nl,
-                err=err,
+                nl=nl if nl is not None else True,
+                err=err if err is not None else True,
                 color=self.colored,
                 fg="bright_black",
             )

packages/robot/src/robotcode/robot/config/model.py

@@ -364,7 +364,10 @@ def add_options(self, config: "BaseOptions", combine_extends: bool = False) -> N
             if new is not None:
                 setattr(self, f.name, new)
 
-    def evaluated(self) -> Self:
+    def evaluated(self, verbose_callback: Optional[Callable[[Union[str, Callable[[], Any]]], None]] = None) -> Self:
+        if verbose_callback is not None:
+            verbose_callback("Evaluating options")
+
         result = dataclasses.replace(self)
         for f in dataclasses.fields(result):
             try:
@@ -2191,6 +2194,17 @@ def save(self, path: "os.PathLike[str]") -> None:
         with Path(path).open("w", encoding="utf-8") as f:
             f.write(tomli_w.dumps(as_dict(self, remove_defaults=True)))
 
+    def evaluated_with_env(
+        self, verbose_callback: Optional[Callable[[Union[str, Callable[[], Any]]], None]] = None
+    ) -> Self:
+        if self.env:
+            for k, v in self.env.items():
+                os.environ[k] = str(v)
+                if verbose_callback:
+                    verbose_callback(lambda: f"Set environment variable {k} to {v}")
+
+        return self.evaluated(verbose_callback)
+
 
 @dataclass
 class RobotExtraBaseProfile(RobotBaseProfile):
@@ -2285,7 +2299,7 @@ class RobotConfig(RobotExtraBaseProfile):
     def select_profiles(
         self,
         *names: str,
-        verbose_callback: Optional[Callable[..., None]] = None,
+        verbose_callback: Optional[Callable[[Union[str, Callable[[], Any]]], None]] = None,
     ) -> Dict[str, RobotProfile]:
         result: Dict[str, RobotProfile] = {}
 
@@ -2316,9 +2330,7 @@ def select_profiles(
         return result
 
     def combine_profiles(
-        self,
-        *names: str,
-        verbose_callback: Optional[Callable[..., None]] = None,
+        self, *names: str, verbose_callback: Optional[Callable[[Union[str, Callable[[], Any]]], None]] = None
     ) -> RobotBaseProfile:
         type_hints = get_type_hints(RobotBaseProfile)
         base_field_names = [f.name for f in dataclasses.fields(RobotBaseProfile)]

packages/runner/src/robotcode/runner/cli/libdoc.py

@@ -70,15 +70,12 @@ def libdoc(app: Application, robot_options_and_args: Tuple[str, ...]) -> None:
         robot_arguments, app.config.config_files, verbose_callback=app.verbose
     )
     try:
-        profile = load_robot_config_from_path(*config_files).combine_profiles(
-            *(app.config.profiles or []), verbose_callback=app.verbose
+        profile = (
+            load_robot_config_from_path(*config_files)
+            .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose)
+            .evaluated_with_env()
         )
 
-        if profile.env:
-            for k, v in profile.env.items():
-                os.environ[k] = str(v)
-                app.verbose(lambda: f"Set environment variable {k} to {v}")
-        profile = profile.evaluated()
     except (TypeError, ValueError) as e:
         raise click.ClickException(str(e)) from e
 

packages/runner/src/robotcode/runner/cli/rebot.py

@@ -71,14 +71,11 @@ def rebot(app: Application, robot_options_and_args: Tuple[str, ...]) -> None:
     )
 
     try:
-        profile = load_robot_config_from_path(*config_files).combine_profiles(
-            *(app.config.profiles or []), verbose_callback=app.verbose
+        profile = (
+            load_robot_config_from_path(*config_files)
+            .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose)
+            .evaluated_with_env()
         )
-        if profile.env:
-            for k, v in profile.env.items():
-                os.environ[k] = str(v)
-                app.verbose(lambda: f"Set environment variable {k} to {v}")
-        profile = profile.evaluated()
 
     except (TypeError, ValueError) as e:
         raise click.ClickException(str(e)) from e

packages/runner/src/robotcode/runner/cli/robot.py

@@ -108,17 +108,11 @@ def handle_robot_options(
         robot_arguments, app.config.config_files, verbose_callback=app.verbose
     )
     try:
-        profile = load_robot_config_from_path(*config_files).combine_profiles(
-            *(app.config.profiles or []), verbose_callback=app.verbose
+        profile = (
+            load_robot_config_from_path(*config_files)
+            .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose)
+            .evaluated_with_env()
         )
-
-        if profile.env:
-            for k, v in profile.env.items():
-                os.environ[k] = str(v)
-                app.verbose(lambda: f"Set environment variable {k} to {v}")
-
-        profile = profile.evaluated()
-
     except (TypeError, ValueError) as e:
         raise click.ClickException(str(e)) from e
 

packages/runner/src/robotcode/runner/cli/testdoc.py

@@ -71,14 +71,12 @@ def testdoc(app: Application, robot_options_and_args: Tuple[str, ...]) -> None:
     )
 
     try:
-        profile = load_robot_config_from_path(*config_files).combine_profiles(
-            *(app.config.profiles or []), verbose_callback=app.verbose
+        profile = (
+            load_robot_config_from_path(*config_files)
+            .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose)
+            .evaluated_with_env()
         )
-        if profile.env:
-            for k, v in profile.env.items():
-                os.environ[k] = str(v)
-                app.verbose(lambda: f"Set environment variable {k} to {v}")
-        profile = profile.evaluated()
+
     except (TypeError, ValueError) as e:
         raise click.ClickException(str(e)) from e
 

src/robotcode/cli/commands/profiles.py

@@ -48,7 +48,7 @@ def show(app: Application, no_evaluate: bool, paths: List[Path]) -> None:
         )
 
         if not no_evaluate:
-            config = config.evaluated()
+            config = config.evaluated_with_env()
 
         app.print_data(
             config,