feat: Add build_arg_defaults support for execution environment projects (#584)

* clean build_args_default

* remove scm changes from this PR

* fix tests

* Try to fix lint

Author: KB-perByte

cspell.config.yaml

@@ -28,6 +28,7 @@ ignoreWords:
   - adoc
   - argparser
   - dellos
+  - dictsort
   - endfor
   - envsubst
   - endif

src/ansible_creator/_arg_parser_custom.py

@@ -0,0 +1,125 @@
+"""Custom argparse formatter and parser used by ``arg_parser``."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+
+from argparse import HelpFormatter
+from operator import attrgetter
+from typing import TYPE_CHECKING
+
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+    from typing import Any
+
+
+class CustomHelpFormatter(HelpFormatter):  # pragma: no cover py>=3.14
+    """A custom help formatter."""
+
+    def __init__(self, prog: str) -> None:
+        """Initialize the help formatter.
+
+        Args:
+            prog: The program name
+        """
+        long_string = "--abc  --really_really_really_log"
+        # 3 here accounts for the spaces in the ljust(6) below
+        HelpFormatter.__init__(
+            self,
+            prog=prog,
+            indent_increment=1,
+            max_help_position=len(long_string) + 3,
+        )
+
+    def _format_action_invocation(
+        self,
+        action: argparse.Action,
+    ) -> str:
+        """Format the action invocation.
+
+        Args:
+            action: The action to format
+
+        Raises:
+            ValueError: If more than 2 options are given
+
+        Returns:
+            The formatted action invocation
+        """
+        if not action.option_strings:  # pragma: no branch
+            default = self._get_default_metavar_for_positional(action)
+            (metavar,) = self._metavar_formatter(action, default)(1)
+            return metavar
+
+        if len(action.option_strings) == 1:
+            return action.option_strings[0]
+
+        max_variations = 2
+        if len(action.option_strings) == max_variations:
+            # Account for a --1234 --long-option-name
+            return f"{action.option_strings[0].ljust(6)} {action.option_strings[1]}"
+        msg = "Too many option strings"
+        raise ValueError(msg)
+
+    def add_arguments(self, actions: Iterable[argparse.Action]) -> None:
+        """Add arguments sorted by option strings.
+
+        Args:
+            actions: The actions to add
+        """
+        actions = sorted(actions, key=attrgetter("option_strings"))
+        super().add_arguments(actions)
+
+
+class CustomArgumentParser(argparse.ArgumentParser):
+    """A custom argument parser."""
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:  # noqa: ANN401
+        """Initialize the argument parser.
+
+        Args:
+            *args: The arguments
+            **kwargs: The keyword arguments
+        """
+        super().__init__(*args, **kwargs)
+        if sys.version_info < (3, 14):  # pragma: no cover py>=3.14
+            self.formatter_class = CustomHelpFormatter
+
+    def add_argument(  # type: ignore[override]
+        self,
+        *args: Any,  # noqa: ANN401
+        **kwargs: Any,  # noqa: ANN401
+    ) -> None:
+        """Add an argument.
+
+        Args:
+            *args: The arguments
+            **kwargs: The keyword arguments
+        """
+        if sys.version_info < (3, 14):  # pragma: no cover py>=3.14
+            if "choices" in kwargs:  # pragma: no cover py>=3.14
+                kwargs["help"] += f" (choices: {', '.join(kwargs['choices'])})"
+            if "default" in kwargs and kwargs["default"] != "==SUPPRESS==":
+                kwargs["help"] += f" (default: {kwargs['default']})"
+        super().add_argument(*args, **kwargs)
+
+    def add_argument_group(
+        self,
+        *args: Any,  # noqa: ANN401
+        **kwargs: Any,  # noqa: ANN401
+    ) -> argparse._ArgumentGroup:
+        """Add an argument group.
+
+        Args:
+            *args: The arguments
+            **kwargs: The keyword arguments
+
+        Returns:
+            The argument group
+        """
+        group = super().add_argument_group(*args, **kwargs)
+        if group.title:  # pragma: no cover
+            group.title = group.title.capitalize()
+        return group

src/ansible_creator/arg_parser.py

@@ -7,17 +7,12 @@
 import re
 import sys
 
-from argparse import HelpFormatter
-from operator import attrgetter
 from pathlib import Path
 from typing import TYPE_CHECKING, TypeAlias
 
 from ansible_creator.output import Level, Msg
 
-
-if TYPE_CHECKING:
-    from collections.abc import Iterable
-    from typing import Any
+from ._arg_parser_custom import CustomArgumentParser
 
 
 try:
@@ -40,64 +35,6 @@
     SubParser: TypeAlias = argparse._SubParsersAction  # noqa: SLF001
 
 
-class CustomHelpFormatter(HelpFormatter):  # pragma: no cover py>=3.14
-    """A custom help formatter."""
-
-    def __init__(self, prog: str) -> None:
-        """Initialize the help formatter.
-
-        Args:
-            prog: The program name
-        """
-        long_string = "--abc  --really_really_really_log"
-        # 3 here accounts for the spaces in the ljust(6) below
-        HelpFormatter.__init__(
-            self,
-            prog=prog,
-            indent_increment=1,
-            max_help_position=len(long_string) + 3,
-        )
-
-    def _format_action_invocation(
-        self,
-        action: argparse.Action,
-    ) -> str:
-        """Format the action invocation.
-
-        Args:
-            action: The action to format
-
-        Raises:
-            ValueError: If more than 2 options are given
-
-        Returns:
-            The formatted action invocation
-        """
-        if not action.option_strings:  # pragma: no branch
-            default = self._get_default_metavar_for_positional(action)
-            (metavar,) = self._metavar_formatter(action, default)(1)
-            return metavar
-
-        if len(action.option_strings) == 1:
-            return action.option_strings[0]
-
-        max_variations = 2
-        if len(action.option_strings) == max_variations:
-            # Account for a --1234 --long-option-name
-            return f"{action.option_strings[0].ljust(6)} {action.option_strings[1]}"
-        msg = "Too many option strings"
-        raise ValueError(msg)
-
-    def add_arguments(self, actions: Iterable[argparse.Action]) -> None:
-        """Add arguments sorted by option strings.
-
-        Args:
-            actions: The actions to add
-        """
-        actions = sorted(actions, key=attrgetter("option_strings"))
-        super().add_arguments(actions)
-
-
 class Parser:
     """A parser for the command line arguments."""
 
@@ -835,6 +772,16 @@ def _init_ee_project(self, subparser: SubParser[argparse.ArgumentParser]) -> Non
             "Must end with .yml or .yaml. Default: execution-environment.yml",
         )
 
+        parser.add_argument(
+            "--ee-build-arg-default",
+            dest="ee_build_arg_defaults",
+            action="append",
+            default=[],
+            metavar="KEY=VALUE",
+            help="Default build ARG for the EE image (repeatable). "
+            "Example: --ee-build-arg-default ANSIBLE_GALAXY_CLI_COLLECTION_OPTS=--pre",
+        )
+
         parser.add_argument(
             "--registry-tls-verify",
             dest="registry_tls_verify",
@@ -943,53 +890,4 @@ def handle_deprecations(self) -> bool:  # noqa: C901
         return True
 
 
-class CustomArgumentParser(argparse.ArgumentParser):
-    """A custom argument parser."""
-
-    def __init__(self, *args: Any, **kwargs: Any) -> None:  # noqa: ANN401
-        """Initialize the argument parser.
-
-        Args:
-            *args: The arguments
-            **kwargs: The keyword arguments
-        """
-        super().__init__(*args, **kwargs)
-        if sys.version_info < (3, 14):  # pragma: no cover py>=3.14
-            self.formatter_class = CustomHelpFormatter
-
-    def add_argument(  # type: ignore[override]
-        self,
-        *args: Any,  # noqa: ANN401
-        **kwargs: Any,  # noqa: ANN401
-    ) -> None:
-        """Add an argument.
-
-        Args:
-            *args: The arguments
-            **kwargs: The keyword arguments
-        """
-        if sys.version_info < (3, 14):  # pragma: no cover py>=3.14
-            if "choices" in kwargs:  # pragma: no cover py>=3.14
-                kwargs["help"] += f" (choices: {', '.join(kwargs['choices'])})"
-            if "default" in kwargs and kwargs["default"] != "==SUPPRESS==":
-                kwargs["help"] += f" (default: {kwargs['default']})"
-        super().add_argument(*args, **kwargs)
-
-    def add_argument_group(
-        self,
-        *args: Any,  # noqa: ANN401
-        **kwargs: Any,  # noqa: ANN401
-    ) -> argparse._ArgumentGroup:
-        """Add an argument group.
-
-        Args:
-            *args: The arguments
-            **kwargs: The keyword arguments
-
-        Returns:
-            The argument group
-        """
-        group = super().add_argument_group(*args, **kwargs)
-        if group.title:  # pragma: no cover
-            group.title = group.title.capitalize()
-        return group
+__all__ = ["CustomArgumentParser", "Parser"]

src/ansible_creator/config.py

@@ -47,6 +47,7 @@ class Config:
         ee_system_packages: List of system packages for execution environment.
         ee_name: Name/tag for the execution environment image.
         ee_file_name: Name of the EE definition file.
+        ee_build_arg_defaults: EE build ARG defaults as KEY=VALUE strings (from CLI).
         registry_tls_verify: Whether to verify TLS for container registry operations
             (login, pull, push, and image builds). None means the user did not
             explicitly set this flag, so the EE config file value is preserved.
@@ -80,6 +81,7 @@ class Config:
     ee_system_packages: Sequence[str] = field(default_factory=list)
     ee_name: str = "ansible_sample_ee"
     ee_file_name: str = "execution-environment.yml"
+    ee_build_arg_defaults: Sequence[str] = field(default_factory=list)
     registry_tls_verify: bool | None = None
     scm_provider: str = "github"
 

src/ansible_creator/resources/execution_env_project/execution-environment.yml.j2

@@ -4,6 +4,13 @@ version: 3
 images:
   base_image:
     name: {{ ee_base_image }}
+{%- if ee_build_arg_defaults %}
+
+build_arg_defaults:
+{%- for key, val in ee_build_arg_defaults | dictsort %}
+  {{ key }}: {{ val | json }}
+{%- endfor %}
+{%- endif %}
 
 dependencies:
 {%- if not is_official_ee %}