tests/go.scm

   1 ;;; GNU Guix --- Functional package management for GNU
   2 ;;; Copyright © 2021 François Joulaud <francois.joulaud@radiofrance.com>
   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 ;;; Summary
  20 ;; Tests for guix/import/go.scm
  21
  22 (define-module (tests-import-go)
  23   #:use-module (guix base32)
  24   #:use-module (guix build-system go)
  25   #:use-module (guix import go)
  26   #:use-module (guix base32)
  27   #:use-module ((guix utils) #:select (call-with-temporary-directory))
  28   #:use-module (guix tests)
  29   #:use-module (ice-9 match)
  30   #:use-module (srfi srfi-19)
  31   #:use-module (srfi srfi-64)
  32   #:use-module (web response))
  33
  34 (define parse-go.mod
  35   (@@ (guix import go) parse-go.mod))
  36
  37 (define fixture-go-mod-simple
  38   "module my/thing
  39 go 1.12
  40 require other/thing v1.0.2
  41 require new/thing/v2 v2.3.4
  42 exclude old/thing v1.2.3
  43 replace bad/thing v1.4.5 => good/thing v1.4.5
  44 ")
  45
  46 (define fixture-go-mod-with-block
  47   "module M
  48
  49 require (
  50          A v1
  51          B v1.0.0
  52          C v1.0.0
  53          D v1.2.3
  54          E dev
  55 )
  56
  57 exclude D v1.2.3
  58 ")
  59
  60 (define fixture-go-mod-complete
  61   "module M
  62
  63 go 1.13
  64
  65 replace github.com/myname/myproject/myapi => ./api
  66
  67 replace github.com/mymname/myproject/thissdk => ../sdk
  68
  69 replace launchpad.net/gocheck => github.com/go-check/check v0.0.0-20140225173054-eb6ee6f84d0a
  70
  71 require (
  72         github.com/user/project v1.1.11
  73         github.com/user/project/sub/directory v1.1.12
  74         bitbucket.org/user/project v1.11.20
  75         bitbucket.org/user/project/sub/directory v1.11.21
  76         launchpad.net/project v1.1.13
  77         launchpad.net/project/series v1.1.14
  78         launchpad.net/project/series/sub/directory v1.1.15
  79         launchpad.net/~user/project/branch v1.1.16
  80         launchpad.net/~user/project/branch/sub/directory v1.1.17
  81         hub.jazz.net/git/user/project v1.1.18
  82         hub.jazz.net/git/user/project/sub/directory v1.1.19
  83         k8s.io/kubernetes/subproject v1.1.101
  84         one.example.com/abitrary/repo v1.1.111
  85         two.example.com/abitrary/repo v0.0.2
  86         \"quoted.example.com/abitrary/repo\" v0.0.2
  87 )
  88
  89 replace two.example.com/abitrary/repo => github.com/corp/arbitrary-repo v0.0.2
  90
  91 replace (
  92         golang.org/x/sys => golang.org/x/sys v0.0.0-20190813064441-fde4db37ae7a // pinned to release-branch.go1.13
  93         golang.org/x/tools => golang.org/x/tools v0.0.0-20190821162956-65e3620a7ae7 // pinned to release-branch.go1.13
  94 )
  95
  96 ")
  97
  98 (define fixtures-go-check-test
  99   (let ((version
 100            "{\"Version\":\"v0.0.0-20201130134442-10cb98267c6c\",\"Time\":\"2020-11-30T13:44:42Z\"}")
 101         (go.mod
 102           "module gopkg.in/check.v1
 103
 104 go 1.11
 105
 106 require github.com/kr/pretty v0.2.1
 107 ")
 108         (go-get
 109            "<!DOCTYPE html>
 110 <html lang=\"en\" >
 111   <head>
 112     <meta charset=\"utf-8\">
 113   <link rel=\"dns-prefetch\" href=\"https://github.githubassets.com\">
 114     <script crossorigin=\"anonymous\" defer=\"defer\" integrity=\"sha512-aw5tciVT0IsECUmMuwp9ez60QReE2/yFNL1diLgZnOom6RhU8+0lG3RlAKto4JwbCoEP15E41Pksd7rK5BKfCQ==\" type=\"application/javascript\" src=\"https://github.githubassets.com/assets/topic-suggestions-6b0e6d72.js\"></script>
 115       <meta name=\"viewport\" content=\"width=device-width\">
 116
 117    <title>GitHub - go-check/check: Rich testing for the Go language</title>
 118    <meta name=\"description\" content=\"Rich testing for the Go language. Contribute to go-check/check development by creating an account on GitHub.\">
 119    <link rel=\"search\" type=\"application/opensearchdescription+xml\" href=\"/opensearch.xml\" title=\"GitHub\">
 120    <link rel=\"fluid-icon\" href=\"https://github.com/fluidicon.png\" title=\"GitHub\">
 121    <!-- To prevent page flashing, the optimizely JS needs to be loaded in the
 122                      <head> tag before the DOM renders -->
 123    <meta name=\"hostname\" content=\"github.com\">
 124    <meta name=\"user-login\" content=\"\">
 125    <link href=\"https://github.com/go-check/check/commits/v1.atom\" rel=\"alternate\" title=\"Recent Commits to check:v1\" type=\"application/atom+xml\">
 126    <meta name=\"go-import\" content=\"github.com/go-check/check git https://github.com/go-check/check.git\">
 127   </head>
 128   <body class=\"logged-out env-production page-responsive\" style=\"word-wrap: break-word;\">
 129   </body>
 130 </html>
 131 ")
 132         (pkg.go.dev "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n  <meta charset=\"utf-8\">\n</head>\n<body class=\"Site Site--wide Site--redesign\">\n  <div class=\"Site-content\">\n    <div class=\"Container\">\n      <div class=\"UnitDetails\" data-test-id=\"UnitDetails\">\n        <div class=\"UnitDetails-content js-unitDetailsContent\" role=\"main\" data-test-id=\"UnitDetails-content\">\n          <div class=\"UnitReadme js-readme\">\n            <h2 class=\"UnitReadme-title\" id=\"section-readme\"><img height=\"25px\" width=\"20px\" src=\"/static/img/pkg-icon-readme_20x16.svg\" alt=\"\">README</h2>\n            <div class=\"UnitReadme-content\" data-test-id=\"Unit-readmeContent\">\n              <div class=\"Overview-readmeContent js-readmeContent\">\n                <h3 class=\"h1\" id=\"readme-instructions\">Instructions</h3>\n                <p>Install the package with:</p>\n                <pre><code>go get gopkg.in/check.v1\n</code></pre>\n              </div>\n              <div class=\"UnitReadme-fadeOut\"></div>\n            </div>\n          </div>\n          <div class=\"UnitDoc\">\n            <h2 class=\"UnitDoc-title\" id=\"section-documentation\"><img height=\"25px\" width=\"20px\" src=\"/static/img/pkg-icon-doc_20x12.svg\" alt=\"\">Documentation</h2>\n            <div class=\"Documentation js-documentation\">\n              <div class=\"Documentation-content js-docContent\">\n                <section class=\"Documentation-overview\">\n                  <h3 tabindex=\"-1\" id=\"pkg-overview\" class=\"Documentation-overviewHeader\">Overview <a href=\"#pkg-overview\">¶</a></h3>\n                  <div role=\"navigation\" aria-label=\"Table of Contents\">\n                    <ul class=\"Documentation-toc\"></ul>\n                  </div>\n                  <p>Package check is a rich testing extension for Go's testing package.</p>\n                  <p>For details about the project, see:</p>\n                  <pre><a href=\"http://labix.org/gocheck\">http://labix.org/gocheck</a>\n</pre>\n                </section>\n                <h3 tabindex=\"-1\" id=\"pkg-constants\" class=\"Documentation-constantsHeader\">Constants <a href=\"#pkg-constants\">¶</a></h3>\n              </div>\n            </div>\n          </div>\n        </div>\n      </div>\n    </div>\n  </div>\n</body>\n</html>\n")
 133         (pkg.go.dev-licence "<!DOCTYPE html>\n<html lang=\"en\">\n<meta charset=\"utf-8\">\n<meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">\n<body class=\"Site Site--wide Site--redesign\">\n  <div class=\"Unit-content\" role=\"main\">\n    <section class=\"License\" id=\"lic-0\">\n      <h2><div id=\"#lic-0\">BSD-2-Clause</div></h2>\n      <p>This is not legal advice. <a href=\"/license-policy\">Read disclaimer.</a></p>\n      <pre class=\"License-contents\">Gocheck - A rich testing framework for Go\n \nCopyright line\n\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met: \n\n1. Redistributions of source code must retain the above copyright notice, this\n   list of conditions and the following disclaimer. \n2. Redistributions in binary form must reproduce the above copyright notice,\n   this list of conditions and the following disclaimer in the documentation\n   and/or other materials provided with the distribution. \n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &#34;AS IS&#34; AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR\nANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\nLOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\nON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n</pre>\n    </section>\n    <div class=\"License-source\">Source: github.com/go-check/check@v0.0.0-20201128035030-22ab2dfb190c/LICENSE</div>\n  </div>\n  </div>\n"))
 134     `(("https://proxy.golang.org/github.com/go-check/check/@v/v0.0.0-20201130134442-10cb98267c6c.mod"
 135        . ,go.mod)
 136       ("https://proxy.golang.org/github.com/go-check/check/@latest"
 137        . ,version)
 138       ("https://github.com/go-check/check?go-get=1"
 139        . ,go-get)
 140       ("https://pkg.go.dev/github.com/go-check/check"
 141        . ,pkg.go.dev)
 142       ("https://pkg.go.dev/github.com/go-check/check?tab=licenses"
 143        . ,pkg.go.dev-licence)
 144       ("https://proxy.golang.org/github.com/go-check/check/@v/list" . ""))))
 145
 146 (test-begin "go")
 147
 148 ;;; Unit tests for go build-system
 149
 150 (test-equal "go-version basic"
 151   "v1.0.2"
 152   (go-version->git-ref "v1.0.2"))
 153
 154 (test-equal "go-version with embedded git-ref"
 155   "65e3620a7ae7"
 156   (go-version->git-ref "v0.0.0-20190821162956-65e3620a7ae7"))
 157
 158 (test-equal "go-version with complex embedded git-ref"
 159   "daa7c04131f5"
 160   (go-version->git-ref "v1.2.4-0.20191109021931-daa7c04131f5"))
 161
 162 (test-assert "go-pseudo-version? multi-digit version number"
 163   (go-pseudo-version? "v1.23.1-0.20200526195155-81db48ad09cc"))
 164
 165 (test-assert "go-pseudo-version? semantic version with rc"
 166   (go-pseudo-version? "v1.4.0-rc.4.0.20200313231945-b860323f09d0"))
 167
 168 ;;; Unit tests for (guix import go)
 169
 170 (test-equal "go-path-escape"
 171   "github.com/!azure/!avere"
 172   ((@@ (guix import go) go-path-escape) "github.com/Azure/Avere"))
 173
 174
 175 ;; We define a function for all similar tests with different go.mod files
 176 (define (testing-parse-mod name expected input)
 177   (define (inf? p1 p2)
 178     (string<? (car p1) (car p2)))
 179   (test-equal name
 180     (sort expected inf?)
 181     (sort ((@@ (guix import go) parse-go.mod) input) inf?)))
 182
 183 (testing-parse-mod "parse-go.mod-simple"
 184                    '(("good/thing" "v1.4.5")
 185                      ("new/thing/v2" "v2.3.4")
 186                      ("other/thing" "v1.0.2"))
 187                    fixture-go-mod-simple)
 188
 189 (testing-parse-mod "parse-go.mod-with-block"
 190                    '(("A" "v1")
 191                      ("B" "v1.0.0")
 192                      ("C" "v1.0.0")
 193                      ("D" "v1.2.3")
 194                      ("E" "dev"))
 195                    fixture-go-mod-with-block)
 196
 197 (testing-parse-mod
 198  "parse-go.mod-complete"
 199  '(("github.com/corp/arbitrary-repo" "v0.0.2")
 200    ("quoted.example.com/abitrary/repo" "v0.0.2")
 201    ("one.example.com/abitrary/repo" "v1.1.111")
 202    ("hub.jazz.net/git/user/project/sub/directory" "v1.1.19")
 203    ("hub.jazz.net/git/user/project" "v1.1.18")
 204    ("launchpad.net/~user/project/branch/sub/directory" "v1.1.17")
 205    ("launchpad.net/~user/project/branch" "v1.1.16")
 206    ("launchpad.net/project/series/sub/directory" "v1.1.15")
 207    ("launchpad.net/project/series" "v1.1.14")
 208    ("launchpad.net/project" "v1.1.13")
 209    ("bitbucket.org/user/project/sub/directory" "v1.11.21")
 210    ("bitbucket.org/user/project" "v1.11.20")
 211    ("k8s.io/kubernetes/subproject" "v1.1.101")
 212    ("github.com/user/project/sub/directory" "v1.1.12")
 213    ("github.com/user/project" "v1.1.11")
 214    ("github.com/go-check/check" "v0.0.0-20140225173054-eb6ee6f84d0a"))
 215  fixture-go-mod-complete)
 216
 217 ;;; End-to-end tests for (guix import go)
 218 (define (mock-http-fetch testcase)
 219   (lambda (url . rest)
 220     (let ((body (assoc-ref testcase url)))
 221       (if body
 222           (open-input-string body)
 223           (error "mocked http-fetch Unexpected URL: " url)))))
 224
 225 (define (mock-http-get testcase)
 226   (lambda (url . rest)
 227     (let ((body (assoc-ref testcase url))
 228           (response-header
 229              (build-response
 230                 #:version '(1 . 1)
 231                 #:code 200
 232                 #:reason-phrase "Ok"
 233                 #:headers `(
 234                             (content-type text/html (charset . "utf-8"))
 235                             (date . ,(make-date 0 10 58 12 6 3 2021 0))
 236                             (transfer-encoding (chunked)))
 237                 #:port #f
 238                 #:validate-headers? #t)))
 239       (if body
 240           (values response-header body)
 241           (error "mocked http-get Unexpected URL: " url)))))
 242
 243 (test-equal "go-module->guix-package"
 244   '(package
 245      (name "go-github-com-go-check-check")
 246      (version "0.0.0-20201130134442-10cb98267c6c")
 247      (source
 248       (origin
 249         (method git-fetch)
 250         (uri (git-reference
 251               (url "https://github.com/go-check/check")
 252               (commit (go-version->git-ref version))))
 253         (file-name (git-file-name name version))
 254         (sha256
 255          (base32
 256           "0sjjj9z1dhilhpc8pq4154czrb79z9cm044jvn75kxcjv6v5l2m5"))))
 257      (build-system go-build-system)
 258      (arguments
 259       '(#:import-path "github.com/go-check/check"))
 260      (propagated-inputs
 261       `(("go-github-com-kr-pretty" ,go-github-com-kr-pretty)))
 262      (home-page "https://github.com/go-check/check")
 263      (synopsis "Instructions")
 264      (description "Package check is a rich testing extension for Go's testing \
 265 package.")
 266      (license license:bsd-2))
 267
 268   ;; Replace network resources with sample data.
 269   (call-with-temporary-directory
 270    (lambda (checkout)
 271      (mock ((web client) http-get
 272             (mock-http-get fixtures-go-check-test))
 273          (mock ((guix http-client) http-fetch
 274                 (mock-http-fetch fixtures-go-check-test))
 275              (mock ((guix git) update-cached-checkout
 276                     (lambda* (url #:key ref)
 277                       ;; Return an empty directory and its hash.
 278                       (values checkout
 279                               (nix-base32-string->bytevector
 280                                "0sjjj9z1dhilhpc8pq4154czrb79z9cm044jvn75kxcjv6v5l2m5")
 281                               #f)))
 282                  (go-module->guix-package "github.com/go-check/check")))))))
 283
 284 (test-end "go")