Merge branch 'main' into chore/file_.pre-commit-config.yaml_240603-22…

…5641

.config/dictionary.txt

@@ -10,9 +10,11 @@ cpart
 cpath
 crepository
 csource
+delenv
 excinfo
 fileh
 fqcn
+jsonschema
 levelname
 levelno
 netcommon
@@ -23,5 +25,6 @@ setenv
 specp
 treemaker
 uninstallation
+usefixtures
 vuuid
 xmltodict

src/ansible_dev_environment/__main__.py

@@ -4,7 +4,7 @@
 via :command:`python -m ansible_dev_environment`.
 """
 
-from .cli import main
+from ansible_dev_environment.cli import main
 
 
 if __name__ == "__main__":

src/ansible_dev_environment/arg_parser.py

@@ -200,20 +200,25 @@ def parse() -> argparse.Namespace:
         help="Uninstall a collection.",
     )
 
-    for grp in parser._action_groups:  # noqa: SLF001
-        if grp.title is None:
-            continue
-        grp.title = grp.title.capitalize()
+    _group_titles(parser)
     for subparser in subparsers.choices.values():
-        for grp in subparser._action_groups:  # noqa: SLF001
-            if grp.title is None:
-                continue
-            grp.title = grp.title.capitalize()
-    # pylint: enable=protected-access
+        _group_titles(subparser)
 
     return parser.parse_args()
 
 
+def _group_titles(parser: ArgumentParser) -> None:
+    """Set the group titles to be capitalized.
+
+    Args:
+        parser: The parser to set the group titles for
+    """
+    for group in parser._action_groups:  # noqa: SLF001
+        if group.title is None:
+            continue
+        group.title = group.title.capitalize()
+
+
 class ArgumentParser(argparse.ArgumentParser):
     """A custom argument parser."""
 

src/ansible_dev_environment/cli.py

@@ -170,7 +170,3 @@ def main() -> None:
     cli.args_sanity()
     cli.ensure_isolated()
     cli.run()
-
-
-if __name__ == "__main__":
-    main()

src/ansible_dev_environment/subcommands/treemaker.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 from ansible_dev_environment.tree import Tree
 from ansible_dev_environment.utils import builder_introspect, collect_manifests
@@ -44,10 +44,7 @@ def run(self: TreeMaker) -> None:  # noqa: C901, PLR0912, PLR0915
             target=self._config.site_pkg_collections_path,
             venv_cache_dir=self._config.venv_cache_dir,
         )
-        tree_dict: JSONVal = {c: {} for c in collections}
-        if not isinstance(tree_dict, dict):
-            msg = "Tree dict is not a dict."
-            raise TypeError(msg)
+        tree_dict: dict[str, dict[str, JSONVal]] = {c: {} for c in collections}
 
         links: dict[str, str] = {}
         for collection_name, collection in collections.items():
@@ -65,10 +62,6 @@ def run(self: TreeMaker) -> None:  # noqa: C901, PLR0912, PLR0915
                     self._output.error(err)
                     continue
                 target = tree_dict[collection_name]
-                if not isinstance(target, dict):
-                    msg = "Tree dict is not a dict."
-                    raise TypeError(msg)
-
                 target[dep] = tree_dict[dep]
 
             docs = collection["collection_info"].get("documentation")
@@ -97,7 +90,8 @@ def run(self: TreeMaker) -> None:  # noqa: C901, PLR0912, PLR0915
 
         more_verbose = 2
         if self._config.args.verbose >= more_verbose:
-            tree = Tree(obj=tree_dict, term_features=self._config.term_features)
+            j_tree_dict = cast(JSONVal, tree_dict)
+            tree = Tree(obj=j_tree_dict, term_features=self._config.term_features)
             tree.links = links
             tree.green.extend(green)
             rendered = tree.render()
@@ -132,7 +126,7 @@ def run(self: TreeMaker) -> None:  # noqa: C901, PLR0912, PLR0915
 
 
 def add_python_reqs(
-    tree_dict: dict[str, JSONVal],
+    tree_dict: dict[str, dict[str, JSONVal]],
     collection_name: str,
     python_deps: list[str],
 ) -> None:

tests/integration/test_basic.py

@@ -137,16 +137,13 @@ def test_non_local(
     assert string in captured.out
     monkeypatch.setattr(
         "sys.argv",
-        ["ade", "tree", f"--venv={tmp_path / 'venv'}"],
+        ["ade", "tree", f"--venv={tmp_path / 'venv'}", "-v"],
     )
     with pytest.raises(SystemExit):
         main()
     captured = capsys.readouterr()
-    with pytest.raises(SystemExit):
-        main()
-    captured = capsys.readouterr()
-    string = "ansible.scm\n└──ansible.utils\n\n"
-    assert string == captured.out
+    assert "ansible.scm\n├──ansible.utils" in captured.out
+    assert "├──jsonschema" in captured.out
 
 
 def test_requirements(

tests/test_argparser.py

@@ -0,0 +1,92 @@
+"""Tests for the arg_parser module."""
+
+import pytest
+
+from ansible_dev_environment.arg_parser import (
+    ArgumentParser,
+    CustomHelpFormatter,
+    _group_titles,
+)
+
+
+def test_no_option_string(
+    capsys: pytest.CaptureFixture[str],
+) -> None:
+    """Test an argument without an option string.
+
+    Args:
+        capsys: Pytest fixture.
+    """
+    parser = ArgumentParser(
+        formatter_class=CustomHelpFormatter,
+    )
+    parser.add_argument(
+        dest="test",
+        action="store_true",
+        help="Test this",
+    )
+    parser.print_help()
+    captured = capsys.readouterr()
+    assert "Test this" in captured.out
+
+
+def test_one_string(
+    capsys: pytest.CaptureFixture[str],
+) -> None:
+    """Test an argument without an option string.
+
+    Args:
+        capsys: Pytest fixture.
+    """
+    parser = ArgumentParser(
+        formatter_class=CustomHelpFormatter,
+    )
+    parser.add_argument(
+        "-t",
+        dest="test",
+        action="store_true",
+        help="Test this",
+    )
+    parser.print_help()
+    captured = capsys.readouterr()
+    assert "-t             Test this" in captured.out
+
+
+def test_too_many_string(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    """Test an argument with too many option strings.
+
+    Args:
+        monkeypatch: Pytest fixture.
+    """
+    monkeypatch.setattr("sys.argv", ["prog", "--help"])
+
+    parser = ArgumentParser(
+        formatter_class=CustomHelpFormatter,
+    )
+    parser.add_argument(
+        "-t",
+        "-test",
+        "--test",
+        action="store_true",
+        help="Test this",
+    )
+    with pytest.raises(ValueError, match="Too many option strings"):
+        parser.parse_args()
+
+
+def test_group_no_title(capsys: pytest.CaptureFixture[str]) -> None:
+    """Test a group without a title.
+
+    Args:
+        capsys: Pytest fixture.
+    """
+    parser = ArgumentParser(
+        formatter_class=CustomHelpFormatter,
+    )
+    parser.add_argument_group()
+    _group_titles(parser)
+    parser.print_help()
+    captured = capsys.readouterr()
+    assert "--help" in captured.out

tests/unit/conftest.py

@@ -31,3 +31,25 @@ def output(tmp_path: Path) -> Output:
         term_features=TermFeatures(color=False, links=False),
         verbosity=0,
     )
+
+
+@pytest.fixture(name="_wide_console")
+def _wide_console(monkeypatch: pytest.MonkeyPatch) -> None:
+    """Fixture to set the terminal width to 1000 to prevent wrapping.
+
+    Args:
+        monkeypatch: Pytest fixture.
+    """
+
+    def _console_width() -> int:
+        """Return a large console width.
+
+        Returns:
+            int: Console width.
+        """
+        return 1000
+
+    monkeypatch.setattr(
+        "ansible_dev_environment.output.console_width",
+        _console_width,
+    )