steve
89537d417a
P5-01 — Documentation site under docs/book/ rendered with mdBook
(downloaded via Makefile, same static-binary pattern as Tailwind).
Structured chapters: getting started, concepts, operations,
security, reference. `make docs` / `make docs-watch`. Generated
output gitignored.
P5-02 — CONTRIBUTING.md rewritten from placeholder to a full
guide. CODE_OF_CONDUCT.md adapted from Contributor Covenant for a
single-maintainer project. .gitea/issue_template/{bug,feature}.md
and PULL_REQUEST_TEMPLATE.md.
P5-04 — Six README screenshots captured live from a fresh server
bootstrap (login, empty dashboard, add-host, alerts, settings,
audit log). README rewritten to centre the screenshot grid and
link out to the docs site.
P5-05 — SECURITY.md with disclosure policy (3-day ack, 30-day
default window), scope in/out, threat-model summary, operator
hardening checklist. Mirrored as a docs-site chapter.
P5-06 — End-to-end test harness. e2e/compose.e2e.yml brings up
server + sibling Linux agent (alpine + restic) + restic/rest-server.
Agent uses announce-and-approve so Playwright can drive the full
operator flow: bootstrap → login → accept pending → backup →
verify terminal status. Second spec scrapes /metrics to assert
the P6-04 endpoint surface. .gitea/workflows/e2e.yml runs on every
PR; local how-to in docs/e2e.md.
81 lines
3.2 KiB
TypeScript
81 lines
3.2 KiB
TypeScript
// End-to-end smoke: bootstrap → accept pending host → run backup → see succeeded.
|
|
//
|
|
// The compose stack stands up a server, a sibling rest-server, and an
|
|
// agent in announce-and-approve mode. This test drives the operator
|
|
// path through the UI (login + dashboard) and the API
|
|
// (accept + run-now + poll for terminal) — UI for the human surfaces,
|
|
// API for the deterministic ones.
|
|
|
|
import { test, expect } from '@playwright/test';
|
|
import {
|
|
baseURL,
|
|
bootstrapAdmin,
|
|
loginViaUI,
|
|
waitForPendingHostID,
|
|
acceptPending,
|
|
waitForHostStatus,
|
|
getSessionCookie,
|
|
} from './lib/server';
|
|
|
|
test.describe('smoke: enrol-via-announce → backup', () => {
|
|
test('happy path completes in under a minute', async ({ page, request }) => {
|
|
const { username, password } = await bootstrapAdmin(request);
|
|
await loginViaUI(page, username, password);
|
|
|
|
// Dashboard renders.
|
|
await expect(page.locator('main')).toContainText(/host|fleet|pending/i, { timeout: 10_000 });
|
|
|
|
// Pending host appears (the agent container has been
|
|
// announcing since startup).
|
|
const pendingID = await waitForPendingHostID(page);
|
|
const cookie = await getSessionCookie(page);
|
|
|
|
// Accept with the rest-server creds. compose's rest-server runs
|
|
// --no-auth, so any credentials work; restic still demands a
|
|
// password to encrypt the repo.
|
|
await acceptPending(request, cookie, pendingID, {
|
|
url: 'rest:http://rest-server:8000/',
|
|
password: 'e2e-repo-password',
|
|
});
|
|
|
|
// Wait for the host to come online + auto-init to land.
|
|
const onlineHost = await waitForHostStatus(
|
|
request, cookie,
|
|
(h) => h.status === 'online',
|
|
60_000,
|
|
);
|
|
expect(onlineHost.id).toBeTruthy();
|
|
|
|
// Trigger a backup via the UI form-post (HX-Redirect to /jobs/{id}).
|
|
await page.goto(`${baseURL}/hosts/${onlineHost.id}`);
|
|
await Promise.all([
|
|
page.waitForURL(/\/jobs\//),
|
|
page.locator('form[action$="/run-backup"] button[type="submit"]').first().click(),
|
|
]);
|
|
|
|
// Wait for the host's last_backup_status to flip to 'succeeded'.
|
|
// The job page itself is harder to assert on (it uses
|
|
// server-pushed updates and a reload-on-finish pattern); the
|
|
// host record is the source of truth and is what the dashboard
|
|
// surfaces.
|
|
const finishedHost = await waitForHostStatus(
|
|
request, cookie,
|
|
(h) => h.id === onlineHost.id && h.last_backup_status === 'succeeded',
|
|
120_000,
|
|
);
|
|
expect(finishedHost.last_backup_status).toBe('succeeded');
|
|
});
|
|
});
|
|
|
|
test.describe('smoke: scrape /metrics', () => {
|
|
test('metrics endpoint exposes the host gauge', async ({ request }) => {
|
|
// Compose sets RM_METRICS_TRUSTED_CIDR=0.0.0.0/0 so the
|
|
// endpoint is open to the test runner.
|
|
const res = await request.get(`${baseURL}/metrics`);
|
|
expect(res.status()).toBe(200);
|
|
const body = await res.text();
|
|
expect(body).toContain('rm_hosts_total');
|
|
expect(body).toContain('rm_build_info{');
|
|
});
|
|
});
|