[Git][reproducible-builds/diffoscope][master] 2 commits: Add lzma comparator

Chris Lamb (@lamby) gitlab at salsa.debian.org
Tue May 27 20:57:42 UTC 2025



Chris Lamb pushed to branch master at Reproducible Builds / diffoscope


Commits:
bf04ad9a by Will Hollywood at 2025-05-23T14:57:57+12:00
Add lzma comparator

- - - - -
f94b754a by Will Hollywood at 2025-05-24T09:03:41+12:00
Update headers, base tests off of test_xz.py

- - - - -


6 changed files:

- diffoscope/comparators/__init__.py
- + diffoscope/comparators/lzma.py
- diffoscope/external_tools.py
- + tests/comparators/test_lzma.py
- + tests/data/test1.lzma
- + tests/data/test2.lzma


Changes:

=====================================
diffoscope/comparators/__init__.py
=====================================
@@ -82,6 +82,7 @@ class ComparatorManager:
         ("java.ClassFile",),
         ("lz4.Lz4File",),
         ("lzip.LzipFile",),
+        ("lzma.LzmaFile",),
         ("mono.MonoExeFile",),
         ("pdf.PdfFile",),
         ("png.PngFile",),


=====================================
diffoscope/comparators/lzma.py
=====================================
@@ -0,0 +1,65 @@
+#
+# diffoscope: in-depth comparison of files, archives, and directories
+#
+# Copyright © 2014-2015 Jérémy Bobbio <lunar at debian.org>
+# Copyright © 2015-2020, 2024-2025 Chris Lamb <lamby at debian.org>
+#
+# diffoscope is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# diffoscope is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with diffoscope.  If not, see <https://www.gnu.org/licenses/>.
+
+import re
+import logging
+import subprocess
+
+from diffoscope.tools import tool_required
+
+
+from .utils.file import File
+from .utils.archive import Archive
+
+logger = logging.getLogger(__name__)
+
+
+class LzmaContainer(Archive):
+    def open_archive(self):
+        return self
+
+    def close_archive(self):
+        pass
+
+    def get_member_names(self):
+        return [self.get_compressed_content_name(".lzma")]
+
+    @tool_required("xz")
+    def extract(self, member_name, dest_dir):
+        dest_path = self.get_path_name(dest_dir)
+        logger.debug("lzma extracting to %s", dest_path)
+        with open(dest_path, "wb") as fp:
+            subprocess.check_call(
+                [
+                    "xz",
+                    "--decompress",
+                    "--format=lzma",
+                    "--stdout",
+                    self.source.path,
+                ],
+                stdout=fp,
+                stderr=None,
+            )
+        return dest_path
+
+
+class LzmaFile(File):
+    DESCRIPTION = "LZMA compressed files"
+    CONTAINER_CLASSES = [LzmaContainer]
+    FILE_TYPE_RE = re.compile(r"^LZMA compressed data\b")


=====================================
diffoscope/external_tools.py
=====================================
@@ -132,6 +132,7 @@ EXTERNAL_TOOLS = {
     },
     "lz4": {"debian": "lz4", "FreeBSD": "lz4", "guix": "lz4"},
     "lzip": {"debian": "lzip", "guix": "lzip"},
+    "lzma": {"debian": "xz-utils", "arch": "xz", "guix": "xz"},
     "msgunfmt": {
         "debian": "gettext",
         "arch": "gettext",


=====================================
tests/comparators/test_lzma.py
=====================================
@@ -0,0 +1,75 @@
+#
+# diffoscope: in-depth comparison of files, archives, and directories
+#
+# Copyright © 2015 Jérémy Bobbio <lunar at debian.org>
+# Copyright © 2016-2017, 2020, 2024-2025 Chris Lamb <lamby at debian.org>
+#
+# diffoscope is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# diffoscope is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with diffoscope.  If not, see <https://www.gnu.org/licenses/>.
+
+import shutil
+import pytest
+
+from diffoscope.comparators.lzma import LzmaFile
+from diffoscope.comparators.binary import FilesystemFile
+from diffoscope.comparators.utils.specialize import specialize
+
+from ..utils.data import load_fixture, assert_diff
+from ..utils.tools import skip_unless_tools_exist
+from ..utils.nonexisting import assert_non_existing
+
+lzma1 = load_fixture("test1.lzma")
+lzma2 = load_fixture("test2.lzma")
+
+
+def test_identification(lzma1):
+    assert isinstance(lzma1, LzmaFile)
+
+
+def test_no_differences(lzma1):
+    difference = lzma1.compare(lzma1)
+    assert difference is None
+
+
+ at pytest.fixture
+def differences(lzma1, lzma2):
+    return lzma1.compare(lzma2).details
+
+
+ at skip_unless_tools_exist("xz")
+def test_content_source(differences):
+    assert differences[0].source1 == "test1"
+    assert differences[0].source2 == "test2"
+
+
+ at skip_unless_tools_exist("xz")
+def test_content_source_without_extension(tmpdir, lzma1, lzma2):
+    path1 = str(tmpdir.join("test1"))
+    path2 = str(tmpdir.join("test2"))
+    shutil.copy(lzma1.path, path1)
+    shutil.copy(lzma2.path, path2)
+    lzma1 = specialize(FilesystemFile(path1))
+    lzma2 = specialize(FilesystemFile(path2))
+    difference = lzma1.compare(lzma2).details
+    assert difference[0].source1 == "test1-content"
+    assert difference[0].source2 == "test2-content"
+
+
+ at skip_unless_tools_exist("xz")
+def test_content_diff(differences):
+    assert_diff(differences[0], "text_ascii_expected_diff")
+
+
+ at skip_unless_tools_exist("xz")
+def test_compare_non_existing(monkeypatch, lzma1):
+    assert_non_existing(monkeypatch, lzma1)


=====================================
tests/data/test1.lzma
=====================================
Binary files /dev/null and b/tests/data/test1.lzma differ


=====================================
tests/data/test2.lzma
=====================================
Binary files /dev/null and b/tests/data/test2.lzma differ



View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/-/compare/e551f17bd31b2d6057e2598d76e44279eb85a990...f94b754afdee4a7be6de657fa5717c399f600681

-- 
View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/-/compare/e551f17bd31b2d6057e2598d76e44279eb85a990...f94b754afdee4a7be6de657fa5717c399f600681
You're receiving this email because of your account on salsa.debian.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.reproducible-builds.org/pipermail/rb-commits/attachments/20250527/37662bb2/attachment.htm>


More information about the rb-commits mailing list