tests/opam.scm

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