feat(robotcode): better formatting and include active, selected, enabled state of a profile in profile list command

Author: d-biehl

.vscode/launch.json

@@ -43,7 +43,8 @@
 				// "--no-color",
 				// "--no-pager",
 				//"config", "info", "list",
-				 "analyze",
+				// "analyze",
+				"profiles", "list"
 				// "."
 			]
 		},

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

@@ -171,9 +171,24 @@ def echo_as_markdown(self, text: str) -> None:
         if self.colored:
             try:
                 from rich.console import Console, ConsoleOptions, RenderResult
-                from rich.markdown import Heading, Markdown
+                from rich.markdown import (
+                    Heading,
+                    Markdown,
+                    TableBodyElement,
+                    TableDataElement,
+                    TableElement,
+                    TableHeaderElement,
+                    TableRowElement,
+                )
                 from rich.text import Text
 
+                # this is needed because of https://github.com/Textualize/rich/issues/3027
+                TableElement.new_line = False
+                TableHeaderElement.new_line = False
+                TableBodyElement.new_line = False
+                TableRowElement.new_line = False
+                TableDataElement.new_line = False
+
                 class MyHeading(Heading):
                     def __rich_console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
                         for result in super().__rich_console__(console, options):

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

@@ -189,6 +189,9 @@ def evaluate(self) -> bool:
         except Exception as e:
             raise EvaluationError(self.if_, str(e)) from e
 
+    def __bool__(self) -> bool:
+        return self.evaluate()
+
 
 @dataclass()
 class NamePattern(ValidateMixin):
@@ -348,7 +351,9 @@ def evaluated(self) -> Self:
         result = dataclasses.replace(self)
         for f in dataclasses.fields(result):
             try:
-                if isinstance(getattr(result, f.name), Expression):
+                if isinstance(getattr(result, f.name), Condition):
+                    setattr(result, f.name, getattr(result, f.name).evaluate())
+                elif isinstance(getattr(result, f.name), Expression):
                     setattr(result, f.name, getattr(result, f.name).evaluate())
                 elif isinstance(getattr(result, f.name), list):
                     setattr(
@@ -2277,11 +2282,9 @@ def combine_profiles(self, *names: str, verbose_callback: Optional[Callable[...,
 
         for profile_name, profile in sorted(selected_profiles.items(), key=lambda x: x[1].precedence or 0):
             try:
-                if profile.enabled is not None and (
-                    isinstance(profile.enabled, Condition) and not profile.enabled.evaluate() or not profile.enabled
-                ):
+                if profile.enabled is not None and not bool(profile.enabled):
                     if verbose_callback:
-                        verbose_callback(f'Skipping profile "{profile_name}" because it\'s  disabled.')
+                        verbose_callback(f'Skipping profile "{profile_name}" because it\'s disabled.')
                     continue
             except EvaluationError as e:
                 raise ValueError(f'Error evaluating "enabled" condition for profile "{profile_name}": {e}') from e

src/robotcode/cli/commands/profiles.py

@@ -7,6 +7,7 @@
     DiscoverdBy,
     load_robot_config_from_path,
 )
+from robotcode.robot.config.model import EvaluationError, RobotProfile
 from robotcode.robot.config.utils import get_config_files
 
 
@@ -66,9 +67,20 @@ def list(
             k for k in config.select_profiles(*(app.config.profiles or []), verbose_callback=app.verbose).keys()
         ]
 
+        def check_enabled(name: str, profile: RobotProfile) -> bool:
+            try:
+                return profile.enabled is None or bool(profile.enabled)
+            except EvaluationError as e:
+                raise ValueError(f"Cannot evaluate profile '{name}'.enabled: {e}") from e
+
         result: Dict[str, Any] = {
             "profiles": [
-                {"name": k, "description": v.description or "", "selected": True if k in selected_profiles else False}
+                {
+                    "name": k,
+                    "enabled": check_enabled(k, v),
+                    "description": v.description or "",
+                    "selected": True if k in selected_profiles else False,
+                }
                 for k, v in (config.profiles or {}).items()
             ]
         }
@@ -85,7 +97,30 @@ def list(
 
         if app.config.output_format is None or app.config.output_format == OutputFormat.TEXT:
             for v in result["profiles"]:
-                app.echo(f'{"* " if v["selected"] else "  "}{v["name"]} {v["description"] if v["description"] else ""}')
+                for k in ["name", "description"]:
+                    lines = v[k].splitlines()
+                    v[k] = " ".join(lines[:1]) + (" ..." if len(lines) > 1 else "")
+
+            header = ""
+            max_name = max(*(len(profile["name"]) for profile in result["profiles"]), len("Name"))
+            max_description = max(*(len(profile["description"]) for profile in result["profiles"]), len("Description"))
+            header += (
+                f'| Active | Selected | Enabled | Name{(max_name-len("Name"))*" "} '
+                f'| Description{(max_description-len("Description"))*" "} |\n'
+            )
+            header += f"|:------:|:--------:|:-------:|:{max_name*'-'}-|:{max_description*'-'}-|\n"
+            for selected, enabled, name, description in (
+                (v["selected"], v["enabled"], v["name"], v["description"]) for v in result["profiles"]
+            ):
+                header += (
+                    f'|   {"*" if selected and enabled else " "}    '
+                    f'|    {"*" if selected else " "}     '
+                    f'|    {"*" if enabled else " "}    '
+                    f'| {name}{(max_name-len(name))*" "} '
+                    f'| {description if description else ""}{(max_description-len(description))*" "} |\n'
+                )
+
+            app.echo_as_markdown(header)
         else:
             app.print_data(result)
 

tests/robotcode/language_server/robotframework/parts/data/.robot.toml

@@ -1,9 +1,9 @@
-default-profiles = "firefox"
+#default-profiles = "firefox"
 
 
-#extra-args = ["--profile", "default"]
+#extends-args = ["--profile", "default"]
 #[extra-profiles.abc]
-[extra-profiles.firefox]
+[extend-profiles.firefox]
 description = "The overridden firefox profile"
 extend-python-path = ["./python"]
 #extra-python-path = ["./python1"]

tests/robotcode/language_server/robotframework/parts/data/robot.toml

@@ -1,4 +1,8 @@
-default-profiles = ["devel"]
+default-profiles = [
+    "devel",
+    "disabled_profile",
+    "disabled_profile_with_env_var",
+]
 paths = ["."]
 python-path = ["./lib", "./resources"]
 output-dir = { expr = "f'results/run-{datetime.now().strftime(\"%d-%m-%Y-%H.%M.%S\")}'" }
@@ -24,7 +28,13 @@ CMD_VAR_LONG = "a test"
 ANOTHER_VAR = { expr = "environ.get('CMD_VAR_LONG', 'default')" }
 
 [profiles.devel]
-description = "The devel profile"
+description = """The devel profile
+this is a second line
+this is a third line
+this is a fourth line
+this is a fifth line
+
+and this is a sixth line"""
 
 [profiles.devel.extend-variables]
 BROWSER = "chromium"
@@ -49,10 +59,17 @@ extend-variables = { BROWSER = "chromium" }
 API_URL = "https://api.prod.company.com"
 APP_URL = "https://app.prod.company.com"
 
+[profiles.disabled_profile]
+enabled = false
+
+[profiles.disabled_profile_with_env_var]
+enabled = { if = "environ.get('DISABLED_PROFILE') in ['true', '1']" }
+
+
 [profiles.test1.extend-variables]
 API_URL = "https://api.test1.company.com"
 APP_URL = "https://app.test1.company.com"
 
 [tool.robotcode-analyze]
 select = ["all"]
-ignore = ["KeywordNotFound"]
+ignore = ["KeywordNotFound"]