approval-utilities 14.3.0__tar.gz → 14.4.0__tar.gz

{approval_utilities-14.3.0/approval_utilities.egg-info → approval_utilities-14.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: approval_utilities
-Version: 14.3.0
+Version: 14.4.0
 Summary: Utilities for your production code that work well with approvaltests
 Home-page: https://github.com/approvals/ApprovalTests.Python
 Author: ApprovalTests Contributors
@@ -21,3 +21,10 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary

{approval_utilities-14.3.0 → approval_utilities-14.4.0}/README.md

@@ -307,7 +307,7 @@ mock >= 5.1.0         # For verify_logging
 
 ### Weekly Ensemble
 
-The best way to contribute is to [join our weekly mob/ensemble](./docs/Contribute.md)
+The best way to contribute is to [join our weekly mob/ensemble](./docs/Contribute.md).
 
 ### Pull Requests
 

{approval_utilities-14.3.0 → approval_utilities-14.4.0}/approval_utilities/utils.py

@@ -3,6 +3,7 @@ import json
 import os
 
 from copy import deepcopy
+from pathlib import Path
 
 from typing import Callable, Dict, TypeVar
 
@@ -92,3 +93,8 @@ _K = TypeVar("_K")
 
 def filter_values(filter: Callable[[_V], bool], a_dict: Dict[_K, _V]) -> Dict[_K, _V]:
     return {k: v for k, v in a_dict.items() if filter(v)}
+
+
+def append_to_file(file: Path, text: str):
+    with file.open(mode="a") as f:
+        f.write(text)

{approval_utilities-14.3.0 → approval_utilities-14.4.0/approval_utilities.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: approval_utilities
-Version: 14.3.0
+Version: 14.4.0
 Summary: Utilities for your production code that work well with approvaltests
 Home-page: https://github.com/approvals/ApprovalTests.Python
 Author: ApprovalTests Contributors
@@ -21,3 +21,10 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary

{approval_utilities-14.3.0 → approval_utilities-14.4.0}/approval_utilities.egg-info/SOURCES.txt

@@ -42,6 +42,7 @@ approval_utilities/utilities/logger/simple_logger.py
 approval_utilities/utilities/persistence/__init__.py
 approval_utilities/utilities/persistence/loader.py
 approval_utilities/utilities/persistence/saver.py
+tests/test_approvaltests_temp_dir.py
 tests/test_asserts.py
 tests/test_build.py
 tests/test_combinations.py

approval_utilities-14.4.0/tests/test_approvaltests_temp_dir.py

@@ -0,0 +1,8 @@
+from approvaltests.internals.logs.log_commons import APPROVAL_TESTS_TEMP_DIRECTORY
+
+
+def test_temp_directory_is_setup_automatically():
+    # setup happens automatically
+    gitignore_path = APPROVAL_TESTS_TEMP_DIRECTORY / ".gitignore"
+    contents = gitignore_path.read_text()
+    assert contents == "*"

{approval_utilities-14.3.0 → approval_utilities-14.4.0}/tests/test_fileapprover.py

@@ -6,9 +6,11 @@ from approvaltests.file_approver import FileApprover
 from approvaltests.reporters.generic_diff_reporter_factory import (
     GenericDiffReporterFactory,
 )
+from approvaltests.reporters.report_quietly import ReportQuietly
 from approvaltests.reporters.testing_reporter import ReporterForTesting
 from approvaltests.string_writer import StringWriter
-from approvaltests.approved_file_log import ApprovedFilesLog
+from approvaltests.internals.logs.approved_file_log import ApprovedFilesLog
+from approvaltests.internals.logs.failed_comparison_log import FailedComparisonLog
 
 
 class FileApproverTests(unittest.TestCase):
@@ -55,11 +57,12 @@ class FileApproverTests(unittest.TestCase):
 
     def test_approved_file_is_logged(self):
         name = approvals.get_default_namer().get_approved_filename()
-        log = ApprovedFilesLog.get_approved_files_log()
-        log_lines = log.read_text().split("\n")
         name1 = name.replace(".txt", ".txt1")
         name2 = name.replace(".txt", ".txt2")
 
+        log = ApprovedFilesLog.get_approved_files_log()
+        log_lines = log.read_text().split("\n")
+
         # check log is cleared
         self.assertNotIn(name1, log_lines)
         self.assertNotIn(name2, log_lines)
@@ -72,3 +75,40 @@ class FileApproverTests(unittest.TestCase):
         log_lines = log.read_text().split("\n")
         self.assertIn(name1, log_lines)
         self.assertIn(name2, log_lines)
+
+    def test_failed_comparison_is_logged(self):
+        approved_name = approvals.get_default_namer().get_approved_filename()
+        received_name = approvals.get_default_namer().get_received_filename()
+        expected_line = f"{received_name} -> {approved_name}"
+
+        name1 = expected_line.replace(".txt", ".txt1")
+        name2 = expected_line.replace(".txt", ".txt2")
+
+        log = FailedComparisonLog.get_failed_comparison_log()
+
+        log_lines = log.read_text().split("\n")
+
+        # check log is cleared
+        self.assertNotIn(name1, log_lines)
+        self.assertNotIn(name2, log_lines)
+
+        # fail a verify and log it
+        self.run_a_failing_test(".txt1")
+        self.run_a_failing_test(".txt2")
+
+        # assert that the approved file is logged
+        log_lines = log.read_text().split("\n")
+        self.assertIn(name1, log_lines)
+        self.assertIn(name2, log_lines)
+
+    def run_a_failing_test(self, extension):
+        try:
+            verify(
+                "a",
+                options=Options()
+                .for_file.with_extension(extension)
+                .with_reporter(ReportQuietly()),
+            )
+            self.fail("expected to fail")
+        except:
+            pass

approval_utilities-14.4.0/version.py

@@ -0,0 +1 @@
+version_number = "v14.4.0"

approval_utilities-14.3.0/version.py

@@ -1 +0,0 @@
-version_number = "v14.3.0"