Fix optional dependency installation

Author: cidrblock

src/ansible_dev_environment/subcommands/installer.py

@@ -16,6 +16,7 @@
 from ansible_dev_environment.utils import (
     builder_introspect,
     collections_from_requirements,
+    opt_deps_to_files,
     oxford_join,
     subprocess_run,
 )
@@ -77,6 +78,8 @@ def run(self) -> None:
 
         if self._config.args.requirement or self._config.args.cpi:
             self._install_galaxy_requirements()
+
+        opt_dep_paths = None
         if self._config.args.collection_specifier:
             collections = [
                 parse_collection_request(
@@ -98,7 +101,15 @@ def run(self) -> None:
                     self._output.critical(msg)
                 self._install_galaxy_collections(collections=distant_collections)
 
-        builder_introspect(config=self._config, output=self._output)
+            opt_dep_paths = [
+                path
+                for collection in collections
+                for path in opt_deps_to_files(collection, self._output)
+            ]
+            msg = f"Optional dependencies found: {oxford_join(opt_dep_paths)}"
+            self._output.info(msg)
+
+        builder_introspect(config=self._config, opt_dep_paths=opt_dep_paths, output=self._output)
         self._pip_install()
         Checker(config=self._config, output=self._output).system_deps()
 

src/ansible_dev_environment/utils.py

@@ -18,12 +18,15 @@
 
 
 if TYPE_CHECKING:
+    from collections.abc import Sequence
     from pathlib import Path
     from types import TracebackType
 
+    from .collection import Collection
     from .config import Config
     from .output import Output
 
+
 from typing import Any
 
 
@@ -156,50 +159,58 @@ def subprocess_run(  # pylint: disable=too-many-positional-arguments
         )
 
 
-def oxford_join(words: list[str]) -> str:
+def oxford_join(words: Sequence[str | Path]) -> str:
     """Join a list of words with commas and an oxford comma.
 
     Args:
         words: A list of words to join
     Returns:
         A string of words joined with commas and an oxford comma
     """
-    words.sort()
-    if not words:
+    _words = sorted([str(word) for word in words])
+    if not _words:
         return ""
-    if len(words) == 1:
-        return words[0]
-    if len(words) == 2:  # noqa: PLR2004
-        return " and ".join(words)
-    return ", ".join(words[:-1]) + ", and " + words[-1]
+    if len(_words) == 1:
+        return _words[0]
+    if len(_words) == 2:  # noqa: PLR2004
+        return " and ".join(_words)
+    return ", ".join(_words[:-1]) + ", and " + _words[-1]
 
 
-def opt_deps_to_files(collection_path: Path, dep_str: str) -> list[Path]:
+def opt_deps_to_files(collection: Collection, output: Output) -> list[Path]:
     """Convert a string of optional dependencies to a list of files.
 
     Args:
-        collection_path: The path to the collection
-        dep_str: A string of optional dependencies
+        collection: The collection object
+        output: The output object
     Returns:
-        A list of files
+        A list of paths
     """
-    deps = dep_str.split(",")
+    if not collection.opt_deps:
+        msg = "No optional dependencies specified."
+        output.debug(msg)
+        return []
+
+    deps = collection.opt_deps.split(",")
     files = []
     for dep in deps:
         _dep = dep.strip()
-        variant1 = collection_path / f"{_dep}-requirements.txt"
+        variant1 = collection.path / f"{_dep}-requirements.txt"
         if variant1.exists():
             files.append(variant1)
             continue
-        variant2 = collection_path / f"requirements-{_dep}.txt"
+        variant2 = collection.path / f"requirements-{_dep}.txt"
         if variant2.exists():
             files.append(variant2)
             continue
         msg = (
             f"Failed to find optional dependency file for '{_dep}'."
             f" Checked for '{variant1.name}' and '{variant2.name}'. Skipping."
         )
-        logger.error(msg)
+        output.error(msg)
+    count = len(files)
+    msg = f"Found {count} optional dependency file{'s' * (count > 1)}. {oxford_join(files)}"
+    output.debug(msg)
     return files
 
 
@@ -277,7 +288,11 @@ def collect_manifests(  # noqa: C901
     return sort_dict(collections)
 
 
-def builder_introspect(config: Config, output: Output) -> None:
+def builder_introspect(
+    config: Config,
+    output: Output,
+    opt_dep_paths: list[Path] | None = None,
+) -> None:
     """Introspect a collection.
 
     Use the sys executable to run builder, since it is a direct dependency
@@ -286,29 +301,20 @@ def builder_introspect(config: Config, output: Output) -> None:
     Args:
         config: The configuration object.
         output: The output object.
+        opt_dep_paths: A list of optional dependency paths.
     """
     command = (
         f"{sys.executable} -m ansible_builder introspect {config.site_pkg_path}"
         f" --write-pip {config.discovered_python_reqs}"
         f" --write-bindep {config.discovered_bindep_reqs}"
         " --sanitize"
     )
-    if (
-        hasattr(config.args, "collection_specifier")
-        and hasattr(config, "collection")
-        and config.collection.opt_deps
-        and config.collection.path
-    ):
-        dep_paths = opt_deps_to_files(
-            collection_path=config.collection.path,
-            dep_str=config.collection.opt_deps,
-        )
-        for dep_path in dep_paths:
-            command += f" --user-pip {dep_path}"
+    for opt_dep_path in opt_dep_paths or []:
+        command += f" --user-pip {opt_dep_path}"
     msg = f"Writing discovered python requirements to: {config.discovered_python_reqs}"
-    logger.debug(msg)
+    output.debug(msg)
     msg = f"Writing discovered system requirements to: {config.discovered_bindep_reqs}"
-    logger.debug(msg)
+    output.debug(msg)
     work = "Persisting requirements to file system"
     try:
         subprocess_run(

tests/integration/test_basic.py

@@ -26,6 +26,8 @@ def test_venv(
 ) -> None:
     """Basic smoke test.
 
+    Test for a local collection install with optional dependencies
+
     Args:
         capsys: Capture stdout and stderr
         tmp_path: Temporary directory
@@ -56,17 +58,19 @@ def test_venv(
         [
             "ade",
             "install",
-            str(tmp_path / "cisco.nxos"),
+            str(tmp_path / "cisco.nxos[test]"),
             "--venv=venv",
             "--no-ansi",
+            "-vvv",
         ],
     )
     with pytest.raises(SystemExit):
         main()
-    string = "Installed collections include: ansible.netcommon, ansible.utils,"
-    captured = capsys.readouterr()
 
-    assert string in captured.out
+    captured = capsys.readouterr()
+    assert "Installed collections include: ansible.netcommon, ansible.utils," in captured.out
+    assert "Optional dependencies found" in captured.out
+    assert "'pytest-xdist  # from collection user'" in captured.out
 
     monkeypatch.setattr(
         "sys.argv",