1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2018 Ricardo Wurmus <rekado@elephly.net>
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 (test-channels)
20 #:use-module (guix channels)
21 #:use-module (guix profiles)
22 #:use-module ((guix build syscalls) #:select (mkdtemp!))
23 #:use-module (guix tests)
24 #:use-module (guix store)
25 #:use-module ((guix grafts) #:select (%graft?))
26 #:use-module (guix derivations)
27 #:use-module (guix sets)
28 #:use-module (guix gexp)
29 #:use-module ((guix utils)
30 #:select (error-location? error-location location-line))
31 #:use-module ((guix build utils) #:select (which))
33 #:use-module (guix git)
34 #:use-module (guix git-authenticate)
35 #:use-module (guix openpgp)
36 #:use-module (guix tests git)
37 #:use-module (guix tests gnupg)
38 #:use-module (srfi srfi-1)
39 #:use-module (srfi srfi-26)
40 #:use-module (srfi srfi-34)
41 #:use-module (srfi srfi-35)
42 #:use-module (srfi srfi-64)
43 #:use-module (rnrs bytevectors)
44 #:use-module (rnrs io ports)
45 #:use-module (ice-9 control)
46 #:use-module (ice-9 match))
48 (define (gpg+git-available?)
49 (and (which (git-command))
50 (which (gpg-command)) (which (gpgconf-command))))
52 (define commit-id-string
53 (compose oid->string commit-id))
56 (test-begin "channels")
58 (define* (make-instance #:key
62 (define instance-dir (mkdtemp! "/tmp/checkout.XXXXXX"))
64 (call-with-output-file (string-append instance-dir "/.guix-channel")
65 (lambda (port) (write spec port))))
66 (checkout->channel-instance instance-dir
70 (define instance--boring (make-instance))
71 (define instance--unsupported-version
73 '(channel (version 42) (dependencies whatever))))
74 (define instance--no-deps
76 '(channel (version 0))))
77 (define instance--sub-directory
79 '(channel (version 0) (directory "modules"))))
80 (define instance--simple
87 (url "https://example.com/test-channel"))))))
88 (define instance--with-dupes
95 (url "https://example.com/test-channel"))
98 (url "https://example.com/test-channel")
102 (url "https://example.com/test-channel-elsewhere"))))))
104 (define channel-instance-metadata
105 (@@ (guix channels) channel-instance-metadata))
106 (define channel-metadata-directory
107 (@@ (guix channels) channel-metadata-directory))
108 (define channel-metadata-dependencies
109 (@@ (guix channels) channel-metadata-dependencies))
112 (test-equal "channel-instance-metadata returns default if .guix-channel does not exist"
114 (let ((metadata (channel-instance-metadata instance--boring)))
115 (list (channel-metadata-directory metadata)
116 (channel-metadata-dependencies metadata))))
118 (test-equal "channel-instance-metadata and default dependencies"
120 (channel-metadata-dependencies (channel-instance-metadata instance--no-deps)))
122 (test-equal "channel-instance-metadata and directory"
124 (channel-metadata-directory
125 (channel-instance-metadata instance--sub-directory)))
127 (test-equal "channel-instance-metadata rejects unsupported version"
128 1 ;line number in the generated '.guix-channel'
129 (guard (c ((and (message-condition? c) (error-location? c))
130 (location-line (error-location c))))
131 (channel-instance-metadata instance--unsupported-version)))
133 (test-assert "channel-instance-metadata returns <channel-metadata>"
134 (every (@@ (guix channels) channel-metadata?)
135 (map channel-instance-metadata
136 (list instance--no-deps
138 instance--with-dupes))))
140 (test-assert "channel-instance-metadata dependencies are channels"
141 (let ((deps ((@@ (guix channels) channel-metadata-dependencies)
142 (channel-instance-metadata instance--simple))))
144 (((? channel? dep)) #t)
147 (test-assert "latest-channel-instances includes channel dependencies"
148 (let* ((channel (channel
151 (test-dir (channel-instance-checkout instance--simple)))
152 (mock ((guix git) update-cached-checkout
153 (lambda* (url #:key ref starting-commit)
155 ("test" (values test-dir "caf3cabba9e" #f))
156 (_ (values (channel-instance-checkout instance--no-deps)
159 (let ((instances (latest-channel-instances store (list channel))))
160 (and (eq? 2 (length instances))
163 (map (compose channel-name channel-instance-channel)
166 (test-assert "latest-channel-instances excludes duplicate channel dependencies"
167 (let* ((channel (channel
170 (test-dir (channel-instance-checkout instance--with-dupes)))
171 (mock ((guix git) update-cached-checkout
172 (lambda* (url #:key ref starting-commit)
174 ("test" (values test-dir "caf3cabba9e" #f))
175 (_ (values (channel-instance-checkout instance--no-deps)
178 (let ((instances (latest-channel-instances store (list channel))))
179 (and (= 2 (length instances))
182 (map (compose channel-name channel-instance-channel)
184 ;; only the most specific channel dependency should remain,
185 ;; i.e. the one with a specified commit.
186 (find (lambda (instance)
187 (and (eq? (channel-name
188 (channel-instance-channel instance))
190 (string=? (channel-commit
191 (channel-instance-channel instance))
195 (unless (which (git-command)) (test-skip 1))
196 (test-equal "latest-channel-instances #:validate-pull"
199 ;; Make sure the #:validate-pull procedure receives the right values.
201 (with-temporary-git-repository directory
203 (commit "first commit")
205 (commit "second commit"))
206 (with-repository directory repository
207 (let* ((commit1 (find-commit repository "first"))
208 (commit2 (find-commit repository "second"))
209 (spec (channel (url (string-append "file://" directory))
211 (new (channel (inherit spec)
212 (commit (oid->string (commit-id commit2)))))
213 (old (channel (inherit spec)
214 (commit (oid->string (commit-id commit1))))))
215 (define (validate-pull channel current commit relation)
216 (return (and (eq? channel old)
217 (string=? (oid->string (commit-id commit2))
219 (string=? (oid->string (commit-id commit1))
224 ;; Attempt a downgrade from NEW to OLD.
225 (latest-channel-instances store (list old)
226 #:current-channels (list new)
227 #:validate-pull validate-pull)))))))
229 (test-assert "channel-instances->manifest"
230 ;; Compute the manifest for a graph of instances and make sure we get a
231 ;; derivation graph that mirrors the instance graph. This test also ensures
232 ;; we don't try to access Git repositores at all at this stage.
233 (let* ((spec (lambda deps
234 `(channel (version 0)
239 (url "http://example.org")))
241 (guix (make-instance #:name 'guix))
242 (instance0 (make-instance #:name 'a))
243 (instance1 (make-instance #:name 'b #:spec (spec 'a)))
244 (instance2 (make-instance #:name 'c #:spec (spec 'b)))
245 (instance3 (make-instance #:name 'd #:spec (spec 'c 'a))))
246 (%graft? #f) ;don't try to build stuff
248 ;; Create 'build-self.scm' so that GUIX is recognized as the 'guix' channel.
249 (let ((source (channel-instance-checkout guix)))
250 (mkdir (string-append source "/build-aux"))
251 (call-with-output-file (string-append source
252 "/build-aux/build-self.scm")
255 (use-modules (guix) (gnu packages bootstrap))
258 (package->derivation %bootstrap-guile)))
264 (run-with-store store
265 (channel-instances->manifest (list guix
267 instance2 instance3))))
270 (manifest-entries manifest))
272 (define (depends? drv in out)
273 ;; Return true if DRV depends (directly or indirectly) on all of IN
275 (let ((set (list->set
277 (list (derivation-file-name drv)))))
278 (in (map derivation-file-name in))
279 (out (map derivation-file-name out)))
280 (and (every (cut set-contains? set <>) in)
281 (not (any (cut set-contains? set <>) out)))))
283 (define (lookup name)
284 (run-with-store store
287 (manifest-lookup manifest
288 (manifest-pattern (name name)))))))
290 (let ((drv-guix (lookup "guix"))
295 (and (depends? drv-guix '() (list drv0 drv1 drv2 drv3))
297 (list) (list drv1 drv2 drv3))
299 (list drv0) (list drv2 drv3))
301 (list drv1) (list drv3))
303 (list drv2 drv0) (list))))))))
305 (unless (which (git-command)) (test-skip 1))
306 (test-equal "channel-news, no news"
308 (with-temporary-git-repository directory
310 (commit "the commit"))
311 (with-repository directory repository
312 (let ((channel (channel (url (string-append "file://" directory))
314 (latest (reference-name->oid repository "HEAD")))
315 (channel-news-for-commit channel (oid->string latest))))))
317 (unless (which (git-command)) (test-skip 1))
318 (test-assert "channel-news, one entry"
319 (with-temporary-git-repository directory
320 `((add ".guix-channel"
322 '(channel (version 0)
323 (news-file "news.scm"))))
324 (commit "first commit")
325 (add "src/a.txt" "A")
326 (commit "second commit")
327 (tag "tag-for-first-news-entry")
329 ,(lambda (repository)
331 (reference-name->oid repository "HEAD")))
335 (entry (commit ,(oid->string previous))
336 (title (en "New file!")
337 (eo "Nova dosiero!"))
338 (body (en "Yeah, a.txt."))))))))
339 (commit "third commit")
340 (add "src/b.txt" "B")
341 (commit "fourth commit")
343 ,(lambda (repository)
346 (find-commit repository "second commit")))
348 (reference-name->oid repository "HEAD")))
352 (entry (commit ,(oid->string previous))
353 (title (en "Another file!"))
354 (body (en "Yeah, b.txt.")))
355 (entry (tag "tag-for-first-news-entry")
356 (title (en "Old news.")
358 (body (en "For a.txt"))))))))
359 (commit "fifth commit"))
360 (with-repository directory repository
361 (define (find-commit* message)
362 (oid->string (commit-id (find-commit repository message))))
364 (let ((channel (channel (url (string-append "file://" directory))
366 (commit1 (find-commit* "first commit"))
367 (commit2 (find-commit* "second commit"))
368 (commit3 (find-commit* "third commit"))
369 (commit4 (find-commit* "fourth commit"))
370 (commit5 (find-commit* "fifth commit")))
371 ;; First try fetching all the news up to a given commit.
372 (and (null? (channel-news-for-commit channel commit2))
374 (map channel-news-entry-commit
375 (channel-news-for-commit channel commit5))
376 (list commit2 commit4))
378 (map channel-news-entry-title
379 (channel-news-for-commit channel commit5))
380 '((("en" . "Another file!"))
381 (("en" . "Old news.") ("eo" . "Malnovaĵoj."))))
383 (map channel-news-entry-commit
384 (channel-news-for-commit channel commit3))
387 ;; Now fetch news entries that apply to a commit range.
389 (map channel-news-entry-commit
390 (channel-news-for-commit channel commit3 commit1))
393 (map channel-news-entry-commit
394 (channel-news-for-commit channel commit5 commit3))
397 (map channel-news-entry-commit
398 (channel-news-for-commit channel commit5 commit1))
399 (list commit4 commit2))
401 (map channel-news-entry-tag
402 (channel-news-for-commit channel commit5 commit1))
403 '(#f "tag-for-first-news-entry")))))))
405 (unless (which (git-command)) (test-skip 1))
406 (test-assert "latest-channel-instances, missing introduction for 'guix'"
407 (with-temporary-git-repository directory
409 (commit "first commit")
411 (commit "second commit"))
412 (with-repository directory repository
413 (let* ((commit1 (find-commit repository "first"))
414 (commit2 (find-commit repository "second"))
415 (channel (channel (url (string-append "file://" directory))
418 (guard (c ((message-condition? c)
419 (->bool (string-contains (condition-message c)
422 ;; Attempt a downgrade from NEW to OLD.
423 (latest-channel-instances store (list channel))
426 (unless (gpg+git-available?) (test-skip 1))
427 (test-equal "authenticate-channel, wrong first commit signer"
429 (with-fresh-gnupg-setup (list %ed25519-public-key-file
430 %ed25519-secret-key-file
431 %ed25519bis-public-key-file
432 %ed25519bis-secret-key-file)
433 (with-temporary-git-repository directory
434 `((add ".guix-channel"
436 '(channel (version 0)
437 (keyring-reference "master"))))
438 (add ".guix-authorizations"
440 `(authorizations (version 0)
442 %ed25519-public-key-file)
443 (name "Charlie"))))))
444 (add "signer.key" ,(call-with-input-file %ed25519-public-key-file
446 (commit "first commit"
447 (signer ,(key-fingerprint %ed25519-public-key-file)))
448 (add "random" ,(random-text))
449 (commit "second commit"
450 (signer ,(key-fingerprint %ed25519-public-key-file))))
451 (with-repository directory repository
452 (let* ((commit1 (find-commit repository "first"))
453 (commit2 (find-commit repository "second"))
454 (intro (make-channel-introduction
455 (commit-id-string commit1)
456 (openpgp-public-key-fingerprint
458 %ed25519bis-public-key-file)))) ;different key
459 (channel (channel (name 'example)
460 (url (string-append "file://" directory))
461 (introduction intro))))
462 (guard (c ((message-condition? c)
463 (->bool (string-contains (condition-message c)
465 (authenticate-channel channel directory
466 (commit-id-string commit2)
467 #:keyring-reference-prefix "")
470 (unless (gpg+git-available?) (test-skip 1))
471 (test-assert "authenticate-channel, .guix-authorizations"
472 (with-fresh-gnupg-setup (list %ed25519-public-key-file
473 %ed25519-secret-key-file
474 %ed25519bis-public-key-file
475 %ed25519bis-secret-key-file)
476 (with-temporary-git-repository directory
477 `((add ".guix-channel"
479 '(channel (version 0)
480 (keyring-reference "channel-keyring"))))
481 (add ".guix-authorizations"
483 `(authorizations (version 0)
485 %ed25519-public-key-file)
486 (name "Charlie"))))))
487 (commit "zeroth commit")
489 (commit "first commit"
490 (signer ,(key-fingerprint %ed25519-public-key-file)))
492 (commit "second commit"
493 (signer ,(key-fingerprint %ed25519-public-key-file)))
495 (commit "third commit"
496 (signer ,(key-fingerprint %ed25519bis-public-key-file)))
497 (branch "channel-keyring")
498 (checkout "channel-keyring")
499 (add "signer.key" ,(call-with-input-file %ed25519-public-key-file
501 (add "other.key" ,(call-with-input-file %ed25519bis-public-key-file
503 (commit "keyring commit")
505 (with-repository directory repository
506 (let* ((commit1 (find-commit repository "first"))
507 (commit2 (find-commit repository "second"))
508 (commit3 (find-commit repository "third"))
509 (intro (make-channel-introduction
510 (commit-id-string commit1)
511 (openpgp-public-key-fingerprint
513 %ed25519-public-key-file))))
514 (channel (channel (name 'example)
515 (url (string-append "file://" directory))
516 (introduction intro))))
517 ;; COMMIT1 and COMMIT2 are fine.
518 (and (authenticate-channel channel directory
519 (commit-id-string commit2)
520 #:keyring-reference-prefix "")
522 ;; COMMIT3 is signed by an unauthorized key according to its
523 ;; parent's '.guix-authorizations' file.
524 (guard (c ((unauthorized-commit-error? c)
525 (and (oid=? (git-authentication-error-commit c)
528 (openpgp-public-key-fingerprint
529 (unauthorized-commit-error-signing-key c))
530 (openpgp-public-key-fingerprint
532 %ed25519bis-public-key-file))))))
533 (authenticate-channel channel directory
534 (commit-id-string commit3)
535 #:keyring-reference-prefix "")
538 (test-end "channels")