feat(robotcode): Add commands to get informations about configurations and profiles

Author: d-biehl

hatch.toml

@@ -25,7 +25,7 @@ dependencies = [
   "tomli-w",
   "rich",
 ]
-features = ["yaml", "rest", "lint", "tidy"]
+features = ["all"]
 pre-install-commands = ["python ./scripts/install_packages.py"]
 
 
@@ -39,7 +39,6 @@ create_json_schema = "python ./scripts/create_robot_toml_json_schema.py"
 
 [envs.devel]
 python = "38"
-features = ["yaml", "rest", "lint", "tidy"]
 
 [[envs.devel.matrix]]
 python = ["38", "39", "310", "311"]

packages/analyze/robotcode/analyze/cli/__init__.py

@@ -9,7 +9,6 @@
     context_settings={
         "allow_extra_args": True,
         "ignore_unknown_options": True,
-        "help_option_names": ["-h", "--help"],
     },
     add_help_option=True,
 )

packages/plugin/robotcode/plugin/__init__.py

@@ -1,22 +1,30 @@
 from dataclasses import dataclass
+from enum import Enum
 from pathlib import Path
 from typing import Any, Callable, List, Optional, TypeVar, cast
 
 import click
 import pluggy
 
-__all__ = ["hookimpl", "CommonConfig", "pass_common_config"]
+__all__ = ["hookimpl", "ClickCommonConfig", "pass_common_config"]
 
 F = TypeVar("F", bound=Callable[..., Any])
 hookimpl = cast(Callable[[F], F], pluggy.HookimplMarker("robotcode"))
 
 
+class ColoredOutput(str, Enum):
+    AUTO = "auto"
+    YES = "yes"
+    NO = "no"
+
+
 @dataclass
-class CommonConfig:
+class ClickCommonConfig:
     config_file: Optional[Path] = None
     profiles: Optional[List[str]] = None
     dry: bool = False
     verbose: bool = False
+    colored_output: ColoredOutput = ColoredOutput.AUTO
 
 
-pass_common_config = click.make_pass_decorator(CommonConfig, ensure=True)
+pass_common_config = click.make_pass_decorator(ClickCommonConfig, ensure=True)

packages/robot/robotcode/robot/config/loader.py

@@ -31,6 +31,7 @@ class ConfigType(str, Enum):
     PYPROJECT_TOML = PYPROJECT_TOML
     ROBOT_TOML = ROBOT_TOML
     LOCAL_ROBOT_TOML = LOCAL_ROBOT_TOML
+    CUSTOM_TOML = ".toml"
 
 
 def loads_config_from_robot_toml(__s: str) -> RobotConfig:

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

@@ -420,9 +420,20 @@ def get_profile(self, *names: str, verbose_callback: Callable[..., None] = None)
 
         profiles = self.profiles or {}
 
+        if not names:
+            if verbose_callback:
+                verbose_callback('No profiles given, try to check if there are default profiles specified".')
+
+            default_profile = [self.default_profile] if isinstance(self.default_profile, str) else self.default_profile
+
+            if verbose_callback and default_profile:
+                verbose_callback(f"Using default profiles {', '.join( default_profile)}.")
+
+            names = (*(default_profile or ()),)
+
         for profile_name in names:
             if profile_name not in profiles:
-                raise ValueError(f'Unknown profile "{profile_name}".')
+                raise ValueError(f'Profile "{profile_name}" is not defined.')
 
             profile = profiles[profile_name]
 

packages/runner/robotcode/runner/cli/__init__.py

@@ -8,7 +8,7 @@
 from robot.run import USAGE, RobotFramework
 from robot.version import get_full_version
 
-from robotcode.plugin import CommonConfig, pass_common_config
+from robotcode.plugin import ClickCommonConfig, pass_common_config
 from robotcode.robot.config.loader import find_project_root, get_config_files_from_folder, load_config_from_path
 from robotcode.robot.config.model import BaseProfile
 
@@ -59,7 +59,6 @@ def main(self, arguments: Any, **options: Any) -> Any:
     context_settings={
         "allow_extra_args": True,
         "ignore_unknown_options": True,
-        "help_option_names": ["-h", "--help"],
     },
     add_help_option=True,
     short_help='Runs "robot" with the selected configuration, profiles, options and arguments.',
@@ -74,7 +73,7 @@ def main(self, arguments: Any, **options: Any) -> Any:
 @click.pass_context
 @pass_common_config
 def run(
-    common_config: CommonConfig,
+    common_config: ClickCommonConfig,
     ctx: click.Context,
     robot_options_and_args: Tuple[str, ...],
 ) -> Union[str, int, None]:

pyproject.toml

@@ -74,6 +74,7 @@ yaml = ["PyYAML>=5.4", "types-PyYAML>=5.4"]
 lint = ["robotframework-robocop>=2.0.0"]
 tidy = ["robotframework-tidy>=2.0.0"]
 rest = ["docutils"]
+colored = ["rich"]
 all = [
   "runner",
   "debugger",
@@ -82,6 +83,8 @@ all = [
   "yaml",
   "lint",
   "tidy",
+  "colored",
+  "rest",
 ]
 
 

robotcode/cli/__init__.py

@@ -3,15 +3,15 @@
 
 import click
 
-from robotcode.plugin import CommonConfig, pass_common_config
+from robotcode.plugin import ClickCommonConfig, ColoredOutput, pass_common_config
 from robotcode.plugin.manager import PluginManager
 
 from .__version__ import __version__
-from .commands import config
+from .commands import config, profiles
 
 
 @click.group(
-    context_settings={"help_option_names": ["-h", "--help"], "auto_envvar_prefix": "ROBOTCODE"},
+    context_settings={"auto_envvar_prefix": "ROBOTCODE"},
     invoke_without_command=False,
 )
 @click.version_option(version=__version__, prog_name="robotcode")
@@ -36,16 +36,24 @@
         """,
 )
 @click.option("-d", "--dry", is_flag=True, show_envvar=True, help="Dry run, do not execute any commands.")
+@click.option(
+    "--color / --no-color",
+    "color",
+    default=None,
+    help="Whether or not to display colored output (default is auto-detection).",
+    show_envvar=True,
+)
 @click.option("-v", "--verbose", is_flag=True, help="Enables verbose mode.")
 @click.pass_context
 @pass_common_config
 def robotcode(
-    common_config: CommonConfig,
+    common_config: ClickCommonConfig,
     ctx: click.Context,
     config_file: Optional[Path],
     profiles: Optional[List[str]],
-    dry: bool = False,
-    verbose: bool = False,
+    dry: bool,
+    verbose: bool,
+    color: Optional[bool],
 ) -> None:
     """\b
  _____       _           _    _____          _
@@ -60,9 +68,16 @@ def robotcode(
     common_config.profiles = profiles
     common_config.dry = dry
     common_config.verbose = verbose
+    if color is None:
+        common_config.colored_output = ColoredOutput.AUTO
+    elif color:
+        common_config.colored_output = ColoredOutput.YES
+    else:
+        common_config.colored_output = ColoredOutput.NO
 
 
 robotcode.add_command(config)
+robotcode.add_command(profiles)
 
 for p in PluginManager().cli_commands:
     for c in p:

robotcode/cli/commands/__init__.py

@@ -1,3 +1,4 @@
 from .config import config
+from .profiles import profiles
 
-__all__ = ["config"]
+__all__ = ["config", "profiles"]

robotcode/cli/commands/_common.py

@@ -0,0 +1,74 @@
+from pathlib import Path
+from typing import Any, Dict, List, Sequence, Tuple
+
+import click
+
+from robotcode.core.dataclasses import as_json
+from robotcode.plugin import ClickCommonConfig, ColoredOutput
+from robotcode.robot.config.loader import (
+    ConfigType,
+    find_project_root,
+    get_config_files_from_folder,
+)
+
+
+def print_dict(config: Dict[str, Any], format: str, color: ColoredOutput) -> None:
+    text = None
+    if format == "toml":
+        try:
+            import tomli_w
+
+            text = tomli_w.dumps(config)
+        except ImportError:
+            click.secho("tomli-w is required to output toml.", fg="red", err=True)
+
+            format = "json"
+
+    if text is None:
+        text = as_json(config, indent=True)
+
+    if not text:
+        return
+
+    if color in [ColoredOutput.AUTO, ColoredOutput.YES]:
+        try:
+            from rich.console import Console
+            from rich.syntax import Syntax
+
+            Console().print(Syntax(text, format, background_color="default"))
+
+            return
+        except ImportError as e:
+            if color == "yes":
+                raise click.ClickException('Package "rich" is required to use colored output.') from e
+
+    click.echo(text)
+
+    return
+
+
+def get_config_files(common_config: ClickCommonConfig, paths: List[Path]) -> Sequence[Tuple[Path, ConfigType]]:
+    if common_config.config_file is not None:
+        if common_config.verbose:
+            click.secho(f"Using config file: {common_config.config_file}", fg="bright_black")
+
+        return [(common_config.config_file, ConfigType.CUSTOM_TOML)]
+
+    root_folder, discovered_by = find_project_root(*(paths or []))
+
+    if root_folder is None:
+        raise click.ClickException("Cannot detect root folder for project. 😥")
+
+    if common_config.verbose:
+        click.secho(f"Found project root at:\n    {root_folder} ({discovered_by})", fg="bright_black")
+
+    result = get_config_files_from_folder(root_folder)
+
+    if result:
+        if common_config.verbose:
+            click.secho(
+                "Found configuration files:\n    " + "\n    ".join(str(f[0]) for f in result),
+                fg="bright_black",
+            )
+
+    return result