classyclick: make use of helpers to simplify code (#60)

Author: fopina

Makefile

@@ -6,6 +6,9 @@ lint-check:
 	uv run ruff format --diff
 	uv run ruff check
 
+sync:
+	uv sync --dev --all-extras
+
 .venv39: export VIRTUAL_ENV=.venv39
 .venv39:
 	uv sync --dev --extra cli --python 3.9 --active

defectdojo_api_generated/cli/__main__.py

@@ -1,15 +1,6 @@
 """Command-line entrypoint for defectdojo_api_generated."""
 
-import importlib
-import pkgutil
 import sys
-from pathlib import Path
-
-
-def discover_commands():
-    # str() required because of py3.10
-    for _, module_name, _ in pkgutil.iter_modules([str(Path(__file__).parent / 'commands')]):
-        importlib.import_module(f'{__package__}.commands.{module_name}')
 
 
 def load_cli():
@@ -28,7 +19,6 @@ def load_cli():
 
 def main():
     CLI = load_cli()
-    discover_commands()
     CLI.click()
 
 

defectdojo_api_generated/cli/commands/__init__.py

@@ -33,7 +33,7 @@
 )
 
 
-class API(CLI.SubGroup, classyclick.Group):
+class API(CLI.SubGroup):
     """Interact directly with any API/method"""
 
 
@@ -326,7 +326,7 @@ def _build_command_namespace(command_name: str, api_class: type, target_method:
 def _build_command_class(parent_class: type, namespace: dict[str, Any]) -> type:
     return type(
         'ApiCommand',
-        (parent_class, classyclick.Command),
+        (parent_class,),
         namespace,
     )
 
@@ -572,7 +572,7 @@ def make_api_group(module_name: str, api_class: type) -> type:
         _, target_method = command_methods[0]
         return make_api_command(api_class, group_name, target_method, parent_class=API.Command)
 
-    class ApiGroup(API.SubGroup, classyclick.Group):
+    class ApiGroup(API.SubGroup):
         __config__ = classyclick.Group.Config(
             name=group_name,
             help=f'methods from `{api_class.__name__}`.',

defectdojo_api_generated/cli/commands/apis.py

@@ -2,51 +2,25 @@
 
 import logging
 from pathlib import Path
-from typing import Optional
 
 import classyclick
 import click
-from platformdirs import user_config_dir
 
 from defectdojo_api_generated.client import DefectDojo
 
 from ... import __version__
 
-try:
-    # Python 3.11+
-    import tomllib
-except ModuleNotFoundError:
-    # Python < 3.11
-    import tomli as tomllib  # type: ignore
 
-
-DEFAULT_PATH = Path(user_config_dir('defectdojo-generated-api')) / 'config.toml'
-
-
-def ensure_config_file(config_path: Optional[Path]) -> Path:
-    config_path = config_path or DEFAULT_PATH
-    if not config_path.exists():
-        config_path.parent.mkdir(parents=True, exist_ok=True)
-        config_path.write_text((Path(__file__).parent.parent / 'config.example.toml').read_text())
-        print(f'Info: No configuration file found at {config_path}, a sample config has been placed there.')
-
-    return config_path
-
-
-def load_config_data(config_path: Path) -> dict:
-    with config_path.open('rb') as f:
-        return tomllib.load(f)
-
-
-class CLI(classyclick.Group):
+class CLI(classyclick.helpers.ConfigFileMixin, classyclick.Group):
     """DefectDojo CLI"""
 
-    __config__ = classyclick.Group.Config(context_settings=dict(show_default=True))
-
-    config: Path = classyclick.Option(help='Path to the configuration file', show_default=str(DEFAULT_PATH))
-    env: str = classyclick.Option(
-        '-e', help='Environment to use for the command (as many can be specified in config.toml)'
+    __config__ = classyclick.Group.Config(
+        context_settings=dict(show_default=True),
+        decorators=[click.version_option(version=__version__, message='%(version)s')],
     )
+    CONFIG_DEFAULT_NAME = 'defectdojo-generated-api'
+    CONFIG_EXAMPLE_PATH = Path(__file__).parent.parent / 'config.example.toml'
+
     host: str = classyclick.Option(
         '-h',
         envvar='DEFECTDOJO_HOST',
@@ -73,37 +47,9 @@ class CLI(classyclick.Group):
     )
     disable_tls: bool = classyclick.Option(help='Disable TLS verification in DefectDojo API requests')
     debug_http: bool = classyclick.Option(help='Log HTTP requests and responses')
-    ctx: classyclick.Context = classyclick.Context()
 
     def __call__(self):
-        self.config = ensure_config_file(self.config)
-        config_data = load_config_data(self.config)
-
-        if self.env is None:
-            self.env = config_data.get('default_env')
-
-        # allow empty string to choose root environment when "default_env" is set to something else
-        if self.env:
-            if self.env not in config_data.get('env', {}):
-                raise click.ClickException(f'Environment "{self.env}" not found in {self.config}')
-            env_config = config_data['env'][self.env]
-            config_data = merge_dicts(config_data, env_config)
-
-        # to late to have these options from default_map, so process them manually
-        if self.host is None:
-            self.host = config_data.get('host')
-
-        if self.token is None:
-            self.token = config_data.get('token')
-
-        if self.user is None:
-            self.user = config_data.get('user')
-
-        if self.password is None:
-            self.password = config_data.get('password')
-
-        if self.disable_tls is None:
-            self.disable_tls = config_data.get('disable_tls', False)
+        self.load_config()
 
         if self.debug_http:
             import http.client
@@ -120,32 +66,10 @@ def __call__(self):
             auth=None if self.token else (self.user, self.password),
             verify_ssl=not self.disable_tls,
         )
-        self.ctx.meta['config_path'] = self.config
-        self.ctx.meta['config_data'] = config_data
-        self.ctx.meta['selected_env'] = self.env
-
-        self.ctx.default_map = config_data
-
-
-def merge_dicts(base: dict, override: dict) -> dict:
-    """
-    To merge two Python dictionaries where:
-    * nested dictionaries should merge recursively
-    * lists and other values should be replaced entirely
-
-    by ChatGPT
-    """
-    result = base.copy()
-    for key, value in override.items():
-        if key in result:
-            if isinstance(result[key], dict) and isinstance(value, dict):
-                result[key] = merge_dicts(result[key], value)
-            else:
-                result[key] = value
-        else:
-            result[key] = value
-    return result
-
-
-# TODO: classyclick missing @click.version_option - https://github.com/fopina/classyclick/issues/48
-CLI.click = click.version_option(version=__version__, message='%(version)s')(CLI.click)
+
+
+class Config(classyclick.helpers.ConfigBaseCommand, CLI.Command):
+    pass
+
+
+classyclick.helpers.discover_commands(__package__)

defectdojo_api_generated/cli/commands/cli.py

@@ -8,7 +8,7 @@
 from .cli import CLI
 
 
-class Status(CLI.Command, classyclick.Command):
+class Status(CLI.Command):
     """Quick connectivity check"""
 
     client: DefectDojo = classyclick.ContextMeta('client')

defectdojo_api_generated/cli/commands/config.py

@@ -1,11 +1,9 @@
 def on_config(config, **kwargs):
-    from defectdojo_api_generated.cli import __main__
-
-    __main__.discover_commands()
-
     # TODO: mkdocs-click does not support class nor class methods - create PR for this
+    # so `cli.md` can use `CLI.click` directly instead of monkeypatched `_docs_cli_`
     from defectdojo_api_generated.cli.commands import cli
+    from defectdojo_api_generated.cli.commands.cli import CLI
 
-    cli._docs_cli_ = cli.CLI.click
+    cli._docs_cli_ = CLI.click
 
     return config

defectdojo_api_generated/cli/commands/status.py

@@ -18,9 +18,8 @@ dependencies = [
 
 [project.optional-dependencies]
 cli = [
-    "classyclick==0.8.0",
+    "classyclick==1.0.0",
     "jmespath>=1.0.1",
-    "platformdirs>=4.4.0",
 ]
 
 [project.scripts]

docs/hooks.py

@@ -4,7 +4,7 @@
 
 from click.testing import CliRunner
 
-from defectdojo_api_generated.cli import __main__
+from defectdojo_api_generated.cli.commands.cli import CLI
 
 from . import E2ETestCase
 
@@ -15,19 +15,11 @@ class Test(E2ETestCase):
     # Run `run_dojo.sh` manually (and stop after), set this one to True and then you can run individual tests here quickly
     _PARTIAL_RUN = False
 
-    @classmethod
-    def setUpClass(cls):
-        __main__.discover_commands()
-        cls.CLI = __main__.load_cli()
-        super().setUpClass()
-
     def setUp(self):
         self.runner = CliRunner()
 
     def _run_cli(self, *args):
-        return self.runner.invoke(
-            self.CLI.click, ['--config', Path(__file__).parent / 'config.integration.toml', *args]
-        )
+        return self.runner.invoke(CLI.click, ['--config', Path(__file__).parent / 'config.integration.toml', *args])
 
     def _run_cli_api(self, *args):
         return self._run_cli('api', *args)