aboutsummaryrefslogtreecommitdiff
path: root/tests/pack.scm
blob: f8a9e09c2840014077eef08cae1648db649f0736 (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
30
31
32
33
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2017-2021, 2023 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2018 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2021, 2023 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;; Copyright © 2023 Oleg Pykhalov <go.wigust@gmail.com>
;;;
;;; 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/>.

(define-module (test-pack)
  #:use-module (guix scripts pack)
  #:use-module (guix store)
  #:use-module (guix derivations)
  #:use-module (guix profiles)
  #:use-module (guix packages)
  #:use-module (guix monads)
  #:use-module (guix tests)
  #:use-module (guix gexp)
  #:use-module (guix modules)
  #:use-module (guix utils)
  #:use-module ((guix build utils) #:select (%store-directory))
  #:use-module (gnu packages)
  #:use-module ((gnu packages base) #:select (libc-utf8-locales-for-target))
  #:use-module (gnu packages bootstrap)
  #:use-module ((gnu packages package-management) #:select (rpm))
  #:use-module ((gnu packages compression) #:select (squashfs-tools))
  #:use-module ((gnu packages debian) #:select (dpkg))
  #:use-module ((gnu packages guile) #:select (guile-sqlite3))
  #:use-module ((gnu packages gnupg) #:select (guile-gcrypt))
  #:use-module ((gnu packages linux) #:select (fakeroot))
  #:use-module (srfi srfi-64))

(define %store
  (open-connection-for-tests))

;; Globally disable grafts because they can trigger early builds.
(%graft? #f)

(define %gzip-compressor
  ;; Compressor that uses the bootstrap 'gzip'.
  ((@ (guix scripts pack) compressor) "gzip"
   ".gz"
   #~(list #+(file-append %bootstrap-coreutils&co "/bin/gzip") "-6n")))

(define %tar-bootstrap %bootstrap-coreutils&co)

(define %ar-bootstrap %bootstrap-binutils)

;;; This is a variant of the RPM package configured so that its database can
;;; be created on a writable location readily available inside the build
;;; container ("/tmp").
(define rpm-for-tests
  (package
    (inherit rpm)
    (arguments (substitute-keyword-arguments (package-arguments rpm)
                 ((#:configure-flags flags '())
                  #~(cons "--localstatedir=/tmp"
                          (delete "--localstatedir=/var" #$flags)))))))


(test-begin "pack")

;; The following test needs guile-sqlite3, libgcrypt, etc. as a consequence of
;; commit c45477d2a1a651485feede20fe0f3d15aec48b39 and related changes.  Thus,
;; run it on the user's store, if it's available, on the grounds that these
;; dependencies may be already there, or we can get substitutes or build them
;; quite inexpensively; see <https://bugs.gnu.org/32184>.
(with-external-store store
  (define-syntax-rule (test-assertm name exp)
    (test-assert name
      (let ((guile (package-derivation store %bootstrap-guile)))
        (run-with-store store exp
                        #:guile-for-build guile))))

  (unless store (test-skip 1))
  (test-assertm "self-contained-tarball"
    (mlet* %store-monad
        ((guile   (set-guile-for-build (default-guile)))
         (profile -> (profile
                      (content (packages->manifest (list %bootstrap-guile)))
                      (hooks '())
                      (locales? #f)))
         (tarball (self-contained-tarball "pack" profile
                                          #:symlinks '(("/bin/Guile"
                                                        -> "bin/guile"))
                                          #:compressor %gzip-compressor
                                          #:archiver %tar-bootstrap))
         (check   (gexp->derivation
                   "check-tarball"
                   (with-imported-modules '((guix build utils))
                     #~(begin
                         (use-modules (guix build utils)
                                      (srfi srfi-1))

                         (define store
                           ;; The unpacked store.
                           (string-append "." (%store-directory) "/"))

                         (define (canonical? file)
                           ;; Return #t if FILE is read-only and its mtime is 1.
                           (let ((st (lstat file)))
                             (or (not (string-prefix? store file))
                                 (eq? 'symlink (stat:type st))
                                 (and (= 1 (stat:mtime st))
                                      (zero? (logand #o222
                                                     (stat:mode st)))))))

                         (define bin
                           (string-append "." #$profile "/bin"))

                         (setenv "PATH"
                                 (string-append #$%tar-bootstrap "/bin"))
                         (system* "tar" "xvf" #$tarball)
                         (mkdir #$output)
                         (exit
                          (and (file-exists? (string-append bin "/guile"))
                               (file-exists? store)
                               (every canonical?
                                      (find-files "." (const #t)
                                                  #:directories? #t))
                               (string=? (string-append #$%bootstrap-guile "/bin")
                                         (readlink bin))
                               (string=? (string-append ".." #$profile
                                                        "/bin/guile")
                                         (readlink "bin/Guile")))))))))
      (built-derivations (list check))))

  (unless store (test-skip 1))
  (test-assertm "self-contained-tarball + localstatedir"
    (mlet* %store-monad
        ((guile   (set-guile-for-build (default-guile)))
         (profile -> (profile
                      (content (packages->manifest (list %bootstrap-guile)))
                      (hooks '())
                      (locales? #f)))
         (tarball (self-contained-tarball "tar-pack" profile
                                          #:localstatedir? #t))
         (check   (gexp->derivation
                   "check-tarball"
                   #~(let ((bin (string-append "." #$profile "/bin")))
                       (setenv "PATH"
                               (string-append #$%tar-bootstrap "/bin"))
                       (system* "tar" "xvf" #$tarball)
                       (mkdir #$output)
                       (exit
                        (and (file-exists? "var/guix/db/db.sqlite")
                             (string=? (string-append #$%bootstrap-guile "/bin")
                                       (readlink bin))))))))
      (built-derivations (list check))))

  (unless store (test-skip 1))
  (test-assertm "self-contained-tarball + localstatedir, UTF-8 file names"
    (mlet* %store-monad
        ((guile   (set-guile-for-build (default-guile)))
         (tree    (interned-file-tree
                   `("directory-with-utf8-file-names" directory
                     ("α" regular (data "alpha"))
                     ("λ" regular (data "lambda")))))
         (tarball (self-contained-tarball "tar-pack" tree
                                          #:localstatedir? #t))
         (check   (gexp->derivation
                   "check-tarball"
                   (with-extensions (list guile-sqlite3 guile-gcrypt)
                     (with-imported-modules (source-module-closure
                                             '((guix store database)))
                       #~(begin
                           (use-modules (guix store database)
                                        (rnrs io ports)
                                        (srfi srfi-1))

                           (define (valid-file? basename data)
                             (define file
                               (string-append "./" #$tree "/" basename))

                             (string=? (call-with-input-file (pk 'file file)
                                         get-string-all)
                                       data))

                           (setenv "PATH"
                                   (string-append #$%tar-bootstrap "/bin"))
                           (system* "tar" "xvf" #$tarball)

                           (sql-schema
                            #$(local-file (search-path %load-path
                                                       "guix/store/schema.sql")))
                           (with-database "var/guix/db/db.sqlite" db
                             ;; Make sure non-ASCII file names are properly
                             ;; handled.
                             (setenv "GUIX_LOCPATH"
                                     #+(file-append
                                        (libc-utf8-locales-for-target)
                                        "/lib/locale"))
                             (setlocale LC_ALL "en_US.utf8")

                             (mkdir #$output)
                             (exit
                              (and (every valid-file?
                                          '("α" "λ")
                                          '("alpha" "lambda"))
                                   (integer? (valid-path-id db #$tree)))))))))))
      (built-derivations (list check))))

  (unless store (test-skip 1))
  (test-assertm "docker-image + localstatedir"
    (mlet* %store-monad
        ((guile   (set-guile-for-build (default-guile)))
         (profile -> (profile
                      (content (packages->manifest (list %bootstrap-guile)))
                      (hooks '())
                      (locales? #f)))
         (tarball (docker-image "docker-pack" profile
                                #:symlinks '(("/bin/Guile" -> "bin/guile"))
                                #:localstatedir? #t))
         (check   (gexp->derivation
                   "check-tarball"
                   (with-imported-modules '((guix build utils))
                     #~(begin
                         (use-modules (guix build utils)
                                      (ice-9 match))

                         (define bin
                           (string-append "." #$profile "/bin"))

                         (setenv "PATH" (string-append #$%tar-bootstrap "/bin"))
                         (mkdir "base")
                         (with-directory-excursion "base"
                           (invoke "tar" "xvf" #$tarball))

                         (match (find-files "base" "layer.tar")
                           ((layer)
                            (invoke "tar" "xvf" layer)))

                         (when (and (file-exists? (string-append bin "/guile"))
                                    (file-exists? "var/guix/db/db.sqlite")
                                    (file-is-directory? "tmp")
                                    (string=? (string-append #$%bootstrap-guile "/bin")
                                              (pk 'binlink (readlink bin)))
                                    (string=? (string-append #$profile "/bin/guile")
                                              (pk 'guilelink (readlink "bin/Guile"))))
                           (mkdir #$output)))))))
      (built-derivations (list check))))

  (unless store (test-skip 1))
  (test-assertm "docker-layered-image + localstatedir"
    (mlet* %store-monad
        ((guile (set-guile-for-build (default-guile)))
         (profile -> (profile
                      (content (packages->manifest (list %bootstrap-guile)))
                      (hooks '())
                      (locales? #f)))
         (tarball (docker-image "docker-pack" profile
                                #:symlinks '(("/bin/Guile" -> "bin/guile"))
                                #:localstatedir? #t
                                #:max-layers 100))
         (check (gexp->derivation
                 "check-tarball"
                 (with-imported-modules '((guix build utils))
                   #~(begin
                       (use-modules (guix build utils)
                                    (ice-9 match))

                       (define bin
                         (string-append "." #$profile "/bin"))

                       (define store
                         (string-append "." #$(%store-directory)))

                       (setenv "PATH" (string-append #$%tar-bootstrap "/bin"))
                       (mkdir "base")
                       (with-directory-excursion "base"
                         (invoke "tar" "xvf" #$tarball))

                       (match (find-files "base" "layer.tar")
                         ((layers ...)
                          (for-each (lambda (layer)
                                      (invoke "tar" "xvf" layer)
                                      (invoke "chmod" "--recursive" "u+w" store))
                                    layers)))

                       (when
                           (and (file-exists? (string-append bin "/guile"))
                                (file-exists? "var/guix/db/db.sqlite")
                                (file-is-directory? "tmp")
                                (string=? (string-append #$%bootstrap-guile "/bin")
                                          (readlink bin))
                                (string=? (string-append #$profile "/bin/guile")
                                          (readlink "bin/Guile")))
                         (mkdir #$output)))))))
      (built-derivations (list check))))

  (unless store (test-skip 1))
  (test-assertm "squashfs-image + localstatedir"
    (mlet* %store-monad
        ((guile   (set-guile-for-build (default-guile)))
         (profile -> (profile
                      (content (packages->manifest (list %bootstrap-guile)))
                      (hooks '())
                      (locales? #f)))
         (image   (squashfs-image "squashfs-pack" profile
                                  #:symlinks '(("/bin" -> "bin"))
                                  #:localstatedir? #t))
         (check   (gexp->derivation
                   "check-tarball"
                   (with-imported-modules '((guix build utils))
                     #~(begin
                         (use-modules (guix build utils)
                                      (ice-9 match))

                         (define bin
                           (string-append "." #$profile "/bin"))

                         (setenv "PATH"
                                 (string-append #$squashfs-tools "/bin"))
                         (invoke "unsquashfs" #$image)
                         (with-directory-excursion "squashfs-root"
                           (when (and (file-exists? (string-append bin
                                                                   "/guile"))
                                      (file-exists? "var/guix/db/db.sqlite")
                                      (file-is-directory? "tmp")
                                      (string=? (string-append #$%bootstrap-guile "/bin")
                                                (pk 'binlink (readlink bin)))

                                      ;; This is a relative symlink target.
                                      (string=? (string-drop
                                                 (string-append #$profile "/bin")
                                                 1)
                                                (pk 'guilelink (readlink "bin"))))
                             (mkdir #$output))))))))
      (built-derivations (list check))))

  (unless store (test-skip 1))
  (test-assertm "deb archive with symlinks and control files"
    (mlet* %store-monad
        ((guile   (set-guile-for-build (default-guile)))
         (profile -> (profile
                      (content (packages->manifest (list %bootstrap-guile)))
                      (hooks '())
                      (locales? #f)))
         (deb (debian-archive
               "deb-pack" profile
               #:compressor %gzip-compressor
               #:symlinks '(("/opt/gnu/bin" -> "bin"))
               #:archiver %tar-bootstrap
               #:extra-options
               (list #:triggers-file
                     (plain-file "triggers"
                                 "activate-noawait /usr/share/icons/hicolor\n")
                     #:postinst-file
                     (plain-file "postinst"
                                 "echo running configure script\n"))))
         (check
          (gexp->derivation
           "check-deb-pack"
           (with-imported-modules '((guix build utils))
             #~(begin
                 (use-modules (guix build utils)
                              (ice-9 match)
                              (ice-9 popen)
                              (ice-9 rdelim)
                              (ice-9 textual-ports)
                              (rnrs base))

                 (setenv "PATH" (string-join
                                 (list (string-append #+%tar-bootstrap "/bin")
                                       (string-append #+dpkg "/bin")
                                       (string-append #+%ar-bootstrap "/bin"))
                                 ":"))

                 ;; Validate the output of 'dpkg --info'.
                 (let* ((port (open-pipe* OPEN_READ "dpkg" "--info" #$deb))
                        (info (get-string-all port))
                        (exit-val (status:exit-val (close-pipe port))))
                   (assert (zero? exit-val))

                   (assert (string-contains
                            info
                            (string-append "Package: "
                                           #+(package-name %bootstrap-guile))))

                   (assert (string-contains
                            info
                            (string-append "Version: "
                                           #+(package-version %bootstrap-guile)))))

                 ;; Sanity check .deb contents.
                 (invoke "ar" "-xv" #$deb)
                 (assert (file-exists? "debian-binary"))
                 (assert (file-exists? "data.tar.gz"))
                 (assert (file-exists? "control.tar.gz"))

                 ;; Verify there are no hard links in data.tar.gz, as hard
                 ;; links would cause dpkg to fail unpacking the archive.
                 (define hard-links
                   (let ((port (open-pipe* OPEN_READ "tar" "-tvf" "data.tar.gz")))
                     (let loop ((hard-links '()))
                       (match (read-line port)
                         ((? eof-object?)
                          (assert (zero? (status:exit-val (close-pipe port))))
                          hard-links)
                         (line
                          (if (string-prefix? "u" line)
                              (loop (cons line hard-links))
                              (loop hard-links)))))))

                 (unless (null? hard-links)
                   (error "hard links found in data.tar.gz" hard-links))

                 ;; Verify the presence of the control files.
                 (invoke "tar" "-xf" "control.tar.gz")
                 (assert (file-exists? "control"))
                 (assert (and (file-exists? "postinst")
                              (= #o111  ;script is executable
                                 (logand #o111 (stat:perms
                                                (stat "postinst"))))))
                 (assert (file-exists? "triggers"))

                 (mkdir #$output))))))
      (built-derivations (list check))))

  (unless store (test-skip 1))
  (test-assertm "rpm archive can be installed/uninstalled"
    (mlet* %store-monad
        ((guile   (set-guile-for-build (default-guile)))
         (profile -> (profile
                      (content (packages->manifest (list %bootstrap-guile)))
                      (hooks '())
                      (locales? #f)))
         (rpm-pack (rpm-archive "rpm-pack" profile
                                #:compressor %gzip-compressor
                                #:symlinks '(("/bin/guile" -> "bin/guile"))
                                #:extra-options '(#:relocatable? #t)))
         (check
          (gexp->derivation
           "check-rpm-pack"
           (with-imported-modules (source-module-closure
                                   '((guix build utils)))
             #~(begin
                 (use-modules (guix build utils))

                 (define fakeroot #+(file-append fakeroot "/bin/fakeroot"))
                 (define rpm #+(file-append rpm-for-tests "/bin/rpm"))
                 (mkdir-p "/tmp/lib/rpm")

                 ;; Install the RPM package.  This causes RPM to validate the
                 ;; signatures, header as well as the file digests, which
                 ;; makes it a rather thorough test.
                 (mkdir "test-prefix")
                 (invoke fakeroot rpm "--install"
                         (string-append "--prefix=" (getcwd) "/test-prefix")
                         #$rpm-pack)

                 ;; Invoke the installed Guile command.
                 (invoke "./test-prefix/bin/guile" "--version")

                 ;; Uninstall the RPM package.
                 (invoke fakeroot rpm "--erase" "guile-bootstrap")

                 ;; Required so the above is run.
                 (mkdir #$output))))))
      (built-derivations (list check)))))

(test-end)

;; Local Variables:
;; eval: (put 'test-assertm 'scheme-indent-function 2)
;; End: