From b93d1ff2701217054f0172fdd9641b476baa1b2a Mon Sep 17 00:00:00 2001
From: Rikko <rikkolovescats@tutanota.com>
Date: Fri, 6 Oct 2023 20:48:34 +0530
Subject: [PATCH] Improve error messages on common test failures

---
 test/test_checks.py | 41 +++++++++++++++++++++++++++++++++--------
 1 file changed, 33 insertions(+), 8 deletions(-)

diff --git a/test/test_checks.py b/test/test_checks.py
index 734a76fb..69a6a4ee 100644
--- a/test/test_checks.py
+++ b/test/test_checks.py
@@ -50,7 +50,12 @@ def test_versions(self):
             api_version = self.api_version_regexp.search(content).group()
             plugin_manager_version = self.plugin_manager_version_regexp.search(content).group()
 
-            self.assertEqual(md5sum, version_metadata["md5sum"])
+            if md5sum != version_metadata["md5sum"]:
+                self.fail(
+                    "Plugin manager MD5 checksum changed;\n"
+                    f"{version_metadata['md5sum']} (mentioned in index.json) ->\n"
+                    f"{md5sum} (actual)"
+                )
             self.assertEqual(int(api_version.decode("utf-8")), version_metadata["api_version"])
             self.assertEqual(plugin_manager_version.decode("utf-8"), f'"{version_name}"')
 
@@ -65,7 +70,12 @@ def test_latest_version(self):
         api_version = self.api_version_regexp.search(content).group()
         plugin_manager_version = self.plugin_manager_version_regexp.search(content).group()
 
-        self.assertEqual(md5sum, latest_version_metadata["md5sum"])
+        if md5sum != latest_version_metadata["md5sum"]:
+            self.fail(
+                "Plugin manager MD5 checksum changed;\n"
+                f"{latest_version_metadata['md5sum']} (mentioned in index.json) ->\n"
+                f"{md5sum} (actual)"
+            )
         self.assertEqual(int(api_version.decode("utf-8")), latest_version_metadata["api_version"])
         self.assertEqual(plugin_manager_version.decode("utf-8"), f'"{latest_version_name}"')
 
@@ -137,14 +147,20 @@ def test_versions(self):
             for plugin_name, plugin_metadata in self.content["plugins"].items():
                 for version_name, version_metadata in plugin_metadata["versions"].items():
                     commit = self.repository.commit(version_metadata["commit_sha"])
-                    plugin = commit.tree / self.category / f"{plugin_name}.py"
-                    with io.BytesIO(plugin.data_stream.read()) as fin:
+                    plugin = os.path.join(self.category, f"{plugin_name}.py")
+                    plugin_commit_sha = commit.tree / plugin
+                    with io.BytesIO(plugin_commit_sha.data_stream.read()) as fin:
                         content = fin.read()
 
                     md5sum = hashlib.md5(content).hexdigest()
                     api_version = self.api_version_regexp.search(content).group()
 
-                    self.assertEqual(md5sum, version_metadata["md5sum"])
+                    if md5sum != version_metadata["md5sum"]:
+                        self.fail(
+                            f"{plugin} checksum changed;\n"
+                            f"{version_metadata['md5sum']} (mentioned in {self.category_metadata_file}) ->\n"
+                            f"{md5sum} (actual)"
+                        )
                     self.assertEqual(int(api_version.decode("utf-8")),
                                      version_metadata["api_version"])
 
@@ -159,6 +175,12 @@ def test_latest_version(self):
                 md5sum = hashlib.md5(content).hexdigest()
                 api_version = self.api_version_regexp.search(content).group()
 
+                if md5sum != latest_version_metadata["md5sum"]:
+                    self.fail(
+                        f"{plugin} checksum changed;\n"
+                        f"{latest_version_metadata['md5sum']} (mentioned in {self.category_metadata_file}) ->\n"
+                        f"{md5sum} (actual)"
+                    )
                 self.assertEqual(md5sum, latest_version_metadata["md5sum"])
                 self.assertEqual(int(api_version.decode("utf-8")),
                                  latest_version_metadata["api_version"])
@@ -169,7 +191,8 @@ def setUp(self):
         super().setUp()
         self.name = "Utilities"
         self.category = os.path.join("plugins", "utilities")
-        with open(f"{self.category}.json", "rb") as fin:
+        self.category_metadata_file = f"{self.category}.json"
+        with open(self.category_metadata_file, "rb") as fin:
             self.content = json.load(fin)
 
 
@@ -178,7 +201,8 @@ def setUp(self):
         super().setUp()
         self.name = "Maps"
         self.category = os.path.join("plugins", "maps")
-        with open(f"{self.category}.json", "rb") as fin:
+        self.category_metadata_file = f"{self.category}.json"
+        with open(self.category_metadata_file, "rb") as fin:
             self.content = json.load(fin)
 
 
@@ -187,5 +211,6 @@ def setUp(self):
         super().setUp()
         self.name = "Minigames"
         self.category = os.path.join("plugins", "minigames")
-        with open(f"{self.category}.json", "rb") as fin:
+        self.category_metadata_file = f"{self.category}.json"
+        with open(self.category_metadata_file, "rb") as fin:
             self.content = json.load(fin)