aboutsummaryrefslogtreecommitdiff
path: root/tests/go.scm
blob: a70a0ddbf572ffc8645d5d600ad188eb423fcd1d (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
2016-05-19
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2021 François Joulaud <francois.joulaud@radiofrance.com>
;;; Copyright © 2021 Sarah Morgensen <iskarian@mgsn.dev>
;;;
;;; 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/>.

;;; Summary
;; Tests for guix/import/go.scm

(define-module (tests-import-go)
  #:use-module (guix base32)
  #:use-module (guix build-system go)
  #:use-module (guix import go)
  #:use-module (guix base32)
  #:use-module ((guix utils) #:select (call-with-temporary-directory))
  #:use-module (guix tests)
  #:use-module (ice-9 match)
  #:use-module (srfi srfi-19)
  #:use-module (srfi srfi-64)
  #:use-module (web response))

(define go.mod-requirements
  (@@ (guix import go) go.mod-requirements))

(define parse-go.mod
  (@@ (guix import go) parse-go.mod))

(define fixture-go-mod-simple
  "module my/thing
go 1.12
require other/thing v1.0.2
require new/thing/v2 v2.3.4
exclude old/thing v1.2.3
replace bad/thing v1.4.5 => good/thing v1.4.5
")

(define fixture-go-mod-with-block
  "module M

require (
         A v1
         B v1.0.0
         C v1.0.0
         D v1.2.3
         E dev
)

exclude D v1.2.3
")

(define fixture-go-mod-complete
  "module M

go 1.13

replace github.com/myname/myproject/myapi => ./api

replace github.com/mymname/myproject/thissdk => ../sdk

replace launchpad.net/gocheck => github.com/go-check/check v0.0.0-20140225173054-eb6ee6f84d0a

require (
	github.com/user/project v1.1.11
	github.com/user/project/sub/directory v1.1.12
	bitbucket.org/user/project v1.11.20
	bitbucket.org/user/project/sub/directory v1.11.21
	launchpad.net/project v1.1.13
	launchpad.net/project/series v1.1.14
	launchpad.net/project/series/sub/directory v1.1.15
	launchpad.net/~user/project/branch v1.1.16
	launchpad.net/~user/project/branch/sub/directory v1.1.17
	hub.jazz.net/git/user/project v1.1.18
	hub.jazz.net/git/user/project/sub/directory v1.1.19
	k8s.io/kubernetes/subproject v1.1.101
	one.example.com/abitrary/repo v1.1.111
	two.example.com/abitrary/repo v0.0.2
	\"quoted.example.com/abitrary/repo\" v0.0.2
)

replace two.example.com/abitrary/repo => github.com/corp/arbitrary-repo v0.0.2

replace (
	golang.org/x/sys => golang.org/x/sys v0.0.0-20190813064441-fde4db37ae7a // pinned to release-branch.go1.13
	golang.org/x/tools => golang.org/x/tools v0.0.0-20190821162956-65e3620a7ae7 // pinned to release-branch.go1.13
)

")

(define fixture-go-mod-unparsable
  "module my/thing
go 1.12 // avoid feature X
require other/thing v1.0.2
// Security issue: CVE-XXXXX
exclude old/thing v1.2.3
new-directive another/thing yet-another/thing
replace (
        bad/thing v1.4.5 => good/thing v1.4.5
        // Unparseable
        bad/thing [v1.4.5, v1.9.7] => good/thing v2.0.0
)
")

(define fixture-go-mod-retract
  "retract v0.9.1

retract (
	v1.9.2
	[v1.0.0, v1.7.9]
)
")

(define fixture-go-mod-strings
  "require `example.com/\"some-repo\"` v1.9.3
require (
        `example.com/\"another.repo\"` v1.0.0
        \"example.com/special!repo\" v9.3.1
)
replace \"example.com/\\\"some-repo\\\"\" => `launchpad.net/some-repo` v1.9.3
replace (
        \"example.com/\\\"another.repo\\\"\" => launchpad.net/another-repo v1.0.0
)
")

(define fixtures-go-check-test
  (let ((version
           "{\"Version\":\"v0.0.0-20201130134442-10cb98267c6c\",\"Time\":\"2020-11-30T13:44:42Z\"}")
        (go.mod
          "module gopkg.in/check.v1

go 1.11

require github.com/kr/pretty v0.2.1
")
        (go-get
           "<!DOCTYPE html>
<html lang=\"en\" >
  <head>
    <meta charset=\"utf-8\">
  <link rel=\"dns-prefetch\" href=\"https://github.githubassets.com\">
    <script crossorigin=\"anonymous\" defer=\"defer\" integrity=\"sha512-aw5tciVT0IsECUmMuwp9ez60QReE2/yFNL1diLgZnOom6RhU8+0lG3RlAKto4JwbCoEP15E41Pksd7rK5BKfCQ==\" type=\"application/javascript\" src=\"https://github.githubassets.com/assets/topic-suggestions-6b0e6d72.js\"></script>
      <meta name=\"viewport\" content=\"width=device-width\">

   <title>GitHub - go-check/check: Rich testing for the Go language</title>
   <meta name=\"description\" content=\"Rich testing for the Go language. Contribute to go-check/check development by creating an account on GitHub.\">
   <link rel=\"search\" type=\"application/opensearchdescription+xml\" href=\"/opensearch.xml\" title=\"GitHub\">
   <link rel=\"fluid-icon\" href=\"https://github.com/fluidicon.png\" title=\"GitHub\">
   <!-- To prevent page flashing, the optimizely JS needs to be loaded in the
                     <head> tag before the DOM renders -->
   <meta name=\"hostname\" content=\"github.com\">
   <meta name=\"user-login\" content=\"\">
   <link href=\"https://github.com/go-check/check/commits/v1.atom\" rel=\"alternate\" title=\"Recent Commits to check:v1\" type=\"application/atom+xml\">
   <meta name=\"go-import\" content=\"github.com/go-check/check git https://github.com/go-check/check.git\">
  </head>
  <body class=\"logged-out env-production page-responsive\" style=\"word-wrap: break-word;\">
  </body>
</html>
")
        (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")
        (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"))
    `(("https://proxy.golang.org/github.com/go-check/check/@v/v0.0.0-20201130134442-10cb98267c6c.mod"
       . ,go.mod)
      ("https://proxy.golang.org/github.com/go-check/check/@latest"
       . ,version)
      ("https://github.com/go-check/check?go-get=1"
       . ,go-get)
      ("https://pkg.go.dev/github.com/go-check/check"
       . ,pkg.go.dev)
      ("https://pkg.go.dev/github.com/go-check/check?tab=licenses"
       . ,pkg.go.dev-licence)
      ("https://proxy.golang.org/github.com/go-check/check/@v/list" . ""))))

(test-begin "go")

;;; Unit tests for go build-system

(test-equal "go-version basic"
  "v1.0.2"
  (go-version->git-ref "v1.0.2"))

(test-equal "go-version with embedded git-ref"
  "65e3620a7ae7"
  (go-version->git-ref "v0.0.0-20190821162956-65e3620a7ae7"))

(test-equal "go-version with complex embedded git-ref"
  "daa7c04131f5"
  (go-version->git-ref "v1.2.4-0.20191109021931-daa7c04131f5"))

(test-assert "go-pseudo-version? multi-digit version number"
  (go-pseudo-version? "v1.23.1-0.20200526195155-81db48ad09cc"))

(test-assert "go-pseudo-version? semantic version with rc"
  (go-pseudo-version? "v1.4.0-rc.4.0.20200313231945-b860323f09d0"))

;;; Unit tests for (guix import go)

(test-equal "go-path-escape"
  "github.com/!azure/!avere"
  ((@@ (guix import go) go-path-escape) "github.com/Azure/Avere"))


;; We define a function for all similar tests with different go.mod files
(define (testing-parse-mod name expected input)
  (define (inf? p1 p2)
    (string<? (car p1) (car p2)))
  (test-equal name
    (sort expected inf?)
    (sort (go.mod-requirements (parse-go.mod input)) inf?)))

(testing-parse-mod "parse-go.mod-simple"
                   '(("good/thing" "v1.4.5")
                     ("new/thing/v2" "v2.3.4")
                     ("other/thing" "v1.0.2"))
                   fixture-go-mod-simple)

(testing-parse-mod "parse-go.mod-with-block"
                   '(("A" "v1")
                     ("B" "v1.0.0")
                     ("C" "v1.0.0")
                     ("D" "v1.2.3")
                     ("E" "dev"))
                   fixture-go-mod-with-block)

(testing-parse-mod
 "parse-go.mod-complete"
 '(("github.com/corp/arbitrary-repo" "v0.0.2")
   ("quoted.example.com/abitrary/repo" "v0.0.2")
   ("one.example.com/abitrary/repo" "v1.1.111")
   ("hub.jazz.net/git/user/project/sub/directory" "v1.1.19")
   ("hub.jazz.net/git/user/project" "v1.1.18")
   ("launchpad.net/~user/project/branch/sub/directory" "v1.1.17")
   ("launchpad.net/~user/project/branch" "v1.1.16")
   ("launchpad.net/project/series/sub/directory" "v1.1.15")
   ("launchpad.net/project/series" "v1.1.14")
   ("launchpad.net/project" "v1.1.13")
   ("bitbucket.org/user/project/sub/directory" "v1.11.21")
   ("bitbucket.org/user/project" "v1.11.20")
   ("k8s.io/kubernetes/subproject" "v1.1.101")
   ("github.com/user/project/sub/directory" "v1.1.12")
   ("github.com/user/project" "v1.1.11")
   ("github.com/go-check/check" "v0.0.0-20140225173054-eb6ee6f84d0a"))
 fixture-go-mod-complete)

(test-equal "parse-go.mod: simple"
  `((module (module-path "my/thing"))
    (go (version "1.12"))
    (require (module-path "other/thing") (version "v1.0.2"))
    (require (module-path "new/thing/v2") (version "v2.3.4"))
    (exclude (module-path "old/thing") (version "v1.2.3"))
    (replace (original (module-path "bad/thing") (version "v1.4.5"))
      (with (module-path "good/thing") (version "v1.4.5"))))
  (parse-go.mod fixture-go-mod-simple))

(test-equal "parse-go.mod: comments and unparsable lines"
  `((module (module-path "my/thing"))
    (go (version "1.12") (comment "avoid feature X"))
    (require (module-path "other/thing") (version "v1.0.2"))
    (comment "Security issue: CVE-XXXXX")
    (exclude (module-path "old/thing") (version "v1.2.3"))
    (unknown "new-directive another/thing yet-another/thing")
    (replace (original (module-path "bad/thing") (version "v1.4.5"))
      (with (module-path "good/thing") (version "v1.4.5")))
    (comment "Unparseable")
    (unknown "bad/thing [v1.4.5, v1.9.7] => good/thing v2.0.0"))
  (parse-go.mod fixture-go-mod-unparsable))

(test-equal "parse-go.mod: retract"
  `((retract (version "v0.9.1"))
    (retract (version "v1.9.2"))
    (retract (range (version "v1.0.0") (version "v1.7.9"))))
  (parse-go.mod fixture-go-mod-retract))

(test-equal "parse-go.mod: raw strings and quoted strings"
  `((require (module-path "example.com/\"some-repo\"") (version "v1.9.3"))
    (require (module-path "example.com/\"another.repo\"") (version "v1.0.0"))
    (require (module-path "example.com/special!repo") (version "v9.3.1"))
    (replace (original (module-path "example.com/\"some-repo\""))
      (with (module-path "launchpad.net/some-repo") (version "v1.9.3")))
    (replace (original (module-path "example.com/\"another.repo\""))
      (with (module-path "launchpad.net/another-repo") (version "v1.0.0"))))
  (parse-go.mod fixture-go-mod-strings))

(test-equal "parse-go.mod: complete"
  `((module (module-path "M"))
    (go (version "1.13"))
    (replace (original (module-path "github.com/myname/myproject/myapi"))
      (with (file-path "./api")))
    (replace (original (module-path "github.com/mymname/myproject/thissdk"))
      (with (file-path "../sdk")))
    (replace (original (module-path "launchpad.net/gocheck"))
      (with (module-path "github.com/go-check/check")
            (version "v0.0.0-20140225173054-eb6ee6f84d0a")))
    (require (module-path "github.com/user/project")
             (version "v1.1.11"))
    (require (module-path "github.com/user/project/sub/directory")
             (version "v1.1.12"))
    (require (module-path "bitbucket.org/user/project")
             (version "v1.11.20"))
    (require (module-path "bitbucket.org/user/project/sub/directory")
             (version "v1.11.21"))
    (require (module-path "launchpad.net/project")
             (version "v1.1.13"))
    (require (module-path "launchpad.net/project/series")
             (version "v1.1.14"))
    (require (module-path "launchpad.net/project/series/sub/directory")
             (version "v1.1.15"))
    (require (module-path "launchpad.net/~user/project/branch")
             (version "v1.1.16"))
    (require (module-path "launchpad.net/~user/project/branch/sub/directory")
             (version "v1.1.17"))
    (require (module-path "hub.jazz.net/git/user/project")
             (version "v1.1.18"))
    (require (module-path "hub.jazz.net/git/user/project/sub/directory")
             (version "v1.1.19"))
    (require (module-path "k8s.io/kubernetes/subproject")
             (version "v1.1.101"))
    (require (module-path "one.example.com/abitrary/repo")
             (version "v1.1.111"))
    (require (module-path "two.example.com/abitrary/repo")
             (version "v0.0.2"))
    (require (module-path "quoted.example.com/abitrary/repo")
             (version "v0.0.2"))
    (replace (original (module-path "two.example.com/abitrary/repo"))
      (with (module-path "github.com/corp/arbitrary-repo")
            (version "v0.0.2")))
    (replace (original (module-path "golang.org/x/sys"))
      (with (module-path "golang.org/x/sys")
            (version "v0.0.0-20190813064441-fde4db37ae7a"))
      (comment "pinned to release-branch.go1.13"))
    (replace (original (module-path "golang.org/x/tools"))
      (with (module-path "golang.org/x/tools")
            (version "v0.0.0-20190821162956-65e3620a7ae7"))
      (comment "pinned to release-branch.go1.13")))
  (parse-go.mod fixture-go-mod-complete))

;;; End-to-end tests for (guix import go)
(define (mock-http-fetch testcase)
  (lambda (url . rest)
    (let ((body (assoc-ref testcase url)))
      (if body
          (open-input-string body)
          (error "mocked http-fetch Unexpected URL: " url)))))

(define (mock-http-get testcase)
  (lambda (url . rest)
    (let ((body (assoc-ref testcase url))
          (response-header
             (build-response
                #:version '(1 . 1)
                #:code 200
                #:reason-phrase "Ok"
                #:headers `(
                            (content-type text/html (charset . "utf-8"))
                            (date . ,(make-date 0 10 58 12 6 3 2021 0))
                            (transfer-encoding (chunked)))
                #:port #f
                #:validate-headers? #t)))
      (if body
          (values response-header body)
          (error "mocked http-get Unexpected URL: " url)))))

(test-equal "go-module->guix-package"
  '(package
     (name "go-github-com-go-check-check")
     (version "0.0.0-20201130134442-10cb98267c6c")
     (source
      (origin
        (method git-fetch)
        (uri (git-reference
              (url "https://github.com/go-check/check")
              (commit (go-version->git-ref version))))
        (file-name (git-file-name name version))
        (sha256
         (base32
          "0sjjj9z1dhilhpc8pq4154czrb79z9cm044jvn75kxcjv6v5l2m5"))))
     (build-system go-build-system)
     (arguments
      '(#:import-path "github.com/go-check/check"))
     (propagated-inputs
      `(("go-github-com-kr-pretty" ,go-github-com-kr-pretty)))
     (home-page "https://github.com/go-check/check")
     (synopsis "Instructions")
     (description "Package check is a rich testing extension for Go's testing \
package.")
     (license license:bsd-2))

  ;; Replace network resources with sample data.
  (call-with-temporary-directory
   (lambda (checkout)
     (mock ((web client) http-get
            (mock-http-get fixtures-go-check-test))
         (mock ((guix http-client) http-fetch
                (mock-http-fetch fixtures-go-check-test))
             (mock ((guix git) update-cached-checkout
                    (lambda* (url #:key ref)
                      ;; Return an empty directory and its hash.
                      (values checkout
                              (nix-base32-string->bytevector
                               "0sjjj9z1dhilhpc8pq4154czrb79z9cm044jvn75kxcjv6v5l2m5")
                              #f)))
                 (go-module->guix-package* "github.com/go-check/check")))))))

(test-end "go")