Fix not a repo

Author: cidrblock

.vscode/settings.json

@@ -8,7 +8,7 @@
     "editor.codeActionsOnSave": {
       "source.fixAll": "explicit"
     },
-    "editor.defaultFormatter": "ms-python.black-formatter"
+    "editor.defaultFormatter": "charliermarsh.ruff"
   },
   "mypy.runUsingActiveInterpreter": true,
   "mypy.targets": ["src", "tests"],

pyproject.toml

@@ -266,10 +266,11 @@ lines-after-imports = 2 # Ensures consistency for cases when there's variable vs
 lines-between-types = 1 # Separate import/from with 1 line
 
 [tool.ruff.per-file-ignores]
+# SLF001: Allow private member access in tests
 # S101 Allow assert in tests
 # S602 Allow shell in test
 # T201 Allow print in tests
-"tests/**" = ["S101", "S602", "T201"]
+"tests/**" = ["SLF001", "S101", "S602", "T201"]
 
 [tool.ruff.pydocstyle]
 convention = "pep257"

src/ansible_dev_environment/subcommands/installer.py

@@ -215,15 +215,16 @@ def _install_galaxy_requirements(self: Installer) -> None:
             msg = f"Source installed collections include: {oxford_join(installed)}"
         self._output.note(msg)
 
-    def _copy_files_using_git_ls_files(
+    def _find_files_using_git_ls_files(
         self: Installer,
         local_repo_path: Path | None,
-    ) -> str | None:
+    ) -> tuple[str | None, str | None]:
         """Copy collection files tracked using git ls-files to the build directory.
 
         Args:
             local_repo_path: The collection local path.
         Returns:
+            string with the command used to list files or None
             string containing a list of files or nothing
         """
         msg = "List collection files using git ls-files."
@@ -240,19 +241,21 @@ def _copy_files_using_git_ls_files(
             )
         except subprocess.CalledProcessError as exc:
             err = f"Failed to list collection using git ls-files: {exc} {exc.stderr}"
-            self._output.critical(err)
+            self._output.info(err)
+            return None, None
 
-        return tracked_files_output.stdout
+        return "git ls-files", tracked_files_output.stdout
 
-    def _copy_files_using_ls(
+    def _find_files_using_ls(
         self: Installer,
         local_repo_path: Path | None,
-    ) -> str | None:
+    ) -> tuple[str | None, str | None]:
         """Copy collection files tracked using ls to the build directory.
 
         Args:
             local_repo_path: The collection local path.
         Returns:
+            string with the command used to list files or None
             string containing a list of files or nothing
         """
         msg = "List collection files using ls."
@@ -269,9 +272,10 @@ def _copy_files_using_ls(
             )
         except subprocess.CalledProcessError as exc:
             err = f"Failed to list collection using ls: {exc} {exc.stderr}"
-            self._output.critical(err)
+            self._output.debug(err)
+            return None, None
 
-        return tracked_files_output.stdout
+        return "ls", tracked_files_output.stdout
 
     def _copy_repo_files(
         self: Installer,
@@ -287,35 +291,34 @@ def _copy_repo_files(
         """
         if local_repo_path is None:
             msg = "Invalid repo path, no files to copy"
-            self._output.info(msg)
+            self._output.debug(msg)
             return
 
         # Get tracked files from git ls-files command
-        tracked_files_output = self._copy_files_using_git_ls_files(
+        found_using, files_stdout = self._find_files_using_git_ls_files(
             local_repo_path=local_repo_path,
         )
 
-        if tracked_files_output is None:
-            msg = "No tracked files found using git ls-files"
-            self._output.info(msg)
-
-            # If no tracked files found, get files using ls command
-            tracked_files_output = self._copy_files_using_ls(
+        if not files_stdout:
+            found_using, files_stdout = self._find_files_using_ls(
                 local_repo_path=local_repo_path,
             )
 
-        if tracked_files_output is None:
-            msg = "No files found"
-            self._output.info(msg)
+        if not files_stdout:
+            msg = "No files found with either 'git ls-files' or 'ls"
+            self._output.critical(msg)
             return
 
+        msg = f"File list generated with '{found_using}'"
+        self._output.info(msg)
+
         # Parse tracked files output
-        tracked_files = tracked_files_output.split("\n")
+        files_list = files_stdout.split("\n")
 
         # Create the destination folder if it doesn't exist
         Path(destination_path).mkdir(parents=True, exist_ok=True)
 
-        for file in tracked_files:
+        for file in files_list:
             src_file_path = Path(local_repo_path) / file
             dest_file_path = Path(destination_path) / file
 

tests/unit/conftest.py

@@ -0,0 +1,29 @@
+"""Fixtures for unit tests."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import pytest
+
+from ansible_dev_environment.output import Output
+from ansible_dev_environment.utils import TermFeatures
+
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+@pytest.fixture()
+def output(tmp_path: Path) -> Output:
+    """Create an Output class object as fixture.
+
+    :param tmp_path: App configuration object.
+    """
+    return Output(
+        log_file=str(tmp_path) + "ansible-creator.log",
+        log_level="notset",
+        log_append="false",
+        term_features=TermFeatures(color=False, links=False),
+        verbosity=0,
+    )

tests/unit/test_installer.py

@@ -0,0 +1,151 @@
+"""Tests for the installer."""
+
+import subprocess
+
+from argparse import Namespace
+from pathlib import Path
+
+import pytest
+
+from ansible_dev_environment.config import Config
+from ansible_dev_environment.output import Output
+from ansible_dev_environment.subcommands.installer import Installer
+
+
+NAMESPACE = Namespace()
+NAMESPACE.verbose = 0
+
+
+def test_git_no_files(tmp_path: Path, output: Output) -> None:
+    """Test no files using git.
+
+    Args:
+        tmp_dir: Temp directory
+        output: Output instance
+    """
+    config = Config(args=NAMESPACE, output=output, term_features=output.term_features)
+    installer = Installer(output=output, config=config)
+    found_using, files = installer._find_files_using_git_ls_files(local_repo_path=tmp_path)
+    assert not found_using
+    assert files is None
+
+
+def test_git_none_tracked(tmp_path: Path, output: Output) -> None:
+    """Test non tracked using git.
+
+    Args:
+        tmp_dir: Temp directory
+        output: Output instance
+    """
+    config = Config(args=NAMESPACE, output=output, term_features=output.term_features)
+    installer = Installer(output=output, config=config)
+    subprocess.run(args=["git", "init"], cwd=tmp_path, check=False)
+    found_using, files = installer._find_files_using_git_ls_files(local_repo_path=tmp_path)
+    assert found_using == "git ls-files"
+    assert files == ""
+
+
+def test_git_one_tracked(tmp_path: Path, output: Output) -> None:
+    """Test one tracked using git.
+
+    Args:
+        tmp_dir: Temp directory
+        output: Output instance
+    """
+    config = Config(args=NAMESPACE, output=output, term_features=output.term_features)
+    installer = Installer(output=output, config=config)
+    subprocess.run(args=["git", "init"], cwd=tmp_path, check=False)
+    (tmp_path / "file.txt").touch()
+    subprocess.run(args=["git", "add", "--all"], cwd=tmp_path, check=False)
+    found_using, files = installer._find_files_using_git_ls_files(local_repo_path=tmp_path)
+    assert found_using == "git ls-files"
+    assert files == "file.txt\n"
+
+
+def test_ls_no_files(tmp_path: Path, output: Output) -> None:
+    """Test no files using ls.
+
+    Args:
+        tmp_dir: Temp directory
+        output: Output instance
+    """
+    config = Config(args=NAMESPACE, output=output, term_features=output.term_features)
+    installer = Installer(output=output, config=config)
+    found_using, files = installer._find_files_using_ls(local_repo_path=tmp_path)
+    assert found_using == "ls"
+    assert files == ""
+
+
+def test_ls_one_found(tmp_path: Path, output: Output) -> None:
+    """Test one found using ls.
+
+    Args:
+        tmp_dir: Temp directory
+        output: Output instance
+    """
+    config = Config(args=NAMESPACE, output=output, term_features=output.term_features)
+    installer = Installer(output=output, config=config)
+    (tmp_path / "file.txt").touch()
+    found_using, files = installer._find_files_using_ls(local_repo_path=tmp_path)
+    assert found_using == "ls"
+    assert files == "file.txt\n"
+
+
+def test_copy_no_files(tmp_path: Path, output: Output) -> None:
+    """Test file copy no files.
+
+    Args:
+        tmp_dir: Temp directory
+        output: Output instance
+    """
+    source = tmp_path / "source"
+    source.mkdir()
+    dest = tmp_path / "build"
+    dest.mkdir()
+    config = Config(args=NAMESPACE, output=output, term_features=output.term_features)
+    installer = Installer(output=output, config=config)
+    with pytest.raises(SystemExit) as excinfo:
+        installer._copy_repo_files(local_repo_path=source, destination_path=dest)
+    assert excinfo.value.code == 1
+
+
+def test_copy_using_git(tmp_path: Path, output: Output) -> None:
+    """Test file copy using git.
+
+    Args:
+        tmp_dir: Temp directory
+        output: Output instance
+    """
+    source = tmp_path / "source"
+    source.mkdir()
+    dest = tmp_path / "build"
+    dest.mkdir()
+    config = Config(args=NAMESPACE, output=output, term_features=output.term_features)
+    installer = Installer(output=output, config=config)
+    subprocess.run(args=["git", "init"], cwd=source, check=False)
+    (source / "file_tracked.txt").touch()
+    (source / "file_untracked.txt").touch()
+    subprocess.run(args=["git", "add", "file_tracked.txt"], cwd=source, check=False)
+    installer._copy_repo_files(local_repo_path=source, destination_path=dest)
+    moved = dest.glob("**/*")
+    assert [m.name for m in list(moved)] == ["file_tracked.txt"]
+
+
+def test_copy_using_ls(tmp_path: Path, output: Output) -> None:
+    """Test file copy using ls.
+
+    Args:
+        tmp_dir: Temp directory
+        output: Output instance
+    """
+    source = tmp_path / "source"
+    source.mkdir()
+    dest = tmp_path / "build"
+    dest.mkdir()
+    config = Config(args=NAMESPACE, output=output, term_features=output.term_features)
+    installer = Installer(output=output, config=config)
+    (source / "file1.txt").touch()
+    (source / "file2.txt").touch()
+    installer._copy_repo_files(local_repo_path=source, destination_path=dest)
+    moved = dest.glob("**/*")
+    assert [m.name for m in list(moved)] == ["file1.txt", "file2.txt"]