use syrupy for snapshotting

Author: Friendly-Banana

pyproject.toml

@@ -19,6 +19,7 @@ dev = [
     "pre-commit~=4.1",
     "pytest~=8.3",
     "ruff>=0.11.4",
+    "syrupy~=4.0",
     "types-requests~=2.32",
 ]
 

src/test/test_menu_parser.py

@@ -5,7 +5,9 @@
 from datetime import date
 from typing import Dict
 
+import pytest
 from lxml import html  # nosec: https://github.com/TUM-Dev/eat-api/issues/19
+from syrupy.extensions.json import JSONSnapshotExtension
 
 from src import main
 from src.entities import Canteen, Menu, Week
@@ -19,6 +21,11 @@
 from src.utils import file_util, json_util
 
 
+@pytest.fixture
+def snapshot_json(snapshot):
+    return snapshot.with_defaults(extension_class=JSONSnapshotExtension)
+
+
 def test_get_date():
     assert MenuParser.get_date(2017, 44, 1) == date(2017, 10, 30)
     assert MenuParser.get_date(2018, 1, 1) == date(2018, 1, 1)
@@ -66,24 +73,20 @@ def test_get_all_dates(self) -> None:
             dates.append(self.studentenwerk_menu_parser.extract_date_from_html(html_menu))
         assert dates == working_days
 
-    def test_studentenwerk(self) -> None:
+    def test_studentenwerk(self, snapshot_json):
         canteens = [Canteen.MENSA_ARCISSTR, Canteen.STUBISTRO_BUTENANDSTR, Canteen.MENSA_GARCHING]
         for canteen in canteens:
-            self.__test_studentenwerk_canteen(canteen)
+            self.__test_studentenwerk_canteen(canteen, snapshot_json)
 
-    def __test_studentenwerk_canteen(self, canteen: Canteen) -> None:
+    def __test_studentenwerk_canteen(self, canteen, snapshot_json):
         menus = self.__get_menus(canteen)
         weeks = Week.to_weeks(menus)
 
         # create temp dir for testing
         with tempfile.TemporaryDirectory() as temp_dir:
             # store output in the tempdir
             main.jsonify(weeks, temp_dir, canteen, True)
-            generated = file_util.load_ordered_json(os.path.join(temp_dir, "combined", "combined.json"))
-            reference = file_util.load_ordered_json(
-                f"{self.base_path_canteen.format(canteen=canteen.canteen_id)}/reference/combined.json",
-            )
-            assert generated == reference
+            assert file_util.load_ordered_json(os.path.join(temp_dir, "combined", "combined.json")) == snapshot_json
 
     def __get_menus(self, canteen: Canteen) -> Dict[date, Menu]:
         menus = {}
@@ -109,23 +112,19 @@ def test_should_return_weeks_when_converting_menu_to_week_objects(self):
             week_length = len(week.days)
             assert week_length == 5
 
-    def test_should_convert_week_to_json(self):
+    def test_should_convert_week_to_json(self, snapshot_json):
         calendar_weeks = [31, 32]
         menus = self.__get_menus(Canteen.MENSA_GARCHING)
         weeks = Week.to_weeks(menus)
         for calendar_week in calendar_weeks:
-            reference_week = file_util.load_ordered_json(
-                f"{self.base_path_canteen.format(canteen=Canteen.MENSA_GARCHING.canteen_id)}"
-                f"/reference/week_{calendar_week}.json",
-            )
             generated_week = json_util.order_json_objects(weeks[calendar_week].to_json_obj())
-            assert generated_week == reference_week
+            assert generated_week == snapshot_json
 
 
 class TestFMIBistroParser:
     bistro_parser = FMIBistroMenuParser()
 
-    def test_fmi_bistro(self):
+    def test_fmi_bistro(self, snapshot_json):
         for_generation_path = "src/test/assets/fmi/for-generation/calendar_week_2023_{calendar_week}.txt"
         menus = {}
         for calendar_week in range(21, 23):
@@ -138,15 +137,13 @@ def test_fmi_bistro(self):
             # store output in the tempdir
             main.jsonify(weeks, temp_dir, Canteen.FMI_BISTRO, True)
             generated = file_util.load_ordered_json(os.path.join(temp_dir, "combined", "combined.json"))
-            reference = file_util.load_ordered_json("src/test/assets/fmi/reference/combined.json")
-
-            assert generated == reference
+            assert generated == snapshot_json
 
 
 class TestMedizinerMensaParser:
     mediziner_mensa_parser = MedizinerMensaMenuParser()
 
-    def test_mediziner_mensa(self):
+    def test_mediziner_mensa(self, snapshot_json):
         # parse the menu
         for calendar_week in [44, 47]:
             for_generation = file_util.load_txt(
@@ -168,36 +165,13 @@ def test_mediziner_mensa(self):
                 main.jsonify(weeks, temp_dir, Canteen.MEDIZINER_MENSA, True)
                 # open the generated file
                 generated = file_util.load_ordered_json(os.path.join(temp_dir, "combined", "combined.json"))
-                reference = file_util.load_ordered_json(
-                    f"src/test/assets/mediziner-mensa/reference/week_2018_{calendar_week}.json",
-                )
-                assert generated == reference
-
-    # """
-    # just for generating reference json files
-    def test_gen_file(self):
-        # parse the menu
-        for_generation = file_util.load_txt(
-            "src/test/assets/mediziner-mensa/for-generation/week_2018_44.txt",
-        )
-        menus = self.mediziner_mensa_parser.get_menus(
-            for_generation,
-            2018,
-            47,
-        )
-        assert menus is not None
-        if not menus:
-            return
-        weeks = Week.to_weeks(menus)
-        main.jsonify(weeks, "/tmp/eat-api_test_output", Canteen.MEDIZINER_MENSA, True)  # noqa: S108
-
-    # """
+                assert generated == snapshot_json
 
 
 class TestStraubingMensaMenuParser:
     straubing_mensa_parser = StraubingMensaMenuParser()
 
-    def test_straubing_mensa(self):
+    def test_straubing_mensa(self, snapshot_json):
         for calendar_week in [16, 17]:
             with open(f"src/test/assets/straubing/for-generation/{calendar_week}.csv", encoding="cp1252") as f:
                 for_generation = f.read()
@@ -213,7 +187,4 @@ def test_straubing_mensa(self):
                 main.jsonify(weeks, temp_dir, Canteen.MENSA_STRAUBING, True)
                 # open the generated file
                 generated = file_util.load_ordered_json(os.path.join(temp_dir, "2022", f"{calendar_week}.json"))
-                reference = file_util.load_ordered_json(
-                    f"src/test/assets/straubing/reference/{calendar_week}.json",
-                )
-                assert generated == reference
+                assert generated == snapshot_json

src/test/test_translate.py

@@ -1,17 +1,24 @@
 import pathlib
 import tempfile
 
+import pytest
+from syrupy.extensions.json import JSONSnapshotExtension
+
 from src.entities import Canteen
 from src.translate import Translator, translate_file
 from src.utils.file_util import load_ordered_json
 
 
+@pytest.fixture
+def snapshot_json(snapshot):
+    return snapshot.with_defaults(extension_class=JSONSnapshotExtension)
+
+
 class TestTranslate:
     base_path = pathlib.Path("src/test/assets/studentenwerk") / Canteen.MENSA_GARCHING.canteen_id
 
-    def test_week(self):
+    def test_week(self, snapshot_json):
         input_file = self.base_path / "reference/week_31.json"
-        expected_file = self.base_path / "en/week_31.json"
 
         translator = Translator("DUMMY", self.base_path / "en/translations.json")
         translator.load_cache()
@@ -20,12 +27,10 @@ def test_week(self):
             translate_file(input_file, output, translator)
             translated = load_ordered_json(output)
 
-        expected = load_ordered_json(expected_file)
-        assert translated == expected
+        assert translated == snapshot_json
 
-    def test_combined(self):
+    def test_combined(self, snapshot_json):
         input_file = self.base_path / "reference/combined.json"
-        expected_file = self.base_path / "en/combined.json"
 
         translator = Translator("DUMMY", self.base_path / "en/translations.json")
         translator.load_cache()
@@ -34,5 +39,4 @@ def test_combined(self):
             translate_file(input_file, output, translator)
             translated = load_ordered_json(output)
 
-        expected = load_ordered_json(expected_file)
-        assert translated == expected
+        assert translated == snapshot_json