diffoscope 280__tar.gz → 282__tar.gz

{diffoscope-280 → diffoscope-282}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diffoscope
-Version: 280
+Version: 282
 Summary: in-depth comparison of files, archives, and directories
 Home-page: https://diffoscope.org/
 Author: Diffoscope developers

{diffoscope-280 → diffoscope-282}/diffoscope/__init__.py

@@ -17,4 +17,4 @@
 # You should have received a copy of the GNU General Public License
 # along with diffoscope.  If not, see <https://www.gnu.org/licenses/>.
 
-VERSION = "280"
+VERSION = "282"

{diffoscope-280 → diffoscope-282}/diffoscope/comparators/__init__.py

@@ -108,6 +108,7 @@ class ComparatorManager:
         ("openssh.PublicKeyFile",),
         ("gif.GifFile",),
         ("pcap.PcapFile",),
+        ("uki.UKIFile",),
         ("pe32.Pe32PlusFile",),
         ("pgp.PgpFile",),
         ("pgp.PgpSignature",),

{diffoscope-280 → diffoscope-282}/diffoscope/comparators/ar.py

@@ -3,7 +3,7 @@
 #
 # Copyright © 2014-2015 Jérémy Bobbio <lunar@debian.org>
 # Copyright © 2016 Ximin Luo <infinity0@pwned.gg>
-# Copyright © 2016-2020 Chris Lamb <lamby@debian.org>
+# Copyright © 2016-2020, 2024 Chris Lamb <lamby@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
@@ -69,8 +69,8 @@ class ArFile(File):
                 ArSymbolTableDumper, self.path, other.path
             ),
             Difference.from_text_readers(
-                list_libarchive(self.path),
-                list_libarchive(other.path),
+                list_libarchive(self.path, ignore_errors=True),
+                list_libarchive(other.path, ignore_errors=True),
                 self.path,
                 other.path,
                 source="file list",

diffoscope-282/diffoscope/comparators/uki.py

@@ -0,0 +1,58 @@
+#
+# diffoscope: in-depth comparison of files, archives, and directories
+#
+# Copyright © 2024 Jelle van der Waa <jelle@archlinux.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 subprocess
+import re
+import logging
+
+from diffoscope.tools import tool_required
+from diffoscope.difference import Difference
+
+from .utils.file import File
+from .utils.command import Command, our_check_output
+
+logger = logging.getLogger(__name__)
+
+
+class UKIDump(Command):
+    @tool_required("ukify")
+    def cmdline(self):
+        return ["ukify", "inspect", self.path]
+
+
+class UKIFile(File):
+    DESCRIPTION = "UKI image (.efi)"
+    FILE_EXTENSION_SUFFIX = {".efi"}
+    FILE_TYPE_RE = re.compile(r"^PE32\+")
+
+    @classmethod
+    def recognizes(cls, file):
+        if not super().recognizes(file):
+            return False
+
+        try:
+            our_check_output(
+                ["objdump", "-h", "--section", ".linux", file.path],
+            )
+            return True
+        except subprocess.SubprocessError:
+            return False
+
+    def compare_details(self, other, source=None):
+        return [Difference.from_operation(UKIDump, self.path, other.path)]

{diffoscope-280 → diffoscope-282}/diffoscope/comparators/utils/libarchive.py

@@ -2,7 +2,7 @@
 # diffoscope: in-depth comparison of files, archives, and directories
 #
 # Copyright © 2015 Jérémy Bobbio <lunar@debian.org>
-# Copyright © 2016-2023 Chris Lamb <lamby@debian.org>
+# Copyright © 2016-2024 Chris Lamb <lamby@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
@@ -122,6 +122,14 @@ libarchive.ArchiveEntry.pathname = property(
 
 
 def list_libarchive(path, ignore_errors=False):
+    """
+    NB. Despite this method's contents being wrapped entirely in a try/except,
+    the use of yield operator means that the setting `ignore_errors` to `True`
+    will emit valid entries until there is an error, rather than a) masking all
+    entries if there is any error or b) skipping *over* errors to the next
+    entry.
+    """
+
     def force_str(val):
         # libarchive ~5 began to return uname and gname as UTF-8 whilst
         # previous versions returned bytes that required decoding.

{diffoscope-280 → diffoscope-282}/diffoscope/external_tools.py

@@ -224,6 +224,10 @@ EXTERNAL_TOOLS = {
     "tar": {"debian": "tar", "arch": "tar", "guix": "tar"},
     "tcpdump": {"debian": "tcpdump", "arch": "tcpdump", "guix": "tcpdump"},
     "ttx": {"debian": "fonttools", "guix": "python-fonttools"},
+    "ukify": {
+        "debian": "systemd-ukify",
+        "arch": "systemd-ukify",
+    },
     "unsquashfs": {
         "debian": "squashfs-tools",
         "arch": "squashfs-tools",

{diffoscope-280 → diffoscope-282}/diffoscope.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diffoscope
-Version: 280
+Version: 282
 Summary: in-depth comparison of files, archives, and directories
 Home-page: https://diffoscope.org/
 Author: Diffoscope developers

{diffoscope-280 → diffoscope-282}/diffoscope.egg-info/SOURCES.txt

@@ -1,43 +1,10 @@
-.coveragerc
-.dockerignore
 CONTRIBUTING.md
 COPYING
-Dockerfile
 MANIFEST.in
 README.rst
 extras_require.json
 pyproject.toml
-pytest.ini
 setup.py
-bin/diffoscope
-debian/README.source
-debian/changelog
-debian/check-dep-sizes.sh
-debian/clean
-debian/control
-debian/copyright
-debian/diffoscope-minimal.docs
-debian/diffoscope-minimal.install
-debian/diffoscope-minimal.lintian-overrides
-debian/diffoscope-minimal.manpages
-debian/diffoscope.docs
-debian/gbp.conf
-debian/py3dist-overrides
-debian/rules
-debian/watch
-debian/source/format
-debian/source/lintian-overrides
-debian/source/options
-debian/tests/basic-command-line
-debian/tests/control
-debian/tests/control.in
-debian/tests/control.sh
-debian/tests/generate-recommends.py
-debian/tests/pytest
-debian/tests/pytest-with-recommends
-debian/upstream/metadata
-debian/upstream/signing-key.asc
-debian/zsh-completion/_diffoscope
 diffoscope/__init__.py
 diffoscope/changes.py
 diffoscope/config.py
@@ -136,6 +103,7 @@ diffoscope/comparators/symlink.py
 diffoscope/comparators/tar.py
 diffoscope/comparators/text.py
 diffoscope/comparators/uimage.py
+diffoscope/comparators/uki.py
 diffoscope/comparators/vmlinuz.py
 diffoscope/comparators/wasm.py
 diffoscope/comparators/xar.py
@@ -170,9 +138,6 @@ diffoscope/readers/__init__.py
 diffoscope/readers/json.py
 diffoscope/readers/utils.py
 diffoscope/scripts/extract-vmlinux
-doc/Makefile
-doc/diffoscope.h2m.0
-doc/logo.svg
 tests/__init__.py
 tests/conftest.py
 tests/test_diff_mask.py
@@ -259,6 +224,7 @@ tests/comparators/test_symlink.py
 tests/comparators/test_tar.py
 tests/comparators/test_text.py
 tests/comparators/test_uimage.py
+tests/comparators/test_uki.py
 tests/comparators/test_utils.py
 tests/comparators/test_wasm.py
 tests/comparators/test_xml.py
@@ -319,6 +285,7 @@ tests/data/dot_changes_different_contents_and_identical_files_expected_diff
 tests/data/dot_changes_fallback_expected_diff
 tests/data/dot_changes_identical_contents_and_different_files_expected_diff
 tests/data/dot_dsc_fallback_expected_diff
+tests/data/dummyx64.efi.stub
 tests/data/elf_lib_metadata_expected_diff
 tests/data/elf_lib_objdump_expected_diff
 tests/data/elf_obj_expected_diff
@@ -653,6 +620,7 @@ tests/data/ttf_expected_diff
 tests/data/ttf_ttx_expected_diff
 tests/data/uimage_expected_diff
 tests/data/uimage_expected_diff_pre_5_41
+tests/data/uki_expected_diff
 tests/data/wasm_expected_diff
 tests/data/xsb_expected_diff
 tests/data/zip2_zipdetails_expected_diff

diffoscope-282/tests/comparators/test_uki.py

@@ -0,0 +1,81 @@
+#
+# diffoscope: in-depth comparison of files, archives, and directories
+#
+# Copyright © 2024 Jelle van der Waa <jelle@archlinux.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 pytest
+
+from diffoscope.comparators.binary import FilesystemFile
+from diffoscope.comparators.uki import UKIFile
+from diffoscope.comparators.utils.command import our_check_output
+from diffoscope.comparators.utils.specialize import specialize
+
+from ..utils.data import assert_diff, load_fixture
+from ..utils.tools import skip_unless_tools_exist
+
+efi_stub = load_fixture("dummyx64.efi.stub")
+
+
+def uki_fixture(prefix, os_release, uname):
+    @pytest.fixture
+    def uki(tmpdir, efi_stub):
+        input_ = str(tmpdir.join(prefix))
+        output = str(tmpdir.join("{}.unsigned.efi".format(prefix)))
+
+        with open(input_, "w") as fp:
+            fp.write("kernel")
+
+        our_check_output(
+            [
+                "ukify",
+                "build",
+                "--stub",
+                efi_stub.path,
+                "--linux",
+                input_,
+                "--os-release",
+                os_release,
+                "--uname",
+                uname,
+            ],
+            cwd=tmpdir,
+        )
+
+        return specialize(FilesystemFile(output))
+
+    return uki
+
+
+uki1 = uki_fixture("linux1", "arch", "6.11")
+uki2 = uki_fixture("linux2", "debian", "6.12")
+
+
+@pytest.fixture
+def differences(uki1, uki2):
+    return uki1.compare(uki2).details
+
+
+@skip_unless_tools_exist("objdump")
+@skip_unless_tools_exist("ukify")
+def test_no_differences(uki1):
+    difference = uki1.compare(uki1)
+    assert difference is None
+
+
+@skip_unless_tools_exist("objdump")
+@skip_unless_tools_exist("ukify")
+def test_diff(differences):
+    assert_diff(differences[0], "uki_expected_diff")

diffoscope-280/.coveragerc

@@ -1,4 +0,0 @@
-[report]
-exclude_lines =
-  noqa
-  raise NotImplementedError

diffoscope-280/.dockerignore

@@ -1,4 +0,0 @@
-*
-!bin/
-!debian/
-!diffoscope/

diffoscope-280/Dockerfile

@@ -1,21 +0,0 @@
-FROM debian:sid-slim
-
-ARG DEBIAN_FRONTEND=noninteractive
-
-ADD [".", "/srv/diffoscope"]
-RUN mkdir -p /usr/share/man/man1/ \
-&& apt-get update && apt-get install --yes --no-install-recommends \
-    build-essential devscripts equivs \
-&& mk-build-deps --install --tool 'apt-get -o Debug::pkgProblemResolver=yes --no-install-recommends --yes' /srv/diffoscope/debian/control \
-&& apt-get remove --purge --yes \
-    build-essential devscripts equivs \
-&& rm -rf /srv/diffoscope/debian \
-&& rm -rf /var/lib/apt/lists/* \
-&& useradd -ms /bin/bash user
-
-USER user
-WORKDIR /home/user
-
-ENV PATH="/srv/diffoscope/bin:${PATH}"
-
-ENTRYPOINT ["/srv/diffoscope/bin/diffoscope"]

diffoscope-280/bin/diffoscope

@@ -1,36 +0,0 @@
-#!/usr/bin/env python3
-# PYTHON_ARGCOMPLETE_OK
-# -*- coding: utf-8 -*-
-#
-# diffoscope: in-depth comparison of files, archives, and directories
-#
-# Copyright © 2014-2015 Jérémy Bobbio <lunar@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 os
-import sys
-
-
-# Prefer local modules over any system-installed ones to ensure that running a
-# Git version from any current working directory does not have unexpected
-# behaviour.
-parent = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
-if os.path.exists(os.path.join(parent, 'diffoscope', '__init__.py')):
-    sys.path.insert(0, parent)
-
-from diffoscope.main import main
-
-if __name__ == '__main__':
-    main()

diffoscope-280/debian/README.source

@@ -1,14 +0,0 @@
-diffoscope: hacking tips
-========================
-
-Running the test suite
-----------------------
-
-Tests are meant to be run with PyTest. The easiest way is simple to run
-the tests are then:
-
-    $ PYTHONPATH=. py.test
-
-To get code coverage:
-
-    $ PYTHONPATH=. py.test --cov diffoscope --cov-report html