tests/opam.scm

   1 ;;; GNU Guix --- Functional package management for GNU
   2 ;;; Copyright © 2018 Julien Lepiller <julien@lepiller.eu>
   3 ;;;
   4 ;;; This file is part of GNU Guix.
   5 ;;;
   6 ;;; GNU Guix is free software; you can redistribute it and/or modify it
   7 ;;; under the terms of the GNU General Public License as published by
   8 ;;; the Free Software Foundation; either version 3 of the License, or (at
   9 ;;; your option) any later version.
  10 ;;;
  11 ;;; GNU Guix is distributed in the hope that it will be useful, but
  12 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ;;; GNU General Public License for more details.
  15 ;;;
  16 ;;; You should have received a copy of the GNU General Public License
  17 ;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 (define-module (test-opam)
  20   #:use-module (guix import opam)
  21   #:use-module (guix base32)
  22   #:use-module (gcrypt hash)
  23   #:use-module (guix tests)
  24   #:use-module ((guix build syscalls) #:select (mkdtemp!))
  25   #:use-module ((guix build utils) #:select (delete-file-recursively mkdir-p which))
  26   #:use-module ((guix utils) #:select (call-with-temporary-output-file))
  27   #:use-module (srfi srfi-1)
  28   #:use-module (srfi srfi-64)
  29   #:use-module (web uri)
  30   #:use-module (ice-9 match)
  31   #:use-module (ice-9 peg))
  32
  33 (define test-opam-file
  34 "opam-version: \"2.0\"
  35   version: \"1.0.0\"
  36 maintainer: \"Alice Doe\"
  37 authors: [
  38   \"Alice Doe\"
  39   \"John Doe\"
  40 ]
  41 homepage: \"https://example.org/\"
  42 bug-reports: \"https://example.org/bugs\"
  43 dev-repo: \"https://example.org/git\"
  44 build: [
  45   [\"ocaml\" \"pkg/pkg.ml\" \"build\" \"--pinned\" \"%{pinned}%\"]
  46 ]
  47 build-test: [
  48   [\"ocaml\" \"pkg/pkg.ml\" \"build\" \"--pinned\" \"%{pinned}%\" \"--tests\" \"true\"]
  49 ]
  50 depends: [
  51   \"alcotest\" {test & >= \"0.7.2\"}
  52   \"ocamlbuild\" {build & >= \"0.9.2\"}
  53   \"zarith\" {>= \"0.7\"}
  54 ]
  55 synopsis: \"Some example package\"
  56 description: \"\"\"
  57 This package is just an example.\"\"\"
  58 url {
  59   src: \"https://example.org/foo-1.0.0.tar.gz\"
  60   checksum: \"md5=74c6e897658e820006106f45f736381f\"
  61 }")
  62
  63 (define test-source-hash
  64   "")
  65
  66 (define test-repo
  67   (mkdtemp! "/tmp/opam-repo.XXXXXX"))
  68
  69 (test-begin "opam")
  70
  71 (test-assert "opam->guix-package"
  72   (mock ((guix import utils) url-fetch
  73          (lambda (url file-name)
  74            (match url
  75              ("https://example.org/foo-1.0.0.tar.gz"
  76               (begin
  77                 (mkdir-p "foo-1.0.0")
  78                 (system* "tar" "czvf" file-name "foo-1.0.0/")
  79                 (delete-file-recursively "foo-1.0.0")
  80                 (set! test-source-hash
  81                   (call-with-input-file file-name port-sha256))))
  82              (_ (error "Unexpected URL: " url)))))
  83       (let ((my-package (string-append test-repo "/packages/foo/foo.1.0.0")))
  84         (mkdir-p my-package)
  85         (with-output-to-file (string-append my-package "/opam")
  86           (lambda _
  87             (format #t "~a" test-opam-file))))
  88       (mock ((guix import opam) get-opam-repository
  89              (lambda _
  90                test-repo))
  91         (match (opam->guix-package "foo")
  92           (('package
  93              ('name "ocaml-foo")
  94              ('version "1.0.0")
  95              ('source ('origin
  96                         ('method 'url-fetch)
  97                         ('uri "https://example.org/foo-1.0.0.tar.gz")
  98                         ('sha256
  99                          ('base32
 100                           (? string? hash)))))
 101              ('build-system 'ocaml-build-system)
 102              ('inputs
 103               ('quasiquote
 104                (("ocaml-zarith" ('unquote 'ocaml-zarith)))))
 105              ('native-inputs
 106               ('quasiquote
 107                (("ocaml-alcotest" ('unquote 'ocaml-alcotest))
 108                 ("ocamlbuild" ('unquote 'ocamlbuild)))))
 109              ('home-page "https://example.org/")
 110              ('synopsis "Some example package")
 111              ('description "This package is just an example.")
 112              ('license #f))
 113            (string=? (bytevector->nix-base32-string
 114                       test-source-hash)
 115                      hash))
 116           (x
 117            (pk 'fail x #f))))))
 118
 119 ;; Test the opam file parser
 120 ;; We fold over some test cases. Each case is a pair of the string to parse and the
 121 ;; expected result.
 122 (test-assert "parse-strings"
 123   (fold (lambda (test acc)
 124           (display test) (newline)
 125           (and acc
 126                (let ((result (peg:tree (match-pattern (@@ (guix import opam) string-pat) (car test)))))
 127                  (if (equal? result (cdr test))
 128                    #t
 129                    (pk 'fail (list (car test) result (cdr test)) #f)))))
 130     #t '(("" . #f)
 131          ("\"hello\"" . (string-pat "hello"))
 132          ("\"hello world\"" . (string-pat "hello world"))
 133          ("\"The dreaded \\\"é\\\"\"" . (string-pat "The dreaded \"é\""))
 134          ("\"Have some \\\\\\\\ :)\"" . (string-pat "Have some \\\\ :)"))
 135          ("\"今日は\"" . (string-pat "今日は")))))
 136
 137 (test-assert "parse-multiline-strings"
 138   (fold (lambda (test acc)
 139           (display test) (newline)
 140           (and acc
 141                (let ((result (peg:tree (match-pattern (@@ (guix import opam) multiline-string) (car test)))))
 142                  (if (equal? result (cdr test))
 143                    #t
 144                    (pk 'fail (list (car test) result (cdr test)) #f)))))
 145     #t '(("" . #f)
 146          ("\"\"\"hello\"\"\"" . (multiline-string "hello"))
 147          ("\"\"\"hello \"world\"!\"\"\"" . (multiline-string "hello \"world\"!"))
 148          ("\"\"\"hello \"\"world\"\"!\"\"\"" . (multiline-string "hello \"\"world\"\"!")))))
 149
 150 (test-assert "parse-lists"
 151   (fold (lambda (test acc)
 152           (and acc
 153                (let ((result (peg:tree (match-pattern (@@ (guix import opam) list-pat) (car test)))))
 154                  (if (equal? result (cdr test))
 155                    #t
 156                    (pk 'fail (list (car test) result (cdr test)) #f)))))
 157     #t '(("" . #f)
 158          ("[]" . list-pat)
 159          ("[make]" . (list-pat (var "make")))
 160          ("[\"make\"]" . (list-pat (string-pat "make")))
 161          ("[\n  a\n  b\n  c]" . (list-pat (var "a") (var "b") (var "c")))
 162          ("[a   b     \"c\"]" . (list-pat (var "a") (var "b") (string-pat "c"))))))
 163
 164 (test-assert "parse-dicts"
 165   (fold (lambda (test acc)
 166           (and acc
 167                (let ((result (peg:tree (match-pattern (@@ (guix import opam) dict) (car test)))))
 168                  (if (equal? result (cdr test))
 169                    #t
 170                    (pk 'fail (list (car test) result (cdr test)) #f)))))
 171     #t '(("" . #f)
 172          ("{}" . dict)
 173          ("{a: \"b\"}" . (dict (record "a" (string-pat "b"))))
 174          ("{a: \"b\"\nc: \"d\"}" . (dict (record "a" (string-pat "b")) (record "c" (string-pat "d")))))))
 175
 176 (test-assert "parse-conditions"
 177   (fold (lambda (test acc)
 178           (and acc
 179                (let ((result (peg:tree (match-pattern (@@ (guix import opam) condition) (car test)))))
 180                  (if (equal? result (cdr test))
 181                    #t
 182                    (pk 'fail (list (car test) result (cdr test)) #f)))))
 183     #t '(("" . #f)
 184          ("{}" . #f)
 185          ("{build}" . (condition-var "build"))
 186          ("{>= \"0.2.0\"}" . (condition-greater-or-equal
 187                                (condition-string "0.2.0")))
 188          ("{>= \"0.2.0\" & test}" . (condition-and
 189                                       (condition-greater-or-equal
 190                                         (condition-string "0.2.0"))
 191                                       (condition-var "test")))
 192          ("{>= \"0.2.0\" | build}" . (condition-or
 193                                       (condition-greater-or-equal
 194                                         (condition-string "0.2.0"))
 195                                       (condition-var "build")))
 196          ("{ = \"1.0+beta19\" }" . (condition-eq
 197                                      (condition-string "1.0+beta19"))))))
 198
 199 (test-end "opam")