tests: Skip Python tests if the bindings are not built.
[gnupg.git] / tests / gpgme / gpgme-defs.scm
1 #!/usr/bin/env gpgscm
2
3 ;; Copyright (C) 2016 g10 Code GmbH
4 ;;
5 ;; This file is part of GnuPG.
6 ;;
7 ;; GnuPG is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 3 of the License, or
10 ;; (at your option) any later version.
11 ;;
12 ;; GnuPG is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 ;; GNU General Public License for more details.
16 ;;
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with this program; if not, see <http://www.gnu.org/licenses/>.
19
20 (load (with-path "defs.scm"))
21
22 (define gpgme-srcdir (getenv "XTEST_GPGME_SRCDIR"))
23 (when (string=? "" gpgme-srcdir)
24     (info
25      "SKIP: Environment variable 'XTEST_GPGME_SRCDIR' not set.  Please"
26      "point it to a recent GPGME source tree to run the GPGME test suite.")
27     (exit 0))
28
29 (define (in-gpgme-srcdir . names)
30   (canonical-path (apply path-join (cons gpgme-srcdir names))))
31
32 (define gpgme-builddir (getenv "XTEST_GPGME_BUILDDIR"))
33 (when (string=? "" gpgme-builddir)
34     (info
35      "SKIP: Environment variable 'XTEST_GPGME_BUILDDIR' not set.  Please"
36      "point it to a recent GPGME build tree to run the GPGME test suite.")
37     (exit 0))
38
39 ;; Make sure that GPGME picks up our gpgconf.  This makes GPGME use
40 ;; and thus executes the tests with GnuPG components from the build
41 ;; tree.
42 (setenv "PATH" (string-append (path-join (getenv "GNUPG_BUILDDIR") "tools")
43                               (string *pathsep*) (getenv "PATH")) #t)
44
45 ;; The tests expect the pinentry to return the passphrase "abc".
46 (setenv "PINENTRY_USER_DATA" "abc" #t)
47
48 (define (create-file name . lines)
49   (letfd ((fd (open name (logior O_WRONLY O_CREAT O_BINARY) #o600)))
50     (let ((port (fdopen fd "wb")))
51       (for-each (lambda (line) (display line port) (newline port)) lines))))
52
53 (define (create-gpgmehome . path)
54   ;; Support for various environments.
55   (define mode
56     (cond
57      ((equal? path '("lang" "python" "tests"))
58       (set! path '("tests" "gpg")) ;; Mostly uses files from tests/gpg.
59       'python)
60      (else
61       'gpg)))
62
63   (create-file
64    "gpg.conf"
65    "no-force-v3-sigs"
66    (string-append "agent-program " (tool 'gpg-agent) "|--debug-quick-random\n"))
67   (create-file
68    "gpg-agent.conf"
69    (string-append "pinentry-program " (tool 'pinentry)))
70
71   (start-agent)
72
73   (log "Storing private keys")
74   (for-each
75    (lambda (name)
76      (file-copy (apply in-gpgme-srcdir `(,@path ,name))
77                 (path-join "private-keys-v1.d"
78                            (string-append name ".key"))))
79    '("13CD0F3BDF24BE53FE192D62F18737256FF6E4FD"
80      "76F7E2B35832976B50A27A282D9B87E44577EB66"
81      "A0747D5F9425E6664F4FFBEED20FBCA79FDED2BD"
82      "13CBE3758AFE42B5E5E2AE4CED27AFA455E3F87F"
83      "7A030357C0F253A5BBCD282FFC4E521B37558F5C"))
84
85   (log "Importing public demo and test keys")
86   (for-each
87    (lambda (file)
88      (call-check `(,@GPG --yes --import ,(apply in-gpgme-srcdir
89                                                 `(,@path ,file)))))
90    (list "pubdemo.asc" "secdemo.asc"))
91
92   (when (equal? mode 'python)
93         (log "Importing extra keys for Python tests")
94         (for-each
95          (lambda (file)
96            (call-check `(,@GPG --yes --import
97                                ,(apply in-gpgme-srcdir
98                                        `("lang" "python" "tests" ,file)))))
99          (list "encrypt-only.asc" "sign-only.asc"))
100
101         (log "Marking key as trusted")
102         (pipe:do
103          (pipe:echo "A0FF4590BB6122EDEF6E3C542D727CC768697734:6:\n")
104          (pipe:spawn `(,(tool 'gpg) --import-ownertrust))))
105
106   (stop-agent))
107
108 ;; Initialize the test environment, install appropriate configuration
109 ;; and start the agent, with the keys from the legacy test suite.
110 (define (setup-gpgme-environment . path)
111   (if (member "--unpack-tarball" *args*)
112       (begin
113         (call-check `(,(tool 'gpgtar) --extract --directory=. ,(cadr *args*)))
114         (start-agent))
115       (apply create-gpgme-gpghome path)))
116
117 (define (parse-makefile port key)
118   (define (is-continuation? tokens)
119     (string=? (last tokens) "\\"))
120   (define (valid-token? s)
121     (< 0 (string-length s)))
122   (define (drop-continuations tokens)
123     (let loop ((acc '()) (tks tokens))
124       (if (null? tks)
125           (reverse acc)
126           (loop (if (string=? "\\" (car tks))
127                     acc
128                     (cons (car tks) acc)) (cdr tks)))))
129   (let next ((acc '()) (found #f))
130     (let ((line (read-line port)))
131       (if (eof-object? line)
132           acc
133           (let ((tokens (filter valid-token?
134                                 (string-splitp (string-trim char-whitespace?
135                                                             line)
136                                                char-whitespace? -1))))
137             (cond
138              ((or (null? tokens)
139                   (string-prefix? (car tokens) "#")
140                   (and (not found) (not (and (string=? key (car tokens))
141                                              (string=? "=" (cadr tokens))))))
142               (next acc found))
143              ((not found)
144               (assert (and (string=? key (car tokens))
145                            (string=? "=" (cadr tokens))))
146               (if (is-continuation? tokens)
147                   (next (drop-continuations (cddr tokens)) #t)
148                   (drop-continuations (cddr tokens))))
149              (else
150               (assert found)
151               (if (is-continuation? tokens)
152                   (next (append acc (drop-continuations tokens)) found)
153                   (append acc (drop-continuations tokens))))))))))
154
155 (define (parse-makefile-expand filename expand key)
156   (define (variable? v)
157     (and (string-prefix? v "$(") (string-suffix? v ")")))
158
159   (let expand-all ((values (parse-makefile (open-input-file filename) key)))
160     (if (any variable? values)
161         (expand-all
162          (let expand-one ((acc '()) (v values))
163            (cond
164             ((null? v)
165              acc)
166             ((variable? (car v))
167              (let ((makefile (open-input-file filename))
168                    (key (substring (car v) 2 (- (string-length (car v)) 1))))
169                (expand-one (append acc (expand filename makefile key))
170                            (cdr v))))
171             (else
172              (expand-one (append acc (list (car v))) (cdr v))))))
173         values)))
174
175 (define python (catch #f
176                       (path-expand "python" (string-split (getenv "PATH") *pathsep*))))
177 (define (run-python-tests?)
178   (let* ((python-version
179           (string-trim char-whitespace?
180                        (call-popen `(,python -c "import sys; print('{0}.{1}'.format(sys.version_info[0], sys.version_info[1]))") "")))
181          (build-path (path-join gpgme-builddir "lang" "python"
182                                 (string-append "python" python-version "-gpg"))))
183     (trace (file-exists? (trace build-path)))))