diff options
Diffstat (limited to 'nixpkgs/pkgs/tools/misc/diffoscope')
| -rw-r--r-- | nixpkgs/pkgs/tools/misc/diffoscope/default.nix | 308 | ||||
| -rw-r--r-- | nixpkgs/pkgs/tools/misc/diffoscope/ignore_links.patch | 20 | ||||
| -rwxr-xr-x | nixpkgs/pkgs/tools/misc/diffoscope/list-missing-tools.sh | 23 |
3 files changed, 351 insertions, 0 deletions
diff --git a/nixpkgs/pkgs/tools/misc/diffoscope/default.nix b/nixpkgs/pkgs/tools/misc/diffoscope/default.nix new file mode 100644 index 000000000000..5bac5602c79f --- /dev/null +++ b/nixpkgs/pkgs/tools/misc/diffoscope/default.nix @@ -0,0 +1,308 @@ +{ lib +, stdenv +, abootimg +, acl +, apksigcopier +, apksigner +, apktool +, binutils-unwrapped-all-targets +, bzip2 +, cbfstool +, cdrkit +, colord +, colordiff +, coreutils +, cpio +, db +, diffutils +, docutils +, dtc +, e2fsprogs +, enableBloat ? true +, enjarify +, fetchurl +, file +, findutils +, fontforge-fonttools +, ffmpeg +, fpc +, gettext +, ghc +, ghostscriptX +, giflib +, gnumeric +, gnupg +, gnutar +, gzip +, hdf5 +, help2man +, html2text +, imagemagick +, installShellFiles +, jdk +, libarchive +, libcaca +, libxmlb +, llvm +, lz4 +, lzip +, mono +, ocaml +, odt2txt +, oggvideotools +, openssh +, openssl +, pdftk +, pgpdump +, poppler_utils +, procyon +, python3 +, qemu +, R +, radare2 +, sng +, sqlite +, squashfsTools +, tcpdump +, ubootTools +, unzip +, wabt +, xmlbeans +, xxd +, xz +, zip +, zstd + # updater only +, writeScript +}: + +# Note: when upgrading this package, please run the list-missing-tools.sh script as described below! +python3.pkgs.buildPythonApplication rec { + pname = "diffoscope"; + version = "259"; + + src = fetchurl { + url = "https://diffoscope.org/archive/diffoscope-${version}.tar.bz2"; + hash = "sha256-WYgFWM6HKFt3xVcRNytQPWOf3ZpH1cG7Cghhu/AES80="; + }; + + outputs = [ + "out" + "man" + ]; + + patches = [ + ./ignore_links.patch + ]; + + postPatch = '' + # Upstream doesn't provide a PKG-INFO file + sed -i setup.py -e "/'rpm-python',/d" + + # When generating manpage, use the installed version + substituteInPlace doc/Makefile --replace "../bin" "$out/bin" + ''; + + nativeBuildInputs = [ + docutils + help2man + installShellFiles + ]; + + # Most of the non-Python dependencies here are optional command-line tools for various file-format parsers. + # To help figuring out what's missing from the list, run: ./pkgs/tools/misc/diffoscope/list-missing-tools.sh + # + # Still missing these tools: + # Android-specific tools: + # aapt2 + # dexdump + # Darwin-specific tools: + # lipo + # otool + # Other tools: + # docx2txt <- makes tests broken: + # > FAILED tests/comparators/test_docx.py::test_diff - IndexError: list index out of range + # > FAILED tests/comparators/test_docx.py::test_compare_non_existing - AssertionError + # + # We filter automatically all packages for the host platform (some dependencies are not supported on Darwin, aarch64, etc.). + pythonPath = lib.filter (lib.meta.availableOn stdenv.hostPlatform) ([ + acl + binutils-unwrapped-all-targets + bzip2 + cdrkit + colordiff + coreutils + cpio + db + diffutils + dtc + e2fsprogs + file + findutils + fontforge-fonttools + gettext + gnutar + gzip + html2text + libarchive + libxmlb + lz4 + lzip + openssl + pgpdump + sng + sqlite + squashfsTools + unzip + xxd + xz + zip + zstd + ] + ++ (with python3.pkgs; [ + argcomplete + debian + defusedxml + jsbeautifier + jsondiff + libarchive-c + progressbar33 + pypdf2 + python-magic + pyxattr + rpm + tlsh + ]) + ++ lib.optionals enableBloat ( + [ + abootimg + apksigcopier + apksigner + apktool + cbfstool + colord + enjarify + ffmpeg + fpc + ghc + ghostscriptX + giflib + gnupg + hdf5 + imagemagick + jdk + libcaca + llvm + mono + ocaml + odt2txt + openssh + pdftk + poppler_utils + procyon + qemu + R + radare2 + tcpdump + ubootTools + wabt + xmlbeans + ] + ++ (with python3.pkgs; [ + androguard + binwalk + guestfs + h5py + pdfminer-six + # docx2txt, breaks the tests. + ]) + # oggvideotools is broken on Darwin, please put it back when it will be fixed? + ++ lib.optionals stdenv.isLinux [ oggvideotools ] + # This doesn't work on aarch64-darwin + ++ lib.optionals (stdenv.hostPlatform.system != "aarch64-darwin") [ gnumeric ] + )); + + nativeCheckInputs = with python3.pkgs; [ + pytestCheckHook + ] ++ pythonPath; + + pytestFlagsArray = [ + # Always show more information when tests fail + "-vv" + ]; + + postInstall = '' + make -C doc + installManPage doc/diffoscope.1 + ''; + + disabledTests = [ + "test_sbin_added_to_path" + "test_diff_meta" + "test_diff_meta2" + + # Fails because it fails to determine llvm version + "test_item3_deflate_llvm_bitcode" + ] ++ lib.optionals stdenv.isDarwin [ + # Disable flaky tests on Darwin + "test_non_unicode_filename" + "test_listing" + "test_symlink_root" + + # Appears to be a sandbox related issue + "test_trim_stderr_in_command" + # Seems to be a bug caused by having different versions of rdata than + # expected. Will file upstream. + "test_item_rdb" + # Caused by getting an otool command instead of llvm-objdump. Could be Nix + # setup, could be upstream bug. Will file upstream. + "test_libmix_differences" + ]; + + disabledTestPaths = [ + # fails due to https://github.com/NixOS/nixpkgs/issues/256896 + # should be removed once that issue is resolved in coreboot or diffoscope + "tests/comparators/test_cbfs.py" + ] + # Flaky tests on Darwin + ++ lib.optionals stdenv.isDarwin [ + "tests/comparators/test_git.py" + "tests/comparators/test_java.py" + "tests/comparators/test_uimage.py" + "tests/comparators/test_device.py" + "tests/comparators/test_macho.py" + ]; + + passthru = { + updateScript = writeScript "update-diffoscope" '' + #!/usr/bin/env nix-shell + #!nix-shell -i bash -p curl pcre common-updater-scripts + + set -eu -o pipefail + + # Expect the text in format of "Latest release: 198 (31 Dec 2021)"'. + newVersion="$(curl -s https://diffoscope.org/ | pcregrep -o1 'Latest release: ([0-9]+)')" + update-source-version ${pname} "$newVersion" + ''; + }; + + meta = with lib; { + description = "Perform in-depth comparison of files, archives, and directories"; + longDescription = '' + diffoscope will try to get to the bottom of what makes files or directories + different. It will recursively unpack archives of many kinds and transform + various binary formats into more human readable form to compare them. It can + compare two tarballs, ISO images, or PDF just as easily. The differences can + be shown in a text or HTML report. + + diffoscope is developed as part of the "reproducible builds" Debian + project and was formerly known as "debbindiff". + ''; + homepage = "https://diffoscope.org/"; + changelog = "https://diffoscope.org/news/diffoscope-${version}-released/"; + license = licenses.gpl3Plus; + maintainers = with maintainers; [ dezgeg danielfullmer raitobezarius ]; + platforms = platforms.unix; + mainProgram = "diffoscope"; + }; +} diff --git a/nixpkgs/pkgs/tools/misc/diffoscope/ignore_links.patch b/nixpkgs/pkgs/tools/misc/diffoscope/ignore_links.patch new file mode 100644 index 000000000000..2830acdd9655 --- /dev/null +++ b/nixpkgs/pkgs/tools/misc/diffoscope/ignore_links.patch @@ -0,0 +1,20 @@ +diff --git a/diffoscope/comparators/directory.py b/diffoscope/comparators/directory.py +index 5f34d62..36999a3 100644 +--- a/diffoscope/comparators/directory.py ++++ b/diffoscope/comparators/directory.py +@@ -77,6 +77,7 @@ else: + FILE_RE = re.compile(r"^\s*File:.*$") + DEVICE_RE = re.compile(r"Device: [0-9a-f]+h/[0-9]+d\s+") + INODE_RE = re.compile(r"Inode: [0-9]+\s+") ++ LINKS_RE = re.compile(r"Links: [0-9]+\s+") + ACCESS_TIME_RE = re.compile(r"^Access: [0-9]{4}-[0-9]{2}-[0-9]{2}.*$") + CHANGE_TIME_RE = re.compile(r"^Change: [0-9]{4}-[0-9]{2}-[0-9]{2}.*$") + BIRTH_TIME_RE = re.compile(r"^\s*Birth:.*$") +@@ -86,6 +87,7 @@ else: + line = Stat.FILE_RE.sub("", line) + line = Stat.DEVICE_RE.sub("", line) + line = Stat.INODE_RE.sub("", line) ++ line = Stat.LINKS_RE.sub("", line) + line = Stat.ACCESS_TIME_RE.sub("", line) + line = Stat.CHANGE_TIME_RE.sub("", line) + line = Stat.BIRTH_TIME_RE.sub("", line) diff --git a/nixpkgs/pkgs/tools/misc/diffoscope/list-missing-tools.sh b/nixpkgs/pkgs/tools/misc/diffoscope/list-missing-tools.sh new file mode 100755 index 000000000000..5f4d118cfed7 --- /dev/null +++ b/nixpkgs/pkgs/tools/misc/diffoscope/list-missing-tools.sh @@ -0,0 +1,23 @@ +#!/usr/bin/env bash + +# This script lists all the optional command-line tools that diffoscope can use +# (i.e. `diffoscope --list-tools`) but are missing from the Nix expression. + +diffoscope=$(nix-build --no-out-link -E 'with import ./. {}; diffoscope.override { enableBloat = true; }')/bin/diffoscope + +required=$($diffoscope --list-tools | \ + grep '^External-Tools-Required:' | \ + cut -d ' ' -f2- | \ + tr -d ,) + +# Uber-hacky! +pathScript=$(cat $diffoscope | grep PATH) + +export PATH=$(nix-build --no-out-link -A which)/bin +eval "$pathScript" + +for tool in $required; do + if ! which $tool >/dev/null 2>&1; then + echo $tool + fi +done | sort |