]> git.street.me.uk Git - andy/dehydrated.git/blame - test.sh
Remove unneded shebang for config.sh.example
[andy/dehydrated.git] / test.sh
CommitLineData
1561e9fc 1#!/usr/bin/env bash
a4e7c43a
LS
2
3# Fail early
4set -eu -o pipefail
5
6# Check if running in CI environment
7if [[ ! "${CI:-false}" == "true" ]]; then
8 echo "ERROR: Not running in CI environment!"
9 exit 1
10fi
11
12_TEST() {
d3bc67eb 13 echo
40556950
LS
14 echo "${1} "
15}
16_SUBTEST() {
17 echo -n " + ${1} "
a4e7c43a
LS
18}
19_PASS() {
40556950 20 echo -e "[\u001B[32mPASS\u001B[0m]"
a4e7c43a
LS
21}
22_FAIL() {
23 echo -e "[\u001B[31mFAIL\u001B[0m]"
24 echo
25 echo "Problem: ${@}"
26 echo
27 echo "STDOUT:"
28 cat tmplog
29 echo
30 echo "STDERR:"
31 cat errorlog
32 exit 1
33}
34_CHECK_FILE() {
d3bc67eb 35 _SUBTEST "Checking if file '${1}' exists..."
40556950
LS
36 if [[ -e "${1}" ]]; then
37 _PASS
38 else
39 _FAIL "Missing file: ${1}"
40 fi
a4e7c43a
LS
41}
42_CHECK_LOG() {
d3bc67eb 43 _SUBTEST "Checking if log contains '${1}'..."
40556950
LS
44 if grep -- "${1}" tmplog > /dev/null; then
45 _PASS
46 else
47 _FAIL "Missing in log: ${1}"
48 fi
49}
341f5252 50_CHECK_NOT_LOG() {
d3bc67eb 51 _SUBTEST "Checking if log doesn't contain '${1}'..."
341f5252
LS
52 if grep -- "${1}" tmplog > /dev/null; then
53 _FAIL "Found in log: ${1}"
54 else
55 _PASS
56 fi
57}
40556950
LS
58_CHECK_ERRORLOG() {
59 _SUBTEST "Checking if errorlog is empty..."
60 if [[ -z "$(cat errorlog)" ]]; then
61 _PASS
62 else
63 _FAIL "Non-empty errorlog"
64 fi
a4e7c43a
LS
65}
66
67# If not found (should be cached in travis) download ngrok
68if [[ ! -e "ngrok/ngrok" ]]; then
69 (
70 mkdir -p ngrok
ebe9ea3d 71 cd ngrok
a4e7c43a
LS
72 wget https://dl.ngrok.com/ngrok_2.0.19_linux_amd64.zip -O ngrok.zip
73 unzip ngrok.zip ngrok
74 chmod +x ngrok
75 )
76fi
77
78# Run ngrok and grab temporary url from logfile
79ngrok/ngrok http 8080 --log stdout --log-format logfmt --log-level debug > tmp.log &
338ec308 80ngrok/ngrok http 8080 --log stdout --log-format logfmt --log-level debug > tmp2.log &
c9823c25 81ngrok/ngrok http 8080 --log stdout --log-format logfmt --log-level debug > tmp3.log &
a4e7c43a
LS
82sleep 2
83TMP_URL="$(grep -Eo "Hostname:[a-z0-9]+.ngrok.io" tmp.log | head -1 | cut -d':' -f2)"
338ec308 84TMP2_URL="$(grep -Eo "Hostname:[a-z0-9]+.ngrok.io" tmp2.log | head -1 | cut -d':' -f2)"
c9823c25
LS
85TMP3_URL="$(grep -Eo "Hostname:[a-z0-9]+.ngrok.io" tmp3.log | head -1 | cut -d':' -f2)"
86if [[ -z "${TMP_URL}" ]] || [[ -z "${TMP2_URL}" ]] || [[ -z "${TMP3_URL}" ]]; then
a4e7c43a
LS
87 echo "Couldn't get an url from ngrok, not a letsencrypt.sh bug, tests can't continue."
88 exit 1
89fi
90
91# Run python webserver in .acme-challenges directory to serve challenge responses
92mkdir -p .acme-challenges/.well-known/acme-challenge
93(
94 cd .acme-challenges
95 python -m SimpleHTTPServer 8080 > /dev/null 2> /dev/null
96) &
97
98# Generate config and create empty domains.txt
f6f77139
LS
99echo 'CA="https://testca.kurz.pw/directory"' > config.sh
100echo 'LICENSE="https://testca.kurz.pw/terms/v1"' >> config.sh
a4e7c43a 101echo 'WELLKNOWN=".acme-challenges/.well-known/acme-challenge"' >> config.sh
da2795d3 102echo 'RENEW_DAYS="14"' >> config.sh
a4e7c43a
LS
103touch domains.txt
104
105# Check if help command is working
106_TEST "Checking if help command is working..."
6a8f4482 107./letsencrypt.sh --help > tmplog 2> errorlog || _FAIL "Script execution failed"
a4e7c43a 108_CHECK_LOG "Default command: help"
40556950
LS
109_CHECK_LOG "--help (-h)"
110_CHECK_LOG "--domain (-d) domain.tld"
111_CHECK_ERRORLOG
a4e7c43a
LS
112
113# Run in cron mode with empty domains.txt (should only generate private key and exit)
114_TEST "First run in cron mode, checking if private key is generated and registered"
6a8f4482 115./letsencrypt.sh --cron > tmplog 2> errorlog || _FAIL "Script execution failed"
a4e7c43a
LS
116_CHECK_LOG "Registering account key"
117_CHECK_FILE "private_key.pem"
40556950 118_CHECK_ERRORLOG
a4e7c43a
LS
119
120# Temporarily move config out of the way and try signing certificate by using temporary config location
121_TEST "Try signing using temporary config location and with domain as command line parameter"
122mv config.sh tmp_config.sh
b57fd221 123./letsencrypt.sh --cron --domain "${TMP_URL}" --domain "${TMP2_URL}" -f tmp_config.sh > tmplog 2> errorlog || _FAIL "Script execution failed"
6a8f4482 124_CHECK_NOT_LOG "Checking domain name(s) of existing cert"
a4e7c43a
LS
125_CHECK_LOG "Generating private key"
126_CHECK_LOG "Requesting challenge for ${TMP_URL}"
338ec308 127_CHECK_LOG "Requesting challenge for ${TMP2_URL}"
a4e7c43a
LS
128_CHECK_LOG "Challenge is valid!"
129_CHECK_LOG "Creating fullchain.pem"
130_CHECK_LOG "Done!"
40556950 131_CHECK_ERRORLOG
a4e7c43a
LS
132mv tmp_config.sh config.sh
133
134# Move private key and add new location to config
135mv private_key.pem account_key.pem
136echo 'PRIVATE_KEY="./account_key.pem"' >> config.sh
137
c9823c25
LS
138# Add third domain to command-lime, should force renewal.
139_TEST "Run in cron mode again, this time adding third domain, should force renewal."
0d842e87 140./letsencrypt.sh --cron --domain "${TMP_URL}" --domain "${TMP2_URL}" --domain "${TMP3_URL}" > tmplog 2> errorlog || _FAIL "Script execution failed"
c9823c25
LS
141_CHECK_LOG "Domain name(s) are not matching!"
142_CHECK_LOG "Forcing renew."
a2867410 143_CHECK_LOG "Generating private key"
c9823c25
LS
144_CHECK_LOG "Requesting challenge for ${TMP_URL}"
145_CHECK_LOG "Requesting challenge for ${TMP2_URL}"
146_CHECK_LOG "Requesting challenge for ${TMP3_URL}"
147_CHECK_LOG "Challenge is valid!"
148_CHECK_LOG "Creating fullchain.pem"
149_CHECK_LOG "Done!"
150_CHECK_ERRORLOG
151
33f07fcc
LS
152# Prepare domains.txt
153# Modify TMP3_URL to be uppercase to check for upper-lower-case mismatch bugs
154echo "${TMP_URL} ${TMP2_URL} $(tr 'a-z' 'A-Z' <<<"${TMP3_URL}")" >> domains.txt
155
156# Run in cron mode again (should find a non-expiring certificate and do nothing)
a4e7c43a 157_TEST "Run in cron mode again, this time with domain in domains.txt, should find non-expiring certificate"
6a8f4482
LS
158./letsencrypt.sh --cron > tmplog 2> errorlog || _FAIL "Script execution failed"
159_CHECK_LOG "Checking domain name(s) of existing cert... unchanged."
64b23e7a 160_CHECK_LOG "Skipping renew"
40556950 161_CHECK_ERRORLOG
a4e7c43a 162
a2867410
LS
163# Disable private key renew
164echo 'PRIVATE_KEY_RENEW="no"' >> config.sh
165
341f5252
LS
166# Run in cron mode one last time, with domain in domains.txt and force-resign (should find certificate, resign anyway, and not generate private key)
167_TEST "Run in cron mode one last time, with domain in domains.txt and force-resign"
6a8f4482
LS
168./letsencrypt.sh --cron --force > tmplog 2> errorlog || _FAIL "Script execution failed"
169_CHECK_LOG "Checking domain name(s) of existing cert... unchanged."
2d097c92 170_CHECK_LOG "Ignoring because renew was forced!"
af2bc7a9 171_CHECK_NOT_LOG "Generating private key"
341f5252 172_CHECK_LOG "Requesting challenge for ${TMP_URL}"
338ec308 173_CHECK_LOG "Requesting challenge for ${TMP2_URL}"
c9823c25 174_CHECK_LOG "Requesting challenge for ${TMP3_URL}"
341f5252
LS
175_CHECK_LOG "Challenge is valid!"
176_CHECK_LOG "Creating fullchain.pem"
177_CHECK_LOG "Done!"
178_CHECK_ERRORLOG
179
c9823c25
LS
180# Check if signcsr command is working
181_TEST "Running signcsr command"
182./letsencrypt.sh --signcsr certs/${TMP_URL}/cert.csr > tmplog 2> errorlog || _FAIL "Script execution failed"
bfb45d8b
LS
183_CHECK_LOG "BEGIN CERTIFICATE"
184_CHECK_LOG "END CERTIFICATE"
185_CHECK_NOT_LOG "ERROR"
c9823c25 186
a4e7c43a
LS
187# Delete account key (not needed anymore)
188rm account_key.pem
189
85b3f191
LS
190# Check if renewal works
191_TEST "Run in cron mode again, to check if renewal works"
192echo 'RENEW_DAYS="300"' >> config.sh
193./letsencrypt.sh --cron > tmplog 2> errorlog || _FAIL "Script execution failed"
194_CHECK_LOG "Checking domain name(s) of existing cert... unchanged."
195_CHECK_LOG "Renewing!"
196_CHECK_ERRORLOG
197
a4e7c43a
LS
198# Check if certificate is valid in various ways
199_TEST "Verifying certificate..."
d3bc67eb
LS
200_SUBTEST "Verifying certificate on its own..."
201openssl x509 -in "certs/${TMP_URL}/cert.pem" -noout -text > tmplog 2> errorlog && _PASS || _FAIL
a4e7c43a 202_CHECK_LOG "CN=${TMP_URL}"
338ec308 203_CHECK_LOG "${TMP2_URL}"
d3bc67eb
LS
204_SUBTEST "Verifying file with full chain..."
205openssl x509 -in "certs/${TMP_URL}/fullchain.pem" -noout -text > /dev/null 2>> errorlog && _PASS || _FAIL
206_SUBTEST "Verifying certificate against CA certificate..."
207(openssl verify -verbose -CAfile "certs/${TMP_URL}/fullchain.pem" -purpose sslserver "certs/${TMP_URL}/fullchain.pem" 2>&1 || true) | (grep -v ': OK$' || true) >> errorlog 2>> errorlog && _PASS || _FAIL
40556950 208_CHECK_ERRORLOG
a4e7c43a
LS
209
210# Revoke certificate using certificate key
211_TEST "Revoking certificate..."
6a8f4482 212./letsencrypt.sh --revoke "certs/${TMP_URL}/cert.pem" --privkey "certs/${TMP_URL}/privkey.pem" > tmplog 2> errorlog || _FAIL "Script execution failed"
c7018036
MG
213REAL_CERT="$(readlink -n "certs/${TMP_URL}/cert.pem")"
214_CHECK_LOG "Revoking certs/${TMP_URL}/${REAL_CERT}"
3dcfa8b4 215_CHECK_LOG "Done."
c7018036 216_CHECK_FILE "certs/${TMP_URL}/${REAL_CERT}-revoked"
40556950 217_CHECK_ERRORLOG
a4e7c43a 218
a35b89e9
LS
219# Test cleanup command
220_TEST "Cleaning up certificates"
221./letsencrypt.sh --cleanup > tmplog 2> errorlog || _FAIL "Script execution failed"
222_CHECK_LOG "Moving unused file to archive directory: ${TMP_URL}/cert-"
223_CHECK_LOG "Moving unused file to archive directory: ${TMP_URL}/chain-"
224_CHECK_LOG "Moving unused file to archive directory: ${TMP_URL}/fullchain-"
225_CHECK_ERRORLOG
226
a4e7c43a
LS
227# All done
228exit 0