Minor refactoring, error returns and e2e testing suite
This commit is contained in:
Joona Hoikkala
@@ -0,0 +1,37 @@
|
||||
# acme-dns E2E Testing Suite
|
||||
|
||||
This directory contains the end-to-end (E2E) testing suite for `acme-dns`. The suite runs in a containerized environment to ensure a consistent and isolated test execution.
|
||||
|
||||
## Overview
|
||||
|
||||
The E2E suite consists of:
|
||||
- A Dockerized `acme-dns` server.
|
||||
- A Python-based `tester` container that performs API and DNS operations.
|
||||
- A GitHub Actions workflow for CI/CD integration.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [Docker](https://www.docker.com/get-started)
|
||||
- [Docker Compose](https://docs.docker.com/compose/install/)
|
||||
|
||||
## Running Locally
|
||||
|
||||
To run the full E2E suite locally, execute the following command from the root of the repository:
|
||||
|
||||
```bash
|
||||
docker compose -f test/e2e/docker-compose.yml up --build --abort-on-container-exit
|
||||
```
|
||||
|
||||
The `tester` container will return an exit code of `0` on success and `1` on failure.
|
||||
|
||||
## Test Flow
|
||||
|
||||
The `tester.py` script follows these steps:
|
||||
1. **Wait for Ready**: Polls the `/health` endpoint until the API is available.
|
||||
2. **Account Registration**: Registers a NEW account at `/register`.
|
||||
3. **TXT Update**: Performs TWO sequential updates to the TXT records of the newly created subdomain.
|
||||
4. **DNS Verification**: Directly queries the `acme-dns` server (on port 53) used in the test to verify that the TXT records have been correctly updated and are resolvable.
|
||||
|
||||
## CI/CD integration
|
||||
|
||||
The tests are automatically run on every push and pull request to the `master` branch via GitHub Actions. The workflow configuration can be found in `.github/workflows/e2e.yml`.
|
||||
@@ -0,0 +1,16 @@
|
||||
FROM golang:alpine AS builder
|
||||
RUN apk add --update gcc musl-dev git
|
||||
WORKDIR /app
|
||||
COPY . .
|
||||
RUN CGO_ENABLED=1 go build -o acme-dns
|
||||
|
||||
FROM alpine:latest
|
||||
WORKDIR /root/
|
||||
COPY --from=builder /app/acme-dns .
|
||||
COPY --from=builder /app/config.cfg /etc/acme-dns/config.cfg
|
||||
RUN mkdir -p /var/lib/acme-dns
|
||||
RUN apk --no-cache add ca-certificates && update-ca-certificates
|
||||
VOLUME ["/etc/acme-dns", "/var/lib/acme-dns"]
|
||||
ENTRYPOINT ["./acme-dns", "-c", "/etc/acme-dns/config.cfg"]
|
||||
EXPOSE 53 80 443
|
||||
EXPOSE 53/udp
|
||||
@@ -0,0 +1,28 @@
|
||||
[general]
|
||||
listen = "0.0.0.0:53"
|
||||
protocol = "both"
|
||||
domain = "auth.example.org"
|
||||
nsname = "auth.example.org"
|
||||
nsadmin = "admin.example.org"
|
||||
records = [
|
||||
"auth.example.org. A 127.0.0.1",
|
||||
"auth.example.org. NS auth.example.org.",
|
||||
]
|
||||
debug = true
|
||||
|
||||
[database]
|
||||
engine = "sqlite"
|
||||
connection = "/var/lib/acme-dns/acme-dns.db"
|
||||
|
||||
[api]
|
||||
ip = "0.0.0.0"
|
||||
disable_registration = false
|
||||
port = "80"
|
||||
tls = "none"
|
||||
corsorigins = ["*"]
|
||||
use_header = false
|
||||
|
||||
[logconfig]
|
||||
loglevel = "debug"
|
||||
logtype = "stdout"
|
||||
logformat = "text"
|
||||
@@ -0,0 +1,30 @@
|
||||
version: '3'
|
||||
services:
|
||||
acme-dns:
|
||||
build:
|
||||
context: ../../
|
||||
dockerfile: test/e2e/Dockerfile.e2e
|
||||
ports:
|
||||
- "15353:53/udp"
|
||||
- "18080:80"
|
||||
- "18443:443"
|
||||
volumes:
|
||||
- ./config.cfg:/etc/acme-dns/config.cfg
|
||||
- e2e-data:/var/lib/acme-dns
|
||||
|
||||
tester:
|
||||
image: python:3.9-slim
|
||||
depends_on:
|
||||
- acme-dns
|
||||
volumes:
|
||||
- .:/test
|
||||
working_dir: /test
|
||||
command: >
|
||||
sh -c "pip install -r requirements.txt && python tester.py"
|
||||
environment:
|
||||
- ACMEDNS_URL=http://acme-dns:80
|
||||
- DNS_SERVER=acme-dns
|
||||
- DNS_PORT=53
|
||||
|
||||
volumes:
|
||||
e2e-data:
|
||||
@@ -0,0 +1,2 @@
|
||||
requests
|
||||
dnspython
|
||||
@@ -0,0 +1,105 @@
|
||||
import requests
|
||||
import dns.resolver
|
||||
import os
|
||||
import time
|
||||
import sys
|
||||
import socket
|
||||
|
||||
ACMEDNS_URL = os.environ.get("ACMEDNS_URL", "http://localhost:80")
|
||||
DNS_SERVER = os.environ.get("DNS_SERVER", "localhost")
|
||||
DNS_PORT = int(os.environ.get("DNS_PORT", 53))
|
||||
|
||||
def wait_for_server():
|
||||
print(f"Waiting for acme-dns at {ACMEDNS_URL}...")
|
||||
for i in range(30):
|
||||
try:
|
||||
resp = requests.get(f"{ACMEDNS_URL}/health")
|
||||
if resp.status_code == 200:
|
||||
print("Server is up!")
|
||||
return True
|
||||
except:
|
||||
pass
|
||||
time.sleep(1)
|
||||
return False
|
||||
|
||||
def test_flow():
|
||||
# 1. Register account
|
||||
print("Registering account...")
|
||||
resp = requests.post(f"{ACMEDNS_URL}/register")
|
||||
if resp.status_code != 201:
|
||||
print(f"Failed to register: {resp.status_code} {resp.text}")
|
||||
return False
|
||||
|
||||
account = resp.json()
|
||||
username = account['username']
|
||||
api_key = account['password']
|
||||
subdomain = account['subdomain']
|
||||
fulldomain = account['fulldomain']
|
||||
print(f"Registered subdomain: {subdomain}")
|
||||
|
||||
# 2. Update TXT records
|
||||
headers = {
|
||||
"X-Api-User": username,
|
||||
"X-Api-Key": api_key
|
||||
}
|
||||
|
||||
txt_values = ["secret_token_1", "secret_token_2"]
|
||||
|
||||
for val in txt_values:
|
||||
print(f"Updating TXT record with value: {val}")
|
||||
# Let's Encrypt uses 43 char tokens usually, but our validation is flexible now (or we use a dummy one)
|
||||
# Actually our current validation in pkg/api/util.go still expects 43 chars if I recall correctly
|
||||
# Let's use 43 chars just in case
|
||||
dummy_val = val.ljust(43, '_')[:43]
|
||||
payload = {
|
||||
"subdomain": subdomain,
|
||||
"txt": dummy_val
|
||||
}
|
||||
resp = requests.post(f"{ACMEDNS_URL}/update", headers=headers, json=payload)
|
||||
if resp.status_code != 200:
|
||||
print(f"Failed to update: {resp.status_code} {resp.text}")
|
||||
return False
|
||||
|
||||
print("Updates successful. Waiting for DNS propagation (local cache)...")
|
||||
time.sleep(2)
|
||||
|
||||
# 3. Verify DNS resolution
|
||||
print(f"Resolving TXT records for {fulldomain}...")
|
||||
|
||||
# Resolve hostname to IP if needed
|
||||
try:
|
||||
dns_server_ip = socket.gethostbyname(DNS_SERVER)
|
||||
except:
|
||||
dns_server_ip = DNS_SERVER
|
||||
|
||||
resolver = dns.resolver.Resolver()
|
||||
resolver.nameservers = [dns_server_ip]
|
||||
resolver.port = DNS_PORT
|
||||
|
||||
try:
|
||||
answers = resolver.resolve(fulldomain, "TXT")
|
||||
resolved_values = [str(rdata).strip('"') for rdata in answers]
|
||||
print(f"Resolved values: {resolved_values}")
|
||||
|
||||
# Check if both are present
|
||||
for val in txt_values:
|
||||
dummy_val = val.ljust(43, '_')[:43]
|
||||
if dummy_val not in resolved_values:
|
||||
print(f"Expected value {dummy_val} not found in resolved values")
|
||||
return False
|
||||
except Exception as e:
|
||||
print(f"DNS resolution failed: {e}")
|
||||
return False
|
||||
|
||||
print("E2E Test Passed Successfully!")
|
||||
return True
|
||||
|
||||
if __name__ == "__main__":
|
||||
if not wait_for_server():
|
||||
print("Server timed out.")
|
||||
sys.exit(1)
|
||||
|
||||
if not test_flow():
|
||||
sys.exit(1)
|
||||
|
||||
sys.exit(0)
|
||||
Reference in New Issue
Block a user