Add success messages (#30)

Introduces a new logging level

Author: George-Ogden

README.md

@@ -145,7 +145,7 @@ If you use, `pre-commit`, consider adding this repo as a hook to check for updat
 
 ```yaml
 - repo: https://github.com/George-Ogden/mirror-rorrim/
-  rev: v0.4.6
+  rev: v0.4.7
   hooks:
     - id: mirror-check
 ```

mirror/installer.py

@@ -27,6 +27,7 @@ class MirrorInstaller(MirrorManager):
 
     def install(self) -> None:
         self._run(self._install, keep_lock_on_failure=False)
+        logger.success("Install complete!")
 
     def _install(self) -> None:
         self.checkout_all()

mirror/logger.py

@@ -90,12 +90,14 @@ def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
 
 def log_level_name(quiet: int, verbose: int) -> str | int:
     match verbose - quiet:
-        case -3:
+        case -4:
             return "CRITICAL"
-        case -2:
+        case -3:
             return "ERROR"
-        case -1:
+        case -2:
             return "WARNING"
+        case -1:
+            return "SUCCESS"
         case 0:
             return "INFO"
         case 1:

mirror/logger_test.py

@@ -181,21 +181,23 @@ def log(x: int) -> int:
         # -vvvv
         (0, 4, 0),
         # -q
-        (1, 0, "warning"),
+        (1, 0, "success"),
         # -qq
-        (2, 0, "error"),
+        (2, 0, "warning"),
         # -qqq
-        (3, 0, "critical"),
+        (3, 0, "error"),
         # -qqqq
-        (4, 0, 50),
+        (4, 0, "critical"),
         # -qqqqq
         (5, 0, 50),
+        # -qqqqqq
+        (6, 0, 50),
         # mixed equally
         (1, 1, "info"),
         # mixed verbose
         (1, 2, "debug"),
         # mixed quiet
-        (3, 1, "error"),
+        (4, 1, "error"),
     ],
 )
 def test_log_level_name(quiet: int, verbose: int, level: str | int) -> None:

mirror/main.py

@@ -50,7 +50,7 @@ def main(*args: P.args, **kwargs: P.kwargs) -> None:
     "-q",
     "--quiet",
     count=True,
-    help="Display less output (repeat up to 3 times).",
+    help="Display less output (repeat up to 4 times).",
     show_default=False,
 )
 @check_for_errors

mirror/main_test.py

@@ -35,7 +35,7 @@ def remove_git_data(local: GitDir) -> None:
             # abs path to config
             "install --config .mirror.yaml",
             0,
-            snapshot(""),
+            snapshot("Install complete!"),
             "installer_tests/empty_repo_with_config",
         ),
         (
@@ -69,7 +69,7 @@ def remove_git_data(local: GitDir) -> None:
             # abs path + remote (valid)
             "install --config-repo https://github.com/George-Ogden/mirror-rorrim-test-data/ --config-file /config-only.yaml",
             0,
-            snapshot(""),
+            snapshot("Install complete!"),
             None,
         ),
         (
@@ -103,22 +103,24 @@ def remove_git_data(local: GitDir) -> None:
             # overwrite local mirror file
             "install -C https://github.com/George-Ogden/mirror-rorrim-test-data --config-file config-only.yaml",
             0,
-            snapshot("'.mirror.yaml' has been overwritten during installation."),
+            snapshot(
+                "'.mirror.yaml' has been overwritten during installation.    Install complete!"
+            ),
             "installer_tests/remote_config_overwrite",
         ),
         (
             # overwrite local mirror file with itself
             "install",
             0,
-            snapshot(""),
+            snapshot("Install complete!"),
             "installer_tests/remote_config_overwrite",
         ),
         # check tests
         (
             # works fine
             "check",
             0,
-            snapshot(""),
+            snapshot("All up to date!"),
             "checker_tests/up_to_date",
         ),
         (
@@ -142,7 +144,7 @@ def remove_git_data(local: GitDir) -> None:
             # works fine
             "sync",
             0,
-            snapshot(""),
+            snapshot("All synced!"),
             "syncer_tests/behind",
         ),
         (
@@ -177,7 +179,7 @@ def remove_git_data(local: GitDir) -> None:
             "sync",
             0,
             snapshot(
-                "'.mirror.yaml' modified while syncing. Please merge any conflicts then rerun to sync any added files."
+                "'.mirror.yaml' modified while syncing. Please merge any conflicts then rerun to sync any added files.    All synced!"
             ),
             "syncer_tests/update_mirror",
         ),

mirror/mirror.py

@@ -36,7 +36,7 @@ def check(self) -> ExitCode:
         self.checkout_all()
         up_to_date = self.all_up_to_date()
         if up_to_date:
-            logger.info("All up to date!")
+            logger.success("All up to date!")
         return int(not up_to_date)
 
     def all_up_to_date(self) -> bool:

mirror/syncer.py

@@ -1,12 +1,15 @@
 from dataclasses import dataclass
 
+from loguru import logger
+
 from .manager import ExistingMirrorManager
 
 
 @dataclass(frozen=True)
 class MirrorSyncer(ExistingMirrorManager):
     def sync(self) -> None:
         self._run(self._sync, keep_lock_on_failure=True)
+        logger.success("All synced!")
 
     def _sync(self) -> None:
         self.checkout_all()

version.txt

@@ -1 +1 @@
-0.4.6
+0.4.7