feat(profiles): a profile can now be hidden and inherit from other profiles

d-biehl · d-biehl · commit 9cd2ffb16ecf · 2024-01-31T22:09:55.000+01:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -45,7 +45,8 @@
 				// "--no-pager",
 				//"config", "info", "list",
 				// "analyze",
-				"profiles", "list"
+				"-p", "ci",
+				"profiles", "show"
 				// "discover", "tests", "--tags"
 				// "."
 			]
diff --git a/etc/robot.toml.json b/etc/robot.toml.json
@@ -1466,7 +1466,14 @@
         },
         "env": {
           "additionalProperties": {
-            "type": "string"
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/StringExpression"
+              }
+            ]
           },
           "default": null,
           "description": "Define environment variables to be set before running tests.\n\nExamples:\n```toml\n[env]\nTEST_VAR = \"test\"\nSECRET = \"password\"\n```\n",
@@ -1561,7 +1568,7 @@
         },
         "extend-args": {
           "default": null,
-          "description": "Append extra arguments to be passed to _robot_.\n",
+          "description": "Append extra arguments to be passed to _robot_.\n\nExamples:\n```toml\nextend-args = [\"-t\", \"abc\"]\n```\n",
           "items": {
             "type": "string"
           },
@@ -1573,10 +1580,17 @@
         },
         "extend-env": {
           "additionalProperties": {
-            "type": "string"
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/StringExpression"
+              }
+            ]
           },
           "default": null,
-          "description": "Append extra environment variables to be set before tests.\n",
+          "description": "Append extra environment variables to be set before run.\n\nExamples:\n```toml\n[extend-env]\nEXTRA_VAR = \"value\"\n\n```\n",
           "title": "Extend env",
           "type": [
             "object",
@@ -1789,7 +1803,7 @@
             }
           ],
           "default": null,
-          "description": "Append extra entries to the paths argument.\n\nExamples:\n```toml\npaths = [\"tests\"]\n```\n",
+          "description": "Append extra entries to the paths argument.\n\nExamples:\n```toml\nextend-paths = [\"tests\"]\n```\n",
           "title": "Extend paths"
         },
         "extend-pre-rebot-modifiers": {
@@ -3315,7 +3329,14 @@
         },
         "env": {
           "additionalProperties": {
-            "type": "string"
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/StringExpression"
+              }
+            ]
           },
           "default": null,
           "description": "Define environment variables to be set before running tests.\n\nExamples:\n```toml\n[env]\nTEST_VAR = \"test\"\nSECRET = \"password\"\n```\n",
@@ -3410,7 +3431,7 @@
         },
         "extend-args": {
           "default": null,
-          "description": "Append extra arguments to be passed to _robot_.\n",
+          "description": "Append extra arguments to be passed to _robot_.\n\nExamples:\n```toml\nextend-args = [\"-t\", \"abc\"]\n```\n",
           "items": {
             "type": "string"
           },
@@ -3422,10 +3443,17 @@
         },
         "extend-env": {
           "additionalProperties": {
-            "type": "string"
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/StringExpression"
+              }
+            ]
           },
           "default": null,
-          "description": "Append extra environment variables to be set before tests.\n",
+          "description": "Append extra environment variables to be set before run.\n\nExamples:\n```toml\n[extend-env]\nEXTRA_VAR = \"value\"\n\n```\n",
           "title": "Extend env",
           "type": [
             "object",
@@ -3638,7 +3666,7 @@
             }
           ],
           "default": null,
-          "description": "Append extra entries to the paths argument.\n\nExamples:\n```toml\npaths = [\"tests\"]\n```\n",
+          "description": "Append extra entries to the paths argument.\n\nExamples:\n```toml\nextend-paths = [\"tests\"]\n```\n",
           "title": "Extend paths"
         },
         "extend-pre-rebot-modifiers": {
@@ -4029,6 +4057,22 @@
             "null"
           ]
         },
+        "hidden": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "$ref": "#/definitions/Condition"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "The profile should be hidden.\nHidden means it is not shown in the list of available profiles.\n\nExamples:\n```toml\nhidden = true\n```\n\n```toml\nhidden = { if = 'environ.get(\"CI\") == \"true\"' }\n```\n",
+          "title": "Hidden"
+        },
         "includes": {
           "default": null,
           "description": "Select tests by tag. Similarly as name with --test,\ntag is case and space insensitive and it is possible\nto use patterns with `*`, `?` and `[]` as wildcards.\nTags and patterns can also be combined together with\n`AND`, `OR`, and `NOT` operators.\n\nExamples:\n\n```\n--include foo --include bar*\n--include fooANDbar*\n```\n\ncorresponds to the `-i --include tag *` option of _robot_\n",
@@ -4048,6 +4092,35 @@
             "null"
           ]
         },
+        "inherits": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "$ref": "#/definitions/StringExpression"
+            },
+            {
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "$ref": "#/definitions/StringExpression"
+                  }
+                ]
+              },
+              "type": "array"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Profiles to inherit from.\n\nExamples:\n```toml\ninherits = [\"default\", \"Firefox\"]\n```\n",
+          "title": "Inherits"
+        },
         "languages": {
           "default": null,
           "description": "Activate localization. `lang` can be a name or a code\nof a built-in language, or a path or a module name of\na custom language file.\n\ncorresponds to the `--language lang *` option of _robot_\n",
diff --git a/packages/robot/src/robotcode/robot/config/model.py b/packages/robot/src/robotcode/robot/config/model.py
@@ -99,7 +99,7 @@ def field(
     return dataclasses.field(*args, **kwargs)
 
 
-class EvaluationError(Exception):
+class EvaluationError(ValueError):
     """Evaluation error."""
 
     def __init__(self, expression: str, message: str):
@@ -155,15 +155,19 @@ def evaluate(self) -> Any:
         try:
             return safe_eval(self.expr, SAFE_GLOBALS)
         except Exception as e:
-            raise EvaluationError(self.expr, str(e)) from e
+            raise EvaluationError(self.expr, f"{type(e).__name__}: {e}") from e
 
 
 @dataclass
 class StringExpression(Expression):
     """Expression to evaluate to a string."""
 
     def evaluate(self) -> str:
-        return str(super().evaluate())
+        result = super().evaluate()
+        if result is None:
+            return ""
+
+        return str(result)
 
     def __str__(self) -> str:
         return self.evaluate()
@@ -2201,24 +2205,36 @@ def evaluated_with_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}")
+                    verbose_callback(lambda: f"Set environment variable `{k}` to `{v}`")
 
         return self.evaluated(verbose_callback)
 
 
 @dataclass
-class RobotExtraBaseProfile(RobotBaseProfile):
+class RobotExtendBaseProfile(RobotBaseProfile):
     """Base profile for Robot Framework with Extras."""
 
     extend_args: Optional[List[str]] = field(
         description="""\
             Append extra arguments to be passed to _robot_.
+
+            Examples:
+            ```toml
+            extend-args = ["-t", "abc"]
+            ```
             """
     )
 
     extend_env: Optional[Dict[str, Union[str, StringExpression]]] = field(
         description="""\
-            Append extra environment variables to be set before tests.
+            Append extra environment variables to be set before run.
+
+            Examples:
+            ```toml
+            [extend-env]
+            EXTRA_VAR = "value"
+
+            ```
             """
     )
 
@@ -2228,14 +2244,14 @@ class RobotExtraBaseProfile(RobotBaseProfile):
 
             Examples:
             ```toml
-            paths = ["tests"]
+            extend-paths = ["tests"]
             ```
             """
     )
 
 
 @dataclass
-class RobotProfile(RobotExtraBaseProfile):
+class RobotProfile(RobotExtendBaseProfile):
     """Robot Framework configuration profile."""
 
     description: Optional[str] = field(description="Description of the profile.")
@@ -2265,15 +2281,42 @@ class RobotProfile(RobotExtraBaseProfile):
             """
     )
 
+    hidden: Union[bool, Condition, None] = field(
+        description="""\
+            The profile should be hidden.
+            Hidden means it is not shown in the list of available profiles.
+
+            Examples:
+            ```toml
+            hidden = true
+            ```
+
+            ```toml
+            hidden = { if = 'environ.get("CI") == "true"' }
+            ```
+            """
+    )
+
     precedence: Optional[int] = field(
         description="""\
         Precedence of the profile. Lower values are executed first. If not set the order is undefined.
         """
     )
 
+    inherits: Union[str, StringExpression, List[Union[str, StringExpression]], None] = field(
+        description="""\
+            Profiles to inherit from.
+
+            Examples:
+            ```toml
+            inherits = ["default", "Firefox"]
+            ```
+            """
+    )
+
 
 @dataclass
-class RobotConfig(RobotExtraBaseProfile):
+class RobotConfig(RobotExtendBaseProfile):
     """Robot Framework configuration."""
 
     default_profiles: Union[str, List[str], None] = field(
@@ -2318,14 +2361,32 @@ def select_profiles(
 
             names = (*(default_profile or ()),)
 
-        for name in names:
+        def select(name: str) -> None:
+            if not name:
+                return
+
+            nonlocal result
+
+            if verbose_callback:
+                verbose_callback(f"Selecting profiles matching '{name}'.")
+
             profile_names = [p for p in profiles.keys() if fnmatch.fnmatchcase(p, name)]
 
             if not profile_names:
                 raise ValueError(f"Can't find any profiles matching the pattern '{name}'.")
 
             for v in profile_names:
-                result.update({v: profiles[v]})
+                p = profiles[v]
+                result.update({v: p})
+                if p.inherits:
+                    if isinstance(p.inherits, list):
+                        for i in p.inherits:
+                            select(str(i))
+                    else:
+                        select(str(p.inherits))
+
+        for name in names:
+            select(name)
 
         return result
 
@@ -2335,6 +2396,12 @@ def combine_profiles(
         type_hints = get_type_hints(RobotBaseProfile)
         base_field_names = [f.name for f in dataclasses.fields(RobotBaseProfile)]
 
+        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}`")
+
         result = RobotBaseProfile(
             **{
                 f.name: self._verified_value(f.name, new, type_hints[f.name], self)
@@ -2346,7 +2413,7 @@ def combine_profiles(
         selected_profiles = self.select_profiles(*names, verbose_callback=verbose_callback)
         if verbose_callback:
             if selected_profiles:
-                verbose_callback(f"Select profiles: {', '.join(selected_profiles.keys())}")
+                verbose_callback(f"Selected profiles: {', '.join(selected_profiles.keys())}")
             else:
                 verbose_callback("No profiles selected.")
 
@@ -2362,6 +2429,12 @@ def combine_profiles(
             if verbose_callback:
                 verbose_callback(f'Using profile "{profile_name}".')
 
+            if profile.env:
+                for k, v in profile.env.items():
+                    os.environ[k] = str(v)
+                    if verbose_callback:
+                        verbose_callback(lambda: f"Set environment variable `{k}` to `{v}`")
+
             if profile.detached:
                 result = RobotBaseProfile()
 
diff --git a/src/robotcode/cli/commands/profiles.py b/src/robotcode/cli/commands/profiles.py
