test: add edge cases for unicode and forbidden filesystem characters

Author: dwong2708

openedx_learning/apps/authoring/backup_restore/zipper.py

@@ -38,11 +38,11 @@ def slugify_hashed_filename(identifier: str) -> str:
         - Append a short hash for uniqueness.
         - Result: human-readable but still unique and filesystem-safe filename.
     """
-    slug = slugify(identifier)
+    slug = slugify(identifier, allow_unicode=True)
     # Short digest ensures uniqueness without overly long filenames
     short_hash = hashlib.blake2b(
         identifier.encode("utf-8"),
-        digest_size=3
+        digest_size=3,
     ).hexdigest()
     return f"{slug}_{short_hash}"
 

tests/openedx_learning/apps/authoring/backup_restore/test_slug_hash.py

@@ -22,16 +22,55 @@ def test_slugify_hashed_filename_special_chars(self):
         # Test the slugify_hashed_filename function with special characters
         self.assertEqual(slugify_hashed_filename("my@ex#ample!"), "myexample_3366b5")
 
+    def test_slugify_hashed_filename_invalid_characters_common_filesystems(self):
+        # Test the slugify_hashed_filename function with invalid characters for common filesystems
+        self.assertEqual(
+            slugify_hashed_filename("xblock.v1:problem:my_component"), "xblockv1problemmy_component_d346b1"
+        )
+        self.assertEqual(
+            slugify_hashed_filename("xblock.v1/problem/my_component"), "xblockv1problemmy_component_2648c6"
+        )
+        self.assertEqual(
+            slugify_hashed_filename("xblock.v1?problem?my_component"), "xblockv1problemmy_component_12a86d"
+        )
+        self.assertEqual(
+            slugify_hashed_filename("xblock.v1\\problem_[my_component]"), "xblockv1problem_my_component_a59bb3"
+        )
+        self.assertEqual(
+            slugify_hashed_filename("xblock.v1>problem_>my_component"), "xblockv1problem_my_component_8497eb"
+        )
+        self.assertEqual(
+            slugify_hashed_filename("xblock.v1*problem*EndsWith|"), "xblockv1problemendswith_b88aab"
+        )
+        self.assertEqual(
+            slugify_hashed_filename("xblock.v1*problem*EndsWith."), "xblockv1problemendswith_7fa0cf"
+        )
+
+    def test_slugify_hashed_filename_unicode(self):
+        # Test the slugify_hashed_filename function with unicode characters
+
+        # Example with accents
+        self.assertEqual(slugify_hashed_filename("café"), "café_07f4df")
+        self.assertEqual(slugify_hashed_filename("naïve"), "naïve_308c7e")
+
+        # Example with non-latin (e.g., Japanese)
+        identifier = "テスト用"
+        result = slugify_hashed_filename(identifier)
+        self.assertEqual(result, "テスト用_be48ab")
+
+        # Example with mixed characters
+        identifier = "café_テスト用"
+        result = slugify_hashed_filename(identifier)
+        self.assertEqual(result, "café_テスト用_3cf9ef")
+
     def test_slugify_hashed_filename_long_string(self):
         # Test the slugify_hashed_filename function with a long string
         long_string = "a" * 100
         self.assertEqual(slugify_hashed_filename(long_string), f"{long_string}_4e84b3")
 
     def test_slugify_hashed_filename_case_insensitivity(self):
         # Test the slugify_hashed_filename function for case insensitivity
-        self.assertEqual(slugify_hashed_filename("My_Example"), "my_example_4f859c")
-        self.assertEqual(slugify_hashed_filename("MY_EXAMPLE"), "my_example_49be65")
-        self.assertEqual(slugify_hashed_filename("my_example"), "my_example_880989")
-        self.assertEqual(slugify_hashed_filename("mY_eXamPle"), "my_example_d28c02")
-        self.assertEqual(slugify_hashed_filename("My_ExAmPlE"), "my_example_79232e")
-        self.assertEqual(slugify_hashed_filename("mY_EXAMPLE"), "my_example_b91dc0")
+        upper_case_value = slugify_hashed_filename("MY_EXAMPLE")
+        lower_case_value = slugify_hashed_filename("my_example")
+        # The values should be different even though they are the same but with different cases
+        self.assertNotEqual(upper_case_value, lower_case_value)