mirror of https://github.com/alexhopeoconnor/dnsmasq-webui.git synced 2026-10-04 04:18:13 +10:00

Files

T

alex d910688742 Add dnsmasq version awareness, readiness endpoint, and Docker healthcheck

- Options: VersionCommand, VersionTimeoutSeconds, MinimumVersion, EnforceMinimumVersion
- Version probe service and parser; startup enforcement when EnforceMinimumVersion
- Save flow: block save on probe failure (VersionProbeFailed) or version below minimum (UnsupportedVersion)
- Status API and Dnsmasq page: show version with tooltip, link to CHANGELOG
- Readiness: GET /healthz/ready (version + dnsmasq running when StatusCommand set)
- MapReadyHealthCheck extension; Dockerfile HEALTHCHECK + curl; compose healthcheck and service_healthy
- Docs: README and agents.md updated

2026-03-08 23:12:38 +10:00

4.3 KiB

Raw Blame History

Agent instructions: dnsmasq-webui

Test harness (Docker)

The test harness runs the app and dnsmasq in Docker with DHCP clients so you can test the UI and effective config against real dnsmasq.

Script: scripts/prepare-test-mount.sh
Compose file: docker-compose.test.yml

Start the harness

From the repo root:

./scripts/prepare-test-mount.sh

This will:

Sync testdata/ to testdata-mount/ (preserving existing contents unless you pass --clear)
Remove any *dnsmasq-webui*.conf in the mount so dnsmasq starts clean
Resolve the requested dnsmasq version (latest by default) to a concrete value when needed
Run docker compose -f docker-compose.test.yml up -d --build

Quick restart (no image rebuild): ./scripts/prepare-test-mount.sh --no-build
Force a fresh image build: ./scripts/prepare-test-mount.sh --no-cache-build
Pin dnsmasq version: ./scripts/prepare-test-mount.sh --dnsmasq-version 2.91 --build
Use distro package: ./scripts/prepare-test-mount.sh --dnsmasq-version distro --build
Prepare mount only (no start): ./scripts/prepare-test-mount.sh --prepare-only
Then start manually with the version printed by the script: TESTDATA_MOUNT=./testdata-mount DNSMASQ_VERSION=<resolved-version> docker compose -f docker-compose.test.yml up -d [--build]
Preserve mount (e.g. keep leases): ./scripts/prepare-test-mount.sh --no-build (default mount behavior)

App is at http://localhost:8080. Main config path in the container is /data/dnsmasq-test.conf; managed file is zz-dnsmasq-webui.conf in the same directory. The app service has a healthcheck (GET /healthz/ready); DHCP client services use depends_on: app: condition: service_healthy so they start only after the app (and dnsmasq) is ready.

Stop the harness

./scripts/prepare-test-mount.sh --stop

Runs docker compose -f docker-compose.test.yml down (stops and removes containers/networks). Does not change the mount directory.

Clean (stop + clear mount)

./scripts/prepare-test-mount.sh --tidy

Stops the harness and deletes the contents of testdata-mount/ so the next run starts from a clean sync of testdata/.

Custom paths

--source DIR — Source to sync from (default: testdata)
--mount DIR — Mount directory (default: testdata-mount). The script exports TESTDATA_MOUNT=./DIR when you use --mount, so compose uses it.
--dnsmasq-version V — Dnsmasq version for the harness image: latest (default), distro, or an exact upstream version like 2.91.
--no-cache-build — Force a fresh image build with docker compose build --pull --no-cache before start.

Example: sync from a custom dir and start:

./scripts/prepare-test-mount.sh --source myfixtures --mount mymount

Help

./scripts/prepare-test-mount.sh -h

Unit tests