Commit df6b083
authored
test(e2e): close the skipped-browser-journeys gap (#557)
## Summary
- Wire a working `TestMain` under `internal/e2e/` that stands up an
OpenLDAP testcontainer (pre-seeded with `ou=users` / `ou=groups`,
`admin-user`, `testuser1`, `developers`), installs the Playwright
Chromium headless shell, starts ldap-manager in-process on an
ephemeral 127.0.0.1 port, and publishes `E2E_*` env vars so the
per-test helpers work unchanged. The suite was previously compile-
broken (a stale `BrowserNewPageOptions.ViewportSize` field name) and
CI never shipped an app + LDAP for it to talk to.
- Fix the `ViewportSize` → `Viewport` field name so the file builds
under `-tags=e2e`.
- Adjust the user-list / 404 assertions to the real templ output
(`.list-container` + `[data-search-input]` instead of `<table>`,
"does not exist" instead of "404"), and replace the deprecated
`WaitForTimeout` poll with a `Locator.WaitFor()` web expect.
- Add `TestUserDetailJourney` — the spec explicitly lists
"click a user → DN + attributes render" as one of the five required
journeys but nothing covered it before.
- Flip `enable-e2e-tests: true` on the `netresearch/.github` reusable
`go-check` workflow with `e2e-test-packages: ./internal/e2e/...` so
the suite runs on every PR. Coverage uploads under the existing
`e2e` flag in [`.github/codecov.yml`](.github/codecov.yml). Record
the opt-in on the ci.yml intentional-drift entry.
## Browser automation choice
**Playwright** (`github.com/playwright-community/playwright-go`).
The repo already committed to it — `go.mod` pins `playwright-community/
playwright-go v0.5700.1` and the existing `e2e_helpers.go`/`user_
journey_test.go` are built on its `BrowserType` / `Locator` / `Page`
API — so rewriting to chromedp would have meant throwing away ~30
working helpers plus the seven existing journey tests. Playwright's
strict-mode Locators + `WaitForURL` web-expects also give us the
assertion ergonomics the flows rely on (strict-mode violations
surfaced the list-vs-table drift on first run). `playwright.Install`
in `TestMain` is idempotent — the first CI run caches ~110 MB of
Chromium under `~/.cache/ms-playwright`, every subsequent run is a
no-op.
## Journeys covered
| # | Requirement | Where |
| - | ----------- | ----- |
| 1 | Login: `/` → `/login`, submit valid creds, land on user list |
`TestLoginJourney` (login_with_valid_credentials_succeeds,
logout_works_correctly), `TestProtectedRoutes` |
| 2 | User list: seeded user visible, filter/search works |
`TestUserListJourney` (user_list_page_loads, user_list_shows_user_data,
search_functionality_works) |
| 3 | User detail: click a user, DN + attributes render | **new**
`TestUserDetailJourney` |
| 4 | Logout: back to login, cookie cleared |
`TestLoginJourney/logout_works_correctly`, `TestSessionPersistence` |
| 5 | Auth negative: wrong password → stay on login with error |
`TestLoginJourney/login_with_invalid_credentials_shows_error`,
`TestLoginJourney/login_with_empty_credentials_shows_validation` |
Plus the suite also exercises 404 rendering, nav visibility, CSRF
token presence, password-field masking, aria labels, and mobile /
tablet viewport rendering.
## Bootstrap time
Local, warm caches:
```
go test -race -tags=e2e -coverprofile=coverage-e2e.out -covermode=atomic ./internal/e2e/...
ok github.com/netresearch/ldap-manager/internal/e2e 17.234s coverage: 64.8% of statements
```
Local, cold cache (first pull of osixia/openldap:1.5.0 + Playwright
Chromium Headless Shell 143.0.7499.4 download, 109.7 MiB): ~60 s
additional. The reusable `go-check` e2e job budgets 30 min
(`e2e-timeout-minutes`, default) and the actual test-execution window
is 25 min (set by the workflow), so there's plenty of headroom even
on the cold path.
## Caveats
* **OpenLDAP ACL loosening.** `osixia/openldap`'s default ACL hides
the DIT root from non-admin users. Every `FindUsers` /
`FindGroups` call via the per-user bind (the one the home page,
user list, and group list all make) would return
`LDAP Result Code 32 "No Such Object"` and handlers would 500.
`TestMain` now applies the same permissive ACL we ship in
`dev/acl.ldif` (`by users read`) via `ldapmodify -Y EXTERNAL` before
seeding. Production deployments are expected to have a service
account with broader read rights; the ACL loosening only affects
the test container.
* **`simple-ldap-go`'s "example server" heuristic.** The library
short-circuits real LDAP ops for any server URI whose host
contains `localhost` (among ~15 other substrings). The
testcontainers Docker provider returns `localhost` on native Linux
runners, so `TestMain` rewrites the host to `127.0.0.1` before
handing the URI to `options.Opts`.
* **Lint pedantics.** The pre-existing `e2e_helpers.go` has a handful
of `errcheck` / `nlreturn` findings. They're invisible to CI
because `golangci-lint-action` doesn't pass `-tags=e2e`, so the
e2e files stay outside its visible file set. I deliberately didn't
touch them — out of scope and would muddy the review.
## Test plan
- [ ] `go test -race -tags=e2e -coverprofile=coverage-e2e.out
-covermode=atomic ./internal/e2e/...` passes locally
- [ ] `enable-e2e-tests: true` job runs green on this PR in CI
- [ ] Codecov ingests the `e2e` flag (check the PR comment)
- [ ] Template-drift job still passes (drift reason updated in
`.github/template.yaml`)4 files changed
Lines changed: 443 additions & 17 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
16 | 21 | | |
17 | 22 | | |
18 | 23 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
26 | 33 | | |
27 | 34 | | |
28 | 35 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
| 341 | + | |
| 342 | + | |
| 343 | + | |
| 344 | + | |
| 345 | + | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
0 commit comments