ci(tests): run the Keycloak features suite in E2E Suites

Add a matrix row for features/keycloak on ubuntu-docker-rootful-keycloak,
include the Keycloak realm in the tmachine disk cache key, and document
environments that provide services in TESTING.md.

Signed-off-by: Matthew Grossman <mgrossman@nvidia.com>

Author: matthewgrossman

.github/workflows/e2e-suites.yml

@@ -48,6 +48,11 @@ jobs:
             family: conformance
             package: sandbox
             runner: ubuntu-24.04
+          - environment: ubuntu-docker-rootful-keycloak
+            installer: deb
+            family: features
+            package: keycloak
+            runner: ubuntu-24.04
     runs-on: ${{ matrix.runner }}
     timeout-minutes: 90
     steps:
@@ -77,7 +82,7 @@ jobs:
           # actions/cache doesn't save after an exact key hit, so a fixed key
           # would rebuild the changed layers on every run. Key on the playbooks
           # and fall back to the newest entry for the same runner.
-          key: tmachine-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('tests/tmachine/ansible/**', 'tests/tmachine/images.nix') }}
+          key: tmachine-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('tests/tmachine/ansible/**', 'tests/tmachine/images.nix', 'scripts/keycloak-realm.json') }}
           restore-keys: |
             tmachine-${{ runner.os }}-${{ runner.arch }}-
 

TESTING.md

@@ -204,6 +204,24 @@ an explicit matrix and runs the runner once per row. Branch E2E calls it when
 the `test:e2e` label is set. It is advisory for now. To run a suite in another
 environment on CI, add a row.
 
+**Environments with services.** A suite that needs something besides the
+gateway, such as an OIDC issuer, runs in a tmachine environment that provides
+it. The environment's setup starts the service (with a restart policy, since
+setup is cached as a disk) and writes how to reach it as `OPENSHELL_TEST_*`
+lines in `/etc/openshell-test/env.d/<service>.env`. The runner passes those
+variables to the tests and rejects names without that prefix. A suite-local
+fixture reads them with plain environment variables, so you can run the suite
+against your own deployment by setting them yourself. See the
+`ubuntu-docker-rootful-keycloak` environment in `tests/tmachine/config.nix`,
+`tests/tmachine/ansible/playbooks/keycloak.yaml` and
+`tests/suites/features/keycloak`:
+
+```shell
+nix run .#openshell-test-runner -- \
+  --environment ubuntu-docker-rootful-keycloak --installer deb \
+  --family features --package keycloak
+```
+
 The older conformance, feature and driver lanes in `.github/workflows/` still
 run through the tmachine testsuites in `tests/tmachine/config.nix`. They move
 to the runner as their suites move to testkit.