Skip to content

Commit 6aeabbe

Browse files
authored
docs(fixtures): add manual testing guide and AGENTS.md to test project (#99)
* docs(fixtures): add manual testing guide and AGENTS.md to test project * docs(fixtures): consolidate AGENTS.md into README.md
1 parent da1612a commit 6aeabbe

1 file changed

Lines changed: 69 additions & 1 deletion

File tree

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,71 @@
11
# mypackage
22

3-
Minimal test project for manual validation of reqstool-python-poetry-plugin.
3+
Minimal test project for manual validation of `reqstool-python-poetry-plugin`.
4+
5+
## Prerequisites
6+
7+
A `.venv` must exist in the repository root with both the plugin and Poetry installed.
8+
If it is missing, recreate it from the repository root:
9+
10+
```bash
11+
python3.13 -m venv .venv
12+
.venv/bin/pip install -e .
13+
.venv/bin/pip install poetry
14+
```
15+
16+
Point Poetry at Python 3.13 (once per machine):
17+
18+
```bash
19+
cd tests/fixtures/test_project
20+
../../../.venv/bin/poetry env use python3.13
21+
```
22+
23+
## Validation
24+
25+
Run all commands from `tests/fixtures/test_project/`.
26+
27+
### 1 — Install
28+
29+
```bash
30+
../../../.venv/bin/poetry install
31+
```
32+
33+
Expected: plugin prints its version, then adds three entries to `pyproject.toml` under `[tool.poetry]`:
34+
35+
```toml
36+
include = ["reqstool_config.yml", "docs/reqstool/**/*", "build/reqstool/**/*"]
37+
```
38+
39+
### 2 — Build
40+
41+
```bash
42+
../../../.venv/bin/poetry build
43+
```
44+
45+
Expected output (in order):
46+
1. `[reqstool] plugin version <x.y.z>`
47+
2. `[reqstool] added to reqstool_config.yml: docs/reqstool/requirements.yml`
48+
3. `[reqstool] added to reqstool_config.yml: build/reqstool/annotations.yml`
49+
4. `[reqstool] Created reqstool_config.yml in project root`
50+
5. Poetry builds sdist + wheel
51+
6. `[reqstool] Removed reqstool_config.yml from project root`
52+
53+
### 3 — Verify
54+
55+
```bash
56+
# annotations.yml must exist
57+
test -f build/reqstool/annotations.yml && echo "OK: annotations.yml"
58+
59+
# reqstool_config.yml must be gone from project root after build
60+
test ! -f reqstool_config.yml && echo "OK: reqstool_config.yml cleaned up"
61+
62+
# sdist must contain all reqstool files
63+
tar -tzf dist/mypackage-0.1.0.tar.gz | sort
64+
```
65+
66+
Expected entries in the sdist:
67+
- `mypackage-0.1.0/reqstool_config.yml`
68+
- `mypackage-0.1.0/build/reqstool/annotations.yml`
69+
- `mypackage-0.1.0/docs/reqstool/requirements.yml`
70+
71+
`annotations.yml` must contain `REQ_001` mapped to `src.mypackage.main.hello`.

0 commit comments

Comments
 (0)