Pier-Jean Malandrino fdbab2f49e feat: add Karate UI e2e tests with data-e2e selectors (#124 )

- Add e2e/ui/ as peer project to e2e/api/ (own pom.xml, runner, config)
- 5 critical UI journeys: upload, delete, analysis, batch-progress, rechunk
- 4 local-only tests: sidebar, i18n, error-states, pipeline-options
- 1 full happy path workflow covering all modes
- Add data-e2e attributes on all tested Vue components (decoupled from CSS)
- Add CONVENTIONS.md with 7 golden rules for writing Karate UI tests
- Update CI with dedicated e2e-ui job (Chrome headless, --no-sandbox)
- Update docs/contributing.md with UI test instructions

Closes #124

2026-04-08 17:53:52 +02:00

2.5 KiB

Raw Blame History

Contributing

Getting Started

Fork the repository

Clone your fork:

git clone https://github.com/<your-username>/Docling-Studio.git
cd Docling-Studio

Create a branch:
```
git checkout -b feature/my-feature
```

Development Setup

=== "Backend (Python 3.12+)"

```bash
cd document-parser
python -m venv .venv && source .venv/bin/activate

# Remote mode (lightweight — delegates to Docling Serve)
pip install -r requirements.txt

# Local mode (full — runs Docling in-process)
pip install -r requirements-local.txt

pip install ruff pytest pytest-asyncio httpx
uvicorn main:app --reload --port 8000
```

=== "Frontend (Node 20+)"

```bash
cd frontend
npm install
npm run dev
```

Code Quality

Backend — Ruff

cd document-parser
ruff check .          # lint
ruff check . --fix    # auto-fix
ruff format .         # format

Frontend — TypeScript + ESLint + Prettier

cd frontend
npm run type-check          # vue-tsc strict mode
npx eslint src/             # lint
npx prettier --check src/   # check formatting
npx prettier --write src/   # auto-format

Running Tests

=== "Backend"

```bash
cd document-parser
pytest tests/ -v
```

=== "Frontend"

```bash
cd frontend
npm run test:run
```

=== "E2E API (Karate)"

```bash
# Generate test PDFs + start stack
python e2e/generate-test-data.py
docker compose up -d --wait

# Run all API tests
mvn test -f e2e/api/pom.xml

# Or by tag: @smoke, @regression, @e2e
mvn test -f e2e/api/pom.xml -Dkarate.options="--tags @smoke"
```

=== "E2E UI (Karate UI)"

```bash
# Generate test PDFs + start stack (if not already running)
python e2e/generate-test-data.py
docker compose up -d --wait

# Run critical UI tests (CI scope)
mvn test -f e2e/ui/pom.xml -Dkarate.options="--tags @critical"

# Run all UI tests (local scope)
mvn test -f e2e/ui/pom.xml -Dkarate.options="--tags @ui"
```

All tests must pass before submitting a PR.

Pull Request Guidelines

Keep PRs focused — one feature or fix per PR
Add tests for new functionality
Update documentation if behavior changes
Ensure CI passes (lint + type-check + tests + build)

License

By contributing, you agree that your contributions will be licensed under the MIT License.

2.5 KiB Raw Blame History