Merge pull request #20 from openSUSE/bug-cli-and-placeholders

Replace placeholders in cli (and context)

Author: tomschr

changelog.d/20.bugfix.rst

@@ -0,0 +1 @@
+Replace placeholders in :command:`cli` main command. This ensures that the placeholders in the environment or application configuration are replaced before the subcommands are executed. This is necessary because the subcommands might rely on these placeholders being resolved.

src/docbuild/cli/cmd_c14n.py

@@ -12,6 +12,4 @@ def c14n(ctx: click.Context) -> None:
 
     :param ctx: The Click context object.
     """
-    ctx.ensure_object(DocBuildContext)
-    context: DocBuildContext = ctx.obj
-    click.echo(f'[C17N] Verbosity: {context.verbose}')
+    click.echo(f'[C17N] Verbosity: {ctx.obj.verbose}')

src/docbuild/cli/cmd_cli.py

@@ -5,6 +5,7 @@
 import click
 
 from ..__about__ import __version__
+from ..config.app import replace_placeholders
 from ..config.load import handle_config
 from ..constants import (
     APP_CONFIG_BASENAMES,
@@ -117,6 +118,8 @@ def cli(
         None,
         DEFAULT_APP_CONFIG,
     )
+    context.appconfig = replace_placeholders(context.appconfig)
+
     (
         context.envconfigfiles,
         context.envconfig,
@@ -128,6 +131,9 @@ def cli(
         DEFAULT_ENV_CONFIG_FILENAME,
         DEFAULT_ENV_CONFIG,
     )
+    context.envconfig = replace_placeholders(
+        context.envconfig,
+    )
 
 
 # Add subcommand

src/docbuild/cli/cmd_validate.py

@@ -26,16 +26,11 @@ def validate(ctx: click.Context, xmlfiles: tuple | Iterator[Path]) -> None:
 
     :param ctx: The Click context object.
     """
-    ctx.ensure_object(DocBuildContext)
     context: DocBuildContext = ctx.obj
     if context.envconfig is None:
         # log.critical('No envconfig found in context.')
         raise ValueError('No envconfig found in context.')
 
-    # Replace placeholders in the envconfig
-    # TODO: shouldn't this be done somewhere else? In the context initialization?
-    context.envconfig = replace_placeholders(context.envconfig)
-
     if (paths := ctx.obj.envconfig.get('paths')) is None:
         raise ValueError('No paths found in envconfig.')
 

src/docbuild/config/app.py

@@ -3,10 +3,6 @@
 import re
 from typing import Any
 
-# Type aliases
-Container = dict[str, Any] | list[Any]
-"""A dictionary or list container for any configuration data."""
-
 MAX_RECURSION_DEPTH: int = 10
 """The maximum recursion depth for placeholder replacement."""
 
@@ -159,9 +155,9 @@ def replace(self) -> dict[str, Any]:
 
 
 def replace_placeholders(
-    config: dict[str, Any],
+    config: dict[str, Any] | None,
     max_recursion_depth: int = MAX_RECURSION_DEPTH,
-) -> Container:
+) -> dict[str, Any] | None:
     """Replace placeholder values in a nested dictionary structure.
 
     * ``{foo}`` resolves from the current section.

src/docbuild/config/load.py

@@ -7,11 +7,11 @@
 from typing import Any
 
 from ..constants import DEFAULT_ENV_CONFIG_FILENAME
-from .app import Container, replace_placeholders
+from .app import replace_placeholders
 from .merge import deep_merge
 
 
-def process_envconfig(envconfigfile: str | Path | None) -> tuple[Path, Container]:
+def process_envconfig(envconfigfile: str | Path | None) -> tuple[Path, dict[str, Any]]:
     """Process the env config.
 
     :param envconfigfile: Path to the env TOML config file.

tests/cli/test_cmd_c14n.py

@@ -36,7 +36,7 @@ def test_c14n_command_with_high_verbosity(self, runner):
     def test_c14n_command_without_context_object(self, runner):
         """Test c14n command without passing a context object."""
         # Don't pass obj parameter - this will test ctx.ensure_object()
-        result = runner.invoke(cmd_c14n.c14n, [])
+        result = runner.invoke(cmd_c14n.c14n, [], obj=DocBuildContext())
 
         assert result.exit_code == 0
         # Should create a default context with verbose=0

tests/cli/test_cmd_cli.py

@@ -30,7 +30,7 @@ def fake_handle_config(user_path, *a, **kw):
     monkeypatch.setattr(cli_mod, 'handle_config', fake_handle_config)
     result = runner.invoke(cli, ['--app-config', str(app_file), 'capture'])
     assert result.exit_code == 0
-    assert result.output.strip() == 'capture'
+    assert 'capture' in result.output.strip()
 
 
 def test_cli_with_app_and_env_config(monkeypatch, runner, tmp_path):
@@ -62,7 +62,7 @@ def fake_handle_config(user_path, *a, **kw):
         obj=context,
     )
     assert result.exit_code == 0
-    assert result.output == 'capture\n'
+    assert 'capture' in result.output.strip()
 
     assert context.appconfigfiles == (app_file,)
     assert context.appconfig == {'app_config_data': 'app_content'}
@@ -94,7 +94,7 @@ def fake_handle_config(user_path, *a, **kw):
         obj=context,
     )
     assert result.exit_code == 0
-    assert result.output == 'capture\n'
+    assert 'capture\n' in result.output
     assert context.verbose == 3
     assert context.debug is True
     assert context.appconfigfiles == (app_file,)

tests/cli/test_cmd_validate.py

@@ -269,7 +269,7 @@ def test_validate_no_envconfig_in_context(self, runner):
             Path('test.xml').write_text('<?xml version="1.0"?><root></root>')
             # When no context object is passed, a default one is created,
             # which has envconfig=None, triggering the error.
-            result = runner.invoke(validate, ['test.xml'])
+            result = runner.invoke(validate, ['test.xml'], obj=DocBuildContext())
 
             assert result.exit_code != 0
             assert isinstance(result.exception, ValueError)