fix: Ensuring users know when a duplicate repository is trying to be added (#81)

This PR further enhances #65 by ensuring the user gets feedback on if
duplicate repositories are installed. Additionally, it performs more
test clean up.

---------

Signed-off-by: Steven Elliott <[email protected]>
Co-authored-by: Mitch Negus <[email protected]>

Author: sdelliot

src/firewheel/cli/helpers/repository/install

@@ -93,8 +93,11 @@ def install_repo(repo):
         repo (dict): A dictionary object which can be added as a new FIREWHEEL repository.
     """
     repo_db = RepositoryDb()
-    repo_db.add_repository(repo)
-    Console().print("[green]Repository successfully installed!")
+    ret = repo_db.add_repository(repo)
+    if ret:
+        Console().print("[green]Repository successfully installed!")
+    else:
+        Console().print("[yellow]Duplicate repositories cannot be installed!")
 
 
 def run_install_script(repo, insecure):

src/firewheel/control/repository_db.py

@@ -78,6 +78,9 @@ def add_repository(self, repository):
 
         Args:
             repository (dict): A repository dictionary to add. See format for the database.
+
+        Returns:
+            int: Number of entries added, 0 for duplicate repository or 1 for a single repository.
         """
         self._validate_repository(repository)
 
@@ -95,13 +98,14 @@ def add_repository(self, repository):
 
         if any(entry["path"] == repository["path"] for entry in entries):
             self.log.debug("Ignoring duplicate repository: %s", repository)
-            return
+            return 0
 
         entries.append(repository)
         with self.db_file.open("w") as db:
             json.dump(entries, db)
 
         self.log.debug("Added repository: %s", repository)
+        return 1
 
     def delete_repository(self, repository):
         """

src/firewheel/tests/unit/control/test_repository_db.py

@@ -41,6 +41,9 @@ def repository_db():
         db_filename="test_repositories.json",
     )
     yield repository_db
+    # Ensure all repositories are removed during teardown
+    for repo in repository_db.list_repositories():
+        repository_db.delete_repository(repo)
 
 
 @pytest.fixture
@@ -92,7 +95,7 @@ def test_corrupt_repository_add(self, repository_db_test_path, repo_entry):
         assert location.exists() is False
 
     def test_add_repository(self, repository_db, repo_entry):
-        repository_db.add_repository(repo_entry)
+        assert repository_db.add_repository(repo_entry) == 1
         repo_list = list(repository_db.list_repositories())
         assert self._entry_in_repo_list(repo_entry, repo_list)
 
@@ -120,8 +123,8 @@ def test_add_repository_invalid(
 
     def test_duplicate_repository(self, repository_db, repo_entry):
         orig_entry_count = len(list(repository_db.list_repositories()))
-        repository_db.add_repository(repo_entry)
-        repository_db.add_repository(repo_entry)
+        assert repository_db.add_repository(repo_entry) == 1
+        assert repository_db.add_repository(repo_entry) == 0
         repo_list = list(repository_db.list_repositories())
         assert self._entry_in_repo_list(repo_entry, repo_list)
         # The entry should only be added once