source: mod_gnutls/test/Makefile.am

Last change on this file was 0da2c5d, checked in by Fiona Klute <fiona.klute@…>, 8 days ago

Test suite: Update README and newtest script

  • Property mode set to 100644
File size: 12.1 KB
Line 
1SUBDIRS = tests
2
3# Generate the test scripts
4test-%.bash: test-template.bash.in | tests/%/
5        testname="$(*)"; sed s/@NUMBER@/$${testname%%_*}/ < $< > $@
6        chmod a+x $@
7
8test_scripts = test-00_basic.bash \
9        test-01_serverwide_priorities.bash \
10        test-02_cache_in_vhost.bash \
11        test-03_cachetimeout_in_vhost.bash \
12        test-04_basic_nosni.bash \
13        test-05_mismatched-priorities.bash \
14        test-06_verify_sni_a.bash \
15        test-07_verify_sni_b.bash \
16        test-08_verify_no_sni_fallback_to_first_vhost.bash \
17        test-09_verify_no_sni_fails_with_wrong_order.bash \
18        test-10_basic_client_verification.bash \
19        test-11_basic_client_verification_fail.bash \
20        test-12_cgi_variables.bash \
21        test-13_cgi_variables_no_client_cert.bash \
22        test-14_resume_session.bash
23if USE_MSVA
24test_scripts += test-15_basic_msva.bash
25endif
26test_scripts += test-16_view-status.bash \
27        test-17_cgi_vars_large_cert.bash \
28        test-18_client_verification_wrong_cert.bash \
29        test-19_TLS_reverse_proxy.bash \
30        test-20_TLS_reverse_proxy_client_auth.bash \
31        test-21_TLS_reverse_proxy_wrong_cert.bash \
32        test-22_TLS_reverse_proxy_crl_revoke.bash \
33        test-23_TLS_reverse_proxy_mismatched_priorities.bash \
34        test-24_pkcs11_cert.bash \
35        test-25_Disable_TLS_1.0.bash \
36        test-26_redirect_HTTP_to_HTTPS.bash \
37        test-27_OCSP_server.bash \
38        test-28_HTTP2_support.bash \
39        test-29_force_handshake_vhost.bash \
40        test-30_ip_based_vhosts.bash \
41        test-31_vhost_SNI_serveralias_match.bash \
42        test-32_vhost_SNI_serveralias_mismatch.bash \
43        test-33_vhost_SNI_serveralias_missinghost.bash \
44        test-34_TLS_reverse_proxy_h2.bash
45
46MOSTLYCLEANFILES = $(test_scripts)
47dist_check_SCRIPTS = netns_py.bash test-template.bash.in
48
49TEST_EXTENSIONS = .bash .py
50PY_LOG_COMPILER = $(PYTHON)
51TESTS = doctest-mgstest.py $(test_scripts)
52
53check_PROGRAMS = pgpcrc
54pgpcrc_SOURCES = pgpcrc.c
55
56# build OCSP database tool
57if ENABLE_OCSP_TEST
58check_PROGRAMS += gen_ocsp_index
59gen_ocsp_index_SOURCES = gen_ocsp_index.c cert_helper.c
60gen_ocsp_index_CFLAGS = $(LIBGNUTLS_CFLAGS)
61gen_ocsp_index_LDFLAGS = $(LIBGNUTLS_LIBS)
62noinst_HEADERS = cert_helper.h
63endif
64
65# Python tools for tests
66noinst_PYTHON = https-test-client.py mgstest/http.py mgstest/__init__.py \
67        mgstest/hooks.py mgstest/services.py mgstest/softhsm.py \
68        mgstest/tests.py runtest.py softhsm-init.py doctest-mgstest.py
69
70# Identities in the miniature CA, server, and client environment for
71# the test suite
72shared_identities = authority authority/client
73pgp_identities = $(shared_identities)
74x509_only_identities = authority/server authority/imposter \
75        authority/subca authority/subca/server \
76        rogueca rogueca/rogueclient
77if ENABLE_OCSP_TEST
78x509_only_identities += authority/ocsp-responder authority/subca/ocsp-responder
79endif
80x509_identities = $(shared_identities) $(x509_only_identities)
81identities = $(shared_identities) $(x509_only_identities)
82# Append strings after ":=" to each identity to generate a list of
83# necessary files
84pgp_tokens = $(pgp_identities:=/cert.pgp) \
85        $(pgp_identities:=/secret.pgp)
86x509_keys = $(x509_identities:=/secret.key)
87x509_certs = $(x509_identities:=/x509.pem)
88x509_tokens = $(x509_certs) $(x509_keys)
89tokens = $(x509_tokens)
90if USE_MSVA
91tokens += $(pgp_tokens)
92endif
93
94if !DISABLE_FLOCK
95# flock command for write access to the authority keyring
96GPG_FLOCK = @FLOCK@ authority/lock
97endif
98
99include $(srcdir)/test_ca.mk
100
101# Test cases trying to create keys and certificates in parallel causes
102# race conditions. Ensure that all keys and certificates are generated
103# before tests get to run.
104#
105# NOTE: Once the support files have been generated, test cases can be
106# run with multiple jobs, but real parallelization would require
107# dynamic port assignments. At the moment, lock files ensure that only
108# one Apache instance (possibly plus a proxy back end instance) is
109# running at any time, so test cases actually have to wait for each
110# other - just not in any particular order.
111check_DATA = $(tokens) authority/server/crl.pem
112
113MOSTLYCLEANFILES += cache/* logs/* outputs/* authority/server/crl.pem
114
115cert_templates = authority/template.in authority/client/template.in \
116        authority/imposter/template.in authority/ocsp-responder/template \
117        authority/server/template.in \
118        authority/subca/template.in authority/subca/server/template.in \
119        authority/subca/ocsp-responder/template \
120        rogueca/template rogueca/rogueclient/template.in
121generated_templates = authority/template authority/client/template \
122        authority/imposter/template rogueca/rogueclient/template \
123        authority/server/template
124
125# Delete X.509 private keys on full clean. Note that unless you need
126# to generate fresh keys, the "mostlyclean" target should be
127# sufficient (see below).
128CLEANFILES = $(x509_keys)
129
130# Delete X.509 certificates and generated templates on "mostlyclean"
131# target. Certificates can be rebuilt without generating new key
132# pairs, and regenerating them makes it possible to change identities
133# (e.g. host names) without wasting time on new keys (which would
134# happen after "clean").
135MOSTLYCLEANFILES += $(x509_certs) $(generated_templates) $(identities:=/uid)
136
137
138# Delete PGP keyrings on "mostlyclean" target. They are created from
139# the X.509 private keys and certificates with an expiration time of
140# one day, so regenerating them is both fast and frequently
141# necessary.
142pgp_patterns = /*.pgp /*.pgp.raw /*.gpg /*.gpg~ /gpg.conf \
143        /*.kbx /*.kbx~ /S.gpg-agent /private-keys-v1.d/*
144MOSTLYCLEANFILES += $(foreach pat,$(pgp_patterns),$(pgp_identities:=$(pat))) \
145        authority/lock authority/tofu.db
146# GnuPG random pool, no need to regenerate on every build
147CLEANFILES += authority/random_seed
148
149# GnuPG 2 starts gpg-agent processes per GNUPGHOME (one for every PGP
150# identity) while creating the PGP certificates. This target is called
151# by both "check-local" and "mostlyclean-local": The former because
152# agent processes are started while preparing for "check" and are no
153# longer needed afterwards, the latter to make sure they are gone
154# along with their certificates.
155stop-gnupg-agent:
156        for id in $(pgp_identities) $(msva_home); do \
157                GNUPGHOME=$$id/ gpgconf --kill gpg-agent || true; \
158        done
159
160check-local: stop-gnupg-agent
161
162# Delete lock files for test servers on "mostlyclean" target.
163MOSTLYCLEANFILES += *.lock
164
165# rule to build MSVA trust database
166if USE_MSVA
167msva_home = msva.gnupghome
168check_DATA += $(msva_home)/trustdb.gpg authority/client/uid
169MOSTLYCLEANFILES += $(foreach pat,$(pgp_patterns),$(msva_home)$(pat))
170$(msva_home)/trustdb.gpg: authority/minimal.pgp authority/client/cert.pgp
171        mkdir -p -m 0700 $(dir $@)
172        GNUPGHOME=$(dir $@) gpg --import < $<
173        printf "%s:6:\n" "$$(GNUPGHOME=authority/ gpg --with-colons --list-secret-keys --fingerprint | grep ^fpr: | cut -f 10 -d :)" | GNUPGHOME=$(dir $@) gpg --import-ownertrust
174        GNUPGHOME=$(dir $@) gpg --import < authority/client/cert.pgp
175        printf "keyserver does-not-exist.example\n" > $(msva_home)/gpg.conf
176endif
177
178if ENABLE_OCSP_TEST
179# rules to build OCSP database
180ocsp_index_data = authority/ocsp_index.txt authority/ocsp_index.txt.attr \
181        authority/subca/ocsp_index.txt authority/subca/ocsp_index.txt.attr
182check_DATA += $(ocsp_index_data)
183MOSTLYCLEANFILES += $(ocsp_index_data)
184
185# The "find" command builds a list of all certificates directly below
186# the CA that aren't for the ocsp-responder.
187%/ocsp_index.txt: $(x509_tokens) gen_ocsp_index
188        ./gen_ocsp_index $$(find $(*) -mindepth 2 -maxdepth 2 ! -path '*/ocsp-responder/*' -name x509.pem) > $@
189
190%/ocsp_index.txt.attr:
191        @mkdir -m 0700 -p $(dir $@)
192        echo "unique_subject = no" > $@
193
194# Build certificate chain files. Note that intermediate tokens must be
195# listed explicitly, or the dependency chain will be broken because
196# the higher level pattern matches, too.
197chain_tokens = authority/server/x509-chain.pem \
198        authority/subca/x509-chain.pem \
199        authority/subca/server/x509-chain.pem
200check_DATA += $(chain_tokens)
201MOSTLYCLEANFILES += $(chain_tokens) authority/x509-chain.pem
202endif
203
204# SoftHSM token, note that the SoftHSM 2 token is a directory
205SOFTHSM2_TOKEN = authority/server/softhsm2.db
206# included in mostlyclean-local below
207clean-softhsm2-db:
208        -rm -rf $(SOFTHSM2_TOKEN)
209
210if HAVE_SOFTHSM
211check_DATA += $(SOFTHSM2_TOKEN)
212endif HAVE_SOFTHSM
213
214check_DATA += make-test-dirs
215extra_dirs = logs cache outputs
216make-test-dirs:
217        mkdir -p $(extra_dirs)
218
219.PHONY: make-test-dirs clean-softhsm2-db stop-gnupg-agent
220
221
222mostlyclean-local: clean-softhsm2-db stop-gnupg-agent
223        -rmdir $(pgp_identities:=/private-keys-v1.d) || true
224if USE_MSVA
225        -rmdir $(msva_home)/private-keys-v1.d || true
226endif
227
228# Delete test data directories, and wait for test services to
229# exit. The reason for the wait is that Apache instances may take some
230# time to exit and delete their PID files. Occasionally some PID files
231# where still around during "distcheck" runs by the time the target
232# checked if the build directory was really empty after "distclean",
233# breaking the build. Delaying "clean-local" until PID files are gone
234# avoids this issue, and the timeout will expose actually unclean
235# stops.
236clean-local:
237        -rmdir $(extra_dirs) || true
238if USE_MSVA
239        -rmdir $(msva_home) || true
240endif
241        wait=0; \
242        while ls *.pid && test "$$wait" -lt "@TEST_LOCK_WAIT@"; do \
243                wait=$$(($$wait + 1)); \
244                echo "waiting for test services to exit ($$wait seconds)"; \
245                sleep 1; \
246        done
247
248# Apache configuration and data files
249apache_data = base_apache.conf cgi_module.conf data/dump.cgi data/ocsp.cgi \
250        data/test.txt mime.types proxy_mods.conf
251
252# Documentation for the test system
253test_doc = README.md sample_fail.yml sample_test.yml
254
255EXTRA_DIST = $(apache_data) $(cert_templates) $(shared_identities:=/uid.in) \
256        authority/server/crl.template $(test_doc)
257
258# Lockfile for the main Apache process
259test_lockfile = ./test.lock
260# Lockfile for the proxy backend Apache process (if any)
261backend_lockfile = ./backend.lock
262# Lockfile for the OCSP server Apache process (if any)
263ocsp_lockfile = ./ocsp.lock
264
265# port for the main Apache server
266TEST_PORT ?= 9932
267# port for MSVA in test cases that use it
268MSVA_PORT ?= 9933
269# port for TLS proxy backend server
270BACKEND_PORT ?= 9934
271# port for plain HTTP server
272TEST_HTTP_PORT ?= 9935
273# port for the OCSP responder
274if ENABLE_OCSP_TEST
275OCSP_PORT ?= 9936
276OCSP_URI_TEMPLATE = ocsp_uri = http://$(TEST_HOST):$(OCSP_PORT)/ocsp/
277endif
278# maximum time to wait for MSVA startup (milliseconds)
279TEST_SERVICE_MAX_WAIT ?= 10000
280# wait loop time for MSVA startup (milliseconds)
281TEST_SERVICE_WAIT ?= 400
282
283AM_TESTS_ENVIRONMENT = export APACHE2=@APACHE2@; \
284        export AP_LIBEXECDIR=@AP_LIBEXECDIR@; \
285        export PYTHON="@PYTHON@"; \
286        export TEST_LOCK_WAIT="@TEST_LOCK_WAIT@"; \
287        export TEST_IP="@TEST_IP@"; \
288        export TEST_HOST="@TEST_HOST@"; \
289        export TEST_PORT="$(TEST_PORT)"; \
290        export MSVA_PORT="$(MSVA_PORT)"; \
291        export TEST_SERVICE_MAX_WAIT="$(TEST_SERVICE_MAX_WAIT)"; \
292        export TEST_SERVICE_WAIT="$(TEST_SERVICE_WAIT)"; \
293        export TEST_QUERY_TIMEOUT="@TEST_QUERY_TIMEOUT@"; \
294        export BACKEND_HOST="@TEST_HOST@"; \
295        export BACKEND_PORT="$(BACKEND_PORT)"; \
296        export TEST_HTTP_PORT="$(TEST_HTTP_PORT)"; \
297        export HTTP_CLI="@HTTP_CLI@";
298
299if HAVE_SOFTHSM
300AM_TESTS_ENVIRONMENT += export SOFTHSM="@SOFTHSM@"; \
301        export SOFTHSM_LIB="@SOFTHSM_LIB@";
302endif
303
304if ENABLE_OCSP_TEST
305AM_TESTS_ENVIRONMENT += export OPENSSL="@OPENSSL@"; \
306        export OCSP_PORT="$(OCSP_PORT)";
307endif
308
309if ENABLE_NETNS
310AM_TESTS_ENVIRONMENT += export UNSHARE="@UNSHARE@"; \
311        export USE_TEST_NAMESPACE=1;
312endif
313# Without flock tests must not run in parallel, and PID files are used
314# to prevent conflicts between server instances. Otherwise set lock
315# files for flock.
316if DISABLE_FLOCK
317AM_TESTS_ENVIRONMENT += export TEST_LOCK="apache2.pid"; \
318        export BACKEND_LOCK="backend.pid"; \
319        export OCSP_LOCK="ocsp.pid";
320.NOTPARALLEL:
321else
322AM_TESTS_ENVIRONMENT += export FLOCK="@FLOCK@"; \
323        export TEST_LOCK="$(test_lockfile)"; \
324        export BACKEND_LOCK="$(backend_lockfile)"; \
325        export OCSP_LOCK="$(ocsp_lockfile)";
326endif
327
328# Echo AM_TESTS_ENVIRONMENT. This can be useful for debugging, e.g. if
329# you want to manually run an Apache instance with Valgrind using the
330# same configuration as a test case.
331show-test-env: export TEST_ENV=$(AM_TESTS_ENVIRONMENT)
332show-test-env:
333        @echo "$${TEST_ENV}"
334
335# Build the test suite README as HTML if pandoc is available.
336if USE_PANDOC
337noinst_DATA = README.html
338MOSTLYCLEANFILES += $(noinst_DATA)
339%.html: %.md $(srcdir)/../doc/style.css
340        $(PANDOC) --css $(filter %.css,$^) --metadata pagetitle="$(<)" --self-contained -f markdown -o $@ $<
341endif
Note: See TracBrowser for help on using the repository browser.