secureli-435: add repo_files test

secureli/modules/pii_scanner/pii_scanner.py

@@ -52,7 +52,7 @@ def scan_repo(
         :param scan_mode: Whether to scan the staged files (i.e., the files about to be
         committed) or the entire repository
         :param files: A specified list of files to scan
-        :return: A ScanResult object containing whether we succeeded and any error
+        :return: A ScanResult object with details of whether the scan succeeded and, if not, details of the failures
         """
 
         file_paths = self._get_files_list(

tests/repositories/test_repo_files_repository.py

@@ -3,10 +3,18 @@
 
 import pytest
 from pytest_mock import MockerFixture
+from subprocess import CompletedProcess
 
 from secureli.repositories.repo_files import RepoFilesRepository
 
 
+@pytest.fixture()
+def mock_subprocess(mocker: MockerFixture) -> MagicMock:
+    mock_subprocess = MagicMock()
+    mocker.patch("secureli.repositories.repo_files.subprocess", mock_subprocess)
+    return mock_subprocess
+
+
 @pytest.fixture()
 def git_not_exists_folder_path() -> MagicMock:
     git_folder_path = MagicMock()
@@ -145,6 +153,22 @@ def test_that_list_repo_files_raises_value_error_without_git_repo(
         repo_files_repository.list_repo_files(git_not_exists_folder_path)
 
 
+def test_that_list_staged_files_returns_list_of_staged_files(
+    repo_files_repository: RepoFilesRepository,
+    mock_subprocess: MagicMock,
+):
+    fake_file_1 = "i/am/staged"
+    fake_file_2 = "also/staged"
+    mock_subprocess.run.return_value = CompletedProcess(
+        args=[],
+        returncode=0,
+        stdout=f"{fake_file_1}\n{fake_file_2}\n".encode("utf8"),
+    )
+
+    result = repo_files_repository.list_staged_files(Path("."))
+    assert result == [fake_file_1, fake_file_2]
+
+
 def test_that_list_repo_files_raises_value_error_if_dot_git_is_a_file_somehow(
     repo_files_repository: RepoFilesRepository,
     git_a_file_for_some_reason_folder_path: MagicMock,