1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org>
4 ;;; This file is part of GNU Guix.
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.
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.
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/>.
19 (define-module (guix tests)
20 #:use-module ((guix config) #:select (%storedir %localstatedir))
21 #:use-module (guix store)
22 #:use-module (guix derivations)
23 #:use-module (guix packages)
24 #:use-module (guix base32)
25 #:use-module (guix serialization)
26 #:use-module (gcrypt hash)
27 #:use-module (guix build-system gnu)
28 #:use-module (gnu packages bootstrap)
29 #:use-module (srfi srfi-34)
30 #:use-module (srfi srfi-64)
31 #:use-module (rnrs bytevectors)
32 #:use-module (ice-9 binary-ports)
33 #:use-module (web uri)
34 #:export (open-connection-for-tests
47 with-derivation-narinfo
48 with-derivation-substitute
54 ;;; This module provide shared infrastructure for the test suite. For
55 ;;; internal use only.
59 (define %test-substitute-urls
60 ;; URLs where to look for substitutes during tests.
62 (or (and=> (getenv "GUIX_BINARY_SUBSTITUTE_URL") list)
65 (define* (open-connection-for-tests #:optional (uri (%daemon-socket-uri)))
66 "Open a connection to the build daemon for tests purposes and return it."
67 (guard (c ((store-error? c)
68 (format (current-error-port)
69 "warning: build daemon error: ~s~%" c)
71 (let ((store (open-connection uri)))
72 ;; Make sure we build everything by ourselves.
73 (set-build-options store
75 #:substitute-urls (%test-substitute-urls))
77 ;; Use the bootstrap Guile when running tests, so we don't end up
78 ;; building everything in the temporary test store.
79 (%guile-for-build (package-derivation store %bootstrap-guile))
83 (define (call-with-external-store proc)
84 "Call PROC with an open connection to the external store or #f it there is
85 no external store to talk to."
86 (parameterize ((%daemon-socket-uri
87 (string-append %localstatedir
88 "/guix/daemon-socket/socket"))
89 (%store-prefix %storedir))
99 ;; Since we're using a different store we must clear the
100 ;; package-derivation cache.
101 (hash-clear! (@@ (guix packages) %derivation-cache))
106 (close-connection store))))))
108 (define-syntax-rule (with-external-store store exp ...)
109 "Evaluate EXP with STORE bound to the external store rather than the
110 temporary test store, or #f if there is no external store to talk to.
112 This is meant to be used for tests that need to build packages that would be
113 too expensive to build entirely in the test store."
114 (call-with-external-store (lambda (store) exp ...)))
116 (define (random-seed)
117 (or (and=> (getenv "GUIX_TESTS_RANDOM_SEED")
119 (logxor (getpid) (car (gettimeofday)))))
122 (let ((seed (random-seed)))
123 (format (current-error-port) "random seed for tests: ~a~%"
125 (seed->random-state seed)))
127 (define (random-text)
128 "Return the hexadecimal representation of a random number."
129 (number->string (random (expt 2 256) %seed) 16))
131 (define (random-bytevector n)
132 "Return a random bytevector of N bytes."
133 (let ((bv (make-bytevector n)))
137 (bytevector-u8-set! bv i (random 256 %seed))
142 "Return true if files A and B have the same type and same content."
143 (and (eq? (stat:type (lstat a)) (stat:type (lstat b)))
144 (case (stat:type (lstat a))
147 (call-with-input-file a get-bytevector-all)
148 (call-with-input-file b get-bytevector-all)))
150 (string=? (readlink a) (readlink b)))
152 (error "what?" (lstat a))))))
154 (define (canonical-file? file)
155 "Return #t if FILE is in the store, is read-only, and its mtime is 1."
156 (let ((st (lstat file)))
157 (or (not (string-prefix? (%store-prefix) file))
158 (eq? 'symlink (stat:type st))
159 (and (= 1 (stat:mtime st))
160 (zero? (logand #o222 (stat:mode st)))))))
162 (define (network-reachable?)
163 "Return true if we can reach the Internet."
164 (false-if-exception (getaddrinfo "www.gnu.org" "80" AI_NUMERICSERV)))
166 (define-syntax-rule (mock (module proc replacement) body ...)
167 "Within BODY, replace the definition of PROC from MODULE with the definition
168 given by REPLACEMENT."
169 (let* ((m (resolve-module 'module))
170 (original (module-ref m 'proc)))
172 (lambda () (module-set! m 'proc replacement))
174 (lambda () (module-set! m 'proc original)))))
176 (define-syntax-rule (test-assertm name exp)
177 "Like 'test-assert', but EXP is a monadic value. A new connection to the
180 (let ((store (open-connection-for-tests)))
184 (run-with-store store exp
185 #:guile-for-build (%guile-for-build)))
187 (close-connection store))))))
189 (define-syntax-rule (test-equalm name value exp)
190 "Like 'test-equal', but EXP is a monadic value. A new connection to the
195 (run-with-store store exp
196 #:guile-for-build (%guile-for-build)))))
200 ;;; Narinfo files, as used by the substituter.
203 (define* (derivation-narinfo drv #:key (nar "example.nar")
204 (sha256 (make-bytevector 32 0))
206 "Return the contents of the narinfo corresponding to DRV, with the specified
207 REFERENCES (a list of store items); NAR should be the file name of the archive
208 containing the substitute for DRV, and SHA256 is the expected hash."
209 (format #f "StorePath: ~a
217 (derivation->output-path drv) ; StorePath
219 (bytevector->nix-base32-string sha256) ; NarHash
220 (string-join (map basename references)) ; References
221 (derivation-system drv) ; System
223 (derivation-file-name drv)))) ; Deriver
225 (define %substitute-directory
227 (and=> (getenv "GUIX_BINARY_SUBSTITUTE_URL")
228 (compose uri-path string->uri))))
230 (define* (call-with-derivation-narinfo drv thunk
232 (sha256 (make-bytevector 32 0))
234 "Call THUNK in a context where fake substituter data, as read by 'guix
235 substitute', has been installed for DRV. SHA256 is the hash of the
236 expected output of DRV."
237 (let* ((output (derivation->output-path drv))
238 (dir (%substitute-directory))
239 (info (string-append dir "/nix-cache-info"))
240 (narinfo (string-append dir "/" (store-path-hash-part output)
244 (call-with-output-file info
246 (format p "StoreDir: ~a\nWantMassQuery: 0\n"
248 (call-with-output-file narinfo
250 (display (derivation-narinfo drv #:sha256 sha256
251 #:references references)
255 (delete-file narinfo)
256 (delete-file info)))))
258 (define-syntax with-derivation-narinfo
259 (syntax-rules (sha256 references =>)
260 "Evaluate BODY in a context where DRV looks substitutable from the
261 substituter's viewpoint."
262 ((_ drv (sha256 => hash) (references => refs) body ...)
263 (call-with-derivation-narinfo drv
267 ((_ drv (sha256 => hash) body ...)
268 (with-derivation-narinfo drv
269 (sha256 => hash) (references => '())
272 (call-with-derivation-narinfo drv
276 (define* (call-with-derivation-substitute drv contents thunk
280 "Call THUNK in a context where a substitute for DRV has been installed,
281 using CONTENTS, a string, as its contents. If SHA256 is true, use it as the
282 expected hash of the substitute; otherwise use the hash of the nar containing
284 (define dir (%substitute-directory))
287 (call-with-output-file (string-append dir "/example.out")
289 (display contents port)))
290 (call-with-output-file (string-append dir "/example.nar")
292 (write-file (string-append dir "/example.out") p))))
294 (let ((hash (call-with-input-file (string-append dir "/example.nar")
296 ;; Create fake substituter data, to be read by 'guix substitute'.
297 (call-with-derivation-narinfo drv
299 #:sha256 (or sha256 hash)
300 #:references references)))
302 (delete-file (string-append dir "/example.out"))
303 (delete-file (string-append dir "/example.nar")))))
305 (define (shebang-too-long?)
306 "Return true if the typical shebang in the current store would exceed
307 Linux's static limit---the BINPRM_BUF_SIZE constant, normally 128 characters
310 (string-append "#!" (%store-prefix) "/"
312 "-bootstrap-binaries-0/bin/bash\0"))
314 (> (string-length shebang) 128))
316 (define-syntax with-derivation-substitute
317 (syntax-rules (sha256 references =>)
318 "Evaluate BODY in a context where DRV is substitutable with the given
320 ((_ drv contents (sha256 => hash) (references => refs) body ...)
321 (call-with-derivation-substitute drv contents
325 ((_ drv contents (sha256 => hash) body ...)
326 (with-derivation-substitute drv contents
327 (sha256 => hash) (references => '())
329 ((_ drv contents body ...)
330 (call-with-derivation-substitute drv contents
334 (define-syntax-rule (dummy-package name* extra-fields ...)
335 "Return a \"dummy\" package called NAME*, with all its compulsory fields
336 initialized with default values, and with EXTRA-FIELDS set as specified."
338 (name name*) (version "0") (source #f)
339 (build-system gnu-build-system)
340 (synopsis #f) (description #f)
341 (home-page #f) (license #f))))
342 (package (inherit p) extra-fields ...)))
344 (define-syntax-rule (dummy-origin extra-fields ...)
345 "Return a \"dummy\" origin, with all its compulsory fields initialized with
346 default values, and with EXTRA-FIELDS set as specified."
347 (let ((o (origin (method #f) (uri "http://www.example.com")
348 (sha256 (base32 (make-string 52 #\x))))))
349 (origin (inherit o) extra-fields ...)))
352 ;; eval: (put 'call-with-derivation-narinfo 'scheme-indent-function 1)
353 ;; eval: (put 'call-with-derivation-substitute 'scheme-indent-function 2)
356 ;;; tests.scm ends here