feat: include details about created/updated snapshots in detailed report (#942)

(cherry picked from commit 9736efc)

Author: noahnu

README.md

@@ -134,7 +134,7 @@ These are the cli options exposed to `pytest` by the plugin.
 | Option                         | Description                                                                                                                    | Default                                                                                                      |
 | ------------------------------ |--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
 | `--snapshot-update`            | Snapshots will be updated to match assertions and unused snapshots will be deleted.                                            | `False`                                                                                                      |
-| `--snapshot-details`           | Includes details of unused snapshots (test name and snapshot location) in the final report.                                    | `False`                                                                                                      |
+| `--snapshot-details`           | Includes details of unused, generated, and updated snapshots (test name and snapshot location) in the final report.                                    | `False`                                                                                                      |
 | `--snapshot-warn-unused`       | Prints a warning on unused snapshots rather than fail the test suite.                                                          | `False`                                                                                                      |
 | `--snapshot-default-extension` | Use to change the default snapshot extension class.                                                                            | [AmberSnapshotExtension](https://github.com/syrupy-project/syrupy/blob/main/src/syrupy/extensions/amber/__init__.py) |
 | `--snapshot-no-colors`         | Disable test results output highlighting. Equivalent to setting the environment variables `ANSI_COLORS_DISABLED` or `NO_COLOR` | Disabled by default if not in terminal.                                                                      |

src/syrupy/report.py

@@ -17,6 +17,7 @@
     DefaultDict,
     Dict,
     FrozenSet,
+    Generator,
     Iterator,
     List,
     Set,
@@ -347,17 +348,9 @@ def lines(self) -> Iterator[str]:
             yield ""
             if self.update_snapshots or self.include_snapshot_details:
                 base_message = "Deleted" if self.update_snapshots else "Unused"
-                for snapshot_collection in self.unused:
-                    filepath = snapshot_collection.location
-                    snapshots = (snapshot.name for snapshot in snapshot_collection)
-
-                    try:
-                        path_to_file = str(Path(filepath).relative_to(self.base_dir))
-                    except ValueError:
-                        # this is just used for display, so better to fallback to
-                        # something vaguely reasonable (the full path) than give up
-                        path_to_file = filepath
-
+                for snapshots, path_to_file in self.__iterate_snapshot_collection(
+                    self.unused
+                ):
                     unused_snapshots = ", ".join(map(bold, sorted(snapshots)))
                     yield (
                         warning_style(gettext(base_message))
@@ -372,6 +365,44 @@ def lines(self) -> Iterator[str]:
                 else:
                     yield error_style(message)
 
+        if self.num_created and self.update_snapshots and self.include_snapshot_details:
+            yield ""
+            for snapshots, path_to_file in self.__iterate_snapshot_collection(
+                self.created
+            ):
+                created_snapshots = ", ".join(map(bold, sorted(snapshots)))
+                yield (
+                    warning_style(gettext("Generated"))
+                    + f" {created_snapshots} ({path_to_file})"
+                )
+
+        if self.num_updated and self.update_snapshots and self.include_snapshot_details:
+            yield ""
+            for snapshots, path_to_file in self.__iterate_snapshot_collection(
+                self.updated
+            ):
+                updated_snapshots = ", ".join(map(bold, sorted(snapshots)))
+                yield (
+                    warning_style(gettext("Updated"))
+                    + f" {updated_snapshots} ({path_to_file})"
+                )
+
+    def __iterate_snapshot_collection(
+        self, collection: "SnapshotCollections"
+    ) -> Generator[tuple[Generator[str, None, None], str], Any, None]:
+        for snapshot_collection in collection:
+            filepath = snapshot_collection.location
+            snapshots = (snapshot.name for snapshot in snapshot_collection)
+
+            try:
+                path_to_file = str(Path(filepath).relative_to(self.base_dir))
+            except ValueError:
+                # this is just used for display, so better to fallback to
+                # something vaguely reasonable (the full path) than give up
+                path_to_file = filepath
+
+            yield (snapshots, path_to_file)
+
     def _diff_snapshot_collections(
         self,
         snapshot_collections1: "SnapshotCollections",

tests/integration/test_snapshot_option_include_details.py

@@ -146,3 +146,44 @@ def test_unused_snapshots_details_no_details_on_deletion(
         )
     )
     assert result.ret == 0
+
+
+def test_created_and_updates_details(testdir, plugin_args_fails_xdist):
+    # Generate initial snapshots.
+    testdir.makepyfile(
+        test_generated="""
+            def test_generated_1(snapshot):
+                assert snapshot == "1"
+
+            def test_generated_2(snapshot):
+                assert snapshot == "2"
+            """
+    )
+    result = testdir.runpytest("-v", "--snapshot-update")
+    result.stdout.re_match_lines((r"2 snapshots generated\.",))
+
+    # Update one of the snapshots and generate a new one
+    testdir.makepyfile(
+        test_generated="""
+            def test_generated_1(snapshot):
+                assert snapshot == "1"
+
+            def test_generated_2(snapshot):
+                assert snapshot == "2-update"
+
+            def test_generated_3(snapshot):
+                assert snapshot == "3"
+            """
+    )
+
+    result = testdir.runpytest(
+        "-v", "--snapshot-details", "--snapshot-update", *plugin_args_fails_xdist
+    )
+    result.stdout.re_match_lines(
+        (
+            r"1 snapshot passed\. 1 snapshot generated\. 1 snapshot updated\.",
+            r"Generated test_generated_3 \(__snapshots__[\\/]test_generated.ambr\)",
+            r"Updated test_generated_2 \(__snapshots__[\\/]test_generated.ambr\)",
+        )
+    )
+    assert result.ret == 0