updated tests for metadata/illus/typing updates

Author: rgaudin

tests/zim/test_metadata.py

@@ -508,3 +508,102 @@ def test_std_metadata_values():
 
 def test_raw_metadata():
     assert metadata.Metadata(name="Name", value=b"hello")
+
+
+def test_decorators():
+    @metadata.allow_empty
+    class MyMetadata(metadata.XCustomTextMetadata): ...
+
+    assert MyMetadata("Test", "value").libzim_value == b"value"
+
+    @metadata.allow_duplicates
+    class MyMetadata2(metadata.TextListBasedMetadata):
+        join_list_with = "|"
+
+    assert (
+        MyMetadata2(name="Test", value=["value", "hello", "value"]).libzim_value
+        == b"value|hello|value"
+    )
+
+    raw_value = "\t\n\r\n \tA val \t\awith  \bcontrol chars\v\n"
+
+    class MyMetadata3(metadata.TextBasedMetadata):
+        require_text_cleanup = False
+
+    assert MyMetadata3(name="Test", value=raw_value).libzim_value == raw_value.encode(
+        "UTF-8"
+    )
+
+    @metadata.allow_duplicates
+    class MyMetadata4(metadata.TextListBasedMetadata):
+        require_textlist_cleanup = False
+        join_list_with = "|"
+
+    assert MyMetadata4(
+        name="Test", value=(raw_value, raw_value)
+    ).libzim_value == "|".join([raw_value, raw_value]).encode("UTF-8")
+
+
+def test_custom_ones():
+    textval = "value"
+    value = textval.encode("UTF-8")
+    assert metadata.CustomMetadata("Test", value).libzim_value == value
+    assert metadata.XCustomMetadata("Name", value).libzim_value == value
+    assert metadata.XCustomMetadata("Name", value).name == "X-Name"
+    assert metadata.CustomTextMetadata("Test", textval).libzim_value == value
+    assert metadata.XCustomTextMetadata("Name", textval).libzim_value == value
+    assert metadata.XCustomTextMetadata("Name", textval).name == "X-Name"
+    with pytest.raises(ValueError, match="must be X- prefixed"):
+        metadata.CustomMetadata("Name", value)
+    with pytest.raises(ValueError, match="must be X- prefixed"):
+        metadata.CustomTextMetadata("Name", textval)
+
+
+def test_mandatory_zim_metadata_keys():
+    # as per the spec on 2024-12-13
+    assert len(metadata.MANDATORY_ZIM_METADATA_KEYS) >= 8
+    assert "Illustration_48x48@1" in metadata.MANDATORY_ZIM_METADATA_KEYS
+
+
+def test_default_dev_zim_metadata():
+    assert isinstance(metadata.DEFAULT_DEV_ZIM_METADATA, metadata.StandardMetadataList)
+    # as per the spec on 2024-12-13
+    assert len(metadata.DEFAULT_DEV_ZIM_METADATA.values()) == 8
+
+
+def test_get_binary_from(png_image):
+    with open(png_image, "rb") as fh:
+        png_data = fh.read()
+    # bytes input
+    assert metadata.Metadata(value=png_data, name="Test").libzim_value == png_data
+    # io.BytesIO input
+    assert (
+        metadata.Metadata(value=io.BytesIO(png_data), name="Test").libzim_value
+        == png_data
+    )
+    # BaseIO input
+    with open(png_image, "rb") as fh:
+        assert metadata.Metadata(value=fh, name="Test").libzim_value == png_data
+
+    # unseekbale BaseIO
+    def notseekable():
+        return False
+
+    with open(png_image, "rb") as fh:
+        fh.seekable = notseekable
+        assert metadata.Metadata(value=fh, name="Test").libzim_value == png_data
+
+
+def test_ensure_missingname_raises():
+    with pytest.raises(OSError, match="name missing"):
+        metadata.Metadata(b"yello")
+
+
+def test_mimetype_usage():
+    mimetype = "video/webm"
+    assert metadata.Metadata(b"hello", "Test", mimetype=mimetype).mimetype == mimetype
+    assert metadata.Metadata(b"hello", "Test").mimetype == "text/plain;charset=UTF-8"
+    assert (
+        metadata.DEFAULT_DEV_ZIM_METADATA.Illustration_48x48_at_1.mimetype
+        == "image/png"
+    )

tests/zim/test_typing.py

@@ -0,0 +1,40 @@
+from zimscraperlib.typing import Callback
+
+
+class GlobalCounter:
+    count: int = 0
+
+
+def update_counter() -> int:
+    GlobalCounter.count += 1
+    return GlobalCounter.count
+
+
+def update_counter_args(bump: int) -> int:
+    GlobalCounter.count += bump
+    return GlobalCounter.count
+
+
+def update_counter_kwargs(*, bump: int) -> int:
+    GlobalCounter.count += bump
+    return GlobalCounter.count
+
+
+def update_counter_args_and_kwargs(bump: int, *, factor: int) -> int:
+    GlobalCounter.count += bump * factor
+    return GlobalCounter.count
+
+
+def test_callback_init():
+    assert Callback(update_counter)
+    assert Callback(update_counter).callable
+    GlobalCounter.count = 0
+    assert GlobalCounter.count == 0
+    Callback(update_counter_args, args=(1,)).call()
+    assert GlobalCounter.count == 1
+    Callback(update_counter_args, kwargs={"bump": 1}).call()
+    assert GlobalCounter.count == 2
+    Callback(update_counter_kwargs, kwargs={"bump": 1}).call()
+    assert GlobalCounter.count == 3
+    Callback(update_counter_args_and_kwargs, args=(1,), kwargs={"factor": 2}).call()
+    assert GlobalCounter.count == 5

tests/zim/test_zim_creator.py

@@ -181,6 +181,14 @@ def test_add_item_for(tmp_path):
             creator.add_item_for(path="welcome", title="hello")
 
 
+def test_additem_bad_content(tmp_path):
+    with Creator(tmp_path / "test.zim", "welcome").config_dev_metadata() as creator:
+        with pytest.raises(RuntimeError, match="Unexpected type for content"):
+            si = StaticItem(path="welcome", content="hello")
+            si.content = 1  # pyright: ignore[reportAttributeAccessIssue]
+            creator.add_item(si)
+
+
 def test_add_item_for_delete(tmp_path, html_file):
     fpath = tmp_path / "test.zim"
     local_path = pathlib.Path(tmp_path / "somefile.html")
@@ -480,6 +488,51 @@ def cb():
     assert Store.called is True
 
 
+def test_item_callbacks(tmp_path):
+    fpath = tmp_path / "test.zim"
+
+    class Store:
+        called = 0
+
+    def cb():
+        Store.called += 1
+
+    with Creator(fpath, "").config_dev_metadata() as creator:
+        creator.add_item_for(
+            path="hello",
+            content="hello",
+            callbacks=[Callback(func=cb), Callback(func=cb)],
+        )
+
+    assert Store.called == 2
+
+    class UnCallableCallback(Callback):
+        @property
+        def callable(self) -> bool:
+            return False
+
+    with Creator(fpath, "").config_dev_metadata() as creator:
+        # +2
+        creator.add_item(
+            StaticItem(path="hello", content="hello"),
+            callbacks=[Callback(func=cb), Callback(func=cb)],
+        )
+        # + 0
+        creator.add_item(StaticItem(path="hello2", content="hello"))
+        # +1
+        creator.add_item(
+            StaticItem(path="hello3", content="hello"),
+            callbacks=Callback(func=cb),
+        )
+        # + 0
+        creator.add_item(
+            StaticItem(path="hello4", content="hello"),
+            callbacks=UnCallableCallback(func=cb),
+        )
+
+    assert Store.called == 5
+
+
 def test_compess_hints(tmp_path, html_file):
     with Creator(tmp_path / "test.zim", "").config_dev_metadata() as creator:
         creator.add_item_for(