tests: run the E2E suite against a standalone Francis runtime

Adds a matrix entry that starts a SQLite-backed Francis runtime next to
Pocket ID and points FRANCIS_HOST at it, so the same Playwright suite runs
with the actor state, alarms, and placement owned by the runtime instead of
embedded in Pocket ID.

The suite needs no changes to work in that topology: the E2E reset seeds
every actor through actors.Service() and deliberately leaves the actor
store alone, so it behaves the same whichever side owns it.

The CLI spec is the exception, since export and import are the two commands
whose behaviour genuinely differs. It now picks the right Compose file,
expects an export to carry no francis.bin, feeds the import an archive
without one, and gains a case asserting that an archive that does carry one
is refused.

The runtime is reached over the Compose network on its UDP port, so nothing
is published to the host, and the cluster CA is left unpinned, which
exercises the same trust-on-first-use path an operator gets without
FRANCIS_CA. Pinning is covered by a unit test instead.
This commit is contained in:
Alessandro (Ale) Segala
2026-08-31 05:27:04 +00:00
parent 2e48aaf0a4
commit 22cf4eab93
7 changed files with 243 additions and 8 deletions
+48
View File
@@ -0,0 +1,48 @@
# This Docker Compose file is used to set up the environment for the tests.
# It's the variant where Pocket ID does not embed the Francis actor runtime, but connects to a standalone one instead.
services:
lldap:
extends:
file: docker-compose.yml
service: lldap
scim-test-server:
extends:
file: docker-compose.yml
service: scim-test-server
francis-runtime:
image: ghcr.io/italypaleale/francis:0.1.0-rc.2
volumes:
- ./francis-config.yaml:/etc/francis/config.yaml:ro
- francis-test-data:/data
# The image ships its own HEALTHCHECK, which probes the runtime over the loopback
# It's repeated here so Pocket ID can wait on it, and so a runtime that never comes up fails fast instead of after the default retries
healthcheck:
test: ["CMD", "/bin/francis", "healthcheck"]
interval: 2s
timeout: 5s
retries: 15
start_period: 5s
pocket-id:
extends:
file: docker-compose.yml
service: pocket-id
environment:
APP_ENV: test
ENCRYPTION_KEY: test-encryption-key
FILE_BACKEND: ${FILE_BACKEND}
# The runtime's port is UDP, since WebTransport runs over HTTP/3
FRANCIS_HOST: francis-runtime:7400
# Must match "bootstrap.hostPSK" in francis-config.yaml
FRANCIS_HOST_PSK: e2e-host-bootstrap-psk-0123456789
# FRANCIS_CA is intentionally unset, so this exercises the same trust-on-first-use path an operator gets without it
# The cluster only exists inside this Compose network for the duration of the tests
#
# Peers reach actors placed on this host at ACTORS_HOST, which the runtime hands out, so it has to be the address other containers resolve rather than the default wildcard
ACTORS_HOST: pocket-id
depends_on:
francis-runtime:
condition: service_healthy
volumes:
pocket-id-test-data:
francis-test-data:
+26
View File
@@ -0,0 +1,26 @@
# Configuration for the standalone Francis runtime used by the "remote Francis" E2E variant.
# In that variant Pocket ID does not embed the actor runtime: it connects to this one instead, which owns the actor state, placement, and alarms.
# These secrets are fixed test values and must match the FRANCIS_HOST_PSK passed to Pocket ID in docker-compose-francis.yml.
# The WebTransport server runs over HTTP/3, so this port is UDP
bind: "0.0.0.0:7400"
# The runtime PSKs derive the cluster CA that signs every workload certificate
runtimePSKs:
- "e2e-runtime-psk-0123456789abcdef"
# Hosts prove they may join by presenting this pre-shared key
bootstrap:
method: psk
hostPSK: "e2e-host-bootstrap-psk-0123456789"
# The runtime owns its own SQLite store, which is separate from Pocket ID's database
# It lives on a volume because the image runs as a non-root user that cannot write to the image filesystem
provider:
connectionString: "/data/francis.db"
# A single Pocket ID replica joins the cluster, matching the cap the embedded runtime applies when HA is off
maxHosts: 1
log:
level: debug
+54 -5
View File
@@ -12,11 +12,19 @@ const containerName = 'pocket-id';
const setupDir = pathFromRoot('setup');
const exampleExportPath = pathFromRoot('resources/export');
const dockerCommandMaxBuffer = 100 * 1024 * 1024;
let mode: 'sqlite' | 'postgres' | 's3' = 'sqlite';
let mode: 'sqlite' | 'postgres' | 's3' | 'francis' = 'sqlite';
// With a standalone Francis runtime the actor data lives in the runtime's own store rather than in Pocket ID's database,
// so an export cannot include francis.bin and an import refuses an archive that carries one.
function isRemoteFrancis(): boolean {
return mode === 'francis';
}
test.beforeAll(() => {
const dockerComposeLs = runDockerCommand(['compose', 'ls', '--format', 'json']);
if (dockerComposeLs.includes('postgres')) {
if (dockerComposeLs.includes('francis')) {
mode = 'francis';
} else if (dockerComposeLs.includes('postgres')) {
mode = 'postgres';
} else if (dockerComposeLs.includes('s3')) {
mode = 's3';
@@ -104,6 +112,30 @@ test('Import SQLite export via stdin', async () => {
compareExports(exampleExportPath, exportExtracted);
});
test('Import rejects an archive with actor data against a standalone runtime', async () => {
test.skip(
!isRemoteFrancis(),
'Only applies when a standalone Francis runtime owns the actor data'
);
// Keeping francis.bin makes this the archive of a deployment that embedded the runtime, which has nowhere to be restored here
const archivePath = path.join(tmpDir, 'example-export-with-actors.zip');
const archive = archiveExampleExport(archivePath, true);
// The import aborts before it opens the database, so the running instance is left untouched
let stderr = '';
expect(() => {
try {
runImportFromStdin(archive);
} catch (err: any) {
stderr = err?.stderr?.toString() ?? '';
throw err;
}
}).toThrow();
expect(stderr).toContain('francis.bin');
});
function compareExports(dir1: string, dir2: string): void {
const hashes1 = hashAllFiles(dir1);
const hashes2 = hashAllFiles(dir2);
@@ -135,9 +167,18 @@ function compareExports(dir1: string, dir2: string): void {
expect(normalizedActual).toEqual(normalizedExpected);
// Compare francis.bin contents
// The reference export always carries it, while the produced one only does when Pocket ID owns the actor data
const file1 = path.join(dir1, 'francis.bin');
const file2 = path.join(dir2, 'francis.bin');
if (isRemoteFrancis()) {
expect(
fs.existsSync(file2),
`${file2} must not exist: the standalone Francis runtime owns the actor data`
).toBe(false);
return;
}
for (const filePath of [file1, file2]) {
expect(fs.existsSync(filePath), `${filePath} should exist`).toBe(true);
@@ -149,12 +190,18 @@ function compareExports(dir1: string, dir2: string): void {
}
}
function archiveExampleExport(outputPath: string): Buffer {
// archiveExampleExport zips the reference export so it can be fed back to the import command.
// With a standalone Francis runtime it drops francis.bin, so the archive matches what an export produces in that topology; keepActorsBackup overrides that to build the archive the import is expected to reject.
function archiveExampleExport(outputPath: string, keepActorsBackup = false): Buffer {
fs.rmSync(outputPath, { force: true });
const skipActorsBackup = isRemoteFrancis() && !keepActorsBackup;
const zip = new AdmZip();
const files = fs.readdirSync(exampleExportPath);
for (const file of files) {
if (skipActorsBackup && file === 'francis.bin') continue;
const filePath = path.join(exampleExportPath, file);
if (fs.statSync(filePath).isFile()) {
zip.addLocalFile(filePath);
@@ -168,7 +215,6 @@ function archiveExampleExport(outputPath: string): Buffer {
return buffer;
}
// Helper to load JSON files
function loadJSON(path: string) {
return JSON.parse(fs.readFileSync(path, 'utf-8'));
@@ -382,6 +428,9 @@ function dockerComposeArgs(args: string[]): string[] {
case 's3':
dockerComposeFile = 'docker-compose-s3.yml';
break;
case 'francis':
dockerComposeFile = 'docker-compose-francis.yml';
break;
}
return ['compose', '-f', dockerComposeFile, ...args];
}