mirror of
https://github.com/abhigyanpatwari/GitNexus.git
synced 2026-10-02 02:11:29 +00:00
56feb85c97
Some checks are pending
CodeQL / Analyze (python) (push) Waiting to run
Publish / RC guard (marker + release-PR skip) (push) Blocked by required conditions
Trivy Image Scan / Trivy (gitnexus-web) (push) Waiting to run
CodeQL / Analyze (javascript-typescript) (push) Waiting to run
Gitleaks / gitleaks (push) Waiting to run
Publish / Classify release event (push) Waiting to run
Publish / ci (push) Blocked by required conditions
Publish / Publish to npm (push) Blocked by required conditions
Publish / Build & Push RC Docker images (push) Blocked by required conditions
Scorecard / Scorecard analysis (push) Waiting to run
Trivy Image Scan / Trivy (gitnexus-cli) (push) Waiting to run
* fix(web): drop TypeScript 7-incompatible tsconfig paths Remove baseUrl and the dead ../shared include so web project references typecheck under TypeScript 7. Co-authored-by: Cursor <cursoragent@cursor.com> * test(cli): parse TypeScript with a TypeScript 6 API package Keep AST guards working after the named typescript package becomes 7, which no longer ships the Compiler API. Co-authored-by: Cursor <cursoragent@cursor.com> * chore(lint): pin root TypeScript to the 6 API package Give typescript-eslint a TypeScript 6 peer so syntax-only lint still installs after CLI and web move to TypeScript 7. Co-authored-by: Cursor <cursoragent@cursor.com> * chore(deps): compile first-party packages with TypeScript 7.0.2 Unify CLI and web on the same native compiler line as gitnexus-shared so typecheck and emit no longer split 5.x versus 7.x. Co-authored-by: Cursor <cursoragent@cursor.com> * docs(ci): describe parent TypeScript 7 as the shared compiler Stop saying web compiles shared with TypeScript 5 now that the parent lockfile is 7. Co-authored-by: Cursor <cursoragent@cursor.com> * fix(ci): compile shared from parent TypeScript on Vercel and skill-evolution Stop isolated npm installs in gitnexus-shared so those paths do not pull a second TypeScript 7 optional-platform tree. Co-authored-by: Cursor <cursoragent@cursor.com> * docs: record TypeScript 7 typecheck and Dependabot major-split policy Keep contributor typecheck commands, and stop Dependabot from bumping shared onto a different TypeScript major than CLI and web. Co-authored-by: Cursor <cursoragent@cursor.com> * fix(lint): pin root TypeScript to 5.9 so npm ci satisfies eslint peers typescript-eslint 8 peers typescript below 6.0.0, so the typescript6 alias made quality lint npm ci fail with ERESOLVE. Co-authored-by: Cursor <cursoragent@cursor.com> * test(cli): drop the TypeScript 6 Compiler API package TypeScript 7.0 has no classic createProgram surface, so parse-only guards now use Babel and Mode 4 uses the TypeScript 7 Checker. Co-authored-by: Cursor <cursoragent@cursor.com> * docs: align contributor setup with parent TypeScript 7 compile Stop telling clones to npm-install gitnexus-shared; CI and Vercel already emit that package from a parent lib/tsc.js shim. Co-authored-by: Cursor <cursoragent@cursor.com> * fix(web): typecheck React JSX on TypeScript 7 with explicit DOM libs TypeScript 7 no longer implies DOM or auto-includes @types, so the web app must declare React/JSX settings while Vite keeps plugin-react. Co-authored-by: Cursor <cursoragent@cursor.com> * test: pin Vercel --include=dev and share parse-only string helpers Production npm ci omits the web TypeScript unless --include=dev is on that install. Move staticStringValue next to the other Babel walk helpers so CLI help and contract tests share one source. Co-authored-by: Cursor <cursoragent@cursor.com> * chore(autofix): apply prettier + eslint fixes via /autofix command --------- Co-authored-by: Gergo Magyar <gergomagyar0@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
135 lines
7.9 KiB
Markdown
135 lines
7.9 KiB
Markdown
# Testing — GitNexus
|
|
|
|
How we structure tests and which commands to run locally and in CI.
|
|
|
|
## Packages
|
|
|
|
| Package | Path | Runner | Notes |
|
|
| -------------- | --------------- | ---------- | -------------------------- |
|
|
| CLI + MCP core | `gitnexus/` | Vitest | Primary test surface in CI |
|
|
| Web UI | `gitnexus-web/` | Vitest | Unit/component tests |
|
|
| Web UI E2E | `gitnexus-web/` | Playwright | Run when changing UI flows |
|
|
|
|
## Test lanes
|
|
|
|
### `gitnexus/` commands
|
|
|
|
From `gitnexus/`:
|
|
|
|
| Command | What it runs | When to use |
|
|
| ----------------------------- | -------------------------------------------------- | ------------------------------------- |
|
|
| `npm test` | Full suite (all 3 vitest projects) | Before opening a PR |
|
|
| `npm run test:unit` | Unit tests only (`test/unit/`) | Tight development loop |
|
|
| `npm run test:integration` | Integration tests (`test/integration/`) | After changing pipelines, DB, workers |
|
|
| `npm run test:coverage` | Full suite + v8 coverage with thresholds | Checking coverage impact |
|
|
| `npm run test:parity` | Scope-resolution parity for all migrated languages | After changing resolver or scope code |
|
|
| `npm run test:cross-platform` | Platform-sensitive subset only | Debugging a Windows/macOS issue |
|
|
| `npm run test:watch` | Vitest in watch mode | Active development |
|
|
|
|
### `gitnexus-web/` commands
|
|
|
|
From `gitnexus-web/`:
|
|
|
|
| Command | What it runs | When to use |
|
|
| ----------------------- | ----------------------------- | ------------------------------------------------------------------- |
|
|
| `npm test` | Unit/component tests (vitest) | After changing web code |
|
|
| `npm run test:coverage` | Unit tests + coverage | Checking coverage impact |
|
|
| `npm run test:e2e` | Playwright browser tests | After changing UI flows (requires `gitnexus serve` + `npm run dev`) |
|
|
|
|
### Before opening a PR
|
|
|
|
```bash
|
|
# gitnexus-shared/dist must exist first. `npm install` / `npm run build` in
|
|
# gitnexus/ compiles it via parent `lib/tsc.js` (do not npm ci gitnexus-shared).
|
|
cd gitnexus && npx tsc --noEmit && npm test
|
|
cd ../gitnexus-web && npx tsc -b --noEmit && npm test
|
|
```
|
|
|
|
## Pre-commit hook
|
|
|
|
A husky pre-commit hook (`.husky/pre-commit`) runs automatically on every `git commit`:
|
|
|
|
1. **Formatting** — `lint-staged` runs prettier on staged files
|
|
2. **`gitnexus-web/` files staged** → `tsc -b --noEmit`
|
|
3. **`gitnexus/` files staged** → `tsc --noEmit`
|
|
|
|
Tests do **not** run in the pre-commit hook — they run in CI (`ci-tests.yml`) only.
|
|
|
|
Skip with `git commit --no-verify` (use sparingly).
|
|
|
|
## Vitest projects
|
|
|
|
`gitnexus/vitest.config.ts` defines three projects for safety isolation:
|
|
|
|
| Project | Files | Parallelism | Purpose |
|
|
| --------- | -------------------------------------------------- | ----------- | --------------------------------------------------- |
|
|
| `lbug-db` | Native LadybugDB integration tests (explicit list) | Sequential | Prevents file-lock conflicts from native mmap addon |
|
|
| `cli-e2e` | `skills-e2e.test.ts` | Sequential | CLI process spawning requires serial execution |
|
|
| `default` | Everything else | Parallel | Fast execution for pure logic and parser tests |
|
|
|
|
When adding a new test that uses native LadybugDB (`@ladybugdb/core`), add it to the `lbug-db` project's explicit include list and the `default` project's exclude list.
|
|
|
|
## Test categories
|
|
|
|
- **Unit** — Pure logic, parsers, graph/query helpers; fast; no network.
|
|
- **Integration** — Real combinations (filesystem, MCP wiring, larger pipelines) as already organized under `gitnexus/test/integration`.
|
|
- **Resolver / parity** — Language-specific call-resolution tests in `test/integration/resolvers/`.
|
|
- **E2E (web)** — Critical user paths only; prefer `data-testid` attributes for stable selectors. Tests run against real backend (`gitnexus serve`) and Vite dev server.
|
|
|
|
## Scope-resolution tests
|
|
|
|
Every language resolves calls and inheritance through the scope-resolution pipeline — the legacy call-resolution DAG and the per-language `REGISTRY_PRIMARY_<LANG>` flag were removed in RING4-1 (#942). Each language's resolver test lives at `test/integration/resolvers/<slug>.test.ts` and runs once, on the single scope-resolution path, as part of the normal `tests` job (`vitest test/**/*.test.ts`).
|
|
|
|
Adding a language: register its `ScopeResolver` in `scope-resolution/pipeline/registry.ts` (`SCOPE_RESOLVERS`) and add the resolver test file — no workflow or config edit needed.
|
|
|
|
## Cross-platform testing
|
|
|
|
Windows and macOS CI runs only the platform-sensitive test subset (~50 files out of 373). The full suite runs on Ubuntu.
|
|
|
|
The subset is defined in `gitnexus/scripts/cross-platform-tests.ts` and includes:
|
|
|
|
- **Platform-specific logic** — tests with `process.platform` guards, path.sep behavior, EPERM/EBUSY error classification
|
|
- **Native LadybugDB** — all `lbug-*` integration tests (N-API addon with known platform-varying behavior)
|
|
- **Process spawning / CLI** — tests using real `child_process.spawn`, shell quoting, CLI invocations
|
|
- **Worker threads** — tests spawning real `worker_threads`
|
|
- **Native addon loading** — tree-sitter grammar loading smoke tests
|
|
- **Filesystem behavior** — CRLF handling, directory walking, symlinks
|
|
|
|
When adding a platform-sensitive test, add it to the appropriate section in `scripts/cross-platform-tests.ts`.
|
|
|
|
### Confirming no tests are orphaned
|
|
|
|
Every test file matches one of the three vitest projects. To verify:
|
|
|
|
```bash
|
|
cd gitnexus
|
|
npx vitest list 2>/dev/null | wc -l # should match total test count
|
|
```
|
|
|
|
To check the cross-platform list is up to date, run `npm run test:cross-platform` — it fails fast if any listed file is missing.
|
|
|
|
## CI integration
|
|
|
|
GitHub Actions (`.github/workflows/ci.yml`) orchestrate:
|
|
|
|
| Workflow | Jobs | Purpose |
|
|
| --------------------- | ----------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
| `ci-quality.yml` | format, lint, typecheck, typecheck-web, workflow-convention | Code quality gates |
|
|
| `ci-tests.yml` | ubuntu/coverage, cross-platform (Win/Mac), packaged-install-smoke | Full suite + coverage on Ubuntu; platform-sensitive subset on Win/Mac |
|
|
| `ci-scope-parity.yml` | discover, parity | Scope-resolution parity for all migrated languages |
|
|
| `ci-e2e.yml` | e2e (chromium) | Playwright E2E, gated on `gitnexus-web/**` changes |
|
|
|
|
The `CI Gate` job in `ci.yml` is the single required check for branch protection. It requires quality, tests, e2e, and scope-parity to all pass.
|
|
|
|
## Regression testing
|
|
|
|
Re-run the full relevant suite when:
|
|
|
|
- Prompt or agent-behavior documentation changes (if tests encode behavior)
|
|
- Model or embedding-related code paths change
|
|
- Graph schema, query contracts, or MCP tool shapes change
|
|
- Dependencies with parsing or runtime impact upgrade
|
|
|
|
## User acceptance / beta (optional)
|
|
|
|
For staged releases or UI betas: deploy to a staging environment, collect structured feedback, watch errors and latency, then iterate before a wider release.
|