Improvements to logging and tests

Author: RobertoRoos

src/tctools/patch_plc/patch_plc_class.py

@@ -1,3 +1,4 @@
+import logging
 from argparse import RawDescriptionHelpFormatter
 from collections.abc import Iterable
 from dataclasses import dataclass, field
@@ -200,6 +201,8 @@ def operation_merge(
             self.logger.info("No new source files or folders, stopping")
             return 0
 
+        self.log_sources(new_sources, True)
+
         if self.args.check:
             self.logger.info("Some file or folders would be added")
             return 1  # Something left to do, so exit with error (= check has failed)
@@ -229,6 +232,8 @@ def operation_remove(
             self.logger.info("No files or folders to un-register, stopping")
             return 0
 
+        self.log_sources(to_remove, False)
+
         if self.args.check:
             self.logger.info("Some file or folders would be un-registered")
             return 1  # Something left to do, so exit with error (= check has failed)
@@ -278,6 +283,9 @@ def operation_reset(self, current_sources: FileItems, new_sources: FileItemsGrou
             self.logger.info("No files or folders to change, stopping")
             return 0
 
+        self.log_sources(to_add, True)
+        self.log_sources(to_remove, False)
+
         if self.args.check:
             self.logger.info("Some file or folders would be (un-)registered")
             return 1  # Something left to do, so exit with error (= check has failed)
@@ -432,6 +440,20 @@ def remove_helper(ref_elements, ref_set):
         remove_helper(self._element_folders, to_remove.folders)
         remove_helper(self._element_files, to_remove.files)
 
+    def log_sources(self, source: FileItems, add: bool):
+        """Log a set of sources in its entirety.
+
+        Logged a INFO level when `dry` or `check` (otherwise the output is kind of
+        meaningless), otherwise at DEBUG.
+        """
+        level = logging.INFO if self.args.check or self.args.dry else logging.DEBUG
+
+        action = "New" if add else "Remove"
+        for item in source.files:
+            self.logger.log(level, f"{action} file: {item}")
+        for item in source.folders:
+            self.logger.log(level, f"{action} folder: {item}")
+
     @staticmethod
     def path_to_str(path: PurePath) -> str:
         """Turn any path into a windows-path string.

tests/test_patch_plc.py

@@ -2,8 +2,8 @@
 import shutil
 import subprocess
 import sys
+from collections.abc import Generator
 from pathlib import Path, PureWindowsPath
-from typing import Any, Generator
 
 import pytest
 
@@ -23,12 +23,12 @@ def to_paths(*paths: str) -> list[Path]:
 
 
 @pytest.fixture()
-def plc_dir(plc_code) -> Generator[Any, Any, None]:
+def plc_dir(plc_code) -> Generator[Path, None, None]:
     yield plc_code / "TwinCAT Project1" / "MyPlc"
 
 
 @pytest.fixture()
-def project(plc_dir) -> Generator[Any, Any, None]:
+def project(plc_dir) -> Generator[Path, None, None]:
     yield plc_dir / "MyPlc.plcproj"
 
 
@@ -180,7 +180,7 @@ def test_remove_recursive(plc_dir, project, recursive):
     lines_after = content_after.count("\n")
 
     if not recursive:
-        assert content_after == content_before   # No changes
+        assert content_after == content_before  # No changes
         return
 
     for item in tracked_files + tracked_folders: