5a7bc230b8
* Refactor core * Re-added tests * Small fixes * Add tests for acmetxt cidrslice and util funcs * Remove the last dangling reference to old logging package * Refactoring (#327) * chore: enable more linters and fix linter issues * ci: enable linter checks on all branches and disable recurring checks recurring linter checks don't make that much sense. The code & linter checks should not change on their own over night ;) * chore: update packages * Revert "chore: update packages" This reverts commit 30250bf28c4b39e9e5b3af012a4e28ab036bf9af. * chore: manually upgrade some packages * Updated dependencies, wrote changelog entry and fixed namespace for release * Refactoring - improving coverage (#371) * Increase code coverage in acmedns * More testing of ReadConfig() and its fallback mechanism * Found that if someone put a '"' double quote into the filename that we configure zap to log to, it would cause the the JSON created to be invalid. I have replaced the JSON string with proper config * Better handling of config options for api.TLS - we now error on an invalid value instead of silently failing. added a basic test for api.setupTLS() (to increase test coverage) * testing nameserver isOwnChallenge and isAuthoritative methods * add a unit test for nameserver answerOwnChallenge * fix linting errors * bump go and golangci-lint versions in github actions * Update golangci-lint.yml Bumping github-actions workflow versions to accommodate some changes in upstream golanci-lint * Bump Golang version to 1.23 (currently the oldest supported version) Bump golanglint-ci to 2.0.2 and migrate the config file. This should resolve the math/rand/v2 issue * bump golanglint-ci action version * Fixing up new golanglint-ci warnings and errors --------- Co-authored-by: Joona Hoikkala <5235109+joohoi@users.noreply.github.com> * Minor refactoring, error returns and e2e testing suite * Add a few tests * Fix linter and umask setting * Update github actions * Refine concurrency configuration for GitHub actions * HTTP timeouts to API, and self-validation mutex to nameserver ops --------- Co-authored-by: Florian Ritterhoff <32478819+fritterhoff@users.noreply.github.com> Co-authored-by: Jason Playne <jason@jasonplayne.com>
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
# 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`.
|