James Wampler
1556b486d2
## Summary - Fix a chain of QA CI issues: Docker build/health-check flakiness, NuGet vuln pins, then adds the post-deploy integration + Playwright smoke suite and works through everything needed to make it actually run on the self-hosted `qa` runner (musl/Alpine job container, no node/dotnet/curl preinstalled, docker-outside-of-docker networking). - Adds a fixed dev/QA seed admin user + fixed Development environment API key so integration tests and e2e specs have a stable target. - Pins Aspire's `AppHost.cs` ports/credentials to match the docker-compose local dev defaults. - Adds `tests/api/MicCheck.Api.Tests.Integration` coverage for disabled flags, environment-document bootstrap, identity override precedence, auth login, and unauthorized access; adds a Playwright e2e suite under `src/admin/e2e` (login, nav, context selection, features CRUD/toggle). - Adds a `smoke-qa` CI job that runs both suites against the just-deployed QA stack, working around: no curl/node/dotnet on the bare runner, musl vs glibc (Playwright browsers run via the official `mcr.microsoft.com/playwright` image instead), and the runner's job-container network isolation (reach the QA stack via the docker bridge gateway IP; `docker cp` instead of a bind mount to get files into the playwright container, since paths don't cross the docker-outside-of-docker boundary). ## Test plan - [x] Unit tests pass (dotnet test tests/api/MicCheck.Api.Tests.Unit, 243 passed) - [x] API integration suite passes against the real QA stack in CI - [x] Playwright e2e suite passes against the real QA stack in CI (verified 3/3 locally against a real dev API + vite server for the flakiest spec) - [x] Full CI pipeline (build → deploy-qa → smoke-qa) green end to end on the qa runner Reviewed-on: #3
51 lines
2.3 KiB
Markdown
Executable File
51 lines
2.3 KiB
Markdown
Executable File
# CLAUDE.md
|
|
|
|
Guidance for Claude Code (claude.ai/code) when working in this repo.
|
|
|
|
## Project
|
|
|
|
MicCheck: open source. asp.net, c#, typescript, VueJS. Manages feature flags, projects, environments.
|
|
|
|
## Planned Structure
|
|
|
|
- `src/admin/` — VueJS admin components
|
|
- `src/api/` - .NET API + REST endpoints
|
|
- `tests/` — test suite
|
|
- `docs/` — documentation
|
|
|
|
## Best Practices
|
|
|
|
- Use latest LTS .NET + latest supported nuget packages for that version
|
|
- Set `langVersion` to latest in all csproj files; enable nullable
|
|
- Organize code by feature/area, not type (e.g. `features` namespace)
|
|
- New features need unit tests covering as much logic as possible (both nunit and jest)
|
|
- Any modified file: evaluate for missing test coverage and that all tests pass
|
|
|
|
# Coding
|
|
- Descriptive names for all classes/methods. No generic names: Provider, Manager, Helper
|
|
- Match formatting/style from `.editorconfig`
|
|
- Wrap lines at 220 characters, leave single line if fewer
|
|
- Place interfaces that are implemented by a single class at the bottom of the class file. An interface with multiple implementations of an interface should be in a seperate file.
|
|
- Do not use tuples for return types. Prefer records or classes for multiple values
|
|
- Do not use `sealed`
|
|
- Use `record` for data objects, `class` for objects with behavior. Avoid mutable state where possible.
|
|
|
|
## Testing
|
|
- BDD-style unit tests, end-to-end as possible, no external resources (DB, filesystem). e.g. `WhenAUserDoesSomething_ThenAThingAppears`
|
|
- Mock external deps with Moq
|
|
- Mock EntityFramework DBContexts with an extracted interface and Moq. Do not rely on InMemory provider.
|
|
- New features need unit tests covering as much logic as possible
|
|
- Any modified file: evaluate for missing test coverage-
|
|
- No "Mock" in mocked object names
|
|
- No Arrange/Act/Assert comments
|
|
- All tests should pass before commit
|
|
|
|
## Claude
|
|
- Plans = `.md` files in `docs/plans/`. Admin → `docs/plans/admin/`, API → `docs/plans/api/`
|
|
- Split large plans into discrete chunks — each buildable + committable independently
|
|
- Plan generated from `docs/plans/<name>.md` → save as `docs/plans/<name>_plan.md`
|
|
- Plan implemented from `docs/plans/<name>.md` → save summary as `docs/plans/<name>_output.md`
|
|
|
|
## Stack
|
|
`.gitignore` configured for .NET/Visual Studio (C#, NuGet, MSBuild). Update if stack changes.
|