[jackhill/guix/guix.git] / gnu / packages / diffoscope.scm

;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2017 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2017, 2018, 2019 Tobias Geerinckx-Rice <me@tobias.gr>
;;; Copyright © 2018 Julien Lepiller <julien@lepiller.eu>
;;; Copyright © 2018, 2019 Rutger Helling <rhelling@mykolab.com>
;;; Copyright © 2019 Vagrant Cascadian <vagrant@reproducible-builds.org>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix 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.
;;;
;;; GNU Guix 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 GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu packages diffoscope)
  #:use-module (gnu packages)
  #:use-module (gnu packages acl)
  #:use-module (gnu packages admin)
  #:use-module (gnu packages android)
  #:use-module (gnu packages backup)
  #:use-module (gnu packages base)
  #:use-module (gnu packages bootloaders)
  #:use-module (gnu packages cdrom)
  #:use-module (gnu packages check)
  #:use-module (gnu packages compression)
  #:use-module (gnu packages cpio)
  #:use-module (gnu packages dbm)
  #:use-module (gnu packages gettext)
  #:use-module (gnu packages ghostscript)
  #:use-module (gnu packages gnome)
  #:use-module (gnu packages gnupg)
  #:use-module (gnu packages haskell)
  #:use-module (gnu packages image)
  #:use-module (gnu packages imagemagick)
  #:use-module (gnu packages java)
  #:use-module (gnu packages linux)
  #:use-module (gnu packages llvm)
  #:use-module (gnu packages mono)
  #:use-module (gnu packages ocaml)
  #:use-module (gnu packages package-management)
  #:use-module (gnu packages patchutils)
  #:use-module (gnu packages pdf)
  #:use-module (gnu packages python-web)
  #:use-module (gnu packages python-xyz)
  #:use-module (gnu packages sqlite)
  #:use-module (gnu packages ssh)
  #:use-module (gnu packages statistics)
  #:use-module (gnu packages textutils)
  #:use-module (gnu packages video)
  #:use-module (gnu packages vim)
  #:use-module (gnu packages web)
  #:use-module (guix build-system python)
  #:use-module (guix gexp)
  #:use-module (guix git-download)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix packages)
  #:use-module (guix utils))

(define-public diffoscope
  (let ((version "125"))
    (package
      (name "diffoscope")
      (version version)
      (source (origin
                (method git-fetch)
                (uri (git-reference
                      (url "https://salsa.debian.org/reproducible-builds/diffoscope.git")
                      (commit version)))
                (file-name (git-file-name name version))
                (sha256
                 (base32
                  "02kwisp9j63w27hhcwpdhg66dgxzz61q4fcyfz8z4hwlz6r0gyqy"))))
      (build-system python-build-system)
      (arguments
       `(#:phases (modify-phases %standard-phases
                    ;; setup.py mistakenly requires python-magic from PyPi, even
                    ;; though the Python bindings of `file` are sufficient.
                    ;; https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=815844
                    (add-after 'unpack 'dependency-on-python-magic
                      (lambda _
                        (substitute* "setup.py"
                          (("'python-magic',") ""))))
                    ;; Patch in support for known tools
                    (add-after 'unpack 'add-known-tools
                      (lambda _
                        (substitute* "diffoscope/external_tools.py"
                          (("'arch': 'enjarify'},")
                           "'arch': 'enjarify', 'guix': 'enjarify'},"))
                        (substitute* "diffoscope/external_tools.py"
                          (("'arch': 'python-jsbeautifier'},")
                           "'arch': 'python-jsbeautifier', 'guix': 'python-jsbeautifier'},"))
                        (substitute* "diffoscope/external_tools.py"
                          (("'arch': 'wabt'},")
                           "'arch': 'wabt', 'guix': 'wabt'},"))))
                    ;; This test is broken because our `file` package has a
                    ;; bug in berkeley-db file type detection.
                    (add-after 'unpack 'remove-berkeley-test
                      (lambda _
                        (delete-file "tests/comparators/test_berkeley_db.py")
                        #t))
                    ;; Test is dynamically generated and may have false
                    ;; negatives with different ocaml versions.  Further
                    ;; background in: https://bugs.debian.org/939386
                    (add-after 'unpack 'remove-ocaml-test
                      (lambda _
                        (substitute* "tests/comparators/test_ocaml.py"
                          (("def test_diff.differences.:")
                           "def skip_test_diff(differences):"))
                        #t))
                    (add-after 'unpack 'skip-elf-tests
                      ;; FIXME: libmix_differences test added in 125, and is
                      ;; failing, need to explore why...
                      (lambda _
                        (substitute* "tests/comparators/test_elf.py"
                          (("def test_libmix_differences.libmix_differences.:")
                           "def skip_test_libmix_differences(libmix_differences):"))
                        #t))
                    (add-after 'unpack 'embed-tool-references
                      (lambda* (#:key inputs #:allow-other-keys)
                        (substitute* "diffoscope/comparators/utils/compare.py"
                          (("\\['xxd',")
                           (string-append "['" (which "xxd") "',")))
                        (substitute* "diffoscope/comparators/elf.py"
                          (("@tool_required\\('readelf'\\)") "")
                          (("get_tool_name\\('readelf'\\)")
                           (string-append "'" (which "readelf") "'")))
                        (substitute* "diffoscope/comparators/directory.py"
                          (("@tool_required\\('stat'\\)") "")
                          (("@tool_required\\('getfacl'\\)") "")
                          (("\\['stat',")
                           (string-append "['" (which "stat") "',"))
                          (("\\['getfacl',")
                           (string-append "['" (which "getfacl") "',")))
                        #t))
                    (add-before 'check 'writable-test-data
                      (lambda _
                        ;; tests may need needs write access to tests
                        ;; directory
                        (for-each make-file-writable (find-files "tests"))
                        #t))
                    (add-before 'check 'delete-failing-test
                      (lambda _
                        ;; this requires /sbin to be on the path
                        (delete-file "tests/test_tools.py")
                        #t)))))
      (inputs `(("rpm" ,rpm)                        ;for rpm-python
                ("python-file" ,python-file)
                ("python-debian" ,python-debian)
                ("python-libarchive-c" ,python-libarchive-c)
                ("python-tlsh" ,python-tlsh)
                ("acl" ,acl)                        ;for getfacl
                ("colordiff" ,colordiff)
                ("xxd" ,xxd)))
      ;; Below are modules used for tests.
      (native-inputs `(("python-pytest" ,python-pytest)
                       ("python-chardet" ,python-chardet)
                       ("python-binwalk" ,python-binwalk)
                       ;; test suite skips tests when tool is missing
                       ("abootimg" ,abootimg)
                       ("bdb" ,bdb)
                       ("binutils" ,binutils)
                       ("bzip2" ,bzip2)
                       ("cdrtools" ,cdrtools)
                       ("colord" ,colord)
                       ("cpio" ,cpio)
                       ("docx2txt" ,docx2txt)
                       ("dtc" ,dtc)
                       ("e2fsprogs" ,e2fsprogs)
                       ("enjarify" ,enjarify)
                       ("ffmpeg" ,ffmpeg)
                       ("gettext" ,gettext-minimal)
                       ("ghc" ,ghc)
                       ("ghostscript" ,ghostscript)
                       ("giflib:bin" ,giflib "bin")
                       ("gnumeric" ,gnumeric)
                       ("gnupg" ,gnupg)
                       ("imagemagick" ,imagemagick)
                       ("libarchive" ,libarchive)
                       ("llvm" ,llvm)
                       ("lz4" ,lz4)
                       ("mono" ,mono)
                       ("ocaml" ,ocaml)
                       ("odt2txt" ,odt2txt)
                       ;; no unversioned openjdk available
                       ("openjdk:jdk" ,openjdk12 "jdk")
                       ("openssh" ,openssh)
                       ("pgpdump" ,pgpdump)
                       ("poppler" ,poppler)
                       ("python-jsbeautifier" ,python-jsbeautifier)
                       ("r-minimal" ,r-minimal)
                       ("rpm" ,rpm)
                       ("sng" ,sng)
                       ("sqlite" ,sqlite)
                       ("squashfs-tools" ,squashfs-tools)
                       ("tcpdump" ,tcpdump)
                       ("unzip" ,unzip)
                       ("wabt" ,wabt)
                       ("xxd" ,xxd)
                       ("xz" ,xz)
                       ("zip" ,zip)))
      (home-page "https://diffoscope.org/")
      (synopsis "Compare files, archives, and directories in depth")
      (description
       "Diffoscope tries to get to the bottom of what makes files or directories
different.  It recursively unpacks archives of many kinds and transforms
various binary formats into more human readable forms to compare them.  It can
compare two tarballs, ISO images, or PDFs just as easily.")
      (license license:gpl3+))))

(define-public trydiffoscope
 (package
   (name "trydiffoscope")
   (version "67.0.1")
   (source
    (origin
      (method git-fetch)
      (uri (git-reference
            (url "https://salsa.debian.org/reproducible-builds/trydiffoscope.git")
            (commit version)))
      (file-name (git-file-name name version))
      (sha256
       (base32
        "03b66cjii7l2yiwffj6ym6mycd5drx7prfp4j2550281pias6mjh"))))
    (arguments
     `(#:phases
       (modify-phases %standard-phases
         (add-after 'install 'install-doc
           (lambda* (#:key outputs #:allow-other-keys)
             (let* ((share (string-append (assoc-ref outputs "out") "/share/")))
               (mkdir-p (string-append share "/man/man1/" ))
               (invoke "rst2man.py"
                       "trydiffoscope.1.rst"
                       (string-append share "/man/man1/trydiffoscope.1"))
               (mkdir-p (string-append share "/doc/" ,name "-" ,version))
               (install-file "./README.rst"
                          (string-append share "/doc/" ,name "-" ,version)))
             #t)))))
    (propagated-inputs
     `(("python-requests" ,python-requests)))
    (native-inputs
     `(("gzip" ,gzip)
       ("python-docutils" ,python-docutils)))
    (build-system python-build-system)
    (home-page "https://try.diffoscope.org")
    (synopsis "Client for remote diffoscope service")
    (description "This is a client for the @url{https://try.diffoscope.org,
remote diffoscope service}.

Diffoscope tries to get to the bottom of what makes files or directories
different.  It recursively unpacks archives of many kinds and transforms
various binary formats into more human readable forms to compare them.  It can
compare two tarballs, ISO images, or PDFs just as easily.

Results are displayed by default, stored as local text or html files, or made
available via a URL on @url{https://try.diffoscope.org}.  Results stored on the
server are purged after 30 days.")
    (license license:gpl3+)))
Commit	Line	Data
52211add VC	1	;;; GNU Guix --- Functional package management for GNU
	2	;;; Copyright © 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org>
	3	;;; Copyright © 2017 Ricardo Wurmus <rekado@elephly.net>
	4	;;; Copyright © 2017, 2018, 2019 Tobias Geerinckx-Rice <me@tobias.gr>
	5	;;; Copyright © 2018 Julien Lepiller <julien@lepiller.eu>
	6	;;; Copyright © 2018, 2019 Rutger Helling <rhelling@mykolab.com>
	7	;;; Copyright © 2019 Vagrant Cascadian <vagrant@reproducible-builds.org>
	8	;;;
	9	;;; This file is part of GNU Guix.
	10	;;;
	11	;;; GNU Guix is free software; you can redistribute it and/or modify it
	12	;;; under the terms of the GNU General Public License as published by
	13	;;; the Free Software Foundation; either version 3 of the License, or (at
	14	;;; your option) any later version.
	15	;;;
	16	;;; GNU Guix is distributed in the hope that it will be useful, but
	17	;;; WITHOUT ANY WARRANTY; without even the implied warranty of
	18	;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	;;; GNU General Public License for more details.
	20	;;;
	21	;;; You should have received a copy of the GNU General Public License
	22	;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
	23
	24	(define-module (gnu packages diffoscope)
	25	#:use-module (gnu packages)
	26	#:use-module (gnu packages acl)
	27	#:use-module (gnu packages admin)
3244b64f	28	#:use-module (gnu packages android)
52211add VC	29	#:use-module (gnu packages backup)
52211add VC	30	#:use-module (gnu packages base)
3244b64f	31	#:use-module (gnu packages bootloaders)
52211add VC	32	#:use-module (gnu packages cdrom)
	33	#:use-module (gnu packages check)
	34	#:use-module (gnu packages compression)
	35	#:use-module (gnu packages cpio)
	36	#:use-module (gnu packages dbm)
	37	#:use-module (gnu packages gettext)
	38	#:use-module (gnu packages ghostscript)
	39	#:use-module (gnu packages gnome)
	40	#:use-module (gnu packages gnupg)
	41	#:use-module (gnu packages haskell)
	42	#:use-module (gnu packages image)
	43	#:use-module (gnu packages imagemagick)
	44	#:use-module (gnu packages java)
	45	#:use-module (gnu packages linux)
	46	#:use-module (gnu packages llvm)
	47	#:use-module (gnu packages mono)
3fb581ca	48	#:use-module (gnu packages ocaml)
52211add VC	49	#:use-module (gnu packages package-management)
	50	#:use-module (gnu packages patchutils)
	51	#:use-module (gnu packages pdf)
	52	#:use-module (gnu packages python-web)
	53	#:use-module (gnu packages python-xyz)
	54	#:use-module (gnu packages sqlite)
	55	#:use-module (gnu packages ssh)
3244b64f	56	#:use-module (gnu packages statistics)
52211add VC	57	#:use-module (gnu packages textutils)
	58	#:use-module (gnu packages video)
	59	#:use-module (gnu packages vim)
4d83157c	60	#:use-module (gnu packages web)
52211add VC	61	#:use-module (guix build-system python)
	62	#:use-module (guix gexp)
	63	#:use-module (guix git-download)
	64	#:use-module ((guix licenses) #:prefix license:)
	65	#:use-module (guix packages)
	66	#:use-module (guix utils))
	67
	68	(define-public diffoscope
3fb581ca	69	(let ((version "125"))
52211add VC	70	(package
	71	(name "diffoscope")
	72	(version version)
	73	(source (origin
	74	(method git-fetch)
	75	(uri (git-reference
	76	(url "https://salsa.debian.org/reproducible-builds/diffoscope.git")
	77	(commit version)))
	78	(file-name (git-file-name name version))
	79	(sha256
	80	(base32
3fb581ca	81	"02kwisp9j63w27hhcwpdhg66dgxzz61q4fcyfz8z4hwlz6r0gyqy"))))
52211add VC	82	(build-system python-build-system)
	83	(arguments
	84	`(#:phases (modify-phases %standard-phases
	85	;; setup.py mistakenly requires python-magic from PyPi, even
	86	;; though the Python bindings of `file` are sufficient.
	87	;; https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=815844
	88	(add-after 'unpack 'dependency-on-python-magic
	89	(lambda _
	90	(substitute* "setup.py"
	91	(("'python-magic',") ""))))
4d83157c VC	92	;; Patch in support for known tools
	93	(add-after 'unpack 'add-known-tools
	94	(lambda _
68620d62 VC	95	(substitute* "diffoscope/external_tools.py"
	96	(("'arch': 'enjarify'},")
	97	"'arch': 'enjarify', 'guix': 'enjarify'},"))
6ec87223 VC	98	(substitute* "diffoscope/external_tools.py"
	99	(("'arch': 'python-jsbeautifier'},")
	100	"'arch': 'python-jsbeautifier', 'guix': 'python-jsbeautifier'},"))
4d83157c VC	101	(substitute* "diffoscope/external_tools.py"
	102	(("'arch': 'wabt'},")
	103	"'arch': 'wabt', 'guix': 'wabt'},"))))
52211add VC	104	;; This test is broken because our `file` package has a
	105	;; bug in berkeley-db file type detection.
	106	(add-after 'unpack 'remove-berkeley-test
	107	(lambda _
	108	(delete-file "tests/comparators/test_berkeley_db.py")
	109	#t))
	110	;; Test is dynamically generated and may have false
	111	;; negatives with different ocaml versions. Further
	112	;; background in: https://bugs.debian.org/939386
	113	(add-after 'unpack 'remove-ocaml-test
	114	(lambda _
3fb581ca VC	115	(substitute* "tests/comparators/test_ocaml.py"
	116	(("def test_diff.differences.:")
	117	"def skip_test_diff(differences):"))
	118	#t))
	119	(add-after 'unpack 'skip-elf-tests
	120	;; FIXME: libmix_differences test added in 125, and is
	121	;; failing, need to explore why...
	122	(lambda _
	123	(substitute* "tests/comparators/test_elf.py"
	124	(("def test_libmix_differences.libmix_differences.:")
	125	"def skip_test_libmix_differences(libmix_differences):"))
52211add VC	126	#t))
	127	(add-after 'unpack 'embed-tool-references
	128	(lambda* (#:key inputs #:allow-other-keys)
	129	(substitute* "diffoscope/comparators/utils/compare.py"
	130	(("\\['xxd',")
	131	(string-append "['" (which "xxd") "',")))
	132	(substitute* "diffoscope/comparators/elf.py"
	133	(("@tool_required\\('readelf'\\)") "")
	134	(("get_tool_name\\('readelf'\\)")
	135	(string-append "'" (which "readelf") "'")))
	136	(substitute* "diffoscope/comparators/directory.py"
	137	(("@tool_required\\('stat'\\)") "")
	138	(("@tool_required\\('getfacl'\\)") "")
	139	(("\\['stat',")
	140	(string-append "['" (which "stat") "',"))
	141	(("\\['getfacl',")
	142	(string-append "['" (which "getfacl") "',")))
	143	#t))
	144	(add-before 'check 'writable-test-data
	145	(lambda _
	146	;; tests may need needs write access to tests
	147	;; directory
	148	(for-each make-file-writable (find-files "tests"))
	149	#t))
	150	(add-before 'check 'delete-failing-test
	151	(lambda _
	152	;; this requires /sbin to be on the path
	153	(delete-file "tests/test_tools.py")
	154	#t)))))
	155	(inputs `(("rpm" ,rpm) ;for rpm-python
	156	("python-file" ,python-file)
	157	("python-debian" ,python-debian)
	158	("python-libarchive-c" ,python-libarchive-c)
	159	("python-tlsh" ,python-tlsh)
	160	("acl" ,acl) ;for getfacl
	161	("colordiff" ,colordiff)
	162	("xxd" ,xxd)))
	163	;; Below are modules used for tests.
	164	(native-inputs `(("python-pytest" ,python-pytest)
	165	("python-chardet" ,python-chardet)
f315673d	166	("python-binwalk" ,python-binwalk)
52211add	167	;; test suite skips tests when tool is missing
3244b64f	168	("abootimg" ,abootimg)
52211add VC	169	("bdb" ,bdb)
	170	("binutils" ,binutils)
	171	("bzip2" ,bzip2)
	172	("cdrtools" ,cdrtools)
	173	("colord" ,colord)
	174	("cpio" ,cpio)
	175	("docx2txt" ,docx2txt)
3244b64f	176	("dtc" ,dtc)
52211add	177	("e2fsprogs" ,e2fsprogs)
68620d62	178	("enjarify" ,enjarify)
52211add VC	179	("ffmpeg" ,ffmpeg)
	180	("gettext" ,gettext-minimal)
	181	("ghc" ,ghc)
	182	("ghostscript" ,ghostscript)
	183	("giflib:bin" ,giflib "bin")
	184	("gnumeric" ,gnumeric)
	185	("gnupg" ,gnupg)
	186	("imagemagick" ,imagemagick)
	187	("libarchive" ,libarchive)
	188	("llvm" ,llvm)
	189	("lz4" ,lz4)
	190	("mono" ,mono)
3fb581ca	191	("ocaml" ,ocaml)
52211add VC	192	("odt2txt" ,odt2txt)
	193	;; no unversioned openjdk available
	194	("openjdk:jdk" ,openjdk12 "jdk")
	195	("openssh" ,openssh)
	196	("pgpdump" ,pgpdump)
	197	("poppler" ,poppler)
6ec87223	198	("python-jsbeautifier" ,python-jsbeautifier)
3244b64f	199	("r-minimal" ,r-minimal)
52211add VC	200	("rpm" ,rpm)
	201	("sng" ,sng)
	202	("sqlite" ,sqlite)
	203	("squashfs-tools" ,squashfs-tools)
	204	("tcpdump" ,tcpdump)
	205	("unzip" ,unzip)
4d83157c	206	("wabt" ,wabt)
52211add VC	207	("xxd" ,xxd)
	208	("xz" ,xz)
	209	("zip" ,zip)))
	210	(home-page "https://diffoscope.org/")
	211	(synopsis "Compare files, archives, and directories in depth")
	212	(description
	213	"Diffoscope tries to get to the bottom of what makes files or directories
	214	different. It recursively unpacks archives of many kinds and transforms
	215	various binary formats into more human readable forms to compare them. It can
	216	compare two tarballs, ISO images, or PDFs just as easily.")
	217	(license license:gpl3+))))
	218
	219	(define-public trydiffoscope
	220	(package
	221	(name "trydiffoscope")
	222	(version "67.0.1")
	223	(source
	224	(origin
	225	(method git-fetch)
	226	(uri (git-reference
	227	(url "https://salsa.debian.org/reproducible-builds/trydiffoscope.git")
	228	(commit version)))
	229	(file-name (git-file-name name version))
	230	(sha256
	231	(base32
	232	"03b66cjii7l2yiwffj6ym6mycd5drx7prfp4j2550281pias6mjh"))))
	233	(arguments
	234	`(#:phases
	235	(modify-phases %standard-phases
	236	(add-after 'install 'install-doc
	237	(lambda* (#:key outputs #:allow-other-keys)
	238	(let* ((share (string-append (assoc-ref outputs "out") "/share/")))
	239	(mkdir-p (string-append share "/man/man1/" ))
	240	(invoke "rst2man.py"
	241	"trydiffoscope.1.rst"
	242	(string-append share "/man/man1/trydiffoscope.1"))
	243	(mkdir-p (string-append share "/doc/" ,name "-" ,version))
	244	(install-file "./README.rst"
	245	(string-append share "/doc/" ,name "-" ,version)))
	246	#t)))))
	247	(propagated-inputs
	248	`(("python-requests" ,python-requests)))
	249	(native-inputs
	250	`(("gzip" ,gzip)
	251	("python-docutils" ,python-docutils)))
	252	(build-system python-build-system)
	253	(home-page "https://try.diffoscope.org")
	254	(synopsis "Client for remote diffoscope service")
	255	(description "This is a client for the @url{https://try.diffoscope.org,
	256	remote diffoscope service}.
	257
	258	Diffoscope tries to get to the bottom of what makes files or directories
	259	different. It recursively unpacks archives of many kinds and transforms
	260	various binary formats into more human readable forms to compare them. It can
	261	compare two tarballs, ISO images, or PDFs just as easily.
	262
	263	Results are displayed by default, stored as local text or html files, or made
	264	available via a URL on @url{https://try.diffoscope.org}. Results stored on the
	265	server are purged after 30 days.")
	266	(license license:gpl3+)))