upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-07-16 05:03:08 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Merge 92021ac576 into f769e35e77

Browse source
This commit is contained in:
Zach Shepherd 2026-06-25 01:06:46 +00:00 committed by GitHub
commit beee9620c9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 112 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

107
tests/dns/cloudflare.bats Normal file
View file

@ -0,0 +1,107 @@
#!/usr/bin/env bats
load 'common'
function setup() {
# Skip if any required environment variable is unset or empty
[ -z "$TEST_CLOUDFLARE_DOMAIN" ] && skip '$TEST_CLOUDFLARE_DOMAIN variable not set'
[ -z "$TEST_CLOUDFLARE_EMAIL" ] && skip '$TEST_CLOUDFLARE_EMAIL variable not set'
[ -z "$TEST_CLOUDFLARE_API_KEY" ] && skip '$TEST_CLOUDFLARE_API_KEY variable not set'
# Create a temporary directory the test
pattern="${BATS_TMPDIR:-/tmp/}/$(basename "$BATS_TEST_FILENAME").XXXXXX"
tmpdir=$(mktemp -d "$pattern")
# Provide common args that should be used with each certbot invocation
common_args="--staging --agree-tos --register-unsafely-without-email --config-dir=$tmpdir/config --work-dir=$tmpdir/work --logs-dir=$tmpdir/logs"
}
function teardown() {
# Clean up the temporary directory used for credentials files
[ -z "$tmpdir" ] || [ ! -d "$tmpdir" ] || rm -rf "$tmpdir"
}
function write_credentials () {
credentials="$tmpdir/credentials"
echo "dns_cloudflare_email = $TEST_CLOUDFLARE_EMAIL" > "$credentials"
echo "dns_cloudflare_api_key = $TEST_CLOUDFLARE_API_KEY" >> "$credentials"
echo "$credentials"
}
@test "obtain and renew certificate" {
run certbot certonly $common_args --dns-cloudflare -d $(random_subdomain).$TEST_CLOUDFLARE_DOMAIN --dns-cloudflare-credentials="$(write_credentials)"
[ "$status" -eq 0 ]
run certbot renew $common_args --force-renewal
[ "$status" -eq 0 ]
[[ "$output" =~ .*"Renewing an existing certificate".* ]]
[[ "$output" =~ .*"all renewals succeeded".* ]]
}
@test "obtain certificate for three subdomains" {
run certbot certonly $common_args --dns-cloudflare -d $(random_subdomain).$TEST_CLOUDFLARE_DOMAIN,$(random_subdomain).$TEST_CLOUDFLARE_DOMAIN,$(random_subdomain).$TEST_CLOUDFLARE_DOMAIN --dns-cloudflare-credentials="$(write_credentials)"
[ "$status" -eq 0 ]
}
@test "attempt with invalid domain" {
run certbot certonly $common_args --dns-cloudflare -d invalid.example.com --dns-cloudflare-credentials="$(write_credentials)"
[ "$status" -ne 0 ]
[[ "$output" =~ .*"confirm that the domain name has been entered correctly".* ]]
}
@test "attempt with empty credentials" {
echo "# Intentionally empty" > "$tmpdir/no-credentials"
run certbot certonly $common_args --dns-cloudflare -d $(random_subdomain).$TEST_CLOUDFLARE_DOMAIN --dns-cloudflare-credentials="$tmpdir/no-credentials"
[ "$status" -ne 0 ]
[[ "$output" =~ .*"Missing properties in credentials configuration file".* ]]
[[ "$output" =~ .*"should be email address".* ]]
[[ "$output" =~ .*"should be API key".* ]]
}
@test "attempt with missing credentials file" {
run certbot certonly $common_args --dns-cloudflare -d $(random_subdomain).$TEST_CLOUDFLARE_DOMAIN --dns-cloudflare-credentials="$tmpdir/not-a-file"
[ "$status" -ne 0 ]
[[ "$output" =~ .*"File not found".* ]]
}
@test "attempt with incomplete API key" {
bad_credentials="$tmpdir/bad_credentials"
echo "dns_cloudflare_email = $TEST_CLOUDFLARE_EMAIL" > "$bad_credentials"
echo "dns_cloudflare_api_key = ${TEST_CLOUDFLARE_API_KEY:0:-1}" >> "$bad_credentials"
run certbot certonly $common_args --dns-cloudflare -d $(random_subdomain).$TEST_CLOUDFLARE_DOMAIN --dns-cloudflare-credentials="$bad_credentials"
[ "$status" -ne 0 ]
[[ "$output" =~ .*"Invalid request headers".* ]]
[[ "$output" =~ .*"confirm that you have supplied valid Cloudflare API credentials".* ]]
[[ "$output" =~ .*"copy your entire API key".* ]]
}
@test "attempt with incorrect API key" {
bad_credentials="$tmpdir/bad_credentials"
echo "dns_cloudflare_email = $TEST_CLOUDFLARE_EMAIL" > "$bad_credentials"
echo "dns_cloudflare_api_key = 0123456789abcdef0123456789abcdef01234567" >> "$bad_credentials"
run certbot certonly $common_args --dns-cloudflare -d $(random_subdomain).$TEST_CLOUDFLARE_DOMAIN --dns-cloudflare-credentials="$bad_credentials"
[ "$status" -ne 0 ]
[[ "$output" =~ .*"Unknown X-Auth-Key or X-Auth-Email".* ]]
[[ "$output" =~ .*"confirm that you have supplied valid Cloudflare API credentials".* ]]
}
@test "attempt with incorrect e-mail address" {
bad_credentials="$tmpdir/bad_credentials"
echo "dns_cloudflare_email = invalid@example.com" > "$bad_credentials"
echo "dns_cloudflare_api_key = $TEST_CLOUDFLARE_API_KEY" >> "$bad_credentials"
run certbot certonly $common_args --dns-cloudflare -d $(random_subdomain).$TEST_CLOUDFLARE_DOMAIN --dns-cloudflare-credentials="$bad_credentials"
[ "$status" -ne 0 ]
[[ "$output" =~ .*"Unknown X-Auth-Key or X-Auth-Email".* ]]
[[ "$output" =~ .*"confirm that you have supplied valid Cloudflare API credentials".* ]]
[[ "$output" =~ .*"enter the correct email address".* ]]
}

5
tests/dns/common.bash Normal file
View file

@ -0,0 +1,5 @@
#!/usr/bin/env bash
function random_subdomain() {
</dev/urandom tr -dc 'a-z' | head -c 13
}