- F wip capture_previous inline approvals

Co-Authored-By: jmasonlee <262853+jmasonlee@users.noreply.github.com>
Co-Authored-By: Gregor Riegler <rieglerg85@gmail.com>
Co-Authored-By: blade290 <43077216+blade290@users.noreply.github.com>
Co-Authored-By: Nitsan Avni <nitsanav@gmail.com>
Co-Authored-By: bhargavgundu <7643639+bhargavgundu@users.noreply.github.com>

Author: 6 people

approvaltests/inline/inline_options.py

@@ -49,3 +49,18 @@ def apply(self, options: "Options") -> "Options":
                 return options
 
         return ShowCodeInlineOptions() if do_show_code else DoNotShowCodeInlineOptions()
+
+    @staticmethod
+    def previous_capture():
+        from approvaltests.namer.inline_python_reporter import InlinePythonReporter
+        from approvaltests.reporters import ReporterThatAutomaticallyApproves
+
+        class SemiAutomaticInlineOptions(InlineOptions):
+            def apply(self, options: "Options") -> "Options":
+                return options.with_reporter(
+                    InlinePythonReporter(
+                        ReporterThatAutomaticallyApproves(), add_approval_line=False, previous_result=True
+                    )
+                )
+
+        return SemiAutomaticInlineOptions()

approvaltests/namer/inline_python_reporter.py

@@ -5,16 +5,22 @@
 from approvaltests import Reporter, StackFrameNamer
 from approvaltests.inline.split_code import SplitCode
 
+DELETE_ME_TO_APPROVE_ = "\n***** DELETE ME TO APPROVE *****"
+
 
 class InlinePythonReporter(Reporter):
-    def __init__(self, reporter, add_approval_line=False):
+    def __init__(self, reporter, add_approval_line=False, previous_result=None):
         self.diffReporter = reporter
         self.semi_automatic_extra_line = (
-            "\n***** DELETE ME TO APPROVE *****" if add_approval_line else ""
+            DELETE_ME_TO_APPROVE_ if add_approval_line else ""
         )
+        self.previous_result = previous_result
 
     def report(self, received_path: str, approved_path: str) -> bool:
         test_source_file = self.get_test_source_file()
+        if self.previous_result:
+            previous_result_stuff = lambda: "\n" + "vvvvv PREVIOUS RESULT vvvvv" + "\n" + "41"
+            self.semi_automatic_extra_line = DELETE_ME_TO_APPROVE_ + previous_result_stuff()
         received_path = self.create_received_file(received_path, test_source_file)
         return self.diffReporter.report(received_path, test_source_file)
 
@@ -24,6 +30,7 @@ def get_test_source_file(self):
 
     def create_received_file(self, received_path: str, test_source_file: str):
         code = Path(test_source_file).read_text()
+
         received_text = (
             Path(received_path).read_text()[:-1] + self.semi_automatic_extra_line
         )

tests/test_inline_approvals.py

@@ -188,3 +188,30 @@ def test_inline_with_additional_reporter():
         "hello\nworld",
         options=(Options().inline().add_reporter(ReportWithBeyondCompare())),
     )
+    
+def test_inline_with_preserved_approved_text():
+    """
+    42
+    ***** DELETE ME TO APPROVE *****
+    vvvvv PREVIOUS RESULT vvvvv
+    41
+    """
+    this_is_the_docstring_we_want = remove_indentation_from("""
+    42
+    ***** DELETE ME TO APPROVE *****
+    vvvvv PREVIOUS RESULT vvvvv
+    41
+    """)
+    
+    
+    # 1. Run a failing inline approval with a new configuration
+    # 2. Capture whatever we've overwriting the docstring with
+    # 3. Capture the last docstring so we can write it to previous result 
+    # 4. Check that the overwriting string is equal to the docstring we want
+    options = Options().inline(InlineOptions.previous_capture())
+    try:
+        verify("42", options=options)
+    except ApprovalException:
+        pass
+    # assert that the docstring is equal to the string we want
+    assert get_approved_via_doc_string() == this_is_the_docstring_we_want