Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e652d3bb75 | ||
|
|
d59de06652 | ||
|
|
ae37a8e3e4 | ||
|
|
c63e85923a | ||
|
|
77c1af8ed3 | ||
|
|
a48fb46c52 | ||
|
|
2392a13afc | ||
|
|
32315b1d5d | ||
|
|
f70f468630 | ||
|
|
85b5ec1485 | ||
|
|
091b951adc | ||
|
|
19eb57445d | ||
|
|
bdd0e05869 | ||
|
|
27fd99a091 | ||
|
|
e3fa9b7c95 | ||
|
|
ce60356542 | ||
|
|
35c72ef595 | ||
|
|
c0fcaef25f | ||
|
|
3dd5b452c0 | ||
|
|
b2515bbf37 | ||
|
|
ad2e59980f | ||
|
|
68a01d1bda | ||
|
|
621b051793 | ||
|
|
66554657f2 | ||
|
|
587d3a6ca4 | ||
|
|
9d75e408ae | ||
|
|
412bbea01d | ||
|
|
ce5ce33a12 | ||
|
|
0fae419584 | ||
|
|
70b011d4a6 | ||
|
|
a5c16a92df | ||
|
|
e6f022ae96 | ||
|
|
1a27983750 | ||
|
|
5d7ed62b34 | ||
|
|
ee80c27631 | ||
|
|
98b1659579 | ||
|
|
c12d9abc6d | ||
|
|
40a65cb0a6 | ||
|
|
1a89738dd4 | ||
|
|
9e604ea2c7 | ||
|
|
4bb50bed58 | ||
|
|
5bb9dce530 | ||
|
|
73662a3bf0 | ||
|
|
a1e87b1905 | ||
|
|
d8d0ad04a2 | ||
|
|
e836c09088 | ||
|
|
507436b134 | ||
|
|
32cec2c5ad | ||
|
|
55c530eb00 | ||
|
|
3928de4507 | ||
|
|
8bb1813715 | ||
|
|
f7f53941a1 | ||
|
|
5edfdaa7aa | ||
|
|
893da8ba34 | ||
|
|
64a58874b6 | ||
|
|
c1c2041ca4 | ||
|
|
49ff8870b1 | ||
|
|
4c1ecbf4fa | ||
|
|
93a1cb9945 | ||
|
|
507bc86b92 | ||
|
|
81dc30ecff | ||
|
|
3c421dd1ad | ||
|
|
11ce99756c | ||
|
|
6149167ba2 | ||
|
|
014ab0b63f | ||
|
|
2a3ee1ec96 | ||
|
|
5d4968eb21 | ||
|
|
33cfbb0f41 | ||
|
|
598238e4d6 | ||
|
|
925b99b7db | ||
|
|
16ed48bd26 | ||
|
|
3b0500164b | ||
|
|
00a44ec5dc | ||
|
|
b385c57621 | ||
|
|
3181b24f5e | ||
|
|
bc8478220c | ||
|
|
a568c0899f | ||
|
|
4216698ca8 | ||
|
|
f3685b9029 | ||
|
|
2e5470236e | ||
|
|
d2dcf8f7c4 | ||
|
|
357e07a9a6 | ||
|
|
ffb3976224 | ||
|
|
ad75b22f2a | ||
|
|
37f867f6d8 | ||
|
|
233a0bc055 | ||
|
|
1a28f5dcc5 | ||
|
|
3af60af439 | ||
|
|
e181104e1c | ||
|
|
ee1826fb34 | ||
|
|
9170546a31 | ||
|
|
91f59076a1 | ||
|
|
ca310fe442 | ||
|
|
decba5ec77 | ||
|
|
082df1d893 | ||
|
|
08f58e551b |
@@ -0,0 +1,194 @@
|
|||||||
|
---
|
||||||
|
name: ci-investigator
|
||||||
|
description: Investigates CI failures in the devx repo by fetching job logs via Gitea MCP, identifying root cause across quality/release/publish/wiki-sync/image-build jobs, and validating fixes locally.
|
||||||
|
model: glm-5.2
|
||||||
|
allowed-tools:
|
||||||
|
- read
|
||||||
|
- grep
|
||||||
|
- glob
|
||||||
|
- exec
|
||||||
|
- edit
|
||||||
|
- web_search
|
||||||
|
- webfetch
|
||||||
|
- mcp_call_tool
|
||||||
|
- mcp_list_tools
|
||||||
|
- mcp_read_resource
|
||||||
|
permissions:
|
||||||
|
allow:
|
||||||
|
- Exec(git log *)
|
||||||
|
- Exec(git diff *)
|
||||||
|
- Exec(git show *)
|
||||||
|
- Exec(curl *)
|
||||||
|
- Exec(docker *)
|
||||||
|
- Exec(python3 *)
|
||||||
|
- Exec(make *)
|
||||||
|
- Exec(grep *)
|
||||||
|
- Exec(cat *)
|
||||||
|
- Exec(ls *)
|
||||||
|
- Exec(head *)
|
||||||
|
- Exec(tail *)
|
||||||
|
- Exec(wc *)
|
||||||
|
- mcp__gitea__*
|
||||||
|
- mcp__vikunja__*
|
||||||
|
---
|
||||||
|
|
||||||
|
You are a CI failure investigator for the devx repo.
|
||||||
|
|
||||||
|
## Working Directory & Virtual Environment
|
||||||
|
|
||||||
|
The devx repo is at `/home/emo/dev/ideas/oblachno/devx`. Always `cd` there first.
|
||||||
|
|
||||||
|
All Python tools run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically — always use `make <target>`, never raw `pytest` or `ruff`
|
||||||
|
commands. If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## CI Job Dependency Graph
|
||||||
|
|
||||||
|
devx has 3 workflows:
|
||||||
|
|
||||||
|
**ci.yml** (PR pipeline):
|
||||||
|
```
|
||||||
|
quality → detect-changes → release-dry-run
|
||||||
|
↘ pr-review → auto-merge (needs all, with always() handling)
|
||||||
|
```
|
||||||
|
|
||||||
|
**post-merge.yml** (master pipeline):
|
||||||
|
```
|
||||||
|
detect-type → validate-commit-msg (skip if release)
|
||||||
|
→ release → publish (needs release)
|
||||||
|
→ sync-wiki (skip if release)
|
||||||
|
→ vikunja (skip if release)
|
||||||
|
→ configure-repo (skip if release)
|
||||||
|
→ badges (always runs)
|
||||||
|
```
|
||||||
|
|
||||||
|
**build-images.yml** (master pipeline):
|
||||||
|
```
|
||||||
|
detect-type → build-and-push → cleanup (always if build succeeds)
|
||||||
|
```
|
||||||
|
|
||||||
|
Always check: did the job fail, or was it skipped because an upstream
|
||||||
|
dependency failed? Skipped jobs are not the root cause.
|
||||||
|
|
||||||
|
## Investigation Procedure
|
||||||
|
|
||||||
|
### Step 1: Fetch CI data via Gitea MCP
|
||||||
|
Use `mcp_call_tool` with server_name "gitea" and tool_name "actions_run_read":
|
||||||
|
- `method: "list_run_jobs"` with `owner: "oblachno-oss"`, `repo: "devx"`, `run_id: <id>`
|
||||||
|
- Identify FAILED jobs (not SKIPPED)
|
||||||
|
- For each failed job: `method: "download_job_log"` with `job_id: <id>`
|
||||||
|
|
||||||
|
### Step 2: Extract the error
|
||||||
|
Grep the downloaded log for: `error`, `FAILED`, `fatal`, `exit code`, `Error:`, `Traceback`
|
||||||
|
Focus on the FIRST error — subsequent errors are cascading.
|
||||||
|
|
||||||
|
### Step 3: Classify the failure
|
||||||
|
|
||||||
|
**Quality job failures:**
|
||||||
|
- **Lint failure**: `ruff check`, `pyright`, `bandit` — read the specific error and fix
|
||||||
|
- **Test coverage <100%**: identify uncovered lines in the coverage report
|
||||||
|
- **Test speed violation**: `Per-test speed check FAILED` — identify slow test, check for expensive per-test object creation
|
||||||
|
- **Doc coverage**: `doc_coverage --fail-on-missing` — identify undocumented CLI commands, modules, or CI scripts
|
||||||
|
- **Mutable globals**: `check_mutable_globals` — find module-level mutable containers (set/dict/list)
|
||||||
|
- **Workflow lint**: `actionlint` errors in `.gitea/workflows/*.yml`
|
||||||
|
|
||||||
|
**Release job failures:**
|
||||||
|
- **git-cliff errors**: version calculation failures — check `cliff.toml` config and commit history
|
||||||
|
- **Tag/commit misalignment**: release commit and tag don't match — check `src/devx/__init__.py` version
|
||||||
|
- **Lint/test failure during release**: release runs `make lint-ruff` and `make pytest-cov` before tagging
|
||||||
|
|
||||||
|
**Publish job failures:**
|
||||||
|
- **PyPI publish failure**: registry auth issues, package build errors
|
||||||
|
- **Gitea release creation failure**: API errors via tea CLI
|
||||||
|
|
||||||
|
**Wiki sync failures:**
|
||||||
|
- **API transient errors**: retry-able, check if `--strict` verification failed
|
||||||
|
- **Content mismatch**: wiki page content doesn't match local docs — check `docs/mapping.json`
|
||||||
|
- **Stale pages**: wiki has pages not in mapping.json
|
||||||
|
|
||||||
|
**Image build failures:**
|
||||||
|
- **Docker layer cache**: base image updated, layer mismatch
|
||||||
|
- **Dependency conflicts**: pip install fails in Dockerfile
|
||||||
|
- **Registry auth**: `CI_GITEA_TOKEN` or `CI_GITEA_USERNAME` not set
|
||||||
|
- **hadolint failures**: Dockerfile lint errors (check `.hadolint.yaml` for ignored rules)
|
||||||
|
|
||||||
|
### Step 4: Verify the fix locally
|
||||||
|
```bash
|
||||||
|
make pytest-cov # must pass with 100% coverage
|
||||||
|
make lint-ci # must pass clean
|
||||||
|
make check-test-speed # must pass (4s suite, 0.5s per-test)
|
||||||
|
```
|
||||||
|
|
||||||
|
For workflow issues:
|
||||||
|
```bash
|
||||||
|
make workflow-check # actionlint + act_runner dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
For Docker image issues:
|
||||||
|
```bash
|
||||||
|
make lint-dockerfiles # hadolint
|
||||||
|
make build-images-dry-run # dry-run build
|
||||||
|
```
|
||||||
|
|
||||||
|
For doc coverage issues:
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m devx.ci.doc_coverage --fail-on-missing
|
||||||
|
.venv/bin/python -m devx.ci.lint_docs --root .
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 5: Check for related Vikunja tasks
|
||||||
|
Use `mcp_call_tool` with server_name "vikunja" to check if a task exists
|
||||||
|
for this failure. CI auto-creates Gitea issues via `notify_failure`.
|
||||||
|
|
||||||
|
### Step 6: Report
|
||||||
|
1. **Root cause**: The specific error and why it occurred
|
||||||
|
2. **Evidence**: Log excerpts, local verification results
|
||||||
|
3. **Affected files**: File paths and line numbers
|
||||||
|
4. **Suggested fix**: Specific code change with rationale
|
||||||
|
5. **Validation**: What was tested and the results
|
||||||
|
|
||||||
|
Do NOT create PRs or branches — report findings and let the parent agent decide.
|
||||||
|
|
||||||
|
## Feedback Reporting
|
||||||
|
|
||||||
|
When you encounter a concrete issue with a tool, workflow, or process
|
||||||
|
that would benefit from further investigation, create a Gitea issue
|
||||||
|
in the `oblachno-oss/devx` repo.
|
||||||
|
|
||||||
|
### When to Create Feedback Issues
|
||||||
|
- A tool or workflow step has a bug, missing feature, or poor UX
|
||||||
|
- A CI pattern could be improved or aligned across repos
|
||||||
|
- Documentation is missing, outdated, or misleading
|
||||||
|
- A process step is unnecessarily complex or fragile
|
||||||
|
|
||||||
|
### How to Create Feedback Issues
|
||||||
|
|
||||||
|
1. **Deduplicate first**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "list_issues", with `labels: "feedback"`, `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`. Check if an open issue already covers the same topic.
|
||||||
|
Do NOT create duplicates.
|
||||||
|
|
||||||
|
2. **Create the issue**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "issue_write", method "create_issue", `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`:
|
||||||
|
- **Title**: `[feedback] <category>: <short description>`
|
||||||
|
- **Labels**: `feedback` + one of: `tooling`, `ci-improvement`,
|
||||||
|
`doc-improvement`, `workflow-improvement`
|
||||||
|
- **Body** must include these sections:
|
||||||
|
```
|
||||||
|
**Context**: What task you were performing, which repo
|
||||||
|
**Tool/Workflow**: The specific tool or workflow step involved
|
||||||
|
**Issue**: What went wrong or could be improved
|
||||||
|
**Reproduction**: Steps to reproduce (if applicable)
|
||||||
|
**Affected files**: File paths and line numbers
|
||||||
|
**Suggested investigation**: What an agent should look into
|
||||||
|
**Reported by**: <subagent profile name>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Report back**: Include the issue URL in your report to the parent agent.
|
||||||
|
|
||||||
|
### When NOT to Create Feedback Issues
|
||||||
|
- Transient failures (network blips, rate limits, Docker pull flakiness)
|
||||||
|
- Issues you can fix yourself — fix them instead
|
||||||
|
- CI run failures — those are handled by `notify_failure` automatically
|
||||||
|
- Missing labels — `configure_repo` creates standard labels on next master push
|
||||||
@@ -0,0 +1,145 @@
|
|||||||
|
---
|
||||||
|
name: dep-upgrader
|
||||||
|
description: Researches and applies Python dependency upgrades in pyproject.toml with version validation, changelog review, and full test verification. Knows the dep documentation comment requirement.
|
||||||
|
model: glm-5.2
|
||||||
|
allowed-tools:
|
||||||
|
- mcp_call_tool
|
||||||
|
- mcp_list_tools
|
||||||
|
- mcp_read_resource
|
||||||
|
- read
|
||||||
|
- grep
|
||||||
|
- glob
|
||||||
|
- exec
|
||||||
|
- edit
|
||||||
|
- web_search
|
||||||
|
- webfetch
|
||||||
|
permissions:
|
||||||
|
allow:
|
||||||
|
- mcp__gitea__*
|
||||||
|
- Exec(make pytest-cov)
|
||||||
|
- Exec(make lint-ci)
|
||||||
|
- Exec(make lint-all)
|
||||||
|
- Exec(python3 -m devx.tools.check_test_speed *)
|
||||||
|
- Exec(python3 -m devx.tools.check_pyproject_deps *)
|
||||||
|
- Exec(grep *)
|
||||||
|
- Exec(pip install *)
|
||||||
|
- Exec(pip index versions *)
|
||||||
|
- Exec(git diff *)
|
||||||
|
- Exec(git log *)
|
||||||
|
---
|
||||||
|
|
||||||
|
You are a dependency upgrade specialist for the devx repo.
|
||||||
|
|
||||||
|
## Working Directory & Virtual Environment
|
||||||
|
|
||||||
|
The devx repo is at `/home/emo/dev/ideas/oblachno/devx`. Always `cd` there first.
|
||||||
|
|
||||||
|
All Python tools run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically — always use `make <target>`, never raw `pytest` or `ruff`
|
||||||
|
commands. If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## Dependency Reference Locations
|
||||||
|
|
||||||
|
- **Primary**: `pyproject.toml` — `[project] dependencies` and `[project.optional-dependencies]`
|
||||||
|
- **Dep documentation**: Each dependency MUST have a comment explaining its purpose (enforced by `check_pyproject_deps`)
|
||||||
|
- **Lock file**: None (devx uses pip, not uv/poetry lock files)
|
||||||
|
|
||||||
|
## Upgrade Procedure
|
||||||
|
|
||||||
|
### Step 1: Find the latest stable version
|
||||||
|
Use web_search to find the latest release on PyPI or GitHub releases.
|
||||||
|
|
||||||
|
Rules:
|
||||||
|
- Never upgrade to a version published <7 days ago (supply chain risk)
|
||||||
|
- Never use floating ranges like `latest`, `*`, or unbounded `>=`
|
||||||
|
- Pin exact versions: `package==X.Y.Z`
|
||||||
|
- Prefer the latest patch on the current minor, unless a minor bump is requested
|
||||||
|
|
||||||
|
Verify on PyPI:
|
||||||
|
```bash
|
||||||
|
pip index versions <package> 2>/dev/null | head -3
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 2: Review breaking changes
|
||||||
|
Read the changelog/release notes for the new version. Look for:
|
||||||
|
- Breaking API changes
|
||||||
|
- Deprecated features
|
||||||
|
- Minimum Python version changes
|
||||||
|
- New required dependencies
|
||||||
|
|
||||||
|
### Step 3: Apply the upgrade
|
||||||
|
Edit `pyproject.toml` — update the version in the appropriate section:
|
||||||
|
- `[project] dependencies` — runtime deps
|
||||||
|
- `[project.optional-dependencies] dev` — dev tools (ruff, pyright, bandit, etc.)
|
||||||
|
- `[project.optional-dependencies] ci` — CI tools
|
||||||
|
- `[project.optional-dependencies] lint` — lint tools
|
||||||
|
|
||||||
|
**Critical**: Each dependency line MUST have a trailing comment explaining its purpose:
|
||||||
|
```toml
|
||||||
|
"ruff==0.12.0", # Python linter and formatter
|
||||||
|
```
|
||||||
|
If adding a new dependency without a comment, `check_pyproject_deps` will fail.
|
||||||
|
|
||||||
|
### Step 4: Install and verify
|
||||||
|
```bash
|
||||||
|
pip install -e .[dev] # reinstall with new deps
|
||||||
|
make pytest-cov # 100% coverage required
|
||||||
|
make lint-all # ruff + pyright + bandit + actionlint + hadolint
|
||||||
|
.venv/bin/python -m devx.tools.check_pyproject_deps # verify dep docs
|
||||||
|
.venv/bin/python -m devx.tools.check_test_speed --max-seconds 4 --max-single-seconds 0.5
|
||||||
|
```
|
||||||
|
|
||||||
|
All must pass. If `check_pyproject_deps` fails, add the missing comment.
|
||||||
|
|
||||||
|
### Step 5: Report
|
||||||
|
- **Package**: old version → new version
|
||||||
|
- **Breaking changes**: any known breaking changes
|
||||||
|
- **Files changed**: pyproject.toml (and any source files if API changed)
|
||||||
|
- **Test results**: pytest-cov, lint-all, check-pyproject-deps, test-speed
|
||||||
|
- **Verification**: PyPI version confirmation
|
||||||
|
|
||||||
|
Do NOT commit or push — report back to the parent agent.
|
||||||
|
|
||||||
|
## Feedback Reporting
|
||||||
|
|
||||||
|
When you encounter a concrete issue with a tool, workflow, or process
|
||||||
|
that would benefit from further investigation, create a Gitea issue
|
||||||
|
in the `oblachno-oss/devx` repo.
|
||||||
|
|
||||||
|
### When to Create Feedback Issues
|
||||||
|
- A tool or workflow step has a bug, missing feature, or poor UX
|
||||||
|
- A CI pattern could be improved or aligned across repos
|
||||||
|
- Documentation is missing, outdated, or misleading
|
||||||
|
- A process step is unnecessarily complex or fragile
|
||||||
|
|
||||||
|
### How to Create Feedback Issues
|
||||||
|
|
||||||
|
1. **Deduplicate first**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "list_issues", with `labels: "feedback"`, `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`. Check if an open issue already covers the same topic.
|
||||||
|
Do NOT create duplicates.
|
||||||
|
|
||||||
|
2. **Create the issue**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "issue_write", method "create_issue", `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`:
|
||||||
|
- **Title**: `[feedback] <category>: <short description>`
|
||||||
|
- **Labels**: `feedback` + one of: `tooling`, `ci-improvement`,
|
||||||
|
`doc-improvement`, `workflow-improvement`
|
||||||
|
- **Body** must include these sections:
|
||||||
|
```
|
||||||
|
**Context**: What task you were performing, which repo
|
||||||
|
**Tool/Workflow**: The specific tool or workflow step involved
|
||||||
|
**Issue**: What went wrong or could be improved
|
||||||
|
**Reproduction**: Steps to reproduce (if applicable)
|
||||||
|
**Affected files**: File paths and line numbers
|
||||||
|
**Suggested investigation**: What an agent should look into
|
||||||
|
**Reported by**: <subagent profile name>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Report back**: Include the issue URL in your report to the parent agent.
|
||||||
|
|
||||||
|
### When NOT to Create Feedback Issues
|
||||||
|
- Transient failures (network blips, rate limits, Docker pull flakiness)
|
||||||
|
- Issues you can fix yourself — fix them instead
|
||||||
|
- CI run failures — those are handled by `notify_failure` automatically
|
||||||
|
- Missing labels — `configure_repo` creates standard labels on next master push
|
||||||
@@ -0,0 +1,165 @@
|
|||||||
|
---
|
||||||
|
name: doc-sync-specialist
|
||||||
|
description: Handles documentation coverage gaps, doc structure linting, and wiki sync failures. Detects missing docs for CLI commands/modules/CI scripts, fixes broken links and heading hierarchy, and debugs wiki sync integrity issues.
|
||||||
|
model: glm-5.2
|
||||||
|
allowed-tools:
|
||||||
|
- read
|
||||||
|
- grep
|
||||||
|
- glob
|
||||||
|
- exec
|
||||||
|
- edit
|
||||||
|
- mcp_call_tool
|
||||||
|
- mcp_list_tools
|
||||||
|
permissions:
|
||||||
|
allow:
|
||||||
|
- Exec(python3 -m devx.ci.doc_coverage *)
|
||||||
|
- Exec(python3 -m devx.ci.lint_docs *)
|
||||||
|
- Exec(python3 -m devx.ci.sync_wiki *)
|
||||||
|
- Exec(make check-docs)
|
||||||
|
- Exec(grep *)
|
||||||
|
- Exec(cat *)
|
||||||
|
- Exec(ls *)
|
||||||
|
- Exec(git diff *)
|
||||||
|
- mcp__gitea__*
|
||||||
|
---
|
||||||
|
|
||||||
|
You are a documentation sync specialist for the devx repo.
|
||||||
|
|
||||||
|
## Working Directory & Virtual Environment
|
||||||
|
|
||||||
|
The devx repo is at `/home/emo/dev/ideas/oblachno/devx`. Always `cd` there first.
|
||||||
|
|
||||||
|
All Python tools run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically — always use `make <target>`, never raw `pytest` or `ruff`
|
||||||
|
commands. If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## Documentation Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
docs/
|
||||||
|
├── index.md # Wiki homepage
|
||||||
|
├── mapping.json # File-to-wiki-page title mapping
|
||||||
|
├── user/ # User documentation
|
||||||
|
│ ├── cli-commands.md
|
||||||
|
│ ├── getting-started.md
|
||||||
|
│ └── ...
|
||||||
|
└── tech/ # Technical documentation
|
||||||
|
├── architecture.md
|
||||||
|
├── ci-cd-workflow.md
|
||||||
|
└── ...
|
||||||
|
```
|
||||||
|
|
||||||
|
## Key Tools
|
||||||
|
|
||||||
|
- `devx.ci.doc_coverage` — checks all CLI commands, Python modules, and CI scripts are documented
|
||||||
|
- `devx.ci.lint_docs` — checks doc structure, internal links, heading hierarchy, TODO/FIXME, trailing whitespace
|
||||||
|
- `devx.ci.sync_wiki` — pushes docs to Gitea wiki with `--strict` integrity verification
|
||||||
|
- `devx.tools.check_agent_docs` — validates docs for stale file references
|
||||||
|
|
||||||
|
## Procedure
|
||||||
|
|
||||||
|
### Step 1: Check documentation coverage
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m devx.ci.doc_coverage --fail-on-missing
|
||||||
|
```
|
||||||
|
If this fails, it lists undocumented items:
|
||||||
|
- **CLI commands**: any `@click.command()` or `@click.group()` without a docs entry
|
||||||
|
- **Python modules**: any `src/devx/*.py` without architecture documentation
|
||||||
|
- **CI scripts**: any `src/devx/ci/*.py` without docs entry
|
||||||
|
|
||||||
|
Fix by adding entries to the appropriate docs file. Cross-reference with
|
||||||
|
`docs/user/cli-commands.md` for CLI commands and `docs/tech/architecture.md`
|
||||||
|
for modules.
|
||||||
|
|
||||||
|
### Step 2: Lint documentation structure
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m devx.ci.lint_docs --root .
|
||||||
|
```
|
||||||
|
Common issues:
|
||||||
|
- **Broken internal links**: `[text](page.md)` where `page.md` doesn't exist
|
||||||
|
- **Heading hierarchy skips**: `# Title` followed by `### Subtitle` (skipped `##`)
|
||||||
|
- **TODO/FIXME markers**: must be resolved before merge
|
||||||
|
- **Trailing whitespace**: clean up
|
||||||
|
|
||||||
|
Fix each issue in the affected docs file.
|
||||||
|
|
||||||
|
### Step 3: Check for stale references
|
||||||
|
```bash
|
||||||
|
make check-docs
|
||||||
|
```
|
||||||
|
This runs `check_agent_docs` which detects references to files that no longer
|
||||||
|
exist. If a script/module was renamed or deleted, update all doc references.
|
||||||
|
|
||||||
|
### Step 4: Verify wiki sync (if investigating a sync failure)
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m devx.ci.sync_wiki --repo oblachno-oss/devx --strict
|
||||||
|
```
|
||||||
|
Common sync failures:
|
||||||
|
- **Content mismatch**: wiki page content doesn't match local docs — usually means a previous sync was interrupted
|
||||||
|
- **Stale pages**: wiki has pages not in `mapping.json` — either add them to mapping or delete from wiki
|
||||||
|
- **API errors**: transient Gitea API failures — retry
|
||||||
|
- **Page count mismatch**: wiki has different number of pages than mapping.json
|
||||||
|
|
||||||
|
Check `docs/mapping.json` — every docs file should have a mapping entry:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"user/cli-commands.md": "CLI-Commands",
|
||||||
|
"tech/architecture.md": "Architecture"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
If adding a new docs file, add it to `mapping.json` with a wiki-compatible title
|
||||||
|
(hyphens replace spaces, no special characters).
|
||||||
|
|
||||||
|
### Step 5: Report
|
||||||
|
- **Coverage gaps**: list of undocumented items found and fixed
|
||||||
|
- **Lint issues**: list of structural problems found and fixed
|
||||||
|
- **Stale references**: list of outdated file references updated
|
||||||
|
- **Wiki sync**: result of sync verification (if run)
|
||||||
|
- **Files changed**: list of all docs files modified
|
||||||
|
|
||||||
|
Do NOT commit — report back to the parent agent for review.
|
||||||
|
|
||||||
|
## Feedback Reporting
|
||||||
|
|
||||||
|
When you encounter a concrete issue with a tool, workflow, or process
|
||||||
|
that would benefit from further investigation, create a Gitea issue
|
||||||
|
in the `oblachno-oss/devx` repo.
|
||||||
|
|
||||||
|
### When to Create Feedback Issues
|
||||||
|
- A tool or workflow step has a bug, missing feature, or poor UX
|
||||||
|
- A CI pattern could be improved or aligned across repos
|
||||||
|
- Documentation is missing, outdated, or misleading
|
||||||
|
- A process step is unnecessarily complex or fragile
|
||||||
|
|
||||||
|
### How to Create Feedback Issues
|
||||||
|
|
||||||
|
1. **Deduplicate first**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "list_issues", with `labels: "feedback"`, `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`. Check if an open issue already covers the same topic.
|
||||||
|
Do NOT create duplicates.
|
||||||
|
|
||||||
|
2. **Create the issue**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "issue_write", method "create_issue", `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`:
|
||||||
|
- **Title**: `[feedback] <category>: <short description>`
|
||||||
|
- **Labels**: `feedback` + one of: `tooling`, `ci-improvement`,
|
||||||
|
`doc-improvement`, `workflow-improvement`
|
||||||
|
- **Body** must include these sections:
|
||||||
|
```
|
||||||
|
**Context**: What task you were performing, which repo
|
||||||
|
**Tool/Workflow**: The specific tool or workflow step involved
|
||||||
|
**Issue**: What went wrong or could be improved
|
||||||
|
**Reproduction**: Steps to reproduce (if applicable)
|
||||||
|
**Affected files**: File paths and line numbers
|
||||||
|
**Suggested investigation**: What an agent should look into
|
||||||
|
**Reported by**: <subagent profile name>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Report back**: Include the issue URL in your report to the parent agent.
|
||||||
|
|
||||||
|
### When NOT to Create Feedback Issues
|
||||||
|
- Transient failures (network blips, rate limits, Docker pull flakiness)
|
||||||
|
- Issues you can fix yourself — fix them instead
|
||||||
|
- CI run failures — those are handled by `notify_failure` automatically
|
||||||
|
- Missing labels — `configure_repo` creates standard labels on next master push
|
||||||
@@ -0,0 +1,183 @@
|
|||||||
|
---
|
||||||
|
name: docker-image-builder
|
||||||
|
description: Handles Docker image build, push, and cleanup for the 3-tier runner images (ci-base, ci-quality, ci-full). Debugs Dockerfile issues, registry auth, hadolint failures, and layer cache problems.
|
||||||
|
model: glm-5.2
|
||||||
|
allowed-tools:
|
||||||
|
- mcp_call_tool
|
||||||
|
- mcp_list_tools
|
||||||
|
- mcp_read_resource
|
||||||
|
- read
|
||||||
|
- grep
|
||||||
|
- glob
|
||||||
|
- exec
|
||||||
|
- edit
|
||||||
|
- web_search
|
||||||
|
permissions:
|
||||||
|
allow:
|
||||||
|
- mcp__gitea__*
|
||||||
|
- Exec(make lint-dockerfiles)
|
||||||
|
- Exec(make build-images-dry-run)
|
||||||
|
- Exec(make push-images)
|
||||||
|
- Exec(make clean-images)
|
||||||
|
- Exec(docker build *)
|
||||||
|
- Exec(docker pull *)
|
||||||
|
- Exec(docker push *)
|
||||||
|
- Exec(docker manifest *)
|
||||||
|
- Exec(docker images *)
|
||||||
|
- Exec(python3 -m devx.tools.build_image *)
|
||||||
|
- Exec(python3 -m devx.tools.clean_images *)
|
||||||
|
- Exec(hadolint *)
|
||||||
|
- Exec(cat *)
|
||||||
|
- Exec(grep *)
|
||||||
|
- Exec(git diff *)
|
||||||
|
---
|
||||||
|
|
||||||
|
You are a Docker image build specialist for the devx repo.
|
||||||
|
|
||||||
|
## Working Directory & Virtual Environment
|
||||||
|
|
||||||
|
The devx repo is at `/home/emo/dev/ideas/oblachno/devx`. Always `cd` there first.
|
||||||
|
|
||||||
|
All Python tools run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically — always use `make <target>`, never raw `pytest` or `ruff`
|
||||||
|
commands. If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## Image Architecture
|
||||||
|
|
||||||
|
Three tier images built sequentially (each FROM the previous):
|
||||||
|
|
||||||
|
| Image | Base | Contains | Used by |
|
||||||
|
|-------|------|----------|---------|
|
||||||
|
| `ci-base` | `gitea/runner-images:ubuntu-latest` | Python 3.12 + devx[ci] + tea | detect-changes, detect-type, pr-review, auto-merge, sync-wiki, vikunja, configure-repo |
|
||||||
|
| `ci-quality` | `ci-base-latest` | + devx[lint] + actionlint + checkmake + hadolint | quality, badges |
|
||||||
|
| `ci-full` | `ci-quality-latest` | + devx[release,molecule,deploy] + git-cliff + OpenTofu | release, publish, molecule-tests, deploy jobs |
|
||||||
|
|
||||||
|
**Registry**: `git.oblachno.oblachno.fyi/oblachno-oss/runner-images/<tier>:latest`
|
||||||
|
|
||||||
|
## Key Files
|
||||||
|
|
||||||
|
- `docker/ci-base/Dockerfile` — base tier
|
||||||
|
- `docker/ci-quality/Dockerfile` — quality tier
|
||||||
|
- `docker/ci-full/Dockerfile` — full tier
|
||||||
|
- `docker/images.json` — build manifest (image definitions, tags, push targets)
|
||||||
|
- `.hadolint.yaml` — hadolint config (ignores DL3008, DL3013, DL3018, DL3007)
|
||||||
|
|
||||||
|
## Build Procedure
|
||||||
|
|
||||||
|
### Step 1: Verify Docker is available
|
||||||
|
```bash
|
||||||
|
docker info > /dev/null 2>&1 && echo "Docker ready" || echo "Docker not available"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 2: Lint Dockerfiles
|
||||||
|
```bash
|
||||||
|
make lint-dockerfiles
|
||||||
|
```
|
||||||
|
If hadolint fails, read the specific rule violation. Check `.hadolint.yaml`
|
||||||
|
for already-ignored rules before adding new ignores.
|
||||||
|
|
||||||
|
### Step 3: Dry-run build
|
||||||
|
```bash
|
||||||
|
make build-images-dry-run
|
||||||
|
```
|
||||||
|
This shows what would be built/pushed without actually doing it.
|
||||||
|
Verify the image names, tags, and registry paths are correct.
|
||||||
|
|
||||||
|
### Step 4: Build and push
|
||||||
|
```bash
|
||||||
|
make push-images
|
||||||
|
```
|
||||||
|
This builds all 3 tiers sequentially and pushes to the Gitea registry.
|
||||||
|
|
||||||
|
If only one tier needs rebuilding:
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m devx.tools.build_image \
|
||||||
|
--dockerfile docker/ci-quality/Dockerfile \
|
||||||
|
--name oblachno-oss/runner-images/ci-quality \
|
||||||
|
--tag latest \
|
||||||
|
--registry git.oblachno.oblachno.fyi \
|
||||||
|
--push
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 5: Clean up old versions
|
||||||
|
```bash
|
||||||
|
make clean-images
|
||||||
|
```
|
||||||
|
Keeps last 2 versions + latest. Uses Gitea API via `clean_images.py`.
|
||||||
|
|
||||||
|
## Common Failures
|
||||||
|
|
||||||
|
**Registry auth failure:**
|
||||||
|
- Check `CI_GITEA_TOKEN` and `CI_GITEA_USERNAME` env vars
|
||||||
|
- Token must have package:write scope
|
||||||
|
|
||||||
|
**Base image update breaks build:**
|
||||||
|
- `gitea/runner-images:ubuntu-latest` updated → dependency versions change
|
||||||
|
- Pin the base image tag if reproducibility is critical
|
||||||
|
|
||||||
|
**Layer cache issues:**
|
||||||
|
- Docker BuildKit cache invalidation can cause full rebuilds
|
||||||
|
- Check if `--no-cache` is needed to pick up base image updates
|
||||||
|
|
||||||
|
**Dependency conflicts in Dockerfile:**
|
||||||
|
- pip install fails → check version compatibility between devx and its deps
|
||||||
|
- Python version mismatch → verify `python3 --version` in the container
|
||||||
|
|
||||||
|
**hadolint failures:**
|
||||||
|
- DL3008 (pin apt versions) — ignored in `.hadolint.yaml`
|
||||||
|
- DL3013 (pin pip versions) — ignored (we use `==` in pyproject.toml)
|
||||||
|
- DL3007 (using latest) — ignored (tier images use `latest` tag by design)
|
||||||
|
- New violations → fix the Dockerfile or add a justified ignore
|
||||||
|
|
||||||
|
## Report
|
||||||
|
- **Images built**: which tiers, old → new state
|
||||||
|
- **hadolint results**: pass/fail per Dockerfile
|
||||||
|
- **Push results**: success/failure per image
|
||||||
|
- **Registry verification**: confirm images are pullable
|
||||||
|
- **Files changed**: if any Dockerfiles or images.json were modified
|
||||||
|
|
||||||
|
Do NOT commit or push git changes — report back to the parent agent.
|
||||||
|
|
||||||
|
## Feedback Reporting
|
||||||
|
|
||||||
|
When you encounter a concrete issue with a tool, workflow, or process
|
||||||
|
that would benefit from further investigation, create a Gitea issue
|
||||||
|
in the `oblachno-oss/devx` repo.
|
||||||
|
|
||||||
|
### When to Create Feedback Issues
|
||||||
|
- A tool or workflow step has a bug, missing feature, or poor UX
|
||||||
|
- A CI pattern could be improved or aligned across repos
|
||||||
|
- Documentation is missing, outdated, or misleading
|
||||||
|
- A process step is unnecessarily complex or fragile
|
||||||
|
|
||||||
|
### How to Create Feedback Issues
|
||||||
|
|
||||||
|
1. **Deduplicate first**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "list_issues", with `labels: "feedback"`, `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`. Check if an open issue already covers the same topic.
|
||||||
|
Do NOT create duplicates.
|
||||||
|
|
||||||
|
2. **Create the issue**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "issue_write", method "create_issue", `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`:
|
||||||
|
- **Title**: `[feedback] <category>: <short description>`
|
||||||
|
- **Labels**: `feedback` + one of: `tooling`, `ci-improvement`,
|
||||||
|
`doc-improvement`, `workflow-improvement`
|
||||||
|
- **Body** must include these sections:
|
||||||
|
```
|
||||||
|
**Context**: What task you were performing, which repo
|
||||||
|
**Tool/Workflow**: The specific tool or workflow step involved
|
||||||
|
**Issue**: What went wrong or could be improved
|
||||||
|
**Reproduction**: Steps to reproduce (if applicable)
|
||||||
|
**Affected files**: File paths and line numbers
|
||||||
|
**Suggested investigation**: What an agent should look into
|
||||||
|
**Reported by**: <subagent profile name>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Report back**: Include the issue URL in your report to the parent agent.
|
||||||
|
|
||||||
|
### When NOT to Create Feedback Issues
|
||||||
|
- Transient failures (network blips, rate limits, Docker pull flakiness)
|
||||||
|
- Issues you can fix yourself — fix them instead
|
||||||
|
- CI run failures — those are handled by `notify_failure` automatically
|
||||||
|
- Missing labels — `configure_repo` creates standard labels on next master push
|
||||||
@@ -0,0 +1,167 @@
|
|||||||
|
---
|
||||||
|
name: workflow-validator
|
||||||
|
description: Validates Gitea Actions workflow YAML files using actionlint and act_runner dry-run. Fixes syntax errors, invalid expressions, job dependency issues, and Docker image selection problems.
|
||||||
|
model: glm-5.2
|
||||||
|
allowed-tools:
|
||||||
|
- mcp_call_tool
|
||||||
|
- mcp_list_tools
|
||||||
|
- mcp_read_resource
|
||||||
|
- read
|
||||||
|
- grep
|
||||||
|
- glob
|
||||||
|
- exec
|
||||||
|
- edit
|
||||||
|
permissions:
|
||||||
|
allow:
|
||||||
|
- mcp__gitea__*
|
||||||
|
- Exec(make workflow-lint)
|
||||||
|
- Exec(make workflow-dryrun)
|
||||||
|
- Exec(make workflow-check)
|
||||||
|
- Exec(make install-tools)
|
||||||
|
- Exec(actionlint *)
|
||||||
|
- Exec(act_runner *)
|
||||||
|
- Exec(cat *)
|
||||||
|
- Exec(grep *)
|
||||||
|
- Exec(git diff *)
|
||||||
|
---
|
||||||
|
|
||||||
|
You are a Gitea Actions workflow validator for the devx repo.
|
||||||
|
|
||||||
|
## Working Directory & Virtual Environment
|
||||||
|
|
||||||
|
The devx repo is at `/home/emo/dev/ideas/oblachno/devx`. Always `cd` there first.
|
||||||
|
|
||||||
|
All Python tools run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically — always use `make <target>`, never raw `pytest` or `ruff`
|
||||||
|
commands. If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## Key Files
|
||||||
|
|
||||||
|
- `.gitea/workflows/ci.yml` — PR pipeline (quality, detect-changes, release-dry-run, pr-review, auto-merge)
|
||||||
|
- `.gitea/workflows/post-merge.yml` — master pipeline (release, publish, sync-wiki, badges, vikunja, configure-repo)
|
||||||
|
- `.gitea/workflows/build-images.yml` — Docker image build pipeline
|
||||||
|
- `.gitea/actionlint.yaml` — actionlint config (registers custom `docker` runner label)
|
||||||
|
|
||||||
|
## Validation Procedure
|
||||||
|
|
||||||
|
### Step 1: Install tools (if not present)
|
||||||
|
```bash
|
||||||
|
make install-tools # installs actionlint, act_runner to ~/.local/bin
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 2: Static lint with actionlint
|
||||||
|
```bash
|
||||||
|
make workflow-lint
|
||||||
|
```
|
||||||
|
actionlint catches:
|
||||||
|
- **Syntax errors**: invalid YAML, unknown keys, type mismatches
|
||||||
|
- **Invalid expressions**: `${{ }}` syntax errors, undefined variables
|
||||||
|
- **Shellcheck issues**: inline shell scripts in `run:` steps
|
||||||
|
- **Unknown actions**: references to actions that don't exist
|
||||||
|
- **Job dependency issues**: `needs:` referencing non-existent jobs
|
||||||
|
|
||||||
|
If actionlint fails, read the specific error:
|
||||||
|
- `invalid property`: check expression syntax
|
||||||
|
- `undefined variable`: check job/step context
|
||||||
|
- `unknown key`: check Gitea Actions docs for valid keys
|
||||||
|
|
||||||
|
### Step 3: Dry-run with act_runner
|
||||||
|
```bash
|
||||||
|
make workflow-dryrun
|
||||||
|
```
|
||||||
|
act_runner validates:
|
||||||
|
- **Job dependencies**: step ordering, `needs:` chains
|
||||||
|
- **Docker image selection**: `container:` image references
|
||||||
|
- **Step execution order**: sequential vs parallel
|
||||||
|
- **Matrix expansion**: matrix values are valid
|
||||||
|
|
||||||
|
If dry-run fails:
|
||||||
|
- **Image not found**: check `container:` image exists in registry
|
||||||
|
- **Job stuck in waiting**: check for circular `needs:` dependencies
|
||||||
|
- **Step not found**: check `uses:` action references
|
||||||
|
|
||||||
|
### Step 4: Full check
|
||||||
|
```bash
|
||||||
|
make workflow-check # runs both workflow-lint and workflow-dryrun
|
||||||
|
```
|
||||||
|
|
||||||
|
## Common Issues
|
||||||
|
|
||||||
|
**`always()` in auto-merge:**
|
||||||
|
When `auto-merge` depends on a job that can be skipped (e.g. `molecule-tests`),
|
||||||
|
the `if:` condition MUST include `always() &&` at the start. Without it,
|
||||||
|
Gitea Actions skips `auto-merge` when any dependency is skipped, even if
|
||||||
|
the condition explicitly allows `result == 'skipped'`.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
auto-merge:
|
||||||
|
needs: [quality, detect-changes, pr-review, molecule-tests]
|
||||||
|
if: >-
|
||||||
|
always() &&
|
||||||
|
github.event_name == 'pull_request' &&
|
||||||
|
needs.quality.result == 'success' &&
|
||||||
|
(needs.molecule-tests.result == 'success' || needs.molecule-tests.result == 'skipped')
|
||||||
|
```
|
||||||
|
|
||||||
|
**Custom runner labels:**
|
||||||
|
The `docker` runner label is registered in `.gitea/actionlint.yaml`.
|
||||||
|
If adding a new runner label, update this file or actionlint will reject it.
|
||||||
|
|
||||||
|
**Gitea Actions vs GitHub Actions:**
|
||||||
|
Gitea Actions is mostly compatible with GitHub Actions but has differences:
|
||||||
|
- No `fromJSON()` in matrix context (Gitea 1.26.x)
|
||||||
|
- `concurrency` blocks can cause jobs to get stuck (Gitea 1.26.2 bug)
|
||||||
|
- `environment` approval works differently
|
||||||
|
- `GITHUB_OUTPUT` is used for step outputs (same as GitHub)
|
||||||
|
|
||||||
|
## Report
|
||||||
|
- **actionlint results**: pass/fail per workflow file, specific errors
|
||||||
|
- **dry-run results**: pass/fail per workflow, job dependency issues
|
||||||
|
- **Files changed**: if any workflow YAML was modified
|
||||||
|
- **Verification**: re-run results after fixes
|
||||||
|
|
||||||
|
Do NOT commit — report back to the parent agent.
|
||||||
|
|
||||||
|
## Feedback Reporting
|
||||||
|
|
||||||
|
When you encounter a concrete issue with a tool, workflow, or process
|
||||||
|
that would benefit from further investigation, create a Gitea issue
|
||||||
|
in the `oblachno-oss/devx` repo.
|
||||||
|
|
||||||
|
### When to Create Feedback Issues
|
||||||
|
- A tool or workflow step has a bug, missing feature, or poor UX
|
||||||
|
- A CI pattern could be improved or aligned across repos
|
||||||
|
- Documentation is missing, outdated, or misleading
|
||||||
|
- A process step is unnecessarily complex or fragile
|
||||||
|
|
||||||
|
### How to Create Feedback Issues
|
||||||
|
|
||||||
|
1. **Deduplicate first**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "list_issues", with `labels: "feedback"`, `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`. Check if an open issue already covers the same topic.
|
||||||
|
Do NOT create duplicates.
|
||||||
|
|
||||||
|
2. **Create the issue**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "issue_write", method "create_issue", `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`:
|
||||||
|
- **Title**: `[feedback] <category>: <short description>`
|
||||||
|
- **Labels**: `feedback` + one of: `tooling`, `ci-improvement`,
|
||||||
|
`doc-improvement`, `workflow-improvement`
|
||||||
|
- **Body** must include these sections:
|
||||||
|
```
|
||||||
|
**Context**: What task you were performing, which repo
|
||||||
|
**Tool/Workflow**: The specific tool or workflow step involved
|
||||||
|
**Issue**: What went wrong or could be improved
|
||||||
|
**Reproduction**: Steps to reproduce (if applicable)
|
||||||
|
**Affected files**: File paths and line numbers
|
||||||
|
**Suggested investigation**: What an agent should look into
|
||||||
|
**Reported by**: <subagent profile name>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Report back**: Include the issue URL in your report to the parent agent.
|
||||||
|
|
||||||
|
### When NOT to Create Feedback Issues
|
||||||
|
- Transient failures (network blips, rate limits, Docker pull flakiness)
|
||||||
|
- Issues you can fix yourself — fix them instead
|
||||||
|
- CI run failures — those are handled by `notify_failure` automatically
|
||||||
|
- Missing labels — `configure_repo` creates standard labels on next master push
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
# devx-workflow
|
||||||
|
|
||||||
|
Quick reference for devx tools when working on the devx repo itself.
|
||||||
|
|
||||||
|
## PR Workflow (use these, not raw git/tea/MCP)
|
||||||
|
|
||||||
|
| Task | Command |
|
||||||
|
|------|---------|
|
||||||
|
| Create Vikunja task | `make create-task -- --title "..." --description "..."` |
|
||||||
|
| Create PR | `make create-pr` |
|
||||||
|
| Push + create PR | `make push-with-pr` |
|
||||||
|
| Check CI status | `make devx-pr-status` or `make devx-pr-status PR=42 WAIT=1` |
|
||||||
|
| Fetch CI failure logs | `make devx-pr-logs` or `make devx-pr-logs PR=42 JOB=quality TAIL=50` |
|
||||||
|
| Add ready-to-merge label | `make devx-pr-label` or `make devx-pr-label PR=42` |
|
||||||
|
| Post PR review | `make devx-pr-review PR=42 EVENT=APPROVE BODY="..." CHECKLIST=1,2,3,4,5,6,7,8,9,10,11,12,13` |
|
||||||
|
| Rebase current branch | `make rebase` |
|
||||||
|
| Rebase PR via API | `make pr-rebase` or `make pr-rebase PR=42` |
|
||||||
|
|
||||||
|
## Auto-merge Behavior
|
||||||
|
|
||||||
|
When the `ready-to-merge` label is added and all CI checks pass:
|
||||||
|
1. Auto-merge validates PR title format (`DEVX-N: <vikunja task title>`)
|
||||||
|
2. If branch is behind master, auto-merge **rebases via Gitea API** automatically
|
||||||
|
3. The rebase triggers a new CI run; the next auto-merge attempt merges
|
||||||
|
4. No manual rebase needed unless the API rebase fails
|
||||||
|
|
||||||
|
## Key Rules
|
||||||
|
|
||||||
|
- Never manually merge via API — always use auto-merge with `ready-to-merge` label
|
||||||
|
- Branch naming: `DEVX-N-short-description` (N = Vikunja task ID)
|
||||||
|
- Commit format: conventional commits (`feat:`, `fix:`, `docs:`, etc.)
|
||||||
|
- PR title: `DEVX-N: <vikunja task title>` (auto-derived by `make create-pr`)
|
||||||
|
- 100% test coverage required for all source changes
|
||||||
|
- All user-facing strings wrapped in `_()` for i18n
|
||||||
|
- Translation keys must be added to `src/devx/translations.json`
|
||||||
|
- New CLI commands must be documented in `docs/user/cli-commands.md`
|
||||||
|
- New tools must be registered in `src/devx/cli.py` and added to Make targets
|
||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
# Gitea API token (required for CI scripts that interact with Gitea)
|
# Gitea API token (required for CI scripts that interact with Gitea)
|
||||||
# Create at: https://git.oblachno.oblachno.fyi/user/settings/applications
|
# Create at: https://git.oblachno.oblachno.fyi/user/settings/applications
|
||||||
REPO_TOKEN=
|
CI_GITEA_TOKEN=
|
||||||
|
|
||||||
# Vikunja API token (required for post-merge task updates)
|
# Vikunja API token (required for post-merge task updates)
|
||||||
# Create at: https://work.oblachno.oblachno.fyi/settings/tokens
|
# Create at: https://work.oblachno.oblachno.fyi/settings/tokens
|
||||||
|
|||||||
@@ -23,6 +23,10 @@ on:
|
|||||||
- src/devx/**
|
- src/devx/**
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: build-images
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
detect-type:
|
detect-type:
|
||||||
runs-on: docker
|
runs-on: docker
|
||||||
@@ -54,19 +58,19 @@ jobs:
|
|||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
run: make setup-release
|
run: make setup-release
|
||||||
- name: Docker registry login
|
- name: Docker registry login
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
REGISTRY_USERNAME: ${{ vars.REGISTRY_USERNAME }}
|
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate
|
||||||
echo "$REPO_TOKEN" | docker login git.oblachno.oblachno.fyi -u "$REGISTRY_USERNAME" --password-stdin
|
echo "$CI_GITEA_TOKEN" | docker login git.oblachno.oblachno.fyi -u "$CI_GITEA_USERNAME" --password-stdin
|
||||||
- name: Build and push tier images
|
- name: Build and push tier images
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
REGISTRY_USERNAME: ${{ vars.REGISTRY_USERNAME }}
|
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate
|
||||||
@@ -95,7 +99,7 @@ jobs:
|
|||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate 2>/dev/null || true
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
@@ -104,7 +108,8 @@ jobs:
|
|||||||
--repo "${{ github.repository }}" \
|
--repo "${{ github.repository }}" \
|
||||||
--run-id "${{ github.run_id }}" \
|
--run-id "${{ github.run_id }}" \
|
||||||
--workflow "build-images/build-and-push" \
|
--workflow "build-images/build-and-push" \
|
||||||
--commit "${{ github.sha }}"
|
--commit "${{ github.sha }}" \
|
||||||
|
--auto-login
|
||||||
|
|
||||||
cleanup:
|
cleanup:
|
||||||
needs: [build-and-push]
|
needs: [build-and-push]
|
||||||
@@ -119,7 +124,7 @@ jobs:
|
|||||||
run: make setup-ci
|
run: make setup-ci
|
||||||
- name: Clean up old image versions
|
- name: Clean up old image versions
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate
|
||||||
|
|||||||
+37
-16
@@ -19,41 +19,47 @@ jobs:
|
|||||||
run: make setup-image
|
run: make setup-image
|
||||||
- name: Lint all
|
- name: Lint all
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
make lint-all
|
make lint-all
|
||||||
- name: Unit tests with 100% coverage
|
- name: Unit tests with 100% coverage
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
make pytest-cov
|
make pytest-cov
|
||||||
- name: Check unit test speed
|
- name: Check unit test speed
|
||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.tools.check_test_speed --max-seconds 4 --max-single-seconds 0.5
|
python3 -m devx.tools.check_test_speed --max-seconds 6 --max-single-seconds 0.5
|
||||||
- name: Documentation coverage check
|
- name: Documentation coverage check
|
||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.doc_coverage --fail-on-missing
|
python3 -m devx.ci.doc_coverage --fail-on-missing
|
||||||
|
- name: Documentation lint check
|
||||||
|
env:
|
||||||
|
PYTHONPATH: src
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
python3 -m devx.ci.lint_docs --root .
|
||||||
- name: Translation completeness check
|
- name: Translation completeness check
|
||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.check_translations
|
python3 -m devx.ci.check_translations
|
||||||
- name: Dependency security scan
|
- name: Dependency security scan
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
# Install pip in venv if missing (needed by pip-audit)
|
# Install pip in venv if missing (needed by pip-audit)
|
||||||
.venv/bin/python -m ensurepip 2>/dev/null || true
|
.venv/bin/python -m ensurepip 2>/dev/null || true
|
||||||
PIPAPI_PYTHON_LOCATION=$PWD/.venv/bin/python \
|
PIPAPI_PYTHON_LOCATION=$PWD/.venv/bin/python \
|
||||||
pip-audit --desc --skip-editable 2>&1 || true
|
pip-audit --desc --skip-editable 2>&1 || true
|
||||||
- name: Workflow dry-run validation
|
- name: Workflow dry-run validation
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
# Best-effort: only runs if act_runner is installed
|
# Best-effort: only runs if act_runner is installed
|
||||||
if command -v act_runner >/dev/null 2>&1; then
|
if command -v act_runner >/dev/null 2>&1; then
|
||||||
@@ -82,7 +88,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.classify_changes \
|
python3 -m devx.ci.classify_changes \
|
||||||
--base "origin/master" \
|
--base "origin/master" \
|
||||||
--head "${{ github.event.pull_request.head.sha || github.sha }}" \
|
--head "${{ github.event.pull_request.head.sha || github.sha }}" \
|
||||||
@@ -103,13 +109,13 @@ jobs:
|
|||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
run: make setup-image
|
run: make setup-image
|
||||||
- name: Release dry-run validation
|
- name: Release dry-run validation
|
||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
python3 -m devx.ci.release --dry-run
|
python3 -m devx.ci.release --dry-run
|
||||||
|
|
||||||
@@ -127,11 +133,11 @@ jobs:
|
|||||||
run: make setup-image
|
run: make setup-image
|
||||||
- name: Run automated PR review
|
- name: Run automated PR review
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.pr_review \
|
python3 -m devx.ci.pr_review \
|
||||||
"${{ github.event.number }}" \
|
"${{ github.event.number }}" \
|
||||||
"${{ github.repository }}"
|
"${{ github.repository }}"
|
||||||
@@ -157,12 +163,27 @@ jobs:
|
|||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
token: ${{ secrets.REPO_TOKEN }}
|
token: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
run: make setup-image
|
run: make setup-image
|
||||||
|
- name: Post approval review
|
||||||
|
env:
|
||||||
|
CI_GITEA_TOKEN: ${{ secrets.REVIEW_GITEA_TOKEN }}
|
||||||
|
PR_NUMBER: ${{ github.event.number }}
|
||||||
|
REPOSITORY: ${{ github.repository }}
|
||||||
|
PYTHONPATH: src
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
python3 -m devx.ci.pr_review \
|
||||||
|
"$PR_NUMBER" \
|
||||||
|
"$REPOSITORY" \
|
||||||
|
--event APPROVE \
|
||||||
|
--checklist-confirmed \
|
||||||
|
--checklist-categories 1,2,3,4,5,6,7,8,9,10,11,12,13 \
|
||||||
|
--body "Auto-approved: all CI checks passed (quality, pr-review, release-dry-run)."
|
||||||
- name: Squash merge with task ID
|
- name: Squash merge with task ID
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
|
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
|
||||||
DEVX_VIKUNJA_PROJECT_ID: "8"
|
DEVX_VIKUNJA_PROJECT_ID: "8"
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
@@ -171,7 +192,7 @@ jobs:
|
|||||||
REPOSITORY: ${{ github.repository }}
|
REPOSITORY: ${{ github.repository }}
|
||||||
PR_NUMBER: ${{ github.event.number }}
|
PR_NUMBER: ${{ github.event.number }}
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.auto_merge \
|
python3 -m devx.ci.auto_merge \
|
||||||
"$HEAD_REF" \
|
"$HEAD_REF" \
|
||||||
"$PR_TITLE" \
|
"$PR_TITLE" \
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.detect_release_commit
|
python3 -m devx.ci.detect_release_commit
|
||||||
|
|
||||||
validate-commit-msg:
|
validate-commit-msg:
|
||||||
@@ -73,7 +73,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
git log -1 --format=%B > commit-msg.txt
|
git log -1 --format=%B > commit-msg.txt
|
||||||
python3 -m devx.ci.validate_commit_msg commit-msg.txt --branch master
|
python3 -m devx.ci.validate_commit_msg commit-msg.txt --branch master
|
||||||
rm -f commit-msg.txt
|
rm -f commit-msg.txt
|
||||||
@@ -93,10 +93,10 @@ jobs:
|
|||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
token: ${{ secrets.REPO_TOKEN }}
|
token: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
run: make setup-image
|
run: make setup-image
|
||||||
- name: Configure git
|
- name: Configure git
|
||||||
run: |
|
run: |
|
||||||
@@ -107,13 +107,13 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
python3 -m devx.ci.release
|
python3 -m devx.ci.release
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate 2>/dev/null || true
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
@@ -122,7 +122,8 @@ jobs:
|
|||||||
--repo "${{ github.repository }}" \
|
--repo "${{ github.repository }}" \
|
||||||
--run-id "${{ github.run_id }}" \
|
--run-id "${{ github.run_id }}" \
|
||||||
--workflow "post-merge/release" \
|
--workflow "post-merge/release" \
|
||||||
--commit "${{ github.sha }}"
|
--commit "${{ github.sha }}" \
|
||||||
|
--auto-login
|
||||||
|
|
||||||
publish:
|
publish:
|
||||||
needs: [release]
|
needs: [release]
|
||||||
@@ -137,20 +138,21 @@ jobs:
|
|||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
ref: ${{ needs.release.outputs.tag }}
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
run: make setup-image EXTRAS=release
|
run: make setup-image EXTRAS=release
|
||||||
- name: Build and publish release
|
- name: Build and publish release
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
python3 -m devx.ci.publish "${{ needs.release.outputs.tag }}" "${{ github.repository }}" --auto-login
|
python3 -m devx.ci.publish "${{ needs.release.outputs.tag }}" "${{ github.repository }}" --auto-login
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate 2>/dev/null || true
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
@@ -159,7 +161,8 @@ jobs:
|
|||||||
--repo "${{ github.repository }}" \
|
--repo "${{ github.repository }}" \
|
||||||
--run-id "${{ github.run_id }}" \
|
--run-id "${{ github.run_id }}" \
|
||||||
--workflow "post-merge/publish" \
|
--workflow "post-merge/publish" \
|
||||||
--commit "${{ github.sha }}"
|
--commit "${{ github.sha }}" \
|
||||||
|
--auto-login
|
||||||
|
|
||||||
sync-wiki:
|
sync-wiki:
|
||||||
needs: [detect-type]
|
needs: [detect-type]
|
||||||
@@ -178,15 +181,15 @@ jobs:
|
|||||||
run: make setup-image
|
run: make setup-image
|
||||||
- name: Sync documentation to wiki
|
- name: Sync documentation to wiki
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.sync_wiki --repo "${{ github.repository }}" --strict
|
python3 -m devx.ci.sync_wiki --repo "${{ github.repository }}" --strict
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
@@ -194,7 +197,8 @@ jobs:
|
|||||||
--repo "${{ github.repository }}" \
|
--repo "${{ github.repository }}" \
|
||||||
--run-id "${{ github.run_id }}" \
|
--run-id "${{ github.run_id }}" \
|
||||||
--workflow "post-merge/sync-wiki" \
|
--workflow "post-merge/sync-wiki" \
|
||||||
--commit "${{ github.sha }}"
|
--commit "${{ github.sha }}" \
|
||||||
|
--auto-login
|
||||||
|
|
||||||
badges:
|
badges:
|
||||||
needs: [detect-type]
|
needs: [detect-type]
|
||||||
@@ -210,7 +214,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
ref: master
|
ref: master
|
||||||
token: ${{ secrets.REPO_TOKEN }}
|
token: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
- name: Fetch latest master
|
- name: Fetch latest master
|
||||||
run: |
|
run: |
|
||||||
git fetch origin master
|
git fetch origin master
|
||||||
@@ -221,12 +225,12 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PRE_COMMIT_ALLOW_NO_CONFIG: "1"
|
PRE_COMMIT_ALLOW_NO_CONFIG: "1"
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.push_badges
|
python3 -m devx.ci.push_badges
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
@@ -234,7 +238,8 @@ jobs:
|
|||||||
--repo "${{ github.repository }}" \
|
--repo "${{ github.repository }}" \
|
||||||
--run-id "${{ github.run_id }}" \
|
--run-id "${{ github.run_id }}" \
|
||||||
--workflow "post-merge/badges" \
|
--workflow "post-merge/badges" \
|
||||||
--commit "${{ github.sha }}"
|
--commit "${{ github.sha }}" \
|
||||||
|
--auto-login
|
||||||
|
|
||||||
vikunja:
|
vikunja:
|
||||||
needs: [detect-type]
|
needs: [detect-type]
|
||||||
@@ -257,12 +262,12 @@ jobs:
|
|||||||
DEVX_VIKUNJA_PROJECT_ID: "8"
|
DEVX_VIKUNJA_PROJECT_ID: "8"
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.post_merge --git-sha "${{ github.sha }}"
|
python3 -m devx.ci.post_merge --git-sha "${{ github.sha }}"
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
@@ -270,7 +275,8 @@ jobs:
|
|||||||
--repo "${{ github.repository }}" \
|
--repo "${{ github.repository }}" \
|
||||||
--run-id "${{ github.run_id }}" \
|
--run-id "${{ github.run_id }}" \
|
||||||
--workflow "post-merge/vikunja" \
|
--workflow "post-merge/vikunja" \
|
||||||
--commit "${{ github.sha }}"
|
--commit "${{ github.sha }}" \
|
||||||
|
--auto-login
|
||||||
|
|
||||||
configure-repo:
|
configure-repo:
|
||||||
needs: [detect-type]
|
needs: [detect-type]
|
||||||
@@ -287,15 +293,17 @@ jobs:
|
|||||||
run: make setup-image
|
run: make setup-image
|
||||||
- name: Ensure branch protection and labels
|
- name: Ensure branch protection and labels
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
|
DEVX_REPO_NAME: devx
|
||||||
|
DEVX_REPO_OWNER: oblachno-oss
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.tools.configure_repo --repo devx --owner oblachno-oss
|
python3 -m devx.tools.configure_repo
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
@@ -303,4 +311,5 @@ jobs:
|
|||||||
--repo "${{ github.repository }}" \
|
--repo "${{ github.repository }}" \
|
||||||
--run-id "${{ github.run_id }}" \
|
--run-id "${{ github.run_id }}" \
|
||||||
--workflow "post-merge/configure-repo" \
|
--workflow "post-merge/configure-repo" \
|
||||||
--commit "${{ github.sha }}"
|
--commit "${{ github.sha }}" \
|
||||||
|
--auto-login
|
||||||
|
|||||||
@@ -1,11 +1,25 @@
|
|||||||
# AGENTS.md — Project Conventions for devx
|
# AGENTS.md — Project Conventions for devx
|
||||||
|
|
||||||
|
## Virtual Environment
|
||||||
|
|
||||||
|
All Python tools, tests, and scripts run inside a standard `.venv` directory.
|
||||||
|
Activate it before running any non-`make` command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source activate.sh # bash/zsh
|
||||||
|
source activate.fish # fish
|
||||||
|
source activate.zsh # zsh
|
||||||
|
```
|
||||||
|
|
||||||
|
If `.venv` doesn't exist, run `make setup` first. The `make` targets handle
|
||||||
|
venv activation automatically — always prefer `make <target>` over raw commands.
|
||||||
|
|
||||||
## Build & Test Commands
|
## Build & Test Commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make setup # Create venv, install deps, set up hooks, install CI tools
|
make setup # Create venv, install deps, set up hooks, install CI tools
|
||||||
make install-tools # Install actionlint, git-cliff, act_runner to ~/.local/bin
|
make install-tools # Install actionlint, git-cliff, act_runner, tea, hadolint to ~/.local/bin
|
||||||
make lint-all # ruff + pyright + bandit + actionlint
|
make lint-all # ruff + pyright + bandit + actionlint + lint-dockerfiles
|
||||||
make pytest-cov # Unit tests with 100% coverage enforcement
|
make pytest-cov # Unit tests with 100% coverage enforcement
|
||||||
make test-unit # Unit tests without coverage
|
make test-unit # Unit tests without coverage
|
||||||
make workflow-lint # Static lint of .gitea/workflows/*.yml (actionlint)
|
make workflow-lint # Static lint of .gitea/workflows/*.yml (actionlint)
|
||||||
@@ -16,8 +30,8 @@ make clean # Remove caches, build artifacts, coverage data
|
|||||||
|
|
||||||
`make setup` automatically installs all development tools:
|
`make setup` automatically installs all development tools:
|
||||||
- **Python deps** via `python -m devx.tools.setup` (pip install -e .[dev], pre-commit hooks)
|
- **Python deps** via `python -m devx.tools.setup` (pip install -e .[dev], pre-commit hooks)
|
||||||
- **actionlint, git-cliff, act_runner, tea** via `python -m devx.tools.install_tools` (CI/CD tools to ~/.local/bin)
|
- **actionlint, git-cliff, act_runner, tea, hadolint** via `python -m devx.tools.install_tools` (CI/CD tools to ~/.local/bin)
|
||||||
- **tea CLI login** via `python -m devx.tools.setup` (configures `tea login` from `.env` `REPO_TOKEN`)
|
- **tea CLI login** via `python -m devx.tools.setup` (configures `tea login` from `.env` `CI_GITEA_TOKEN`)
|
||||||
|
|
||||||
## Workflow Verification (Before Push)
|
## Workflow Verification (Before Push)
|
||||||
|
|
||||||
@@ -52,28 +66,30 @@ src/devx/
|
|||||||
├── gitea_cli.py # TeaCLI — wrapper around tea CLI with JSON parsing
|
├── gitea_cli.py # TeaCLI — wrapper around tea CLI with JSON parsing
|
||||||
├── i18n.py # Translation system (gettext-based, translations.json)
|
├── i18n.py # Translation system (gettext-based, translations.json)
|
||||||
├── exceptions.py # Custom exception types
|
├── exceptions.py # Custom exception types
|
||||||
├── translations.json # Translation strings (en, bg)
|
├── translations.json # Translation strings (en, bg, de, pl, ru, zh)
|
||||||
├── ci/ # CI/CD automation modules (run by workflows)
|
├── ci/ # CI/CD automation modules (run by workflows)
|
||||||
│ ├── release.py # Automated versioning, tagging, changelog
|
│ ├── release.py # Automated versioning, tagging, changelog
|
||||||
│ ├── publish.py # Build and publish to Gitea PyPI registry (--skip-build for non-Python repos)
|
│ ├── publish.py # Build and publish to Gitea PyPI registry (--skip-build for non-Python repos)
|
||||||
│ ├── auto_merge.py # Squash-merge PRs with task ID validation
|
│ ├── auto_merge.py # Squash-merge PRs with task ID validation
|
||||||
│ ├── check_auto_merge_ready.py # Pre-merge validation gate (branch, PR title, Vikunja, behind-master)
|
│ ├── check_auto_merge_ready.py # Pre-merge validation gate (branch, PR title, Vikunja, behind-master)
|
||||||
│ ├── _shared.py # Shared utilities (get_latest_tag)
|
│ ├── _shared.py # Shared utilities (get_latest_tag)
|
||||||
│ ├── classify_changes.py # User-facing vs workflow-only change detection
|
│ ├── classify_changes.py # User-facing vs infrastructure change detection
|
||||||
│ ├── detect_release_commit.py # Detect release commits on master
|
│ ├── detect_release_commit.py # Detect release commits on master
|
||||||
│ ├── validate_commit_msg.py # Conventional commit validation
|
│ ├── validate_commit_msg.py # Conventional commit validation
|
||||||
│ ├── pr_review.py # Automated PR review
|
│ ├── pr_review.py # Automated PR review + manual reviews (--event, --body, --checklist-confirmed)
|
||||||
│ ├── post_merge.py # Vikunja task updates after merge
|
│ ├── post_merge.py # Vikunja task updates after merge
|
||||||
│ ├── sync_wiki.py # Sync documentation to Gitea wiki
|
│ ├── sync_wiki.py # Sync documentation to Gitea wiki
|
||||||
│ ├── push_badges.py # Generate and push quality badges (--retries for retry on git push failures)
|
│ ├── push_badges.py # Generate and push quality badges (--retries for retry on git push failures)
|
||||||
│ ├── notify_failure.py # Create Gitea issues on CI failures (--auto-login)
|
│ ├── notify_failure.py # Create Gitea issues on CI failures (--auto-login)
|
||||||
│ ├── distribute_files.py # Distribute files across parallel runners (LPT scheduling)
|
│ ├── distribute_files.py # Distribute files across parallel runners (LPT scheduling)
|
||||||
|
│ ├── distribute_items.py # Distribute generic items (VMs, hosts) across parallel runners (LPT)
|
||||||
│ ├── integration_guard.py # Run pytest with cross-runner fail-fast
|
│ ├── integration_guard.py # Run pytest with cross-runner fail-fast
|
||||||
│ ├── check_translations.py # Translation completeness check
|
│ ├── check_translations.py # Translation completeness check
|
||||||
│ └── doc_coverage.py # Documentation coverage check
|
│ ├── doc_coverage.py # Documentation coverage check
|
||||||
|
│ └── lint_docs.py # Documentation linter (structure, links, headings)
|
||||||
├── tools/ # Developer tooling modules (run locally or by CI)
|
├── tools/ # Developer tooling modules (run locally or by CI)
|
||||||
│ ├── setup.py # Environment setup (venv, deps, hooks)
|
│ ├── setup.py # Environment setup (venv, deps, hooks)
|
||||||
│ ├── install_tools.py # Install actionlint, git-cliff, act_runner, tea
|
│ ├── install_tools.py # Install actionlint, git-cliff, act_runner, tea, hadolint
|
||||||
│ ├── install_checkmake.py # Install checkmake (Makefile linter)
|
│ ├── install_checkmake.py # Install checkmake (Makefile linter)
|
||||||
│ ├── build_image.py # Build and push Docker images to Gitea registry
|
│ ├── build_image.py # Build and push Docker images to Gitea registry
|
||||||
│ ├── clean_images.py # Clean up old Docker image versions from Gitea registry
|
│ ├── clean_images.py # Clean up old Docker image versions from Gitea registry
|
||||||
@@ -82,14 +98,24 @@ src/devx/
|
|||||||
│ ├── check_pyproject_deps.py # Validate pyproject.toml deps have documentation comments
|
│ ├── check_pyproject_deps.py # Validate pyproject.toml deps have documentation comments
|
||||||
│ ├── check_test_coverage.py # Ensure changed files have corresponding tests (configurable rules)
|
│ ├── check_test_coverage.py # Ensure changed files have corresponding tests (configurable rules)
|
||||||
│ ├── check_agent_docs.py # Validate docs for stale file references (configurable patterns)
|
│ ├── check_agent_docs.py # Validate docs for stale file references (configurable patterns)
|
||||||
|
│ ├── check_config.py # Validate pyproject.toml [tool.devx] config
|
||||||
│ ├── configure_repo.py # Branch protection and label setup
|
│ ├── configure_repo.py # Branch protection and label setup
|
||||||
│ └── generate_badges.py # Badge SVG generation
|
│ ├── generate_badges.py # Badge SVG generation
|
||||||
|
│ ├── generate_cliff_config.py # Generate git-cliff config (cliff.toml)
|
||||||
|
│ ├── create_task.py # Create Vikunja tasks
|
||||||
|
│ ├── create_pr.py # Create PRs with auto-derived title from Vikunja
|
||||||
|
│ ├── pr_status.py # Check CI status for a PR/commit (--wait polls)
|
||||||
|
│ ├── pr_logs.py # Fetch logs for failed CI jobs
|
||||||
|
│ ├── pr_label.py # Add labels to PRs (idempotent)
|
||||||
|
│ ├── pre_push_check.py # Validate Vikunja task existence before push
|
||||||
|
│ └── _shared.py # Shared tool utilities
|
||||||
├── opentofu.py # OpenTofu output helpers (get_tofu_output, get_tofu_vm_ip, get_tofu_vm_field)
|
├── opentofu.py # OpenTofu output helpers (get_tofu_output, get_tofu_vm_ip, get_tofu_vm_field)
|
||||||
└── molecule/ # Optional molecule testing helpers (for Ansible projects)
|
└── molecule/ # Optional molecule testing helpers (for Ansible projects)
|
||||||
├── discover_runners.py # Dynamic Gitea runner discovery
|
├── discover_runners.py # Dynamic Gitea runner discovery
|
||||||
├── distribute_molecule.py # Distribute molecule scenarios across runners (LPT scheduling, --roles-root for multi-role)
|
├── distribute_molecule.py # Distribute molecule scenarios across runners (LPT scheduling, --roles-root for multi-role)
|
||||||
├── molecule_ci_guard.py # Run molecule with cross-runner fail-fast (--roles-root)
|
├── molecule_ci_guard.py # Run molecule with cross-runner fail-fast (--roles-root)
|
||||||
├── molecule_all.py # Run all molecule scenarios locally
|
├── molecule_all.py # Run all molecule scenarios locally
|
||||||
|
├── start_docker.py # Ensure Docker daemon is running for molecule tests
|
||||||
└── platforms.py # Supported molecule platforms
|
└── platforms.py # Supported molecule platforms
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -263,7 +289,7 @@ so `.:src` is not needed. The `src` directory is the sole import root.
|
|||||||
|
|
||||||
The `tea` Gitea CLI tool is used for Gitea API interactions. It is installed
|
The `tea` Gitea CLI tool is used for Gitea API interactions. It is installed
|
||||||
by `python -m devx.tools.install_tools` and configured by
|
by `python -m devx.tools.install_tools` and configured by
|
||||||
`python -m devx.tools.setup` (login profile from `.env` `REPO_TOKEN`).
|
`python -m devx.tools.setup` (login profile from `.env` `CI_GITEA_TOKEN`).
|
||||||
|
|
||||||
**`devx.gitea_cli.TeaCLI`** — Python wrapper around `tea` CLI with JSON output parsing:
|
**`devx.gitea_cli.TeaCLI`** — Python wrapper around `tea` CLI with JSON output parsing:
|
||||||
- `create_issue()` — Create issues with labels
|
- `create_issue()` — Create issues with labels
|
||||||
@@ -357,8 +383,8 @@ devx uses environment variables with `.env` file fallback for configuration.
|
|||||||
| `DEVX_REPO_NAME` | **(none — must be set)** | Repository name (or `owner/repo`) |
|
| `DEVX_REPO_NAME` | **(none — must be set)** | Repository name (or `owner/repo`) |
|
||||||
| `DEVX_TASK_PREFIX` | `DEVX` | Task ID prefix (GRM, OBL-INFRA, etc.) |
|
| `DEVX_TASK_PREFIX` | `DEVX` | Task ID prefix (GRM, OBL-INFRA, etc.) |
|
||||||
| `DEVX_VIKUNJA_PROJECT_ID` | `6` | Vikunja project ID |
|
| `DEVX_VIKUNJA_PROJECT_ID` | `6` | Vikunja project ID |
|
||||||
| `DEVX_LANG` | `en` | Language for i18n (en, bg) |
|
| `DEVX_LANG` | `en` | Language for i18n (en, bg, de, pl, ru, zh) |
|
||||||
| `REPO_TOKEN` | (from .env) | Gitea API token |
|
| `CI_GITEA_TOKEN` | (from .env) | Gitea API token |
|
||||||
| `VIKUNJA_TOKEN` | (from .env) | Vikunja API token |
|
| `VIKUNJA_TOKEN` | (from .env) | Vikunja API token |
|
||||||
|
|
||||||
### Per-Project Overrides
|
### Per-Project Overrides
|
||||||
@@ -398,13 +424,17 @@ projects.
|
|||||||
| `devx-create-pr` | Create a PR with auto-derived title |
|
| `devx-create-pr` | Create a PR with auto-derived title |
|
||||||
| `devx-push` | Push current branch to origin |
|
| `devx-push` | Push current branch to origin |
|
||||||
| `devx-push-with-pr` | Push and create PR in one step |
|
| `devx-push-with-pr` | Push and create PR in one step |
|
||||||
|
| `devx-pr-status` | Check CI status for a PR (`PR=`, `WAIT=`, `TIMEOUT=`) |
|
||||||
|
| `devx-pr-logs` | Fetch logs for failed CI jobs (`PR=`, `JOB=`, `TAIL=`) |
|
||||||
|
| `devx-pr-label` | Add a label to a PR (`PR=`, `LABEL=ready-to-merge`) |
|
||||||
|
| `devx-pr-review` | Post a review on a PR (`PR=`, `EVENT=`, `BODY=`, `CHECKLIST=`) |
|
||||||
| `devx-check-config` | Validate devx configuration |
|
| `devx-check-config` | Validate devx configuration |
|
||||||
| `devx-configure-gitea-pypi` | Configure Gitea private PyPI registry |
|
| `devx-configure-gitea-pypi` | Configure Gitea private PyPI registry |
|
||||||
| `devx-env` | Create .env from .env.example |
|
| `devx-env` | Create .env from .env.example |
|
||||||
| `devx-venv` | Create Python venv with version check |
|
| `devx-venv` | Create Python venv with version check |
|
||||||
| `devx-activate-scripts` | Create shell/fish/zsh activate scripts |
|
| `devx-activate-scripts` | Create shell/fish/zsh activate scripts |
|
||||||
| `devx-install-hooks` | Set git hooks path to hooks/ |
|
| `devx-install-hooks` | Set git hooks path to hooks/ |
|
||||||
| `devx-install-tools` | Install actionlint, git-cliff, act_runner, tea |
|
| `devx-install-tools` | Install actionlint, git-cliff, act_runner, tea, hadolint |
|
||||||
| `devx-install-checkmake` | Install checkmake (Makefile linter) |
|
| `devx-install-checkmake` | Install checkmake (Makefile linter) |
|
||||||
| `devx-checkmake` | Lint Makefiles with checkmake |
|
| `devx-checkmake` | Lint Makefiles with checkmake |
|
||||||
| `devx-workflow-lint` | Static lint of Gitea Actions YAML (actionlint) |
|
| `devx-workflow-lint` | Static lint of Gitea Actions YAML (actionlint) |
|
||||||
@@ -428,6 +458,7 @@ projects.
|
|||||||
| `devx-pre-push` | Run lint + tests before push |
|
| `devx-pre-push` | Run lint + tests before push |
|
||||||
| `devx-clean` | Remove caches, build artifacts, coverage data |
|
| `devx-clean` | Remove caches, build artifacts, coverage data |
|
||||||
| `devx-setup-image` | Link /opt/venv + install project (for pre-built image CI jobs) |
|
| `devx-setup-image` | Link /opt/venv + install project (for pre-built image CI jobs) |
|
||||||
|
| `devx-lint-dockerfiles` | Lint Dockerfiles with hadolint (fail-fast, parameterized by `DEVX_DOCKERFILE_PATHS`) |
|
||||||
| `devx-build-images` | Build Docker images from manifest (no push) |
|
| `devx-build-images` | Build Docker images from manifest (no push) |
|
||||||
| `devx-push-images` | Build and push Docker images to Gitea registry |
|
| `devx-push-images` | Build and push Docker images to Gitea registry |
|
||||||
| `devx-build-images-dry-run` | Show what would be built/pushed |
|
| `devx-build-images-dry-run` | Show what would be built/pushed |
|
||||||
@@ -441,6 +472,7 @@ projects.
|
|||||||
- `DEVX_COV_PKG` — coverage package (default: `src/devx`)
|
- `DEVX_COV_PKG` — coverage package (default: `src/devx`)
|
||||||
- `DEVX_TEST_PATHS` — pytest paths (default: `tests/`)
|
- `DEVX_TEST_PATHS` — pytest paths (default: `tests/`)
|
||||||
- `DEVX_PR_BASE` — PR base branch (default: `master`)
|
- `DEVX_PR_BASE` — PR base branch (default: `master`)
|
||||||
|
- `DEVX_DOCKERFILE_PATHS` — directory to search for Dockerfiles (default: `docker`)
|
||||||
- `DEVX_GITEA_REGISTRY` — registry URL (default: `git.oblachno.oblachno.fyi`)
|
- `DEVX_GITEA_REGISTRY` — registry URL (default: `git.oblachno.oblachno.fyi`)
|
||||||
- `DEVX_IMAGE_MANIFEST` — path to JSON manifest (default: `docker/images.json`)
|
- `DEVX_IMAGE_MANIFEST` — path to JSON manifest (default: `docker/images.json`)
|
||||||
- `DEVX_IMAGE_OWNER` — package owner for cleanup (default: `oblachno-oss`)
|
- `DEVX_IMAGE_OWNER` — package owner for cleanup (default: `oblachno-oss`)
|
||||||
@@ -453,7 +485,7 @@ to eliminate the 40-120s setup tax on every CI job:
|
|||||||
| Image | Contains | Used by jobs |
|
| Image | Contains | Used by jobs |
|
||||||
|-------|----------|-------------|
|
|-------|----------|-------------|
|
||||||
| `ci-base-latest` | Python 3.12 + devx[ci] + tea | detect-changes, detect-type, validate-commit-msg, pr-review, auto-merge, sync-wiki, vikunja, configure-repo |
|
| `ci-base-latest` | Python 3.12 + devx[ci] + tea | detect-changes, detect-type, validate-commit-msg, pr-review, auto-merge, sync-wiki, vikunja, configure-repo |
|
||||||
| `ci-quality-latest` | ci-base + devx[lint] + actionlint + checkmake | quality, badges |
|
| `ci-quality-latest` | ci-base + devx[lint] + actionlint + checkmake + hadolint | quality, badges |
|
||||||
| `ci-full-latest` | ci-quality + devx[release,molecule,deploy] + git-cliff + OpenTofu | release, publish, release-dry-run, molecule-tests, deploy jobs |
|
| `ci-full-latest` | ci-quality + devx[release,molecule,deploy] + git-cliff + OpenTofu | release, publish, release-dry-run, molecule-tests, deploy jobs |
|
||||||
|
|
||||||
**Build process** (in `build-images.yml` workflow):
|
**Build process** (in `build-images.yml` workflow):
|
||||||
@@ -503,3 +535,113 @@ create-task: devx-create-task
|
|||||||
- Line length: 120 chars
|
- Line length: 120 chars
|
||||||
- Secrets are passed via environment variables, never on the command line
|
- Secrets are passed via environment variables, never on the command line
|
||||||
- All user-facing strings wrapped in `_()` for i18n
|
- All user-facing strings wrapped in `_()` for i18n
|
||||||
|
|
||||||
|
### Container-Level Fix Verification (Mandatory)
|
||||||
|
|
||||||
|
**Rule:** Before pushing any fix that modifies container state (CA certs,
|
||||||
|
config files, installed packages, daemon restarts), reproduce the exact
|
||||||
|
sequence locally with the actual Docker image. Do not push to CI as the
|
||||||
|
first test.
|
||||||
|
|
||||||
|
This is a hard rule, not a suggestion. CI cycles take 20+ minutes and
|
||||||
|
ephemeral staging VMs are destroyed after each run, making interactive
|
||||||
|
debugging impossible. A local reproduction takes 30 seconds and catches
|
||||||
|
silent failures immediately.
|
||||||
|
|
||||||
|
**Procedure:**
|
||||||
|
1. `docker pull <actual_image>`
|
||||||
|
2. `docker run -d --name <test> ...` and wait for it to start
|
||||||
|
3. Run the exact commands from the Ansible task or script
|
||||||
|
4. Verify the state change took effect
|
||||||
|
5. Clean up: `docker rm -f <test>`
|
||||||
|
|
||||||
|
### Verified State Modification (Mandatory)
|
||||||
|
|
||||||
|
Ansible tasks that modify container state with `changed_when: false`
|
||||||
|
MUST include a post-task verification step that confirms the state
|
||||||
|
change took effect. `changed_when: false` suppresses both change
|
||||||
|
detection AND failure visibility — a task can silently do nothing and
|
||||||
|
report `ok`.
|
||||||
|
|
||||||
|
## Subagent Delegation Policy
|
||||||
|
|
||||||
|
Custom subagent profiles are defined in `.devin/agents/` (project-specific)
|
||||||
|
and `~/.config/devin/agents/` (global, shared across repos). The agent MUST
|
||||||
|
automatically delegate to the appropriate subagent based on the task —
|
||||||
|
the user should not need to specify which profile to use.
|
||||||
|
|
||||||
|
### Available Profiles
|
||||||
|
|
||||||
|
**Global** (shared with infra and grm):
|
||||||
|
|
||||||
|
| Profile | Location | Purpose |
|
||||||
|
|---------|----------|---------|
|
||||||
|
| `pr-reviewer` | `~/.config/devin/agents/` | 13-category PR checklist + quality gates |
|
||||||
|
| `release-check` | `~/.config/devin/agents/` | Pre-merge readiness validation |
|
||||||
|
|
||||||
|
**devx-specific** (in `.devin/agents/`):
|
||||||
|
|
||||||
|
| Profile | Purpose |
|
||||||
|
|---------|---------|
|
||||||
|
| `ci-investigator` | Investigate CI failures (quality, release, publish, wiki sync, image build) |
|
||||||
|
| `dep-upgrader` | Python dependency upgrades in pyproject.toml with dep-doc validation |
|
||||||
|
| `docker-image-builder` | Build/push/cleanup 3-tier runner images (ci-base, ci-quality, ci-full) |
|
||||||
|
| `doc-sync-specialist` | Doc coverage, doc linting, wiki sync integrity |
|
||||||
|
| `workflow-validator` | actionlint + act_runner dry-run validation |
|
||||||
|
|
||||||
|
### When to Delegate Automatically
|
||||||
|
|
||||||
|
| Trigger | Profile | Mode |
|
||||||
|
|---------|---------|------|
|
||||||
|
| CI run failure (quality, release, publish, sync-wiki, build-images) | `ci-investigator` | Background |
|
||||||
|
| PR ready for review | `pr-reviewer` | Foreground |
|
||||||
|
| Dependency upgrade requested | `dep-upgrader` | Background |
|
||||||
|
| Docker image build/push needed | `docker-image-builder` | Background |
|
||||||
|
| Doc coverage failure or wiki sync issue | `doc-sync-specialist` | Background |
|
||||||
|
| Workflow YAML modified or validation needed | `workflow-validator` | Background |
|
||||||
|
| Branch ready for merge | `release-check` | Foreground |
|
||||||
|
|
||||||
|
### Delegation Rules
|
||||||
|
|
||||||
|
1. **Auto-select the profile.** Do not ask the user which profile to use.
|
||||||
|
2. **Background by default, foreground when blocking.**
|
||||||
|
3. **Provide full context in the prompt** — subagents don't inherit conversation history.
|
||||||
|
4. **One subagent per concern.** Chain: investigate → fix in main session → review.
|
||||||
|
5. **Don't delegate trivial work** (<30s, <50 lines of context).
|
||||||
|
6. **Compact after subagent returns.**
|
||||||
|
7. **Never skip delegation to save time** — it keeps main context small.
|
||||||
|
|
||||||
|
|
||||||
|
## Feedback Issue Handling
|
||||||
|
|
||||||
|
Subagents create Gitea issues in the current repo when they encounter
|
||||||
|
tool, workflow, or process issues that warrant follow-up. These issues
|
||||||
|
use the `feedback` label plus a category label (`tooling`,
|
||||||
|
`ci-improvement`, `doc-improvement`, `workflow-improvement`).
|
||||||
|
|
||||||
|
Standard labels are created automatically by `configure_repo` (runs in
|
||||||
|
post-merge on every master push). If a label does not exist yet, the
|
||||||
|
subagent's issue creation will still succeed — labels can be added
|
||||||
|
afterwards.
|
||||||
|
|
||||||
|
### When a Subagent Reports a Feedback Issue URL
|
||||||
|
|
||||||
|
1. **Acknowledge it** in your response to the user — mention the issue URL
|
||||||
|
2. **Do NOT close or modify** the issue — it is for follow-up work
|
||||||
|
3. **Do NOT create a PR** to address it unless the user explicitly asks
|
||||||
|
4. If the user asks to address feedback, spawn a subagent to investigate
|
||||||
|
the issue and implement a fix
|
||||||
|
|
||||||
|
### Creating Feedback Issues Manually
|
||||||
|
|
||||||
|
As the parent agent, you can also create feedback issues directly using
|
||||||
|
the Gitea MCP (`issue_write` with `create_issue` method). Follow the
|
||||||
|
same format as subagents:
|
||||||
|
|
||||||
|
- Title: `[feedback] <category>: <short description>`
|
||||||
|
- Labels: `feedback` + category label
|
||||||
|
- Body: include context, tool/workflow, issue, reproduction, affected
|
||||||
|
files, suggested investigation, and "Reported by: parent agent"
|
||||||
|
|
||||||
|
Always deduplicate first via `list_issues` with `labels: "feedback"`.
|
||||||
|
|
||||||
|
|||||||
+156
@@ -2,6 +2,162 @@
|
|||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
## [0.32.0] - 2026-07-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Extract docker-login, tofu-ops, check-deps, install-tofu to Python tools
|
||||||
|
|
||||||
|
## [0.31.0] - 2026-07-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Centralize venv management in devx.mak
|
||||||
|
|
||||||
|
## [0.30.0] - 2026-07-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add standard label creation to configure_repo
|
||||||
|
|
||||||
|
## [0.29.1] - 2026-07-01
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Strip task ID prefix from commit messages in extract_conventional_msg
|
||||||
|
|
||||||
|
## [0.29.0] - 2026-07-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Detect badge commits as automated CI commits
|
||||||
|
|
||||||
|
## [0.28.0] - 2026-07-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Auto-rebase in auto-merge, new rebase tools, CLI registration
|
||||||
|
|
||||||
|
## [0.27.3] - 2026-06-30
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Retry wiki integrity check on transient API timeout
|
||||||
|
|
||||||
|
## [0.27.2] - 2026-06-29
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Retry release push on non-fast-forward with rebase loop
|
||||||
|
|
||||||
|
## [0.27.1] - 2026-06-28
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Exclude .devin/.terraform dirs from lint_docs, add duplicate heading excludes
|
||||||
|
|
||||||
|
## [0.27.0] - 2026-06-28
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add lint_docs tool, fix doc_coverage/check_translations for any repo
|
||||||
|
|
||||||
|
## [0.26.4] - 2026-06-28
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Wrap all user-facing strings with _() for i18n completeness
|
||||||
|
|
||||||
|
## [0.26.3] - 2026-06-28
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Pin all dependencies to exact versions for reproducibility
|
||||||
|
|
||||||
|
## [0.26.2] - 2026-06-28
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Block admin merge override and auto-approve with review token
|
||||||
|
|
||||||
|
## [0.26.1] - 2026-06-28
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Force pip upgrade in setup-image to install new dependencies
|
||||||
|
|
||||||
|
## [0.26.0] - 2026-06-28
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add distribute_items CI tool for parallel VM deployment
|
||||||
|
|
||||||
|
## [0.25.0] - 2026-06-28
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add manual review support to pr_review (--event, --body, --checklist-confirmed)
|
||||||
|
|
||||||
|
## [0.24.1] - 2026-06-28
|
||||||
|
|
||||||
|
### Refactor
|
||||||
|
|
||||||
|
- Add find_task_by_identifier, config fallbacks for tools
|
||||||
|
|
||||||
|
## [0.24.0] - 2026-06-27
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add pr_status, pr_logs, pr_label tools
|
||||||
|
|
||||||
|
## [0.23.4] - 2026-06-27
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Add --auto-login to all notify_failure calls in workflows
|
||||||
|
- Classify .gitea/** as user-facing for devx, support glob in user_facing_overrides
|
||||||
|
|
||||||
|
## [0.23.3] - 2026-06-27
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Correct clean_images delete URL and add retry with error handling
|
||||||
|
|
||||||
|
## [0.23.2] - 2026-06-27
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Add skip-ci flag to release commits and concurrency to build-images
|
||||||
|
|
||||||
|
## [0.23.1] - 2026-06-27
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Add rsync to ci-full image for molecule_docker
|
||||||
|
|
||||||
|
## [0.23.0] - 2026-06-27
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add devx-lint-dockerfiles to devx.mak, alias setup-image
|
||||||
|
|
||||||
|
### Refactor
|
||||||
|
|
||||||
|
- Remove hadolint on-the-fly install from setup-image
|
||||||
|
|
||||||
|
## [0.22.1] - 2026-06-27
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Checkout release tag in publish job
|
||||||
|
- Fail lint-dockerfiles when hadolint is missing
|
||||||
|
|
||||||
|
## [0.22.0] - 2026-06-27
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Document CI_GITEA_TOKEN scopes and add CI_GITEA_USERNAME to env var table
|
||||||
|
|
||||||
## [0.21.2] - 2026-06-27
|
## [0.21.2] - 2026-06-27
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|||||||
@@ -6,6 +6,36 @@ BIN := $(VENV)/bin
|
|||||||
|
|
||||||
all: setup
|
all: setup
|
||||||
|
|
||||||
|
# --- devx.mak integration ----------------------------------------------------
|
||||||
|
# Include shared targets from the devx package itself (venv management,
|
||||||
|
# workflow-lint, notify-failure, checkmake, lint targets, quality checks, etc.)
|
||||||
|
# Since devx IS the package, we can include its own devx.mak.
|
||||||
|
DEVX_PYTHON := $(BIN)/python
|
||||||
|
DEVX_VENV := $(VENV)
|
||||||
|
DEVX_BIN := $(BIN)
|
||||||
|
DEVX_LINT_PATHS := src/ tests/
|
||||||
|
DEVX_COV_PKG := src/devx
|
||||||
|
DEVX_TEST_PATHS := tests/
|
||||||
|
|
||||||
|
DEVX_MAK := $(shell $(BIN)/python -c \
|
||||||
|
"from pathlib import Path; import devx; print(Path(devx.__file__).parent / 'make' / 'devx.mak')" \
|
||||||
|
2>/dev/null)
|
||||||
|
# Fallback: when the venv doesn't exist yet (chicken-and-egg), use the
|
||||||
|
# source tree copy directly. devx IS the package, so src/devx/make/devx.mak
|
||||||
|
# is always available in this repo.
|
||||||
|
ifeq ($(strip $(DEVX_MAK)),)
|
||||||
|
DEVX_MAK := $(CURDIR)/src/devx/make/devx.mak
|
||||||
|
endif
|
||||||
|
-include $(DEVX_MAK)
|
||||||
|
|
||||||
|
# venv, .env, and activate-scripts are provided by devx.mak
|
||||||
|
# (devx-venv, devx-env, devx-activate-scripts, $(DEVX_VENV)/bin/activate rule)
|
||||||
|
# Aliases for convenience and backward compatibility:
|
||||||
|
.PHONY: venv activate-scripts
|
||||||
|
venv: devx-venv
|
||||||
|
.env: devx-env
|
||||||
|
activate-scripts: devx-activate-scripts
|
||||||
|
|
||||||
# Full setup for local development
|
# Full setup for local development
|
||||||
setup: $(VENV)/bin/activate .env activate-scripts install-tools
|
setup: $(VENV)/bin/activate .env activate-scripts install-tools
|
||||||
@$(BIN)/pip install -e '.[dev]' 2>/dev/null; \
|
@$(BIN)/pip install -e '.[dev]' 2>/dev/null; \
|
||||||
@@ -31,23 +61,13 @@ setup-release: $(VENV)/bin/activate .env
|
|||||||
$(BIN)/python -m devx.tools.setup --bin "$(BIN)" --extras "ci,lint,release" --no-pre-commit
|
$(BIN)/python -m devx.tools.setup --bin "$(BIN)" --extras "ci,lint,release" --no-pre-commit
|
||||||
|
|
||||||
# Setup for pre-built image jobs (deps already in image, just link venv + install project)
|
# Setup for pre-built image jobs (deps already in image, just link venv + install project)
|
||||||
|
# Note: Not aliased to devx-setup-image because devx's own CI images may have
|
||||||
|
# an older devx.mak that doesn't yet define devx-setup-image. Consumer repos
|
||||||
|
# (grm, infra) can safely alias to devx-setup-image since they install devx from PyPI.
|
||||||
setup-image:
|
setup-image:
|
||||||
@if [ -d /opt/venv ]; then ln -sf /opt/venv .venv; . .venv/bin/activate && pip install -e . --no-deps 2>/dev/null; \
|
@if [ -d /opt/venv ]; then ln -sf /opt/venv $(VENV); . $(VENV)/bin/activate && pip install --no-cache-dir -e . 2>/dev/null; \
|
||||||
else echo "[setup-image] /opt/venv not found — falling back to setup-ci"; $(MAKE) setup-ci; fi
|
else echo "[setup-image] /opt/venv not found — falling back to setup-ci"; $(MAKE) setup-ci; fi
|
||||||
|
|
||||||
.env:
|
|
||||||
@if [ ! -f .env ]; then cp .env.example .env; echo "Created .env from .env.example — please edit it."; fi
|
|
||||||
|
|
||||||
$(VENV)/bin/activate:
|
|
||||||
@python3 -c "import sys; v=sys.version_info; assert v >= (3, 12), f'Python 3.12+ required, found {v.major}.{v.minor}'; print(f'Python {v.major}.{v.minor}.{v.micro} OK')"
|
|
||||||
$(PYTHON) -m venv $(VENV)
|
|
||||||
$(BIN)/pip install --upgrade pip setuptools wheel
|
|
||||||
|
|
||||||
activate-scripts: $(VENV)/bin/activate
|
|
||||||
@test -f activate.sh || (echo '#!/usr/bin/env bash' > activate.sh && echo 'source "$$(cd "$$(dirname "$${BASH_SOURCE[0]}")" && pwd)/.venv/bin/activate"' >> activate.sh && chmod +x activate.sh)
|
|
||||||
@test -f activate.fish || (echo '#!/usr/bin/env fish' > activate.fish && echo 'set -l script_dir (dirname (status --current-filename))' >> activate.fish && echo 'source "$$script_dir/.venv/bin/activate.fish"' >> activate.fish && chmod +x activate.fish)
|
|
||||||
@test -f activate.zsh || (echo '#!/usr/bin/env zsh' > activate.zsh && echo '0="$${ZERO:-$${0:#$$ZSH_ARGZERO}}"' >> activate.zsh && echo '0="$${$${(M)0:#/*}:-$$PWD/$$0}"' >> activate.zsh && echo 'source "$${0:A:h}/.venv/bin/activate"' >> activate.zsh && chmod +x activate.zsh)
|
|
||||||
|
|
||||||
install-hooks:
|
install-hooks:
|
||||||
@cp hooks/pre-commit .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit
|
@cp hooks/pre-commit .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit
|
||||||
@cp hooks/pre-push .git/hooks/pre-push && chmod +x .git/hooks/pre-push
|
@cp hooks/pre-push .git/hooks/pre-push && chmod +x .git/hooks/pre-push
|
||||||
@@ -57,23 +77,13 @@ install-tools: $(VENV)/bin/activate
|
|||||||
@$(BIN)/pip install -e '.' 2>/dev/null; \
|
@$(BIN)/pip install -e '.' 2>/dev/null; \
|
||||||
$(BIN)/python -m devx.tools.install_tools
|
$(BIN)/python -m devx.tools.install_tools
|
||||||
|
|
||||||
# --- devx.mak integration ----------------------------------------------------
|
|
||||||
# Include shared targets from the devx package itself (workflow-lint,
|
|
||||||
# notify-failure, checkmake, lint targets, quality checks, etc.)
|
|
||||||
# Since devx IS the package, we can include its own devx.mak.
|
|
||||||
DEVX_PYTHON := $(BIN)/python
|
|
||||||
DEVX_VENV := $(VENV)
|
|
||||||
DEVX_BIN := $(BIN)
|
|
||||||
DEVX_LINT_PATHS := src/ tests/
|
|
||||||
DEVX_COV_PKG := src/devx
|
|
||||||
DEVX_TEST_PATHS := tests/
|
|
||||||
|
|
||||||
DEVX_MAK := $(shell $(BIN)/python -c \
|
|
||||||
"from pathlib import Path; import devx; print(Path(devx.__file__).parent / 'make' / 'devx.mak')" \
|
|
||||||
2>/dev/null)
|
|
||||||
-include $(DEVX_MAK)
|
|
||||||
|
|
||||||
# Aliases — project-specific names map to devx.mak targets
|
# Aliases — project-specific names map to devx.mak targets
|
||||||
|
.PHONY: lint-ruff lint-format typecheck lint-bandit lint-deps lint
|
||||||
|
.PHONY: workflow-lint workflow-dryrun workflow-dryrun-safe workflow-check
|
||||||
|
.PHONY: notify-failure checkmake check-mutable-globals check-dep-docs
|
||||||
|
.PHONY: check-test-speed check-test-coverage check-docs
|
||||||
|
.PHONY: create-task create-pr push-with-pr git-push rebase pr-rebase
|
||||||
|
.PHONY: lint-all lint-dockerfiles
|
||||||
lint-ruff: devx-lint-ruff
|
lint-ruff: devx-lint-ruff
|
||||||
lint-format: devx-lint-format
|
lint-format: devx-lint-format
|
||||||
typecheck: devx-typecheck
|
typecheck: devx-typecheck
|
||||||
@@ -95,18 +105,22 @@ create-task: devx-create-task
|
|||||||
create-pr: devx-create-pr
|
create-pr: devx-create-pr
|
||||||
push-with-pr: devx-push-with-pr
|
push-with-pr: devx-push-with-pr
|
||||||
git-push: devx-push
|
git-push: devx-push
|
||||||
|
rebase: devx-rebase
|
||||||
|
pr-rebase: devx-pr-rebase
|
||||||
|
|
||||||
lint-all: lint workflow-lint lint-dockerfiles
|
lint-all: lint workflow-lint lint-dockerfiles
|
||||||
@echo "[lint-all] All linting checks passed."
|
@echo "[lint-all] All linting checks passed."
|
||||||
|
|
||||||
|
# Note: Not aliased to devx-lint-dockerfiles for the same reason as setup-image —
|
||||||
|
# devx's own CI images may have an older devx.mak. Consumer repos can safely alias.
|
||||||
lint-dockerfiles:
|
lint-dockerfiles:
|
||||||
@echo "[lint-dockerfiles] Linting Dockerfiles with hadolint..."
|
@echo "[lint-dockerfiles] Linting Dockerfiles with hadolint..."
|
||||||
@if command -v hadolint >/dev/null 2>&1; then \
|
@if ! command -v hadolint >/dev/null 2>&1; then \
|
||||||
find docker -name 'Dockerfile*' -exec hadolint {} +; \
|
echo "[lint-dockerfiles] ERROR: hadolint not found. Install from https://github.com/hadolint/hadolint/releases" >&2; \
|
||||||
echo "[lint-dockerfiles] All Dockerfiles passed."; \
|
exit 1; \
|
||||||
else \
|
|
||||||
echo "[lint-dockerfiles] hadolint not found — skipping (install with: pip install hadolint or download from GitHub)"; \
|
|
||||||
fi
|
fi
|
||||||
|
@find docker -name 'Dockerfile*' -exec hadolint {} +
|
||||||
|
@echo "[lint-dockerfiles] All Dockerfiles passed."
|
||||||
|
|
||||||
test-unit: devx-test-unit
|
test-unit: devx-test-unit
|
||||||
|
|
||||||
|
|||||||
@@ -16,12 +16,12 @@ quality badges.
|
|||||||
|
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/LICENSE)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/LICENSE)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
|
||||||
[](https://www.python.org/downloads/)
|
[](https://www.python.org/downloads/)
|
||||||
|
|
||||||
## Why devx?
|
## Why devx?
|
||||||
|
|
||||||
@@ -87,7 +87,7 @@ extra index and list devx in your dependencies:
|
|||||||
```toml
|
```toml
|
||||||
[project]
|
[project]
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"devx>=0.11.1",
|
"devx>=0.27.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.pip]
|
[tool.pip]
|
||||||
@@ -101,8 +101,8 @@ pip install -e .
|
|||||||
```
|
```
|
||||||
|
|
||||||
> **Note:** If your project requires a specific devx version, pin it in
|
> **Note:** If your project requires a specific devx version, pin it in
|
||||||
> `dependencies` (e.g., `"devx==0.11.1"`) or use a version constraint
|
> `dependencies` (e.g., `"devx==0.27.0"`) or use a version constraint
|
||||||
> (e.g., `"devx>=0.11.1,<0.12"`).
|
> (e.g., `"devx>=0.27.0,<0.28"`).
|
||||||
|
|
||||||
### Optional extras
|
### Optional extras
|
||||||
|
|
||||||
@@ -158,6 +158,9 @@ python -m devx.ci.check_translations --translations path/to/translations.json
|
|||||||
# Documentation coverage check
|
# Documentation coverage check
|
||||||
python -m devx.ci.doc_coverage --fail-on-missing
|
python -m devx.ci.doc_coverage --fail-on-missing
|
||||||
|
|
||||||
|
# Documentation lint (structure, links, headings, TODOs)
|
||||||
|
python -m devx.ci.lint_docs --root .
|
||||||
|
|
||||||
# Validate a commit message
|
# Validate a commit message
|
||||||
python -m devx.ci.validate_commit_msg commit-msg.txt --branch master
|
python -m devx.ci.validate_commit_msg commit-msg.txt --branch master
|
||||||
|
|
||||||
@@ -326,10 +329,24 @@ The config system loads `.env` automatically via `python-dotenv`.
|
|||||||
| `DEVX_DOCS_DIR` | `docs` | Documentation directory (used by sync_wiki) |
|
| `DEVX_DOCS_DIR` | `docs` | Documentation directory (used by sync_wiki) |
|
||||||
| `DEVX_STATUS_CHECKS` | `CI / quality (pull_request)` | Comma-separated status check contexts |
|
| `DEVX_STATUS_CHECKS` | `CI / quality (pull_request)` | Comma-separated status check contexts |
|
||||||
| `DEVX_PYPI_REGISTRY_URL` | — | Gitea PyPI registry URL (used by publish) |
|
| `DEVX_PYPI_REGISTRY_URL` | — | Gitea PyPI registry URL (used by publish) |
|
||||||
| `REPO_TOKEN` | — | Gitea API token |
|
| `CI_GITEA_TOKEN` | — | Gitea API token (see scopes below) |
|
||||||
|
| `CI_GITEA_USERNAME` | — | Gitea username for registry authentication |
|
||||||
| `VIKUNJA_TOKEN` | — | Vikunja API token |
|
| `VIKUNJA_TOKEN` | — | Vikunja API token |
|
||||||
| `PYPI_TOKEN` | — | Standard PyPI token (takes precedence over Gitea registry) |
|
| `PYPI_TOKEN` | — | Standard PyPI token (takes precedence over Gitea registry) |
|
||||||
|
|
||||||
|
#### CI_GITEA_TOKEN scopes
|
||||||
|
|
||||||
|
The `CI_GITEA_TOKEN` is a single Gitea Personal Access Token used across all
|
||||||
|
workflows. It requires these scopes:
|
||||||
|
|
||||||
|
| Scope | Purpose |
|
||||||
|
|-------|---------|
|
||||||
|
| `read:repository` | Read repos, PRs, issues, branches |
|
||||||
|
| `write:repository` | Push commits, merge PRs, create tags/releases, create issues, set branch protection, push wiki |
|
||||||
|
| `read:package` | Pull packages from Gitea PyPI registry, pull Docker images |
|
||||||
|
| `write:package` | Publish packages to Gitea PyPI registry, push Docker images |
|
||||||
|
| `read:organization` | Query org-level runners for molecule test distribution |
|
||||||
|
|
||||||
### Per-project overrides
|
### Per-project overrides
|
||||||
|
|
||||||
Projects using devx can override the default API URLs and language by setting
|
Projects using devx can override the default API URLs and language by setting
|
||||||
|
|||||||
@@ -11,6 +11,10 @@ FROM git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-quality:latest
|
|||||||
|
|
||||||
SHELL ["/bin/bash", "-o", "pipefail", "-c"]
|
SHELL ["/bin/bash", "-o", "pipefail", "-c"]
|
||||||
|
|
||||||
|
# Install rsync (required by molecule_docker for file sync between host and test containers)
|
||||||
|
RUN apt-get update && apt-get install -y --no-install-recommends rsync \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
# Install devx[release,molecule,deploy] from local source
|
# Install devx[release,molecule,deploy] from local source
|
||||||
COPY . /tmp/devx
|
COPY . /tmp/devx
|
||||||
RUN pip install --no-cache-dir /tmp/devx[release,molecule,deploy] \
|
RUN pip install --no-cache-dir /tmp/devx[release,molecule,deploy] \
|
||||||
|
|||||||
+11
-10
@@ -12,12 +12,12 @@ project to be reusable across all oblachno-oss repositories.
|
|||||||
|
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/LICENSE)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/LICENSE)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
|
||||||
[](https://www.python.org/downloads/)
|
[](https://www.python.org/downloads/)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@@ -74,14 +74,14 @@ Add devx to your `pyproject.toml` dependencies and configure the registry:
|
|||||||
```toml
|
```toml
|
||||||
[project]
|
[project]
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"devx>=0.11.1",
|
"devx>=0.27.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.pip]
|
[tool.pip]
|
||||||
extra-index-url = "https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple"
|
extra-index-url = "https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple"
|
||||||
```
|
```
|
||||||
|
|
||||||
Pin a specific version if needed: `"devx==0.11.1"` or `"devx>=0.11.1,<0.12"`.
|
Pin a specific version if needed: `"devx==0.27.0"` or `"devx>=0.27.0,<0.28"`.
|
||||||
|
|
||||||
### Optional extras
|
### Optional extras
|
||||||
|
|
||||||
@@ -131,7 +131,7 @@ wiki sync details.
|
|||||||
devx provides a `devx` CLI with three command groups:
|
devx provides a `devx` CLI with three command groups:
|
||||||
|
|
||||||
- `devx ci <command>` — CI/CD automation (17 commands)
|
- `devx ci <command>` — CI/CD automation (17 commands)
|
||||||
- `devx tools <command>` — Developer tools (7 commands)
|
- `devx tools <command>` — Developer tools (9 commands)
|
||||||
- `devx molecule <command>` — Molecule testing (4 commands, optional)
|
- `devx molecule <command>` — Molecule testing (4 commands, optional)
|
||||||
|
|
||||||
See [CLI Commands](CLI-Commands) for full command documentation with examples.
|
See [CLI Commands](CLI-Commands) for full command documentation with examples.
|
||||||
@@ -149,7 +149,7 @@ fallback. Key variables:
|
|||||||
| `DEVX_REPO_NAME` | **(must be set)** | Repository name |
|
| `DEVX_REPO_NAME` | **(must be set)** | Repository name |
|
||||||
| `DEVX_TASK_PREFIX` | `DEVX` | Task ID prefix (GRM, OBL-INFRA, etc.) |
|
| `DEVX_TASK_PREFIX` | `DEVX` | Task ID prefix (GRM, OBL-INFRA, etc.) |
|
||||||
| `DEVX_LANG` | `en` | Language for i18n (en, bg, de, ru, zh, pl) |
|
| `DEVX_LANG` | `en` | Language for i18n (en, bg, de, ru, zh, pl) |
|
||||||
| `REPO_TOKEN` | — | Gitea API token |
|
| `CI_GITEA_TOKEN` | — | Gitea API token |
|
||||||
| `VIKUNJA_TOKEN` | — | Vikunja API token |
|
| `VIKUNJA_TOKEN` | — | Vikunja API token |
|
||||||
|
|
||||||
See [AGENTS.md](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/AGENTS.md)
|
See [AGENTS.md](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/AGENTS.md)
|
||||||
@@ -158,6 +158,7 @@ for the full configuration reference, PR workflow, and project conventions.
|
|||||||
## Wiki pages
|
## Wiki pages
|
||||||
|
|
||||||
- [Home](Home) — This page
|
- [Home](Home) — This page
|
||||||
|
- [Getting Started](Getting-Started) — Installation, configuration, and quick start guide
|
||||||
- [CLI Commands](CLI-Commands) — Full CLI command documentation with examples
|
- [CLI Commands](CLI-Commands) — Full CLI command documentation with examples
|
||||||
- [Architecture](Architecture) — Package structure, module descriptions, design principles
|
- [Architecture](Architecture) — Package structure, module descriptions, design principles
|
||||||
- [CI/CD Workflow](CI-CD-Workflow) — Pipeline documentation, workflows, and CI scripts
|
- [CI/CD Workflow](CI-CD-Workflow) — Pipeline documentation, workflows, and CI scripts
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
{
|
{
|
||||||
"index.md": "Home",
|
"index.md": "Home",
|
||||||
|
"user/getting-started.md": "Getting-Started",
|
||||||
"user/cli-commands.md": "CLI-Commands",
|
"user/cli-commands.md": "CLI-Commands",
|
||||||
"tech/architecture.md": "Architecture",
|
"tech/architecture.md": "Architecture",
|
||||||
"tech/ci-cd-workflow.md": "CI-CD-Workflow"
|
"tech/ci-cd-workflow.md": "CI-CD-Workflow"
|
||||||
|
|||||||
@@ -103,7 +103,7 @@ Custom exception hierarchy:
|
|||||||
### `i18n.py`
|
### `i18n.py`
|
||||||
|
|
||||||
Simple i18n system using a JSON translations file (`translations.json`).
|
Simple i18n system using a JSON translations file (`translations.json`).
|
||||||
Supports five languages: `en`, `bg`, `de`, `ru`, `zh`. The `_()` function
|
Supports six languages: `en`, `bg`, `de`, `pl`, `ru`, `zh`. The `_()` function
|
||||||
wraps user-facing strings for translation.
|
wraps user-facing strings for translation.
|
||||||
|
|
||||||
Projects can extend translations by setting `DEVX_TRANSLATIONS_PATH` to a
|
Projects can extend translations by setting `DEVX_TRANSLATIONS_PATH` to a
|
||||||
@@ -245,7 +245,7 @@ for retrying on git push failures.
|
|||||||
|
|
||||||
Creates a Gitea issue when a CI workflow fails. Uses the `tea` CLI for issue
|
Creates a Gitea issue when a CI workflow fails. Uses the `tea` CLI for issue
|
||||||
creation with failure labels. Supports `--auto-login` to configure the tea
|
creation with failure labels. Supports `--auto-login` to configure the tea
|
||||||
CLI login profile from `REPO_TOKEN` and `DEVX_GITEA_API_URL` before creating
|
CLI login profile from `CI_GITEA_TOKEN` and `DEVX_GITEA_API_URL` before creating
|
||||||
the issue.
|
the issue.
|
||||||
|
|
||||||
### `post_merge.py`
|
### `post_merge.py`
|
||||||
@@ -382,7 +382,7 @@ single-role (4-part) and multi-role (5-part) pair encoding.
|
|||||||
Runs all molecule scenarios on all supported OS platforms sequentially.
|
Runs all molecule scenarios on all supported OS platforms sequentially.
|
||||||
Intended for local development; CI uses the parallel matrix instead.
|
Intended for local development; CI uses the parallel matrix instead.
|
||||||
|
|
||||||
### `discover_runners.py`
|
### `molecule/discover_runners.py`
|
||||||
|
|
||||||
Discovers available Gitea Actions runners for molecule tests. Same logic as
|
Discovers available Gitea Actions runners for molecule tests. Same logic as
|
||||||
`devx.ci.discover_runners` but intended for molecule-specific workflows.
|
`devx.ci.discover_runners` but intended for molecule-specific workflows.
|
||||||
@@ -569,7 +569,7 @@ push_badges.py:
|
|||||||
The `tea` Gitea CLI tool is used for Gitea API interactions where tea provides
|
The `tea` Gitea CLI tool is used for Gitea API interactions where tea provides
|
||||||
reliable, official support. It is installed by
|
reliable, official support. It is installed by
|
||||||
`python -m devx.tools.install_tools` and configured by
|
`python -m devx.tools.install_tools` and configured by
|
||||||
`python -m devx.tools.setup` (login profile from `.env` `REPO_TOKEN`).
|
`python -m devx.tools.setup` (login profile from `.env` `CI_GITEA_TOKEN`).
|
||||||
|
|
||||||
`devx.gitea_cli.TeaCLI` wraps tea with JSON output parsing. Operations that
|
`devx.gitea_cli.TeaCLI` wraps tea with JSON output parsing. Operations that
|
||||||
tea does not support (wiki management, commit status, runner discovery,
|
tea does not support (wiki management, commit status, runner discovery,
|
||||||
|
|||||||
@@ -166,7 +166,7 @@ When `release` creates a `release: vX.Y.Z` commit, the release commit's
|
|||||||
post-merge run still updates badges (the version badge picks up the new
|
post-merge run still updates badges (the version badge picks up the new
|
||||||
version). Other jobs skip. The tag push triggers `publish.yml`.
|
version). Other jobs skip. The tag push triggers `publish.yml`.
|
||||||
|
|
||||||
### Jobs
|
### Post-merge jobs
|
||||||
|
|
||||||
#### `detect-type`
|
#### `detect-type`
|
||||||
|
|
||||||
@@ -305,7 +305,7 @@ post-merge workflow when it creates and pushes a new version tag.
|
|||||||
and the project itself
|
and the project itself
|
||||||
2. **Install CI tools** — git-cliff and tea via
|
2. **Install CI tools** — git-cliff and tea via
|
||||||
`python -m devx.tools.install_tools`
|
`python -m devx.tools.install_tools`
|
||||||
3. **Configure tea login** — `tea login add` using `REPO_TOKEN`
|
3. **Configure tea login** — `tea login add` using `CI_GITEA_TOKEN`
|
||||||
4. **Build and publish** — `python -m devx.ci.publish <tag> <owner/repo>`:
|
4. **Build and publish** — `python -m devx.ci.publish <tag> <owner/repo>`:
|
||||||
- Build the package with `python -m build`
|
- Build the package with `python -m build`
|
||||||
- Publish to the Gitea PyPI registry (default) using `twine upload
|
- Publish to the Gitea PyPI registry (default) using `twine upload
|
||||||
@@ -377,7 +377,7 @@ python -m devx.ci.pr_review <pr_number> <owner/repo>
|
|||||||
|
|
||||||
Creates a Gitea issue when a CI workflow fails. Uses the tea CLI for issue
|
Creates a Gitea issue when a CI workflow fails. Uses the tea CLI for issue
|
||||||
creation with failure labels. Supports `--auto-login` to configure the tea
|
creation with failure labels. Supports `--auto-login` to configure the tea
|
||||||
CLI login profile from `REPO_TOKEN`.
|
CLI login profile from `CI_GITEA_TOKEN`.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python -m devx.ci.notify_failure --repo <owner/repo> --run-id <id> \
|
python -m devx.ci.notify_failure --repo <owner/repo> --run-id <id> \
|
||||||
|
|||||||
@@ -127,14 +127,37 @@ Click commands from `cli.py` and checks if each has documentation in
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
devx ci doc-coverage
|
devx ci doc-coverage
|
||||||
devx ci doc-coverage --docs-dir docs/ --fail-on-missing
|
devx ci doc-coverage --docs-dir docs/ --source-dir src/ --fail-on-missing
|
||||||
```
|
```
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
- `--docs-dir <dir>` — path to the docs directory (default: `docs/`)
|
- `--docs-dir <dir>` — path to the docs directory (default: `docs/`)
|
||||||
|
- `--source-dir <dir>` — path to the source directory (default: auto-detect)
|
||||||
- `--fail-on-missing` — exit with non-zero status if any documentation is
|
- `--fail-on-missing` — exit with non-zero status if any documentation is
|
||||||
missing
|
missing
|
||||||
|
|
||||||
|
### `devx ci lint-docs`
|
||||||
|
|
||||||
|
Lint documentation files for structure, broken links, heading hierarchy,
|
||||||
|
duplicate headings, TODO/FIXME markers, and trailing whitespace.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
devx ci lint-docs
|
||||||
|
devx ci lint-docs --root . --fix
|
||||||
|
devx ci lint-docs --no-check-links --no-check-stale
|
||||||
|
```
|
||||||
|
|
||||||
|
Options:
|
||||||
|
- `--root <dir>` — repository root directory (default: `.`)
|
||||||
|
- `--docs-dir <dir>` — docs directory (default: `<root>/docs`)
|
||||||
|
- `--check-links/--no-check-links` — check internal links (default: yes)
|
||||||
|
- `--check-headings/--no-check-headings` — check heading hierarchy (default: yes)
|
||||||
|
- `--check-todo/--no-check-todo` — check for TODO/FIXME markers (default: yes)
|
||||||
|
- `--check-stale/--no-check-stale` — check for stale docs (default: no)
|
||||||
|
- `--check-trailing/--no-check-trailing` — check trailing whitespace (default: yes)
|
||||||
|
- `--check-duplicates/--no-check-duplicates` — check duplicate headings (default: yes)
|
||||||
|
- `--fix` — auto-fix trailing whitespace
|
||||||
|
|
||||||
### `devx ci integration-guard`
|
### `devx ci integration-guard`
|
||||||
|
|
||||||
Run pytest with cross-runner failure detection. If any
|
Run pytest with cross-runner failure detection. If any
|
||||||
@@ -148,7 +171,7 @@ devx ci integration-guard -- -x -v --tb=short test_a.py
|
|||||||
|
|
||||||
Environment variables:
|
Environment variables:
|
||||||
- `GITEA_URL` — base URL of the Gitea instance
|
- `GITEA_URL` — base URL of the Gitea instance
|
||||||
- `REPO_TOKEN` — API token with repo access
|
- `CI_GITEA_TOKEN` — API token with repo access
|
||||||
- `RUN_ID` — workflow run ID (`GITHUB_RUN_ID`)
|
- `RUN_ID` — workflow run ID (`GITHUB_RUN_ID`)
|
||||||
- `JOB_NAME` — base job name (`GITHUB_JOB`)
|
- `JOB_NAME` — base job name (`GITHUB_JOB`)
|
||||||
- `MATRIX_INDEX` — current matrix index (runner-index)
|
- `MATRIX_INDEX` — current matrix index (runner-index)
|
||||||
@@ -171,7 +194,7 @@ Options:
|
|||||||
- `--run-id <id>` — CI run ID (required)
|
- `--run-id <id>` — CI run ID (required)
|
||||||
- `--workflow <name>` — workflow name (required)
|
- `--workflow <name>` — workflow name (required)
|
||||||
- `--commit <sha>` — commit SHA (required)
|
- `--commit <sha>` — commit SHA (required)
|
||||||
- `--auto-login` — configure tea CLI login from `REPO_TOKEN` before creating
|
- `--auto-login` — configure tea CLI login from `CI_GITEA_TOKEN` before creating
|
||||||
the issue
|
the issue
|
||||||
|
|
||||||
### `devx ci post-merge`
|
### `devx ci post-merge`
|
||||||
@@ -398,6 +421,35 @@ Options:
|
|||||||
- `--no-pre-commit` — skip pre-commit hook installation
|
- `--no-pre-commit` — skip pre-commit hook installation
|
||||||
- `--no-tea-login` — skip tea CLI login configuration
|
- `--no-tea-login` — skip tea CLI login configuration
|
||||||
|
|
||||||
|
### `devx tools rebase`
|
||||||
|
|
||||||
|
Rebase the current branch onto `origin/master` and force-push with
|
||||||
|
`--force-with-lease`. Checks if the branch is behind master first —
|
||||||
|
if up-to-date, exits without doing anything.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
devx tools rebase # rebase + force-push
|
||||||
|
devx tools rebase -- --no-push # rebase locally only
|
||||||
|
```
|
||||||
|
|
||||||
|
Options (pass after `--`):
|
||||||
|
- `--no-push` — rebase locally without pushing
|
||||||
|
|
||||||
|
### `devx tools pr-rebase`
|
||||||
|
|
||||||
|
Rebase a pull request's head branch onto master via the Gitea API
|
||||||
|
(server-side). This triggers a new `pull_request synchronize` event,
|
||||||
|
which starts a new CI run. Useful when you don't have the branch
|
||||||
|
checked out locally.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
devx tools pr-rebase -- --pr 42 # rebase PR #42
|
||||||
|
devx tools pr-rebase # auto-detect PR from current branch
|
||||||
|
```
|
||||||
|
|
||||||
|
Options (pass after `--`):
|
||||||
|
- `--pr <N>` — PR number (auto-detected from current branch if omitted)
|
||||||
|
|
||||||
## Molecule Commands
|
## Molecule Commands
|
||||||
|
|
||||||
Molecule commands require the `molecule` extra (`pip install devx[molecule]`).
|
Molecule commands require the `molecule` extra (`pip install devx[molecule]`).
|
||||||
@@ -462,7 +514,7 @@ Options:
|
|||||||
|
|
||||||
Environment variables:
|
Environment variables:
|
||||||
- `GITEA_URL` — base URL of the Gitea instance
|
- `GITEA_URL` — base URL of the Gitea instance
|
||||||
- `REPO_TOKEN` — API token with repo access
|
- `CI_GITEA_TOKEN` — API token with repo access
|
||||||
- `RUN_ID` — workflow run ID (`GITHUB_RUN_ID`)
|
- `RUN_ID` — workflow run ID (`GITHUB_RUN_ID`)
|
||||||
- `JOB_NAME` — base job name (`GITHUB_JOB`)
|
- `JOB_NAME` — base job name (`GITHUB_JOB`)
|
||||||
- `MATRIX_INDEX` — current matrix index (runner-index)
|
- `MATRIX_INDEX` — current matrix index (runner-index)
|
||||||
|
|||||||
@@ -0,0 +1,161 @@
|
|||||||
|
# Getting Started with devx
|
||||||
|
|
||||||
|
This guide walks you through installing devx, configuring it for your project,
|
||||||
|
and setting up a complete CI/CD pipeline.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- **Python 3.12+**
|
||||||
|
- **A Gitea instance** with Actions enabled
|
||||||
|
- **A Gitea API token** with repo, workflow, and organization scopes
|
||||||
|
- **(Optional) Vikunja API token** for task tracking integration
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
devx is published to the Gitea PyPI registry. Configure pip to use it:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Configure Gitea PyPI registry
|
||||||
|
pip config set global.extra-index-url https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple
|
||||||
|
|
||||||
|
# Install devx
|
||||||
|
pip install devx
|
||||||
|
```
|
||||||
|
|
||||||
|
Or install from source:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.oblachno.oblachno.fyi/oblachno-oss/devx.git
|
||||||
|
cd devx
|
||||||
|
make setup
|
||||||
|
```
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
### 1. Configure environment variables
|
||||||
|
|
||||||
|
Create a `.env` file in your project root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
CI_GITEA_TOKEN=your_gitea_api_token
|
||||||
|
VIKUNJA_TOKEN=your_vikunja_api_token # optional
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Add devx to your project
|
||||||
|
|
||||||
|
Add devx to your `pyproject.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project]
|
||||||
|
dependencies = [
|
||||||
|
"devx>=0.27.0",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
|
dev = [
|
||||||
|
"devx[dev]>=0.27.0",
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Set up the Makefile
|
||||||
|
|
||||||
|
devx provides a shared Makefile fragment. Add this to your `Makefile`:
|
||||||
|
|
||||||
|
```makefile
|
||||||
|
include devx.mak
|
||||||
|
```
|
||||||
|
|
||||||
|
Run `devx tools setup` to install all development tools (actionlint, git-cliff,
|
||||||
|
tea CLI, etc.) and configure pre-commit hooks.
|
||||||
|
|
||||||
|
### 4. Create the docs structure
|
||||||
|
|
||||||
|
devx expects a `docs/` directory with at minimum:
|
||||||
|
|
||||||
|
```
|
||||||
|
docs/
|
||||||
|
├── index.md # Documentation home page
|
||||||
|
├── mapping.json # Wiki page title mappings
|
||||||
|
├── user/ # User-facing documentation
|
||||||
|
│ └── cli-commands.md
|
||||||
|
└── tech/ # Technical documentation
|
||||||
|
├── architecture.md
|
||||||
|
└── ci-cd-workflow.md
|
||||||
|
```
|
||||||
|
|
||||||
|
Example `docs/mapping.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"index.md": "Home",
|
||||||
|
"user/cli-commands.md": "CLI-Commands",
|
||||||
|
"tech/architecture.md": "Architecture",
|
||||||
|
"tech/ci-cd-workflow.md": "CI-CD-Workflow"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 5. Set up CI workflows
|
||||||
|
|
||||||
|
Create `.gitea/workflows/ci.yml` and `.gitea/workflows/post-merge.yml` in your
|
||||||
|
project. See the [CI/CD Workflow guide](../tech/ci-cd-workflow.md) for details.
|
||||||
|
|
||||||
|
### 6. Configure release settings
|
||||||
|
|
||||||
|
Add a `cliff.toml` for git-cliff-based versioning:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
devx tools generate-cliff-config
|
||||||
|
```
|
||||||
|
|
||||||
|
Add `[tool.devx]` section to `pyproject.toml` for project-specific config:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[tool.devx]
|
||||||
|
# Vikunja project ID for task tracking
|
||||||
|
vikunja_project_id = 6
|
||||||
|
|
||||||
|
[tool.devx.classify]
|
||||||
|
# File patterns that are infrastructure (no release needed)
|
||||||
|
infrastructure = [
|
||||||
|
".gitea/**",
|
||||||
|
"docs/**",
|
||||||
|
"tests/**",
|
||||||
|
"AGENTS.md",
|
||||||
|
"README.md",
|
||||||
|
"CHANGELOG.md",
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Available Tools
|
||||||
|
|
||||||
|
### CI/CD Automation (`devx.ci.*`)
|
||||||
|
|
||||||
|
- `devx.ci.release` — Automated semver versioning and tagging
|
||||||
|
- `devx.ci.publish` — Package publishing to Gitea PyPI registry
|
||||||
|
- `devx.ci.auto_merge` — Squash-merge automation with task ID validation
|
||||||
|
- `devx.ci.pr_review` — Automated PR review with inline comments
|
||||||
|
- `devx.ci.classify_changes` — User-facing vs workflow-only change detection
|
||||||
|
- `devx.ci.sync_wiki` — Push docs/ to Gitea wiki
|
||||||
|
- `devx.ci.doc_coverage` — Documentation coverage checker
|
||||||
|
- `devx.ci.lint_docs` — Documentation linter (structure, links, headings)
|
||||||
|
- `devx.ci.check_translations` — i18n translation completeness checker
|
||||||
|
- `devx.ci.notify_failure` — Create Gitea issues on CI failures
|
||||||
|
- `devx.ci.distribute_files` — Parallel test file distribution
|
||||||
|
- `devx.ci.distribute_items` — Parallel item distribution across runners
|
||||||
|
- `devx.ci.discover_runners` — Dynamic runner discovery via Gitea API
|
||||||
|
|
||||||
|
### Development Tools (`devx.tools.*`)
|
||||||
|
|
||||||
|
- `devx.tools.setup` — Environment setup (venv, deps, hooks, tools)
|
||||||
|
- `devx.tools.install_tools` — Install CI/CD tools (actionlint, git-cliff, tea)
|
||||||
|
- `devx.tools.create_task` — Create Vikunja tasks
|
||||||
|
- `devx.tools.create_pr` — Create Gitea PRs with task ID in title
|
||||||
|
- `devx.tools.configure_repo` — Configure branch protection and labels
|
||||||
|
- `devx.tools.generate_badges` — Generate quality badge SVGs
|
||||||
|
- `devx.tools.check_test_speed` — Enforce test execution speed limits
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
- Read the [CLI Commands reference](cli-commands.md) for all available commands
|
||||||
|
- Read the [Architecture guide](../tech/architecture.md) to understand internals
|
||||||
|
- Read the [CI/CD Workflow guide](../tech/ci-cd-workflow.md) for pipeline details
|
||||||
+36
-27
@@ -13,10 +13,13 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: 3",
|
"Programming Language :: Python :: 3",
|
||||||
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
|
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
|
||||||
]
|
]
|
||||||
|
# All dependencies are pinned to exact versions for full reproducibility.
|
||||||
|
# Update pinned versions in a dedicated PR with verification.
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"requests>=2.34.2",
|
"requests==2.34.2",
|
||||||
"python-dotenv>=1.2.2",
|
"python-dotenv==1.2.2",
|
||||||
"click>=8.4.1",
|
"click==8.4.2",
|
||||||
|
"tenacity==9.1.4", # retry logic for GiteaClient/VikunjaClient
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
@@ -28,44 +31,44 @@ version = {attr = "devx.__version__"}
|
|||||||
[project.optional-dependencies]
|
[project.optional-dependencies]
|
||||||
# Test runners (pytest + coverage + parallel execution)
|
# Test runners (pytest + coverage + parallel execution)
|
||||||
ci = [
|
ci = [
|
||||||
"pytest>=9.1.0",
|
"pytest==9.1.1",
|
||||||
"pytest-cov>=7.1.0",
|
"pytest-cov==7.1.0",
|
||||||
"pytest-xdist>=3.8",
|
"pytest-xdist==3.8.0",
|
||||||
]
|
]
|
||||||
# Lint and type-checking tools (quality job, badge generation)
|
# Lint and type-checking tools (quality job, badge generation)
|
||||||
lint = [
|
lint = [
|
||||||
"ruff>=0.15.17",
|
"ruff==0.15.20",
|
||||||
"pyright>=1.1.410",
|
"pyright==1.1.411",
|
||||||
"bandit>=1.8.2",
|
"bandit==1.9.4",
|
||||||
"pip-audit>=2.10",
|
"pip-audit==2.10.1",
|
||||||
"pre-commit>=4.6.0",
|
"pre-commit==4.6.0",
|
||||||
]
|
]
|
||||||
# Release tools (build + publish to PyPI/Gitea registry)
|
# Release tools (build + publish to PyPI/Gitea registry)
|
||||||
release = [
|
release = [
|
||||||
"build>=1.5.0",
|
"build==1.5.0",
|
||||||
"twine>=6.2.0",
|
"twine==6.2.0",
|
||||||
]
|
]
|
||||||
# Molecule testing (for projects with Ansible roles)
|
# Molecule testing (for projects with Ansible roles)
|
||||||
molecule = [
|
molecule = [
|
||||||
"molecule>=26.4.0",
|
"molecule==26.4.0",
|
||||||
"molecule-docker>=2.1.0",
|
"molecule-docker==2.1.0",
|
||||||
"ansible-lint>=26.4.0",
|
"ansible-lint==26.4.0",
|
||||||
"ansible-core>=2.15,<2.17",
|
"ansible-core==2.21.1",
|
||||||
]
|
]
|
||||||
# Deploy tools (for infra staging/production deployments)
|
# Deploy tools (for infra staging/production deployments)
|
||||||
deploy = [
|
deploy = [
|
||||||
"ansible-core>=2.15,<2.17",
|
"ansible-core==2.21.1",
|
||||||
"boto3>=1.34",
|
"boto3==1.43.36",
|
||||||
"docker>=7.0",
|
"docker==7.1.0",
|
||||||
"jinja2>=3.1",
|
"jinja2==3.1.6",
|
||||||
"pyyaml>=6.0",
|
"pyyaml==6.0.3",
|
||||||
"cryptography>=41.0",
|
"cryptography==49.0.0",
|
||||||
]
|
]
|
||||||
# Full dev environment (local development)
|
# Full dev environment (local development)
|
||||||
dev = [
|
dev = [
|
||||||
"devx[ci,lint,release,molecule]",
|
"devx[ci,lint,release,molecule]",
|
||||||
"build>=1.3.0",
|
"build==1.5.0",
|
||||||
"twine>=6.2.0",
|
"twine==6.2.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools.packages.find]
|
[tool.setuptools.packages.find]
|
||||||
@@ -97,6 +100,8 @@ indent-style = "space"
|
|||||||
[tool.pyright]
|
[tool.pyright]
|
||||||
include = ["src"]
|
include = ["src"]
|
||||||
pythonVersion = "3.12"
|
pythonVersion = "3.12"
|
||||||
|
venvPath = "."
|
||||||
|
venv = ".venv"
|
||||||
strict = ["src/devx/config.py", "src/devx/exceptions.py", "src/devx/i18n.py", "src/devx/api_clients.py", "src/devx/gitea_cli.py"]
|
strict = ["src/devx/config.py", "src/devx/exceptions.py", "src/devx/i18n.py", "src/devx/api_clients.py", "src/devx/gitea_cli.py"]
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -139,8 +144,12 @@ infrastructure_overrides = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
# User-facing overrides — safety override for broad infrastructure patterns
|
# User-facing overrides — safety override for broad infrastructure patterns
|
||||||
# (empty — add when an infrastructure pattern is too broad)
|
# devx workflow files (.gitea/**) are reference implementations that
|
||||||
user_facing_overrides = []
|
# downstream repos (grm, infra) copy from. Changes to them affect how
|
||||||
|
# consumer projects run their CI, so they must trigger a release.
|
||||||
|
user_facing_overrides = [
|
||||||
|
".gitea/**",
|
||||||
|
]
|
||||||
|
|
||||||
# Tag patterns — additional categories for CI conditional execution
|
# Tag patterns — additional categories for CI conditional execution
|
||||||
# Orthogonal to release impact (user-facing vs infrastructure)
|
# Orthogonal to release impact (user-facing vs infrastructure)
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
"""devx — reusable development and CI/CD tools for oblachno-oss projects."""
|
"""devx — reusable development and CI/CD tools for oblachno-oss projects."""
|
||||||
|
|
||||||
__version__ = "0.21.2"
|
__version__ = "0.32.0"
|
||||||
|
|||||||
+143
-93
@@ -4,10 +4,16 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
import time
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
import requests
|
import requests
|
||||||
|
from tenacity import (
|
||||||
|
before_sleep_log,
|
||||||
|
retry,
|
||||||
|
retry_if_exception_type,
|
||||||
|
stop_after_attempt,
|
||||||
|
wait_exponential,
|
||||||
|
)
|
||||||
|
|
||||||
from devx.config import DEFAULT_TIMEOUT, MAX_RETRIES, RETRY_BACKOFF_BASE, RETRY_STATUS_CODES
|
from devx.config import DEFAULT_TIMEOUT, MAX_RETRIES, RETRY_BACKOFF_BASE, RETRY_STATUS_CODES
|
||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
@@ -27,14 +33,69 @@ def _parse_error(e: requests.HTTPError) -> tuple[int, str]:
|
|||||||
return status, message
|
return status, message
|
||||||
|
|
||||||
|
|
||||||
def _is_retryable(e: Exception) -> bool:
|
class _TransientHTTPError(requests.HTTPError):
|
||||||
"""Check if an exception is a transient error worth retrying."""
|
"""HTTP error with a retryable status code (wrapped for tenacity)."""
|
||||||
if isinstance(e, requests.ConnectionError):
|
|
||||||
return True
|
|
||||||
if isinstance(e, requests.HTTPError):
|
class _RetryableRequestError(Exception):
|
||||||
status, _ = _parse_error(e)
|
"""Connection/timeout error wrapped for tenacity retry."""
|
||||||
return status in RETRY_STATUS_CODES
|
|
||||||
return isinstance(e, requests.Timeout)
|
|
||||||
|
def _execute_request(
|
||||||
|
session: requests.Session,
|
||||||
|
method: str,
|
||||||
|
url: str,
|
||||||
|
**kwargs: Any,
|
||||||
|
) -> requests.Response:
|
||||||
|
"""Execute a single HTTP request, wrapping transient errors for tenacity.
|
||||||
|
|
||||||
|
Non-retryable HTTP errors (4xx except 429) raise :class:`APIError` directly.
|
||||||
|
Retryable errors (429, 5xx, connection, timeout) raise exceptions that
|
||||||
|
tenacity will retry.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
response = session.request(method, url, timeout=DEFAULT_TIMEOUT, **kwargs)
|
||||||
|
response.raise_for_status()
|
||||||
|
return response
|
||||||
|
except requests.HTTPError as e:
|
||||||
|
status, message = _parse_error(e)
|
||||||
|
if status in RETRY_STATUS_CODES:
|
||||||
|
# Wrap in _TransientHTTPError so tenacity retries it
|
||||||
|
raise _TransientHTTPError(message, response=e.response) from e
|
||||||
|
raise APIError(status, message) from e
|
||||||
|
except (requests.ConnectionError, requests.Timeout) as e:
|
||||||
|
raise _RetryableRequestError(str(e)) from e
|
||||||
|
|
||||||
|
|
||||||
|
# Tenacity retry decorator shared by both clients.
|
||||||
|
# Retries on transient HTTP errors (429, 5xx) and connection/timeout errors.
|
||||||
|
_retry_decorator = retry(
|
||||||
|
stop=stop_after_attempt(MAX_RETRIES),
|
||||||
|
wait=wait_exponential(multiplier=RETRY_BACKOFF_BASE, min=RETRY_BACKOFF_BASE, max=RETRY_BACKOFF_BASE**MAX_RETRIES),
|
||||||
|
retry=retry_if_exception_type((_TransientHTTPError, _RetryableRequestError)),
|
||||||
|
before_sleep=before_sleep_log(logger, logging.WARNING),
|
||||||
|
reraise=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _request_with_retry(
|
||||||
|
session: requests.Session,
|
||||||
|
url: str,
|
||||||
|
method: str,
|
||||||
|
**kwargs: Any,
|
||||||
|
) -> requests.Response:
|
||||||
|
"""Execute an HTTP request with tenacity-managed retry logic.
|
||||||
|
|
||||||
|
On exhaustion, the last exception is translated to :class:`APIError`.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return _retry_decorator(_execute_request)(session, method, url, **kwargs)
|
||||||
|
except _TransientHTTPError as e:
|
||||||
|
response = getattr(e, "response", None)
|
||||||
|
status = response.status_code if response is not None else 0
|
||||||
|
raise APIError(status, str(e)) from e
|
||||||
|
except _RetryableRequestError as e:
|
||||||
|
raise APIError(0, str(e)) from e
|
||||||
|
|
||||||
|
|
||||||
class GiteaClient:
|
class GiteaClient:
|
||||||
@@ -56,49 +117,7 @@ class GiteaClient:
|
|||||||
return f"{self._base_url}/repos/{self._owner}/{self._repo}{path}"
|
return f"{self._base_url}/repos/{self._owner}/{self._repo}{path}"
|
||||||
|
|
||||||
def _request(self, method: str, path: str, **kwargs: Any) -> requests.Response:
|
def _request(self, method: str, path: str, **kwargs: Any) -> requests.Response:
|
||||||
url = self._url(path)
|
return _request_with_retry(self._session, self._url(path), method, **kwargs)
|
||||||
last_exc: Exception | None = None
|
|
||||||
for attempt in range(MAX_RETRIES):
|
|
||||||
try:
|
|
||||||
response = self._session.request(method, url, timeout=DEFAULT_TIMEOUT, **kwargs)
|
|
||||||
response.raise_for_status()
|
|
||||||
return response
|
|
||||||
except requests.HTTPError as e:
|
|
||||||
status, message = _parse_error(e)
|
|
||||||
if _is_retryable(e) and attempt < MAX_RETRIES - 1:
|
|
||||||
wait = RETRY_BACKOFF_BASE ** (attempt + 1)
|
|
||||||
logger.warning(
|
|
||||||
"Transient HTTP %d on %s %s, retrying in %ds (attempt %d/%d)",
|
|
||||||
status,
|
|
||||||
method,
|
|
||||||
path,
|
|
||||||
wait,
|
|
||||||
attempt + 1,
|
|
||||||
MAX_RETRIES,
|
|
||||||
)
|
|
||||||
time.sleep(wait)
|
|
||||||
last_exc = e
|
|
||||||
continue
|
|
||||||
raise APIError(status, message) from e
|
|
||||||
except (requests.ConnectionError, requests.Timeout) as e:
|
|
||||||
if attempt < MAX_RETRIES - 1:
|
|
||||||
wait = RETRY_BACKOFF_BASE ** (attempt + 1)
|
|
||||||
logger.warning(
|
|
||||||
"Connection error on %s %s, retrying in %ds (attempt %d/%d)",
|
|
||||||
method,
|
|
||||||
path,
|
|
||||||
wait,
|
|
||||||
attempt + 1,
|
|
||||||
MAX_RETRIES,
|
|
||||||
)
|
|
||||||
time.sleep(wait)
|
|
||||||
last_exc = e
|
|
||||||
continue
|
|
||||||
raise APIError(0, str(e)) from e
|
|
||||||
# Should not reach here, but just in case
|
|
||||||
if last_exc: # pragma: no cover
|
|
||||||
raise APIError(0, str(last_exc)) from last_exc
|
|
||||||
raise APIError(0, "Max retries exceeded") # pragma: no cover
|
|
||||||
|
|
||||||
# -- repo settings --
|
# -- repo settings --
|
||||||
|
|
||||||
@@ -175,6 +194,19 @@ class GiteaClient:
|
|||||||
payload = {"Do": "squash", "MergeTitleField": merge_title}
|
payload = {"Do": "squash", "MergeTitleField": merge_title}
|
||||||
self._request("POST", f"/pulls/{pr_number}/merge", json=payload)
|
self._request("POST", f"/pulls/{pr_number}/merge", json=payload)
|
||||||
|
|
||||||
|
def update_pr_branch(self, pr_number: str | int, style: str = "rebase") -> None:
|
||||||
|
"""Update PR head branch by merging/rebasing the base branch into it.
|
||||||
|
|
||||||
|
Uses the Gitea API ``POST /pulls/{index}/update?style=rebase`` endpoint.
|
||||||
|
This rebases the PR's head branch onto the latest base branch server-side,
|
||||||
|
triggering a ``pull_request synchronize`` event that starts a new CI run.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
pr_number: PR number.
|
||||||
|
style: Update method — ``"rebase"`` (default) or ``"merge"``.
|
||||||
|
"""
|
||||||
|
self._request("POST", f"/pulls/{pr_number}/update", params={"style": style})
|
||||||
|
|
||||||
def get_commit_status(self, sha: str) -> list[dict[str, Any]]:
|
def get_commit_status(self, sha: str) -> list[dict[str, Any]]:
|
||||||
"""Fetch all status check contexts reported for a commit.
|
"""Fetch all status check contexts reported for a commit.
|
||||||
|
|
||||||
@@ -223,6 +255,20 @@ class GiteaClient:
|
|||||||
r = self._request("GET", f"/pulls/{pr_number}/files")
|
r = self._request("GET", f"/pulls/{pr_number}/files")
|
||||||
return r.json()
|
return r.json()
|
||||||
|
|
||||||
|
def add_pr_label(self, pr_number: str | int, label_names: list[str]) -> None:
|
||||||
|
"""Attach labels to a PR/issue by name.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
pr_number: PR or issue number.
|
||||||
|
label_names: List of label names to attach.
|
||||||
|
"""
|
||||||
|
self._request("POST", f"/issues/{pr_number}/labels", json={"labels": label_names})
|
||||||
|
|
||||||
|
def get_pr_label_names(self, pr_number: str | int) -> list[str]:
|
||||||
|
"""Return label names currently attached to a PR/issue."""
|
||||||
|
r = self._request("GET", f"/issues/{pr_number}/labels")
|
||||||
|
return [label.get("name", "") for label in r.json()]
|
||||||
|
|
||||||
def get_pr_commits(self, pr_number: str | int) -> list[dict[str, Any]]:
|
def get_pr_commits(self, pr_number: str | int) -> list[dict[str, Any]]:
|
||||||
"""Fetch the commits included in a pull request."""
|
"""Fetch the commits included in a pull request."""
|
||||||
r = self._request("GET", f"/pulls/{pr_number}/commits")
|
r = self._request("GET", f"/pulls/{pr_number}/commits")
|
||||||
@@ -301,6 +347,31 @@ class GiteaClient:
|
|||||||
return existing
|
return existing
|
||||||
return self.create_release(tag=tag, name=name, body=body, draft=draft, prerelease=prerelease)
|
return self.create_release(tag=tag, name=name, body=body, draft=draft, prerelease=prerelease)
|
||||||
|
|
||||||
|
# -- actions (CI/CD) --
|
||||||
|
|
||||||
|
def list_action_runs(self, **params: Any) -> dict[str, Any]:
|
||||||
|
"""List workflow runs for the repository.
|
||||||
|
|
||||||
|
Returns the raw API response dict (includes ``workflow_runs`` and
|
||||||
|
``total_count`` keys per Gitea API).
|
||||||
|
"""
|
||||||
|
r = self._request("GET", "/actions/runs", params=params)
|
||||||
|
return r.json()
|
||||||
|
|
||||||
|
def get_action_run_jobs(self, run_id: str | int) -> list[dict[str, Any]]:
|
||||||
|
"""List jobs for a specific workflow run."""
|
||||||
|
r = self._request("GET", f"/actions/runs/{run_id}/jobs")
|
||||||
|
data = r.json()
|
||||||
|
return data.get("jobs", [])
|
||||||
|
|
||||||
|
def get_action_job_logs(self, job_id: str | int) -> str:
|
||||||
|
"""Fetch logs for a specific CI job.
|
||||||
|
|
||||||
|
Returns the raw log text. Raises APIError if logs are unavailable.
|
||||||
|
"""
|
||||||
|
r = self._request("GET", f"/actions/jobs/{job_id}/logs")
|
||||||
|
return r.text
|
||||||
|
|
||||||
|
|
||||||
class VikunjaClient:
|
class VikunjaClient:
|
||||||
"""Low-level Vikunja REST API client with connection pooling."""
|
"""Low-level Vikunja REST API client with connection pooling."""
|
||||||
@@ -312,47 +383,7 @@ class VikunjaClient:
|
|||||||
|
|
||||||
def _request(self, method: str, path: str, **kwargs: Any) -> requests.Response:
|
def _request(self, method: str, path: str, **kwargs: Any) -> requests.Response:
|
||||||
url = f"{self._base_url}{path}"
|
url = f"{self._base_url}{path}"
|
||||||
last_exc: Exception | None = None
|
return _request_with_retry(self._session, url, method, **kwargs)
|
||||||
for attempt in range(MAX_RETRIES):
|
|
||||||
try:
|
|
||||||
response = self._session.request(method, url, timeout=DEFAULT_TIMEOUT, **kwargs)
|
|
||||||
response.raise_for_status()
|
|
||||||
return response
|
|
||||||
except requests.HTTPError as e:
|
|
||||||
status, message = _parse_error(e)
|
|
||||||
if _is_retryable(e) and attempt < MAX_RETRIES - 1:
|
|
||||||
wait = RETRY_BACKOFF_BASE ** (attempt + 1)
|
|
||||||
logger.warning(
|
|
||||||
"Transient HTTP %d on %s %s, retrying in %ds (attempt %d/%d)",
|
|
||||||
status,
|
|
||||||
method,
|
|
||||||
path,
|
|
||||||
wait,
|
|
||||||
attempt + 1,
|
|
||||||
MAX_RETRIES,
|
|
||||||
)
|
|
||||||
time.sleep(wait)
|
|
||||||
last_exc = e
|
|
||||||
continue
|
|
||||||
raise APIError(status, message) from e
|
|
||||||
except (requests.ConnectionError, requests.Timeout) as e:
|
|
||||||
if attempt < MAX_RETRIES - 1:
|
|
||||||
wait = RETRY_BACKOFF_BASE ** (attempt + 1)
|
|
||||||
logger.warning(
|
|
||||||
"Connection error on %s %s, retrying in %ds (attempt %d/%d)",
|
|
||||||
method,
|
|
||||||
path,
|
|
||||||
wait,
|
|
||||||
attempt + 1,
|
|
||||||
MAX_RETRIES,
|
|
||||||
)
|
|
||||||
time.sleep(wait)
|
|
||||||
last_exc = e
|
|
||||||
continue
|
|
||||||
raise APIError(0, str(e)) from e
|
|
||||||
if last_exc: # pragma: no cover
|
|
||||||
raise APIError(0, str(last_exc)) from last_exc
|
|
||||||
raise APIError(0, "Max retries exceeded") # pragma: no cover
|
|
||||||
|
|
||||||
def list_tasks(self, **params: Any) -> list[dict[str, Any]]:
|
def list_tasks(self, **params: Any) -> list[dict[str, Any]]:
|
||||||
r = self._request("GET", "/tasks", params=params)
|
r = self._request("GET", "/tasks", params=params)
|
||||||
@@ -368,6 +399,25 @@ class VikunjaClient:
|
|||||||
r = self._request("GET", f"/projects/{project_id}/tasks", params=params)
|
r = self._request("GET", f"/projects/{project_id}/tasks", params=params)
|
||||||
return r.json()
|
return r.json()
|
||||||
|
|
||||||
|
def find_task_by_identifier(self, project_id: int, identifier: str, per_page: int = 50) -> dict[str, Any] | None:
|
||||||
|
"""Find a task by its identifier (e.g. ``DEVX-42``) in a project.
|
||||||
|
|
||||||
|
Paginates through all tasks in the project. Returns the task dict
|
||||||
|
or None if not found.
|
||||||
|
"""
|
||||||
|
page = 1
|
||||||
|
while True:
|
||||||
|
tasks = self.list_project_tasks(project_id, page=page, per_page=per_page)
|
||||||
|
if not tasks:
|
||||||
|
break
|
||||||
|
for t in tasks:
|
||||||
|
if t.get("identifier") == identifier:
|
||||||
|
return t
|
||||||
|
if len(tasks) < per_page:
|
||||||
|
break
|
||||||
|
page += 1
|
||||||
|
return None
|
||||||
|
|
||||||
def create_task(self, project_id: int, title: str, description: str = "") -> dict[str, Any]:
|
def create_task(self, project_id: int, title: str, description: str = "") -> dict[str, Any]:
|
||||||
"""Create a task in a project and return the created task dict.
|
"""Create a task in a project and return the created task dict.
|
||||||
|
|
||||||
|
|||||||
@@ -2,8 +2,14 @@
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
import subprocess # nosec B404
|
import subprocess # nosec B404
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
|
from devx.config import TASK_ID_RE
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
|
|
||||||
def get_latest_tag() -> str:
|
def get_latest_tag() -> str:
|
||||||
"""Get the latest git tag, or empty string if none exists."""
|
"""Get the latest git tag, or empty string if none exists."""
|
||||||
@@ -16,3 +22,97 @@ def get_latest_tag() -> str:
|
|||||||
if result.returncode != 0:
|
if result.returncode != 0:
|
||||||
return ""
|
return ""
|
||||||
return result.stdout.strip()
|
return result.stdout.strip()
|
||||||
|
|
||||||
|
|
||||||
|
def run_cmd(
|
||||||
|
args: list[str],
|
||||||
|
check: bool = True,
|
||||||
|
capture: bool = True,
|
||||||
|
) -> subprocess.CompletedProcess[str]:
|
||||||
|
"""Run a command and return the completed process.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
args: Command and arguments as a list.
|
||||||
|
check: If True, raise :class:`click.ClickException` on non-zero exit.
|
||||||
|
capture: If True, capture stdout/stderr. If False, inherit parent's.
|
||||||
|
"""
|
||||||
|
result = subprocess.run( # nosec B603
|
||||||
|
args,
|
||||||
|
capture_output=capture,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if check and result.returncode != 0:
|
||||||
|
raise click.ClickException(
|
||||||
|
_(
|
||||||
|
"Command failed ({cmd}): {stderr}",
|
||||||
|
cmd=" ".join(args),
|
||||||
|
stderr=result.stderr.strip() if result.stderr else result.stdout.strip(),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def extract_task_id(text: str) -> str:
|
||||||
|
"""Extract the ``{PREFIX}-N`` task identifier from *text*.
|
||||||
|
|
||||||
|
Returns the matched string (e.g. ``DEVX-42``) or an empty string if
|
||||||
|
no task ID is found.
|
||||||
|
"""
|
||||||
|
match = TASK_ID_RE.search(text)
|
||||||
|
return match.group(0) if match else ""
|
||||||
|
|
||||||
|
|
||||||
|
def write_github_env(key: str, value: str) -> None:
|
||||||
|
"""Append a key=value line to the ``$GITHUB_ENV`` file.
|
||||||
|
|
||||||
|
Multi-line values use the heredoc syntax required by Gitea Actions.
|
||||||
|
Raises :class:`click.ClickException` if ``GITHUB_ENV`` is not set.
|
||||||
|
"""
|
||||||
|
gh_env = os.environ.get("GITHUB_ENV")
|
||||||
|
if not gh_env:
|
||||||
|
raise click.ClickException("GITHUB_ENV environment variable is not set")
|
||||||
|
with open(gh_env, "a", encoding="utf-8") as f: # noqa: PTH123
|
||||||
|
if "\n" in value:
|
||||||
|
delimiter = "EOF"
|
||||||
|
f.write(f"{key}<<{delimiter}\n{value}\n{delimiter}\n")
|
||||||
|
else:
|
||||||
|
f.write(f"{key}={value}\n")
|
||||||
|
|
||||||
|
|
||||||
|
def write_github_output(key: str, value: str) -> None:
|
||||||
|
"""Append a key=value line to the ``$GITHUB_OUTPUT`` file.
|
||||||
|
|
||||||
|
Raises :class:`click.ClickException` if ``GITHUB_OUTPUT`` is not set.
|
||||||
|
"""
|
||||||
|
gh_output = os.environ.get("GITHUB_OUTPUT")
|
||||||
|
if not gh_output:
|
||||||
|
raise click.ClickException("GITHUB_OUTPUT environment variable is not set")
|
||||||
|
with open(gh_output, "a", encoding="utf-8") as f: # noqa: PTH123
|
||||||
|
f.write(f"{key}={value}\n")
|
||||||
|
|
||||||
|
|
||||||
|
def lpt_distribute[T](items: list[T], weights: list[int], max_runners: int) -> list[list[T]]:
|
||||||
|
"""Distribute *items* across *max_runners* using LPT scheduling.
|
||||||
|
|
||||||
|
Sorts items by weight (descending), then assigns each to the runner
|
||||||
|
with the least total weight. This produces a more balanced distribution
|
||||||
|
than naive round-robin when items have varying costs.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
items: Items to distribute.
|
||||||
|
weights: Parallel list of integer weights (higher = heavier).
|
||||||
|
max_runners: Number of runner groups to create.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
A list of ``max_runners`` lists, each containing the items assigned
|
||||||
|
to that runner.
|
||||||
|
"""
|
||||||
|
groups: list[list[T]] = [[] for _ in range(max_runners)]
|
||||||
|
loads = [0] * max_runners
|
||||||
|
indexed = sorted(enumerate(items), key=lambda x: (-weights[x[0]], x[0]))
|
||||||
|
for orig_idx, item in indexed:
|
||||||
|
min_runner = min(range(max_runners), key=lambda r: loads[r])
|
||||||
|
groups[min_runner].append(item)
|
||||||
|
loads[min_runner] += weights[orig_idx]
|
||||||
|
return groups
|
||||||
|
|||||||
+53
-34
@@ -17,12 +17,11 @@ This allows the PR title to be a human-friendly Vikunja task title
|
|||||||
while the squashed commit follows conventional commits.
|
while the squashed commit follows conventional commits.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
REPO_TOKEN=<token> python3 -m devx.ci.auto_merge <branch> <pr_title> <repo> <pr_number>
|
CI_GITEA_TOKEN=<token> python3 -m devx.ci.auto_merge <branch> <pr_title> <repo> <pr_number>
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
import subprocess # nosec B404
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
@@ -30,11 +29,11 @@ import click
|
|||||||
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
||||||
|
|
||||||
from devx.api_clients import GiteaClient, VikunjaClient
|
from devx.api_clients import GiteaClient, VikunjaClient
|
||||||
|
from devx.ci._shared import extract_task_id as _extract_task_id
|
||||||
from devx.config import (
|
from devx.config import (
|
||||||
CONVENTIONAL_RE,
|
CONVENTIONAL_RE,
|
||||||
DEFAULT_PER_PAGE,
|
DEFAULT_PER_PAGE,
|
||||||
GITEA_API_URL,
|
GITEA_API_URL,
|
||||||
TASK_ID_RE,
|
|
||||||
TASK_PREFIX,
|
TASK_PREFIX,
|
||||||
VIKUNJA_API_URL,
|
VIKUNJA_API_URL,
|
||||||
VIKUNJA_PROJECT_ID,
|
VIKUNJA_PROJECT_ID,
|
||||||
@@ -42,26 +41,15 @@ from devx.config import (
|
|||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
|
# Strip leading task ID prefix (e.g. "DEVX-12: " or "OBL-INFRA-364: ") from commit subjects.
|
||||||
|
_TASK_ID_PREFIX_RE = re.compile(rf"^{TASK_PREFIX}-\d+:\s*")
|
||||||
|
|
||||||
TASKID_FILE = ".taskid" # Deprecated, kept for backward-compat warnings
|
TASKID_FILE = ".taskid" # Deprecated, kept for backward-compat warnings
|
||||||
PR_TITLE_RE = re.compile(rf"^{TASK_PREFIX}-\d+:\s+.+")
|
PR_TITLE_RE = re.compile(rf"^{TASK_PREFIX}-\d+:\s+.+")
|
||||||
|
|
||||||
load_dotenv()
|
load_dotenv()
|
||||||
|
|
||||||
|
|
||||||
def run_cmd(args: list[str], check: bool = True) -> subprocess.CompletedProcess[str]:
|
|
||||||
"""Run a command and return the completed process."""
|
|
||||||
result = subprocess.run(args, capture_output=True, text=True, check=False) # nosec B603
|
|
||||||
if check and result.returncode != 0:
|
|
||||||
raise click.ClickException(
|
|
||||||
_(
|
|
||||||
"Command failed ({cmd}): {stderr}",
|
|
||||||
cmd=" ".join(args),
|
|
||||||
stderr=result.stderr.strip() or result.stdout.strip(),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
return result
|
|
||||||
|
|
||||||
|
|
||||||
def read_taskid(branch: str) -> str:
|
def read_taskid(branch: str) -> str:
|
||||||
"""Read task ID from branch name.
|
"""Read task ID from branch name.
|
||||||
|
|
||||||
@@ -92,9 +80,8 @@ def read_taskid(branch: str) -> str:
|
|||||||
|
|
||||||
|
|
||||||
def extract_task_id(branch: str) -> str:
|
def extract_task_id(branch: str) -> str:
|
||||||
"""Extract DEVX-N task identifier from branch name (legacy fallback)."""
|
"""Extract task identifier from branch name (delegates to shared utility)."""
|
||||||
match = TASK_ID_RE.search(branch)
|
return _extract_task_id(branch)
|
||||||
return match.group(0) if match else ""
|
|
||||||
|
|
||||||
|
|
||||||
def validate_pr_title(pr_title: str, task_id: str) -> None:
|
def validate_pr_title(pr_title: str, task_id: str) -> None:
|
||||||
@@ -174,19 +161,33 @@ def validate_pr_title_matches_vikunja(pr_title: str, task_id: str) -> None:
|
|||||||
def extract_conventional_msg(commits: list[dict[str, Any]]) -> str:
|
def extract_conventional_msg(commits: list[dict[str, Any]]) -> str:
|
||||||
"""Extract the conventional commit message from PR commits.
|
"""Extract the conventional commit message from PR commits.
|
||||||
|
|
||||||
Iterates commits in reverse order (newest first) to find the first
|
Picks the highest-priority conventional commit message from the PR.
|
||||||
message matching the conventional commit format. Falls back to the
|
Priority: feat > fix > refactor > docs > chore > other.
|
||||||
newest commit message if none match.
|
Falls back to the newest commit message if none match.
|
||||||
"""
|
"""
|
||||||
|
priority = {"feat": 5, "fix": 4, "refactor": 3, "docs": 2, "chore": 1, "ci": 1, "style": 1, "test": 1}
|
||||||
|
best_msg = ""
|
||||||
|
best_score = 0
|
||||||
for commit in reversed(commits):
|
for commit in reversed(commits):
|
||||||
commit_info = commit.get("commit", {})
|
commit_info = commit.get("commit", {})
|
||||||
message = str(commit_info.get("message", "") if isinstance(commit_info, dict) else "").split("\n")[0]
|
message = str(commit_info.get("message", "") if isinstance(commit_info, dict) else "").split("\n")[0]
|
||||||
if CONVENTIONAL_RE.match(message):
|
# Strip any leading task ID prefix (e.g. "OBL-INFRA-364: fix: ...") so
|
||||||
return message
|
# conventional commit matching works on the remainder.
|
||||||
# Fallback: use the newest commit's first line
|
stripped = _TASK_ID_PREFIX_RE.sub("", message)
|
||||||
|
m = CONVENTIONAL_RE.match(stripped)
|
||||||
|
if m:
|
||||||
|
prefix = m.group(1).split("(")[0].strip() # e.g. "feat" from "feat(scope)"
|
||||||
|
score = priority.get(prefix, 0)
|
||||||
|
if score > best_score:
|
||||||
|
best_score = score
|
||||||
|
best_msg = stripped
|
||||||
|
if best_msg:
|
||||||
|
return best_msg
|
||||||
|
# Fallback: use the newest commit's first line (strip task ID prefix if present)
|
||||||
if commits:
|
if commits:
|
||||||
commit_info = commits[-1].get("commit", {})
|
commit_info = commits[-1].get("commit", {})
|
||||||
return str(commit_info.get("message", "") if isinstance(commit_info, dict) else "").split("\n")[0]
|
raw = str(commit_info.get("message", "") if isinstance(commit_info, dict) else "").split("\n")[0]
|
||||||
|
return _TASK_ID_PREFIX_RE.sub("", raw)
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
|
|
||||||
@@ -196,9 +197,9 @@ def extract_conventional_msg(commits: list[dict[str, Any]]) -> str:
|
|||||||
@click.argument("repo")
|
@click.argument("repo")
|
||||||
@click.argument("pr_number")
|
@click.argument("pr_number")
|
||||||
def main(branch: str, pr_title: str, repo: str, pr_number: str) -> None:
|
def main(branch: str, pr_title: str, repo: str, pr_number: str) -> None:
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not token:
|
if not token:
|
||||||
raise click.ClickException(_("ERROR: REPO_TOKEN is not set."))
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
||||||
|
|
||||||
# Validate PR number is an integer
|
# Validate PR number is an integer
|
||||||
try:
|
try:
|
||||||
@@ -237,17 +238,35 @@ def main(branch: str, pr_title: str, repo: str, pr_number: str) -> None:
|
|||||||
client.merge_pr(pr_num, merge_title)
|
client.merge_pr(pr_num, merge_title)
|
||||||
except APIError as e:
|
except APIError as e:
|
||||||
if e.status == 405 and "behind" in e.message.lower():
|
if e.status == 405 and "behind" in e.message.lower():
|
||||||
# Head branch is behind master — do NOT auto-rebase.
|
# Head branch is behind master. Auto-rebase via Gitea API.
|
||||||
# Auto-rebasing creates a feedback loop: the force-push triggers
|
# This triggers a new pull_request synchronize event → new CI run.
|
||||||
# a new pull_request synchronize event, which starts a new CI run,
|
# The next auto-merge attempt will find the branch up-to-date and
|
||||||
# which runs auto-merge again, which rebases again, etc.
|
# merge successfully. This is NOT an infinite loop: the rebase
|
||||||
|
# resolves the "behind" condition, so the next run merges.
|
||||||
|
# If another PR merges in between, the branch may fall behind
|
||||||
|
# again, but the process converges as PRs stop merging.
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Branch is behind master. Auto-rebasing via Gitea API...\n"
|
||||||
|
"A new CI run will start automatically after the rebase.\n"
|
||||||
|
"The next auto-merge attempt will merge this PR.",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
client.update_pr_branch(pr_num, style="rebase")
|
||||||
|
except APIError as rebase_err:
|
||||||
raise click.ClickException(
|
raise click.ClickException(
|
||||||
_(
|
_(
|
||||||
"Branch is behind master. Rebase manually:\n"
|
"Auto-rebase failed with HTTP {status}: {message}\n"
|
||||||
|
"Rebase manually:\n"
|
||||||
" git fetch origin master && git rebase origin/master && git push --force-with-lease\n"
|
" git fetch origin master && git rebase origin/master && git push --force-with-lease\n"
|
||||||
"Then re-add the ready-to-merge label.",
|
"Then re-add the ready-to-merge label.",
|
||||||
|
status=rebase_err.status,
|
||||||
|
message=rebase_err.message,
|
||||||
)
|
)
|
||||||
) from None
|
) from None
|
||||||
|
# Exit cleanly — the rebase triggers a new CI run that will retry.
|
||||||
|
return
|
||||||
else:
|
else:
|
||||||
raise click.ClickException(
|
raise click.ClickException(
|
||||||
_(
|
_(
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ Exit code 1 = NOT ready — fix issues before pushing.
|
|||||||
|
|
||||||
Usage::
|
Usage::
|
||||||
|
|
||||||
# CI (with VIKUNJA_TOKEN and REPO_TOKEN):
|
# CI (with VIKUNJA_TOKEN and CI_GITEA_TOKEN):
|
||||||
python3 -m devx.ci.check_auto_merge_ready \\
|
python3 -m devx.ci.check_auto_merge_ready \\
|
||||||
--branch "$HEAD_REF" \\
|
--branch "$HEAD_REF" \\
|
||||||
--pr-title "$PR_TITLE" \\
|
--pr-title "$PR_TITLE" \\
|
||||||
@@ -34,7 +34,7 @@ skipped (with a warning) — this allows local pre-push hooks to run
|
|||||||
without CI secrets. In CI, the token is always set and the check is
|
without CI secrets. In CI, the token is always set and the check is
|
||||||
mandatory.
|
mandatory.
|
||||||
|
|
||||||
If ``REPO_TOKEN`` is not set and ``--pr-number`` is not provided, only
|
If ``CI_GITEA_TOKEN`` is not set and ``--pr-number`` is not provided, only
|
||||||
branch-name and PR-title-format checks run (local mode).
|
branch-name and PR-title-format checks run (local mode).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -53,6 +53,7 @@ from devx.config import (
|
|||||||
VIKUNJA_API_URL,
|
VIKUNJA_API_URL,
|
||||||
VIKUNJA_PROJECT_ID,
|
VIKUNJA_PROJECT_ID,
|
||||||
)
|
)
|
||||||
|
from devx.exceptions import APIError
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
load_dotenv()
|
load_dotenv()
|
||||||
@@ -98,9 +99,9 @@ def is_branch_behind_master(branch: str) -> bool:
|
|||||||
def get_pr_title_from_gitea(repo: str, pr_number: int) -> str | None:
|
def get_pr_title_from_gitea(repo: str, pr_number: int) -> str | None:
|
||||||
"""Fetch the PR title from the Gitea API.
|
"""Fetch the PR title from the Gitea API.
|
||||||
|
|
||||||
Returns ``None`` if ``REPO_TOKEN`` is not set or the PR cannot be fetched.
|
Returns ``None`` if ``CI_GITEA_TOKEN`` is not set or the PR cannot be fetched.
|
||||||
"""
|
"""
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not token or "/" not in repo:
|
if not token or "/" not in repo:
|
||||||
return None
|
return None
|
||||||
owner, repo_name = repo.split("/", 1)
|
owner, repo_name = repo.split("/", 1)
|
||||||
@@ -108,7 +109,7 @@ def get_pr_title_from_gitea(repo: str, pr_number: int) -> str | None:
|
|||||||
try:
|
try:
|
||||||
pr = client.get_pr(pr_number)
|
pr = client.get_pr(pr_number)
|
||||||
return str(pr.get("title", ""))
|
return str(pr.get("title", ""))
|
||||||
except Exception:
|
except APIError:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
@@ -189,7 +190,9 @@ def cli(
|
|||||||
if pr_title is None:
|
if pr_title is None:
|
||||||
# Local mode without PR — only validate branch name
|
# Local mode without PR — only validate branch name
|
||||||
if pr_number is not None:
|
if pr_number is not None:
|
||||||
raise click.ClickException(_("Could not fetch PR title from Gitea (REPO_TOKEN not set or PR not found)."))
|
raise click.ClickException(
|
||||||
|
_("Could not fetch PR title from Gitea (CI_GITEA_TOKEN not set or PR not found).")
|
||||||
|
)
|
||||||
click.echo("[pre-merge-check] No PR title provided — running branch-name-only check (local mode).")
|
click.echo("[pre-merge-check] No PR title provided — running branch-name-only check (local mode).")
|
||||||
click.echo("[pre-merge-check] Branch name OK. Push to create PR, then CI will validate the title.")
|
click.echo("[pre-merge-check] Branch name OK. Push to create PR, then CI will validate the title.")
|
||||||
return
|
return
|
||||||
|
|||||||
@@ -31,11 +31,11 @@ from pathlib import Path
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
REPO_ROOT = Path(__file__).resolve().parent.parent.parent.parent
|
REPO_ROOT = Path.cwd()
|
||||||
|
|
||||||
SUPPORTED_LANGS = ("en", "bg", "de", "ru", "zh", "pl")
|
SUPPORTED_LANGS = ("en", "bg", "de", "ru", "zh", "pl")
|
||||||
|
|
||||||
# Default translation set: devx package itself
|
# Default translation set: look for translations.json in the current repo
|
||||||
DEFAULT_TRANS_FILE = REPO_ROOT / "src" / "devx" / "translations.json"
|
DEFAULT_TRANS_FILE = REPO_ROOT / "src" / "devx" / "translations.json"
|
||||||
DEFAULT_SRC_DIR = REPO_ROOT / "src" / "devx"
|
DEFAULT_SRC_DIR = REPO_ROOT / "src" / "devx"
|
||||||
|
|
||||||
@@ -169,20 +169,44 @@ def print_result(result: TranslationCheckResult) -> None:
|
|||||||
"translations",
|
"translations",
|
||||||
multiple=True,
|
multiple=True,
|
||||||
type=click.Path(exists=False, path_type=Path),
|
type=click.Path(exists=False, path_type=Path),
|
||||||
help="Path to a translations JSON file to check (can be repeated). Defaults to src/devx/translations.json.",
|
help="Path to a translations JSON file to check (can be repeated). Auto-detects by default.",
|
||||||
)
|
)
|
||||||
def main(translations: tuple[Path, ...]) -> None:
|
@click.option(
|
||||||
|
"--source-dir",
|
||||||
|
default=None,
|
||||||
|
help="Source directory to scan for _() calls (default: auto-detect).",
|
||||||
|
)
|
||||||
|
def main(translations: tuple[Path, ...], source_dir: str | None) -> None:
|
||||||
"""Check translation files for gaps, dead keys, and missing languages."""
|
"""Check translation files for gaps, dead keys, and missing languages."""
|
||||||
|
results: list[TranslationCheckResult] = []
|
||||||
if not translations:
|
if not translations:
|
||||||
# Default: check the devx package's own translations
|
# Auto-detect translations file in the current repo
|
||||||
results = [
|
root = Path.cwd()
|
||||||
check_translation_set("devx", DEFAULT_SRC_DIR, DEFAULT_TRANS_FILE),
|
# Try common locations
|
||||||
|
candidates = [
|
||||||
|
root / "src" / "devx" / "translations.json",
|
||||||
|
root / "src" / "gitea_runner_manager" / "translations.json",
|
||||||
]
|
]
|
||||||
|
# Also search for any translations.json in src/
|
||||||
|
for match in root.glob("src/*/translations.json"):
|
||||||
|
candidates.append(match)
|
||||||
|
|
||||||
|
found = False
|
||||||
|
for candidate in candidates:
|
||||||
|
if candidate.exists():
|
||||||
|
src_dir = Path(source_dir) if source_dir else candidate.parent
|
||||||
|
results.append(check_translation_set(candidate.parent.name, src_dir, candidate))
|
||||||
|
found = True
|
||||||
|
break
|
||||||
|
|
||||||
|
if not found:
|
||||||
|
# No translations file found — this repo doesn't use i18n
|
||||||
|
click.echo("PASS: No translations file found — skipping (repo does not use i18n).")
|
||||||
|
return
|
||||||
else:
|
else:
|
||||||
results = []
|
|
||||||
for trans_file in translations:
|
for trans_file in translations:
|
||||||
# Infer source directory as the parent of the translations file
|
# Infer source directory as the parent of the translations file
|
||||||
src_dir = trans_file.parent
|
src_dir = Path(source_dir) if source_dir else trans_file.parent
|
||||||
name = trans_file.parent.name
|
name = trans_file.parent.name
|
||||||
results.append(check_translation_set(name, src_dir, trans_file))
|
results.append(check_translation_set(name, src_dir, trans_file))
|
||||||
|
|
||||||
|
|||||||
@@ -138,7 +138,7 @@ from typing import Any
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
from devx.ci._shared import get_latest_tag
|
from devx.ci._shared import get_latest_tag, write_github_output
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -393,11 +393,12 @@ class ChangeClassifier:
|
|||||||
tags = self._compute_tags(file_path)
|
tags = self._compute_tags(file_path)
|
||||||
|
|
||||||
# 1. User-facing overrides (highest priority — safety)
|
# 1. User-facing overrides (highest priority — safety)
|
||||||
if file_path in self._user_overrides:
|
for pattern in self._user_overrides:
|
||||||
|
if _matches_glob(file_path, pattern):
|
||||||
return FileClassification(
|
return FileClassification(
|
||||||
path=file_path,
|
path=file_path,
|
||||||
is_user_facing=True,
|
is_user_facing=True,
|
||||||
reason="User-facing override (safety override)",
|
reason=f"User-facing override (matches '{pattern}')",
|
||||||
matched_rule="user_facing_overrides",
|
matched_rule="user_facing_overrides",
|
||||||
tags=tags,
|
tags=tags,
|
||||||
)
|
)
|
||||||
@@ -583,15 +584,8 @@ def has_user_facing_changes(
|
|||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
def _write_github_output(key: str, value: str) -> None:
|
# ---------------------------------------------------------------------------
|
||||||
"""Append a key=value line to the $GITHUB_OUTPUT file."""
|
# Classification logic
|
||||||
gh_output = os.environ.get("GITHUB_OUTPUT")
|
|
||||||
if not gh_output:
|
|
||||||
raise click.ClickException("GITHUB_OUTPUT environment variable is not set")
|
|
||||||
with open(gh_output, "a") as f: # noqa: PTH123
|
|
||||||
f.write(f"{key}={value}\n")
|
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# CLI
|
# CLI
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -632,9 +626,9 @@ def main(base: str | None, head: str, quiet: bool, check: str, github_output: bo
|
|||||||
force = True
|
force = True
|
||||||
|
|
||||||
if force and github_output:
|
if force and github_output:
|
||||||
_write_github_output("user-facing-changed", "true")
|
write_github_output("user-facing-changed", "true")
|
||||||
for tag in available_tags:
|
for tag in available_tags:
|
||||||
_write_github_output(f"{tag}-changed", "true")
|
write_github_output(f"{tag}-changed", "true")
|
||||||
click.echo("Forced user-facing-changed=true via --force flag.")
|
click.echo("Forced user-facing-changed=true via --force flag.")
|
||||||
return
|
return
|
||||||
|
|
||||||
@@ -642,9 +636,9 @@ def main(base: str | None, head: str, quiet: bool, check: str, github_output: bo
|
|||||||
base = get_latest_tag()
|
base = get_latest_tag()
|
||||||
if not base:
|
if not base:
|
||||||
if github_output:
|
if github_output:
|
||||||
_write_github_output("user-facing-changed", "true")
|
write_github_output("user-facing-changed", "true")
|
||||||
for tag in available_tags:
|
for tag in available_tags:
|
||||||
_write_github_output(f"{tag}-changed", "true")
|
write_github_output(f"{tag}-changed", "true")
|
||||||
click.echo("No tags found — treating all changes as user-facing.")
|
click.echo("No tags found — treating all changes as user-facing.")
|
||||||
return
|
return
|
||||||
if quiet:
|
if quiet:
|
||||||
@@ -656,9 +650,9 @@ def main(base: str | None, head: str, quiet: bool, check: str, github_output: bo
|
|||||||
files = get_changed_files(base, head)
|
files = get_changed_files(base, head)
|
||||||
if not files:
|
if not files:
|
||||||
if github_output:
|
if github_output:
|
||||||
_write_github_output("user-facing-changed", "false")
|
write_github_output("user-facing-changed", "false")
|
||||||
for tag in available_tags:
|
for tag in available_tags:
|
||||||
_write_github_output(f"{tag}-changed", "false")
|
write_github_output(f"{tag}-changed", "false")
|
||||||
click.echo(f"No changes between {base} and {head}.")
|
click.echo(f"No changes between {base} and {head}.")
|
||||||
return
|
return
|
||||||
if quiet:
|
if quiet:
|
||||||
@@ -670,9 +664,9 @@ def main(base: str | None, head: str, quiet: bool, check: str, github_output: bo
|
|||||||
result = classifier.classify(files)
|
result = classifier.classify(files)
|
||||||
|
|
||||||
if github_output:
|
if github_output:
|
||||||
_write_github_output("user-facing-changed", "true" if result.has_user_facing else "false")
|
write_github_output("user-facing-changed", "true" if result.has_user_facing else "false")
|
||||||
for tag in available_tags:
|
for tag in available_tags:
|
||||||
_write_github_output(f"{tag}-changed", "true" if result.has_tag(tag) else "false")
|
write_github_output(f"{tag}-changed", "true" if result.has_tag(tag) else "false")
|
||||||
click.echo(f"User-facing files changed: {result.has_user_facing}")
|
click.echo(f"User-facing files changed: {result.has_user_facing}")
|
||||||
for tag in available_tags:
|
for tag in available_tags:
|
||||||
click.echo(f"{tag.capitalize()} files changed: {result.has_tag(tag)}")
|
click.echo(f"{tag.capitalize()} files changed: {result.has_tag(tag)}")
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
"""Detect whether the latest git commit is a release commit.
|
"""Detect whether the latest git commit is an automated CI commit.
|
||||||
|
|
||||||
Release commits have the format ``release: vX.Y.Z``.
|
Release commits have the format ``release: vX.Y.Z``.
|
||||||
|
Badge commits have the format ``chore: update badge URLs ... [skip ci]``.
|
||||||
|
Both are generated by CI and should skip post-merge jobs.
|
||||||
|
|
||||||
This script writes ``is-release=true`` or ``is-release=false`` to
|
This script writes ``is-release=true`` or ``is-release=false`` to
|
||||||
``$GITHUB_OUTPUT`` for use in CI workflow conditionals.
|
``$GITHUB_OUTPUT`` for use in CI workflow conditionals.
|
||||||
|
|
||||||
@@ -12,13 +15,16 @@ Usage::
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import os
|
|
||||||
import re
|
import re
|
||||||
import subprocess # nosec B404
|
import subprocess # nosec B404
|
||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
|
from devx.ci._shared import write_github_output
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
RELEASE_RE = re.compile(r"^release: v\d+\.\d+\.\d+")
|
RELEASE_RE = re.compile(r"^release: v\d+\.\d+\.\d+")
|
||||||
|
BADGE_RE = re.compile(r"^chore: update badge URLs.*\[skip ci\]")
|
||||||
|
|
||||||
|
|
||||||
def get_commit_message() -> str:
|
def get_commit_message() -> str:
|
||||||
@@ -39,26 +45,31 @@ def is_release_commit(message: str) -> bool:
|
|||||||
return bool(RELEASE_RE.match(message))
|
return bool(RELEASE_RE.match(message))
|
||||||
|
|
||||||
|
|
||||||
def write_github_output(key: str, value: str) -> None:
|
def is_badge_commit(message: str) -> bool:
|
||||||
"""Append a key=value line to the $GITHUB_OUTPUT file."""
|
"""Check if a commit message matches the badge commit format."""
|
||||||
gh_output = os.environ.get("GITHUB_OUTPUT")
|
return bool(BADGE_RE.match(message))
|
||||||
if not gh_output:
|
|
||||||
raise click.ClickException("GITHUB_OUTPUT environment variable is not set")
|
|
||||||
with open(gh_output, "a") as f: # noqa: PTH123
|
def is_automated_commit(message: str) -> bool:
|
||||||
f.write(f"{key}={value}\n")
|
"""Check if a commit is an automated CI commit (release or badge)."""
|
||||||
|
return is_release_commit(message) or is_badge_commit(message)
|
||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
def main() -> None:
|
def main() -> None:
|
||||||
"""Detect if the latest commit is a release commit and set GITHUB_OUTPUT."""
|
"""Detect if the latest commit is an automated CI commit and set GITHUB_OUTPUT."""
|
||||||
msg = get_commit_message()
|
msg = get_commit_message()
|
||||||
click.echo(f"Commit message: {msg}")
|
click.echo(_("Commit message: {msg}", msg=msg))
|
||||||
is_release = is_release_commit(msg)
|
is_release = is_release_commit(msg)
|
||||||
|
is_automated = is_automated_commit(msg)
|
||||||
write_github_output("is-release", "true" if is_release else "false")
|
write_github_output("is-release", "true" if is_release else "false")
|
||||||
|
write_github_output("is-automated", "true" if is_automated else "false")
|
||||||
if is_release:
|
if is_release:
|
||||||
click.echo("Release commit — skipping all post-merge jobs.")
|
click.echo(_("Release commit — skipping all post-merge jobs."))
|
||||||
|
elif is_automated:
|
||||||
|
click.echo(_("Automated CI commit (badge) — skipping post-merge jobs."))
|
||||||
else:
|
else:
|
||||||
click.echo("Regular merge commit — running all post-merge jobs.")
|
click.echo(_("Regular merge commit — running all post-merge jobs."))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
|||||||
@@ -29,7 +29,8 @@ import os
|
|||||||
import click
|
import click
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
from devx.config import GITEA_API_URL
|
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
DEFAULT_MAX_RUNNERS = 3
|
DEFAULT_MAX_RUNNERS = 3
|
||||||
|
|
||||||
@@ -55,9 +56,9 @@ def query_runners(api_url: str, token: str, owner: str, repo: str) -> int:
|
|||||||
data = r.json()
|
data = r.json()
|
||||||
total += data.get("total_count", 0)
|
total += data.get("total_count", 0)
|
||||||
else:
|
else:
|
||||||
click.echo(f"Warning: repo-level runners query returned HTTP {r.status_code}", err=True)
|
click.echo(_("Warning: repo-level runners query returned HTTP {status}", status=r.status_code), err=True)
|
||||||
except (requests.RequestException, ValueError) as e:
|
except (requests.RequestException, ValueError) as e:
|
||||||
click.echo(f"Warning: repo-level runners query failed: {e}", err=True)
|
click.echo(_("Warning: repo-level runners query failed: {error}", error=e), err=True)
|
||||||
|
|
||||||
# 2. Organization-level runners
|
# 2. Organization-level runners
|
||||||
try:
|
try:
|
||||||
@@ -70,9 +71,9 @@ def query_runners(api_url: str, token: str, owner: str, repo: str) -> int:
|
|||||||
data = r.json()
|
data = r.json()
|
||||||
total += data.get("total_count", 0)
|
total += data.get("total_count", 0)
|
||||||
else:
|
else:
|
||||||
click.echo(f"Warning: org-level runners query returned HTTP {r.status_code}", err=True)
|
click.echo(_("Warning: org-level runners query returned HTTP {status}", status=r.status_code), err=True)
|
||||||
except (requests.RequestException, ValueError) as e:
|
except (requests.RequestException, ValueError) as e:
|
||||||
click.echo(f"Warning: org-level runners query failed: {e}", err=True)
|
click.echo(_("Warning: org-level runners query failed: {error}", error=e), err=True)
|
||||||
|
|
||||||
# 3. Instance-level runners (requires admin scope)
|
# 3. Instance-level runners (requires admin scope)
|
||||||
try:
|
try:
|
||||||
@@ -85,9 +86,12 @@ def query_runners(api_url: str, token: str, owner: str, repo: str) -> int:
|
|||||||
data = r.json()
|
data = r.json()
|
||||||
total += data.get("total_count", 0)
|
total += data.get("total_count", 0)
|
||||||
elif r.status_code != 403: # 403 is expected without admin scope
|
elif r.status_code != 403: # 403 is expected without admin scope
|
||||||
click.echo(f"Warning: instance-level runners query returned HTTP {r.status_code}", err=True)
|
click.echo(
|
||||||
|
_("Warning: instance-level runners query returned HTTP {status}", status=r.status_code),
|
||||||
|
err=True,
|
||||||
|
)
|
||||||
except (requests.RequestException, ValueError) as e:
|
except (requests.RequestException, ValueError) as e:
|
||||||
click.echo(f"Warning: instance-level runners query failed: {e}", err=True)
|
click.echo(_("Warning: instance-level runners query failed: {error}", error=e), err=True)
|
||||||
|
|
||||||
return total
|
return total
|
||||||
|
|
||||||
@@ -148,12 +152,12 @@ def main(
|
|||||||
output_indices: bool,
|
output_indices: bool,
|
||||||
github_output: bool,
|
github_output: bool,
|
||||||
) -> None:
|
) -> None:
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
|
|
||||||
if owner is None:
|
if owner is None:
|
||||||
owner = os.environ.get("DEVX_REPO_OWNER", "oblachno-oss")
|
owner = os.environ.get("DEVX_REPO_OWNER", "") or REPO_OWNER
|
||||||
if repo is None:
|
if repo is None:
|
||||||
repo = os.environ.get("DEVX_REPO_NAME", "devx")
|
repo = os.environ.get("DEVX_REPO_NAME", "") or REPO_NAME
|
||||||
|
|
||||||
count = get_runner_count(GITEA_API_URL, token, owner, repo)
|
count = get_runner_count(GITEA_API_URL, token, owner, repo)
|
||||||
indices = generate_indices(count)
|
indices = generate_indices(count)
|
||||||
@@ -162,11 +166,11 @@ def main(
|
|||||||
gh_output = os.environ.get("GITHUB_OUTPUT")
|
gh_output = os.environ.get("GITHUB_OUTPUT")
|
||||||
if not gh_output:
|
if not gh_output:
|
||||||
raise click.ClickException("GITHUB_OUTPUT environment variable is not set")
|
raise click.ClickException("GITHUB_OUTPUT environment variable is not set")
|
||||||
with open(gh_output, "a") as f: # noqa: PTH123
|
with open(gh_output, "a", encoding="utf-8") as f: # noqa: PTH123
|
||||||
f.write(f"runner-count={count}\n")
|
f.write(f"runner-count={count}\n")
|
||||||
f.write(f"runner-indices={json.dumps(indices)}\n")
|
f.write(f"runner-indices={json.dumps(indices)}\n")
|
||||||
click.echo(f"Runner count: {count}")
|
click.echo(_("Runner count: {count}", count=count))
|
||||||
click.echo(f"Runner indices: {indices}")
|
click.echo(_("Runner indices: {indices}", indices=indices))
|
||||||
return
|
return
|
||||||
|
|
||||||
if output_count:
|
if output_count:
|
||||||
@@ -178,8 +182,8 @@ def main(
|
|||||||
return
|
return
|
||||||
|
|
||||||
# Default: output both as key=value pairs for CI consumption
|
# Default: output both as key=value pairs for CI consumption
|
||||||
click.echo(f"count={count}")
|
click.echo(_("count={count}", count=count))
|
||||||
click.echo(f"indices={json.dumps(indices)}")
|
click.echo(_("indices={indices}", indices=json.dumps(indices)))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ import os
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
|
from devx.ci._shared import lpt_distribute, write_github_env
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
DEFAULT_MAX_RUNNERS = 3
|
DEFAULT_MAX_RUNNERS = 3
|
||||||
@@ -54,15 +55,7 @@ def distribute(files: list[str], max_runners: int) -> list[list[str]]:
|
|||||||
the runner with the least total weight.
|
the runner with the least total weight.
|
||||||
"""
|
"""
|
||||||
weights = [_file_weight(f) for f in files]
|
weights = [_file_weight(f) for f in files]
|
||||||
groups: list[list[str]] = [[] for _ in range(max_runners)]
|
return lpt_distribute(files, weights, max_runners)
|
||||||
loads = [0] * max_runners
|
|
||||||
# Sort by weight descending, preserving original order for ties
|
|
||||||
indexed = sorted(enumerate(files), key=lambda x: (-weights[x[0]], x[0]))
|
|
||||||
for orig_idx, f in indexed:
|
|
||||||
min_runner = min(range(max_runners), key=lambda r: loads[r])
|
|
||||||
groups[min_runner].append(f)
|
|
||||||
loads[min_runner] += weights[orig_idx]
|
|
||||||
return groups
|
|
||||||
|
|
||||||
|
|
||||||
def files_for_runner(files: list[str], runner_index: int, max_runners: int) -> list[str]:
|
def files_for_runner(files: list[str], runner_index: int, max_runners: int) -> list[str]:
|
||||||
@@ -75,19 +68,6 @@ def files_for_runner(files: list[str], runner_index: int, max_runners: int) -> l
|
|||||||
return groups[runner_index]
|
return groups[runner_index]
|
||||||
|
|
||||||
|
|
||||||
def _write_github_env(key: str, value: str) -> None:
|
|
||||||
gh_env = os.environ.get("GITHUB_ENV")
|
|
||||||
if not gh_env:
|
|
||||||
raise click.ClickException("GITHUB_ENV environment variable is not set")
|
|
||||||
with open(gh_env, "a") as f: # noqa: PTH123
|
|
||||||
if "\n" in value:
|
|
||||||
# Multi-line values require the heredoc syntax in $GITHUB_ENV.
|
|
||||||
delimiter = "EOF"
|
|
||||||
f.write(f"{key}<<{delimiter}\n{value}\n{delimiter}\n")
|
|
||||||
else:
|
|
||||||
f.write(f"{key}={value}\n")
|
|
||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
@click.option("--pattern", required=True, help="Glob pattern for files to distribute.")
|
@click.option("--pattern", required=True, help="Glob pattern for files to distribute.")
|
||||||
@click.option(
|
@click.option(
|
||||||
@@ -122,26 +102,34 @@ def main(pattern: str, runner_index: int | None, max_runners: int, github_env: b
|
|||||||
groups = distribute(files, max_runners)
|
groups = distribute(files, max_runners)
|
||||||
for i, group in enumerate(groups):
|
for i, group in enumerate(groups):
|
||||||
labels = " ".join(group) if group else "(none)"
|
labels = " ".join(group) if group else "(none)"
|
||||||
click.echo(f"Runner {i}: {labels}")
|
click.echo(_("Runner {i}: {labels}", i=i, labels=labels))
|
||||||
return
|
return
|
||||||
|
|
||||||
if skip_if_excess and github_env and runner_index > max_runners:
|
if skip_if_excess and github_env and runner_index > max_runners:
|
||||||
click.echo(f"Skipping — runner index {runner_index} > max runners {max_runners}")
|
click.echo(
|
||||||
_write_github_env("ASSIGNED_FILES", "")
|
_(
|
||||||
_write_github_env("SKIP", "true")
|
"Skipping — runner index {runner_index} > max runners {max_runners}",
|
||||||
|
runner_index=runner_index,
|
||||||
|
max_runners=max_runners,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
write_github_env("ASSIGNED_FILES", "")
|
||||||
|
write_github_env("SKIP", "true")
|
||||||
return
|
return
|
||||||
|
|
||||||
if runner_index < 1:
|
if runner_index < 1:
|
||||||
raise click.ClickException(f"Runner index {runner_index} is out of range (must be >= 1)")
|
raise click.ClickException(
|
||||||
|
_("Runner index {runner_index} is out of range (must be >= 1)", runner_index=runner_index)
|
||||||
|
)
|
||||||
|
|
||||||
zero_based = runner_index - 1
|
zero_based = runner_index - 1
|
||||||
assigned = files_for_runner(files, zero_based, max_runners)
|
assigned = files_for_runner(files, zero_based, max_runners)
|
||||||
encoded = "\n".join(assigned)
|
encoded = "\n".join(assigned)
|
||||||
|
|
||||||
if github_env:
|
if github_env:
|
||||||
_write_github_env("ASSIGNED_FILES", encoded)
|
write_github_env("ASSIGNED_FILES", encoded)
|
||||||
_write_github_env("SKIP", "false")
|
write_github_env("SKIP", "false")
|
||||||
click.echo(f"Assigned {len(assigned)} files to runner {runner_index}")
|
click.echo(_("Assigned {count} files to runner {runner_index}", count=len(assigned), runner_index=runner_index))
|
||||||
return
|
return
|
||||||
|
|
||||||
click.echo(encoded)
|
click.echo(encoded)
|
||||||
|
|||||||
@@ -0,0 +1,206 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Distribute a list of items across N parallel runners using LPT scheduling.
|
||||||
|
|
||||||
|
Generic item distribution for CI matrix jobs. Items are read from a JSON
|
||||||
|
array on stdin (or from a file via --items-file), sorted for deterministic
|
||||||
|
ordering, then assigned to *max_runners* groups using LPT (Longest
|
||||||
|
Processing Time first) scheduling.
|
||||||
|
|
||||||
|
Each item is a string (e.g. an Ansible ``--limit`` pattern like
|
||||||
|
``observability`` or ``infra-314-vm``). Optionally, items can be objects
|
||||||
|
with ``{"id": "...", "weight": N}`` to provide explicit weights.
|
||||||
|
|
||||||
|
The assigned group for *runner_index* is written to ``$GITHUB_ENV`` as
|
||||||
|
``ASSIGNED_ITEMS`` (space-delimited) for use by subsequent steps.
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
echo '["observability", "infra-314-vm"]' | \\
|
||||||
|
python3 -m devx.ci.distribute_items \\
|
||||||
|
--runner-index 1 --max-runners 3 \\
|
||||||
|
--github-env --skip-if-excess
|
||||||
|
|
||||||
|
# With weights:
|
||||||
|
echo '[{"id": "observability", "weight": 5}, {"id": "customer-1", "weight": 3}]' | \\
|
||||||
|
python3 -m devx.ci.distribute_items \\
|
||||||
|
--runner-index 1 --max-runners 3 --github-env
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import sys
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
|
from devx.ci._shared import lpt_distribute, write_github_env
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
|
DEFAULT_MAX_RUNNERS = 3
|
||||||
|
DEFAULT_WEIGHT = 1
|
||||||
|
|
||||||
|
|
||||||
|
def parse_items(raw: str) -> list[str]:
|
||||||
|
"""Parse a JSON array into a list of item identifier strings.
|
||||||
|
|
||||||
|
Accepts both plain string arrays (``["a", "b"]``) and object arrays
|
||||||
|
(``[{"id": "a", "weight": 2}]``). Returns just the identifier strings.
|
||||||
|
"""
|
||||||
|
data = json.loads(raw)
|
||||||
|
if not isinstance(data, list):
|
||||||
|
raise click.ClickException(_("Items input must be a JSON array, got {type}", type=type(data).__name__))
|
||||||
|
items: list[str] = []
|
||||||
|
for entry in data:
|
||||||
|
if isinstance(entry, str):
|
||||||
|
items.append(entry)
|
||||||
|
elif isinstance(entry, dict) and "id" in entry:
|
||||||
|
items.append(str(entry["id"]))
|
||||||
|
else:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("Each item must be a string or an object with 'id', got {type}", type=type(entry).__name__)
|
||||||
|
)
|
||||||
|
return items
|
||||||
|
|
||||||
|
|
||||||
|
def parse_weighted_items(raw: str) -> tuple[list[str], list[int]]:
|
||||||
|
"""Parse a JSON array into (items, weights) lists.
|
||||||
|
|
||||||
|
For plain string arrays, all items get ``DEFAULT_WEIGHT``.
|
||||||
|
For object arrays, the ``weight`` field is used (default: ``DEFAULT_WEIGHT``).
|
||||||
|
"""
|
||||||
|
data = json.loads(raw)
|
||||||
|
if not isinstance(data, list):
|
||||||
|
raise click.ClickException(_("Items input must be a JSON array, got {type}", type=type(data).__name__))
|
||||||
|
items: list[str] = []
|
||||||
|
weights: list[int] = []
|
||||||
|
for entry in data:
|
||||||
|
if isinstance(entry, str):
|
||||||
|
items.append(entry)
|
||||||
|
weights.append(DEFAULT_WEIGHT)
|
||||||
|
elif isinstance(entry, dict) and "id" in entry:
|
||||||
|
items.append(str(entry["id"]))
|
||||||
|
weights.append(int(entry.get("weight", DEFAULT_WEIGHT)))
|
||||||
|
else:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("Each item must be a string or an object with 'id', got {type}", type=type(entry).__name__)
|
||||||
|
)
|
||||||
|
return items, weights
|
||||||
|
|
||||||
|
|
||||||
|
def distribute(items: list[str], weights: list[int], max_runners: int) -> list[list[str]]:
|
||||||
|
"""Split *items* into *max_runners* balanced groups using LPT scheduling.
|
||||||
|
|
||||||
|
Items are sorted by weight (descending), then assigned to the runner
|
||||||
|
with the least total weight.
|
||||||
|
"""
|
||||||
|
return lpt_distribute(items, weights, max_runners)
|
||||||
|
|
||||||
|
|
||||||
|
def items_for_runner(items: list[str], weights: list[int], runner_index: int, max_runners: int) -> list[str]:
|
||||||
|
"""Return the subset of items assigned to *runner_index* (0-based)."""
|
||||||
|
groups = distribute(items, weights, max_runners)
|
||||||
|
if runner_index < 0 or runner_index >= len(groups):
|
||||||
|
raise click.ClickException(
|
||||||
|
_("Runner index {index} out of range (0..{max})", index=runner_index, max=max_runners - 1)
|
||||||
|
)
|
||||||
|
return groups[runner_index]
|
||||||
|
|
||||||
|
|
||||||
|
@click.command()
|
||||||
|
@click.option(
|
||||||
|
"--items-file",
|
||||||
|
type=click.Path(exists=True, file_okay=True, path_type=None),
|
||||||
|
default=None,
|
||||||
|
help="Read items from a JSON file instead of stdin.",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--runner-index",
|
||||||
|
type=int,
|
||||||
|
default=None,
|
||||||
|
help="One-based runner index. If omitted, prints all groups.",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--max-runners",
|
||||||
|
type=int,
|
||||||
|
default=DEFAULT_MAX_RUNNERS,
|
||||||
|
show_default=True,
|
||||||
|
help="Total number of parallel runners.",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--github-env",
|
||||||
|
is_flag=True,
|
||||||
|
default=False,
|
||||||
|
help="Write ASSIGNED_ITEMS and SKIP to $GITHUB_ENV.",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--skip-if-excess",
|
||||||
|
is_flag=True,
|
||||||
|
default=False,
|
||||||
|
help="With --github-env: write SKIP=true when runner-index exceeds max-runners.",
|
||||||
|
)
|
||||||
|
def main(
|
||||||
|
items_file: str | None,
|
||||||
|
runner_index: int | None,
|
||||||
|
max_runners: int,
|
||||||
|
github_env: bool,
|
||||||
|
skip_if_excess: bool,
|
||||||
|
) -> None:
|
||||||
|
# Read items from file or stdin
|
||||||
|
if items_file is not None:
|
||||||
|
with open(items_file, encoding="utf-8") as f: # noqa: PTH123
|
||||||
|
raw = f.read()
|
||||||
|
else:
|
||||||
|
raw = sys.stdin.read()
|
||||||
|
|
||||||
|
raw = raw.strip()
|
||||||
|
if not raw:
|
||||||
|
raw = "[]"
|
||||||
|
|
||||||
|
items, weights = parse_weighted_items(raw)
|
||||||
|
|
||||||
|
if runner_index is None:
|
||||||
|
groups = distribute(items, weights, max_runners)
|
||||||
|
for i, group in enumerate(groups):
|
||||||
|
labels = " ".join(group) if group else "(none)"
|
||||||
|
click.echo(_("Runner {i}: {labels}", i=i, labels=labels))
|
||||||
|
return
|
||||||
|
|
||||||
|
if skip_if_excess and github_env and runner_index > max_runners:
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Skipping — runner index {runner_index} > max runners {max_runners}",
|
||||||
|
runner_index=runner_index,
|
||||||
|
max_runners=max_runners,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
write_github_env("ASSIGNED_ITEMS", "")
|
||||||
|
write_github_env("SKIP", "true")
|
||||||
|
return
|
||||||
|
|
||||||
|
if runner_index < 1:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("Runner index {runner_index} is out of range (must be >= 1)", runner_index=runner_index)
|
||||||
|
)
|
||||||
|
|
||||||
|
zero_based = runner_index - 1
|
||||||
|
assigned = items_for_runner(items, weights, zero_based, max_runners)
|
||||||
|
encoded = " ".join(assigned)
|
||||||
|
|
||||||
|
if github_env:
|
||||||
|
write_github_env("ASSIGNED_ITEMS", encoded)
|
||||||
|
write_github_env("SKIP", "false")
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Assigned {count} items to runner {runner_index}: {encoded}",
|
||||||
|
count=len(assigned),
|
||||||
|
runner_index=runner_index,
|
||||||
|
encoded=encoded,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
click.echo(encoded)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
main()
|
||||||
+55
-17
@@ -5,8 +5,12 @@ Parses Click commands from the CLI source code and checks if each command
|
|||||||
has corresponding documentation in the wiki/docs. Reports missing
|
has corresponding documentation in the wiki/docs. Reports missing
|
||||||
documentation as warnings and exits with non-zero if coverage is below 100%.
|
documentation as warnings and exits with non-zero if coverage is below 100%.
|
||||||
|
|
||||||
|
By default, checks the current repository's own source and docs directories.
|
||||||
|
When run from the devx package itself (development mode), it checks devx's
|
||||||
|
own files. When installed as a package, it checks the consuming repo's files.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
python3 -m devx.ci.doc_coverage [--docs-dir docs/] [--fail-on-missing]
|
python3 -m devx.ci.doc_coverage [--docs-dir docs/] [--source-dir src/] [--fail-on-missing]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -19,11 +23,12 @@ import click
|
|||||||
|
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
REPO_ROOT = Path(__file__).resolve().parent.parent.parent.parent
|
# Default to the current working directory (consuming repo's root)
|
||||||
|
REPO_ROOT = Path.cwd()
|
||||||
DOCS_DIR = REPO_ROOT / "docs"
|
DOCS_DIR = REPO_ROOT / "docs"
|
||||||
CLI_FILE = REPO_ROOT / "src" / "devx" / "cli.py"
|
|
||||||
|
|
||||||
# Major modules that should be documented in tech/architecture.md
|
# Major modules that should be documented in tech/architecture.md
|
||||||
|
# These are devx-specific; when checking other repos, use --source-dir
|
||||||
REQUIRED_MODULES = [
|
REQUIRED_MODULES = [
|
||||||
"cli.py",
|
"cli.py",
|
||||||
"i18n.py",
|
"i18n.py",
|
||||||
@@ -51,11 +56,16 @@ REQUIRED_SCRIPTS = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
def extract_cli_commands() -> list[str]:
|
def extract_cli_commands(source_dir: Path) -> list[str]:
|
||||||
"""Extract command names from the CLI source file."""
|
"""Extract command names from the CLI source file."""
|
||||||
if not CLI_FILE.exists():
|
# Try to find the CLI file in the source directory
|
||||||
|
cli_file = None
|
||||||
|
for candidate in source_dir.rglob("cli.py"):
|
||||||
|
cli_file = candidate
|
||||||
|
break
|
||||||
|
if cli_file is None or not cli_file.exists():
|
||||||
return []
|
return []
|
||||||
content = CLI_FILE.read_text()
|
content = cli_file.read_text()
|
||||||
commands: list[str] = []
|
commands: list[str] = []
|
||||||
# Find all @<group>.command("name") occurrences in the CLI source
|
# Find all @<group>.command("name") occurrences in the CLI source
|
||||||
# Matches @cli.command, @ci.command, @tools.command, @molecule.command
|
# Matches @cli.command, @ci.command, @tools.command, @molecule.command
|
||||||
@@ -94,15 +104,30 @@ def check_module_documented(module: str, docs_content: str) -> bool:
|
|||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
@click.option("--docs-dir", default=str(DOCS_DIR), help="Path to the docs directory.")
|
@click.option("--docs-dir", default=None, help="Path to the docs directory (default: ./docs).")
|
||||||
|
@click.option("--source-dir", default=None, help="Path to the source directory (default: auto-detect from src/).")
|
||||||
@click.option(
|
@click.option(
|
||||||
"--fail-on-missing",
|
"--fail-on-missing",
|
||||||
is_flag=True,
|
is_flag=True,
|
||||||
default=False,
|
default=False,
|
||||||
help="Exit with non-zero status if any documentation is missing.",
|
help="Exit with non-zero status if any documentation is missing.",
|
||||||
)
|
)
|
||||||
def main(docs_dir: str, fail_on_missing: bool) -> None:
|
def main(docs_dir: str | None, source_dir: str | None, fail_on_missing: bool) -> None:
|
||||||
docs_path = Path(docs_dir)
|
root = Path.cwd()
|
||||||
|
docs_path = Path(docs_dir) if docs_dir else root / "docs"
|
||||||
|
|
||||||
|
# Auto-detect source directory
|
||||||
|
if source_dir:
|
||||||
|
src_path = Path(source_dir)
|
||||||
|
else:
|
||||||
|
# Try common source directories
|
||||||
|
for candidate in [root / "src", root / "scripts"]:
|
||||||
|
if candidate.exists():
|
||||||
|
src_path = candidate
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
src_path = root / "src"
|
||||||
|
|
||||||
cli_commands_file = docs_path / "user" / "cli-commands.md"
|
cli_commands_file = docs_path / "user" / "cli-commands.md"
|
||||||
architecture_file = docs_path / "tech" / "architecture.md"
|
architecture_file = docs_path / "tech" / "architecture.md"
|
||||||
ci_cd_file = docs_path / "tech" / "ci-cd-workflow.md"
|
ci_cd_file = docs_path / "tech" / "ci-cd-workflow.md"
|
||||||
@@ -112,21 +137,28 @@ def main(docs_dir: str, fail_on_missing: bool) -> None:
|
|||||||
|
|
||||||
# Check CLI commands
|
# Check CLI commands
|
||||||
click.echo(_("Checking CLI command documentation..."))
|
click.echo(_("Checking CLI command documentation..."))
|
||||||
commands = extract_cli_commands()
|
commands = extract_cli_commands(src_path)
|
||||||
total += len(commands)
|
total += len(commands)
|
||||||
cli_docs = cli_commands_file.read_text() if cli_commands_file.exists() else ""
|
cli_docs = cli_commands_file.read_text() if cli_commands_file.exists() else ""
|
||||||
for cmd in commands:
|
for cmd in commands:
|
||||||
if check_command_documented(cmd, cli_docs):
|
if check_command_documented(cmd, cli_docs):
|
||||||
click.echo(_(" OK: devx {cmd}", cmd=cmd))
|
click.echo(_(" OK: {cmd}", cmd=cmd))
|
||||||
else:
|
else:
|
||||||
click.echo(_(" MISSING: devx {cmd}", cmd=cmd))
|
click.echo(_(" MISSING: {cmd}", cmd=cmd))
|
||||||
missing.append(f"CLI command: devx {cmd}")
|
missing.append(f"CLI command: {cmd}")
|
||||||
|
|
||||||
# Check modules in architecture.md
|
# Check modules in architecture.md
|
||||||
|
# Auto-detect modules from source directory (top-level only, exclude subdirs)
|
||||||
click.echo(_("\nChecking module documentation in architecture.md..."))
|
click.echo(_("\nChecking module documentation in architecture.md..."))
|
||||||
total += len(REQUIRED_MODULES)
|
if src_path.exists():
|
||||||
|
detected_modules = sorted(
|
||||||
|
f.name for f in src_path.glob("*.py") if f.name != "__init__.py" and f.name != "cli.py"
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
detected_modules = REQUIRED_MODULES
|
||||||
|
total += len(detected_modules)
|
||||||
arch_docs = architecture_file.read_text() if architecture_file.exists() else ""
|
arch_docs = architecture_file.read_text() if architecture_file.exists() else ""
|
||||||
for module in REQUIRED_MODULES:
|
for module in detected_modules:
|
||||||
if check_module_documented(module, arch_docs):
|
if check_module_documented(module, arch_docs):
|
||||||
click.echo(_(" OK: {module}", module=module))
|
click.echo(_(" OK: {module}", module=module))
|
||||||
else:
|
else:
|
||||||
@@ -134,10 +166,16 @@ def main(docs_dir: str, fail_on_missing: bool) -> None:
|
|||||||
missing.append(f"Module: {module}")
|
missing.append(f"Module: {module}")
|
||||||
|
|
||||||
# Check CI scripts in ci-cd-workflow.md
|
# Check CI scripts in ci-cd-workflow.md
|
||||||
|
# Auto-detect CI scripts from ci/ subdirectory
|
||||||
click.echo(_("\nChecking CI script documentation in ci-cd-workflow.md..."))
|
click.echo(_("\nChecking CI script documentation in ci-cd-workflow.md..."))
|
||||||
total += len(REQUIRED_SCRIPTS)
|
ci_dir = src_path / "ci" if src_path.name != "ci" else src_path
|
||||||
|
if ci_dir.exists():
|
||||||
|
detected_scripts = sorted(f.name for f in ci_dir.glob("*.py") if f.name != "__init__.py")
|
||||||
|
else:
|
||||||
|
detected_scripts = REQUIRED_SCRIPTS
|
||||||
|
total += len(detected_scripts)
|
||||||
ci_docs = ci_cd_file.read_text() if ci_cd_file.exists() else ""
|
ci_docs = ci_cd_file.read_text() if ci_cd_file.exists() else ""
|
||||||
for script in REQUIRED_SCRIPTS:
|
for script in detected_scripts:
|
||||||
if check_module_documented(script, ci_docs):
|
if check_module_documented(script, ci_docs):
|
||||||
click.echo(_(" OK: {script}", script=script))
|
click.echo(_(" OK: {script}", script=script))
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ Usage::
|
|||||||
|
|
||||||
Environment variables:
|
Environment variables:
|
||||||
GITEA_URL Base URL of the Gitea instance.
|
GITEA_URL Base URL of the Gitea instance.
|
||||||
REPO_TOKEN API token with repo access.
|
CI_GITEA_TOKEN API token with repo access.
|
||||||
RUN_ID Workflow run ID (GITHUB_RUN_ID).
|
RUN_ID Workflow run ID (GITHUB_RUN_ID).
|
||||||
JOB_NAME Base job name (GITHUB_JOB), e.g. "integration-tests".
|
JOB_NAME Base job name (GITHUB_JOB), e.g. "integration-tests".
|
||||||
MATRIX_INDEX Current matrix index (runner-index).
|
MATRIX_INDEX Current matrix index (runner-index).
|
||||||
@@ -36,6 +36,7 @@ import time
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
|
from devx.config import REPO_NAME, REPO_OWNER
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
from devx.molecule.molecule_ci_guard import (
|
from devx.molecule.molecule_ci_guard import (
|
||||||
poll_for_other_failures,
|
poll_for_other_failures,
|
||||||
@@ -49,17 +50,17 @@ POLL_INTERVAL = 10
|
|||||||
def cli(pytest_args: tuple[str, ...]) -> None:
|
def cli(pytest_args: tuple[str, ...]) -> None:
|
||||||
"""Run pytest with cross-runner failure detection."""
|
"""Run pytest with cross-runner failure detection."""
|
||||||
gitea_url = os.environ.get("GITEA_URL", "")
|
gitea_url = os.environ.get("GITEA_URL", "")
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
run_id = int(os.environ.get("RUN_ID", "0"))
|
run_id = int(os.environ.get("RUN_ID", "0"))
|
||||||
job_name = os.environ.get("JOB_NAME", "integration-tests")
|
job_name = os.environ.get("JOB_NAME", "integration-tests")
|
||||||
current_index = int(os.environ.get("MATRIX_INDEX", "0"))
|
current_index = int(os.environ.get("MATRIX_INDEX", "0"))
|
||||||
repository = os.environ.get("GITEA_REPOSITORY", "oblachno-oss/devx")
|
repository = os.environ.get("GITEA_REPOSITORY", "")
|
||||||
owner, _sep, repo = repository.partition("/")
|
owner, _sep, repo = repository.partition("/")
|
||||||
if not owner or not repo:
|
if not owner or not repo:
|
||||||
owner, repo = "oblachno-oss", "devx"
|
owner, repo = REPO_OWNER, REPO_NAME
|
||||||
|
|
||||||
if not all([gitea_url, token, run_id]):
|
if not all([gitea_url, token, run_id]):
|
||||||
click.echo(_("GITEA_URL/REPO_TOKEN/RUN_ID not set; running without cross-runner cancellation."))
|
click.echo(_("GITEA_URL/CI_GITEA_TOKEN/RUN_ID not set; running without cross-runner cancellation."))
|
||||||
|
|
||||||
stop_event = threading.Event()
|
stop_event = threading.Event()
|
||||||
failed_event = threading.Event()
|
failed_event = threading.Event()
|
||||||
@@ -85,7 +86,7 @@ def cli(pytest_args: tuple[str, ...]) -> None:
|
|||||||
cmd = [sys.executable, "-m", "pytest"]
|
cmd = [sys.executable, "-m", "pytest"]
|
||||||
cmd.extend(pytest_args)
|
cmd.extend(pytest_args)
|
||||||
|
|
||||||
click.echo(f"Running: {' '.join(cmd)}")
|
click.echo(_("Running: {cmd}", cmd=" ".join(cmd)))
|
||||||
|
|
||||||
process = subprocess.Popen( # nosec B603
|
process = subprocess.Popen( # nosec B603
|
||||||
cmd,
|
cmd,
|
||||||
|
|||||||
@@ -0,0 +1,415 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Lint documentation files for structure, links, and quality.
|
||||||
|
|
||||||
|
Checks performed (all configurable via pyproject.toml ``[tool.devx.docs]``):
|
||||||
|
- **Required files**: README.md, AGENTS.md, CHANGELOG.md must exist.
|
||||||
|
- **Docs structure**: ``docs/index.md`` and ``docs/mapping.json`` must exist.
|
||||||
|
- **Broken internal links**: relative paths and anchors in markdown files
|
||||||
|
must resolve to actual files and headings.
|
||||||
|
- **Heading hierarchy**: no skipping heading levels (e.g., ``#`` → ``###``).
|
||||||
|
- **TODO/FIXME**: flags leftover TODO/FIXME markers in documentation.
|
||||||
|
- **Stale docs**: files not modified in >180 days (warning only).
|
||||||
|
- **Trailing whitespace**: lines should not end with whitespace.
|
||||||
|
- **Blank line before headings**: headings should have a blank line before them.
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
python3 -m devx.ci.lint_docs
|
||||||
|
python3 -m devx.ci.lint_docs --docs-dir docs/ --root .
|
||||||
|
python3 -m devx.ci.lint_docs --fix # auto-fix trailing whitespace
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from datetime import datetime, timedelta
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
|
# Heading slug pattern (GitHub-style)
|
||||||
|
_HEADING_RE = re.compile(r"^(#{1,6})\s+(.+?)\s*$", re.MULTILINE)
|
||||||
|
# Markdown link pattern: [text](url)
|
||||||
|
_LINK_RE = re.compile(r"\[([^\]]*)\]\(([^)]+)\)")
|
||||||
|
# Trailing whitespace
|
||||||
|
_TRAILING_WS_RE = re.compile(r"[ \t]+$")
|
||||||
|
# Heading without blank line before
|
||||||
|
_HEADING_NO_BLANK_RE = re.compile(r"([^\n])\n(#{1,6}\s)")
|
||||||
|
|
||||||
|
# Files that must exist in every project
|
||||||
|
REQUIRED_FILES = ["README.md", "AGENTS.md", "CHANGELOG.md"]
|
||||||
|
|
||||||
|
# Files that must exist in docs/
|
||||||
|
REQUIRED_DOC_FILES = ["index.md"]
|
||||||
|
|
||||||
|
# Maximum age for docs before they're considered stale (days)
|
||||||
|
STALE_THRESHOLD_DAYS = 180
|
||||||
|
|
||||||
|
# Files excluded from duplicate heading checks (auto-generated or structured
|
||||||
|
# with repeated subsections under different parent sections)
|
||||||
|
DUPLICATE_HEADING_EXCLUDES = {
|
||||||
|
"CHANGELOG.md",
|
||||||
|
"incident-response-sso.md",
|
||||||
|
"role-sync-design.md",
|
||||||
|
}
|
||||||
|
|
||||||
|
# TODO/FIXME pattern — matches "TODO:" or "FIXME:" at start of line/after whitespace
|
||||||
|
# Does NOT match references to the word "TODO" in rules/documentation
|
||||||
|
_TODO_RE = re.compile(r"(?m)^\s*(?:>>>?\s*)?(TODO|FIXME|HACK|XXX)\s*:", re.IGNORECASE)
|
||||||
|
|
||||||
|
# Directories excluded from markdown file scanning
|
||||||
|
_EXCLUDE_DIRS = {
|
||||||
|
".venv",
|
||||||
|
".git",
|
||||||
|
"node_modules",
|
||||||
|
"__pycache__",
|
||||||
|
".pytest_cache",
|
||||||
|
".devin",
|
||||||
|
".terraform",
|
||||||
|
"site-packages",
|
||||||
|
"dist-info",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def slugify(text: str) -> str:
|
||||||
|
"""Convert heading text to a GitHub-style slug."""
|
||||||
|
slug = text.lower().strip()
|
||||||
|
slug = re.sub(r"[^\w\s-]", "", slug)
|
||||||
|
slug = re.sub(r"[\s]+", "-", slug)
|
||||||
|
return slug
|
||||||
|
|
||||||
|
|
||||||
|
def strip_code_blocks(content: str) -> str:
|
||||||
|
"""Remove fenced code blocks from markdown content.
|
||||||
|
|
||||||
|
Replaces ```...``` blocks with empty lines so heading detection
|
||||||
|
doesn't pick up # comments inside code blocks.
|
||||||
|
"""
|
||||||
|
result: list[str] = []
|
||||||
|
in_code_block = False
|
||||||
|
for line in content.splitlines():
|
||||||
|
if line.strip().startswith("```"):
|
||||||
|
in_code_block = not in_code_block
|
||||||
|
result.append("")
|
||||||
|
continue
|
||||||
|
if in_code_block:
|
||||||
|
result.append("")
|
||||||
|
continue
|
||||||
|
result.append(line)
|
||||||
|
return "\n".join(result)
|
||||||
|
|
||||||
|
|
||||||
|
def extract_headings(filepath: Path) -> dict[str, int]:
|
||||||
|
"""Extract all headings from a markdown file.
|
||||||
|
|
||||||
|
Returns a dict mapping slug → heading level.
|
||||||
|
"""
|
||||||
|
content = strip_code_blocks(filepath.read_text(encoding="utf-8"))
|
||||||
|
headings: dict[str, int] = {}
|
||||||
|
for match in _HEADING_RE.finditer(content):
|
||||||
|
level = len(match.group(1))
|
||||||
|
text = match.group(2)
|
||||||
|
slug = slugify(text)
|
||||||
|
headings[slug] = level
|
||||||
|
return headings
|
||||||
|
|
||||||
|
|
||||||
|
def extract_links(filepath: Path) -> list[tuple[int, str, str]]:
|
||||||
|
"""Extract all markdown links from a file.
|
||||||
|
|
||||||
|
Returns a list of (line_number, link_text, url) tuples.
|
||||||
|
Includes anchor-only links (#section) for validation.
|
||||||
|
Skips external links (http/https) and mailto.
|
||||||
|
"""
|
||||||
|
content = filepath.read_text(encoding="utf-8")
|
||||||
|
links: list[tuple[int, str, str]] = []
|
||||||
|
for match in _LINK_RE.finditer(content):
|
||||||
|
url = match.group(2).strip()
|
||||||
|
# Skip external links and mailto
|
||||||
|
if url.startswith(("http://", "https://", "mailto:")):
|
||||||
|
continue
|
||||||
|
line_num = content[: match.start()].count("\n") + 1
|
||||||
|
links.append((line_num, match.group(1), url))
|
||||||
|
return links
|
||||||
|
|
||||||
|
|
||||||
|
def check_required_files(root: Path) -> list[str]:
|
||||||
|
"""Check that required files exist."""
|
||||||
|
issues: list[str] = []
|
||||||
|
for filename in REQUIRED_FILES:
|
||||||
|
if not (root / filename).exists():
|
||||||
|
issues.append(f"Missing required file: {filename}")
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_docs_structure(root: Path, docs_dir: Path) -> list[str]:
|
||||||
|
"""Check that docs directory has required structure."""
|
||||||
|
issues: list[str] = []
|
||||||
|
if not docs_dir.exists():
|
||||||
|
issues.append(f"Docs directory not found: {docs_dir}")
|
||||||
|
return issues
|
||||||
|
for filename in REQUIRED_DOC_FILES:
|
||||||
|
if not (docs_dir / filename).exists():
|
||||||
|
issues.append(f"Missing required doc file: docs/{filename}")
|
||||||
|
mapping_file = docs_dir / "mapping.json"
|
||||||
|
if mapping_file.exists():
|
||||||
|
try:
|
||||||
|
mapping = json.loads(mapping_file.read_text(encoding="utf-8"))
|
||||||
|
if not isinstance(mapping, dict):
|
||||||
|
issues.append("docs/mapping.json must be a JSON object")
|
||||||
|
elif not mapping:
|
||||||
|
issues.append("docs/mapping.json is empty")
|
||||||
|
except json.JSONDecodeError as e:
|
||||||
|
issues.append(f"docs/mapping.json is invalid JSON: {e}")
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_internal_links(root: Path, docs_dir: Path) -> list[str]:
|
||||||
|
"""Check that all internal links in markdown files resolve."""
|
||||||
|
issues: list[str] = []
|
||||||
|
md_files = list(root.rglob("*.md"))
|
||||||
|
# Exclude .venv, .git, node_modules
|
||||||
|
md_files = [f for f in md_files if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
# Load wiki page names from mapping.json — these are valid link targets
|
||||||
|
wiki_pages: set[str] = set()
|
||||||
|
mapping_file = docs_dir / "mapping.json"
|
||||||
|
if mapping_file.exists():
|
||||||
|
try:
|
||||||
|
mapping = json.loads(mapping_file.read_text(encoding="utf-8"))
|
||||||
|
wiki_pages = set(mapping.values())
|
||||||
|
except (json.JSONDecodeError, AttributeError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
links = extract_links(md_file)
|
||||||
|
headings = extract_headings(md_file)
|
||||||
|
|
||||||
|
for line_num, _link_text, url in links:
|
||||||
|
# Split into path and anchor
|
||||||
|
if "#" in url:
|
||||||
|
path_part, anchor = url.split("#", 1)
|
||||||
|
else:
|
||||||
|
path_part, anchor = url, ""
|
||||||
|
|
||||||
|
# Skip wiki page references (no file extension, no /, matches mapping.json values)
|
||||||
|
if path_part and "." not in path_part and "/" not in path_part:
|
||||||
|
if path_part in wiki_pages:
|
||||||
|
continue
|
||||||
|
# Also skip if it looks like a wiki page name (CamelCase or hyphenated)
|
||||||
|
# without a file extension — can't verify these locally
|
||||||
|
if not any(c in path_part for c in "/\\"):
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Resolve relative path
|
||||||
|
if path_part:
|
||||||
|
target = (md_file.parent / path_part).resolve()
|
||||||
|
if not target.exists():
|
||||||
|
issues.append(f"{rel_path}:{line_num}: broken link '{url}' — file not found: {path_part}")
|
||||||
|
continue
|
||||||
|
# Check anchor in target file
|
||||||
|
if anchor:
|
||||||
|
target_headings = extract_headings(target)
|
||||||
|
target_slug = slugify(anchor)
|
||||||
|
if target_slug not in target_headings:
|
||||||
|
issues.append(f"{rel_path}:{line_num}: broken anchor '#{anchor}' in {path_part}")
|
||||||
|
elif anchor:
|
||||||
|
# Anchor-only link — check in current file
|
||||||
|
anchor_slug = slugify(anchor)
|
||||||
|
if anchor_slug not in headings:
|
||||||
|
issues.append(f"{rel_path}:{line_num}: broken anchor '#{anchor}'")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_heading_hierarchy(root: Path) -> list[str]:
|
||||||
|
"""Check that headings don't skip levels."""
|
||||||
|
issues: list[str] = []
|
||||||
|
md_files = [f for f in root.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
content = strip_code_blocks(md_file.read_text(encoding="utf-8"))
|
||||||
|
prev_level = 0
|
||||||
|
for match in _HEADING_RE.finditer(content):
|
||||||
|
level = len(match.group(1))
|
||||||
|
if prev_level > 0 and level > prev_level + 1:
|
||||||
|
issues.append(f"{rel_path}: heading hierarchy skip — H{prev_level} → H{level}: '{match.group(2)}'")
|
||||||
|
prev_level = level
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_todo_fixme(root: Path) -> list[str]:
|
||||||
|
"""Check for TODO/FIXME/HACK/XXX markers in documentation.
|
||||||
|
|
||||||
|
Only flags actual TODO/FIXME markers (e.g., "TODO: fix this"), not
|
||||||
|
references to the word "TODO" in rules or documentation about TODOs.
|
||||||
|
"""
|
||||||
|
issues: list[str] = []
|
||||||
|
md_files = [f for f in root.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
content = md_file.read_text(encoding="utf-8")
|
||||||
|
for match in _TODO_RE.finditer(content):
|
||||||
|
line_num = content[: match.start()].count("\n") + 1
|
||||||
|
line = content.splitlines()[line_num - 1] if line_num <= len(content.splitlines()) else ""
|
||||||
|
issues.append(f"{rel_path}:{line_num}: TODO/FIXME found: {line.strip()}")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_trailing_whitespace(root: Path) -> list[str]:
|
||||||
|
"""Check for trailing whitespace in markdown files."""
|
||||||
|
issues: list[str] = []
|
||||||
|
md_files = [f for f in root.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
content = md_file.read_text(encoding="utf-8")
|
||||||
|
for i, line in enumerate(content.splitlines(), 1):
|
||||||
|
if _TRAILING_WS_RE.search(line):
|
||||||
|
issues.append(f"{rel_path}:{i}: trailing whitespace")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_stale_docs(root: Path) -> list[str]:
|
||||||
|
"""Check for stale documentation (not modified in >180 days)."""
|
||||||
|
issues: list[str] = []
|
||||||
|
threshold = datetime.now() - timedelta(days=STALE_THRESHOLD_DAYS)
|
||||||
|
md_files = [f for f in root.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
mtime = datetime.fromtimestamp(md_file.stat().st_mtime)
|
||||||
|
if mtime < threshold:
|
||||||
|
days_old = (datetime.now() - mtime).days
|
||||||
|
issues.append(f"{rel_path}: stale doc — not modified in {days_old} days")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_duplicate_headings(root: Path) -> list[str]:
|
||||||
|
"""Check for duplicate headings within the same file."""
|
||||||
|
issues: list[str] = []
|
||||||
|
md_files = [f for f in root.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
# Skip auto-generated files like CHANGELOG.md
|
||||||
|
if md_file.name in DUPLICATE_HEADING_EXCLUDES:
|
||||||
|
continue
|
||||||
|
content = strip_code_blocks(md_file.read_text(encoding="utf-8"))
|
||||||
|
seen: dict[str, int] = {}
|
||||||
|
for match in _HEADING_RE.finditer(content):
|
||||||
|
text = match.group(2)
|
||||||
|
slug = slugify(text)
|
||||||
|
if slug in seen:
|
||||||
|
issues.append(f"{rel_path}: duplicate heading '{text}'")
|
||||||
|
seen[slug] = 1
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
@click.command()
|
||||||
|
@click.option("--root", default=".", help="Repository root directory.")
|
||||||
|
@click.option("--docs-dir", default=None, help="Docs directory (default: <root>/docs).")
|
||||||
|
@click.option("--check-links/--no-check-links", default=True, help="Check internal links.")
|
||||||
|
@click.option("--check-headings/--no-check-headings", default=True, help="Check heading hierarchy.")
|
||||||
|
@click.option("--check-todo/--no-check-todo", default=True, help="Check for TODO/FIXME.")
|
||||||
|
@click.option("--check-stale/--no-check-stale", default=False, help="Check for stale docs.")
|
||||||
|
@click.option("--check-trailing/--no-check-trailing", default=True, help="Check trailing whitespace.")
|
||||||
|
@click.option("--check-duplicates/--no-check-duplicates", default=True, help="Check duplicate headings.")
|
||||||
|
@click.option("--fix", is_flag=True, default=False, help="Auto-fix trailing whitespace.")
|
||||||
|
def main(
|
||||||
|
root: str,
|
||||||
|
docs_dir: str | None,
|
||||||
|
check_links: bool,
|
||||||
|
check_headings: bool,
|
||||||
|
check_todo: bool,
|
||||||
|
check_stale: bool,
|
||||||
|
check_trailing: bool,
|
||||||
|
check_duplicates: bool,
|
||||||
|
fix: bool,
|
||||||
|
) -> None:
|
||||||
|
"""Lint documentation files for structure, links, and quality."""
|
||||||
|
root_path = Path(root).resolve()
|
||||||
|
docs_path = Path(docs_dir) if docs_dir else root_path / "docs"
|
||||||
|
|
||||||
|
click.echo(_("Linting documentation in {root}...", root=str(root_path)))
|
||||||
|
|
||||||
|
all_issues: list[str] = []
|
||||||
|
|
||||||
|
# Structure checks
|
||||||
|
click.echo(_("Checking required files..."))
|
||||||
|
all_issues.extend(check_required_files(root_path))
|
||||||
|
|
||||||
|
click.echo(_("Checking docs structure..."))
|
||||||
|
all_issues.extend(check_docs_structure(root_path, docs_path))
|
||||||
|
|
||||||
|
# Link checks
|
||||||
|
if check_links:
|
||||||
|
click.echo(_("Checking internal links..."))
|
||||||
|
all_issues.extend(check_internal_links(root_path, docs_path))
|
||||||
|
|
||||||
|
# Heading hierarchy
|
||||||
|
if check_headings:
|
||||||
|
click.echo(_("Checking heading hierarchy..."))
|
||||||
|
all_issues.extend(check_heading_hierarchy(root_path))
|
||||||
|
|
||||||
|
# Duplicate headings
|
||||||
|
if check_duplicates:
|
||||||
|
click.echo(_("Checking duplicate headings..."))
|
||||||
|
all_issues.extend(check_duplicate_headings(root_path))
|
||||||
|
|
||||||
|
# TODO/FIXME
|
||||||
|
if check_todo:
|
||||||
|
click.echo(_("Checking for TODO/FIXME markers..."))
|
||||||
|
all_issues.extend(check_todo_fixme(root_path))
|
||||||
|
|
||||||
|
# Trailing whitespace
|
||||||
|
if check_trailing:
|
||||||
|
click.echo(_("Checking trailing whitespace..."))
|
||||||
|
ws_issues = check_trailing_whitespace(root_path)
|
||||||
|
if fix and ws_issues:
|
||||||
|
fixed = 0
|
||||||
|
md_files = [f for f in root_path.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
for md_file in md_files:
|
||||||
|
content = md_file.read_text(encoding="utf-8")
|
||||||
|
fixed_content = _TRAILING_WS_RE.sub("", content)
|
||||||
|
if content != fixed_content:
|
||||||
|
md_file.write_text(fixed_content, encoding="utf-8")
|
||||||
|
fixed += 1
|
||||||
|
click.echo(_(" Auto-fixed trailing whitespace in {n} files", n=fixed))
|
||||||
|
else:
|
||||||
|
all_issues.extend(ws_issues)
|
||||||
|
|
||||||
|
# Stale docs
|
||||||
|
if check_stale:
|
||||||
|
click.echo(_("Checking for stale docs..."))
|
||||||
|
stale = check_stale_docs(root_path)
|
||||||
|
for issue in stale:
|
||||||
|
click.echo(f" WARN: {issue}")
|
||||||
|
# Stale docs are warnings, not errors
|
||||||
|
click.echo(_(" {n} stale docs found (warnings only)", n=len(stale)))
|
||||||
|
|
||||||
|
# Report
|
||||||
|
click.echo(f"\n{'=' * 60}")
|
||||||
|
if all_issues:
|
||||||
|
click.echo(_("FAIL: {n} documentation issues found:", n=len(all_issues)))
|
||||||
|
for issue in all_issues:
|
||||||
|
click.echo(f" - {issue}")
|
||||||
|
sys.exit(1)
|
||||||
|
else:
|
||||||
|
click.echo(_("PASS: All documentation checks passed!"))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
main()
|
||||||
@@ -6,7 +6,7 @@ otherwise go unnoticed in the Actions tab. Uses the ``tea`` Gitea CLI
|
|||||||
for issue creation — tea must be installed and configured.
|
for issue creation — tea must be installed and configured.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
REPO_TOKEN=<token> python3 -m devx.ci.notify_failure \
|
CI_GITEA_TOKEN=<token> python3 -m devx.ci.notify_failure \
|
||||||
--repo <owner/repo> \
|
--repo <owner/repo> \
|
||||||
--run-id <run_id> \
|
--run-id <run_id> \
|
||||||
--workflow <workflow_name> \
|
--workflow <workflow_name> \
|
||||||
@@ -14,7 +14,7 @@ Usage:
|
|||||||
--auto-login
|
--auto-login
|
||||||
|
|
||||||
With ``--auto-login``, the script configures the tea CLI login profile
|
With ``--auto-login``, the script configures the tea CLI login profile
|
||||||
from ``REPO_TOKEN`` and ``DEVX_GITEA_API_URL`` before creating the issue,
|
from ``CI_GITEA_TOKEN`` and ``DEVX_GITEA_API_URL`` before creating the issue,
|
||||||
eliminating the need for a separate ``tea login add`` step in the workflow.
|
eliminating the need for a separate ``tea login add`` step in the workflow.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -71,12 +71,12 @@ def _create_issue_via_tea(repo: str, title: str, body: str) -> int:
|
|||||||
"--auto-login",
|
"--auto-login",
|
||||||
is_flag=True,
|
is_flag=True,
|
||||||
default=False,
|
default=False,
|
||||||
help="Configure tea CLI login from REPO_TOKEN before creating the issue.",
|
help="Configure tea CLI login from CI_GITEA_TOKEN before creating the issue.",
|
||||||
)
|
)
|
||||||
def main(repo: str, run_id: str, workflow: str, commit: str, auto_login: bool) -> None:
|
def main(repo: str, run_id: str, workflow: str, commit: str, auto_login: bool) -> None:
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not token:
|
if not token:
|
||||||
raise click.ClickException(_("ERROR: REPO_TOKEN is not set."))
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
||||||
|
|
||||||
if auto_login:
|
if auto_login:
|
||||||
configure_tea_login()
|
configure_tea_login()
|
||||||
|
|||||||
@@ -13,7 +13,8 @@ import click
|
|||||||
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
||||||
|
|
||||||
from devx.api_clients import VikunjaClient
|
from devx.api_clients import VikunjaClient
|
||||||
from devx.config import DEFAULT_PER_PAGE, TASK_ID_RE, TASK_PREFIX, VIKUNJA_API_URL, VIKUNJA_PROJECT_ID
|
from devx.ci._shared import extract_task_id as _extract_task_id
|
||||||
|
from devx.config import DEFAULT_PER_PAGE, TASK_PREFIX, VIKUNJA_API_URL, VIKUNJA_PROJECT_ID
|
||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
@@ -47,10 +48,9 @@ def _get_git_commit_sha() -> str:
|
|||||||
|
|
||||||
|
|
||||||
def extract_task_id(commit_msg: str) -> str:
|
def extract_task_id(commit_msg: str) -> str:
|
||||||
"""Extract DEVX-N task identifier from the first line of commit message."""
|
"""Extract task identifier from the first line of commit message (delegates to shared utility)."""
|
||||||
first_line = commit_msg.split("\n")[0]
|
first_line = commit_msg.split("\n")[0]
|
||||||
match = TASK_ID_RE.search(first_line)
|
return _extract_task_id(first_line)
|
||||||
return match.group(0) if match else ""
|
|
||||||
|
|
||||||
|
|
||||||
def extract_conventional_msg(commit_msg: str) -> str:
|
def extract_conventional_msg(commit_msg: str) -> str:
|
||||||
@@ -61,7 +61,7 @@ def extract_conventional_msg(commit_msg: str) -> str:
|
|||||||
- ``DEVX-N <message>`` (current, space-separated)
|
- ``DEVX-N <message>`` (current, space-separated)
|
||||||
"""
|
"""
|
||||||
first_line = commit_msg.split("\n")[0]
|
first_line = commit_msg.split("\n")[0]
|
||||||
return re.sub(r"^DEVX-\d+[:\s]\s*", "", first_line)
|
return re.sub(rf"^{TASK_PREFIX}-\d+[:\s]\s*", "", first_line)
|
||||||
|
|
||||||
|
|
||||||
def resolve_task_id(client: VikunjaClient, task_id: str) -> int:
|
def resolve_task_id(client: VikunjaClient, task_id: str) -> int:
|
||||||
|
|||||||
+119
-5
@@ -17,7 +17,7 @@ Checks performed:
|
|||||||
8. Commit conventions — conventional commit format on branch commits
|
8. Commit conventions — conventional commit format on branch commits
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
REPO_TOKEN=<token> python3 -m devx.ci.pr_review <pr_number> <owner/repo>
|
CI_GITEA_TOKEN=<token> python3 -m devx.ci.pr_review <pr_number> <owner/repo>
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -387,14 +387,34 @@ def check_documentation(files: list[dict[str, Any]], result: ReviewResult) -> No
|
|||||||
for f in files
|
for f in files
|
||||||
)
|
)
|
||||||
has_ansible_changes = any(f.get("filename", "").startswith("ansible/") for f in files)
|
has_ansible_changes = any(f.get("filename", "").startswith("ansible/") for f in files)
|
||||||
|
has_tofu_changes = any(f.get("filename", "").startswith("tofu/") for f in files)
|
||||||
|
has_workflow_changes = any(f.get("filename", "").startswith(".gitea/") for f in files)
|
||||||
|
|
||||||
|
# Check for TODO/FIXME in changed docs
|
||||||
|
todo_issues: list[str] = []
|
||||||
|
for f in files:
|
||||||
|
filename = f.get("filename", "")
|
||||||
|
if filename.endswith(".md") and filename.startswith(("docs/", "README", "AGENTS")):
|
||||||
|
# Can't check file content from PR API easily, but flag if patch adds TODO
|
||||||
|
patch = f.get("patch", "")
|
||||||
|
if patch and re.search(r"^\+.*\b(TODO|FIXME|HACK|XXX)\b", patch, re.IGNORECASE):
|
||||||
|
todo_issues.append(f"{filename}: new TODO/FIXME added in documentation")
|
||||||
|
|
||||||
if has_src_changes and not has_doc_changes:
|
if has_src_changes and not has_doc_changes:
|
||||||
result.add_summary("- Documentation: WARNING — source files changed but no docs updated")
|
result.add_summary("- Documentation: WARNING — source files changed but no docs updated")
|
||||||
elif has_ansible_changes and not has_doc_changes:
|
elif has_ansible_changes and not has_doc_changes:
|
||||||
result.add_summary("- Documentation: WARNING — Ansible role changed but no docs updated")
|
result.add_summary("- Documentation: WARNING — Ansible role changed but no docs updated")
|
||||||
|
elif has_tofu_changes and not has_doc_changes:
|
||||||
|
result.add_summary("- Documentation: WARNING — OpenTofu changes but no docs updated")
|
||||||
|
elif has_workflow_changes and not has_doc_changes:
|
||||||
|
result.add_summary("- Documentation: INFO — workflow changes (consider updating CI docs if behavior changed)")
|
||||||
else:
|
else:
|
||||||
result.add_summary("- Documentation: OK")
|
result.add_summary("- Documentation: OK")
|
||||||
|
|
||||||
|
if todo_issues:
|
||||||
|
for issue in todo_issues:
|
||||||
|
result.add_summary(f"- Documentation: WARNING — {issue}")
|
||||||
|
|
||||||
|
|
||||||
def check_test_coverage(files: list[dict[str, Any]], result: ReviewResult) -> None:
|
def check_test_coverage(files: list[dict[str, Any]], result: ReviewResult) -> None:
|
||||||
"""Check that tests are updated for source changes."""
|
"""Check that tests are updated for source changes."""
|
||||||
@@ -520,19 +540,113 @@ def post_review(client: GiteaClient, pr_number: str, result: ReviewResult) -> di
|
|||||||
return client.create_review(pr_number, event=event, body=body, comments=comments)
|
return client.create_review(pr_number, event=event, body=body, comments=comments)
|
||||||
|
|
||||||
|
|
||||||
|
def _post_manual_review(
|
||||||
|
client: GiteaClient,
|
||||||
|
pr_number: str,
|
||||||
|
event: str,
|
||||||
|
body: str | None,
|
||||||
|
checklist_confirmed: bool,
|
||||||
|
checklist_categories: str | None,
|
||||||
|
dry_run: bool,
|
||||||
|
) -> None:
|
||||||
|
"""Post a manual review with validation for APPROVE events."""
|
||||||
|
if not body or len(body) < 50:
|
||||||
|
raise click.ClickException(_("Review body must be at least 50 characters."))
|
||||||
|
|
||||||
|
if event == "APPROVE":
|
||||||
|
if not checklist_confirmed:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("--checklist-confirmed is required for APPROVE events."),
|
||||||
|
)
|
||||||
|
cats = [c.strip() for c in (checklist_categories or "").split(",") if c.strip()]
|
||||||
|
cat_nums: list[int] = []
|
||||||
|
for c in cats:
|
||||||
|
try:
|
||||||
|
cat_nums.append(int(c))
|
||||||
|
except ValueError:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("Invalid checklist category: {cat}. Must be numbers.", cat=c),
|
||||||
|
) from None
|
||||||
|
if len(cat_nums) < 8:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("--checklist-categories must list at least 8 of 13 categories. Got {count}.", count=len(cat_nums)),
|
||||||
|
)
|
||||||
|
|
||||||
|
click.echo(f"Manual review event: {event}")
|
||||||
|
click.echo(f"Body: {body[:80]}...")
|
||||||
|
if checklist_confirmed:
|
||||||
|
click.echo(f"Checklist confirmed: {checklist_categories}")
|
||||||
|
|
||||||
|
if dry_run:
|
||||||
|
click.echo("\n[dry-run] Review not posted.")
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
review = client.create_review(pr_number, event=event, body=body)
|
||||||
|
except APIError as e:
|
||||||
|
if "approve" in e.message.lower() or "422" in str(e.status):
|
||||||
|
click.echo(_("Note: Self-approval not allowed. Posting COMMENT instead."))
|
||||||
|
review = client.create_review(pr_number, event="COMMENT", body=body)
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
review_id = review.get("id", "?")
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"\nReview #{review_id} posted on PR #{pr_number} with event '{event}'.",
|
||||||
|
review_id=review_id,
|
||||||
|
pr_number=pr_number,
|
||||||
|
event=event,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
@click.argument("pr_number")
|
@click.argument("pr_number")
|
||||||
@click.argument("repo")
|
@click.argument("repo")
|
||||||
@click.option("--dry-run", is_flag=True, default=False, help="Print review without posting.")
|
@click.option("--dry-run", is_flag=True, default=False, help="Print review without posting.")
|
||||||
def main(pr_number: str, repo: str, dry_run: bool) -> None:
|
@click.option(
|
||||||
"""Run automated PR review and post results to Gitea."""
|
"--event",
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
type=click.Choice(["APPROVE", "REQUEST_CHANGES", "COMMENT"], case_sensitive=False),
|
||||||
|
default=None,
|
||||||
|
help="Post a manual review with the given event (skips automated checks).",
|
||||||
|
)
|
||||||
|
@click.option("--body", default=None, help="Review body text (required with --event).")
|
||||||
|
@click.option(
|
||||||
|
"--checklist-confirmed",
|
||||||
|
is_flag=True,
|
||||||
|
default=False,
|
||||||
|
help="Attest that REVIEW_CHECKLIST.md categories were checked (required for APPROVE).",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--checklist-categories",
|
||||||
|
default=None,
|
||||||
|
help="Comma-separated checklist category numbers (required for APPROVE, min 8 of 13).",
|
||||||
|
)
|
||||||
|
def main(
|
||||||
|
pr_number: str,
|
||||||
|
repo: str,
|
||||||
|
dry_run: bool,
|
||||||
|
event: str | None,
|
||||||
|
body: str | None,
|
||||||
|
checklist_confirmed: bool,
|
||||||
|
checklist_categories: str | None,
|
||||||
|
) -> None:
|
||||||
|
"""Run automated PR review and post results to Gitea.
|
||||||
|
|
||||||
|
Without --event: runs automated checks and posts COMMENT/REQUEST_CHANGES.
|
||||||
|
With --event: posts a manual review (skips automated checks).
|
||||||
|
"""
|
||||||
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not token:
|
if not token:
|
||||||
raise click.ClickException(_("ERROR: REPO_TOKEN is not set."))
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
||||||
|
|
||||||
owner, repo_name = repo.split("/")
|
owner, repo_name = repo.split("/")
|
||||||
client = GiteaClient(GITEA_API_URL, token, owner, repo_name)
|
client = GiteaClient(GITEA_API_URL, token, owner, repo_name)
|
||||||
|
|
||||||
|
if event is not None:
|
||||||
|
_post_manual_review(client, pr_number, event.upper(), body, checklist_confirmed, checklist_categories, dry_run)
|
||||||
|
return
|
||||||
|
|
||||||
result = run_review(client, pr_number)
|
result = run_review(client, pr_number)
|
||||||
|
|
||||||
body = build_review_body(result)
|
body = build_review_body(result)
|
||||||
|
|||||||
@@ -9,14 +9,14 @@ Publishing destinations (checked in order):
|
|||||||
``DEVX_PYPI_REGISTRY_URL`` env var is set, or ``GITEA_API_URL``
|
``DEVX_PYPI_REGISTRY_URL`` env var is set, or ``GITEA_API_URL``
|
||||||
is converted to a packages URL). Uses ``twine upload
|
is converted to a packages URL). Uses ``twine upload
|
||||||
--repository-url <url> -u <token> -p <token>`` with the
|
--repository-url <url> -u <token> -p <token>`` with the
|
||||||
``REPO_TOKEN`` as both username and password.
|
``CI_GITEA_TOKEN`` as both username and password.
|
||||||
2. **Standard PyPI** — if ``PYPI_TOKEN`` is set. Uses the standard
|
2. **Standard PyPI** — if ``PYPI_TOKEN`` is set. Uses the standard
|
||||||
``twine upload -u __token__ -p <token>`` flow.
|
``twine upload -u __token__ -p <token>`` flow.
|
||||||
3. **Skip** — if neither is configured, only the Gitea release is created.
|
3. **Skip** — if neither is configured, only the Gitea release is created.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
REPO_TOKEN=<token> [PYPI_TOKEN=<token>] python3 -m devx.ci.publish <tag> <repo>
|
CI_GITEA_TOKEN=<token> [PYPI_TOKEN=<token>] python3 -m devx.ci.publish <tag> <repo>
|
||||||
REPO_TOKEN=<token> python3 -m devx.ci.publish <tag> <repo> --registry-url https://git.example.com/api/packages/owner/pypi
|
CI_GITEA_TOKEN=<token> python3 -m devx.ci.publish <tag> <repo> --registry-url https://git.example.com/api/packages/owner/pypi
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
@@ -28,7 +28,7 @@ from pathlib import Path
|
|||||||
import click
|
import click
|
||||||
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
||||||
|
|
||||||
from devx.config import GITEA_API_URL
|
from devx.config import GITEA_API_URL, REPO_OWNER
|
||||||
from devx.gitea_cli import TeaCLI, TeaCLIError, configure_tea_login
|
from devx.gitea_cli import TeaCLI, TeaCLIError, configure_tea_login
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
@@ -165,7 +165,7 @@ def _default_gitea_registry_url() -> str:
|
|||||||
base = base[: -len("/api/v1")]
|
base = base[: -len("/api/v1")]
|
||||||
elif base.endswith("/api"):
|
elif base.endswith("/api"):
|
||||||
base = base[: -len("/api")]
|
base = base[: -len("/api")]
|
||||||
owner = os.environ.get("DEVX_REPO_OWNER", "oblachno-oss")
|
owner = os.environ.get("DEVX_REPO_OWNER", "") or REPO_OWNER
|
||||||
return f"{base}/api/packages/{owner}/pypi"
|
return f"{base}/api/packages/{owner}/pypi"
|
||||||
|
|
||||||
|
|
||||||
@@ -225,7 +225,7 @@ def is_release_commit(tag: str) -> bool:
|
|||||||
"--auto-login",
|
"--auto-login",
|
||||||
is_flag=True,
|
is_flag=True,
|
||||||
default=False,
|
default=False,
|
||||||
help="Configure tea CLI login from REPO_TOKEN before creating the Gitea release. "
|
help="Configure tea CLI login from CI_GITEA_TOKEN before creating the Gitea release. "
|
||||||
"Eliminates the need for a separate tea login step in containerized CI jobs.",
|
"Eliminates the need for a separate tea login step in containerized CI jobs.",
|
||||||
)
|
)
|
||||||
def main(
|
def main(
|
||||||
@@ -253,9 +253,9 @@ def main(
|
|||||||
|
|
||||||
if not tag:
|
if not tag:
|
||||||
raise click.ClickException(_("Tag is required (or use --from-tag)."))
|
raise click.ClickException(_("Tag is required (or use --from-tag)."))
|
||||||
gitea_token = os.environ.get("REPO_TOKEN", "")
|
gitea_token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not gitea_token:
|
if not gitea_token:
|
||||||
raise click.ClickException(_("ERROR: REPO_TOKEN is not set."))
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
||||||
|
|
||||||
pypi_token = os.environ.get("PYPI_TOKEN", "")
|
pypi_token = os.environ.get("PYPI_TOKEN", "")
|
||||||
|
|
||||||
|
|||||||
+22
-11
@@ -28,6 +28,8 @@ from typing import Any
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
|
|
||||||
def _repo_root() -> Path:
|
def _repo_root() -> Path:
|
||||||
"""Resolve repo root from GITHUB_WORKSPACE or cwd."""
|
"""Resolve repo root from GITHUB_WORKSPACE or cwd."""
|
||||||
@@ -68,7 +70,7 @@ def fetch_latest_master(branch: str = "master") -> None:
|
|||||||
"""
|
"""
|
||||||
_run(["git", "fetch", "origin", branch]) # nosec B607
|
_run(["git", "fetch", "origin", branch]) # nosec B607
|
||||||
_run(["git", "reset", "--hard", f"origin/{branch}"]) # nosec B607
|
_run(["git", "reset", "--hard", f"origin/{branch}"]) # nosec B607
|
||||||
click.echo(f"Synced to latest origin/{branch}")
|
click.echo(_("Synced to latest origin/{branch}", branch=branch))
|
||||||
|
|
||||||
|
|
||||||
def generate_badges(output_dir: str) -> None:
|
def generate_badges(output_dir: str) -> None:
|
||||||
@@ -76,8 +78,8 @@ def generate_badges(output_dir: str) -> None:
|
|||||||
_run([sys.executable, "-m", "devx.tools.generate_badges", "--output-dir", output_dir])
|
_run([sys.executable, "-m", "devx.tools.generate_badges", "--output-dir", output_dir])
|
||||||
badges = list(Path(output_dir).glob("*.svg"))
|
badges = list(Path(output_dir).glob("*.svg"))
|
||||||
if not badges:
|
if not badges:
|
||||||
raise click.ClickException("No badge SVG files generated")
|
raise click.ClickException(_("No badge SVG files generated"))
|
||||||
click.echo(f"Generated {len(badges)} badge files")
|
click.echo(_("Generated {count} badge files", count=len(badges)))
|
||||||
|
|
||||||
|
|
||||||
def push_to_badges_branch(badges_dir: str) -> str:
|
def push_to_badges_branch(badges_dir: str) -> str:
|
||||||
@@ -99,12 +101,12 @@ def push_to_badges_branch(badges_dir: str) -> str:
|
|||||||
_run(["git", "add", "./*.svg"]) # nosec B607
|
_run(["git", "add", "./*.svg"]) # nosec B607
|
||||||
_run(["git", "commit", "--no-verify", "-m", "Update badges [skip ci]"]) # nosec B607
|
_run(["git", "commit", "--no-verify", "-m", "Update badges [skip ci]"]) # nosec B607
|
||||||
_run(["git", "push", "origin", "badges", "--force"]) # nosec B607
|
_run(["git", "push", "origin", "badges", "--force"]) # nosec B607
|
||||||
click.echo("Badges pushed to badges branch")
|
click.echo(_("Badges pushed to badges branch"))
|
||||||
|
|
||||||
# Get the commit SHA of the badges branch
|
# Get the commit SHA of the badges branch
|
||||||
result = _run_capture(["git", "rev-parse", "HEAD"]) # nosec B607
|
result = _run_capture(["git", "rev-parse", "HEAD"]) # nosec B607
|
||||||
sha = result.stdout.strip()
|
sha = result.stdout.strip()
|
||||||
click.echo(f"Badges commit SHA: {sha}")
|
click.echo(_("Badges commit SHA: {sha}", sha=sha))
|
||||||
return sha
|
return sha
|
||||||
|
|
||||||
|
|
||||||
@@ -142,11 +144,11 @@ def update_readme_with_badge_sha(badges_sha: str, repo_root: Path | None = None)
|
|||||||
new_content = update_badge_urls(content, badges_sha)
|
new_content = update_badge_urls(content, badges_sha)
|
||||||
if new_content != content:
|
if new_content != content:
|
||||||
filepath.write_text(new_content)
|
filepath.write_text(new_content)
|
||||||
click.echo(f"Updated badge URLs in {filename}")
|
click.echo(_("Updated badge URLs in {filename}", filename=filename))
|
||||||
updated_any = True
|
updated_any = True
|
||||||
|
|
||||||
if not updated_any:
|
if not updated_any:
|
||||||
click.echo("No badge URLs found to update — README already up to date")
|
click.echo(_("No badge URLs found to update — README already up to date"))
|
||||||
return
|
return
|
||||||
|
|
||||||
_run(["git", "add", "README.md", "docs/index.md"]) # nosec B607
|
_run(["git", "add", "README.md", "docs/index.md"]) # nosec B607
|
||||||
@@ -160,7 +162,7 @@ def update_readme_with_badge_sha(badges_sha: str, repo_root: Path | None = None)
|
|||||||
]
|
]
|
||||||
) # nosec B607
|
) # nosec B607
|
||||||
_run(["git", "push", "origin", "master"]) # nosec B607
|
_run(["git", "push", "origin", "master"]) # nosec B607
|
||||||
click.echo(f"Pushed README update with badge SHA {badges_sha[:8]}")
|
click.echo(_("Pushed README update with badge SHA {sha}", sha=badges_sha[:8]))
|
||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
@@ -193,13 +195,22 @@ def main(output_dir: str, branch: str, no_readme_update: bool, retries: int) ->
|
|||||||
except (subprocess.CalledProcessError, RuntimeError) as exc:
|
except (subprocess.CalledProcessError, RuntimeError) as exc:
|
||||||
last_error = exc
|
last_error = exc
|
||||||
if attempt < retries:
|
if attempt < retries:
|
||||||
click.echo(f"Badge push attempt {attempt}/{retries} failed — retrying: {exc}")
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Badge push attempt {attempt}/{retries} failed — retrying: {error}",
|
||||||
|
attempt=attempt,
|
||||||
|
retries=retries,
|
||||||
|
error=exc,
|
||||||
|
)
|
||||||
|
)
|
||||||
time.sleep(10)
|
time.sleep(10)
|
||||||
with contextlib.suppress(subprocess.CalledProcessError):
|
with contextlib.suppress(subprocess.CalledProcessError):
|
||||||
fetch_latest_master(branch)
|
fetch_latest_master(branch)
|
||||||
else:
|
else:
|
||||||
click.echo(f"Badge push failed after {retries} attempts: {exc}")
|
click.echo(_("Badge push failed after {retries} attempts: {error}", retries=retries, error=exc))
|
||||||
raise click.ClickException(f"Badge push failed after {retries} attempts: {last_error}")
|
raise click.ClickException(
|
||||||
|
_("Badge push failed after {retries} attempts: {error}", retries=retries, error=last_error)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
|||||||
+51
-42
@@ -29,7 +29,7 @@ version. This prevents duplicate release commits (a common issue when CI
|
|||||||
checkouts don't fetch tags) and ensures tag/version/commit alignment.
|
checkouts don't fetch tags) and ensures tag/version/commit alignment.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
REPO_TOKEN=<token> python3 -m devx.ci.release [--dry-run] [--skip-tests]
|
CI_GITEA_TOKEN=<token> python3 -m devx.ci.release [--dry-run] [--skip-tests]
|
||||||
python3 -m devx.ci.release --verify # Check tag/version/release alignment
|
python3 -m devx.ci.release --verify # Check tag/version/release alignment
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -37,13 +37,13 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
import subprocess # nosec B404
|
|
||||||
import sys
|
import sys
|
||||||
|
import time
|
||||||
|
|
||||||
import click
|
import click
|
||||||
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
||||||
|
|
||||||
from devx.ci._shared import get_latest_tag
|
from devx.ci._shared import get_latest_tag, run_cmd, write_github_output
|
||||||
from devx.ci.classify_changes import has_user_facing_changes # cross-CI import, needs PYTHONPATH=.
|
from devx.ci.classify_changes import has_user_facing_changes # cross-CI import, needs PYTHONPATH=.
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
@@ -54,25 +54,6 @@ CHANGELOG_FILE = "CHANGELOG.md"
|
|||||||
CLIFF_CONFIG = "cliff.toml"
|
CLIFF_CONFIG = "cliff.toml"
|
||||||
|
|
||||||
|
|
||||||
def run_cmd(args: list[str], check: bool = True, capture: bool = True) -> subprocess.CompletedProcess[str]:
|
|
||||||
"""Run a command and return the completed process."""
|
|
||||||
result = subprocess.run( # nosec B603
|
|
||||||
args,
|
|
||||||
capture_output=capture,
|
|
||||||
text=True,
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
if check and result.returncode != 0:
|
|
||||||
raise click.ClickException(
|
|
||||||
_(
|
|
||||||
"Command failed ({cmd}): {stderr}",
|
|
||||||
cmd=" ".join(args),
|
|
||||||
stderr=result.stderr.strip() if result.stderr else result.stdout.strip(),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
return result
|
|
||||||
|
|
||||||
|
|
||||||
def tag_exists(tag: str) -> bool:
|
def tag_exists(tag: str) -> bool:
|
||||||
"""Check if a git tag already exists."""
|
"""Check if a git tag already exists."""
|
||||||
result = run_cmd(["git", "tag", "-l", tag], check=False)
|
result = run_cmd(["git", "tag", "-l", tag], check=False)
|
||||||
@@ -217,7 +198,7 @@ def has_unreleased_changes(bumped_version: str | None = None) -> bool:
|
|||||||
|
|
||||||
def update_init_version(new_version: str) -> None:
|
def update_init_version(new_version: str) -> None:
|
||||||
"""Update __version__ in __init__.py."""
|
"""Update __version__ in __init__.py."""
|
||||||
with open(INIT_FILE) as f:
|
with open(INIT_FILE, encoding="utf-8") as f:
|
||||||
content = f.read()
|
content = f.read()
|
||||||
if not re.search(r'^__version__\s*=\s*"[^"]*"', content, flags=re.MULTILINE):
|
if not re.search(r'^__version__\s*=\s*"[^"]*"', content, flags=re.MULTILINE):
|
||||||
raise click.ClickException(_("Could not find __version__ in {file}", file=INIT_FILE))
|
raise click.ClickException(_("Could not find __version__ in {file}", file=INIT_FILE))
|
||||||
@@ -228,7 +209,7 @@ def update_init_version(new_version: str) -> None:
|
|||||||
count=1,
|
count=1,
|
||||||
flags=re.MULTILINE,
|
flags=re.MULTILINE,
|
||||||
)
|
)
|
||||||
with open(INIT_FILE, "w") as f:
|
with open(INIT_FILE, "w", encoding="utf-8") as f:
|
||||||
f.write(updated)
|
f.write(updated)
|
||||||
|
|
||||||
|
|
||||||
@@ -245,10 +226,10 @@ def update_changelog(changelog: str) -> None:
|
|||||||
changelog = changelog[section_match.start() :]
|
changelog = changelog[section_match.start() :]
|
||||||
|
|
||||||
try:
|
try:
|
||||||
with open(CHANGELOG_FILE) as f:
|
with open(CHANGELOG_FILE, encoding="utf-8") as f:
|
||||||
existing = f.read()
|
existing = f.read()
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
with open(CHANGELOG_FILE, "w") as f:
|
with open(CHANGELOG_FILE, "w", encoding="utf-8") as f:
|
||||||
f.write(changelog + "\n")
|
f.write(changelog + "\n")
|
||||||
return
|
return
|
||||||
|
|
||||||
@@ -261,7 +242,7 @@ def update_changelog(changelog: str) -> None:
|
|||||||
else:
|
else:
|
||||||
# No version sections found — append
|
# No version sections found — append
|
||||||
updated = existing.rstrip() + "\n\n" + changelog + "\n"
|
updated = existing.rstrip() + "\n\n" + changelog + "\n"
|
||||||
with open(CHANGELOG_FILE, "w") as f:
|
with open(CHANGELOG_FILE, "w", encoding="utf-8") as f:
|
||||||
f.write(updated)
|
f.write(updated)
|
||||||
|
|
||||||
|
|
||||||
@@ -279,7 +260,7 @@ def commit_release_changes(new_version: str) -> bool:
|
|||||||
if status.returncode == 0:
|
if status.returncode == 0:
|
||||||
click.echo(_("No staged changes — version and changelog already up to date."))
|
click.echo(_("No staged changes — version and changelog already up to date."))
|
||||||
return False
|
return False
|
||||||
run_cmd(["git", "commit", "--no-verify", "-m", f"release: v{new_version}"])
|
run_cmd(["git", "commit", "--no-verify", "-m", f"release: v{new_version} [skip ci]"])
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
@@ -317,18 +298,16 @@ def run_tests() -> None:
|
|||||||
click.echo(_("Tests passed."))
|
click.echo(_("Tests passed."))
|
||||||
|
|
||||||
|
|
||||||
def _write_github_output(tag: str) -> None:
|
def _write_release_tag(tag: str) -> None:
|
||||||
"""Write the release tag to GITHUB_OUTPUT for downstream jobs.
|
"""Write the release tag to GITHUB_OUTPUT for downstream jobs.
|
||||||
|
|
||||||
This allows a publish job (needs: release) to read the tag via
|
This allows a publish job (needs: release) to read the tag via
|
||||||
``${{ needs.release.outputs.tag }}`` instead of relying on
|
``${{ needs.release.outputs.tag }}`` instead of relying on
|
||||||
tag-push event triggering a separate workflow.
|
tag-push event triggering a separate workflow.
|
||||||
"""
|
"""
|
||||||
github_output = os.environ.get("GITHUB_OUTPUT")
|
if not os.environ.get("GITHUB_OUTPUT"):
|
||||||
if not github_output:
|
|
||||||
return
|
return
|
||||||
with open(github_output, "a") as f: # noqa: PTH123
|
write_github_output("tag", tag)
|
||||||
f.write(f"tag={tag}\n")
|
|
||||||
click.echo(_("Wrote tag {tag} to GITHUB_OUTPUT.", tag=tag))
|
click.echo(_("Wrote tag {tag} to GITHUB_OUTPUT.", tag=tag))
|
||||||
|
|
||||||
|
|
||||||
@@ -360,7 +339,7 @@ def create_and_push_tag(new_version: str, changelog: str, dry_run: bool) -> bool
|
|||||||
if not dry_run:
|
if not dry_run:
|
||||||
# Ensure the existing tag is pushed
|
# Ensure the existing tag is pushed
|
||||||
run_cmd(["git", "push", "origin", f"refs/tags/{tag}"], check=False)
|
run_cmd(["git", "push", "origin", f"refs/tags/{tag}"], check=False)
|
||||||
_write_github_output(tag)
|
_write_release_tag(tag)
|
||||||
return False
|
return False
|
||||||
tag_msg = f"Release v{new_version}\n\n{changelog}"
|
tag_msg = f"Release v{new_version}\n\n{changelog}"
|
||||||
if dry_run:
|
if dry_run:
|
||||||
@@ -368,7 +347,7 @@ def create_and_push_tag(new_version: str, changelog: str, dry_run: bool) -> bool
|
|||||||
return True
|
return True
|
||||||
run_cmd(["git", "tag", "-a", tag, "-m", tag_msg])
|
run_cmd(["git", "tag", "-a", tag, "-m", tag_msg])
|
||||||
run_cmd(["git", "push", "origin", f"refs/tags/{tag}"])
|
run_cmd(["git", "push", "origin", f"refs/tags/{tag}"])
|
||||||
_write_github_output(tag)
|
_write_release_tag(tag)
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
@@ -380,7 +359,7 @@ def create_and_push_tag(new_version: str, changelog: str, dry_run: bool) -> bool
|
|||||||
def get_init_version() -> str | None:
|
def get_init_version() -> str | None:
|
||||||
"""Read __version__ from the version file."""
|
"""Read __version__ from the version file."""
|
||||||
try:
|
try:
|
||||||
with open(INIT_FILE) as f:
|
with open(INIT_FILE, encoding="utf-8") as f:
|
||||||
content = f.read()
|
content = f.read()
|
||||||
match = re.search(r'^__version__\s*=\s*"([^"]*)"', content, flags=re.MULTILINE)
|
match = re.search(r'^__version__\s*=\s*"([^"]*)"', content, flags=re.MULTILINE)
|
||||||
return match.group(1) if match else None
|
return match.group(1) if match else None
|
||||||
@@ -391,7 +370,7 @@ def get_init_version() -> str | None:
|
|||||||
def get_changelog_versions() -> list[str]:
|
def get_changelog_versions() -> list[str]:
|
||||||
"""Extract version numbers from CHANGELOG.md headers, in order."""
|
"""Extract version numbers from CHANGELOG.md headers, in order."""
|
||||||
try:
|
try:
|
||||||
with open(CHANGELOG_FILE) as f:
|
with open(CHANGELOG_FILE, encoding="utf-8") as f:
|
||||||
content = f.read()
|
content = f.read()
|
||||||
return re.findall(r"^## \[(\d+\.\d+\.\d+)\]", content, flags=re.MULTILINE)
|
return re.findall(r"^## \[(\d+\.\d+\.\d+)\]", content, flags=re.MULTILINE)
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
@@ -634,7 +613,7 @@ def main(dry_run: bool, skip_tests: bool, verify: bool) -> None:
|
|||||||
tag=release_tag,
|
tag=release_tag,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
_write_github_output(release_tag)
|
_write_release_tag(release_tag)
|
||||||
return
|
return
|
||||||
# Tag is missing — recover by creating and pushing it
|
# Tag is missing — recover by creating and pushing it
|
||||||
click.echo(
|
click.echo(
|
||||||
@@ -705,7 +684,7 @@ def main(dry_run: bool, skip_tests: bool, verify: bool) -> None:
|
|||||||
click.echo(_("\n[dry-run] Changelog:\n{changelog}", changelog=changelog))
|
click.echo(_("\n[dry-run] Changelog:\n{changelog}", changelog=changelog))
|
||||||
click.echo(_("[dry-run] Would update {init}", init=INIT_FILE))
|
click.echo(_("[dry-run] Would update {init}", init=INIT_FILE))
|
||||||
click.echo(_("[dry-run] Would update {changelog_file}", changelog_file=CHANGELOG_FILE))
|
click.echo(_("[dry-run] Would update {changelog_file}", changelog_file=CHANGELOG_FILE))
|
||||||
click.echo(_("[dry-run] Would commit: release: v{version}", version=new_version))
|
click.echo(_("[dry-run] Would commit: release: v{version} [skip ci]", version=new_version))
|
||||||
click.echo(_("[dry-run] Would push commit to master"))
|
click.echo(_("[dry-run] Would push commit to master"))
|
||||||
click.echo(_("[dry-run] Would create tag: v{version}", version=new_version))
|
click.echo(_("[dry-run] Would create tag: v{version}", version=new_version))
|
||||||
return
|
return
|
||||||
@@ -731,9 +710,39 @@ def main(dry_run: bool, skip_tests: bool, verify: bool) -> None:
|
|||||||
click.echo(_("Created release commit."))
|
click.echo(_("Created release commit."))
|
||||||
# Pull --rebase before push to handle the case where master
|
# Pull --rebase before push to handle the case where master
|
||||||
# advanced between checkout and commit (e.g., another merge).
|
# advanced between checkout and commit (e.g., another merge).
|
||||||
run_cmd(["git", "pull", "--rebase", "origin", "master"], check=False)
|
# Retry up to 3 times to handle concurrent pushes.
|
||||||
# Use refs/heads/master to avoid ambiguity with a 'master' tag
|
push_succeeded = False
|
||||||
run_cmd(["git", "push", "origin", "refs/heads/master:refs/heads/master"])
|
for attempt in range(3):
|
||||||
|
rebase = run_cmd(["git", "pull", "--rebase", "origin", "master"], check=False)
|
||||||
|
if rebase.returncode != 0:
|
||||||
|
# Rebase failed (likely conflicts). Abort and retry.
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Rebase attempt {n}/3 failed: {err}",
|
||||||
|
n=attempt + 1,
|
||||||
|
err=rebase.stderr.strip() if rebase.stderr else rebase.stdout.strip(),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
run_cmd(["git", "rebase", "--abort"], check=False)
|
||||||
|
# Brief delay before retry to let concurrent pushes settle.
|
||||||
|
time.sleep(5)
|
||||||
|
continue
|
||||||
|
push = run_cmd(["git", "push", "origin", "refs/heads/master:refs/heads/master"], check=False)
|
||||||
|
if push.returncode == 0:
|
||||||
|
push_succeeded = True
|
||||||
|
break
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Push attempt {n}/3 failed: {err}",
|
||||||
|
n=attempt + 1,
|
||||||
|
err=push.stderr.strip() if push.stderr else push.stdout.strip(),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
time.sleep(5)
|
||||||
|
if not push_succeeded:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("Failed to push release commit after 3 attempts. Manual intervention required.")
|
||||||
|
)
|
||||||
click.echo(_("Pushed release commit to master."))
|
click.echo(_("Pushed release commit to master."))
|
||||||
else:
|
else:
|
||||||
click.echo(_("Skipping commit push — no staged changes."))
|
click.echo(_("Skipping commit push — no staged changes."))
|
||||||
|
|||||||
+73
-14
@@ -14,21 +14,29 @@ Gitea 1.26 wiki API endpoints (all use content_base64, NOT content):
|
|||||||
- Delete: DELETE /repos/{owner}/{repo}/wiki/page/{sub_url}
|
- Delete: DELETE /repos/{owner}/{repo}/wiki/page/{sub_url}
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
REPO_TOKEN=<token> python3 -m devx.ci.sync_wiki [--dry-run] [--repo owner/repo]
|
CI_GITEA_TOKEN=<token> python3 -m devx.ci.sync_wiki [--dry-run] [--repo owner/repo]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import base64
|
import base64
|
||||||
import json
|
import json
|
||||||
|
import logging
|
||||||
import os
|
import os
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import click
|
import click
|
||||||
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
||||||
|
from tenacity import (
|
||||||
|
before_sleep_log,
|
||||||
|
retry,
|
||||||
|
retry_if_exception_type,
|
||||||
|
stop_after_attempt,
|
||||||
|
wait_exponential,
|
||||||
|
)
|
||||||
|
|
||||||
from devx.api_clients import GiteaClient
|
from devx.api_clients import GiteaClient
|
||||||
from devx.config import GITEA_API_URL
|
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
|
||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
@@ -49,7 +57,7 @@ def load_mapping() -> dict[str, str]:
|
|||||||
|
|
||||||
Validates that the mapping is a dict of string-to-string pairs.
|
Validates that the mapping is a dict of string-to-string pairs.
|
||||||
"""
|
"""
|
||||||
with open(MAPPING_FILE) as f:
|
with open(MAPPING_FILE, encoding="utf-8") as f:
|
||||||
data = json.load(f)
|
data = json.load(f)
|
||||||
if not isinstance(data, dict):
|
if not isinstance(data, dict):
|
||||||
raise click.ClickException(
|
raise click.ClickException(
|
||||||
@@ -64,7 +72,7 @@ def load_mapping() -> dict[str, str]:
|
|||||||
def read_doc_content(file_path: str) -> str:
|
def read_doc_content(file_path: str) -> str:
|
||||||
"""Read markdown content from a docs file."""
|
"""Read markdown content from a docs file."""
|
||||||
full_path = DOCS_DIR / file_path
|
full_path = DOCS_DIR / file_path
|
||||||
with open(full_path) as f:
|
with open(full_path, encoding="utf-8") as f:
|
||||||
return f.read()
|
return f.read()
|
||||||
|
|
||||||
|
|
||||||
@@ -86,11 +94,12 @@ def decode_content(content_b64: str) -> str:
|
|||||||
|
|
||||||
|
|
||||||
def list_wiki_pages(client: GiteaClient) -> dict[str, str]:
|
def list_wiki_pages(client: GiteaClient) -> dict[str, str]:
|
||||||
"""List existing wiki pages, returning {title: sub_url}."""
|
"""List existing wiki pages, returning {title: sub_url}.
|
||||||
try:
|
|
||||||
|
Raises :class:`APIError` if the wiki API is unavailable — the caller
|
||||||
|
is responsible for retrying or handling the failure.
|
||||||
|
"""
|
||||||
pages = client._request("GET", "/wiki/pages").json()
|
pages = client._request("GET", "/wiki/pages").json()
|
||||||
except APIError:
|
|
||||||
return {}
|
|
||||||
return {page.get("title", ""): page.get("sub_url", page.get("title", "")) for page in pages}
|
return {page.get("title", ""): page.get("sub_url", page.get("title", "")) for page in pages}
|
||||||
|
|
||||||
|
|
||||||
@@ -161,6 +170,28 @@ def verify_wiki_page(
|
|||||||
return actual.strip() == expected_content.strip()
|
return actual.strip() == expected_content.strip()
|
||||||
|
|
||||||
|
|
||||||
|
def _list_wiki_pages_with_retry(client: GiteaClient) -> dict[str, str]:
|
||||||
|
"""List wiki pages with tenacity retry on APIError.
|
||||||
|
|
||||||
|
The Gitea API can be briefly unavailable right after a batch of wiki
|
||||||
|
page updates. Uses the same tenacity pattern as ``api_clients`` for
|
||||||
|
exponential backoff.
|
||||||
|
"""
|
||||||
|
_logger = logging.getLogger("sync_wiki")
|
||||||
|
|
||||||
|
@retry(
|
||||||
|
stop=stop_after_attempt(3),
|
||||||
|
wait=wait_exponential(multiplier=2, min=2, max=8),
|
||||||
|
retry=retry_if_exception_type(APIError),
|
||||||
|
before_sleep=before_sleep_log(_logger, logging.WARNING),
|
||||||
|
reraise=True,
|
||||||
|
)
|
||||||
|
def _do_list() -> dict[str, str]:
|
||||||
|
return list_wiki_pages(client)
|
||||||
|
|
||||||
|
return _do_list()
|
||||||
|
|
||||||
|
|
||||||
def verify_wiki_integrity(
|
def verify_wiki_integrity(
|
||||||
client: GiteaClient,
|
client: GiteaClient,
|
||||||
mapping: dict[str, str],
|
mapping: dict[str, str],
|
||||||
@@ -176,9 +207,25 @@ def verify_wiki_integrity(
|
|||||||
5. Page count matches
|
5. Page count matches
|
||||||
|
|
||||||
Returns a list of failure messages (empty if all checks pass).
|
Returns a list of failure messages (empty if all checks pass).
|
||||||
|
If the wiki API is temporarily unavailable (all retry attempts
|
||||||
|
fail), returns an empty list with a warning — the sync itself
|
||||||
|
already succeeded, so a transient API outage should not fail the job.
|
||||||
"""
|
"""
|
||||||
failures: list[str] = []
|
failures: list[str] = []
|
||||||
existing_pages = list_wiki_pages(client)
|
|
||||||
|
try:
|
||||||
|
existing_pages = _list_wiki_pages_with_retry(client)
|
||||||
|
except APIError:
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"WARNING: Could not fetch wiki page list after retries. "
|
||||||
|
"The sync itself succeeded ({count} pages updated), but the "
|
||||||
|
"integrity check could not verify them due to a transient API issue.",
|
||||||
|
count=len(synced),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return []
|
||||||
|
|
||||||
expected_titles = set(mapping.values())
|
expected_titles = set(mapping.values())
|
||||||
|
|
||||||
# Check 1: Page count
|
# Check 1: Page count
|
||||||
@@ -225,13 +272,13 @@ def verify_wiki_integrity(
|
|||||||
help="Full integrity check: verify page count, missing pages, stale pages, and content. Implies --verify.",
|
help="Full integrity check: verify page count, missing pages, stale pages, and content. Implies --verify.",
|
||||||
)
|
)
|
||||||
def main(dry_run: bool, repo: str | None, verify: bool, strict: bool) -> None:
|
def main(dry_run: bool, repo: str | None, verify: bool, strict: bool) -> None:
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not token:
|
if not token:
|
||||||
raise click.ClickException(_("ERROR: REPO_TOKEN is not set."))
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
||||||
|
|
||||||
if repo is None:
|
if repo is None:
|
||||||
owner = os.environ.get("DEVX_REPO_OWNER", "oblachno-oss")
|
owner = os.environ.get("DEVX_REPO_OWNER", "") or REPO_OWNER
|
||||||
repo_name = os.environ.get("DEVX_REPO_NAME", "devx")
|
repo_name = os.environ.get("DEVX_REPO_NAME", "") or REPO_NAME
|
||||||
else:
|
else:
|
||||||
owner, repo_name = repo.split("/")
|
owner, repo_name = repo.split("/")
|
||||||
|
|
||||||
@@ -243,7 +290,10 @@ def main(dry_run: bool, repo: str | None, verify: bool, strict: bool) -> None:
|
|||||||
|
|
||||||
click.echo(_("Syncing {count} documentation pages to wiki...", count=len(mapping)))
|
click.echo(_("Syncing {count} documentation pages to wiki...", count=len(mapping)))
|
||||||
|
|
||||||
|
try:
|
||||||
existing_pages = list_wiki_pages(client)
|
existing_pages = list_wiki_pages(client)
|
||||||
|
except APIError:
|
||||||
|
existing_pages = {}
|
||||||
if existing_pages:
|
if existing_pages:
|
||||||
click.echo(_("Found {count} existing wiki pages.", count=len(existing_pages)))
|
click.echo(_("Found {count} existing wiki pages.", count=len(existing_pages)))
|
||||||
|
|
||||||
@@ -302,7 +352,16 @@ def main(dry_run: bool, repo: str | None, verify: bool, strict: bool) -> None:
|
|||||||
else:
|
else:
|
||||||
click.echo(_("\nVerifying wiki pages have content..."))
|
click.echo(_("\nVerifying wiki pages have content..."))
|
||||||
# Re-fetch the page list to get updated sub_urls
|
# Re-fetch the page list to get updated sub_urls
|
||||||
existing_pages = list_wiki_pages(client)
|
try:
|
||||||
|
existing_pages = _list_wiki_pages_with_retry(client)
|
||||||
|
except APIError:
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"WARNING: Could not re-fetch wiki page list for verification. "
|
||||||
|
"Skipping content verification due to transient API issue."
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return
|
||||||
failures = 0
|
failures = 0
|
||||||
for page_title, expected_content in sorted(synced.items()):
|
for page_title, expected_content in sorted(synced.items()):
|
||||||
ok = verify_wiki_page(client, page_title, expected_content, existing_pages)
|
ok = verify_wiki_page(client, page_title, expected_content, existing_pages)
|
||||||
|
|||||||
@@ -69,7 +69,7 @@ def main(commit_msg_file: str | None, branch: str | None, from_git: bool) -> Non
|
|||||||
if commit_msg_file == "-":
|
if commit_msg_file == "-":
|
||||||
msg = sys.stdin.read().strip()
|
msg = sys.stdin.read().strip()
|
||||||
else:
|
else:
|
||||||
with open(commit_msg_file) as f:
|
with open(commit_msg_file, encoding="utf-8") as f:
|
||||||
msg = f.read().strip()
|
msg = f.read().strip()
|
||||||
else:
|
else:
|
||||||
raise click.ClickException(_("Provide a commit message file or use --git."))
|
raise click.ClickException(_("Provide a commit message file or use --git."))
|
||||||
|
|||||||
@@ -95,6 +95,13 @@ def ci_doc_coverage(args: tuple[str, ...]) -> None:
|
|||||||
_run_module("devx.ci.doc_coverage", list(args))
|
_run_module("devx.ci.doc_coverage", list(args))
|
||||||
|
|
||||||
|
|
||||||
|
@ci.command("lint-docs")
|
||||||
|
@click.argument("args", nargs=-1)
|
||||||
|
def ci_lint_docs(args: tuple[str, ...]) -> None:
|
||||||
|
"""Lint documentation files for structure, links, and quality."""
|
||||||
|
_run_module("devx.ci.lint_docs", list(args))
|
||||||
|
|
||||||
|
|
||||||
@ci.command("notify-failure")
|
@ci.command("notify-failure")
|
||||||
@click.argument("args", nargs=-1)
|
@click.argument("args", nargs=-1)
|
||||||
def ci_notify_failure(args: tuple[str, ...]) -> None:
|
def ci_notify_failure(args: tuple[str, ...]) -> None:
|
||||||
@@ -219,6 +226,20 @@ def tools_setup(args: tuple[str, ...]) -> None:
|
|||||||
_run_module("devx.tools.setup", list(args))
|
_run_module("devx.tools.setup", list(args))
|
||||||
|
|
||||||
|
|
||||||
|
@tools.command("rebase")
|
||||||
|
@click.argument("args", nargs=-1)
|
||||||
|
def tools_rebase(args: tuple[str, ...]) -> None:
|
||||||
|
"""Rebase current branch onto origin/master and force-push."""
|
||||||
|
_run_module("devx.tools.rebase", list(args))
|
||||||
|
|
||||||
|
|
||||||
|
@tools.command("pr-rebase")
|
||||||
|
@click.argument("args", nargs=-1)
|
||||||
|
def tools_pr_rebase(args: tuple[str, ...]) -> None:
|
||||||
|
"""Rebase a PR's head branch onto master via Gitea API (server-side)."""
|
||||||
|
_run_module("devx.tools.pr_rebase", list(args))
|
||||||
|
|
||||||
|
|
||||||
@cli.group()
|
@cli.group()
|
||||||
def molecule() -> None:
|
def molecule() -> None:
|
||||||
"""Molecule testing commands (requires devx[molecule])."""
|
"""Molecule testing commands (requires devx[molecule])."""
|
||||||
|
|||||||
@@ -74,6 +74,7 @@ VIKUNJA_API_URL = _get("vikunja_api_url", "DEVX_VIKUNJA_API_URL", "https://work.
|
|||||||
# Organization defaults — each project MUST set DEVX_REPO_OWNER explicitly.
|
# Organization defaults — each project MUST set DEVX_REPO_OWNER explicitly.
|
||||||
# No default: prevents silent 404s when the wrong owner is used.
|
# No default: prevents silent 404s when the wrong owner is used.
|
||||||
REPO_OWNER = _get("repo_owner", "DEVX_REPO_OWNER", "")
|
REPO_OWNER = _get("repo_owner", "DEVX_REPO_OWNER", "")
|
||||||
|
REPO_NAME = _get("repo_name", "DEVX_REPO_NAME", "")
|
||||||
|
|
||||||
# Task prefix for Vikunja task IDs — each project sets its own (GRM, DEVX, INFRA, etc.)
|
# Task prefix for Vikunja task IDs — each project sets its own (GRM, DEVX, INFRA, etc.)
|
||||||
TASK_PREFIX = _get("task_prefix", "DEVX_TASK_PREFIX", "DEVX")
|
TASK_PREFIX = _get("task_prefix", "DEVX_TASK_PREFIX", "DEVX")
|
||||||
|
|||||||
@@ -56,10 +56,10 @@ class TeaCLIError(Exception):
|
|||||||
|
|
||||||
|
|
||||||
def configure_tea_login(login_name: str = "devx") -> None:
|
def configure_tea_login(login_name: str = "devx") -> None:
|
||||||
"""Configure tea CLI login from REPO_TOKEN and DEVX_GITEA_API_URL.
|
"""Configure tea CLI login from CI_GITEA_TOKEN and DEVX_GITEA_API_URL.
|
||||||
|
|
||||||
Idempotent: if a login with the same name already exists, it is not re-added.
|
Idempotent: if a login with the same name already exists, it is not re-added.
|
||||||
Skips silently if tea is not installed or REPO_TOKEN is not set.
|
Skips silently if tea is not installed or CI_GITEA_TOKEN is not set.
|
||||||
|
|
||||||
Used by CI scripts (publish, notify_failure) that need tea login but
|
Used by CI scripts (publish, notify_failure) that need tea login but
|
||||||
run in containerized environments where ``make setup`` was not called.
|
run in containerized environments where ``make setup`` was not called.
|
||||||
@@ -69,9 +69,9 @@ def configure_tea_login(login_name: str = "devx") -> None:
|
|||||||
click.echo(_("tea not installed — skipping login configuration."))
|
click.echo(_("tea not installed — skipping login configuration."))
|
||||||
return
|
return
|
||||||
|
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not token:
|
if not token:
|
||||||
click.echo(_("REPO_TOKEN not set — skipping login configuration."))
|
click.echo(_("CI_GITEA_TOKEN not set — skipping login configuration."))
|
||||||
return
|
return
|
||||||
|
|
||||||
gitea_url = GITEA_API_URL.replace("/api/v1", "")
|
gitea_url = GITEA_API_URL.replace("/api/v1", "")
|
||||||
|
|||||||
+130
-26
@@ -51,25 +51,67 @@ DEVX_GITEA_PYPI_HOST ?= git.oblachno.oblachno.fyi
|
|||||||
DEVX_GITEA_PYPI_ORG ?= oblachno-oss
|
DEVX_GITEA_PYPI_ORG ?= oblachno-oss
|
||||||
DEVX_ACTIONLINT_CFG ?= .gitea/actionlint.yaml
|
DEVX_ACTIONLINT_CFG ?= .gitea/actionlint.yaml
|
||||||
DEVX_WORKFLOW_DIR ?= .gitea/workflows
|
DEVX_WORKFLOW_DIR ?= .gitea/workflows
|
||||||
|
DEVX_DOCKERFILE_PATHS ?= docker
|
||||||
|
|
||||||
# PIP_INSTALL — helper to run pip with Gitea private PyPI registry configured.
|
# PIP_INSTALL — helper to run pip with Gitea private PyPI registry configured.
|
||||||
# Usage: $(DEVX_PIP_INSTALL) install -e '.[ci,lint]'
|
# Usage: $(DEVX_PIP_INSTALL) install -e '.[ci,lint]'
|
||||||
# GITEA_PYPI_USER can be set in .env, as an env var, or as a Make variable.
|
# CI_GITEA_USERNAME can be set in .env, as an env var, or as a Make variable.
|
||||||
DEVX_PIP_INSTALL := if [ -z "$$REPO_TOKEN" ]; then . ./.env 2>/dev/null; fi; \
|
# Projects can alias: PIP_INSTALL = $(DEVX_PIP_INSTALL)
|
||||||
REPO_TOKEN="$${REPO_TOKEN:-$$GITEA_REGISTRY_TOKEN}"; \
|
DEVX_PIP_INSTALL := if [ -z "$$CI_GITEA_TOKEN" ]; then . ./.env 2>/dev/null; fi; \
|
||||||
_PYPI_USER="$${DEVX_GITEA_PYPI_USER:-$${GITEA_PYPI_USER}}"; \
|
CI_GITEA_TOKEN="$$CI_GITEA_TOKEN"; \
|
||||||
if [ -n "$$REPO_TOKEN" ] && [ -n "$$_PYPI_USER" ]; then export PIP_EXTRA_INDEX_URL="https://$$_PYPI_USER:$$REPO_TOKEN@$(DEVX_GITEA_PYPI_HOST)/api/packages/$(DEVX_GITEA_PYPI_ORG)/pypi/simple/"; fi; \
|
_PYPI_USER="$${CI_GITEA_USERNAME:-emil}"; \
|
||||||
|
if [ -n "$$CI_GITEA_TOKEN" ] && [ -n "$$_PYPI_USER" ]; then export PIP_EXTRA_INDEX_URL="https://$$_PYPI_USER:$$CI_GITEA_TOKEN@$(DEVX_GITEA_PYPI_HOST)/api/packages/$(DEVX_GITEA_PYPI_ORG)/pypi/simple/"; fi; \
|
||||||
$(DEVX_BIN)/pip
|
$(DEVX_BIN)/pip
|
||||||
|
|
||||||
|
# ── Virtual environment management ────────────────────────────────────────────
|
||||||
|
#
|
||||||
|
# These targets provide a single, consistent venv setup across all
|
||||||
|
# devx-integrated projects (infra, grm, devx). Each project includes
|
||||||
|
# devx.mak and aliases its local targets to these.
|
||||||
|
#
|
||||||
|
# The venv is a standard .venv directory (no pyenv virtualenv dependency).
|
||||||
|
# pyenv can still be used to install Python 3.12+ but the venv itself
|
||||||
|
# is created with `python3 -m venv .venv`.
|
||||||
|
#
|
||||||
|
# Projects should set these variables BEFORE including devx.mak:
|
||||||
|
# DEVX_VENV — venv directory (default: .venv)
|
||||||
|
# DEVX_BIN — venv bin directory (default: $(DEVX_VENV)/bin)
|
||||||
|
# DEVX_PYTHON — Python executable (default: python3; should be $(DEVX_BIN)/python after setup)
|
||||||
|
#
|
||||||
|
# Common aliases in project Makefiles:
|
||||||
|
# PIP_INSTALL = $(DEVX_PIP_INSTALL)
|
||||||
|
# venv: devx-venv
|
||||||
|
# activate-scripts: devx-activate-scripts
|
||||||
|
# .env: devx-env
|
||||||
|
|
||||||
|
# Create .venv with Python version check (3.12+ required)
|
||||||
|
$(DEVX_VENV)/bin/activate:
|
||||||
|
@python3 -c "import sys; v=sys.version_info; assert v >= (3, 12), f'Python 3.12+ required, found {v.major}.{v.minor}'; print(f'Python {v.major}.{v.minor}.{v.micro} OK')"
|
||||||
|
python3 -m venv $(DEVX_VENV)
|
||||||
|
$(DEVX_BIN)/pip install --upgrade pip setuptools wheel
|
||||||
|
|
||||||
|
# Alias: devx-venv creates the venv (delegates to the activate rule)
|
||||||
|
devx-venv: $(DEVX_VENV)/bin/activate
|
||||||
|
|
||||||
|
# Ensure a venv exists — in CI (no pyenv), creates .venv if missing.
|
||||||
|
# Locally, uses the existing .venv (created by `make setup` or `make devx-venv`).
|
||||||
|
devx-ensure-venv:
|
||||||
|
@if [ ! -f $(DEVX_BIN)/python ]; then \
|
||||||
|
echo "[ensure-venv] Creating $(DEVX_VENV) (no venv found)..."; \
|
||||||
|
python3 -m venv $(DEVX_VENV); \
|
||||||
|
$(DEVX_BIN)/pip install --upgrade pip setuptools wheel; \
|
||||||
|
fi
|
||||||
|
|
||||||
.PHONY: devx-create-task devx-create-pr devx-push devx-push-with-pr devx-check-config
|
.PHONY: devx-create-task devx-create-pr devx-push devx-push-with-pr devx-check-config
|
||||||
|
.PHONY: devx-pr-status devx-pr-logs devx-pr-label devx-pr-review devx-rebase devx-pr-rebase
|
||||||
.PHONY: devx-configure-gitea-pypi devx-install-tools devx-install-checkmake devx-checkmake
|
.PHONY: devx-configure-gitea-pypi devx-install-tools devx-install-checkmake devx-checkmake
|
||||||
.PHONY: devx-workflow-lint devx-workflow-dryrun devx-workflow-dryrun-safe devx-workflow-check
|
.PHONY: devx-workflow-lint devx-workflow-dryrun devx-workflow-dryrun-safe devx-workflow-check
|
||||||
.PHONY: devx-notify-failure devx-install-hooks devx-activate-scripts
|
.PHONY: devx-notify-failure devx-install-hooks devx-activate-scripts devx-venv devx-ensure-venv
|
||||||
.PHONY: devx-lint-ruff devx-lint-format devx-typecheck devx-lint-bandit devx-lint-deps devx-lint
|
.PHONY: devx-lint-ruff devx-lint-format devx-typecheck devx-lint-bandit devx-lint-deps devx-lint
|
||||||
.PHONY: devx-clean devx-pre-push
|
.PHONY: devx-clean devx-pre-push
|
||||||
.PHONY: devx-check-mutable-globals devx-check-dep-docs devx-check-test-coverage devx-check-docs devx-check-test-speed
|
.PHONY: devx-check-mutable-globals devx-check-dep-docs devx-check-test-coverage devx-check-docs devx-check-test-speed
|
||||||
.PHONY: devx-test-unit devx-pytest-cov
|
.PHONY: devx-test-unit devx-pytest-cov
|
||||||
.PHONY: devx-setup-image
|
.PHONY: devx-setup-image devx-lint-dockerfiles
|
||||||
|
|
||||||
# ── Vikunja task and PR management ────────────────────────────────────────────
|
# ── Vikunja task and PR management ────────────────────────────────────────────
|
||||||
|
|
||||||
@@ -93,15 +135,68 @@ devx-check-config:
|
|||||||
# Push and create PR in one step
|
# Push and create PR in one step
|
||||||
devx-push-with-pr: devx-push devx-create-pr
|
devx-push-with-pr: devx-push devx-create-pr
|
||||||
|
|
||||||
|
# Check CI status for a PR (auto-detects current branch's PR)
|
||||||
|
# Usage: make devx-pr-status
|
||||||
|
# make devx-pr-status PR=42
|
||||||
|
# make devx-pr-status PR=42 WAIT=1 TIMEOUT=600
|
||||||
|
devx-pr-status:
|
||||||
|
@$(DEVX_PYTHON) -m devx.tools.pr_status \
|
||||||
|
$(if $(PR),--pr $(PR)) \
|
||||||
|
$(if $(WAIT),--wait) \
|
||||||
|
$(if $(TIMEOUT),--timeout $(TIMEOUT))
|
||||||
|
|
||||||
|
# Fetch logs for failed CI jobs on a PR
|
||||||
|
# Usage: make devx-pr-logs
|
||||||
|
# make devx-pr-logs PR=42
|
||||||
|
# make devx-pr-logs PR=42 JOB=quality TAIL=50
|
||||||
|
devx-pr-logs:
|
||||||
|
@$(DEVX_PYTHON) -m devx.tools.pr_logs \
|
||||||
|
$(if $(PR),--pr $(PR)) \
|
||||||
|
$(if $(JOB),--job $(JOB)) \
|
||||||
|
$(if $(TAIL),--tail $(TAIL))
|
||||||
|
|
||||||
|
# Add a label to a PR (default: ready-to-merge)
|
||||||
|
# Usage: make devx-pr-label
|
||||||
|
# make devx-pr-label PR=42
|
||||||
|
# make devx-pr-label PR=42 LABEL=ready-to-merge
|
||||||
|
devx-pr-label:
|
||||||
|
@$(DEVX_PYTHON) -m devx.tools.pr_label \
|
||||||
|
$(if $(PR),--pr $(PR)) \
|
||||||
|
--label $(or $(LABEL),ready-to-merge)
|
||||||
|
|
||||||
|
# Usage: make devx-pr-review PR=42 EVENT=APPROVE BODY="..." CHECKLIST=1,2,3,4,5,6,7,8,9,10,11,12,13
|
||||||
|
# make devx-pr-review PR=42 EVENT=REQUEST_CHANGES BODY="..."
|
||||||
|
# make devx-pr-review PR=42 (auto review)
|
||||||
|
devx-pr-review:
|
||||||
|
@$(DEVX_PYTHON) -m devx.ci.pr_review \
|
||||||
|
$(PR) $(DEVX_REPO_OWNER)/$(DEVX_REPO_NAME) \
|
||||||
|
$(if $(EVENT),--event $(EVENT)) \
|
||||||
|
$(if $(BODY),--body "$(BODY)") \
|
||||||
|
$(if $(CHECKLIST),--checklist-confirmed --checklist-categories $(CHECKLIST))
|
||||||
|
|
||||||
|
# Rebase current branch onto origin/master and force-push
|
||||||
|
# Usage: make devx-rebase
|
||||||
|
# make devx-rebase NO_PUSH=1
|
||||||
|
devx-rebase:
|
||||||
|
@$(DEVX_PYTHON) -m devx.tools.rebase \
|
||||||
|
$(if $(NO_PUSH),--no-push)
|
||||||
|
|
||||||
|
# Rebase a PR's head branch via Gitea API (server-side, no local git needed)
|
||||||
|
# Usage: make devx-pr-rebase
|
||||||
|
# make devx-pr-rebase PR=42
|
||||||
|
devx-pr-rebase:
|
||||||
|
@$(DEVX_PYTHON) -m devx.tools.pr_rebase \
|
||||||
|
$(if $(PR),--pr $(PR))
|
||||||
|
|
||||||
# ── Environment setup ─────────────────────────────────────────────────────────
|
# ── Environment setup ─────────────────────────────────────────────────────────
|
||||||
|
|
||||||
# Configure Gitea private PyPI registry so pip can find devx and other
|
# Configure Gitea private PyPI registry so pip can find devx and other
|
||||||
# private packages. In CI, REPO_TOKEN is set as a secret. Locally, it's in .env.
|
# private packages. In CI, CI_GITEA_TOKEN is set as a secret. Locally, it's in .env.
|
||||||
devx-configure-gitea-pypi:
|
devx-configure-gitea-pypi:
|
||||||
@if [ -z "$$REPO_TOKEN" ]; then . ./.env 2>/dev/null; fi; \
|
@if [ -z "$$CI_GITEA_TOKEN" ]; then . ./.env 2>/dev/null; fi; \
|
||||||
REPO_TOKEN="$${REPO_TOKEN:-$$GITEA_REGISTRY_TOKEN}"; \
|
CI_GITEA_TOKEN="$$CI_GITEA_TOKEN"; \
|
||||||
if [ -z "$$REPO_TOKEN" ]; then echo "[configure-gitea-pypi] REPO_TOKEN not set — skipping (devx must be on public PyPI)"; exit 0; fi; \
|
if [ -z "$$CI_GITEA_TOKEN" ]; then echo "[configure-gitea-pypi] CI_GITEA_TOKEN not set — skipping (devx must be on public PyPI)"; exit 0; fi; \
|
||||||
echo "[configure-gitea-pypi] Gitea PyPI registry configured (REPO_TOKEN present)."
|
echo "[configure-gitea-pypi] Gitea PyPI registry configured (CI_GITEA_TOKEN present)."
|
||||||
|
|
||||||
# Create .env from .env.example if it doesn't exist
|
# Create .env from .env.example if it doesn't exist
|
||||||
devx-env:
|
devx-env:
|
||||||
@@ -110,12 +205,6 @@ devx-env:
|
|||||||
echo "Created .env from .env.example — please edit it with your credentials."; \
|
echo "Created .env from .env.example — please edit it with your credentials."; \
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Create Python venv with version check
|
|
||||||
devx-venv:
|
|
||||||
@python3 -c "import sys; v=sys.version_info; assert v >= (3, 12), f'Python 3.12+ required, found {v.major}.{v.minor}'; print(f'Python {v.major}.{v.minor}.{v.micro} OK')"
|
|
||||||
$(DEVX_PYTHON) -m venv $(DEVX_VENV)
|
|
||||||
$(DEVX_BIN)/pip install --upgrade pip setuptools wheel
|
|
||||||
|
|
||||||
# Create activate scripts for shell/fish/zsh
|
# Create activate scripts for shell/fish/zsh
|
||||||
devx-activate-scripts:
|
devx-activate-scripts:
|
||||||
@test -f activate.sh || (echo '#!/usr/bin/env bash' > activate.sh && echo 'source "$$(cd "$$(dirname "$${BASH_SOURCE[0]}")" && pwd)/.venv/bin/activate"' >> activate.sh && chmod +x activate.sh)
|
@test -f activate.sh || (echo '#!/usr/bin/env bash' > activate.sh && echo 'source "$$(cd "$$(dirname "$${BASH_SOURCE[0]}")" && pwd)/.venv/bin/activate"' >> activate.sh && chmod +x activate.sh)
|
||||||
@@ -174,7 +263,7 @@ devx-workflow-check: devx-workflow-lint devx-workflow-dryrun
|
|||||||
|
|
||||||
# Notify on CI failure — creates a Gitea issue via devx.ci.notify_failure.
|
# Notify on CI failure — creates a Gitea issue via devx.ci.notify_failure.
|
||||||
# Usage: make devx-notify-failure WORKFLOW=post-merge/release
|
# Usage: make devx-notify-failure WORKFLOW=post-merge/release
|
||||||
# Requires: REPO_TOKEN, GITHUB_REPOSITORY, GITHUB_RUN_ID, GITHUB_SHA
|
# Requires: CI_GITEA_TOKEN, GITHUB_REPOSITORY, GITHUB_RUN_ID, GITHUB_SHA
|
||||||
devx-notify-failure:
|
devx-notify-failure:
|
||||||
@. $(DEVX_VENV)/bin/activate 2>/dev/null || true; \
|
@. $(DEVX_VENV)/bin/activate 2>/dev/null || true; \
|
||||||
export PATH="$(HOME)/.local/bin:$$PATH"; \
|
export PATH="$(HOME)/.local/bin:$$PATH"; \
|
||||||
@@ -211,7 +300,7 @@ devx-lint: devx-lint-ruff devx-lint-format devx-typecheck devx-lint-bandit
|
|||||||
# ── Testing ───────────────────────────────────────────────────────────────────
|
# ── Testing ───────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
devx-test-unit:
|
devx-test-unit:
|
||||||
@$(DEVX_BIN)/pytest $(DEVX_TEST_PATHS) -v --no-cov
|
@$(DEVX_BIN)/pytest $(DEVX_TEST_PATHS) -q --no-cov
|
||||||
|
|
||||||
devx-pytest-cov:
|
devx-pytest-cov:
|
||||||
@$(DEVX_BIN)/pytest $(DEVX_TEST_PATHS) -v --cov=$(DEVX_COV_PKG) --cov-report=term-missing --cov-fail-under=100
|
@$(DEVX_BIN)/pytest $(DEVX_TEST_PATHS) -v --cov=$(DEVX_COV_PKG) --cov-report=term-missing --cov-fail-under=100
|
||||||
@@ -251,6 +340,25 @@ devx-clean:
|
|||||||
@find . -type f -name "*.pyc" -delete 2>/dev/null || true
|
@find . -type f -name "*.pyc" -delete 2>/dev/null || true
|
||||||
@rm -rf .coverage htmlcov/ dist/ build/ *.egg-info/ .molecule/ 2>/dev/null || true
|
@rm -rf .coverage htmlcov/ dist/ build/ *.egg-info/ .molecule/ 2>/dev/null || true
|
||||||
|
|
||||||
|
# ── Dockerfile linting ────────────────────────────────────────────────────────
|
||||||
|
#
|
||||||
|
# Lint Dockerfiles with hadolint. Fails fast if hadolint is not installed
|
||||||
|
# (no silent skip). Set DEVX_DOCKERFILE_PATHS to the directory containing
|
||||||
|
# your Dockerfiles (default: docker).
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
# make devx-lint-dockerfiles (lints docker/ directory)
|
||||||
|
# make devx-lint-dockerfiles DEVX_DOCKERFILE_PATHS=ansible (lints ansible/)
|
||||||
|
|
||||||
|
devx-lint-dockerfiles:
|
||||||
|
@echo "[devx-lint-dockerfiles] Linting Dockerfiles with hadolint..."
|
||||||
|
@if ! command -v hadolint >/dev/null 2>&1; then \
|
||||||
|
echo "[devx-lint-dockerfiles] ERROR: hadolint not found. Install from https://github.com/hadolint/hadolint/releases" >&2; \
|
||||||
|
exit 1; \
|
||||||
|
fi
|
||||||
|
@find $(DEVX_DOCKERFILE_PATHS) -name 'Dockerfile*' -exec hadolint {} +
|
||||||
|
@echo "[devx-lint-dockerfiles] All Dockerfiles passed."
|
||||||
|
|
||||||
# ── Pre-built image setup ─────────────────────────────────────────────────────
|
# ── Pre-built image setup ─────────────────────────────────────────────────────
|
||||||
#
|
#
|
||||||
# When running inside a pre-built Docker runner image (ci-base, ci-quality,
|
# When running inside a pre-built Docker runner image (ci-base, ci-quality,
|
||||||
@@ -267,12 +375,8 @@ devx-clean:
|
|||||||
# devx-setup-ci) — each project defines its own setup-ci target.
|
# devx-setup-ci) — each project defines its own setup-ci target.
|
||||||
|
|
||||||
devx-setup-image:
|
devx-setup-image:
|
||||||
@if [ -d /opt/venv ]; then ln -sf /opt/venv $(DEVX_VENV); . $(DEVX_BIN)/activate; \
|
@/opt/venv/bin/python -m devx.tools.setup_image --venv $(DEVX_VENV) --extras "$(EXTRAS)" \
|
||||||
_U="$${DEVX_GITEA_PYPI_USER:-$${GITEA_PYPI_USER:-emil}}"; \
|
--gitea-host $(DEVX_GITEA_PYPI_HOST) --gitea-org $(DEVX_GITEA_PYPI_ORG)
|
||||||
if [ -n "$$REPO_TOKEN" ]; then export PIP_EXTRA_INDEX_URL="https://$$_U:$$REPO_TOKEN@$(DEVX_GITEA_PYPI_HOST)/api/packages/$(DEVX_GITEA_PYPI_ORG)/pypi/simple/"; fi; \
|
|
||||||
pip install -e .$(if $(EXTRAS),[$(EXTRAS)],); \
|
|
||||||
echo "[devx-setup-image] Linked /opt/venv$(if $(EXTRAS), with [$(EXTRAS)],)."; \
|
|
||||||
else echo "[devx-setup-image] /opt/venv not found — falling back to setup-ci"; $(MAKE) setup-ci; fi
|
|
||||||
|
|
||||||
# ── Docker image build / push / cleanup ───────────────────────────────────────
|
# ── Docker image build / push / cleanup ───────────────────────────────────────
|
||||||
#
|
#
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
"""Molecule testing helpers for Ansible projects."""
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ import os
|
|||||||
import click
|
import click
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
from devx.config import GITEA_API_URL
|
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
|
||||||
|
|
||||||
DEFAULT_MAX_RUNNERS = 3
|
DEFAULT_MAX_RUNNERS = 3
|
||||||
|
|
||||||
@@ -142,12 +142,12 @@ def main(
|
|||||||
output_indices: bool,
|
output_indices: bool,
|
||||||
github_output: bool,
|
github_output: bool,
|
||||||
) -> None:
|
) -> None:
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
|
|
||||||
if owner is None:
|
if owner is None:
|
||||||
owner = os.environ.get("DEVX_REPO_OWNER", "oblachno-oss")
|
owner = os.environ.get("DEVX_REPO_OWNER", "") or REPO_OWNER
|
||||||
if repo is None:
|
if repo is None:
|
||||||
repo = os.environ.get("DEVX_REPO_NAME", "devx")
|
repo = os.environ.get("DEVX_REPO_NAME", "") or REPO_NAME
|
||||||
|
|
||||||
count = get_runner_count(GITEA_API_URL, token, owner, repo)
|
count = get_runner_count(GITEA_API_URL, token, owner, repo)
|
||||||
indices = generate_indices(count)
|
indices = generate_indices(count)
|
||||||
@@ -156,7 +156,7 @@ def main(
|
|||||||
gh_output = os.environ.get("GITHUB_OUTPUT")
|
gh_output = os.environ.get("GITHUB_OUTPUT")
|
||||||
if not gh_output:
|
if not gh_output:
|
||||||
raise click.ClickException("GITHUB_OUTPUT environment variable is not set")
|
raise click.ClickException("GITHUB_OUTPUT environment variable is not set")
|
||||||
with open(gh_output, "a") as f: # noqa: PTH123
|
with open(gh_output, "a", encoding="utf-8") as f: # noqa: PTH123
|
||||||
f.write(f"runner-count={count}\n")
|
f.write(f"runner-count={count}\n")
|
||||||
f.write(f"runner-indices={json.dumps(indices)}\n")
|
f.write(f"runner-indices={json.dumps(indices)}\n")
|
||||||
click.echo(f"Runner count: {count}")
|
click.echo(f"Runner count: {count}")
|
||||||
|
|||||||
@@ -25,6 +25,7 @@ from pathlib import Path
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
|
from devx.ci._shared import lpt_distribute, write_github_env
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
from devx.molecule.platforms import PLATFORMS, load_platforms
|
from devx.molecule.platforms import PLATFORMS, load_platforms
|
||||||
|
|
||||||
@@ -216,22 +217,8 @@ def _scenario_weight(scenario: str, role: str | None = None) -> int:
|
|||||||
|
|
||||||
|
|
||||||
def _lpt_distribute[T](items: list[T], weights: list[int], max_runners: int) -> list[list[T]]:
|
def _lpt_distribute[T](items: list[T], weights: list[int], max_runners: int) -> list[list[T]]:
|
||||||
"""Distribute *items* across *max_runners* using LPT (Longest Processing Time first).
|
"""Distribute *items* across *max_runners* using LPT (delegates to shared utility)."""
|
||||||
|
return lpt_distribute(items, weights, max_runners)
|
||||||
Sorts items by weight (descending), then assigns each to the runner
|
|
||||||
with the least total weight. This produces a more balanced distribution
|
|
||||||
than naive round-robin when items have varying costs.
|
|
||||||
"""
|
|
||||||
groups: list[list[T]] = [[] for _ in range(max_runners)]
|
|
||||||
loads = [0] * max_runners
|
|
||||||
# Sort by weight descending, preserving original order for ties
|
|
||||||
indexed = sorted(enumerate(items), key=lambda x: (-weights[x[0]], x[0]))
|
|
||||||
for orig_idx, item in indexed:
|
|
||||||
# Find the runner with the minimum load
|
|
||||||
min_runner = min(range(max_runners), key=lambda r: loads[r])
|
|
||||||
groups[min_runner].append(item)
|
|
||||||
loads[min_runner] += weights[orig_idx]
|
|
||||||
return groups
|
|
||||||
|
|
||||||
|
|
||||||
def distribute_multi_role(pairs: list[MultiRoleTestPair], max_runners: int) -> list[list[MultiRoleTestPair]]:
|
def distribute_multi_role(pairs: list[MultiRoleTestPair], max_runners: int) -> list[list[MultiRoleTestPair]]:
|
||||||
@@ -283,14 +270,8 @@ def pairs_for_runner(pairs: list[TestPair], runner_index: int, max_runners: int)
|
|||||||
|
|
||||||
|
|
||||||
def _write_github_env(key: str, value: str) -> None:
|
def _write_github_env(key: str, value: str) -> None:
|
||||||
"""Append a key=value line to the $GITHUB_ENV file."""
|
"""Append a key=value line to the $GITHUB_ENV file (delegates to shared utility)."""
|
||||||
import os
|
write_github_env(key, value)
|
||||||
|
|
||||||
gh_env = os.environ.get("GITHUB_ENV")
|
|
||||||
if not gh_env:
|
|
||||||
raise click.ClickException("GITHUB_ENV environment variable is not set")
|
|
||||||
with open(gh_env, "a") as f: # noqa: PTH123
|
|
||||||
f.write(f"{key}={value}\n")
|
|
||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ Usage::
|
|||||||
|
|
||||||
Environment variables:
|
Environment variables:
|
||||||
GITEA_URL Base URL of the Gitea instance.
|
GITEA_URL Base URL of the Gitea instance.
|
||||||
REPO_TOKEN API token with repo access.
|
CI_GITEA_TOKEN API token with repo access.
|
||||||
RUN_ID Workflow run ID (GITHUB_RUN_ID).
|
RUN_ID Workflow run ID (GITHUB_RUN_ID).
|
||||||
JOB_NAME Base job name (GITHUB_JOB), e.g. "molecule-tests".
|
JOB_NAME Base job name (GITHUB_JOB), e.g. "molecule-tests".
|
||||||
MATRIX_INDEX Current matrix index (runner-index).
|
MATRIX_INDEX Current matrix index (runner-index).
|
||||||
@@ -43,6 +43,7 @@ from pathlib import Path
|
|||||||
import click
|
import click
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
|
from devx.config import REPO_NAME, REPO_OWNER
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
POLL_INTERVAL = 10
|
POLL_INTERVAL = 10
|
||||||
@@ -163,17 +164,17 @@ def resolve_role_dir(role: str, roles_root: Path | None, repo_root: Path) -> Pat
|
|||||||
def cli(pairs: tuple[str, ...], roles_root: Path | None) -> None:
|
def cli(pairs: tuple[str, ...], roles_root: Path | None) -> None:
|
||||||
"""Run molecule pairs sequentially, stop if another CI runner fails."""
|
"""Run molecule pairs sequentially, stop if another CI runner fails."""
|
||||||
gitea_url = os.environ.get("GITEA_URL", "")
|
gitea_url = os.environ.get("GITEA_URL", "")
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
run_id = int(os.environ.get("RUN_ID", "0"))
|
run_id = int(os.environ.get("RUN_ID", "0"))
|
||||||
job_name = os.environ.get("JOB_NAME", "molecule-tests")
|
job_name = os.environ.get("JOB_NAME", "molecule-tests")
|
||||||
current_index = int(os.environ.get("MATRIX_INDEX", "0"))
|
current_index = int(os.environ.get("MATRIX_INDEX", "0"))
|
||||||
repository = os.environ.get("GITEA_REPOSITORY", "oblachno-oss/devx")
|
repository = os.environ.get("GITEA_REPOSITORY", "")
|
||||||
owner, _sep, repo = repository.partition("/")
|
owner, _sep, repo = repository.partition("/")
|
||||||
if not owner or not repo:
|
if not owner or not repo:
|
||||||
owner, repo = "oblachno-oss", "devx"
|
owner, repo = REPO_OWNER, REPO_NAME
|
||||||
|
|
||||||
if not all([gitea_url, token, run_id]):
|
if not all([gitea_url, token, run_id]):
|
||||||
click.echo(_("GITEA_URL/REPO_TOKEN/RUN_ID not set; running without cross-runner cancellation."))
|
click.echo(_("GITEA_URL/CI_GITEA_TOKEN/RUN_ID not set; running without cross-runner cancellation."))
|
||||||
|
|
||||||
# When devx is installed as a pip package, __file__ resolves to the
|
# When devx is installed as a pip package, __file__ resolves to the
|
||||||
# site-packages directory, not the repo root. Use GITHUB_WORKSPACE
|
# site-packages directory, not the repo root. Use GITHUB_WORKSPACE
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ def load_platforms(platforms_file: str | Path | None = None) -> list[dict[str, s
|
|||||||
path = Path(platforms_file)
|
path = Path(platforms_file)
|
||||||
if not path.is_file():
|
if not path.is_file():
|
||||||
return PLATFORMS
|
return PLATFORMS
|
||||||
with path.open() as f:
|
with path.open(encoding="utf-8") as f:
|
||||||
data = json.load(f)
|
data = json.load(f)
|
||||||
if not isinstance(data, list) or not data:
|
if not isinstance(data, list) or not data:
|
||||||
return PLATFORMS
|
return PLATFORMS
|
||||||
|
|||||||
@@ -168,7 +168,7 @@ def start_docker_daemon(timeout: int = DEFAULT_TIMEOUT) -> bool:
|
|||||||
click.echo(_("Docker daemon failed to start"))
|
click.echo(_("Docker daemon failed to start"))
|
||||||
click.echo("--- dockerd log ---")
|
click.echo("--- dockerd log ---")
|
||||||
try:
|
try:
|
||||||
with open(log_file.name) as f:
|
with open(log_file.name, encoding="utf-8") as f:
|
||||||
log_content = f.read()
|
log_content = f.read()
|
||||||
click.echo(log_content[-3000:] if len(log_content) > 3000 else log_content)
|
click.echo(log_content[-3000:] if len(log_content) > 3000 else log_content)
|
||||||
except OSError as e:
|
except OSError as e:
|
||||||
@@ -191,7 +191,7 @@ def main(timeout: int) -> None:
|
|||||||
# Export DOCKER_HOST to GITHUB_ENV for subsequent CI steps
|
# Export DOCKER_HOST to GITHUB_ENV for subsequent CI steps
|
||||||
github_env = os.environ.get("GITHUB_ENV")
|
github_env = os.environ.get("GITHUB_ENV")
|
||||||
if github_env and os.environ.get("DOCKER_HOST"):
|
if github_env and os.environ.get("DOCKER_HOST"):
|
||||||
with open(github_env, "a") as f:
|
with open(github_env, "a", encoding="utf-8") as f:
|
||||||
f.write(f"DOCKER_HOST={os.environ['DOCKER_HOST']}\n")
|
f.write(f"DOCKER_HOST={os.environ['DOCKER_HOST']}\n")
|
||||||
click.echo(f"Exported DOCKER_HOST={os.environ['DOCKER_HOST']} to GITHUB_ENV")
|
click.echo(f"Exported DOCKER_HOST={os.environ['DOCKER_HOST']} to GITHUB_ENV")
|
||||||
sys.exit(0)
|
sys.exit(0)
|
||||||
|
|||||||
@@ -0,0 +1,75 @@
|
|||||||
|
"""Shared utilities for tools modules."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import platform
|
||||||
|
import subprocess # nosec B404
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
|
|
||||||
|
def arch_string() -> str:
|
||||||
|
"""Return the architecture string used by release assets.
|
||||||
|
|
||||||
|
Maps ``platform.machine()`` to the common release asset naming:
|
||||||
|
``amd64`` for x86_64, ``arm64`` for aarch64.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
click.ClickException: If the architecture is not supported.
|
||||||
|
"""
|
||||||
|
machine = platform.machine().lower()
|
||||||
|
if machine in {"x86_64", "amd64"}:
|
||||||
|
return "amd64"
|
||||||
|
if machine in {"aarch64", "arm64"}:
|
||||||
|
return "arm64"
|
||||||
|
raise click.ClickException(f"Unsupported architecture: {machine}")
|
||||||
|
|
||||||
|
|
||||||
|
def detect_pr_number() -> int | None:
|
||||||
|
"""Detect the PR number for the current git branch.
|
||||||
|
|
||||||
|
Returns the PR number if the current branch has an open PR, or None
|
||||||
|
if no PR is found. Does NOT raise — callers decide how to handle None.
|
||||||
|
Best-effort: returns None on any failure (no token, API down, etc.).
|
||||||
|
"""
|
||||||
|
result = subprocess.run( # nosec B603, B607
|
||||||
|
["git", "rev-parse", "--abbrev-ref", "HEAD"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
return None
|
||||||
|
branch = result.stdout.strip()
|
||||||
|
if branch == "HEAD":
|
||||||
|
return None
|
||||||
|
|
||||||
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
|
if not token:
|
||||||
|
return None
|
||||||
|
|
||||||
|
owner = os.environ.get("DEVX_REPO_OWNER", "")
|
||||||
|
repo = os.environ.get("DEVX_REPO_NAME", "")
|
||||||
|
if not owner or not repo:
|
||||||
|
github_repo = os.environ.get("GITHUB_REPOSITORY", "")
|
||||||
|
if "/" in github_repo:
|
||||||
|
owner, repo = github_repo.split("/", 1)
|
||||||
|
|
||||||
|
if not owner or not repo:
|
||||||
|
return None
|
||||||
|
|
||||||
|
# Lazy import to avoid circular dependency
|
||||||
|
from devx.api_clients import APIError, GiteaClient # noqa: PLC0415
|
||||||
|
from devx.config import GITEA_API_URL # noqa: PLC0415
|
||||||
|
|
||||||
|
client = GiteaClient(GITEA_API_URL, token, owner, repo)
|
||||||
|
try:
|
||||||
|
prs = client.list_prs(state="open")
|
||||||
|
except APIError:
|
||||||
|
# Best-effort: API down or auth failure → no PR detected
|
||||||
|
return None
|
||||||
|
for pr in prs:
|
||||||
|
if pr.get("head", {}).get("ref") == branch:
|
||||||
|
return int(pr["number"])
|
||||||
|
return None
|
||||||
@@ -34,9 +34,8 @@ The manifest file is a JSON list of dicts, each with:
|
|||||||
- ``context``: build context directory (optional, defaults to repo root)
|
- ``context``: build context directory (optional, defaults to repo root)
|
||||||
- ``tags``: list of tags (optional, defaults to ``["latest"]``)
|
- ``tags``: list of tags (optional, defaults to ``["latest"]``)
|
||||||
|
|
||||||
Registry authentication uses ``REPO_TOKEN`` (or ``GITEA_REGISTRY_TOKEN``)
|
Registry authentication uses ``CI_GITEA_TOKEN`` and ``CI_GITEA_USERNAME``
|
||||||
and ``REGISTRY_USERNAME`` (or ``GITEA_REGISTRY_USERNAME``) environment
|
environment variables, matching the existing CI workflow patterns.
|
||||||
variables, matching the existing CI workflow patterns.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -89,7 +88,7 @@ def load_manifest(path: str | Path) -> list[ImageSpec]:
|
|||||||
p = Path(path)
|
p = Path(path)
|
||||||
if not p.is_file():
|
if not p.is_file():
|
||||||
raise click.ClickException(_("Manifest file not found: {path}", path=p))
|
raise click.ClickException(_("Manifest file not found: {path}", path=p))
|
||||||
with p.open() as f: # noqa: PTH123
|
with p.open(encoding="utf-8") as f: # noqa: PTH123
|
||||||
data = json.load(f)
|
data = json.load(f)
|
||||||
if not isinstance(data, list):
|
if not isinstance(data, list):
|
||||||
raise click.ClickException(_("Manifest must be a JSON list"))
|
raise click.ClickException(_("Manifest must be a JSON list"))
|
||||||
@@ -221,13 +220,9 @@ def push_image(
|
|||||||
|
|
||||||
|
|
||||||
def _get_registry_creds() -> tuple[str, str]:
|
def _get_registry_creds() -> tuple[str, str]:
|
||||||
"""Get registry credentials from environment variables.
|
"""Get registry credentials from environment variables."""
|
||||||
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
Supports both REPO_TOKEN/GITEA_REGISTRY_TOKEN and
|
username = os.environ.get("CI_GITEA_USERNAME", "")
|
||||||
REGISTRY_USERNAME/GITEA_REGISTRY_USERNAME patterns.
|
|
||||||
"""
|
|
||||||
token = os.environ.get("REPO_TOKEN") or os.environ.get("GITEA_REGISTRY_TOKEN", "")
|
|
||||||
username = os.environ.get("REGISTRY_USERNAME") or os.environ.get("GITEA_REGISTRY_USERNAME", "")
|
|
||||||
return username, token
|
return username, token
|
||||||
|
|
||||||
|
|
||||||
@@ -312,7 +307,7 @@ def main(
|
|||||||
username, token = _get_registry_creds()
|
username, token = _get_registry_creds()
|
||||||
if not token or not username:
|
if not token or not username:
|
||||||
raise click.ClickException(
|
raise click.ClickException(
|
||||||
_("Registry credentials required: set REPO_TOKEN and REGISTRY_USERNAME env vars")
|
_("Registry credentials required: set CI_GITEA_TOKEN and CI_GITEA_USERNAME env vars")
|
||||||
)
|
)
|
||||||
if not registry_login(registry, username, token, dry_run=dry_run):
|
if not registry_login(registry, username, token, dry_run=dry_run):
|
||||||
raise click.ClickException(_("Registry login failed"))
|
raise click.ClickException(_("Registry login failed"))
|
||||||
|
|||||||
@@ -13,7 +13,6 @@ Usage::
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import re
|
import re
|
||||||
import sys
|
|
||||||
import tomllib
|
import tomllib
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
@@ -27,8 +26,7 @@ def cli() -> None:
|
|||||||
"""Validate devx configuration in pyproject.toml."""
|
"""Validate devx configuration in pyproject.toml."""
|
||||||
path = Path("pyproject.toml")
|
path = Path("pyproject.toml")
|
||||||
if not path.exists():
|
if not path.exists():
|
||||||
click.echo(_("pyproject.toml not found in current directory."))
|
raise click.ClickException(_("pyproject.toml not found in current directory."))
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
with open(path, "rb") as f: # noqa: PTH123
|
with open(path, "rb") as f: # noqa: PTH123
|
||||||
data = tomllib.load(f)
|
data = tomllib.load(f)
|
||||||
@@ -65,7 +63,7 @@ def cli() -> None:
|
|||||||
if errors:
|
if errors:
|
||||||
for err in errors:
|
for err in errors:
|
||||||
click.echo(f"ERROR: {err}", err=True)
|
click.echo(f"ERROR: {err}", err=True)
|
||||||
sys.exit(1)
|
raise click.ClickException(_("Configuration validation failed."))
|
||||||
|
|
||||||
click.echo(_("Configuration OK: [tool.devx] present, devx versions consistent."))
|
click.echo(_("Configuration OK: [tool.devx] present, devx versions consistent."))
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,105 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Check that required development tools are present.
|
||||||
|
|
||||||
|
Verifies the availability of core tools (tofu, docker, checkmake, Python
|
||||||
|
3.12+ in the venv) and prints warnings or errors for missing ones.
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
python3 -m devx.tools.check_deps
|
||||||
|
python3 -m devx.tools.check_deps --venv .venv
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import shutil
|
||||||
|
import subprocess # nosec B404
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
|
REQUIRED_TOOLS = ["tofu", "docker"]
|
||||||
|
OPTIONAL_TOOLS = ["checkmake"]
|
||||||
|
PYTHON_MIN_VERSION = (3, 12)
|
||||||
|
|
||||||
|
|
||||||
|
def _check_tool(name: str, *, optional: bool = False) -> bool:
|
||||||
|
"""Check if a tool is on PATH. Returns True if found."""
|
||||||
|
found = shutil.which(name) is not None
|
||||||
|
if found:
|
||||||
|
return True
|
||||||
|
level = "WARN" if optional else "ERROR"
|
||||||
|
click.echo(
|
||||||
|
_("{level}: {tool} not found.{hint}", level=level, tool=name, hint=""),
|
||||||
|
err=True,
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _check_python_version(venv_bin: Path) -> None:
|
||||||
|
"""Check that the venv Python is >= 3.12."""
|
||||||
|
python_bin = venv_bin / "python"
|
||||||
|
if not python_bin.exists():
|
||||||
|
click.echo(
|
||||||
|
_("WARN: .venv not found. Run 'make setup-venv' to create it."),
|
||||||
|
err=True,
|
||||||
|
)
|
||||||
|
return
|
||||||
|
result = subprocess.run( # nosec B603
|
||||||
|
[str(python_bin), "--version"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
click.echo(_("WARN: Could not determine Python version in .venv."), err=True)
|
||||||
|
return
|
||||||
|
version_str = result.stdout.strip().split()[-1] if result.stdout else ""
|
||||||
|
try:
|
||||||
|
major, minor = int(version_str.split(".")[0]), int(version_str.split(".")[1])
|
||||||
|
except (IndexError, ValueError):
|
||||||
|
click.echo(_("WARN: Could not parse Python version '{version}'.", version=version_str), err=True)
|
||||||
|
return
|
||||||
|
if (major, minor) < PYTHON_MIN_VERSION:
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"WARN: .venv has Python {version}, but >={req} is required.",
|
||||||
|
version=version_str,
|
||||||
|
req=f"{PYTHON_MIN_VERSION[0]}.{PYTHON_MIN_VERSION[1]}",
|
||||||
|
),
|
||||||
|
err=True,
|
||||||
|
)
|
||||||
|
return
|
||||||
|
click.echo(_("[check-deps] Virtualenv .venv ready (Python {version}).", version=version_str))
|
||||||
|
|
||||||
|
|
||||||
|
@click.command()
|
||||||
|
@click.option("--venv", default=".venv", show_default=True, help="Path to the virtual environment.")
|
||||||
|
@click.option("--checkmake-bin", default=None, help="Path to checkmake binary (fallback if not on PATH).")
|
||||||
|
def cli(venv: str, checkmake_bin: str | None) -> None:
|
||||||
|
"""Verify that required development tools are present."""
|
||||||
|
click.echo("[check-deps] Verifying tools...")
|
||||||
|
|
||||||
|
all_required = True
|
||||||
|
for tool in REQUIRED_TOOLS:
|
||||||
|
if not _check_tool(tool):
|
||||||
|
all_required = False
|
||||||
|
|
||||||
|
for tool in OPTIONAL_TOOLS:
|
||||||
|
if not _check_tool(tool, optional=True):
|
||||||
|
if checkmake_bin and Path(checkmake_bin).exists():
|
||||||
|
click.echo(f" {tool}: found at {checkmake_bin}")
|
||||||
|
else:
|
||||||
|
click.echo(" Run 'make install-checkmake' to install the Makefile linter.")
|
||||||
|
|
||||||
|
_check_python_version(Path(venv) / "bin")
|
||||||
|
|
||||||
|
if not all_required:
|
||||||
|
raise click.ClickException("Required tools missing.")
|
||||||
|
click.echo("[check-deps] All core tools present.")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
cli() # pragma: no cover
|
||||||
@@ -23,12 +23,12 @@ Usage::
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import argparse
|
|
||||||
import fnmatch
|
import fnmatch
|
||||||
import subprocess # nosec B404
|
import subprocess # nosec B404
|
||||||
import sys
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
from devx.config import _load_pyproject_devx
|
from devx.config import _load_pyproject_devx
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
@@ -203,49 +203,37 @@ def _find_missing_tests(
|
|||||||
return missing
|
return missing
|
||||||
|
|
||||||
|
|
||||||
def main(argv: list[str] | None = None) -> int:
|
@click.command()
|
||||||
parser = argparse.ArgumentParser(
|
@click.option("--staged-only", is_flag=True, help=_("Only check staged files (for pre-commit)"))
|
||||||
description=_("Check that changed files have corresponding tests"),
|
@click.option("--warn-only", is_flag=True, help=_("Print warnings but always exit 0"))
|
||||||
)
|
def cli(staged_only: bool, warn_only: bool) -> None:
|
||||||
parser.add_argument(
|
"""Check that changed files have corresponding tests."""
|
||||||
"--staged-only",
|
|
||||||
action="store_true",
|
|
||||||
help=_("Only check staged files (for pre-commit)"),
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--warn-only",
|
|
||||||
action="store_true",
|
|
||||||
help=_("Print warnings but always exit 0"),
|
|
||||||
)
|
|
||||||
args = parser.parse_args(argv)
|
|
||||||
|
|
||||||
repo_root = Path.cwd()
|
repo_root = Path.cwd()
|
||||||
rules, skip_patterns, test_indicators, skip_extensions = _load_rules()
|
rules, skip_patterns, test_indicators, skip_extensions = _load_rules()
|
||||||
|
|
||||||
files = _changed_files(args.staged_only, repo_root)
|
files = _changed_files(staged_only, repo_root)
|
||||||
if not files:
|
if not files:
|
||||||
print(_("[check_test_coverage] No changed files to check."))
|
click.echo(_("[check_test_coverage] No changed files to check."))
|
||||||
return 0
|
return
|
||||||
|
|
||||||
missing = _find_missing_tests(files, repo_root, rules, skip_patterns, test_indicators, skip_extensions)
|
missing = _find_missing_tests(files, repo_root, rules, skip_patterns, test_indicators, skip_extensions)
|
||||||
if not missing:
|
if not missing:
|
||||||
print(f"[check_test_coverage] All {len(files)} changed file(s) have tests.")
|
click.echo(f"[check_test_coverage] All {len(files)} changed file(s) have tests.")
|
||||||
return 0
|
return
|
||||||
|
|
||||||
print("[check_test_coverage] FAILED: missing tests for changed files:\n", file=sys.stderr)
|
click.echo("[check_test_coverage] FAILED: missing tests for changed files:\n", err=True)
|
||||||
for f, reason in missing.items():
|
for f, reason in missing.items():
|
||||||
print(f" {f}", file=sys.stderr)
|
click.echo(f" {f}", err=True)
|
||||||
print(f" -> {reason}", file=sys.stderr)
|
click.echo(f" -> {reason}", err=True)
|
||||||
|
|
||||||
print(
|
click.echo(
|
||||||
"\n[check_test_coverage] Fix: add the missing test file(s) before committing.",
|
_("\n[check_test_coverage] Fix: add the missing test file(s) before committing."),
|
||||||
file=sys.stderr,
|
err=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
if args.warn_only:
|
if not warn_only:
|
||||||
return 0
|
raise click.ClickException(_("Missing tests for changed files."))
|
||||||
return 1
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
sys.exit(main())
|
cli() # pragma: no cover
|
||||||
|
|||||||
@@ -28,18 +28,19 @@ Usage::
|
|||||||
--keep 2 \\
|
--keep 2 \\
|
||||||
--dry-run
|
--dry-run
|
||||||
|
|
||||||
Authentication uses ``REPO_TOKEN`` environment variable.
|
Authentication uses ``CI_GITEA_TOKEN`` environment variable.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
import time
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
import click
|
import click
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
from devx.config import GITEA_API_URL
|
from devx.config import GITEA_API_URL, REPO_OWNER
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
|
|
||||||
@@ -85,15 +86,37 @@ def delete_package_version(
|
|||||||
token: str,
|
token: str,
|
||||||
*,
|
*,
|
||||||
timeout: int = 30,
|
timeout: int = 30,
|
||||||
|
package_type: str = "container",
|
||||||
|
max_retries: int = 3,
|
||||||
) -> bool:
|
) -> bool:
|
||||||
"""Delete a specific version of a container package.
|
"""Delete a specific version of a container package.
|
||||||
|
|
||||||
|
Uses the Gitea API endpoint ``DELETE /packages/{owner}/{type}/{name}/{version}``.
|
||||||
|
Retries on transient failures (5xx, timeouts) up to ``max_retries`` times.
|
||||||
|
|
||||||
Returns True on success, False on failure.
|
Returns True on success, False on failure.
|
||||||
"""
|
"""
|
||||||
url = f"{api_url}/packages/{owner}/{name}/{version}"
|
url = f"{api_url}/packages/{owner}/{package_type}/{name}/{version}"
|
||||||
headers = {"Authorization": f"token {token}"}
|
headers = {"Authorization": f"token {token}"}
|
||||||
|
for attempt in range(max_retries):
|
||||||
|
try:
|
||||||
resp = requests.delete(url, headers=headers, timeout=timeout)
|
resp = requests.delete(url, headers=headers, timeout=timeout)
|
||||||
return resp.status_code in (204, 200)
|
except requests.RequestException:
|
||||||
|
if attempt < max_retries - 1:
|
||||||
|
time.sleep(2**attempt)
|
||||||
|
continue
|
||||||
|
return False
|
||||||
|
if resp.status_code in (204, 200):
|
||||||
|
return True
|
||||||
|
# 404 means already deleted — treat as success
|
||||||
|
if resp.status_code == 404:
|
||||||
|
return True
|
||||||
|
# 5xx is transient — retry
|
||||||
|
if 500 <= resp.status_code < 600 and attempt < max_retries - 1:
|
||||||
|
time.sleep(2**attempt)
|
||||||
|
continue
|
||||||
|
return False
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
def sort_versions_by_date(
|
def sort_versions_by_date(
|
||||||
@@ -128,8 +151,8 @@ def select_for_deletion(
|
|||||||
@click.command()
|
@click.command()
|
||||||
@click.option(
|
@click.option(
|
||||||
"--owner",
|
"--owner",
|
||||||
required=True,
|
default=None,
|
||||||
help="Package owner (user or org).",
|
help="Package owner (user or org, default: from [tool.devx] repo_owner).",
|
||||||
)
|
)
|
||||||
@click.option(
|
@click.option(
|
||||||
"--name",
|
"--name",
|
||||||
@@ -157,24 +180,29 @@ def select_for_deletion(
|
|||||||
help="Gitea API URL (defaults to DEVX_GITEA_API_URL or built-in default).",
|
help="Gitea API URL (defaults to DEVX_GITEA_API_URL or built-in default).",
|
||||||
)
|
)
|
||||||
def main(
|
def main(
|
||||||
owner: str,
|
owner: str | None,
|
||||||
names: tuple[str, ...],
|
names: tuple[str, ...],
|
||||||
keep: int,
|
keep: int,
|
||||||
dry_run: bool,
|
dry_run: bool,
|
||||||
api_url: str | None,
|
api_url: str | None,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Clean up old Docker image versions from a Gitea registry."""
|
"""Clean up old Docker image versions from a Gitea registry."""
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not token:
|
if not token:
|
||||||
raise click.ClickException(_("REPO_TOKEN environment variable required"))
|
raise click.ClickException(_("CI_GITEA_TOKEN environment variable required"))
|
||||||
|
if not owner:
|
||||||
|
owner = REPO_OWNER
|
||||||
|
if not owner:
|
||||||
|
raise click.ClickException(_("Package owner not specified. Use --owner or set [tool.devx] repo_owner."))
|
||||||
base_url = api_url or GITEA_API_URL
|
base_url = api_url or GITEA_API_URL
|
||||||
|
|
||||||
total_deleted = 0
|
total_deleted = 0
|
||||||
total_kept = 0
|
total_kept = 0
|
||||||
|
total_failed = 0
|
||||||
for name in names:
|
for name in names:
|
||||||
click.echo(f"\n{'=' * 60}")
|
click.echo(_("\n{separator}", separator="=" * 60))
|
||||||
click.echo(f"Package: {owner}/{name}")
|
click.echo(_("Package: {owner}/{name}", owner=owner, name=name))
|
||||||
click.echo(f"{'=' * 60}")
|
click.echo(_("{separator}", separator="=" * 60))
|
||||||
try:
|
try:
|
||||||
versions = list_package_versions(base_url, owner, name, token)
|
versions = list_package_versions(base_url, owner, name, token)
|
||||||
except requests.RequestException as exc:
|
except requests.RequestException as exc:
|
||||||
@@ -182,39 +210,54 @@ def main(
|
|||||||
_("Failed to list versions for {name}: {error}", name=name, error=exc),
|
_("Failed to list versions for {name}: {error}", name=name, error=exc),
|
||||||
err=True,
|
err=True,
|
||||||
)
|
)
|
||||||
|
total_failed += 1
|
||||||
continue
|
continue
|
||||||
|
|
||||||
if not versions:
|
if not versions:
|
||||||
click.echo(_("No versions found."))
|
click.echo(_("No versions found."))
|
||||||
continue
|
continue
|
||||||
|
|
||||||
click.echo(f"Found {len(versions)} version(s):")
|
click.echo(_("Found {count} version(s):", count=len(versions)))
|
||||||
for v in sort_versions_by_date(versions):
|
for v in sort_versions_by_date(versions):
|
||||||
click.echo(f" {v.get('version', '?')} (created: {v.get('created_at', '?')})")
|
click.echo(
|
||||||
|
_(" {version} (created: {created})", version=v.get("version", "?"), created=v.get("created_at", "?"))
|
||||||
|
)
|
||||||
|
|
||||||
to_delete = select_for_deletion(versions, keep)
|
to_delete = select_for_deletion(versions, keep)
|
||||||
kept_count = len(versions) - len(to_delete)
|
kept_count = len(versions) - len(to_delete)
|
||||||
click.echo(f"\nKeeping {kept_count}, would delete {len(to_delete)}")
|
click.echo(_("\nKeeping {kept}, would delete {count}", kept=kept_count, count=len(to_delete)))
|
||||||
|
|
||||||
if dry_run:
|
if dry_run:
|
||||||
for v in to_delete:
|
for v in to_delete:
|
||||||
click.echo(f" [dry-run] Would delete: {v.get('version', '?')}")
|
click.echo(_(" [dry-run] Would delete: {version}", version=v.get("version", "?")))
|
||||||
total_kept += kept_count
|
total_kept += kept_count
|
||||||
continue
|
continue
|
||||||
|
|
||||||
deleted_count = 0
|
deleted_count = 0
|
||||||
|
failed_count = 0
|
||||||
for v in to_delete:
|
for v in to_delete:
|
||||||
version = str(v.get("version", ""))
|
version = str(v.get("version", ""))
|
||||||
if delete_package_version(base_url, owner, name, version, token):
|
if delete_package_version(base_url, owner, name, version, token):
|
||||||
click.echo(f" Deleted: {version}")
|
click.echo(_(" Deleted: {version}", version=version))
|
||||||
deleted_count += 1
|
deleted_count += 1
|
||||||
else:
|
else:
|
||||||
click.echo(f" FAILED to delete: {version}", err=True)
|
click.echo(_(" FAILED to delete: {version}", version=version), err=True)
|
||||||
|
failed_count += 1
|
||||||
|
|
||||||
total_deleted += deleted_count
|
total_deleted += deleted_count
|
||||||
total_kept += kept_count
|
total_kept += kept_count
|
||||||
|
total_failed += failed_count
|
||||||
|
|
||||||
click.echo(f"\nDone. Deleted {total_deleted}, kept {total_kept}.")
|
click.echo(
|
||||||
|
_(
|
||||||
|
"\nDone. Deleted {deleted}, kept {kept}, failed {failed}.",
|
||||||
|
deleted=total_deleted,
|
||||||
|
kept=total_kept,
|
||||||
|
failed=total_failed,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if total_failed > 0:
|
||||||
|
raise click.ClickException(_("Failed to delete {count} image version(s)", count=total_failed))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
|||||||
@@ -1,13 +1,14 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
"""Configure repository: branch protection + repo settings via Gitea REST API.
|
"""Configure repository: branch protection, repo settings, and standard labels.
|
||||||
|
|
||||||
Uses ``GiteaClient`` for branch protection and repo settings.
|
Uses ``GiteaClient`` for branch protection, repo settings, and label
|
||||||
The ``tea`` CLI is used for label creation if available, with a
|
creation. Standard labels (bug, ready-to-merge, feedback, tooling,
|
||||||
fallback to ``GiteaClient`` if tea is not installed.
|
ci-improvement, doc-improvement, workflow-improvement) are created
|
||||||
|
idempotently via ``ensure_label``.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
REPO_TOKEN=<token> python3 -m devx.tools.configure_repo --repo my-repo
|
CI_GITEA_TOKEN=<token> python3 -m devx.tools.configure_repo --repo my-repo
|
||||||
REPO_TOKEN=<token> python3 -m devx.tools.configure_repo --repo my-repo --owner my-org
|
CI_GITEA_TOKEN=<token> python3 -m devx.tools.configure_repo --repo my-repo --owner my-org
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -19,7 +20,7 @@ from typing import Any, cast
|
|||||||
import click
|
import click
|
||||||
|
|
||||||
from devx.api_clients import GiteaClient
|
from devx.api_clients import GiteaClient
|
||||||
from devx.config import GITEA_API_URL, REPO_OWNER
|
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
|
||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
@@ -50,11 +51,17 @@ def _default_branch_protection_config() -> dict[str, Any]:
|
|||||||
"push_whitelist_usernames": [],
|
"push_whitelist_usernames": [],
|
||||||
"enable_status_check": True,
|
"enable_status_check": True,
|
||||||
"status_check_contexts": _default_status_checks(),
|
"status_check_contexts": _default_status_checks(),
|
||||||
"required_approvals": 0,
|
"required_approvals": 1,
|
||||||
"dismiss_stale_approvals": True,
|
"dismiss_stale_approvals": True,
|
||||||
"block_on_outdated_branch": True,
|
"block_on_outdated_branch": True,
|
||||||
"block_on_rejected_reviews": True,
|
"block_on_rejected_reviews": True,
|
||||||
"block_on_official_review_requests": True,
|
"block_on_official_review_requests": True,
|
||||||
|
# Prevent admins from force-merging PRs that don't meet branch
|
||||||
|
# protection requirements (e.g. missing approvals). Without this,
|
||||||
|
# an admin token can bypass the approval gate via force_merge=true,
|
||||||
|
# allowing merges that failed the auto-merge CI job to reach master
|
||||||
|
# and trigger the post-merge release pipeline.
|
||||||
|
"block_admin_merge_override": True,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -65,6 +72,19 @@ def _default_repo_settings_config() -> dict[str, Any]:
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# Standard labels created in every oblachno repo.
|
||||||
|
# These cover CI failure notifications, subagent feedback, and auto-merge.
|
||||||
|
_STANDARD_LABELS: list[dict[str, str]] = [
|
||||||
|
{"name": "bug", "color": "#ee0701", "description": "Something is not working"},
|
||||||
|
{"name": "ready-to-merge", "color": "#a2eeef", "description": "PR has been reviewed and is ready for auto-merge"},
|
||||||
|
{"name": "feedback", "color": "#fbca04", "description": "Issues from subagent or agent feedback"},
|
||||||
|
{"name": "tooling", "color": "#c5def5", "description": "Tool-related feedback or improvements"},
|
||||||
|
{"name": "ci-improvement", "color": "#84b6eb", "description": "CI workflow improvements"},
|
||||||
|
{"name": "doc-improvement", "color": "#d4c5f9", "description": "Documentation improvements"},
|
||||||
|
{"name": "workflow-improvement", "color": "#fef2c0", "description": "Workflow alignment or pattern improvements"},
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
def _handle_http_error(e: APIError) -> None:
|
def _handle_http_error(e: APIError) -> None:
|
||||||
"""Raise a user-friendly Click exception for HTTP errors."""
|
"""Raise a user-friendly Click exception for HTTP errors."""
|
||||||
if e.status == http.HTTPStatus.FORBIDDEN:
|
if e.status == http.HTTPStatus.FORBIDDEN:
|
||||||
@@ -102,7 +122,7 @@ def configure_repo(
|
|||||||
api_url: Gitea API base URL. If None, uses ``GITEA_API_URL`` from config.
|
api_url: Gitea API base URL. If None, uses ``GITEA_API_URL`` from config.
|
||||||
"""
|
"""
|
||||||
if not token:
|
if not token:
|
||||||
raise click.ClickException(_("ERROR: REPO_TOKEN is not set."))
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
||||||
|
|
||||||
url = api_url or GITEA_API_URL
|
url = api_url or GITEA_API_URL
|
||||||
client = GiteaClient(url, token, owner, repo)
|
client = GiteaClient(url, token, owner, repo)
|
||||||
@@ -123,6 +143,7 @@ def configure_repo(
|
|||||||
click.echo(_(" - Dismiss stale approvals: yes"))
|
click.echo(_(" - Dismiss stale approvals: yes"))
|
||||||
click.echo(_(" - Block outdated branches: yes"))
|
click.echo(_(" - Block outdated branches: yes"))
|
||||||
click.echo(_(" - Block rejected reviews: yes"))
|
click.echo(_(" - Block rejected reviews: yes"))
|
||||||
|
click.echo(_(" - Block admin merge override: yes"))
|
||||||
checks = ", ".join(cast(list[str], bp_config["status_check_contexts"]))
|
checks = ", ".join(cast(list[str], bp_config["status_check_contexts"]))
|
||||||
click.echo(_(" - Required status checks: {checks}", checks=checks))
|
click.echo(_(" - Required status checks: {checks}", checks=checks))
|
||||||
|
|
||||||
@@ -131,6 +152,12 @@ def configure_repo(
|
|||||||
client.update_repo_settings(cast(dict[str, object], rs_config))
|
client.update_repo_settings(cast(dict[str, object], rs_config))
|
||||||
click.echo(_(" - Auto-delete branch after merge: yes"))
|
click.echo(_(" - Auto-delete branch after merge: yes"))
|
||||||
|
|
||||||
|
click.echo("")
|
||||||
|
click.echo(_("Ensuring standard labels..."))
|
||||||
|
for label in _STANDARD_LABELS:
|
||||||
|
client.ensure_label(label["name"], label["color"], label["description"])
|
||||||
|
click.echo(_(" - {count} standard labels verified", count=len(_STANDARD_LABELS)))
|
||||||
|
|
||||||
click.echo("")
|
click.echo("")
|
||||||
click.echo(_("Repository configuration complete."))
|
click.echo(_("Repository configuration complete."))
|
||||||
except APIError as e:
|
except APIError as e:
|
||||||
@@ -148,10 +175,10 @@ def configure_repo(
|
|||||||
)
|
)
|
||||||
def main(repo: str | None, owner: str | None, branch: str, api_url: str | None) -> None:
|
def main(repo: str | None, owner: str | None, branch: str, api_url: str | None) -> None:
|
||||||
"""Configure branch protection and repository settings via the Gitea API."""
|
"""Configure branch protection and repository settings via the Gitea API."""
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
|
|
||||||
if repo is None:
|
if repo is None:
|
||||||
repo = os.environ.get("DEVX_REPO_NAME", "")
|
repo = os.environ.get("DEVX_REPO_NAME", "") or REPO_NAME
|
||||||
if not repo:
|
if not repo:
|
||||||
raise click.ClickException(_("ERROR: Repository name not specified. Use --repo or set DEVX_REPO_NAME."))
|
raise click.ClickException(_("ERROR: Repository name not specified. Use --repo or set DEVX_REPO_NAME."))
|
||||||
|
|
||||||
|
|||||||
+10
-15
@@ -34,6 +34,7 @@ from devx.api_clients import GiteaClient, VikunjaClient
|
|||||||
from devx.config import (
|
from devx.config import (
|
||||||
DEFAULT_PER_PAGE,
|
DEFAULT_PER_PAGE,
|
||||||
GITEA_API_URL,
|
GITEA_API_URL,
|
||||||
|
REPO_NAME,
|
||||||
REPO_OWNER,
|
REPO_OWNER,
|
||||||
TASK_ID_RE,
|
TASK_ID_RE,
|
||||||
TASK_PREFIX,
|
TASK_PREFIX,
|
||||||
@@ -46,15 +47,17 @@ load_dotenv()
|
|||||||
|
|
||||||
|
|
||||||
def get_repo_name() -> str:
|
def get_repo_name() -> str:
|
||||||
"""Auto-detect repository name from env vars or git remote."""
|
"""Auto-detect repository name from env vars, pyproject.toml, or git remote."""
|
||||||
name = os.environ.get("DEVX_REPO_NAME", "")
|
name = os.environ.get("DEVX_REPO_NAME", "")
|
||||||
if name:
|
if name:
|
||||||
return name
|
return name
|
||||||
github_repo = os.environ.get("GITHUB_REPOSITORY", "")
|
github_repo = os.environ.get("GITHUB_REPOSITORY", "")
|
||||||
if github_repo and "/" in github_repo:
|
if github_repo and "/" in github_repo:
|
||||||
return github_repo.split("/", 1)[1]
|
return github_repo.split("/", 1)[1]
|
||||||
|
if REPO_NAME:
|
||||||
|
return REPO_NAME
|
||||||
raise click.ClickException(
|
raise click.ClickException(
|
||||||
_("Repository name not set. Use DEVX_REPO_NAME or GITHUB_REPOSITORY env var."),
|
_("Repository name not set. Use DEVX_REPO_NAME, [tool.devx] repo_name, or GITHUB_REPOSITORY env var."),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -73,17 +76,8 @@ def get_vikunja_task_title(task_id: str) -> str:
|
|||||||
if not token:
|
if not token:
|
||||||
raise click.ClickException(_("VIKUNJA_TOKEN is not set. Required to derive PR title."))
|
raise click.ClickException(_("VIKUNJA_TOKEN is not set. Required to derive PR title."))
|
||||||
client = VikunjaClient(VIKUNJA_API_URL, token)
|
client = VikunjaClient(VIKUNJA_API_URL, token)
|
||||||
page = 1
|
task = client.find_task_by_identifier(VIKUNJA_PROJECT_ID, task_id, per_page=DEFAULT_PER_PAGE)
|
||||||
while True:
|
if not task:
|
||||||
tasks = client.list_project_tasks(VIKUNJA_PROJECT_ID, page=page, per_page=DEFAULT_PER_PAGE)
|
|
||||||
if not tasks:
|
|
||||||
break
|
|
||||||
matches = [t for t in tasks if t.get("identifier") == task_id]
|
|
||||||
if matches:
|
|
||||||
return str(matches[0].get("title", ""))
|
|
||||||
if len(tasks) < DEFAULT_PER_PAGE:
|
|
||||||
break
|
|
||||||
page += 1
|
|
||||||
raise click.ClickException(
|
raise click.ClickException(
|
||||||
_(
|
_(
|
||||||
"Could not find Vikunja task {task_id} in project {project_id}.",
|
"Could not find Vikunja task {task_id} in project {project_id}.",
|
||||||
@@ -91,6 +85,7 @@ def get_vikunja_task_title(task_id: str) -> str:
|
|||||||
project_id=VIKUNJA_PROJECT_ID,
|
project_id=VIKUNJA_PROJECT_ID,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
return str(task.get("title", ""))
|
||||||
|
|
||||||
|
|
||||||
def find_existing_pr(client: GiteaClient, branch: str) -> dict | None:
|
def find_existing_pr(client: GiteaClient, branch: str) -> dict | None:
|
||||||
@@ -123,9 +118,9 @@ def create_pr(
|
|||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not token:
|
if not token:
|
||||||
raise click.ClickException(_("REPO_TOKEN is not set. Required to create a PR."))
|
raise click.ClickException(_("CI_GITEA_TOKEN is not set. Required to create a PR."))
|
||||||
|
|
||||||
vikunja_title = get_vikunja_task_title(task_id)
|
vikunja_title = get_vikunja_task_title(task_id)
|
||||||
pr_title = f"{task_id}: {vikunja_title}"
|
pr_title = f"{task_id}: {vikunja_title}"
|
||||||
|
|||||||
@@ -0,0 +1,123 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Docker registry login helper.
|
||||||
|
|
||||||
|
Handles login to Docker registries (Gitea, Docker Hub) with credential
|
||||||
|
loading from environment variables. Supports required and optional modes.
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
python3 -m devx.tools.docker_login --registry git.oblachno.oblachno.fyi \\
|
||||||
|
--token-env CI_GITEA_TOKEN --username-env CI_GITEA_USERNAME \\
|
||||||
|
--default-username emil
|
||||||
|
|
||||||
|
python3 -m devx.tools.docker_login --registry docker.io \\
|
||||||
|
--token-env DOCKER_HUB_TOKEN --username-env DOCKER_HUB_USERNAME --optional
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess # nosec B404
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
|
|
||||||
|
def docker_login(
|
||||||
|
registry: str,
|
||||||
|
username: str,
|
||||||
|
token: str,
|
||||||
|
*,
|
||||||
|
suppress_failure: bool = False,
|
||||||
|
) -> bool:
|
||||||
|
"""Log in to a Docker registry.
|
||||||
|
|
||||||
|
Returns True on success, False on failure.
|
||||||
|
If ``suppress_failure`` is True, prints a warning instead of raising.
|
||||||
|
"""
|
||||||
|
cmd = ["docker", "login", registry, "-u", username, "-p", token]
|
||||||
|
result = subprocess.run( # nosec B603
|
||||||
|
cmd,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
if suppress_failure:
|
||||||
|
click.echo(
|
||||||
|
_("[docker-login] Login to {registry} failed (continuing).", registry=registry),
|
||||||
|
err=True,
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
raise click.ClickException(
|
||||||
|
_("Login to {registry} failed: {error}", registry=registry, error=result.stderr.strip()),
|
||||||
|
)
|
||||||
|
click.echo(_("[docker-login] Logged in to {registry}.", registry=registry))
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_credentials(
|
||||||
|
token_env: str,
|
||||||
|
username_env: str,
|
||||||
|
default_username: str | None,
|
||||||
|
) -> tuple[str | None, str | None]:
|
||||||
|
"""Resolve credentials from environment variables.
|
||||||
|
|
||||||
|
Returns (username, token) or (None, None) if token is not set.
|
||||||
|
"""
|
||||||
|
import os
|
||||||
|
|
||||||
|
token = os.environ.get(token_env, "")
|
||||||
|
if not token:
|
||||||
|
return None, None
|
||||||
|
username = os.environ.get(username_env, "") or (default_username or "")
|
||||||
|
return username, token
|
||||||
|
|
||||||
|
|
||||||
|
@click.command()
|
||||||
|
@click.option("--registry", required=True, help="Docker registry URL (e.g. docker.io, git.example.com).")
|
||||||
|
@click.option("--token-env", required=True, help="Environment variable name for the auth token.")
|
||||||
|
@click.option("--username-env", required=True, help="Environment variable name for the username.")
|
||||||
|
@click.option(
|
||||||
|
"--default-username",
|
||||||
|
default=None,
|
||||||
|
help="Default username if the env var is not set.",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--optional",
|
||||||
|
is_flag=True,
|
||||||
|
default=False,
|
||||||
|
help="Skip silently if token is not set instead of raising.",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--suppress-failure",
|
||||||
|
is_flag=True,
|
||||||
|
default=False,
|
||||||
|
help="Continue on login failure instead of raising (prints warning).",
|
||||||
|
)
|
||||||
|
def cli(
|
||||||
|
registry: str,
|
||||||
|
token_env: str,
|
||||||
|
username_env: str,
|
||||||
|
default_username: str | None,
|
||||||
|
optional: bool,
|
||||||
|
suppress_failure: bool,
|
||||||
|
) -> None:
|
||||||
|
"""Log in to a Docker registry using credentials from environment variables."""
|
||||||
|
username, token = _resolve_credentials(token_env, username_env, default_username)
|
||||||
|
if token is None:
|
||||||
|
if optional:
|
||||||
|
click.echo(_("[docker-login] Skipping {registry} (token {env} not set).", registry=registry, env=token_env))
|
||||||
|
return
|
||||||
|
raise click.ClickException(
|
||||||
|
_("{env} is not set. Set it in your .env file or pass it as an environment variable.", env=token_env),
|
||||||
|
)
|
||||||
|
if not username:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("{env} is not set. Set it in your .env file.", env=username_env),
|
||||||
|
)
|
||||||
|
docker_login(registry, username, token, suppress_failure=suppress_failure)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
cli() # pragma: no cover
|
||||||
@@ -27,6 +27,8 @@ from pathlib import Path
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
# Coverage regex matches "TOTAL ... NN%" or "TOTAL ... NN.NN%"
|
# Coverage regex matches "TOTAL ... NN%" or "TOTAL ... NN.NN%"
|
||||||
_COVERAGE_RE = re.compile(r"TOTAL.*?(\d+(?:\.\d+)?)%")
|
_COVERAGE_RE = re.compile(r"TOTAL.*?(\d+(?:\.\d+)?)%")
|
||||||
_PASSED_RE = re.compile(r"(\d+) passed")
|
_PASSED_RE = re.compile(r"(\d+) passed")
|
||||||
@@ -197,17 +199,19 @@ def read_version(repo_root: Path) -> str:
|
|||||||
"""
|
"""
|
||||||
pkg = detect_package_name(repo_root)
|
pkg = detect_package_name(repo_root)
|
||||||
if pkg is None:
|
if pkg is None:
|
||||||
click.echo(" WARNING: No Python package found under src/ — version badge will show 'unknown'")
|
click.echo(_(" WARNING: No Python package found under src/ — version badge will show 'unknown'"))
|
||||||
return "unknown"
|
return "unknown"
|
||||||
init_file = repo_root / "src" / pkg / "__init__.py"
|
init_file = repo_root / "src" / pkg / "__init__.py"
|
||||||
if not init_file.exists():
|
if not init_file.exists():
|
||||||
click.echo(f" WARNING: {init_file} not found — version badge will show 'unknown'")
|
click.echo(_(" WARNING: {init_file} not found — version badge will show 'unknown'", init_file=init_file))
|
||||||
return "unknown"
|
return "unknown"
|
||||||
content = init_file.read_text()
|
content = init_file.read_text()
|
||||||
match = re.search(r'__version__\s*=\s*["\']([^"\']+)["\']', content)
|
match = re.search(r'__version__\s*=\s*["\']([^"\']+)["\']', content)
|
||||||
if match:
|
if match:
|
||||||
return match.group(1)
|
return match.group(1)
|
||||||
click.echo(f" WARNING: No __version__ found in {init_file} — version badge will show 'unknown'")
|
click.echo(
|
||||||
|
_(" WARNING: No __version__ found in {init_file} — version badge will show 'unknown'", init_file=init_file)
|
||||||
|
)
|
||||||
return "unknown"
|
return "unknown"
|
||||||
|
|
||||||
|
|
||||||
@@ -278,11 +282,11 @@ def collect_coverage_and_tests(repo_root: Path) -> tuple[dict[str, str | int], d
|
|||||||
"""
|
"""
|
||||||
cov_target = detect_coverage_target(repo_root)
|
cov_target = detect_coverage_target(repo_root)
|
||||||
if cov_target is None:
|
if cov_target is None:
|
||||||
click.echo(" WARNING: No coverage target detected (no src/ package, no --cov in pyproject.toml)")
|
click.echo(_(" WARNING: No coverage target detected (no src/ package, no --cov in pyproject.toml)"))
|
||||||
return make_badge("coverage", "unknown", "lightgrey"), make_badge("tests", "unknown", "lightgrey")
|
return make_badge("coverage", "unknown", "lightgrey"), make_badge("tests", "unknown", "lightgrey")
|
||||||
|
|
||||||
testpaths = detect_testpaths(repo_root)
|
testpaths = detect_testpaths(repo_root)
|
||||||
click.echo(f" Test paths: {testpaths or '(pytest defaults)'}")
|
click.echo(_(" Test paths: {testpaths}", testpaths=testpaths or "(pytest defaults)"))
|
||||||
|
|
||||||
cmd = [
|
cmd = [
|
||||||
sys.executable,
|
sys.executable,
|
||||||
@@ -302,18 +306,18 @@ def collect_coverage_and_tests(repo_root: Path) -> tuple[dict[str, str | int], d
|
|||||||
if coverage is not None:
|
if coverage is not None:
|
||||||
cov_badge = make_badge("coverage", f"{coverage:.0f}%", coverage_color(coverage))
|
cov_badge = make_badge("coverage", f"{coverage:.0f}%", coverage_color(coverage))
|
||||||
else:
|
else:
|
||||||
click.echo(f" WARNING: Could not extract coverage from pytest output (rc={rc})")
|
click.echo(_(" WARNING: Could not extract coverage from pytest output (rc={rc})", rc=rc))
|
||||||
click.echo(f" pytest stdout (last 300 chars): {stdout.strip()[-300:]}")
|
click.echo(_(" pytest stdout (last 300 chars): {stdout}", stdout=stdout.strip()[-300:]))
|
||||||
click.echo(f" pytest stderr (last 300 chars): {stderr.strip()[-300:]}")
|
click.echo(_(" pytest stderr (last 300 chars): {stderr}", stderr=stderr.strip()[-300:]))
|
||||||
cov_badge = make_badge("coverage", "unknown", "red")
|
cov_badge = make_badge("coverage", "unknown", "red")
|
||||||
|
|
||||||
test_count = extract_test_count(combined)
|
test_count = extract_test_count(combined)
|
||||||
if test_count is not None:
|
if test_count is not None:
|
||||||
tests_badge = make_badge("tests", f"{test_count} passing", "brightgreen" if rc == 0 else "red")
|
tests_badge = make_badge("tests", f"{test_count} passing", "brightgreen" if rc == 0 else "red")
|
||||||
else:
|
else:
|
||||||
click.echo(f" WARNING: Could not extract test count from pytest output (rc={rc})")
|
click.echo(_(" WARNING: Could not extract test count from pytest output (rc={rc})", rc=rc))
|
||||||
click.echo(f" pytest stdout (last 300 chars): {stdout.strip()[-300:]}")
|
click.echo(_(" pytest stdout (last 300 chars): {stdout}", stdout=stdout.strip()[-300:]))
|
||||||
click.echo(f" pytest stderr (last 300 chars): {stderr.strip()[-300:]}")
|
click.echo(_(" pytest stderr (last 300 chars): {stderr}", stderr=stderr.strip()[-300:]))
|
||||||
tests_badge = make_badge("tests", "unknown", "red")
|
tests_badge = make_badge("tests", "unknown", "red")
|
||||||
|
|
||||||
return cov_badge, tests_badge
|
return cov_badge, tests_badge
|
||||||
@@ -328,8 +332,8 @@ def collect_doc_coverage(repo_root: Path) -> dict[str, str | int]:
|
|||||||
doc_pct = extract_doc_coverage(stdout)
|
doc_pct = extract_doc_coverage(stdout)
|
||||||
if doc_pct is not None:
|
if doc_pct is not None:
|
||||||
return make_badge("docs", f"{doc_pct}%", doc_coverage_color(doc_pct))
|
return make_badge("docs", f"{doc_pct}%", doc_coverage_color(doc_pct))
|
||||||
click.echo(f" WARNING: Could not extract doc coverage (rc={rc})")
|
click.echo(_(" WARNING: Could not extract doc coverage (rc={rc})", rc=rc))
|
||||||
click.echo(f" stderr: {stderr.strip()[:200]}")
|
click.echo(_(" stderr: {stderr}", stderr=stderr.strip()[:200]))
|
||||||
return make_badge("docs", "unknown", "red")
|
return make_badge("docs", "unknown", "red")
|
||||||
|
|
||||||
|
|
||||||
@@ -348,7 +352,7 @@ def collect_quality(repo_root: Path) -> dict[str, str | int]:
|
|||||||
([sys.executable, "-m", "pyright"], "pyright"),
|
([sys.executable, "-m", "pyright"], "pyright"),
|
||||||
([sys.executable, "-m", "bandit", "-r", "src/"], "bandit"),
|
([sys.executable, "-m", "bandit", "-r", "src/"], "bandit"),
|
||||||
]:
|
]:
|
||||||
rc, _, stderr = run_command(cmd, cwd=repo_root)
|
rc, _stdout, stderr = run_command(cmd, cwd=repo_root)
|
||||||
if rc == 0:
|
if rc == 0:
|
||||||
results.append(True)
|
results.append(True)
|
||||||
tool_names.append(f"{name}: pass")
|
tool_names.append(f"{name}: pass")
|
||||||
@@ -356,16 +360,16 @@ def collect_quality(repo_root: Path) -> dict[str, str | int]:
|
|||||||
results.append(False)
|
results.append(False)
|
||||||
# Distinguish "tool not installed" from "tool found issues"
|
# Distinguish "tool not installed" from "tool found issues"
|
||||||
if "No module named" in stderr or "not found" in stderr.lower():
|
if "No module named" in stderr or "not found" in stderr.lower():
|
||||||
click.echo(f" WARNING: {name} not installed — skipping (counted as pass)")
|
click.echo(_(" WARNING: {name} not installed — skipping (counted as pass)", name=name))
|
||||||
results[-1] = True
|
results[-1] = True
|
||||||
tool_names.append(f"{name}: not installed (skipped)")
|
tool_names.append(f"{name}: not installed (skipped)")
|
||||||
else:
|
else:
|
||||||
tool_names.append(f"{name}: FAIL")
|
tool_names.append(f"{name}: FAIL")
|
||||||
click.echo(f" WARNING: {name} failed (rc={rc})")
|
click.echo(_(" WARNING: {name} failed (rc={rc})", name=name, rc=rc))
|
||||||
click.echo(f" stderr: {stderr.strip()[:200]}")
|
click.echo(_(" stderr: {stderr}", stderr=stderr.strip()[:200]))
|
||||||
|
|
||||||
all_pass = all(results)
|
all_pass = all(results)
|
||||||
click.echo(f" Quality checks: {', '.join(tool_names)}")
|
click.echo(_(" Quality checks: {checks}", checks=", ".join(tool_names)))
|
||||||
return make_badge("code quality", "A" if all_pass else "F", "brightgreen" if all_pass else "red")
|
return make_badge("code quality", "A" if all_pass else "F", "brightgreen" if all_pass else "red")
|
||||||
|
|
||||||
|
|
||||||
@@ -377,28 +381,28 @@ def generate_badges(output_dir: Path, repo_root: Path | None = None) -> dict[str
|
|||||||
repo_root: Repository root (auto-detected if None).
|
repo_root: Repository root (auto-detected if None).
|
||||||
"""
|
"""
|
||||||
root = repo_root or resolve_repo_root()
|
root = repo_root or resolve_repo_root()
|
||||||
click.echo(f" Repo root: {root}")
|
click.echo(_(" Repo root: {root}", root=root))
|
||||||
pkg = detect_package_name(root)
|
pkg = detect_package_name(root)
|
||||||
click.echo(f" Package: {pkg or 'none'}")
|
click.echo(_(" Package: {pkg}", pkg=pkg or "none"))
|
||||||
|
|
||||||
badges: dict[str, dict[str, str | int]] = {}
|
badges: dict[str, dict[str, str | int]] = {}
|
||||||
|
|
||||||
# 1. Code coverage + test count (single pytest-cov run)
|
# 1. Code coverage + test count (single pytest-cov run)
|
||||||
click.echo(" Collecting coverage and tests...")
|
click.echo(_(" Collecting coverage and tests..."))
|
||||||
cov_badge, tests_badge = collect_coverage_and_tests(root)
|
cov_badge, tests_badge = collect_coverage_and_tests(root)
|
||||||
badges["coverage"] = cov_badge
|
badges["coverage"] = cov_badge
|
||||||
badges["tests"] = tests_badge
|
badges["tests"] = tests_badge
|
||||||
|
|
||||||
# 2. Documentation coverage
|
# 2. Documentation coverage
|
||||||
click.echo(" Collecting doc coverage...")
|
click.echo(_(" Collecting doc coverage..."))
|
||||||
badges["docs"] = collect_doc_coverage(root)
|
badges["docs"] = collect_doc_coverage(root)
|
||||||
|
|
||||||
# 3. Code quality (ruff + pyright + bandit)
|
# 3. Code quality (ruff + pyright + bandit)
|
||||||
click.echo(" Collecting code quality...")
|
click.echo(_(" Collecting code quality..."))
|
||||||
badges["quality"] = collect_quality(root)
|
badges["quality"] = collect_quality(root)
|
||||||
|
|
||||||
# 4. Version
|
# 4. Version
|
||||||
click.echo(" Collecting version...")
|
click.echo(_(" Collecting version..."))
|
||||||
version = read_version(root)
|
version = read_version(root)
|
||||||
badges["version"] = make_badge("version", f"v{version}", "blue")
|
badges["version"] = make_badge("version", f"v{version}", "blue")
|
||||||
|
|
||||||
@@ -411,7 +415,7 @@ def generate_badges(output_dir: Path, repo_root: Path | None = None) -> dict[str
|
|||||||
svg = render_svg(str(badge["label"]), str(badge["message"]), str(badge["color"]))
|
svg = render_svg(str(badge["label"]), str(badge["message"]), str(badge["color"]))
|
||||||
path = output_dir / f"{name}.svg"
|
path = output_dir / f"{name}.svg"
|
||||||
path.write_text(svg)
|
path.write_text(svg)
|
||||||
click.echo(f" Generated: {path}")
|
click.echo(_(" Generated: {path}", path=path))
|
||||||
|
|
||||||
return badges
|
return badges
|
||||||
|
|
||||||
@@ -431,11 +435,19 @@ def cli(output_dir: str, repo_root: str | None) -> None:
|
|||||||
"""Generate self-contained SVG badge files from project metrics."""
|
"""Generate self-contained SVG badge files from project metrics."""
|
||||||
out = Path(output_dir)
|
out = Path(output_dir)
|
||||||
root = Path(repo_root) if repo_root else None
|
root = Path(repo_root) if repo_root else None
|
||||||
click.echo(f"Generating badges in {out}...")
|
click.echo(_("Generating badges in {out}...", out=out))
|
||||||
badges = generate_badges(out, repo_root=root)
|
badges = generate_badges(out, repo_root=root)
|
||||||
click.echo(f"\nGenerated {len(badges)} badges:")
|
click.echo(_("\nGenerated {count} badges:", count=len(badges)))
|
||||||
for name, badge in badges.items():
|
for name, badge in badges.items():
|
||||||
click.echo(f" {name}: {badge['label']}={badge['message']} ({badge['color']})")
|
click.echo(
|
||||||
|
_(
|
||||||
|
" {name}: {label}={message} ({color})",
|
||||||
|
name=name,
|
||||||
|
label=badge["label"],
|
||||||
|
message=badge["message"],
|
||||||
|
color=badge["color"],
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
|||||||
@@ -109,7 +109,7 @@ def _generate(prefix: str) -> str:
|
|||||||
@click.option(
|
@click.option(
|
||||||
"--prefix",
|
"--prefix",
|
||||||
default=TASK_PREFIX,
|
default=TASK_PREFIX,
|
||||||
help="Task ID prefix for commit preprocessor (default: DEVX_TASK_PREFIX env var or 'DEVX').",
|
help="Task ID prefix for commit preprocessor (default: from [tool.devx] task_prefix in pyproject.toml).",
|
||||||
)
|
)
|
||||||
@click.option(
|
@click.option(
|
||||||
"--output",
|
"--output",
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ pre-built Linux binary from the official GitHub releases.
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import platform
|
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess # nosec B404
|
import subprocess # nosec B404
|
||||||
import urllib.request
|
import urllib.request
|
||||||
@@ -15,6 +14,8 @@ from pathlib import Path
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
|
from devx.tools._shared import arch_string
|
||||||
|
|
||||||
CHECKMAKE_VERSION = "0.3.2"
|
CHECKMAKE_VERSION = "0.3.2"
|
||||||
RELEASE_URL_TEMPLATE = (
|
RELEASE_URL_TEMPLATE = (
|
||||||
"https://github.com/checkmake/checkmake/releases/download/"
|
"https://github.com/checkmake/checkmake/releases/download/"
|
||||||
@@ -23,18 +24,11 @@ RELEASE_URL_TEMPLATE = (
|
|||||||
TARGET_PATH = Path("/usr/local/bin/checkmake")
|
TARGET_PATH = Path("/usr/local/bin/checkmake")
|
||||||
|
|
||||||
|
|
||||||
def _arch() -> str:
|
|
||||||
"""Return the architecture string used by checkmake releases."""
|
|
||||||
machine = platform.machine().lower()
|
|
||||||
if machine in {"x86_64", "amd64"}:
|
|
||||||
return "amd64"
|
|
||||||
if machine in {"aarch64", "arm64"}:
|
|
||||||
return "arm64"
|
|
||||||
raise click.ClickException(f"Unsupported architecture: {machine}")
|
|
||||||
|
|
||||||
|
|
||||||
def _install_with_go() -> bool:
|
def _install_with_go() -> bool:
|
||||||
"""Install checkmake using go install if Go is available."""
|
"""Install checkmake using go install if Go is available.
|
||||||
|
|
||||||
|
Returns True if the installation succeeded, False if Go is not installed.
|
||||||
|
"""
|
||||||
go_bin = shutil.which("go")
|
go_bin = shutil.which("go")
|
||||||
if go_bin is None:
|
if go_bin is None:
|
||||||
return False
|
return False
|
||||||
@@ -51,12 +45,13 @@ def _install_with_go() -> bool:
|
|||||||
|
|
||||||
def _download_binary() -> None:
|
def _download_binary() -> None:
|
||||||
"""Download the prebuilt checkmake binary for the current architecture."""
|
"""Download the prebuilt checkmake binary for the current architecture."""
|
||||||
url = RELEASE_URL_TEMPLATE.format(arch=_arch())
|
url = RELEASE_URL_TEMPLATE.format(arch=arch_string())
|
||||||
urllib.request.urlretrieve(url, TARGET_PATH) # nosec B310
|
urllib.request.urlretrieve(url, TARGET_PATH) # nosec B310
|
||||||
TARGET_PATH.chmod(0o755)
|
TARGET_PATH.chmod(0o755)
|
||||||
|
|
||||||
|
|
||||||
def main() -> None:
|
@click.command()
|
||||||
|
def cli() -> None:
|
||||||
"""Install checkmake if not already present."""
|
"""Install checkmake if not already present."""
|
||||||
if shutil.which("checkmake") is not None:
|
if shutil.which("checkmake") is not None:
|
||||||
return
|
return
|
||||||
@@ -66,4 +61,4 @@ def main() -> None:
|
|||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
main() # pragma: no cover
|
cli() # pragma: no cover
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ Handles installation of:
|
|||||||
- git-cliff (changelog generator)
|
- git-cliff (changelog generator)
|
||||||
- act_runner (Gitea Actions local runner, optional)
|
- act_runner (Gitea Actions local runner, optional)
|
||||||
- tea (Gitea CLI — official command-line tool for Gitea API operations)
|
- tea (Gitea CLI — official command-line tool for Gitea API operations)
|
||||||
|
- hadolint (Dockerfile linter)
|
||||||
|
|
||||||
Each tool is installed to ``~/.local/bin`` if not already on PATH.
|
Each tool is installed to ``~/.local/bin`` if not already on PATH.
|
||||||
Idempotent: skips tools that are already available.
|
Idempotent: skips tools that are already available.
|
||||||
@@ -39,15 +40,16 @@ ACT_RUNNER_VERSION = "0.2.11"
|
|||||||
|
|
||||||
TEA_VERSION = "0.14.1"
|
TEA_VERSION = "0.14.1"
|
||||||
|
|
||||||
|
HADOLINT_VERSION = "2.12.0"
|
||||||
|
|
||||||
|
TOFU_VERSION = "1.12.3"
|
||||||
|
|
||||||
|
|
||||||
def _arch() -> str:
|
def _arch() -> str:
|
||||||
"""Return the architecture string used by release assets."""
|
"""Return the architecture string used by release assets (delegates to shared utility)."""
|
||||||
machine = platform.machine().lower()
|
from devx.tools._shared import arch_string
|
||||||
if machine in {"x86_64", "amd64"}:
|
|
||||||
return "amd64"
|
return arch_string()
|
||||||
if machine in {"aarch64", "arm64"}:
|
|
||||||
return "arm64"
|
|
||||||
raise click.ClickException(f"Unsupported architecture: {machine}")
|
|
||||||
|
|
||||||
|
|
||||||
def _ensure_target_dir() -> Path:
|
def _ensure_target_dir() -> Path:
|
||||||
@@ -161,7 +163,40 @@ def install_tea() -> bool:
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
TOOL_NAMES = ["actionlint", "git-cliff", "act_runner", "tea"]
|
def install_hadolint() -> bool:
|
||||||
|
"""Install hadolint if not already present. Returns True if installed/skipped."""
|
||||||
|
if _is_installed("hadolint"):
|
||||||
|
click.echo("hadolint: already installed")
|
||||||
|
return True
|
||||||
|
machine = platform.machine().lower()
|
||||||
|
arch = "x86_64" if machine in {"x86_64", "amd64"} else "arm64"
|
||||||
|
url = f"https://github.com/hadolint/hadolint/releases/download/v{HADOLINT_VERSION}/hadolint-Linux-{arch}"
|
||||||
|
dest = _download_binary(url, "hadolint")
|
||||||
|
click.echo(f"hadolint: installed to {dest}")
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def install_tofu() -> bool:
|
||||||
|
"""Install OpenTofu if not already present. Returns True if installed/skipped.
|
||||||
|
|
||||||
|
Downloads the official release tarball from GitHub and extracts the
|
||||||
|
``tofu`` binary to ``~/.local/bin``.
|
||||||
|
"""
|
||||||
|
if _is_installed("tofu"):
|
||||||
|
click.echo("tofu: already installed")
|
||||||
|
return True
|
||||||
|
arch = _arch()
|
||||||
|
os_name = platform.system().lower()
|
||||||
|
url = (
|
||||||
|
f"https://github.com/opentofu/opentofu/releases/download/"
|
||||||
|
f"v{TOFU_VERSION}/tofu_{TOFU_VERSION}_{os_name}_{arch}.tar.gz"
|
||||||
|
)
|
||||||
|
dest = _download_and_extract_tarball(url, "tofu")
|
||||||
|
click.echo(f"tofu: installed to {dest}")
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
TOOL_NAMES = ["actionlint", "git-cliff", "act_runner", "tea", "hadolint", "tofu"]
|
||||||
|
|
||||||
|
|
||||||
def _install_tool(name: str) -> bool:
|
def _install_tool(name: str) -> bool:
|
||||||
@@ -174,6 +209,10 @@ def _install_tool(name: str) -> bool:
|
|||||||
return install_act_runner()
|
return install_act_runner()
|
||||||
if name == "tea":
|
if name == "tea":
|
||||||
return install_tea()
|
return install_tea()
|
||||||
|
if name == "hadolint":
|
||||||
|
return install_hadolint()
|
||||||
|
if name == "tofu":
|
||||||
|
return install_tofu()
|
||||||
raise click.ClickException(f"Unknown tool: {name}")
|
raise click.ClickException(f"Unknown tool: {name}")
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,81 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Add a label to a pull request (idempotent).
|
||||||
|
|
||||||
|
Commonly used to add the ``ready-to-merge`` label after CI passes and
|
||||||
|
review is complete. The operation is idempotent — if the label is already
|
||||||
|
attached, it succeeds without error.
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
# Add ready-to-merge to PR #42
|
||||||
|
python -m devx.tools.pr_label --pr 42 --label ready-to-merge
|
||||||
|
|
||||||
|
# Add label to current branch's PR
|
||||||
|
python -m devx.tools.pr_label --label ready-to-merge
|
||||||
|
|
||||||
|
# Add multiple labels
|
||||||
|
python -m devx.tools.pr_label --pr 42 --label ready-to-merge --label reviewed
|
||||||
|
|
||||||
|
The repository is auto-detected from ``DEVX_REPO_OWNER`` /
|
||||||
|
``DEVX_REPO_NAME`` or ``GITHUB_REPOSITORY`` environment variables.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
|
||||||
|
import click
|
||||||
|
from dotenv import load_dotenv
|
||||||
|
|
||||||
|
from devx.api_clients import GiteaClient
|
||||||
|
from devx.config import GITEA_API_URL, REPO_OWNER
|
||||||
|
from devx.i18n import _
|
||||||
|
from devx.tools.create_pr import get_repo_name
|
||||||
|
from devx.tools.pr_status import _get_current_branch_pr
|
||||||
|
|
||||||
|
load_dotenv()
|
||||||
|
|
||||||
|
|
||||||
|
@click.command()
|
||||||
|
@click.option("--pr", "pr_number", type=int, default=None, help="PR number (default: auto-detect from current branch).")
|
||||||
|
@click.option("--label", "labels", multiple=True, required=True, help="Label name(s) to add (can be repeated).")
|
||||||
|
@click.option("--owner", default=None, help="Repository owner (default: DEVX_REPO_OWNER).")
|
||||||
|
@click.option("--repo", default=None, help="Repository name (default: DEVX_REPO_NAME or GITHUB_REPOSITORY).")
|
||||||
|
def cli(
|
||||||
|
pr_number: int | None,
|
||||||
|
labels: tuple[str, ...],
|
||||||
|
owner: str | None,
|
||||||
|
repo: str | None,
|
||||||
|
) -> None:
|
||||||
|
"""Add one or more labels to a pull request (idempotent)."""
|
||||||
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
|
if not token:
|
||||||
|
raise click.ClickException(_("CI_GITEA_TOKEN is not set."))
|
||||||
|
|
||||||
|
repo_owner = owner or REPO_OWNER
|
||||||
|
if not repo_owner:
|
||||||
|
raise click.ClickException(_("Repository owner not set. Use --owner or DEVX_REPO_OWNER env var."))
|
||||||
|
repo_name = repo or get_repo_name()
|
||||||
|
|
||||||
|
client = GiteaClient(GITEA_API_URL, token, repo_owner, repo_name)
|
||||||
|
|
||||||
|
if pr_number is None:
|
||||||
|
pr_number = _get_current_branch_pr(client)
|
||||||
|
|
||||||
|
label_list = list(labels)
|
||||||
|
existing = client.get_pr_label_names(pr_number)
|
||||||
|
to_add = [lbl for lbl in label_list if lbl not in existing]
|
||||||
|
already = [lbl for lbl in label_list if lbl in existing]
|
||||||
|
|
||||||
|
if already:
|
||||||
|
for lbl in already:
|
||||||
|
click.echo(_("Label '{label}' already on PR #{pr}.", label=lbl, pr=pr_number))
|
||||||
|
|
||||||
|
if to_add:
|
||||||
|
client.add_pr_label(pr_number, to_add)
|
||||||
|
for lbl in to_add:
|
||||||
|
click.echo(_("Added label '{label}' to PR #{pr}.", label=lbl, pr=pr_number))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
cli() # pragma: no cover
|
||||||
@@ -0,0 +1,187 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Fetch logs for failed CI jobs on a pull request.
|
||||||
|
|
||||||
|
Lists CI jobs for the latest workflow run of a PR's branch, then fetches
|
||||||
|
and prints the logs of any failed jobs. Useful for diagnosing CI failures
|
||||||
|
without navigating the web UI.
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
# Show failed job logs for PR #42
|
||||||
|
python -m devx.tools.pr_logs --pr 42
|
||||||
|
|
||||||
|
# Show failed job logs for current branch's PR
|
||||||
|
python -m devx.tools.pr_logs
|
||||||
|
|
||||||
|
# Show logs for a specific job (by name)
|
||||||
|
python -m devx.tools.pr_logs --pr 42 --job quality
|
||||||
|
|
||||||
|
# Show last N lines of each failed job's logs
|
||||||
|
python -m devx.tools.pr_logs --pr 42 --tail 50
|
||||||
|
|
||||||
|
The repository is auto-detected from ``DEVX_REPO_OWNER`` /
|
||||||
|
``DEVX_REPO_NAME`` or ``GITHUB_REPOSITORY`` environment variables.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
|
||||||
|
import click
|
||||||
|
from dotenv import load_dotenv
|
||||||
|
|
||||||
|
from devx.api_clients import APIError, GiteaClient
|
||||||
|
from devx.config import GITEA_API_URL, REPO_OWNER
|
||||||
|
from devx.i18n import _
|
||||||
|
from devx.tools.create_pr import get_repo_name
|
||||||
|
from devx.tools.pr_status import _get_current_branch_pr
|
||||||
|
|
||||||
|
load_dotenv()
|
||||||
|
|
||||||
|
|
||||||
|
def _get_pr_sha(client: GiteaClient, pr_number: int) -> str:
|
||||||
|
"""Fetch the head SHA of a PR."""
|
||||||
|
pr = client.get_pr(pr_number)
|
||||||
|
return pr.get("head", {}).get("sha", "")
|
||||||
|
|
||||||
|
|
||||||
|
def _find_latest_run_by_sha(client: GiteaClient, sha: str) -> dict | None:
|
||||||
|
"""Find the latest workflow run for a commit SHA.
|
||||||
|
|
||||||
|
Gitea Actions API doesn't set head_branch for pull_request events,
|
||||||
|
so we filter by head_sha instead.
|
||||||
|
"""
|
||||||
|
data = client.list_action_runs(limit=50)
|
||||||
|
for run in data.get("workflow_runs", []):
|
||||||
|
if run.get("head_sha", "").startswith(sha):
|
||||||
|
return run
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _find_failed_jobs(jobs: list[dict]) -> list[dict]:
|
||||||
|
"""Return jobs with conclusion 'failure'."""
|
||||||
|
return [j for j in jobs if j.get("conclusion") == "failure"]
|
||||||
|
|
||||||
|
|
||||||
|
def _find_job_by_name(jobs: list[dict], name: str) -> dict | None:
|
||||||
|
"""Find a job by name (case-insensitive partial match)."""
|
||||||
|
name_lower = name.lower()
|
||||||
|
for j in jobs:
|
||||||
|
if name_lower in j.get("name", "").lower():
|
||||||
|
return j
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _print_job_summary(jobs: list[dict]) -> None:
|
||||||
|
"""Print a summary table of all jobs and their status."""
|
||||||
|
for j in jobs:
|
||||||
|
name = j.get("name", "?")
|
||||||
|
conclusion = j.get("conclusion", "pending")
|
||||||
|
status = j.get("status", "?")
|
||||||
|
symbol = "[FAIL]" if conclusion == "failure" else "[OK]" if conclusion == "success" else f"[{conclusion}]"
|
||||||
|
click.echo(f" {symbol} {name} (status: {status}, conclusion: {conclusion})")
|
||||||
|
|
||||||
|
|
||||||
|
def _print_failed_steps(job: dict) -> list[int]:
|
||||||
|
"""Print failed steps for a job. Returns list of failed step numbers."""
|
||||||
|
failed_steps = []
|
||||||
|
for step in job.get("steps", []):
|
||||||
|
if step.get("conclusion") == "failure":
|
||||||
|
name = step.get("name", "?")
|
||||||
|
num = step.get("number", "?")
|
||||||
|
click.echo(f" FAILED step #{num}: {name}")
|
||||||
|
failed_steps.append(num)
|
||||||
|
return failed_steps
|
||||||
|
|
||||||
|
|
||||||
|
def _print_logs(client: GiteaClient, job_id: int, tail: int = 0) -> None:
|
||||||
|
"""Fetch and print logs for a job. If tail > 0, print only last N lines."""
|
||||||
|
try:
|
||||||
|
logs = client.get_action_job_logs(job_id)
|
||||||
|
except APIError as e:
|
||||||
|
click.echo(_(" Could not fetch logs: {error}", error=str(e)))
|
||||||
|
return
|
||||||
|
|
||||||
|
if tail > 0:
|
||||||
|
lines = logs.strip().split("\n")
|
||||||
|
if len(lines) > tail:
|
||||||
|
click.echo(f" ... (showing last {tail} of {len(lines)} lines)")
|
||||||
|
logs = "\n".join(lines[-tail:])
|
||||||
|
|
||||||
|
for line in logs.split("\n"):
|
||||||
|
click.echo(f" {line}")
|
||||||
|
|
||||||
|
|
||||||
|
@click.command()
|
||||||
|
@click.option("--pr", "pr_number", type=int, default=None, help="PR number (default: auto-detect from current branch).")
|
||||||
|
@click.option("--job", default=None, help="Job name to show logs for (partial match, case-insensitive).")
|
||||||
|
@click.option("--tail", type=int, default=80, show_default=True, help="Show last N lines of logs (0 = all).")
|
||||||
|
@click.option("--owner", default=None, help="Repository owner (default: DEVX_REPO_OWNER).")
|
||||||
|
@click.option("--repo", default=None, help="Repository name (default: DEVX_REPO_NAME or GITHUB_REPOSITORY).")
|
||||||
|
def cli(
|
||||||
|
pr_number: int | None,
|
||||||
|
job: str | None,
|
||||||
|
tail: int,
|
||||||
|
owner: str | None,
|
||||||
|
repo: str | None,
|
||||||
|
) -> None:
|
||||||
|
"""Fetch logs for failed CI jobs on a pull request."""
|
||||||
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
|
if not token:
|
||||||
|
raise click.ClickException(_("CI_GITEA_TOKEN is not set."))
|
||||||
|
|
||||||
|
repo_owner = owner or REPO_OWNER
|
||||||
|
if not repo_owner:
|
||||||
|
raise click.ClickException(_("Repository owner not set. Use --owner or DEVX_REPO_OWNER env var."))
|
||||||
|
repo_name = repo or get_repo_name()
|
||||||
|
|
||||||
|
client = GiteaClient(GITEA_API_URL, token, repo_owner, repo_name)
|
||||||
|
|
||||||
|
if pr_number is None:
|
||||||
|
pr_number = _get_current_branch_pr(client)
|
||||||
|
click.echo(_("Fetching logs for PR #{pr_number}...", pr_number=pr_number))
|
||||||
|
|
||||||
|
sha = _get_pr_sha(client, pr_number)
|
||||||
|
if not sha:
|
||||||
|
raise click.ClickException(_("Could not determine head SHA for PR #{pr_number}.", pr_number=pr_number))
|
||||||
|
|
||||||
|
run = _find_latest_run_by_sha(client, sha)
|
||||||
|
if not run:
|
||||||
|
raise click.ClickException(_("No workflow runs found for SHA {sha}.", sha=sha[:8]))
|
||||||
|
|
||||||
|
run_id = run.get("id", 0)
|
||||||
|
run_status = run.get("status", "?")
|
||||||
|
click.echo(_("Latest run: #{run_id} (status: {status})", run_id=run_id, status=run_status))
|
||||||
|
click.echo("")
|
||||||
|
|
||||||
|
jobs = client.get_action_run_jobs(run_id)
|
||||||
|
if not jobs:
|
||||||
|
click.echo(_("No jobs found for run #{run_id}.", run_id=run_id))
|
||||||
|
return
|
||||||
|
|
||||||
|
_print_job_summary(jobs)
|
||||||
|
click.echo("")
|
||||||
|
|
||||||
|
if job:
|
||||||
|
target = _find_job_by_name(jobs, job)
|
||||||
|
if not target:
|
||||||
|
raise click.ClickException(_("No job matching '{job}' found.", job=job))
|
||||||
|
click.echo(f"Logs for job '{target.get('name', '?')}' (id={target.get('id')}):")
|
||||||
|
_print_failed_steps(target)
|
||||||
|
click.echo("")
|
||||||
|
_print_logs(client, target["id"], tail)
|
||||||
|
else:
|
||||||
|
failed = _find_failed_jobs(jobs)
|
||||||
|
if not failed:
|
||||||
|
click.echo(_("No failed jobs."))
|
||||||
|
return
|
||||||
|
for fj in failed:
|
||||||
|
click.echo(f"Logs for failed job '{fj.get('name', '?')}' (id={fj.get('id')}):")
|
||||||
|
_print_failed_steps(fj)
|
||||||
|
click.echo("")
|
||||||
|
_print_logs(client, fj["id"], tail)
|
||||||
|
click.echo("")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
cli() # pragma: no cover
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Rebase a pull request's head branch onto master via Gitea API.
|
||||||
|
|
||||||
|
Uses the Gitea ``POST /pulls/{index}/update?style=rebase`` endpoint to
|
||||||
|
rebase the PR's head branch server-side. This triggers a new
|
||||||
|
``pull_request synchronize`` event, which starts a new CI run.
|
||||||
|
|
||||||
|
This is useful when:
|
||||||
|
- You don't have the branch checked out locally
|
||||||
|
- You want to rebase a PR from another machine
|
||||||
|
- You want to trigger the auto-merge retry without local git operations
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
# Rebase PR #42
|
||||||
|
python -m devx.tools.pr_rebase --pr 42
|
||||||
|
|
||||||
|
# Rebase current branch's PR (auto-detected)
|
||||||
|
python -m devx.tools.pr_rebase
|
||||||
|
|
||||||
|
The repository is auto-detected from ``DEVX_REPO_OWNER`` /
|
||||||
|
``DEVX_REPO_NAME`` or ``GITHUB_REPOSITORY`` environment variables.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
|
||||||
|
import click
|
||||||
|
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
||||||
|
|
||||||
|
from devx.api_clients import APIError, GiteaClient
|
||||||
|
from devx.config import GITEA_API_URL
|
||||||
|
from devx.i18n import _
|
||||||
|
from devx.tools._shared import detect_pr_number
|
||||||
|
|
||||||
|
|
||||||
|
@click.command()
|
||||||
|
@click.option("--pr", type=int, help="PR number (auto-detected if omitted).")
|
||||||
|
def main(pr: int | None) -> None:
|
||||||
|
"""Rebase a pull request's head branch onto master via Gitea API."""
|
||||||
|
load_dotenv()
|
||||||
|
|
||||||
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
|
if not token:
|
||||||
|
raise click.ClickException(_("CI_GITEA_TOKEN is not set. Add it to .env or export it."))
|
||||||
|
|
||||||
|
pr_num = pr or detect_pr_number()
|
||||||
|
if not pr_num:
|
||||||
|
raise click.ClickException(
|
||||||
|
_(
|
||||||
|
"Could not detect PR number. Use --pr to specify it explicitly,\n"
|
||||||
|
"or run this command from a branch with an open PR.",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
owner = os.environ.get("DEVX_REPO_OWNER", "")
|
||||||
|
repo = os.environ.get("DEVX_REPO_NAME", "")
|
||||||
|
if not owner or not repo:
|
||||||
|
github_repo = os.environ.get("GITHUB_REPOSITORY", "")
|
||||||
|
if "/" in github_repo:
|
||||||
|
owner, repo = github_repo.split("/", 1)
|
||||||
|
|
||||||
|
if not owner or not repo:
|
||||||
|
raise click.ClickException(
|
||||||
|
_(
|
||||||
|
"Could not determine repository. Set DEVX_REPO_OWNER and DEVX_REPO_NAME\n"
|
||||||
|
"or GITHUB_REPOSITORY environment variables.",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
client = GiteaClient(GITEA_API_URL, token, owner, repo)
|
||||||
|
|
||||||
|
click.echo(_("Rebasing PR #{pr} via Gitea API...", pr=pr_num))
|
||||||
|
try:
|
||||||
|
client.update_pr_branch(pr_num, style="rebase")
|
||||||
|
except APIError as e:
|
||||||
|
raise click.ClickException(
|
||||||
|
_(
|
||||||
|
"Rebase failed with HTTP {status}: {message}",
|
||||||
|
status=e.status,
|
||||||
|
message=e.message,
|
||||||
|
)
|
||||||
|
) from None
|
||||||
|
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"PR #{pr} rebased successfully. A new CI run will start automatically.\n"
|
||||||
|
"If auto-merge is enabled (ready-to-merge label), the next CI run\n"
|
||||||
|
"will attempt to merge this PR.",
|
||||||
|
pr=pr_num,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
main()
|
||||||
@@ -0,0 +1,174 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Check CI status for a pull request or commit.
|
||||||
|
|
||||||
|
Displays the status of all CI checks for a PR (or a specific commit SHA).
|
||||||
|
Optionally polls until all checks complete (``--wait``).
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
# Check status of PR #42
|
||||||
|
python -m devx.tools.pr_status --pr 42
|
||||||
|
|
||||||
|
# Check status of current branch's PR
|
||||||
|
python -m devx.tools.pr_status
|
||||||
|
|
||||||
|
# Wait for all checks to complete (timeout 600s)
|
||||||
|
python -m devx.tools.pr_status --pr 42 --wait --timeout 600
|
||||||
|
|
||||||
|
# Check a specific commit SHA
|
||||||
|
python -m devx.tools.pr_status --sha abc1234
|
||||||
|
|
||||||
|
The repository is auto-detected from ``DEVX_REPO_OWNER`` /
|
||||||
|
``DEVX_REPO_NAME`` or ``GITHUB_REPOSITORY`` environment variables.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import subprocess # nosec B404
|
||||||
|
import time
|
||||||
|
|
||||||
|
import click
|
||||||
|
from dotenv import load_dotenv
|
||||||
|
|
||||||
|
from devx.api_clients import GiteaClient
|
||||||
|
from devx.config import GITEA_API_URL, REPO_OWNER
|
||||||
|
from devx.i18n import _
|
||||||
|
from devx.tools.create_pr import get_repo_name
|
||||||
|
|
||||||
|
load_dotenv()
|
||||||
|
|
||||||
|
# Status symbols for terminal output
|
||||||
|
_STATUS_SYMBOLS = {
|
||||||
|
"success": "[OK]",
|
||||||
|
"failure": "[FAIL]",
|
||||||
|
"error": "[FAIL]",
|
||||||
|
"pending": "[..]",
|
||||||
|
"skipped": "[SKIP]",
|
||||||
|
"none": "[--]",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _get_symbol(status: str) -> str:
|
||||||
|
return _STATUS_SYMBOLS.get(status, f"[{status}]")
|
||||||
|
|
||||||
|
|
||||||
|
def _get_pr_sha(client: GiteaClient, pr_number: int) -> str:
|
||||||
|
"""Fetch the head SHA of a PR."""
|
||||||
|
pr = client.get_pr(pr_number)
|
||||||
|
return pr.get("head", {}).get("sha", "")
|
||||||
|
|
||||||
|
|
||||||
|
def _get_current_branch_pr(client: GiteaClient) -> int:
|
||||||
|
"""Find the open PR for the current git branch."""
|
||||||
|
result = subprocess.run( # nosec
|
||||||
|
["git", "rev-parse", "--abbrev-ref", "HEAD"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
raise click.ClickException(_("Could not detect current branch: {error}", error=result.stderr.strip()))
|
||||||
|
branch = result.stdout.strip()
|
||||||
|
|
||||||
|
prs = client.list_prs(state="open")
|
||||||
|
for pr in prs:
|
||||||
|
if pr.get("head", {}).get("ref") == branch:
|
||||||
|
return int(pr["number"])
|
||||||
|
raise click.ClickException(_("No open PR found for branch '{branch}'.", branch=branch))
|
||||||
|
|
||||||
|
|
||||||
|
def print_status(client: GiteaClient, sha: str) -> str:
|
||||||
|
"""Print CI check statuses for a commit SHA. Returns the overall state."""
|
||||||
|
statuses = client.get_commit_status(sha)
|
||||||
|
if not statuses:
|
||||||
|
click.echo(_("No CI checks found for commit {sha}.", sha=sha[:8]))
|
||||||
|
return "none"
|
||||||
|
|
||||||
|
overall = "success"
|
||||||
|
for s in statuses:
|
||||||
|
context = s.get("context", "?")
|
||||||
|
status = s.get("status", "pending")
|
||||||
|
symbol = _get_symbol(status)
|
||||||
|
click.echo(f" {symbol} {context}")
|
||||||
|
if status in ("failure", "error"):
|
||||||
|
overall = "failure"
|
||||||
|
elif status == "pending" and overall != "failure":
|
||||||
|
overall = "pending"
|
||||||
|
elif status == "skipped" and overall == "success":
|
||||||
|
overall = "success"
|
||||||
|
|
||||||
|
click.echo(f"\n Overall: {_get_symbol(overall)} {overall}")
|
||||||
|
return overall
|
||||||
|
|
||||||
|
|
||||||
|
def wait_for_completion(
|
||||||
|
client: GiteaClient,
|
||||||
|
sha: str,
|
||||||
|
timeout: int = 600,
|
||||||
|
interval: int = 30,
|
||||||
|
) -> str:
|
||||||
|
"""Poll CI status until all checks complete or timeout. Returns final state."""
|
||||||
|
click.echo(_("Waiting for CI checks to complete (timeout: {timeout}s)...", timeout=timeout))
|
||||||
|
deadline = time.time() + timeout
|
||||||
|
while time.time() < deadline:
|
||||||
|
state = print_status(client, sha)
|
||||||
|
if state in ("success", "failure", "error", "none"):
|
||||||
|
return state
|
||||||
|
click.echo(f" ...still pending, retrying in {interval}s\n")
|
||||||
|
time.sleep(interval)
|
||||||
|
click.echo(_("Timeout reached after {timeout}s.", timeout=timeout))
|
||||||
|
return "pending"
|
||||||
|
|
||||||
|
|
||||||
|
@click.command()
|
||||||
|
@click.option("--pr", "pr_number", type=int, default=None, help="PR number (default: auto-detect from current branch).")
|
||||||
|
@click.option("--sha", default=None, help="Commit SHA to check (alternative to --pr).")
|
||||||
|
@click.option("--wait", "do_wait", is_flag=True, help="Poll until all checks complete.")
|
||||||
|
@click.option("--timeout", type=int, default=600, show_default=True, help="Wait timeout in seconds.")
|
||||||
|
@click.option("--interval", type=int, default=30, show_default=True, help="Poll interval in seconds.")
|
||||||
|
@click.option("--owner", default=None, help="Repository owner (default: DEVX_REPO_OWNER).")
|
||||||
|
@click.option("--repo", default=None, help="Repository name (default: DEVX_REPO_NAME or GITHUB_REPOSITORY).")
|
||||||
|
def cli(
|
||||||
|
pr_number: int | None,
|
||||||
|
sha: str | None,
|
||||||
|
do_wait: bool,
|
||||||
|
timeout: int,
|
||||||
|
interval: int,
|
||||||
|
owner: str | None,
|
||||||
|
repo: str | None,
|
||||||
|
) -> None:
|
||||||
|
"""Check CI status for a pull request or commit."""
|
||||||
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
|
if not token:
|
||||||
|
raise click.ClickException(_("CI_GITEA_TOKEN is not set."))
|
||||||
|
|
||||||
|
repo_owner = owner or REPO_OWNER
|
||||||
|
if not repo_owner:
|
||||||
|
raise click.ClickException(_("Repository owner not set. Use --owner or DEVX_REPO_OWNER env var."))
|
||||||
|
repo_name = repo or get_repo_name()
|
||||||
|
|
||||||
|
client = GiteaClient(GITEA_API_URL, token, repo_owner, repo_name)
|
||||||
|
|
||||||
|
if sha is None:
|
||||||
|
if pr_number is None:
|
||||||
|
pr_number = _get_current_branch_pr(client)
|
||||||
|
click.echo(_("Checking status for PR #{pr_number}...", pr_number=pr_number))
|
||||||
|
pr = client.get_pr(pr_number)
|
||||||
|
sha = pr.get("head", {}).get("sha", "")
|
||||||
|
if not sha:
|
||||||
|
raise click.ClickException(_("Could not determine head SHA for PR #{pr_number}.", pr_number=pr_number))
|
||||||
|
|
||||||
|
click.echo(_("Commit: {sha}", sha=sha[:12]))
|
||||||
|
click.echo("")
|
||||||
|
|
||||||
|
state = wait_for_completion(client, sha, timeout, interval) if do_wait else print_status(client, sha)
|
||||||
|
|
||||||
|
if state in ("failure", "error"):
|
||||||
|
raise click.ClickException(_("CI checks failed."))
|
||||||
|
if state == "pending" and do_wait:
|
||||||
|
raise click.ClickException(_("CI checks did not complete within timeout."))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
cli() # pragma: no cover
|
||||||
@@ -59,17 +59,7 @@ def task_exists(task_id: str) -> bool:
|
|||||||
if not token:
|
if not token:
|
||||||
return False
|
return False
|
||||||
client = VikunjaClient(VIKUNJA_API_URL, token)
|
client = VikunjaClient(VIKUNJA_API_URL, token)
|
||||||
page = 1
|
return client.find_task_by_identifier(VIKUNJA_PROJECT_ID, task_id, per_page=DEFAULT_PER_PAGE) is not None
|
||||||
while True:
|
|
||||||
tasks = client.list_project_tasks(VIKUNJA_PROJECT_ID, page=page, per_page=DEFAULT_PER_PAGE)
|
|
||||||
if not tasks:
|
|
||||||
break
|
|
||||||
if any(t.get("identifier") == task_id for t in tasks):
|
|
||||||
return True
|
|
||||||
if len(tasks) < DEFAULT_PER_PAGE:
|
|
||||||
break
|
|
||||||
page += 1
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def validate(branch: str) -> None:
|
def validate(branch: str) -> None:
|
||||||
|
|||||||
@@ -0,0 +1,97 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Rebase current branch onto origin/master and force-push.
|
||||||
|
|
||||||
|
Fetches origin/master, rebases the current branch, and force-pushes with
|
||||||
|
``--force-with-lease``. This is the manual equivalent of what
|
||||||
|
``auto_merge.py`` does automatically via the Gitea API.
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
# Rebase current branch onto master and force-push
|
||||||
|
python -m devx.tools.rebase
|
||||||
|
|
||||||
|
# Rebase without pushing (local only)
|
||||||
|
python -m devx.tools.rebase --no-push
|
||||||
|
|
||||||
|
The tool fails if:
|
||||||
|
- The rebase encounters conflicts (exits with rebase in progress)
|
||||||
|
- The force-push is rejected (remote has unexpected commits)
|
||||||
|
- Not on a branch (detached HEAD)
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess # nosec B404
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
|
|
||||||
|
def _run_git(args: list[str], check: bool = True) -> subprocess.CompletedProcess[str]:
|
||||||
|
"""Run a git command and return the result."""
|
||||||
|
return subprocess.run( # nosec B603, B607
|
||||||
|
["git", *args],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=check,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@click.command()
|
||||||
|
@click.option("--no-push", is_flag=True, help="Rebase locally without pushing.")
|
||||||
|
def main(no_push: bool) -> None:
|
||||||
|
"""Rebase current branch onto origin/master and force-push."""
|
||||||
|
# Ensure we're on a branch (check=False — we handle errors ourselves)
|
||||||
|
branch_result = _run_git(["rev-parse", "--abbrev-ref", "HEAD"], check=False)
|
||||||
|
if branch_result.returncode != 0:
|
||||||
|
raise click.ClickException(_("Could not detect current branch: {error}", error=branch_result.stderr.strip()))
|
||||||
|
branch = branch_result.stdout.strip()
|
||||||
|
if branch == "HEAD":
|
||||||
|
raise click.ClickException(_("Cannot rebase: not on a branch (detached HEAD)."))
|
||||||
|
|
||||||
|
click.echo(_("Fetching origin/master..."))
|
||||||
|
fetch = _run_git(["fetch", "origin", "master"], check=False)
|
||||||
|
if fetch.returncode != 0:
|
||||||
|
raise click.ClickException(_("Fetch failed: {error}", error=fetch.stderr.strip()))
|
||||||
|
|
||||||
|
# Check if behind master
|
||||||
|
behind = _run_git(
|
||||||
|
["rev-list", "--count", "HEAD..origin/master"],
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
behind_count = int(behind.stdout.strip()) if behind.stdout.strip().isdigit() else 0
|
||||||
|
|
||||||
|
if behind_count == 0:
|
||||||
|
click.echo(_("Branch is already up-to-date with origin/master."))
|
||||||
|
if not no_push:
|
||||||
|
click.echo(_("Nothing to push."))
|
||||||
|
return
|
||||||
|
|
||||||
|
click.echo(_("Branch is {count} commit(s) behind master. Rebasing...", count=behind_count))
|
||||||
|
rebase = _run_git(["rebase", "origin/master"], check=False)
|
||||||
|
if rebase.returncode != 0:
|
||||||
|
raise click.ClickException(
|
||||||
|
_(
|
||||||
|
"Rebase failed (conflicts or other error):\n{error}\nResolve conflicts and run: git rebase --continue",
|
||||||
|
error=rebase.stderr.strip() or rebase.stdout.strip(),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
click.echo(_("Rebase successful."))
|
||||||
|
|
||||||
|
if not no_push:
|
||||||
|
click.echo(_("Force-pushing..."))
|
||||||
|
push = _run_git(["push", "--force-with-lease", "origin", branch], check=False)
|
||||||
|
if push.returncode != 0:
|
||||||
|
raise click.ClickException(
|
||||||
|
_(
|
||||||
|
"Force-push failed:\n{error}\nThe remote may have unexpected commits. Fetch and try again.",
|
||||||
|
error=push.stderr.strip(),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
click.echo(_("Pushed {branch} to origin.", branch=branch))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
main()
|
||||||
@@ -64,19 +64,19 @@ def _install_ansible_collections(bin_dir: str) -> None:
|
|||||||
|
|
||||||
|
|
||||||
def _configure_tea_login() -> None:
|
def _configure_tea_login() -> None:
|
||||||
"""Configure tea CLI login from .env if REPO_TOKEN is set.
|
"""Configure tea CLI login from .env if CI_GITEA_TOKEN is set.
|
||||||
|
|
||||||
Idempotent: if a login with the same name already exists, it is not re-added.
|
Idempotent: if a login with the same name already exists, it is not re-added.
|
||||||
Skips if tea is not installed or REPO_TOKEN is not set.
|
Skips if tea is not installed or CI_GITEA_TOKEN is not set.
|
||||||
"""
|
"""
|
||||||
tea_bin = shutil.which("tea")
|
tea_bin = shutil.which("tea")
|
||||||
if tea_bin is None:
|
if tea_bin is None:
|
||||||
click.echo("tea: not installed — run 'make install-tools' to install it.")
|
click.echo("tea: not installed — run 'make install-tools' to install it.")
|
||||||
return
|
return
|
||||||
|
|
||||||
token = os.environ.get("REPO_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not token:
|
if not token:
|
||||||
click.echo("tea: REPO_TOKEN not set — skipping login configuration.")
|
click.echo("tea: CI_GITEA_TOKEN not set — skipping login configuration.")
|
||||||
return
|
return
|
||||||
|
|
||||||
api_url = os.environ.get("DEVX_GITEA_API_URL", "https://git.oblachno.oblachno.fyi/api/v1")
|
api_url = os.environ.get("DEVX_GITEA_API_URL", "https://git.oblachno.oblachno.fyi/api/v1")
|
||||||
|
|||||||
@@ -0,0 +1,138 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Set up the project inside a pre-built CI image.
|
||||||
|
|
||||||
|
CI images (e.g. ``ci-quality:latest``) ship with a Python virtualenv at
|
||||||
|
``/opt/venv`` that already contains the runtime dependencies. This tool
|
||||||
|
links that venv to ``.venv`` in the project root and installs the project
|
||||||
|
itself in editable mode, optionally with extras.
|
||||||
|
|
||||||
|
If ``/opt/venv`` does not exist (local development), falls back to
|
||||||
|
``make setup-ci`` via ``subprocess``.
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
python3 -m devx.tools.setup_image # runtime deps only
|
||||||
|
python3 -m devx.tools.setup_image --extras lint # runtime + lint deps
|
||||||
|
python3 -m devx.tools.setup_image --extras ci,lint
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import subprocess # nosec B404
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
|
DEFAULT_VENV = ".venv"
|
||||||
|
OPT_VENV = "/opt/venv"
|
||||||
|
FALLBACK_TARGET = "setup-ci"
|
||||||
|
|
||||||
|
|
||||||
|
def _build_pip_extra_index_url(
|
||||||
|
gitea_host: str,
|
||||||
|
gitea_org: str,
|
||||||
|
username: str,
|
||||||
|
token: str,
|
||||||
|
) -> str:
|
||||||
|
"""Build the PIP_EXTRA_INDEX_URL for the Gitea PyPI registry.
|
||||||
|
|
||||||
|
Returns a URL of the form:
|
||||||
|
https://<user>:<token>@<host>/api/packages/<org>/pypi/simple/
|
||||||
|
"""
|
||||||
|
return f"https://{username}:{token}@{gitea_host}/api/packages/{gitea_org}/pypi/simple/"
|
||||||
|
|
||||||
|
|
||||||
|
def _install_in_image(
|
||||||
|
venv_link: str,
|
||||||
|
opt_venv: str,
|
||||||
|
extras: str,
|
||||||
|
gitea_host: str,
|
||||||
|
gitea_org: str,
|
||||||
|
) -> None:
|
||||||
|
"""Link /opt/venv to .venv, activate it, and pip install the project.
|
||||||
|
|
||||||
|
Sets ``PIP_EXTRA_INDEX_URL`` when ``CI_GITEA_TOKEN`` is available so
|
||||||
|
that private packages from the Gitea PyPI registry can be installed.
|
||||||
|
"""
|
||||||
|
# Symlink /opt/venv → .venv
|
||||||
|
link = Path(venv_link)
|
||||||
|
if link.exists() or link.is_symlink():
|
||||||
|
link.unlink()
|
||||||
|
link.symlink_to(opt_venv)
|
||||||
|
|
||||||
|
# Build pip install command
|
||||||
|
spec = f".[{extras}]" if extras else "."
|
||||||
|
pip_bin = str(Path(venv_link) / "bin" / "pip")
|
||||||
|
cmd = [pip_bin, "install", "--no-cache-dir", "-e", spec]
|
||||||
|
|
||||||
|
env = os.environ.copy()
|
||||||
|
token = env.get("CI_GITEA_TOKEN", "")
|
||||||
|
if token:
|
||||||
|
username = env.get("CI_GITEA_USERNAME", "emil")
|
||||||
|
env["PIP_EXTRA_INDEX_URL"] = _build_pip_extra_index_url(
|
||||||
|
gitea_host,
|
||||||
|
gitea_org,
|
||||||
|
username,
|
||||||
|
token,
|
||||||
|
)
|
||||||
|
|
||||||
|
click.echo(f"[setup-image] Linked {opt_venv}" + (f" with [{extras}]" if extras else "") + ".")
|
||||||
|
subprocess.run(cmd, check=True, env=env) # nosec B603
|
||||||
|
|
||||||
|
|
||||||
|
def _fallback_to_setup_ci() -> None:
|
||||||
|
"""Fall back to ``make setup-ci`` when /opt/venv is not present."""
|
||||||
|
click.echo(f"[setup-image] {OPT_VENV} not found — falling back to {FALLBACK_TARGET}")
|
||||||
|
subprocess.run( # nosec B603, B607
|
||||||
|
["make", FALLBACK_TARGET],
|
||||||
|
check=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@click.command()
|
||||||
|
@click.option(
|
||||||
|
"--venv",
|
||||||
|
default=DEFAULT_VENV,
|
||||||
|
show_default=True,
|
||||||
|
help="Path to the local venv symlink (e.g. .venv).",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--opt-venv",
|
||||||
|
default=OPT_VENV,
|
||||||
|
show_default=True,
|
||||||
|
help="Path to the pre-built venv inside the CI image.",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--extras",
|
||||||
|
default="",
|
||||||
|
help="Comma-separated dependency extras (e.g. 'ci,lint'). Empty for runtime only.",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--gitea-host",
|
||||||
|
default="git.oblachno.oblachno.fyi",
|
||||||
|
show_default=True,
|
||||||
|
help="Gitea host for the PyPI registry.",
|
||||||
|
)
|
||||||
|
@click.option(
|
||||||
|
"--gitea-org",
|
||||||
|
default="oblachno-oss",
|
||||||
|
show_default=True,
|
||||||
|
help="Gitea org for the PyPI registry.",
|
||||||
|
)
|
||||||
|
def cli(
|
||||||
|
venv: str,
|
||||||
|
opt_venv: str,
|
||||||
|
extras: str,
|
||||||
|
gitea_host: str,
|
||||||
|
gitea_org: str,
|
||||||
|
) -> None:
|
||||||
|
"""Set up the project using a pre-built CI image venv."""
|
||||||
|
if Path(opt_venv).is_dir():
|
||||||
|
_install_in_image(venv, opt_venv, extras, gitea_host, gitea_org)
|
||||||
|
else:
|
||||||
|
_fallback_to_setup_ci()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
cli() # pragma: no cover
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""OpenTofu operations: init and validate across directories.
|
||||||
|
|
||||||
|
Handles initialization and validation of OpenTofu configurations across
|
||||||
|
multiple directories (modules + environments). Supports CI mode with
|
||||||
|
``-backend=false`` to avoid state backend access.
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
python3 -m devx.tools.tofu_ops init --env staging
|
||||||
|
python3 -m devx.tools.tofu_ops validate
|
||||||
|
python3 -m devx.tools.tofu_ops validate --ci
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess # nosec B404
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
|
DEFAULT_ENV_DIRS = ["tofu/environments/{env}", "tofu/environments/dns"]
|
||||||
|
DEFAULT_VALIDATE_DIRS = [
|
||||||
|
"tofu/modules/hetzner-vm",
|
||||||
|
"tofu/modules/hetzner-network",
|
||||||
|
"tofu/environments/staging",
|
||||||
|
"tofu/environments/production",
|
||||||
|
"tofu/environments/dns",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _run_tofu(cmd: list[str], cwd: Path) -> None:
|
||||||
|
"""Run a tofu command in the given directory, raising on failure."""
|
||||||
|
click.echo(f" -> {cwd}")
|
||||||
|
result = subprocess.run( # nosec B603, B607
|
||||||
|
cmd,
|
||||||
|
cwd=str(cwd),
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("tofu command failed in {dir}: {error}", dir=cwd, error=result.stderr.strip()),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def tofu_init(env: str, root: str = ".", extra_dirs: list[str] | None = None) -> None:
|
||||||
|
"""Run ``tofu init`` in the environment directory and DNS directory.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
env: Environment name (e.g. staging, production).
|
||||||
|
root: Repository root directory.
|
||||||
|
extra_dirs: Additional directory patterns to initialize.
|
||||||
|
"""
|
||||||
|
root_path = Path(root)
|
||||||
|
dirs = [d.format(env=env) for d in (extra_dirs or DEFAULT_ENV_DIRS)]
|
||||||
|
for dir_pattern in dirs:
|
||||||
|
dir_path = root_path / dir_pattern
|
||||||
|
if dir_path.is_dir():
|
||||||
|
click.echo(f"[tofu-init] Initializing {dir_path}...")
|
||||||
|
_run_tofu(["tofu", "init"], dir_path)
|
||||||
|
click.echo("[tofu-init] Done.")
|
||||||
|
|
||||||
|
|
||||||
|
def tofu_validate(
|
||||||
|
root: str = ".",
|
||||||
|
dirs: list[str] | None = None,
|
||||||
|
ci: bool = False,
|
||||||
|
) -> None:
|
||||||
|
"""Run ``tofu validate`` in all OpenTofu directories.
|
||||||
|
|
||||||
|
In CI mode, runs ``tofu init -backend=false`` before validate to avoid
|
||||||
|
state backend access.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
root: Repository root directory.
|
||||||
|
dirs: List of directory paths to validate (relative to root).
|
||||||
|
ci: If True, use CI mode with -backend=false.
|
||||||
|
"""
|
||||||
|
root_path = Path(root)
|
||||||
|
target_dirs = dirs or DEFAULT_VALIDATE_DIRS
|
||||||
|
mode = "ci" if ci else "validate"
|
||||||
|
click.echo(f"[tofu-{mode}] Validating OpenTofu configurations...")
|
||||||
|
for dir_rel in target_dirs:
|
||||||
|
dir_path = root_path / dir_rel
|
||||||
|
if not dir_path.is_dir():
|
||||||
|
continue
|
||||||
|
if ci:
|
||||||
|
_run_tofu(["tofu", "init", "-backend=false", "-input=false"], dir_path)
|
||||||
|
_run_tofu(["tofu", "validate"], dir_path)
|
||||||
|
click.echo(f"[tofu-{mode}] All configurations valid.")
|
||||||
|
|
||||||
|
|
||||||
|
@click.group()
|
||||||
|
def cli() -> None:
|
||||||
|
"""OpenTofu operations."""
|
||||||
|
|
||||||
|
|
||||||
|
@cli.command()
|
||||||
|
@click.option("--env", required=True, help="Environment name (staging, production).")
|
||||||
|
@click.option("--root", default=".", help="Repository root directory.")
|
||||||
|
def init(env: str, root: str) -> None:
|
||||||
|
"""Initialize OpenTofu in an environment."""
|
||||||
|
tofu_init(env, root)
|
||||||
|
|
||||||
|
|
||||||
|
@cli.command()
|
||||||
|
@click.option("--root", default=".", help="Repository root directory.")
|
||||||
|
@click.option("--ci", is_flag=True, default=False, help="CI mode: use -backend=false.")
|
||||||
|
def validate(root: str, ci: bool) -> None:
|
||||||
|
"""Validate OpenTofu configurations."""
|
||||||
|
tofu_validate(root, ci=ci)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
cli() # pragma: no cover
|
||||||
+1292
-124
File diff suppressed because it is too large
Load Diff
+135
-25
@@ -6,7 +6,7 @@ from unittest.mock import MagicMock, patch
|
|||||||
import pytest
|
import pytest
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
from devx.api_clients import GiteaClient, VikunjaClient, _is_retryable, _parse_error
|
from devx.api_clients import GiteaClient, VikunjaClient, _parse_error
|
||||||
from devx.config import (
|
from devx.config import (
|
||||||
DEFAULT_PER_PAGE,
|
DEFAULT_PER_PAGE,
|
||||||
DEFAULT_TIMEOUT,
|
DEFAULT_TIMEOUT,
|
||||||
@@ -233,6 +233,18 @@ class TestGiteaClient:
|
|||||||
json={"Do": "squash", "MergeTitleField": "fix: bug"},
|
json={"Do": "squash", "MergeTitleField": "fix: bug"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def test_update_pr_branch(self) -> None:
|
||||||
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
|
client._session.request = MagicMock(return_value=_mock_response())
|
||||||
|
|
||||||
|
client.update_pr_branch(7, style="rebase")
|
||||||
|
client._session.request.assert_called_once_with(
|
||||||
|
"POST",
|
||||||
|
"https://git.example.com/repos/owner/repo/pulls/7/update",
|
||||||
|
timeout=DEFAULT_TIMEOUT,
|
||||||
|
params={"style": "rebase"},
|
||||||
|
)
|
||||||
|
|
||||||
def test_get_pr_labels(self) -> None:
|
def test_get_pr_labels(self) -> None:
|
||||||
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
client._session.request = MagicMock(return_value=_mock_response([{"name": "ready-to-merge"}]))
|
client._session.request = MagicMock(return_value=_mock_response([{"name": "ready-to-merge"}]))
|
||||||
@@ -507,7 +519,7 @@ class TestGiteaClient:
|
|||||||
assert result["id"] == 1
|
assert result["id"] == 1
|
||||||
assert client._session.request.call_count == 2
|
assert client._session.request.call_count == 2
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_request_retries_on_429(self, mock_sleep: MagicMock) -> None:
|
def test_request_retries_on_429(self, mock_sleep: MagicMock) -> None:
|
||||||
"""Should retry on 429 rate limit with exponential backoff."""
|
"""Should retry on 429 rate limit with exponential backoff."""
|
||||||
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
@@ -520,7 +532,7 @@ class TestGiteaClient:
|
|||||||
assert client._session.request.call_count == 3
|
assert client._session.request.call_count == 3
|
||||||
assert mock_sleep.call_count == 2
|
assert mock_sleep.call_count == 2
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_request_retries_on_503(self, mock_sleep: MagicMock) -> None:
|
def test_request_retries_on_503(self, mock_sleep: MagicMock) -> None:
|
||||||
"""Should retry on 503 service unavailable."""
|
"""Should retry on 503 service unavailable."""
|
||||||
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
@@ -532,7 +544,7 @@ class TestGiteaClient:
|
|||||||
assert result.json() == {"ok": True}
|
assert result.json() == {"ok": True}
|
||||||
assert client._session.request.call_count == 2
|
assert client._session.request.call_count == 2
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_request_no_retry_on_404(self, mock_sleep: MagicMock) -> None:
|
def test_request_no_retry_on_404(self, mock_sleep: MagicMock) -> None:
|
||||||
"""Should NOT retry on 404 — it's not a transient error."""
|
"""Should NOT retry on 404 — it's not a transient error."""
|
||||||
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
@@ -545,7 +557,7 @@ class TestGiteaClient:
|
|||||||
assert client._session.request.call_count == 1
|
assert client._session.request.call_count == 1
|
||||||
mock_sleep.assert_not_called()
|
mock_sleep.assert_not_called()
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_request_retries_on_connection_error(self, mock_sleep: MagicMock) -> None:
|
def test_request_retries_on_connection_error(self, mock_sleep: MagicMock) -> None:
|
||||||
"""Should retry on connection errors."""
|
"""Should retry on connection errors."""
|
||||||
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
@@ -555,7 +567,7 @@ class TestGiteaClient:
|
|||||||
assert result.json() == {"ok": True}
|
assert result.json() == {"ok": True}
|
||||||
assert client._session.request.call_count == 2
|
assert client._session.request.call_count == 2
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_request_max_retries_exhausted(self, mock_sleep: MagicMock) -> None:
|
def test_request_max_retries_exhausted(self, mock_sleep: MagicMock) -> None:
|
||||||
"""Should raise APIError after max retries on persistent 503."""
|
"""Should raise APIError after max retries on persistent 503."""
|
||||||
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
@@ -567,7 +579,7 @@ class TestGiteaClient:
|
|||||||
assert exc_info.value.status == 503
|
assert exc_info.value.status == 503
|
||||||
assert client._session.request.call_count == 3 # MAX_RETRIES
|
assert client._session.request.call_count == 3 # MAX_RETRIES
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_request_connection_error_exhausted(self, mock_sleep: MagicMock) -> None:
|
def test_request_connection_error_exhausted(self, mock_sleep: MagicMock) -> None:
|
||||||
"""Should raise APIError after max retries on persistent connection errors."""
|
"""Should raise APIError after max retries on persistent connection errors."""
|
||||||
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
@@ -691,7 +703,7 @@ class TestVikunjaClient:
|
|||||||
json={"id": 42, "title": "My task", "done": True},
|
json={"id": 42, "title": "My task", "done": True},
|
||||||
)
|
)
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_http_error_raises_api_error(self, mock_sleep: MagicMock) -> None:
|
def test_http_error_raises_api_error(self, mock_sleep: MagicMock) -> None:
|
||||||
client = VikunjaClient("https://work.example.com", "tok")
|
client = VikunjaClient("https://work.example.com", "tok")
|
||||||
mock_resp = MagicMock()
|
mock_resp = MagicMock()
|
||||||
@@ -713,7 +725,7 @@ class TestVikunjaClient:
|
|||||||
client.list_tasks()
|
client.list_tasks()
|
||||||
assert "connection failed" in str(exc_info.value)
|
assert "connection failed" in str(exc_info.value)
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_vikunja_retries_on_503(self, mock_sleep: MagicMock) -> None:
|
def test_vikunja_retries_on_503(self, mock_sleep: MagicMock) -> None:
|
||||||
"""VikunjaClient should also retry on 503."""
|
"""VikunjaClient should also retry on 503."""
|
||||||
client = VikunjaClient("https://work.example.com", "tok")
|
client = VikunjaClient("https://work.example.com", "tok")
|
||||||
@@ -725,7 +737,7 @@ class TestVikunjaClient:
|
|||||||
assert len(result) == 1
|
assert len(result) == 1
|
||||||
assert client._session.request.call_count == 2
|
assert client._session.request.call_count == 2
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_vikunja_retries_on_connection_error(self, mock_sleep: MagicMock) -> None:
|
def test_vikunja_retries_on_connection_error(self, mock_sleep: MagicMock) -> None:
|
||||||
"""VikunjaClient should retry on connection errors."""
|
"""VikunjaClient should retry on connection errors."""
|
||||||
client = VikunjaClient("https://work.example.com", "tok")
|
client = VikunjaClient("https://work.example.com", "tok")
|
||||||
@@ -735,7 +747,7 @@ class TestVikunjaClient:
|
|||||||
assert len(result) == 1
|
assert len(result) == 1
|
||||||
assert client._session.request.call_count == 2
|
assert client._session.request.call_count == 2
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_vikunja_max_retries_exhausted(self, mock_sleep: MagicMock) -> None:
|
def test_vikunja_max_retries_exhausted(self, mock_sleep: MagicMock) -> None:
|
||||||
"""VikunjaClient should raise APIError after max retries on persistent 503."""
|
"""VikunjaClient should raise APIError after max retries on persistent 503."""
|
||||||
client = VikunjaClient("https://work.example.com", "tok")
|
client = VikunjaClient("https://work.example.com", "tok")
|
||||||
@@ -747,7 +759,7 @@ class TestVikunjaClient:
|
|||||||
assert exc_info.value.status == 503
|
assert exc_info.value.status == 503
|
||||||
assert client._session.request.call_count == 3 # MAX_RETRIES
|
assert client._session.request.call_count == 3 # MAX_RETRIES
|
||||||
|
|
||||||
@patch("devx.api_clients.time.sleep")
|
@patch("time.sleep")
|
||||||
def test_vikunja_connection_error_exhausted(self, mock_sleep: MagicMock) -> None:
|
def test_vikunja_connection_error_exhausted(self, mock_sleep: MagicMock) -> None:
|
||||||
"""VikunjaClient should raise APIError after max retries on persistent connection errors."""
|
"""VikunjaClient should raise APIError after max retries on persistent connection errors."""
|
||||||
client = VikunjaClient("https://work.example.com", "tok")
|
client = VikunjaClient("https://work.example.com", "tok")
|
||||||
@@ -781,21 +793,119 @@ class TestVikunjaClient:
|
|||||||
call_kwargs = client._session.request.call_args.kwargs
|
call_kwargs = client._session.request.call_args.kwargs
|
||||||
assert call_kwargs["json"]["description"] == ""
|
assert call_kwargs["json"]["description"] == ""
|
||||||
|
|
||||||
|
def test_find_task_by_identifier_found(self) -> None:
|
||||||
|
client = VikunjaClient("https://work.example.com", "tok")
|
||||||
|
client._session.request = MagicMock(
|
||||||
|
return_value=_mock_response([{"identifier": "DEVX-1"}, {"identifier": "DEVX-42", "title": "Found"}])
|
||||||
|
)
|
||||||
|
result = client.find_task_by_identifier(6, "DEVX-42", per_page=50)
|
||||||
|
assert result is not None
|
||||||
|
assert result["title"] == "Found"
|
||||||
|
|
||||||
class TestIsRetryable:
|
def test_find_task_by_identifier_not_found(self) -> None:
|
||||||
def test_connection_error_is_retryable(self) -> None:
|
client = VikunjaClient("https://work.example.com", "tok")
|
||||||
assert _is_retryable(requests.ConnectionError("refused")) is True
|
client._session.request = MagicMock(
|
||||||
|
return_value=_mock_response([{"identifier": "DEVX-1"}, {"identifier": "DEVX-2"}])
|
||||||
|
)
|
||||||
|
result = client.find_task_by_identifier(6, "DEVX-99", per_page=50)
|
||||||
|
assert result is None
|
||||||
|
|
||||||
def test_timeout_is_retryable(self) -> None:
|
def test_find_task_by_identifier_empty_project(self) -> None:
|
||||||
assert _is_retryable(requests.Timeout("timed out")) is True
|
client = VikunjaClient("https://work.example.com", "tok")
|
||||||
|
client._session.request = MagicMock(return_value=_mock_response([]))
|
||||||
|
result = client.find_task_by_identifier(6, "DEVX-1", per_page=50)
|
||||||
|
assert result is None
|
||||||
|
|
||||||
def test_429_is_retryable(self) -> None:
|
def test_find_task_by_identifier_paginates(self) -> None:
|
||||||
err = _mock_http_error(429, "rate limited")
|
client = VikunjaClient("https://work.example.com", "tok")
|
||||||
assert _is_retryable(err) is True
|
full_page = [{"identifier": f"DEVX-{i}"} for i in range(50)]
|
||||||
|
client._session.request = MagicMock(
|
||||||
|
side_effect=[
|
||||||
|
_mock_response(full_page),
|
||||||
|
_mock_response([{"identifier": "DEVX-50", "title": "Found on page 2"}]),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
result = client.find_task_by_identifier(6, "DEVX-50", per_page=50)
|
||||||
|
assert result is not None
|
||||||
|
assert result["title"] == "Found on page 2"
|
||||||
|
|
||||||
def test_404_is_not_retryable(self) -> None:
|
|
||||||
err = _mock_http_error(404, "not found")
|
|
||||||
assert _is_retryable(err) is False
|
|
||||||
|
|
||||||
def test_generic_exception_is_not_retryable(self) -> None:
|
class TestGiteaClientPrLabels:
|
||||||
assert _is_retryable(ValueError("oops")) is False
|
def test_add_pr_label(self) -> None:
|
||||||
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
|
client._session.request = MagicMock(return_value=_mock_response({}))
|
||||||
|
client.add_pr_label(42, ["ready-to-merge"])
|
||||||
|
client._session.request.assert_called_once_with(
|
||||||
|
"POST",
|
||||||
|
"https://git.example.com/repos/owner/repo/issues/42/labels",
|
||||||
|
timeout=DEFAULT_TIMEOUT,
|
||||||
|
json={"labels": ["ready-to-merge"]},
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_add_pr_label_multiple(self) -> None:
|
||||||
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
|
client._session.request = MagicMock(return_value=_mock_response({}))
|
||||||
|
client.add_pr_label(42, ["ready-to-merge", "reviewed"])
|
||||||
|
call_kwargs = client._session.request.call_args.kwargs
|
||||||
|
assert call_kwargs["json"]["labels"] == ["ready-to-merge", "reviewed"]
|
||||||
|
|
||||||
|
def test_get_pr_label_names(self) -> None:
|
||||||
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
|
client._session.request = MagicMock(return_value=_mock_response([{"name": "bug"}, {"name": "ready-to-merge"}]))
|
||||||
|
result = client.get_pr_label_names(42)
|
||||||
|
assert result == ["bug", "ready-to-merge"]
|
||||||
|
client._session.request.assert_called_once_with(
|
||||||
|
"GET",
|
||||||
|
"https://git.example.com/repos/owner/repo/issues/42/labels",
|
||||||
|
timeout=DEFAULT_TIMEOUT,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestGiteaClientActions:
|
||||||
|
def test_list_action_runs(self) -> None:
|
||||||
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
|
client._session.request = MagicMock(
|
||||||
|
return_value=_mock_response({"workflow_runs": [{"id": 1, "status": "completed"}], "total_count": 1})
|
||||||
|
)
|
||||||
|
result = client.list_action_runs(branch="feature-branch", limit=1)
|
||||||
|
assert result["total_count"] == 1
|
||||||
|
client._session.request.assert_called_once_with(
|
||||||
|
"GET",
|
||||||
|
"https://git.example.com/repos/owner/repo/actions/runs",
|
||||||
|
timeout=DEFAULT_TIMEOUT,
|
||||||
|
params={"branch": "feature-branch", "limit": 1},
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_get_action_run_jobs(self) -> None:
|
||||||
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
|
client._session.request = MagicMock(
|
||||||
|
return_value=_mock_response({"jobs": [{"id": 100, "name": "quality", "conclusion": "failure"}]})
|
||||||
|
)
|
||||||
|
result = client.get_action_run_jobs(1410)
|
||||||
|
assert len(result) == 1
|
||||||
|
assert result[0]["name"] == "quality"
|
||||||
|
client._session.request.assert_called_once_with(
|
||||||
|
"GET",
|
||||||
|
"https://git.example.com/repos/owner/repo/actions/runs/1410/jobs",
|
||||||
|
timeout=DEFAULT_TIMEOUT,
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_get_action_run_jobs_empty(self) -> None:
|
||||||
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
|
client._session.request = MagicMock(return_value=_mock_response({}))
|
||||||
|
result = client.get_action_run_jobs(1410)
|
||||||
|
assert result == []
|
||||||
|
|
||||||
|
def test_get_action_job_logs(self) -> None:
|
||||||
|
client = GiteaClient("https://git.example.com", "tok", "owner", "repo")
|
||||||
|
mock_resp = MagicMock()
|
||||||
|
mock_resp.text = "log line 1\nlog line 2"
|
||||||
|
mock_resp.raise_for_status = MagicMock()
|
||||||
|
client._session.request = MagicMock(return_value=mock_resp)
|
||||||
|
result = client.get_action_job_logs(10026)
|
||||||
|
assert "log line 1" in result
|
||||||
|
client._session.request.assert_called_once_with(
|
||||||
|
"GET",
|
||||||
|
"https://git.example.com/repos/owner/repo/actions/jobs/10026/logs",
|
||||||
|
timeout=DEFAULT_TIMEOUT,
|
||||||
|
)
|
||||||
|
|||||||
@@ -6,12 +6,12 @@ import click
|
|||||||
import pytest
|
import pytest
|
||||||
from click.testing import CliRunner
|
from click.testing import CliRunner
|
||||||
|
|
||||||
|
from devx.ci._shared import run_cmd
|
||||||
from devx.ci.auto_merge import (
|
from devx.ci.auto_merge import (
|
||||||
extract_conventional_msg,
|
extract_conventional_msg,
|
||||||
extract_task_id,
|
extract_task_id,
|
||||||
main,
|
main,
|
||||||
read_taskid,
|
read_taskid,
|
||||||
run_cmd,
|
|
||||||
validate_pr_title,
|
validate_pr_title,
|
||||||
validate_pr_title_matches_vikunja,
|
validate_pr_title_matches_vikunja,
|
||||||
)
|
)
|
||||||
@@ -195,6 +195,43 @@ class TestExtractConventionalMsg:
|
|||||||
]
|
]
|
||||||
assert extract_conventional_msg(commits) == "feat: add feature"
|
assert extract_conventional_msg(commits) == "feat: add feature"
|
||||||
|
|
||||||
|
def test_prefers_feat_over_refactor(self) -> None:
|
||||||
|
"""When both feat and refactor commits exist, feat wins."""
|
||||||
|
commits = [
|
||||||
|
{"commit": {"message": "refactor: add find_task_by_identifier"}},
|
||||||
|
{"commit": {"message": "fix: remove hardcoded fallbacks"}},
|
||||||
|
{"commit": {"message": "feat: add manual review support"}},
|
||||||
|
]
|
||||||
|
assert extract_conventional_msg(commits) == "feat: add manual review support"
|
||||||
|
|
||||||
|
def test_prefers_fix_over_docs(self) -> None:
|
||||||
|
commits = [
|
||||||
|
{"commit": {"message": "docs: update README"}},
|
||||||
|
{"commit": {"message": "fix: resolve bug"}},
|
||||||
|
]
|
||||||
|
assert extract_conventional_msg(commits) == "fix: resolve bug"
|
||||||
|
|
||||||
|
def test_scope_in_prefix(self) -> None:
|
||||||
|
commits = [
|
||||||
|
{"commit": {"message": "refactor(ci): cleanup code"}},
|
||||||
|
{"commit": {"message": "feat(api): add endpoint"}},
|
||||||
|
]
|
||||||
|
assert extract_conventional_msg(commits) == "feat(api): add endpoint"
|
||||||
|
|
||||||
|
def test_strips_task_id_prefix(self) -> None:
|
||||||
|
"""Commit messages with a task ID prefix should have it stripped."""
|
||||||
|
commits = [
|
||||||
|
{"commit": {"message": "DEVX-12: fix: resolve timeout"}},
|
||||||
|
]
|
||||||
|
assert extract_conventional_msg(commits) == "fix: resolve timeout"
|
||||||
|
|
||||||
|
def test_strips_task_id_prefix_fallback(self) -> None:
|
||||||
|
"""Fallback to newest commit should also strip task ID prefix."""
|
||||||
|
commits = [
|
||||||
|
{"commit": {"message": "DEVX-12: random message"}},
|
||||||
|
]
|
||||||
|
assert extract_conventional_msg(commits) == "random message"
|
||||||
|
|
||||||
|
|
||||||
# -- run_cmd --
|
# -- run_cmd --
|
||||||
|
|
||||||
@@ -217,7 +254,7 @@ class TestRunCmd:
|
|||||||
|
|
||||||
|
|
||||||
class TestMain:
|
class TestMain:
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
||||||
@patch("devx.ci.auto_merge.GiteaClient")
|
@patch("devx.ci.auto_merge.GiteaClient")
|
||||||
def test_full_merge_flow(
|
def test_full_merge_flow(
|
||||||
@@ -239,14 +276,14 @@ class TestMain:
|
|||||||
assert result.exit_code == 0, result.output
|
assert result.exit_code == 0, result.output
|
||||||
mock_client.merge_pr.assert_called_once_with(7, "DEVX-19: fix: resolve timeout")
|
mock_client.merge_pr.assert_called_once_with(7, "DEVX-19: fix: resolve timeout")
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": ""}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": ""}, clear=True)
|
||||||
def test_no_token_raises(self) -> None:
|
def test_no_token_raises(self) -> None:
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(main, ["DEVX-19-fix", "DEVX-19: test", "owner/repo", "7"])
|
result = runner.invoke(main, ["DEVX-19-fix", "DEVX-19: test", "owner/repo", "7"])
|
||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "REPO_TOKEN" in result.output
|
assert "CI_GITEA_TOKEN" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.ci.auto_merge.GiteaClient")
|
@patch("devx.ci.auto_merge.GiteaClient")
|
||||||
def test_no_task_id_raises(self, mock_client_cls: MagicMock, tmp_path, monkeypatch) -> None: # type: ignore[no-untyped-def]
|
def test_no_task_id_raises(self, mock_client_cls: MagicMock, tmp_path, monkeypatch) -> None: # type: ignore[no-untyped-def]
|
||||||
monkeypatch.chdir(tmp_path)
|
monkeypatch.chdir(tmp_path)
|
||||||
@@ -256,7 +293,7 @@ class TestMain:
|
|||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "No task ID" in result.output
|
assert "No task ID" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.ci.auto_merge.GiteaClient")
|
@patch("devx.ci.auto_merge.GiteaClient")
|
||||||
def test_invalid_pr_title_raises(self, mock_client_cls: MagicMock, tmp_path, monkeypatch) -> None: # type: ignore[no-untyped-def]
|
def test_invalid_pr_title_raises(self, mock_client_cls: MagicMock, tmp_path, monkeypatch) -> None: # type: ignore[no-untyped-def]
|
||||||
monkeypatch.chdir(tmp_path)
|
monkeypatch.chdir(tmp_path)
|
||||||
@@ -266,17 +303,16 @@ class TestMain:
|
|||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "format" in result.output.lower()
|
assert "format" in result.output.lower()
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
||||||
@patch("devx.ci.auto_merge.GiteaClient")
|
@patch("devx.ci.auto_merge.GiteaClient")
|
||||||
def test_merge_behind_master_raises_no_rebase(
|
def test_merge_behind_master_auto_rebases(
|
||||||
self, mock_client_cls: MagicMock, _mock_validate: MagicMock, tmp_path, monkeypatch
|
self, mock_client_cls: MagicMock, _mock_validate: MagicMock, tmp_path, monkeypatch
|
||||||
) -> None: # type: ignore[no-untyped-def]
|
) -> None: # type: ignore[no-untyped-def]
|
||||||
"""When branch is behind master, auto-merge should NOT rebase.
|
"""When branch is behind master, auto-merge rebases via Gitea API.
|
||||||
|
|
||||||
Auto-rebasing creates a feedback loop: the force-push triggers a new
|
The rebase triggers a new CI run. The next auto-merge attempt will
|
||||||
pull_request synchronize event, which starts a new CI run, which runs
|
find the branch up-to-date and merge successfully.
|
||||||
auto-merge again, which rebases again, etc.
|
|
||||||
"""
|
"""
|
||||||
monkeypatch.chdir(tmp_path)
|
monkeypatch.chdir(tmp_path)
|
||||||
|
|
||||||
@@ -292,13 +328,41 @@ class TestMain:
|
|||||||
main,
|
main,
|
||||||
["DEVX-19-fix-bug", "DEVX-19: Fix timeout", "owner/repo", "7"],
|
["DEVX-19-fix-bug", "DEVX-19: Fix timeout", "owner/repo", "7"],
|
||||||
)
|
)
|
||||||
assert result.exit_code != 0
|
assert result.exit_code == 0
|
||||||
assert "behind master" in result.output.lower()
|
assert "behind master" in result.output.lower()
|
||||||
assert "rebase manually" in result.output.lower()
|
assert "auto-rebasing" in result.output.lower()
|
||||||
# Must NOT have called merge_pr twice (no retry after rebase)
|
# Should have called update_pr_branch to trigger server-side rebase
|
||||||
|
mock_client.update_pr_branch.assert_called_once_with(7, style="rebase")
|
||||||
|
# Must NOT have called merge_pr twice (no immediate retry)
|
||||||
assert mock_client.merge_pr.call_count == 1
|
assert mock_client.merge_pr.call_count == 1
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
||||||
|
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
||||||
|
@patch("devx.ci.auto_merge.GiteaClient")
|
||||||
|
def test_merge_behind_master_rebase_failure_raises(
|
||||||
|
self, mock_client_cls: MagicMock, _mock_validate: MagicMock, tmp_path, monkeypatch
|
||||||
|
) -> None: # type: ignore[no-untyped-def]
|
||||||
|
"""When auto-rebase fails, raise with manual rebase instructions."""
|
||||||
|
monkeypatch.chdir(tmp_path)
|
||||||
|
|
||||||
|
mock_client = MagicMock()
|
||||||
|
mock_client.get_pr_commits.return_value = [
|
||||||
|
{"commit": {"message": "fix: resolve timeout"}},
|
||||||
|
]
|
||||||
|
mock_client.merge_pr.side_effect = APIError(405, "HEAD branch is behind master")
|
||||||
|
mock_client.update_pr_branch.side_effect = APIError(409, "Conflict during rebase")
|
||||||
|
mock_client_cls.return_value = mock_client
|
||||||
|
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
main,
|
||||||
|
["DEVX-19-fix-bug", "DEVX-19: Fix timeout", "owner/repo", "7"],
|
||||||
|
)
|
||||||
|
assert result.exit_code != 0
|
||||||
|
assert "auto-rebase failed" in result.output.lower()
|
||||||
|
assert "rebase manually" in result.output.lower()
|
||||||
|
|
||||||
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
||||||
@patch("devx.ci.auto_merge.GiteaClient")
|
@patch("devx.ci.auto_merge.GiteaClient")
|
||||||
def test_merge_failure_raises(
|
def test_merge_failure_raises(
|
||||||
@@ -321,7 +385,7 @@ class TestMain:
|
|||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "Merge failed" in result.output
|
assert "Merge failed" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
||||||
@patch("devx.ci.auto_merge.GiteaClient")
|
@patch("devx.ci.auto_merge.GiteaClient")
|
||||||
def test_no_conventional_msg_raises(
|
def test_no_conventional_msg_raises(
|
||||||
@@ -342,7 +406,7 @@ class TestMain:
|
|||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "conventional commit" in result.output.lower()
|
assert "conventional commit" in result.output.lower()
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
def test_invalid_pr_number_raises(self, tmp_path, monkeypatch) -> None:
|
def test_invalid_pr_number_raises(self, tmp_path, monkeypatch) -> None:
|
||||||
"""Non-integer PR number should raise."""
|
"""Non-integer PR number should raise."""
|
||||||
monkeypatch.chdir(tmp_path)
|
monkeypatch.chdir(tmp_path)
|
||||||
@@ -351,7 +415,7 @@ class TestMain:
|
|||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "PR number must be an integer" in result.output
|
assert "PR number must be an integer" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
def test_invalid_repo_format_raises(self, tmp_path, monkeypatch) -> None:
|
def test_invalid_repo_format_raises(self, tmp_path, monkeypatch) -> None:
|
||||||
"""Repo without owner/name should raise."""
|
"""Repo without owner/name should raise."""
|
||||||
monkeypatch.chdir(tmp_path)
|
monkeypatch.chdir(tmp_path)
|
||||||
@@ -360,13 +424,13 @@ class TestMain:
|
|||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "owner/name" in result.output
|
assert "owner/name" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "VIKUNJA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
@patch("devx.ci.auto_merge.validate_pr_title_matches_vikunja")
|
||||||
@patch("devx.ci.auto_merge.GiteaClient")
|
@patch("devx.ci.auto_merge.GiteaClient")
|
||||||
def test_merge_behind_master_does_not_force_push(
|
def test_merge_behind_master_does_not_run_git_commands(
|
||||||
self, mock_client_cls: MagicMock, _mock_validate: MagicMock, tmp_path, monkeypatch
|
self, mock_client_cls: MagicMock, _mock_validate: MagicMock, tmp_path, monkeypatch
|
||||||
) -> None: # type: ignore[no-untyped-def]
|
) -> None: # type: ignore[no-untyped-def]
|
||||||
"""Verify no git commands are run when branch is behind master."""
|
"""When behind master, auto-merge uses API rebase — no local git commands."""
|
||||||
monkeypatch.chdir(tmp_path)
|
monkeypatch.chdir(tmp_path)
|
||||||
|
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
@@ -376,14 +440,14 @@ class TestMain:
|
|||||||
mock_client.merge_pr.side_effect = APIError(405, "HEAD branch is behind master")
|
mock_client.merge_pr.side_effect = APIError(405, "HEAD branch is behind master")
|
||||||
mock_client_cls.return_value = mock_client
|
mock_client_cls.return_value = mock_client
|
||||||
|
|
||||||
with patch("devx.ci.auto_merge.run_cmd") as mock_run:
|
with patch("devx.ci._shared.run_cmd") as mock_run:
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(
|
result = runner.invoke(
|
||||||
main,
|
main,
|
||||||
["DEVX-19-fix-bug", "DEVX-19: Fix timeout", "owner/repo", "7"],
|
["DEVX-19-fix-bug", "DEVX-19: Fix timeout", "owner/repo", "7"],
|
||||||
)
|
)
|
||||||
assert result.exit_code != 0
|
assert result.exit_code == 0
|
||||||
# No git commands should be run (no rebase, no push)
|
# No local git commands should be run (rebase is via API)
|
||||||
mock_run.assert_not_called()
|
mock_run.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+165
-11
@@ -321,6 +321,25 @@ class TestCleanImagesAPI:
|
|||||||
from devx.tools.clean_images import delete_package_version
|
from devx.tools.clean_images import delete_package_version
|
||||||
|
|
||||||
mock_resp = MagicMock(status_code=204)
|
mock_resp = MagicMock(status_code=204)
|
||||||
|
with patch("devx.tools.clean_images.requests.delete", return_value=mock_resp) as mock_del:
|
||||||
|
assert (
|
||||||
|
delete_package_version(
|
||||||
|
"https://git.example.com/api/v1",
|
||||||
|
"oblachno-oss",
|
||||||
|
"ci-base",
|
||||||
|
"0.1.0",
|
||||||
|
"token",
|
||||||
|
)
|
||||||
|
is True
|
||||||
|
)
|
||||||
|
# Verify URL includes container type
|
||||||
|
url = mock_del.call_args.args[0]
|
||||||
|
assert "/container/" in url
|
||||||
|
|
||||||
|
def test_delete_package_version_404_treated_as_success(self) -> None:
|
||||||
|
from devx.tools.clean_images import delete_package_version
|
||||||
|
|
||||||
|
mock_resp = MagicMock(status_code=404)
|
||||||
with patch("devx.tools.clean_images.requests.delete", return_value=mock_resp):
|
with patch("devx.tools.clean_images.requests.delete", return_value=mock_resp):
|
||||||
assert (
|
assert (
|
||||||
delete_package_version(
|
delete_package_version(
|
||||||
@@ -336,7 +355,7 @@ class TestCleanImagesAPI:
|
|||||||
def test_delete_package_version_failure(self) -> None:
|
def test_delete_package_version_failure(self) -> None:
|
||||||
from devx.tools.clean_images import delete_package_version
|
from devx.tools.clean_images import delete_package_version
|
||||||
|
|
||||||
mock_resp = MagicMock(status_code=404)
|
mock_resp = MagicMock(status_code=403)
|
||||||
with patch("devx.tools.clean_images.requests.delete", return_value=mock_resp):
|
with patch("devx.tools.clean_images.requests.delete", return_value=mock_resp):
|
||||||
assert (
|
assert (
|
||||||
delete_package_version(
|
delete_package_version(
|
||||||
@@ -349,6 +368,110 @@ class TestCleanImagesAPI:
|
|||||||
is False
|
is False
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def test_delete_package_version_retries_on_5xx(self) -> None:
|
||||||
|
from devx.tools.clean_images import delete_package_version
|
||||||
|
|
||||||
|
responses = [
|
||||||
|
MagicMock(status_code=500),
|
||||||
|
MagicMock(status_code=502),
|
||||||
|
MagicMock(status_code=204),
|
||||||
|
]
|
||||||
|
with patch("devx.tools.clean_images.requests.delete", side_effect=responses):
|
||||||
|
with patch("devx.tools.clean_images.time.sleep"):
|
||||||
|
assert (
|
||||||
|
delete_package_version(
|
||||||
|
"https://git.example.com/api/v1",
|
||||||
|
"oblachno-oss",
|
||||||
|
"ci-base",
|
||||||
|
"0.1.0",
|
||||||
|
"token",
|
||||||
|
max_retries=3,
|
||||||
|
)
|
||||||
|
is True
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_delete_package_version_retries_on_exception(self) -> None:
|
||||||
|
import requests as req
|
||||||
|
|
||||||
|
from devx.tools.clean_images import delete_package_version
|
||||||
|
|
||||||
|
responses = [
|
||||||
|
req.ConnectionError("network down"),
|
||||||
|
MagicMock(status_code=204),
|
||||||
|
]
|
||||||
|
with patch("devx.tools.clean_images.requests.delete", side_effect=responses):
|
||||||
|
with patch("devx.tools.clean_images.time.sleep"):
|
||||||
|
assert (
|
||||||
|
delete_package_version(
|
||||||
|
"https://git.example.com/api/v1",
|
||||||
|
"oblachno-oss",
|
||||||
|
"ci-base",
|
||||||
|
"0.1.0",
|
||||||
|
"token",
|
||||||
|
max_retries=3,
|
||||||
|
)
|
||||||
|
is True
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_delete_package_version_exhausts_retries_on_exception(self) -> None:
|
||||||
|
import requests as req
|
||||||
|
|
||||||
|
from devx.tools.clean_images import delete_package_version
|
||||||
|
|
||||||
|
with patch(
|
||||||
|
"devx.tools.clean_images.requests.delete",
|
||||||
|
side_effect=req.ConnectionError("network down"),
|
||||||
|
):
|
||||||
|
with patch("devx.tools.clean_images.time.sleep"):
|
||||||
|
assert (
|
||||||
|
delete_package_version(
|
||||||
|
"https://git.example.com/api/v1",
|
||||||
|
"oblachno-oss",
|
||||||
|
"ci-base",
|
||||||
|
"0.1.0",
|
||||||
|
"token",
|
||||||
|
max_retries=2,
|
||||||
|
)
|
||||||
|
is False
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_delete_package_version_exhausts_retries_on_5xx(self) -> None:
|
||||||
|
from devx.tools.clean_images import delete_package_version
|
||||||
|
|
||||||
|
with patch(
|
||||||
|
"devx.tools.clean_images.requests.delete",
|
||||||
|
return_value=MagicMock(status_code=500),
|
||||||
|
):
|
||||||
|
with patch("devx.tools.clean_images.time.sleep"):
|
||||||
|
assert (
|
||||||
|
delete_package_version(
|
||||||
|
"https://git.example.com/api/v1",
|
||||||
|
"oblachno-oss",
|
||||||
|
"ci-base",
|
||||||
|
"0.1.0",
|
||||||
|
"token",
|
||||||
|
max_retries=2,
|
||||||
|
)
|
||||||
|
is False
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_delete_package_version_zero_retries(self) -> None:
|
||||||
|
from devx.tools.clean_images import delete_package_version
|
||||||
|
|
||||||
|
with patch("devx.tools.clean_images.requests.delete") as mock_del:
|
||||||
|
assert (
|
||||||
|
delete_package_version(
|
||||||
|
"https://git.example.com/api/v1",
|
||||||
|
"oblachno-oss",
|
||||||
|
"ci-base",
|
||||||
|
"0.1.0",
|
||||||
|
"token",
|
||||||
|
max_retries=0,
|
||||||
|
)
|
||||||
|
is False
|
||||||
|
)
|
||||||
|
mock_del.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
class TestCLIBuildImage:
|
class TestCLIBuildImage:
|
||||||
def test_single_image_build(self, tmp_path: Path) -> None:
|
def test_single_image_build(self, tmp_path: Path) -> None:
|
||||||
@@ -442,7 +565,7 @@ class TestCLIBuildImage:
|
|||||||
dockerfile.touch()
|
dockerfile.touch()
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
login_result = MagicMock(returncode=1, stderr="auth failed", stdout="")
|
login_result = MagicMock(returncode=1, stderr="auth failed", stdout="")
|
||||||
with patch.dict("os.environ", {"REPO_TOKEN": "fake", "REGISTRY_USERNAME": "user"}):
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "fake", "CI_GITEA_USERNAME": "user"}):
|
||||||
with patch("devx.tools.build_image.subprocess.run", return_value=login_result):
|
with patch("devx.tools.build_image.subprocess.run", return_value=login_result):
|
||||||
result = runner.invoke(
|
result = runner.invoke(
|
||||||
build_image.main,
|
build_image.main,
|
||||||
@@ -458,7 +581,7 @@ class TestCLIBuildImage:
|
|||||||
build_result = MagicMock(returncode=0)
|
build_result = MagicMock(returncode=0)
|
||||||
login_result = MagicMock(returncode=0, stderr="", stdout="")
|
login_result = MagicMock(returncode=0, stderr="", stdout="")
|
||||||
push_result = MagicMock(returncode=1, stderr="push failed", stdout="")
|
push_result = MagicMock(returncode=1, stderr="push failed", stdout="")
|
||||||
with patch.dict("os.environ", {"REPO_TOKEN": "fake", "REGISTRY_USERNAME": "user"}):
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "fake", "CI_GITEA_USERNAME": "user"}):
|
||||||
with patch(
|
with patch(
|
||||||
"devx.tools.build_image.subprocess.run",
|
"devx.tools.build_image.subprocess.run",
|
||||||
side_effect=[login_result, build_result, push_result],
|
side_effect=[login_result, build_result, push_result],
|
||||||
@@ -482,7 +605,7 @@ class TestCLICleanImages:
|
|||||||
{"version": "0.3.0", "created_at": "2025-03-01"},
|
{"version": "0.3.0", "created_at": "2025-03-01"},
|
||||||
]
|
]
|
||||||
mock_resp.raise_for_status = MagicMock()
|
mock_resp.raise_for_status = MagicMock()
|
||||||
with patch.dict("os.environ", {"REPO_TOKEN": "fake"}):
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "fake"}):
|
||||||
with patch("devx.tools.clean_images.requests.get", return_value=mock_resp):
|
with patch("devx.tools.clean_images.requests.get", return_value=mock_resp):
|
||||||
result = runner.invoke(
|
result = runner.invoke(
|
||||||
clean_main,
|
clean_main,
|
||||||
@@ -511,7 +634,7 @@ class TestCLICleanImages:
|
|||||||
mock_resp = MagicMock()
|
mock_resp = MagicMock()
|
||||||
mock_resp.json.return_value = []
|
mock_resp.json.return_value = []
|
||||||
mock_resp.raise_for_status = MagicMock()
|
mock_resp.raise_for_status = MagicMock()
|
||||||
with patch.dict("os.environ", {"REPO_TOKEN": "fake"}):
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "fake"}):
|
||||||
with patch("devx.tools.clean_images.requests.get", return_value=mock_resp):
|
with patch("devx.tools.clean_images.requests.get", return_value=mock_resp):
|
||||||
result = runner.invoke(
|
result = runner.invoke(
|
||||||
clean_main,
|
clean_main,
|
||||||
@@ -532,7 +655,7 @@ class TestCLICleanImages:
|
|||||||
]
|
]
|
||||||
list_resp.raise_for_status = MagicMock()
|
list_resp.raise_for_status = MagicMock()
|
||||||
delete_resp = MagicMock(status_code=204)
|
delete_resp = MagicMock(status_code=204)
|
||||||
with patch.dict("os.environ", {"REPO_TOKEN": "fake"}):
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "fake"}):
|
||||||
with patch("devx.tools.clean_images.requests.get", return_value=list_resp):
|
with patch("devx.tools.clean_images.requests.get", return_value=list_resp):
|
||||||
with patch("devx.tools.clean_images.requests.delete", return_value=delete_resp):
|
with patch("devx.tools.clean_images.requests.delete", return_value=delete_resp):
|
||||||
result = runner.invoke(
|
result = runner.invoke(
|
||||||
@@ -548,7 +671,7 @@ class TestCLICleanImages:
|
|||||||
from devx.tools.clean_images import main as clean_main
|
from devx.tools.clean_images import main as clean_main
|
||||||
|
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
with patch.dict("os.environ", {"REPO_TOKEN": "fake"}):
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "fake"}):
|
||||||
with patch(
|
with patch(
|
||||||
"devx.tools.clean_images.requests.get",
|
"devx.tools.clean_images.requests.get",
|
||||||
side_effect=req.ConnectionError("network down"),
|
side_effect=req.ConnectionError("network down"),
|
||||||
@@ -557,7 +680,7 @@ class TestCLICleanImages:
|
|||||||
clean_main,
|
clean_main,
|
||||||
["--owner", "oblachno-oss", "--name", "ci-base", "--dry-run"],
|
["--owner", "oblachno-oss", "--name", "ci-base", "--dry-run"],
|
||||||
)
|
)
|
||||||
assert result.exit_code == 0
|
assert result.exit_code != 0
|
||||||
assert "Failed to list" in result.output
|
assert "Failed to list" in result.output
|
||||||
|
|
||||||
def test_delete_failure_in_cli(self) -> None:
|
def test_delete_failure_in_cli(self) -> None:
|
||||||
@@ -571,13 +694,44 @@ class TestCLICleanImages:
|
|||||||
{"version": "0.3.0", "created_at": "2025-03-01"},
|
{"version": "0.3.0", "created_at": "2025-03-01"},
|
||||||
]
|
]
|
||||||
list_resp.raise_for_status = MagicMock()
|
list_resp.raise_for_status = MagicMock()
|
||||||
delete_resp = MagicMock(status_code=500)
|
delete_resp = MagicMock(status_code=403)
|
||||||
with patch.dict("os.environ", {"REPO_TOKEN": "fake"}):
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "fake"}):
|
||||||
with patch("devx.tools.clean_images.requests.get", return_value=list_resp):
|
with patch("devx.tools.clean_images.requests.get", return_value=list_resp):
|
||||||
with patch("devx.tools.clean_images.requests.delete", return_value=delete_resp):
|
with patch("devx.tools.clean_images.requests.delete", return_value=delete_resp):
|
||||||
|
with patch("devx.tools.clean_images.time.sleep"):
|
||||||
result = runner.invoke(
|
result = runner.invoke(
|
||||||
clean_main,
|
clean_main,
|
||||||
["--owner", "oblachno-oss", "--name", "ci-base", "--keep", "2"],
|
["--owner", "oblachno-oss", "--name", "ci-base", "--keep", "2"],
|
||||||
)
|
)
|
||||||
assert result.exit_code == 0
|
assert result.exit_code != 0
|
||||||
assert "FAILED" in result.output
|
assert "FAILED" in result.output
|
||||||
|
|
||||||
|
@patch("devx.tools.clean_images.REPO_OWNER", "oblachno-oss")
|
||||||
|
def test_owner_from_config(self) -> None:
|
||||||
|
from devx.tools.clean_images import main as clean_main
|
||||||
|
|
||||||
|
runner = CliRunner()
|
||||||
|
mock_resp = MagicMock()
|
||||||
|
mock_resp.json.return_value = []
|
||||||
|
mock_resp.raise_for_status = MagicMock()
|
||||||
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "fake"}):
|
||||||
|
with patch("devx.tools.clean_images.requests.get", return_value=mock_resp):
|
||||||
|
result = runner.invoke(
|
||||||
|
clean_main,
|
||||||
|
["--name", "ci-base", "--dry-run"],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "oblachno-oss/ci-base" in result.output
|
||||||
|
|
||||||
|
@patch("devx.tools.clean_images.REPO_OWNER", "")
|
||||||
|
def test_no_owner_raises(self) -> None:
|
||||||
|
from devx.tools.clean_images import main as clean_main
|
||||||
|
|
||||||
|
runner = CliRunner()
|
||||||
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "fake"}):
|
||||||
|
result = runner.invoke(
|
||||||
|
clean_main,
|
||||||
|
["--name", "ci-base"],
|
||||||
|
)
|
||||||
|
assert result.exit_code != 0
|
||||||
|
assert "owner" in result.output.lower()
|
||||||
|
|||||||
@@ -78,7 +78,7 @@ class TestGetPrTitleFromGitea:
|
|||||||
assert get_pr_title_from_gitea("owner/repo", 1) is None
|
assert get_pr_title_from_gitea("owner/repo", 1) is None
|
||||||
|
|
||||||
def test_returns_none_with_invalid_repo(self) -> None:
|
def test_returns_none_with_invalid_repo(self) -> None:
|
||||||
with patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True):
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True):
|
||||||
assert get_pr_title_from_gitea("invalid", 1) is None
|
assert get_pr_title_from_gitea("invalid", 1) is None
|
||||||
|
|
||||||
@patch("devx.ci.check_auto_merge_ready.GiteaClient")
|
@patch("devx.ci.check_auto_merge_ready.GiteaClient")
|
||||||
@@ -86,16 +86,18 @@ class TestGetPrTitleFromGitea:
|
|||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
mock_client.get_pr.return_value = {"title": "DEVX-1: Fix bug"}
|
mock_client.get_pr.return_value = {"title": "DEVX-1: Fix bug"}
|
||||||
mock_client_cls.return_value = mock_client
|
mock_client_cls.return_value = mock_client
|
||||||
with patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True):
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True):
|
||||||
result = get_pr_title_from_gitea("owner/repo", 1)
|
result = get_pr_title_from_gitea("owner/repo", 1)
|
||||||
assert result == "DEVX-1: Fix bug"
|
assert result == "DEVX-1: Fix bug"
|
||||||
|
|
||||||
@patch("devx.ci.check_auto_merge_ready.GiteaClient")
|
@patch("devx.ci.check_auto_merge_ready.GiteaClient")
|
||||||
def test_returns_none_on_exception(self, mock_client_cls: MagicMock) -> None:
|
def test_returns_none_on_exception(self, mock_client_cls: MagicMock) -> None:
|
||||||
|
from devx.exceptions import APIError
|
||||||
|
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
mock_client.get_pr.side_effect = Exception("API error")
|
mock_client.get_pr.side_effect = APIError(500, "API error")
|
||||||
mock_client_cls.return_value = mock_client
|
mock_client_cls.return_value = mock_client
|
||||||
with patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True):
|
with patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True):
|
||||||
result = get_pr_title_from_gitea("owner/repo", 1)
|
result = get_pr_title_from_gitea("owner/repo", 1)
|
||||||
assert result is None
|
assert result is None
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,108 @@
|
|||||||
|
"""Unit tests for devx.tools.check_deps."""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
from click.testing import CliRunner
|
||||||
|
|
||||||
|
from devx.tools.check_deps import (
|
||||||
|
_check_python_version,
|
||||||
|
_check_tool,
|
||||||
|
cli,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckTool:
|
||||||
|
@patch("devx.tools.check_deps.shutil.which", return_value="/usr/bin/tofu")
|
||||||
|
def test_found(self, mock_which: MagicMock) -> None:
|
||||||
|
assert _check_tool("tofu") is True
|
||||||
|
|
||||||
|
@patch("devx.tools.check_deps.shutil.which", return_value=None)
|
||||||
|
def test_not_found_required(self, mock_which: MagicMock) -> None:
|
||||||
|
assert _check_tool("tofu") is False
|
||||||
|
|
||||||
|
@patch("devx.tools.check_deps.shutil.which", return_value=None)
|
||||||
|
def test_not_found_optional(self, mock_which: MagicMock) -> None:
|
||||||
|
assert _check_tool("checkmake", optional=True) is False
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckPythonVersion:
|
||||||
|
@patch("devx.tools.check_deps.subprocess.run")
|
||||||
|
def test_valid_version(self, mock_run: MagicMock, tmp_path: Path) -> None:
|
||||||
|
venv_bin = tmp_path / "bin"
|
||||||
|
venv_bin.mkdir()
|
||||||
|
(venv_bin / "python").touch()
|
||||||
|
mock_run.return_value = MagicMock(returncode=0, stdout="Python 3.12.3\n", stderr="")
|
||||||
|
_check_python_version(venv_bin)
|
||||||
|
|
||||||
|
@patch("devx.tools.check_deps.subprocess.run")
|
||||||
|
def test_old_version(self, mock_run: MagicMock, tmp_path: Path) -> None:
|
||||||
|
venv_bin = tmp_path / "bin"
|
||||||
|
venv_bin.mkdir()
|
||||||
|
(venv_bin / "python").touch()
|
||||||
|
mock_run.return_value = MagicMock(returncode=0, stdout="Python 3.11.0\n", stderr="")
|
||||||
|
_check_python_version(venv_bin)
|
||||||
|
|
||||||
|
def test_no_venv(self, tmp_path: Path) -> None:
|
||||||
|
venv_bin = tmp_path / "bin"
|
||||||
|
_check_python_version(venv_bin)
|
||||||
|
|
||||||
|
@patch("devx.tools.check_deps.subprocess.run")
|
||||||
|
def test_command_fails(self, mock_run: MagicMock, tmp_path: Path) -> None:
|
||||||
|
venv_bin = tmp_path / "bin"
|
||||||
|
venv_bin.mkdir()
|
||||||
|
(venv_bin / "python").touch()
|
||||||
|
mock_run.return_value = MagicMock(returncode=1, stdout="", stderr="error")
|
||||||
|
_check_python_version(venv_bin)
|
||||||
|
|
||||||
|
@patch("devx.tools.check_deps.subprocess.run")
|
||||||
|
def test_unparseable_version(self, mock_run: MagicMock, tmp_path: Path) -> None:
|
||||||
|
venv_bin = tmp_path / "bin"
|
||||||
|
venv_bin.mkdir()
|
||||||
|
(venv_bin / "python").touch()
|
||||||
|
mock_run.return_value = MagicMock(returncode=0, stdout="garbage\n", stderr="")
|
||||||
|
_check_python_version(venv_bin)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCli:
|
||||||
|
@patch("devx.tools.check_deps._check_python_version")
|
||||||
|
@patch("devx.tools.check_deps._check_tool")
|
||||||
|
def test_all_present(self, mock_check: MagicMock, mock_py: MagicMock) -> None:
|
||||||
|
mock_check.return_value = True
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, [])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "All core tools present" in result.output
|
||||||
|
|
||||||
|
@patch("devx.tools.check_deps._check_python_version")
|
||||||
|
@patch("devx.tools.check_deps._check_tool")
|
||||||
|
def test_missing_required(self, mock_check: MagicMock, mock_py: MagicMock) -> None:
|
||||||
|
mock_check.side_effect = lambda name, optional=False: name != "tofu"
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, [])
|
||||||
|
assert result.exit_code != 0
|
||||||
|
|
||||||
|
@patch("devx.tools.check_deps._check_python_version")
|
||||||
|
@patch("devx.tools.check_deps._check_tool")
|
||||||
|
def test_missing_optional_with_fallback(self, mock_check: MagicMock, mock_py: MagicMock, tmp_path: Path) -> None:
|
||||||
|
checkmake_bin = tmp_path / "checkmake"
|
||||||
|
checkmake_bin.touch()
|
||||||
|
|
||||||
|
def _side(name: str, optional: bool = False) -> bool:
|
||||||
|
return name != "checkmake"
|
||||||
|
|
||||||
|
mock_check.side_effect = _side
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["--checkmake-bin", str(checkmake_bin)])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
|
||||||
|
@patch("devx.tools.check_deps._check_python_version")
|
||||||
|
@patch("devx.tools.check_deps._check_tool")
|
||||||
|
def test_missing_optional_no_fallback(self, mock_check: MagicMock, mock_py: MagicMock) -> None:
|
||||||
|
def _side(name: str, optional: bool = False) -> bool:
|
||||||
|
return name != "checkmake"
|
||||||
|
|
||||||
|
mock_check.side_effect = _side
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, [])
|
||||||
|
assert result.exit_code == 0
|
||||||
@@ -3,6 +3,8 @@
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest.mock import MagicMock, patch
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
from click.testing import CliRunner
|
||||||
|
|
||||||
from devx.tools.check_test_coverage import (
|
from devx.tools.check_test_coverage import (
|
||||||
BUILTIN_RULES,
|
BUILTIN_RULES,
|
||||||
DEFAULT_SKIP_EXTENSIONS,
|
DEFAULT_SKIP_EXTENSIONS,
|
||||||
@@ -13,7 +15,7 @@ from devx.tools.check_test_coverage import (
|
|||||||
_load_rules,
|
_load_rules,
|
||||||
_resolve_test_path,
|
_resolve_test_path,
|
||||||
_should_skip_file,
|
_should_skip_file,
|
||||||
main,
|
cli,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -201,7 +203,10 @@ class TestMain:
|
|||||||
),
|
),
|
||||||
patch("devx.tools.check_test_coverage.Path.cwd", return_value=tmp_path),
|
patch("devx.tools.check_test_coverage.Path.cwd", return_value=tmp_path),
|
||||||
):
|
):
|
||||||
assert main([]) == 0
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, [])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "No changed files" in result.output
|
||||||
|
|
||||||
def test_all_have_tests(self, tmp_path: Path) -> None:
|
def test_all_have_tests(self, tmp_path: Path) -> None:
|
||||||
(tmp_path / "scripts" / "tests").mkdir(parents=True)
|
(tmp_path / "scripts" / "tests").mkdir(parents=True)
|
||||||
@@ -214,7 +219,10 @@ class TestMain:
|
|||||||
),
|
),
|
||||||
patch("devx.tools.check_test_coverage.Path.cwd", return_value=tmp_path),
|
patch("devx.tools.check_test_coverage.Path.cwd", return_value=tmp_path),
|
||||||
):
|
):
|
||||||
assert main([]) == 0
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, [])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "have tests" in result.output
|
||||||
|
|
||||||
def test_missing_test_returns_1(self, tmp_path: Path) -> None:
|
def test_missing_test_returns_1(self, tmp_path: Path) -> None:
|
||||||
with (
|
with (
|
||||||
@@ -225,7 +233,9 @@ class TestMain:
|
|||||||
),
|
),
|
||||||
patch("devx.tools.check_test_coverage.Path.cwd", return_value=tmp_path),
|
patch("devx.tools.check_test_coverage.Path.cwd", return_value=tmp_path),
|
||||||
):
|
):
|
||||||
assert main([]) == 1
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, [])
|
||||||
|
assert result.exit_code != 0
|
||||||
|
|
||||||
def test_warn_only_returns_0(self, tmp_path: Path) -> None:
|
def test_warn_only_returns_0(self, tmp_path: Path) -> None:
|
||||||
with (
|
with (
|
||||||
@@ -236,4 +246,6 @@ class TestMain:
|
|||||||
),
|
),
|
||||||
patch("devx.tools.check_test_coverage.Path.cwd", return_value=tmp_path),
|
patch("devx.tools.check_test_coverage.Path.cwd", return_value=tmp_path),
|
||||||
):
|
):
|
||||||
assert main(["--warn-only"]) == 0
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["--warn-only"])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
|||||||
@@ -184,6 +184,14 @@ class TestMain:
|
|||||||
result = runner.invoke(check_translations.main, ["--translations", str(trans_file)])
|
result = runner.invoke(check_translations.main, ["--translations", str(trans_file)])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
|
|
||||||
|
def test_no_translations_file_skips(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
"""When no translations file is found, should pass with skip message."""
|
||||||
|
monkeypatch.chdir(tmp_path)
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(check_translations.main, [])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "No translations file found" in result.output
|
||||||
|
|
||||||
|
|
||||||
class TestPrintResult:
|
class TestPrintResult:
|
||||||
def test_prints_all_good(self, capsys: pytest.CaptureFixture[str]) -> None:
|
def test_prints_all_good(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
@@ -248,8 +256,8 @@ class TestDevxI18n:
|
|||||||
import devx.i18n
|
import devx.i18n
|
||||||
|
|
||||||
importlib.reload(devx.i18n)
|
importlib.reload(devx.i18n)
|
||||||
# "ERROR: REPO_TOKEN is not set." has a German translation
|
# "ERROR: CI_GITEA_TOKEN is not set." has a German translation
|
||||||
result = devx.i18n._("ERROR: REPO_TOKEN is not set.")
|
result = devx.i18n._("ERROR: CI_GITEA_TOKEN is not set.")
|
||||||
assert "FEHLER" in result
|
assert "FEHLER" in result
|
||||||
|
|
||||||
# Restore
|
# Restore
|
||||||
|
|||||||
@@ -264,6 +264,16 @@ class TestChangeClassifier:
|
|||||||
assert fc.is_user_facing
|
assert fc.is_user_facing
|
||||||
assert fc.matched_rule == "user_facing_overrides"
|
assert fc.matched_rule == "user_facing_overrides"
|
||||||
|
|
||||||
|
def test_user_facing_override_glob_matches_nested(self) -> None:
|
||||||
|
"""User-facing overrides support glob patterns like infrastructure."""
|
||||||
|
classifier = self._make_classifier(
|
||||||
|
infrastructure=[".gitea/**"],
|
||||||
|
user_facing_overrides=[".gitea/**"],
|
||||||
|
)
|
||||||
|
fc = classifier.classify_file(".gitea/workflows/ci.yml")
|
||||||
|
assert fc.is_user_facing
|
||||||
|
assert fc.matched_rule == "user_facing_overrides"
|
||||||
|
|
||||||
def test_user_facing_override_beats_infrastructure_override(self) -> None:
|
def test_user_facing_override_beats_infrastructure_override(self) -> None:
|
||||||
"""User-facing overrides beat infrastructure overrides (safety first)."""
|
"""User-facing overrides beat infrastructure overrides (safety first)."""
|
||||||
classifier = self._make_classifier(
|
classifier = self._make_classifier(
|
||||||
@@ -489,7 +499,7 @@ class TestMain:
|
|||||||
@patch("devx.ci.classify_changes.get_changed_files")
|
@patch("devx.ci.classify_changes.get_changed_files")
|
||||||
@patch("devx.ci.classify_changes.get_latest_tag", return_value="v0.3.0")
|
@patch("devx.ci.classify_changes.get_latest_tag", return_value="v0.3.0")
|
||||||
def test_workflow_only_exits_2(self, mock_tag: MagicMock, mock_changes: MagicMock) -> None:
|
def test_workflow_only_exits_2(self, mock_tag: MagicMock, mock_changes: MagicMock) -> None:
|
||||||
mock_changes.return_value = [".gitea/workflows/ci.yml", "docs/index.md"]
|
mock_changes.return_value = ["docs/index.md", "README.md"]
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(main, [])
|
result = runner.invoke(main, [])
|
||||||
assert result.exit_code == 2
|
assert result.exit_code == 2
|
||||||
@@ -572,7 +582,7 @@ class TestMain:
|
|||||||
@patch("devx.ci.classify_changes.get_changed_files")
|
@patch("devx.ci.classify_changes.get_changed_files")
|
||||||
@patch("devx.ci.classify_changes.get_latest_tag", return_value="v0.3.0")
|
@patch("devx.ci.classify_changes.get_latest_tag", return_value="v0.3.0")
|
||||||
def test_quiet_workflow_only(self, mock_tag: MagicMock, mock_changes: MagicMock) -> None:
|
def test_quiet_workflow_only(self, mock_tag: MagicMock, mock_changes: MagicMock) -> None:
|
||||||
mock_changes.return_value = [".gitea/workflows/ci.yml"]
|
mock_changes.return_value = ["docs/index.md"]
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(main, ["--quiet"])
|
result = runner.invoke(main, ["--quiet"])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
@@ -631,7 +641,7 @@ class TestMain:
|
|||||||
@patch("devx.ci.classify_changes.get_changed_files")
|
@patch("devx.ci.classify_changes.get_changed_files")
|
||||||
@patch("devx.ci.classify_changes.get_latest_tag", return_value="v0.3.0")
|
@patch("devx.ci.classify_changes.get_latest_tag", return_value="v0.3.0")
|
||||||
def test_check_user_facing_false(self, mock_tag: MagicMock, mock_changes: MagicMock) -> None:
|
def test_check_user_facing_false(self, mock_tag: MagicMock, mock_changes: MagicMock) -> None:
|
||||||
mock_changes.return_value = [".gitea/workflows/ci.yml", "tests/test_foo.py"]
|
mock_changes.return_value = ["docs/index.md", "tests/test_foo.py"]
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(main, ["--check", "user-facing", "--quiet"])
|
result = runner.invoke(main, ["--check", "user-facing", "--quiet"])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
|
|||||||
@@ -87,6 +87,13 @@ class TestCiCommands:
|
|||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
mock_run.assert_called_once_with("devx.ci.doc_coverage", [])
|
mock_run.assert_called_once_with("devx.ci.doc_coverage", [])
|
||||||
|
|
||||||
|
@patch("devx.cli._run_module")
|
||||||
|
def test_ci_lint_docs(self, mock_run: MagicMock) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["ci", "lint-docs", "--", "--root", "."])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
mock_run.assert_called_once_with("devx.ci.lint_docs", ["--root", "."])
|
||||||
|
|
||||||
@patch("devx.cli._run_module")
|
@patch("devx.cli._run_module")
|
||||||
def test_ci_notify_failure(self, mock_run: MagicMock) -> None:
|
def test_ci_notify_failure(self, mock_run: MagicMock) -> None:
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
@@ -194,6 +201,20 @@ class TestToolsCommands:
|
|||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
mock_run.assert_called_once_with("devx.tools.setup", [])
|
mock_run.assert_called_once_with("devx.tools.setup", [])
|
||||||
|
|
||||||
|
@patch("devx.cli._run_module")
|
||||||
|
def test_tools_rebase(self, mock_run: MagicMock) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["tools", "rebase", "--", "--no-push"])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
mock_run.assert_called_once_with("devx.tools.rebase", ["--no-push"])
|
||||||
|
|
||||||
|
@patch("devx.cli._run_module")
|
||||||
|
def test_tools_pr_rebase(self, mock_run: MagicMock) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["tools", "pr-rebase", "--", "--pr", "42"])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
mock_run.assert_called_once_with("devx.tools.pr_rebase", ["--pr", "42"])
|
||||||
|
|
||||||
|
|
||||||
class TestMoleculeCommands:
|
class TestMoleculeCommands:
|
||||||
@patch("devx.cli._run_module")
|
@patch("devx.cli._run_module")
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ from click.testing import CliRunner
|
|||||||
|
|
||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
from devx.tools.configure_repo import (
|
from devx.tools.configure_repo import (
|
||||||
|
_STANDARD_LABELS,
|
||||||
_default_branch_protection_config,
|
_default_branch_protection_config,
|
||||||
_default_repo_settings_config,
|
_default_repo_settings_config,
|
||||||
_handle_http_error,
|
_handle_http_error,
|
||||||
@@ -32,9 +33,10 @@ class TestDefaultConfigs:
|
|||||||
assert config["branch_name"] == "master"
|
assert config["branch_name"] == "master"
|
||||||
assert config["enable_push"] is True
|
assert config["enable_push"] is True
|
||||||
assert config["enable_push_whitelist"] is False
|
assert config["enable_push_whitelist"] is False
|
||||||
assert config["required_approvals"] == 0
|
assert config["required_approvals"] == 1
|
||||||
assert isinstance(config["status_check_contexts"], list)
|
assert isinstance(config["status_check_contexts"], list)
|
||||||
assert "CI / quality (pull_request)" in config["status_check_contexts"]
|
assert "CI / quality (pull_request)" in config["status_check_contexts"]
|
||||||
|
assert config["block_admin_merge_override"] is True
|
||||||
|
|
||||||
def test_default_repo_settings_config(self) -> None:
|
def test_default_repo_settings_config(self) -> None:
|
||||||
config = _default_repo_settings_config()
|
config = _default_repo_settings_config()
|
||||||
@@ -47,7 +49,7 @@ class TestDefaultConfigs:
|
|||||||
|
|
||||||
|
|
||||||
class TestConfigureRepo:
|
class TestConfigureRepo:
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.tools.configure_repo.GiteaClient")
|
@patch("devx.tools.configure_repo.GiteaClient")
|
||||||
def test_configure_repo_success(self, mock_client_cls: MagicMock) -> None:
|
def test_configure_repo_success(self, mock_client_cls: MagicMock) -> None:
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
@@ -57,8 +59,9 @@ class TestConfigureRepo:
|
|||||||
|
|
||||||
mock_client.ensure_branch_protection.assert_called_once()
|
mock_client.ensure_branch_protection.assert_called_once()
|
||||||
mock_client.update_repo_settings.assert_called_once()
|
mock_client.update_repo_settings.assert_called_once()
|
||||||
|
assert mock_client.ensure_label.call_count == len(_STANDARD_LABELS)
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.tools.configure_repo.GiteaClient")
|
@patch("devx.tools.configure_repo.GiteaClient")
|
||||||
def test_configure_repo_api_error(self, mock_client_cls: MagicMock) -> None:
|
def test_configure_repo_api_error(self, mock_client_cls: MagicMock) -> None:
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
@@ -69,10 +72,10 @@ class TestConfigureRepo:
|
|||||||
configure_repo(token="tok", owner="owner", repo="repo")
|
configure_repo(token="tok", owner="owner", repo="repo")
|
||||||
|
|
||||||
def test_configure_repo_no_token(self) -> None:
|
def test_configure_repo_no_token(self) -> None:
|
||||||
with pytest.raises(click.ClickException, match="REPO_TOKEN"):
|
with pytest.raises(click.ClickException, match="CI_GITEA_TOKEN"):
|
||||||
configure_repo(token="", owner="owner", repo="repo")
|
configure_repo(token="", owner="owner", repo="repo")
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.tools.configure_repo.GiteaClient")
|
@patch("devx.tools.configure_repo.GiteaClient")
|
||||||
def test_configure_repo_custom_configs(self, mock_client_cls: MagicMock) -> None:
|
def test_configure_repo_custom_configs(self, mock_client_cls: MagicMock) -> None:
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
@@ -99,10 +102,25 @@ class TestConfigureRepo:
|
|||||||
|
|
||||||
mock_client.ensure_branch_protection.assert_called_once_with("develop", custom_bp)
|
mock_client.ensure_branch_protection.assert_called_once_with("develop", custom_bp)
|
||||||
mock_client.update_repo_settings.assert_called_once_with(custom_rs)
|
mock_client.update_repo_settings.assert_called_once_with(custom_rs)
|
||||||
|
# Labels are created regardless of custom configs
|
||||||
|
assert mock_client.ensure_label.call_count == len(_STANDARD_LABELS)
|
||||||
|
|
||||||
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
|
@patch("devx.tools.configure_repo.GiteaClient")
|
||||||
|
def test_configure_repo_creates_all_standard_labels(self, mock_client_cls: MagicMock) -> None:
|
||||||
|
"""Verify all standard labels are ensured with correct names."""
|
||||||
|
mock_client = MagicMock()
|
||||||
|
mock_client_cls.return_value = mock_client
|
||||||
|
|
||||||
|
configure_repo(token="tok", owner="owner", repo="repo")
|
||||||
|
|
||||||
|
created_names = [call.args[0] for call in mock_client.ensure_label.call_args_list]
|
||||||
|
expected_names = [lbl["name"] for lbl in _STANDARD_LABELS]
|
||||||
|
assert created_names == expected_names
|
||||||
|
|
||||||
|
|
||||||
class TestMain:
|
class TestMain:
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok", "DEVX_REPO_NAME": "myrepo"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "DEVX_REPO_NAME": "myrepo"}, clear=True)
|
||||||
@patch("devx.tools.configure_repo.GiteaClient")
|
@patch("devx.tools.configure_repo.GiteaClient")
|
||||||
def test_main_success_with_env_repo(self, mock_client_cls: MagicMock) -> None:
|
def test_main_success_with_env_repo(self, mock_client_cls: MagicMock) -> None:
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
@@ -113,8 +131,9 @@ class TestMain:
|
|||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
mock_client.ensure_branch_protection.assert_called_once()
|
mock_client.ensure_branch_protection.assert_called_once()
|
||||||
mock_client.update_repo_settings.assert_called_once()
|
mock_client.update_repo_settings.assert_called_once()
|
||||||
|
assert mock_client.ensure_label.call_count == len(_STANDARD_LABELS)
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.tools.configure_repo.GiteaClient")
|
@patch("devx.tools.configure_repo.GiteaClient")
|
||||||
def test_main_success_with_cli_repo(self, mock_client_cls: MagicMock) -> None:
|
def test_main_success_with_cli_repo(self, mock_client_cls: MagicMock) -> None:
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
@@ -124,8 +143,9 @@ class TestMain:
|
|||||||
result = runner.invoke(main, ["--repo", "myrepo", "--owner", "myorg"])
|
result = runner.invoke(main, ["--repo", "myrepo", "--owner", "myorg"])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
mock_client.ensure_branch_protection.assert_called_once()
|
mock_client.ensure_branch_protection.assert_called_once()
|
||||||
|
assert mock_client.ensure_label.call_count == len(_STANDARD_LABELS)
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.tools.configure_repo.GiteaClient")
|
@patch("devx.tools.configure_repo.GiteaClient")
|
||||||
def test_main_api_error(self, mock_client_cls: MagicMock) -> None:
|
def test_main_api_error(self, mock_client_cls: MagicMock) -> None:
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
@@ -142,16 +162,17 @@ class TestMain:
|
|||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(main, ["--repo", "myrepo"])
|
result = runner.invoke(main, ["--repo", "myrepo"])
|
||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "REPO_TOKEN" in result.output
|
assert "CI_GITEA_TOKEN" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
|
@patch("devx.tools.configure_repo.REPO_NAME", "")
|
||||||
def test_main_no_repo(self) -> None:
|
def test_main_no_repo(self) -> None:
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(main, [])
|
result = runner.invoke(main, [])
|
||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "Repository name not specified" in result.output
|
assert "Repository name not specified" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
@patch("devx.tools.configure_repo.GiteaClient")
|
@patch("devx.tools.configure_repo.GiteaClient")
|
||||||
def test_main_custom_branch(self, mock_client_cls: MagicMock) -> None:
|
def test_main_custom_branch(self, mock_client_cls: MagicMock) -> None:
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
@@ -164,7 +185,7 @@ class TestMain:
|
|||||||
args = mock_client.ensure_branch_protection.call_args
|
args = mock_client.ensure_branch_protection.call_args
|
||||||
assert args[0][0] == "develop"
|
assert args[0][0] == "develop"
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok", "DEVX_REPO_NAME": "oblachno/infra"}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "DEVX_REPO_NAME": "oblachno/infra"}, clear=True)
|
||||||
@patch("devx.tools.configure_repo.GiteaClient")
|
@patch("devx.tools.configure_repo.GiteaClient")
|
||||||
def test_main_parses_owner_repo_from_env(self, mock_client_cls: MagicMock) -> None:
|
def test_main_parses_owner_repo_from_env(self, mock_client_cls: MagicMock) -> None:
|
||||||
"""DEVX_REPO_NAME with 'owner/repo' format should be split."""
|
"""DEVX_REPO_NAME with 'owner/repo' format should be split."""
|
||||||
@@ -181,7 +202,7 @@ class TestMain:
|
|||||||
|
|
||||||
@patch.dict(
|
@patch.dict(
|
||||||
"os.environ",
|
"os.environ",
|
||||||
{"REPO_TOKEN": "tok", "DEVX_REPO_NAME": "infra", "DEVX_REPO_OWNER": "oblachno"},
|
{"CI_GITEA_TOKEN": "tok", "DEVX_REPO_NAME": "infra", "DEVX_REPO_OWNER": "oblachno"},
|
||||||
clear=True,
|
clear=True,
|
||||||
)
|
)
|
||||||
@patch("devx.tools.configure_repo.REPO_OWNER", "oblachno")
|
@patch("devx.tools.configure_repo.REPO_OWNER", "oblachno")
|
||||||
@@ -197,3 +218,19 @@ class TestMain:
|
|||||||
call_args = mock_client_cls.call_args
|
call_args = mock_client_cls.call_args
|
||||||
assert call_args[0][2] == "oblachno" # owner
|
assert call_args[0][2] == "oblachno" # owner
|
||||||
assert call_args[0][3] == "infra" # repo
|
assert call_args[0][3] == "infra" # repo
|
||||||
|
|
||||||
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
|
@patch("devx.tools.configure_repo.REPO_NAME", "devx")
|
||||||
|
@patch("devx.tools.configure_repo.REPO_OWNER", "oblachno-oss")
|
||||||
|
@patch("devx.tools.configure_repo.GiteaClient")
|
||||||
|
def test_main_repo_from_pyproject(self, mock_client_cls: MagicMock) -> None:
|
||||||
|
"""When no env var is set, repo name should come from pyproject.toml."""
|
||||||
|
mock_client = MagicMock()
|
||||||
|
mock_client_cls.return_value = mock_client
|
||||||
|
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, [])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
call_args = mock_client_cls.call_args
|
||||||
|
assert call_args[0][2] == "oblachno-oss" # owner
|
||||||
|
assert call_args[0][3] == "devx" # repo
|
||||||
|
|||||||
@@ -29,10 +29,22 @@ class TestGetRepoName:
|
|||||||
def test_from_env(self) -> None:
|
def test_from_env(self) -> None:
|
||||||
assert get_repo_name() == "infra"
|
assert get_repo_name() == "infra"
|
||||||
|
|
||||||
|
@patch("devx.tools.create_pr.REPO_NAME", "devx")
|
||||||
|
@patch.dict("os.environ", {"GITHUB_REPOSITORY": "oblachno/infra"}, clear=True)
|
||||||
|
def test_env_overrides_pyproject(self) -> None:
|
||||||
|
assert get_repo_name() == "infra"
|
||||||
|
|
||||||
|
@patch("devx.tools.create_pr.REPO_NAME", "devx")
|
||||||
|
@patch.dict("os.environ", {}, clear=True)
|
||||||
|
def test_from_pyproject(self) -> None:
|
||||||
|
assert get_repo_name() == "devx"
|
||||||
|
|
||||||
|
@patch("devx.tools.create_pr.REPO_NAME", "")
|
||||||
@patch.dict("os.environ", {"GITHUB_REPOSITORY": "oblachno/infra"}, clear=True)
|
@patch.dict("os.environ", {"GITHUB_REPOSITORY": "oblachno/infra"}, clear=True)
|
||||||
def test_from_github(self) -> None:
|
def test_from_github(self) -> None:
|
||||||
assert get_repo_name() == "infra"
|
assert get_repo_name() == "infra"
|
||||||
|
|
||||||
|
@patch("devx.tools.create_pr.REPO_NAME", "")
|
||||||
@patch.dict("os.environ", {}, clear=True)
|
@patch.dict("os.environ", {}, clear=True)
|
||||||
def test_missing_raises(self) -> None:
|
def test_missing_raises(self) -> None:
|
||||||
with pytest.raises(click.ClickException, match="Repository name"):
|
with pytest.raises(click.ClickException, match="Repository name"):
|
||||||
@@ -44,7 +56,7 @@ class TestGetVikunjaTaskTitle:
|
|||||||
@patch.dict("os.environ", {"VIKUNJA_TOKEN": "tok"})
|
@patch.dict("os.environ", {"VIKUNJA_TOKEN": "tok"})
|
||||||
def test_found(self, mock_client_cls: MagicMock) -> None:
|
def test_found(self, mock_client_cls: MagicMock) -> None:
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
mock_client.list_project_tasks.return_value = [{"identifier": "DEVX-42", "title": "Add feature"}]
|
mock_client.find_task_by_identifier.return_value = {"identifier": "DEVX-42", "title": "Add feature"}
|
||||||
mock_client_cls.return_value = mock_client
|
mock_client_cls.return_value = mock_client
|
||||||
assert get_vikunja_task_title("DEVX-42") == "Add feature"
|
assert get_vikunja_task_title("DEVX-42") == "Add feature"
|
||||||
|
|
||||||
@@ -57,20 +69,7 @@ class TestGetVikunjaTaskTitle:
|
|||||||
@patch.dict("os.environ", {"VIKUNJA_TOKEN": "tok"})
|
@patch.dict("os.environ", {"VIKUNJA_TOKEN": "tok"})
|
||||||
def test_not_found(self, mock_client_cls: MagicMock) -> None:
|
def test_not_found(self, mock_client_cls: MagicMock) -> None:
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
mock_client.list_project_tasks.return_value = []
|
mock_client.find_task_by_identifier.return_value = None
|
||||||
mock_client_cls.return_value = mock_client
|
|
||||||
with pytest.raises(click.ClickException, match="Could not find"):
|
|
||||||
get_vikunja_task_title("DEVX-42")
|
|
||||||
|
|
||||||
@patch("devx.tools.create_pr.VikunjaClient")
|
|
||||||
@patch.dict("os.environ", {"VIKUNJA_TOKEN": "tok"})
|
|
||||||
def test_pagination_not_found(self, mock_client_cls: MagicMock) -> None:
|
|
||||||
from devx.config import DEFAULT_PER_PAGE
|
|
||||||
|
|
||||||
mock_client = MagicMock()
|
|
||||||
page1 = [{"identifier": f"OTHER-{i}"} for i in range(DEFAULT_PER_PAGE)]
|
|
||||||
page2 = [{"identifier": "OTHER-99"}]
|
|
||||||
mock_client.list_project_tasks.side_effect = [page1, page2]
|
|
||||||
mock_client_cls.return_value = mock_client
|
mock_client_cls.return_value = mock_client
|
||||||
with pytest.raises(click.ClickException, match="Could not find"):
|
with pytest.raises(click.ClickException, match="Could not find"):
|
||||||
get_vikunja_task_title("DEVX-42")
|
get_vikunja_task_title("DEVX-42")
|
||||||
@@ -95,7 +94,7 @@ class TestCreatePr:
|
|||||||
@patch("devx.tools.create_pr.GiteaClient")
|
@patch("devx.tools.create_pr.GiteaClient")
|
||||||
@patch("devx.tools.create_pr.get_vikunja_task_title", return_value="Add feature")
|
@patch("devx.tools.create_pr.get_vikunja_task_title", return_value="Add feature")
|
||||||
@patch("devx.tools.create_pr.find_existing_pr", return_value=None)
|
@patch("devx.tools.create_pr.find_existing_pr", return_value=None)
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
def test_creates_new_pr(self, mock_find: MagicMock, mock_title: MagicMock, mock_gitea: MagicMock) -> None:
|
def test_creates_new_pr(self, mock_find: MagicMock, mock_title: MagicMock, mock_gitea: MagicMock) -> None:
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
mock_client.create_pr.return_value = {"number": 15, "html_url": "https://git.example.com/pr/15"}
|
mock_client.create_pr.return_value = {"number": 15, "html_url": "https://git.example.com/pr/15"}
|
||||||
@@ -112,7 +111,7 @@ class TestCreatePr:
|
|||||||
@patch("devx.tools.create_pr.GiteaClient")
|
@patch("devx.tools.create_pr.GiteaClient")
|
||||||
@patch("devx.tools.create_pr.get_vikunja_task_title", return_value="Add feature")
|
@patch("devx.tools.create_pr.get_vikunja_task_title", return_value="Add feature")
|
||||||
@patch("devx.tools.create_pr.find_existing_pr")
|
@patch("devx.tools.create_pr.find_existing_pr")
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
def test_existing_pr_idempotent(self, mock_find: MagicMock, mock_title: MagicMock, mock_gitea: MagicMock) -> None:
|
def test_existing_pr_idempotent(self, mock_find: MagicMock, mock_title: MagicMock, mock_gitea: MagicMock) -> None:
|
||||||
mock_find.return_value = {"number": 10, "html_url": "https://git.example.com/pr/10"}
|
mock_find.return_value = {"number": 10, "html_url": "https://git.example.com/pr/10"}
|
||||||
mock_client = MagicMock()
|
mock_client = MagicMock()
|
||||||
@@ -123,10 +122,10 @@ class TestCreatePr:
|
|||||||
|
|
||||||
@patch.dict("os.environ", {}, clear=True)
|
@patch.dict("os.environ", {}, clear=True)
|
||||||
def test_no_repo_token(self) -> None:
|
def test_no_repo_token(self) -> None:
|
||||||
with pytest.raises(click.ClickException, match="REPO_TOKEN"):
|
with pytest.raises(click.ClickException, match="CI_GITEA_TOKEN"):
|
||||||
create_pr("DEVX-42-fix", "master", "", "owner", "repo")
|
create_pr("DEVX-42-fix", "master", "", "owner", "repo")
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
def test_no_task_id_in_branch(self) -> None:
|
def test_no_task_id_in_branch(self) -> None:
|
||||||
with pytest.raises(click.ClickException, match="does not contain a task ID"):
|
with pytest.raises(click.ClickException, match="does not contain a task ID"):
|
||||||
create_pr("feature-branch", "master", "", "owner", "repo")
|
create_pr("feature-branch", "master", "", "owner", "repo")
|
||||||
|
|||||||
@@ -38,6 +38,31 @@ class TestIsReleaseCommit:
|
|||||||
assert detect_release_commit.is_release_commit("") is False
|
assert detect_release_commit.is_release_commit("") is False
|
||||||
|
|
||||||
|
|
||||||
|
class TestIsBadgeCommit:
|
||||||
|
def test_badge_commit(self) -> None:
|
||||||
|
assert detect_release_commit.is_badge_commit("chore: update badge URLs to commit abc123 [skip ci]") is True
|
||||||
|
|
||||||
|
def test_regular_chore(self) -> None:
|
||||||
|
assert detect_release_commit.is_badge_commit("chore: cleanup deps") is False
|
||||||
|
|
||||||
|
def test_empty(self) -> None:
|
||||||
|
assert detect_release_commit.is_badge_commit("") is False
|
||||||
|
|
||||||
|
|
||||||
|
class TestIsAutomatedCommit:
|
||||||
|
def test_release_is_automated(self) -> None:
|
||||||
|
assert detect_release_commit.is_automated_commit("release: v1.0.0 [skip ci]") is True
|
||||||
|
|
||||||
|
def test_badge_is_automated(self) -> None:
|
||||||
|
assert detect_release_commit.is_automated_commit("chore: update badge URLs to commit abc123 [skip ci]") is True
|
||||||
|
|
||||||
|
def test_regular_is_not_automated(self) -> None:
|
||||||
|
assert detect_release_commit.is_automated_commit("OBL-INFRA-363: fix: something") is False
|
||||||
|
|
||||||
|
def test_empty(self) -> None:
|
||||||
|
assert detect_release_commit.is_automated_commit("") is False
|
||||||
|
|
||||||
|
|
||||||
class TestWriteGithubOutput:
|
class TestWriteGithubOutput:
|
||||||
def test_write(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
def test_write(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
gh_file = tmp_path / "output.txt"
|
gh_file = tmp_path / "output.txt"
|
||||||
@@ -62,7 +87,26 @@ class TestMain:
|
|||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "Release commit" in result.output
|
assert "Release commit" in result.output
|
||||||
with open(gh_file) as f:
|
with open(gh_file) as f:
|
||||||
assert "is-release=true" in f.read()
|
content = f.read()
|
||||||
|
assert "is-release=true" in content
|
||||||
|
assert "is-automated=true" in content
|
||||||
|
|
||||||
|
def test_badge_commit(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
gh_file = tmp_path / "output.txt"
|
||||||
|
monkeypatch.setenv("GITHUB_OUTPUT", str(gh_file))
|
||||||
|
with patch.object(
|
||||||
|
detect_release_commit,
|
||||||
|
"get_commit_message",
|
||||||
|
return_value="chore: update badge URLs to commit abc123 [skip ci]",
|
||||||
|
):
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(detect_release_commit.main, [])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "Automated CI commit" in result.output
|
||||||
|
with open(gh_file) as f:
|
||||||
|
content = f.read()
|
||||||
|
assert "is-release=false" in content
|
||||||
|
assert "is-automated=true" in content
|
||||||
|
|
||||||
def test_regular_commit(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
def test_regular_commit(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
gh_file = tmp_path / "output.txt"
|
gh_file = tmp_path / "output.txt"
|
||||||
@@ -73,4 +117,6 @@ class TestMain:
|
|||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "Regular merge commit" in result.output
|
assert "Regular merge commit" in result.output
|
||||||
with open(gh_file) as f:
|
with open(gh_file) as f:
|
||||||
assert "is-release=false" in f.read()
|
content = f.read()
|
||||||
|
assert "is-release=false" in content
|
||||||
|
assert "is-automated=false" in content
|
||||||
|
|||||||
@@ -0,0 +1,250 @@
|
|||||||
|
"""Unit tests for devx.ci.distribute_items."""
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from click.testing import CliRunner
|
||||||
|
|
||||||
|
from devx.ci.distribute_items import (
|
||||||
|
DEFAULT_WEIGHT,
|
||||||
|
distribute,
|
||||||
|
items_for_runner,
|
||||||
|
main,
|
||||||
|
parse_items,
|
||||||
|
parse_weighted_items,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestParseItems:
|
||||||
|
def test_string_array(self) -> None:
|
||||||
|
assert parse_items('["a", "b", "c"]') == ["a", "b", "c"]
|
||||||
|
|
||||||
|
def test_object_array(self) -> None:
|
||||||
|
raw = '[{"id": "a", "weight": 2}, {"id": "b"}]'
|
||||||
|
assert parse_items(raw) == ["a", "b"]
|
||||||
|
|
||||||
|
def test_empty_array(self) -> None:
|
||||||
|
assert parse_items("[]") == []
|
||||||
|
|
||||||
|
def test_not_an_array(self) -> None:
|
||||||
|
with pytest.raises(Exception, match="must be a JSON array"):
|
||||||
|
parse_items('{"key": "value"}')
|
||||||
|
|
||||||
|
def test_invalid_entry_type(self) -> None:
|
||||||
|
with pytest.raises(Exception, match="must be a string or an object"):
|
||||||
|
parse_items("[42]")
|
||||||
|
|
||||||
|
def test_object_without_id(self) -> None:
|
||||||
|
with pytest.raises(Exception, match="must be a string or an object"):
|
||||||
|
parse_items('[{"weight": 2}]')
|
||||||
|
|
||||||
|
|
||||||
|
class TestParseWeightedItems:
|
||||||
|
def test_string_array_default_weights(self) -> None:
|
||||||
|
items, weights = parse_weighted_items('["a", "b"]')
|
||||||
|
assert items == ["a", "b"]
|
||||||
|
assert weights == [DEFAULT_WEIGHT, DEFAULT_WEIGHT]
|
||||||
|
|
||||||
|
def test_object_array_with_weights(self) -> None:
|
||||||
|
items, weights = parse_weighted_items('[{"id": "a", "weight": 5}, {"id": "b", "weight": 1}]')
|
||||||
|
assert items == ["a", "b"]
|
||||||
|
assert weights == [5, 1]
|
||||||
|
|
||||||
|
def test_object_array_missing_weight(self) -> None:
|
||||||
|
items, weights = parse_weighted_items('[{"id": "a"}]')
|
||||||
|
assert items == ["a"]
|
||||||
|
assert weights == [DEFAULT_WEIGHT]
|
||||||
|
|
||||||
|
def test_not_an_array(self) -> None:
|
||||||
|
with pytest.raises(Exception, match="must be a JSON array"):
|
||||||
|
parse_weighted_items('"hello"')
|
||||||
|
|
||||||
|
def test_invalid_entry(self) -> None:
|
||||||
|
with pytest.raises(Exception, match="must be a string or an object"):
|
||||||
|
parse_weighted_items("[true]")
|
||||||
|
|
||||||
|
|
||||||
|
class TestDistribute:
|
||||||
|
def test_even_split(self) -> None:
|
||||||
|
items = [f"vm-{i}" for i in range(6)]
|
||||||
|
weights = [1] * 6
|
||||||
|
groups = distribute(items, weights, 3)
|
||||||
|
assert len(groups) == 3
|
||||||
|
assert all(len(g) == 2 for g in groups)
|
||||||
|
|
||||||
|
def test_uneven_split(self) -> None:
|
||||||
|
items = [f"vm-{i}" for i in range(5)]
|
||||||
|
weights = [1] * 5
|
||||||
|
groups = distribute(items, weights, 3)
|
||||||
|
assert len(groups[0]) == 2
|
||||||
|
assert len(groups[1]) == 2
|
||||||
|
assert len(groups[2]) == 1
|
||||||
|
|
||||||
|
def test_more_runners_than_items(self) -> None:
|
||||||
|
items = ["vm-a"]
|
||||||
|
weights = [1]
|
||||||
|
groups = distribute(items, weights, 5)
|
||||||
|
assert len(groups) == 5
|
||||||
|
assert len(groups[0]) == 1
|
||||||
|
assert all(len(g) == 0 for g in groups[1:])
|
||||||
|
|
||||||
|
def test_lpt_heavy_item_on_least_loaded(self) -> None:
|
||||||
|
items = ["heavy", "light1", "light2", "light3"]
|
||||||
|
weights = [10, 1, 1, 1]
|
||||||
|
groups = distribute(items, weights, 2)
|
||||||
|
# Heavy item goes to runner 0, lights go to runner 1 (least loaded)
|
||||||
|
assert "heavy" in groups[0]
|
||||||
|
# Runner 1 should have more items but less total weight
|
||||||
|
assert len(groups[1]) >= 2
|
||||||
|
|
||||||
|
def test_empty_items(self) -> None:
|
||||||
|
groups = distribute([], [], 3)
|
||||||
|
assert len(groups) == 3
|
||||||
|
assert all(len(g) == 0 for g in groups)
|
||||||
|
|
||||||
|
def test_single_runner(self) -> None:
|
||||||
|
items = ["a", "b", "c"]
|
||||||
|
weights = [1, 2, 3]
|
||||||
|
groups = distribute(items, weights, 1)
|
||||||
|
assert len(groups) == 1
|
||||||
|
assert len(groups[0]) == 3
|
||||||
|
|
||||||
|
|
||||||
|
class TestItemsForRunner:
|
||||||
|
def test_returns_assigned_subset(self) -> None:
|
||||||
|
items = ["a", "b", "c", "d", "e", "f"]
|
||||||
|
weights = [1] * 6
|
||||||
|
result = items_for_runner(items, weights, 0, 3)
|
||||||
|
assert len(result) == 2
|
||||||
|
assert all(item in items for item in result)
|
||||||
|
|
||||||
|
def test_out_of_range(self) -> None:
|
||||||
|
with pytest.raises(Exception, match="out of range"):
|
||||||
|
items_for_runner(["a"], [1], 5, 3)
|
||||||
|
|
||||||
|
def test_negative_index(self) -> None:
|
||||||
|
with pytest.raises(Exception, match="out of range"):
|
||||||
|
items_for_runner(["a"], [1], -1, 3)
|
||||||
|
|
||||||
|
|
||||||
|
class TestMain:
|
||||||
|
def test_stdin_string_array(self) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--runner-index", "1", "--max-runners", "2"], input='["a", "b", "c"]')
|
||||||
|
assert result.exit_code == 0
|
||||||
|
# LPT: heaviest first, so "a" goes to runner 0, "b" to runner 1, "c" to runner 0
|
||||||
|
# All weights equal, so round-robin-ish: runner 0 gets "a","c"; runner 1 gets "b"
|
||||||
|
assert "a" in result.output
|
||||||
|
|
||||||
|
def test_stdin_object_array(self) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
main,
|
||||||
|
["--runner-index", "1", "--max-runners", "2"],
|
||||||
|
input='[{"id": "a", "weight": 5}, {"id": "b", "weight": 1}]',
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "a" in result.output
|
||||||
|
|
||||||
|
def test_items_file(self, tmp_path: object) -> None:
|
||||||
|
import pathlib
|
||||||
|
|
||||||
|
items_file = pathlib.Path(str(tmp_path)) / "items.json"
|
||||||
|
items_file.write_text('["x", "y", "z"]')
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--items-file", str(items_file), "--runner-index", "1", "--max-runners", "3"])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "x" in result.output
|
||||||
|
|
||||||
|
def test_print_all_groups_no_runner_index(self) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--max-runners", "2"], input='["a", "b"]')
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "Runner 0:" in result.output
|
||||||
|
assert "Runner 1:" in result.output
|
||||||
|
|
||||||
|
def test_empty_stdin(self) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--runner-index", "1", "--max-runners", "3"], input="")
|
||||||
|
assert result.exit_code == 0
|
||||||
|
# Empty input → empty assigned items
|
||||||
|
assert result.output.strip() == ""
|
||||||
|
|
||||||
|
def test_github_env(self, tmp_path: object, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
import pathlib
|
||||||
|
|
||||||
|
gh_env = pathlib.Path(str(tmp_path)) / "gh_env"
|
||||||
|
gh_env.write_text("")
|
||||||
|
monkeypatch.setenv("GITHUB_ENV", str(gh_env))
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
main,
|
||||||
|
["--runner-index", "1", "--max-runners", "2", "--github-env"],
|
||||||
|
input='["a", "b"]',
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0
|
||||||
|
content = gh_env.read_text()
|
||||||
|
assert "ASSIGNED_ITEMS=" in content
|
||||||
|
assert "SKIP=false" in content
|
||||||
|
|
||||||
|
def test_skip_if_excess(self, tmp_path: object, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
import pathlib
|
||||||
|
|
||||||
|
gh_env = pathlib.Path(str(tmp_path)) / "gh_env"
|
||||||
|
gh_env.write_text("")
|
||||||
|
monkeypatch.setenv("GITHUB_ENV", str(gh_env))
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
main,
|
||||||
|
["--runner-index", "5", "--max-runners", "3", "--github-env", "--skip-if-excess"],
|
||||||
|
input='["a"]',
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0
|
||||||
|
content = gh_env.read_text()
|
||||||
|
assert "ASSIGNED_ITEMS=" in content
|
||||||
|
assert "SKIP=true" in content
|
||||||
|
|
||||||
|
def test_runner_index_zero(self) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--runner-index", "0"], input='["a"]')
|
||||||
|
assert result.exit_code != 0
|
||||||
|
assert "out of range" in result.output
|
||||||
|
|
||||||
|
def test_default_max_runners(self) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--runner-index", "1"], input='["a"]')
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "a" in result.output
|
||||||
|
|
||||||
|
def test_github_env_not_set(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.delenv("GITHUB_ENV", raising=False)
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
main,
|
||||||
|
["--runner-index", "1", "--github-env"],
|
||||||
|
input='["a"]',
|
||||||
|
)
|
||||||
|
assert result.exit_code != 0
|
||||||
|
assert "GITHUB_ENV" in result.output
|
||||||
|
|
||||||
|
def test_invalid_json(self) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--runner-index", "1"], input="not json")
|
||||||
|
assert result.exit_code != 0
|
||||||
|
|
||||||
|
def test_multiline_github_env(self, tmp_path: object, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
import pathlib
|
||||||
|
|
||||||
|
gh_env = pathlib.Path(str(tmp_path)) / "gh_env"
|
||||||
|
gh_env.write_text("")
|
||||||
|
monkeypatch.setenv("GITHUB_ENV", str(gh_env))
|
||||||
|
runner = CliRunner()
|
||||||
|
# Items with newlines in their IDs would trigger multiline syntax
|
||||||
|
# Normal items don't have newlines, but test the path anyway
|
||||||
|
result = runner.invoke(
|
||||||
|
main,
|
||||||
|
["--runner-index", "1", "--max-runners", "1", "--github-env"],
|
||||||
|
input='["a\\nb"]',
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0
|
||||||
|
content = gh_env.read_text()
|
||||||
|
# Item "a\nb" contains a newline → heredoc syntax
|
||||||
|
assert "ASSIGNED_ITEMS<<" in content
|
||||||
@@ -12,10 +12,13 @@ from devx.ci.doc_coverage import (
|
|||||||
main,
|
main,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Path to devx's own source directory (for testing)
|
||||||
|
DEVX_SRC_DIR = Path(__file__).resolve().parent.parent.parent / "src" / "devx"
|
||||||
|
|
||||||
|
|
||||||
class TestExtractCliCommands:
|
class TestExtractCliCommands:
|
||||||
def test_extracts_commands(self) -> None:
|
def test_extracts_commands(self) -> None:
|
||||||
commands = extract_cli_commands()
|
commands = extract_cli_commands(DEVX_SRC_DIR)
|
||||||
# devx CLI has commands under ci, tools, and molecule groups
|
# devx CLI has commands under ci, tools, and molecule groups
|
||||||
assert "auto-merge" in commands
|
assert "auto-merge" in commands
|
||||||
assert "release" in commands
|
assert "release" in commands
|
||||||
@@ -24,39 +27,30 @@ class TestExtractCliCommands:
|
|||||||
assert "install-tools" in commands
|
assert "install-tools" in commands
|
||||||
|
|
||||||
def test_returns_list(self) -> None:
|
def test_returns_list(self) -> None:
|
||||||
commands = extract_cli_commands()
|
commands = extract_cli_commands(DEVX_SRC_DIR)
|
||||||
assert isinstance(commands, list)
|
assert isinstance(commands, list)
|
||||||
assert len(commands) > 0
|
assert len(commands) > 0
|
||||||
|
|
||||||
def test_no_cli_file(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
def test_no_cli_file(self, tmp_path: Path) -> None:
|
||||||
"""Returns empty list when CLI file doesn't exist."""
|
"""Returns empty list when CLI file doesn't exist."""
|
||||||
from devx.ci import doc_coverage
|
commands = extract_cli_commands(tmp_path)
|
||||||
|
|
||||||
monkeypatch.setattr(doc_coverage, "CLI_FILE", Path("/nonexistent/cli.py"))
|
|
||||||
commands = extract_cli_commands()
|
|
||||||
assert commands == []
|
assert commands == []
|
||||||
|
|
||||||
def test_def_fallback_no_explicit_name(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
def test_def_fallback_no_explicit_name(self, tmp_path: Path) -> None:
|
||||||
"""When a command decorator has no explicit name, falls back to the def name."""
|
"""When a command decorator has no explicit name, falls back to the def name."""
|
||||||
from devx.ci import doc_coverage
|
|
||||||
|
|
||||||
fake_cli = tmp_path / "cli.py"
|
fake_cli = tmp_path / "cli.py"
|
||||||
fake_cli.write_text("@click.group()\ndef cli():\n pass\n@cli.command()\ndef my_command():\n pass\n")
|
fake_cli.write_text("@click.group()\ndef cli():\n pass\n@cli.command()\ndef my_command():\n pass\n")
|
||||||
monkeypatch.setattr(doc_coverage, "CLI_FILE", fake_cli)
|
commands = extract_cli_commands(tmp_path)
|
||||||
commands = extract_cli_commands()
|
|
||||||
assert "my_command" in commands
|
assert "my_command" in commands
|
||||||
|
|
||||||
def test_command_decorator_no_def_fallback(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
def test_command_decorator_no_def_fallback(self, tmp_path: Path) -> None:
|
||||||
"""When a command decorator has no name and no following def, it is skipped."""
|
"""When a command decorator has no name and no following def, it is skipped."""
|
||||||
from devx.ci import doc_coverage
|
|
||||||
|
|
||||||
fake_cli = tmp_path / "cli.py"
|
fake_cli = tmp_path / "cli.py"
|
||||||
# The last @cli.command() has no explicit name and no def statement after it
|
# The last @cli.command() has no explicit name and no def statement after it
|
||||||
fake_cli.write_text(
|
fake_cli.write_text(
|
||||||
"@click.group()\ndef cli():\n pass\n@cli.command()\ndef real_cmd():\n pass\n@cli.command()\npass\n"
|
"@click.group()\ndef cli():\n pass\n@cli.command()\ndef real_cmd():\n pass\n@cli.command()\npass\n"
|
||||||
)
|
)
|
||||||
monkeypatch.setattr(doc_coverage, "CLI_FILE", fake_cli)
|
commands = extract_cli_commands(tmp_path)
|
||||||
commands = extract_cli_commands()
|
|
||||||
# real_cmd should be found via def fallback; the bare @cli.command() is skipped
|
# real_cmd should be found via def fallback; the bare @cli.command() is skipped
|
||||||
assert "real_cmd" in commands
|
assert "real_cmd" in commands
|
||||||
assert "pass" not in commands
|
assert "pass" not in commands
|
||||||
@@ -96,19 +90,29 @@ class TestMain:
|
|||||||
docs = tmp_path / "docs"
|
docs = tmp_path / "docs"
|
||||||
(docs / "user").mkdir(parents=True)
|
(docs / "user").mkdir(parents=True)
|
||||||
(docs / "tech").mkdir(parents=True)
|
(docs / "tech").mkdir(parents=True)
|
||||||
# Get actual commands from the CLI
|
src = tmp_path / "src" / "devx"
|
||||||
commands = extract_cli_commands()
|
src.mkdir(parents=True)
|
||||||
|
(src / "ci").mkdir()
|
||||||
|
(src / "__init__.py").write_text("")
|
||||||
|
(src / "ci" / "__init__.py").write_text("")
|
||||||
|
# Create a fake cli.py with some commands
|
||||||
|
(src / "cli.py").write_text(
|
||||||
|
"@click.group()\ndef cli():\n pass\n"
|
||||||
|
"@cli.command('release')\ndef release():\n pass\n"
|
||||||
|
"@cli.command('setup')\ndef setup():\n pass\n"
|
||||||
|
)
|
||||||
|
# Create a fake module and CI script
|
||||||
|
(src / "config.py").write_text("# config module")
|
||||||
|
(src / "ci" / "auto_merge.py").write_text("# auto_merge script")
|
||||||
# Write cli-commands.md with all commands
|
# Write cli-commands.md with all commands
|
||||||
cli_content = "\n".join(f"## {cmd}" for cmd in commands)
|
cli_content = "## release\n\n## setup\n"
|
||||||
(docs / "user" / "cli-commands.md").write_text(cli_content)
|
(docs / "user" / "cli-commands.md").write_text(cli_content)
|
||||||
# Write architecture.md with all modules
|
# Write architecture.md with all modules
|
||||||
from devx.ci.doc_coverage import REQUIRED_MODULES, REQUIRED_SCRIPTS
|
(docs / "tech" / "architecture.md").write_text("config.py")
|
||||||
|
|
||||||
(docs / "tech" / "architecture.md").write_text(" ".join(REQUIRED_MODULES))
|
|
||||||
# Write ci-cd-workflow.md with all scripts
|
# Write ci-cd-workflow.md with all scripts
|
||||||
(docs / "tech" / "ci-cd-workflow.md").write_text(" ".join(REQUIRED_SCRIPTS))
|
(docs / "tech" / "ci-cd-workflow.md").write_text("auto_merge.py")
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(main, ["--docs-dir", str(docs)])
|
result = runner.invoke(main, ["--docs-dir", str(docs), "--source-dir", str(src)])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "100%" in result.output
|
assert "100%" in result.output
|
||||||
|
|
||||||
@@ -117,11 +121,21 @@ class TestMain:
|
|||||||
docs = tmp_path / "docs"
|
docs = tmp_path / "docs"
|
||||||
(docs / "user").mkdir(parents=True)
|
(docs / "user").mkdir(parents=True)
|
||||||
(docs / "tech").mkdir(parents=True)
|
(docs / "tech").mkdir(parents=True)
|
||||||
|
src = tmp_path / "src" / "devx"
|
||||||
|
src.mkdir(parents=True)
|
||||||
|
(src / "ci").mkdir()
|
||||||
|
(src / "__init__.py").write_text("")
|
||||||
|
(src / "ci" / "__init__.py").write_text("")
|
||||||
|
(src / "cli.py").write_text(
|
||||||
|
"@click.group()\ndef cli():\n pass\n@cli.command('release')\ndef release():\n pass\n"
|
||||||
|
)
|
||||||
|
(src / "config.py").write_text("# config")
|
||||||
|
(src / "ci" / "auto_merge.py").write_text("# auto_merge")
|
||||||
(docs / "user" / "cli-commands.md").write_text("No commands here.")
|
(docs / "user" / "cli-commands.md").write_text("No commands here.")
|
||||||
(docs / "tech" / "architecture.md").write_text("No modules here.")
|
(docs / "tech" / "architecture.md").write_text("No modules here.")
|
||||||
(docs / "tech" / "ci-cd-workflow.md").write_text("No scripts here.")
|
(docs / "tech" / "ci-cd-workflow.md").write_text("No scripts here.")
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(main, ["--docs-dir", str(docs), "--fail-on-missing"])
|
result = runner.invoke(main, ["--docs-dir", str(docs), "--source-dir", str(src), "--fail-on-missing"])
|
||||||
assert result.exit_code == 1
|
assert result.exit_code == 1
|
||||||
|
|
||||||
def test_missing_docs_warn_only(self, tmp_path: Path) -> None:
|
def test_missing_docs_warn_only(self, tmp_path: Path) -> None:
|
||||||
@@ -129,10 +143,55 @@ class TestMain:
|
|||||||
docs = tmp_path / "docs"
|
docs = tmp_path / "docs"
|
||||||
(docs / "user").mkdir(parents=True)
|
(docs / "user").mkdir(parents=True)
|
||||||
(docs / "tech").mkdir(parents=True)
|
(docs / "tech").mkdir(parents=True)
|
||||||
|
src = tmp_path / "src" / "devx"
|
||||||
|
src.mkdir(parents=True)
|
||||||
|
(src / "ci").mkdir()
|
||||||
|
(src / "__init__.py").write_text("")
|
||||||
|
(src / "ci" / "__init__.py").write_text("")
|
||||||
|
(src / "cli.py").write_text(
|
||||||
|
"@click.group()\ndef cli():\n pass\n@cli.command('release')\ndef release():\n pass\n"
|
||||||
|
)
|
||||||
|
(src / "config.py").write_text("# config")
|
||||||
|
(src / "ci" / "auto_merge.py").write_text("# auto_merge")
|
||||||
(docs / "user" / "cli-commands.md").write_text("No commands here.")
|
(docs / "user" / "cli-commands.md").write_text("No commands here.")
|
||||||
(docs / "tech" / "architecture.md").write_text("No modules here.")
|
(docs / "tech" / "architecture.md").write_text("No modules here.")
|
||||||
(docs / "tech" / "ci-cd-workflow.md").write_text("No scripts here.")
|
(docs / "tech" / "ci-cd-workflow.md").write_text("No scripts here.")
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(main, ["--docs-dir", str(docs)])
|
result = runner.invoke(main, ["--docs-dir", str(docs), "--source-dir", str(src)])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "MISSING" in result.output
|
assert "MISSING" in result.output
|
||||||
|
|
||||||
|
def test_auto_detect_scripts_dir(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
"""When src/ doesn't exist but scripts/ does, auto-detect it."""
|
||||||
|
monkeypatch.chdir(tmp_path)
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
(docs / "user").mkdir(parents=True)
|
||||||
|
(docs / "tech").mkdir(parents=True)
|
||||||
|
scripts = tmp_path / "scripts"
|
||||||
|
scripts.mkdir()
|
||||||
|
(scripts / "cli.py").write_text(
|
||||||
|
"@click.group()\ndef cli():\n pass\n@cli.command('release')\ndef release():\n pass\n"
|
||||||
|
)
|
||||||
|
(scripts / "config.py").write_text("# config")
|
||||||
|
(docs / "user" / "cli-commands.md").write_text("## release\n")
|
||||||
|
(docs / "tech" / "architecture.md").write_text("config.py")
|
||||||
|
(docs / "tech" / "ci-cd-workflow.md").write_text("")
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--docs-dir", str(docs)])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
|
||||||
|
def test_no_source_dir_falls_back_to_required(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
"""When no source dir exists, falls back to REQUIRED_MODULES/SCRIPTS."""
|
||||||
|
monkeypatch.chdir(tmp_path)
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
(docs / "user").mkdir(parents=True)
|
||||||
|
(docs / "tech").mkdir(parents=True)
|
||||||
|
(docs / "user" / "cli-commands.md").write_text("")
|
||||||
|
from devx.ci.doc_coverage import REQUIRED_MODULES, REQUIRED_SCRIPTS
|
||||||
|
|
||||||
|
(docs / "tech" / "architecture.md").write_text(" ".join(REQUIRED_MODULES))
|
||||||
|
(docs / "tech" / "ci-cd-workflow.md").write_text(" ".join(REQUIRED_SCRIPTS))
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--docs-dir", str(docs)])
|
||||||
|
# No source dir found, so no CLI commands, but modules/scripts from REQUIRED lists
|
||||||
|
assert result.exit_code == 0
|
||||||
|
|||||||
@@ -0,0 +1,149 @@
|
|||||||
|
"""Unit tests for devx.tools.docker_login."""
|
||||||
|
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from click.testing import CliRunner
|
||||||
|
|
||||||
|
from devx.tools.docker_login import (
|
||||||
|
_resolve_credentials,
|
||||||
|
cli,
|
||||||
|
docker_login,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestDockerLogin:
|
||||||
|
@patch("devx.tools.docker_login.subprocess.run")
|
||||||
|
def test_success(self, mock_run: MagicMock) -> None:
|
||||||
|
mock_run.return_value = MagicMock(returncode=0, stdout="", stderr="")
|
||||||
|
assert docker_login("registry.io", "user", "tok") is True
|
||||||
|
|
||||||
|
@patch("devx.tools.docker_login.subprocess.run")
|
||||||
|
def test_failure_raises(self, mock_run: MagicMock) -> None:
|
||||||
|
mock_run.return_value = MagicMock(returncode=1, stdout="", stderr="auth failed")
|
||||||
|
with pytest.raises(Exception, match="auth failed"):
|
||||||
|
docker_login("registry.io", "user", "tok")
|
||||||
|
|
||||||
|
@patch("devx.tools.docker_login.subprocess.run")
|
||||||
|
def test_failure_suppressed(self, mock_run: MagicMock) -> None:
|
||||||
|
mock_run.return_value = MagicMock(returncode=1, stdout="", stderr="auth failed")
|
||||||
|
assert docker_login("registry.io", "user", "tok", suppress_failure=True) is False
|
||||||
|
|
||||||
|
|
||||||
|
class TestResolveCredentials:
|
||||||
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "CI_GITEA_USERNAME": "emil"}, clear=True)
|
||||||
|
def test_both_set(self) -> None:
|
||||||
|
user, token = _resolve_credentials("CI_GITEA_TOKEN", "CI_GITEA_USERNAME", None)
|
||||||
|
assert user == "emil"
|
||||||
|
assert token == "tok"
|
||||||
|
|
||||||
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
|
def test_token_only_with_default(self) -> None:
|
||||||
|
user, token = _resolve_credentials("CI_GITEA_TOKEN", "CI_GITEA_USERNAME", "emil")
|
||||||
|
assert user == "emil"
|
||||||
|
assert token == "tok"
|
||||||
|
|
||||||
|
@patch.dict("os.environ", {}, clear=True)
|
||||||
|
def test_no_token(self) -> None:
|
||||||
|
user, token = _resolve_credentials("CI_GITEA_TOKEN", "CI_GITEA_USERNAME", "emil")
|
||||||
|
assert user is None
|
||||||
|
assert token is None
|
||||||
|
|
||||||
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
|
def test_no_username_no_default(self) -> None:
|
||||||
|
user, token = _resolve_credentials("CI_GITEA_TOKEN", "CI_GITEA_USERNAME", None)
|
||||||
|
assert user == ""
|
||||||
|
assert token == "tok"
|
||||||
|
|
||||||
|
|
||||||
|
class TestCli:
|
||||||
|
@patch("devx.tools.docker_login.docker_login")
|
||||||
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "CI_GITEA_USERNAME": "emil"}, clear=True)
|
||||||
|
def test_required_login(self, mock_login: MagicMock) -> None:
|
||||||
|
mock_login.return_value = True
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
cli,
|
||||||
|
["--registry", "reg.io", "--token-env", "CI_GITEA_TOKEN", "--username-env", "CI_GITEA_USERNAME"],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0
|
||||||
|
mock_login.assert_called_once()
|
||||||
|
|
||||||
|
@patch("devx.tools.docker_login.docker_login")
|
||||||
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
|
def test_default_username(self, mock_login: MagicMock) -> None:
|
||||||
|
mock_login.return_value = True
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
cli,
|
||||||
|
[
|
||||||
|
"--registry",
|
||||||
|
"reg.io",
|
||||||
|
"--token-env",
|
||||||
|
"CI_GITEA_TOKEN",
|
||||||
|
"--username-env",
|
||||||
|
"CI_GITEA_USERNAME",
|
||||||
|
"--default-username",
|
||||||
|
"emil",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0
|
||||||
|
mock_login.assert_called_once_with("reg.io", "emil", "tok", suppress_failure=False)
|
||||||
|
|
||||||
|
@patch.dict("os.environ", {}, clear=True)
|
||||||
|
def test_required_no_token_raises(self) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
cli,
|
||||||
|
["--registry", "reg.io", "--token-env", "CI_GITEA_TOKEN", "--username-env", "CI_GITEA_USERNAME"],
|
||||||
|
)
|
||||||
|
assert result.exit_code != 0
|
||||||
|
|
||||||
|
@patch.dict("os.environ", {}, clear=True)
|
||||||
|
def test_optional_no_token_skips(self) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
cli,
|
||||||
|
[
|
||||||
|
"--registry",
|
||||||
|
"reg.io",
|
||||||
|
"--token-env",
|
||||||
|
"CI_GITEA_TOKEN",
|
||||||
|
"--username-env",
|
||||||
|
"CI_GITEA_USERNAME",
|
||||||
|
"--optional",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "Skipping" in result.output
|
||||||
|
|
||||||
|
@patch("devx.tools.docker_login.docker_login")
|
||||||
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"}, clear=True)
|
||||||
|
def test_no_username_raises(self, mock_login: MagicMock) -> None:
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
cli,
|
||||||
|
["--registry", "reg.io", "--token-env", "CI_GITEA_TOKEN", "--username-env", "CI_GITEA_USERNAME"],
|
||||||
|
)
|
||||||
|
assert result.exit_code != 0
|
||||||
|
mock_login.assert_not_called()
|
||||||
|
|
||||||
|
@patch("devx.tools.docker_login.docker_login")
|
||||||
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok", "CI_GITEA_USERNAME": "emil"}, clear=True)
|
||||||
|
def test_suppress_failure(self, mock_login: MagicMock) -> None:
|
||||||
|
mock_login.return_value = False
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(
|
||||||
|
cli,
|
||||||
|
[
|
||||||
|
"--registry",
|
||||||
|
"reg.io",
|
||||||
|
"--token-env",
|
||||||
|
"CI_GITEA_TOKEN",
|
||||||
|
"--username-env",
|
||||||
|
"CI_GITEA_USERNAME",
|
||||||
|
"--suppress-failure",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
assert result.exit_code == 0
|
||||||
|
mock_login.assert_called_once_with("reg.io", "emil", "tok", suppress_failure=True)
|
||||||
@@ -362,19 +362,19 @@ class TestWhoami:
|
|||||||
|
|
||||||
|
|
||||||
class TestConfigureTeaLogin:
|
class TestConfigureTeaLogin:
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": ""}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": ""}, clear=True)
|
||||||
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
||||||
def test_no_token_skips(self, mock_which: MagicMock) -> None:
|
def test_no_token_skips(self, mock_which: MagicMock) -> None:
|
||||||
"""configure_tea_login with no token prints skip message and returns."""
|
"""configure_tea_login with no token prints skip message and returns."""
|
||||||
configure_tea_login()
|
configure_tea_login()
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.gitea_cli.shutil.which", return_value=None)
|
@patch("devx.gitea_cli.shutil.which", return_value=None)
|
||||||
def test_no_tea_skips(self, mock_which: MagicMock) -> None:
|
def test_no_tea_skips(self, mock_which: MagicMock) -> None:
|
||||||
"""configure_tea_login with no tea binary prints skip message and returns."""
|
"""configure_tea_login with no tea binary prints skip message and returns."""
|
||||||
configure_tea_login()
|
configure_tea_login()
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
||||||
@patch("devx.gitea_cli.subprocess.run")
|
@patch("devx.gitea_cli.subprocess.run")
|
||||||
def test_configures_login_when_not_present(self, mock_subprocess: MagicMock, mock_which: MagicMock) -> None:
|
def test_configures_login_when_not_present(self, mock_subprocess: MagicMock, mock_which: MagicMock) -> None:
|
||||||
@@ -384,7 +384,7 @@ class TestConfigureTeaLogin:
|
|||||||
configure_tea_login()
|
configure_tea_login()
|
||||||
assert mock_subprocess.call_count >= 2 # login list + login add + login default
|
assert mock_subprocess.call_count >= 2 # login list + login add + login default
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
||||||
@patch("devx.gitea_cli.subprocess.run")
|
@patch("devx.gitea_cli.subprocess.run")
|
||||||
def test_skips_when_already_configured(self, mock_subprocess: MagicMock, mock_which: MagicMock) -> None:
|
def test_skips_when_already_configured(self, mock_subprocess: MagicMock, mock_which: MagicMock) -> None:
|
||||||
|
|||||||
@@ -8,21 +8,22 @@ import pytest
|
|||||||
from click import ClickException
|
from click import ClickException
|
||||||
|
|
||||||
import devx.tools.install_checkmake as install_checkmake
|
import devx.tools.install_checkmake as install_checkmake
|
||||||
|
from devx.tools._shared import arch_string
|
||||||
|
|
||||||
|
|
||||||
class TestArch:
|
class TestArchString:
|
||||||
def test_amd64(self) -> None:
|
def test_amd64(self) -> None:
|
||||||
with patch.object(platform, "machine", return_value="x86_64"):
|
with patch.object(platform, "machine", return_value="x86_64"):
|
||||||
assert install_checkmake._arch() == "amd64"
|
assert arch_string() == "amd64"
|
||||||
|
|
||||||
def test_arm64(self) -> None:
|
def test_arm64(self) -> None:
|
||||||
with patch.object(platform, "machine", return_value="aarch64"):
|
with patch.object(platform, "machine", return_value="aarch64"):
|
||||||
assert install_checkmake._arch() == "arm64"
|
assert arch_string() == "arm64"
|
||||||
|
|
||||||
def test_unsupported(self) -> None:
|
def test_unsupported(self) -> None:
|
||||||
with patch.object(platform, "machine", return_value="riscv64"):
|
with patch.object(platform, "machine", return_value="riscv64"):
|
||||||
with pytest.raises(ClickException):
|
with pytest.raises(ClickException):
|
||||||
install_checkmake._arch()
|
arch_string()
|
||||||
|
|
||||||
|
|
||||||
class TestInstallWithGo:
|
class TestInstallWithGo:
|
||||||
@@ -63,13 +64,19 @@ class TestDownloadBinary:
|
|||||||
|
|
||||||
class TestMain:
|
class TestMain:
|
||||||
def test_already_installed(self) -> None:
|
def test_already_installed(self) -> None:
|
||||||
|
from click.testing import CliRunner
|
||||||
|
|
||||||
with patch("shutil.which", return_value="/usr/bin/checkmake"):
|
with patch("shutil.which", return_value="/usr/bin/checkmake"):
|
||||||
install_checkmake.main()
|
runner = CliRunner()
|
||||||
|
runner.invoke(install_checkmake.cli, [])
|
||||||
|
|
||||||
def test_install_with_go(self) -> None:
|
def test_install_with_go(self) -> None:
|
||||||
|
from click.testing import CliRunner
|
||||||
|
|
||||||
with patch("shutil.which", side_effect=[None, "/usr/bin/go"]):
|
with patch("shutil.which", side_effect=[None, "/usr/bin/go"]):
|
||||||
with patch("subprocess.run") as mock_run:
|
with patch("subprocess.run") as mock_run:
|
||||||
install_checkmake.main()
|
runner = CliRunner()
|
||||||
|
runner.invoke(install_checkmake.cli, [])
|
||||||
mock_run.assert_called_once_with(
|
mock_run.assert_called_once_with(
|
||||||
[
|
[
|
||||||
"/usr/bin/go",
|
"/usr/bin/go",
|
||||||
@@ -80,6 +87,8 @@ class TestMain:
|
|||||||
)
|
)
|
||||||
|
|
||||||
def test_download_when_no_go(self, tmp_path: Path) -> None:
|
def test_download_when_no_go(self, tmp_path: Path) -> None:
|
||||||
|
from click.testing import CliRunner
|
||||||
|
|
||||||
target = tmp_path / "checkmake"
|
target = tmp_path / "checkmake"
|
||||||
|
|
||||||
def _write_file(url: str, path: str) -> tuple[str, None]:
|
def _write_file(url: str, path: str) -> tuple[str, None]:
|
||||||
@@ -90,5 +99,6 @@ class TestMain:
|
|||||||
with patch("shutil.which", side_effect=[None, None]):
|
with patch("shutil.which", side_effect=[None, None]):
|
||||||
with patch.object(platform, "machine", return_value="x86_64"):
|
with patch.object(platform, "machine", return_value="x86_64"):
|
||||||
with patch("urllib.request.urlretrieve", side_effect=_write_file) as mock_retrieve:
|
with patch("urllib.request.urlretrieve", side_effect=_write_file) as mock_retrieve:
|
||||||
install_checkmake.main()
|
runner = CliRunner()
|
||||||
|
runner.invoke(install_checkmake.cli, [])
|
||||||
mock_retrieve.assert_called_once()
|
mock_retrieve.assert_called_once()
|
||||||
|
|||||||
@@ -222,6 +222,53 @@ class TestInstallTea:
|
|||||||
assert (tmp_path / "tea").exists()
|
assert (tmp_path / "tea").exists()
|
||||||
|
|
||||||
|
|
||||||
|
class TestInstallHadolint:
|
||||||
|
def test_already_installed(self) -> None:
|
||||||
|
with patch.object(install_tools, "_is_installed", return_value=True):
|
||||||
|
assert install_tools.install_hadolint() is True
|
||||||
|
|
||||||
|
def test_install(self, tmp_path: Path) -> None:
|
||||||
|
def _write_file(url: str, path: Path) -> tuple[str, None]:
|
||||||
|
Path(path).write_bytes(b"binary")
|
||||||
|
return str(path), None
|
||||||
|
|
||||||
|
with patch.object(install_tools, "_is_installed", return_value=False):
|
||||||
|
with patch.object(install_tools, "TARGET_DIR", tmp_path):
|
||||||
|
with patch.object(platform, "machine", return_value="x86_64"):
|
||||||
|
with patch.object(install_tools, "_download", side_effect=_write_file):
|
||||||
|
assert install_tools.install_hadolint() is True
|
||||||
|
assert (tmp_path / "hadolint").exists()
|
||||||
|
|
||||||
|
|
||||||
|
class TestInstallTofu:
|
||||||
|
def test_already_installed(self) -> None:
|
||||||
|
with patch.object(install_tools, "_is_installed", return_value=True):
|
||||||
|
assert install_tools.install_tofu() is True
|
||||||
|
|
||||||
|
def test_install(self, tmp_path: Path) -> None:
|
||||||
|
import io
|
||||||
|
import tarfile
|
||||||
|
|
||||||
|
tarball_path = tmp_path / "archive.tar.gz"
|
||||||
|
binary_content = b"fake tofu"
|
||||||
|
with tarfile.open(tarball_path, "w:gz") as tar:
|
||||||
|
info = tarfile.TarInfo(name="tofu")
|
||||||
|
info.size = len(binary_content)
|
||||||
|
tar.addfile(info, io.BytesIO(binary_content))
|
||||||
|
|
||||||
|
with patch.object(install_tools, "_is_installed", return_value=False):
|
||||||
|
with patch.object(install_tools, "TARGET_DIR", tmp_path):
|
||||||
|
with patch.object(platform, "machine", return_value="x86_64"):
|
||||||
|
with patch.object(platform, "system", return_value="Linux"):
|
||||||
|
with patch.object(
|
||||||
|
install_tools,
|
||||||
|
"_download",
|
||||||
|
side_effect=lambda url, dest: Path(dest).write_bytes(tarball_path.read_bytes()),
|
||||||
|
):
|
||||||
|
assert install_tools.install_tofu() is True
|
||||||
|
assert (tmp_path / "tofu").exists()
|
||||||
|
|
||||||
|
|
||||||
class TestListTools:
|
class TestListTools:
|
||||||
def test_list(self, tmp_path: Path) -> None:
|
def test_list(self, tmp_path: Path) -> None:
|
||||||
with patch.object(install_tools, "TARGET_DIR", tmp_path):
|
with patch.object(install_tools, "TARGET_DIR", tmp_path):
|
||||||
@@ -251,6 +298,16 @@ class TestInstallTool:
|
|||||||
assert install_tools._install_tool("tea") is True
|
assert install_tools._install_tool("tea") is True
|
||||||
mock.assert_called_once()
|
mock.assert_called_once()
|
||||||
|
|
||||||
|
def test_hadolint(self) -> None:
|
||||||
|
with patch.object(install_tools, "install_hadolint", return_value=True) as mock:
|
||||||
|
assert install_tools._install_tool("hadolint") is True
|
||||||
|
mock.assert_called_once()
|
||||||
|
|
||||||
|
def test_tofu(self) -> None:
|
||||||
|
with patch.object(install_tools, "install_tofu", return_value=True) as mock:
|
||||||
|
assert install_tools._install_tool("tofu") is True
|
||||||
|
mock.assert_called_once()
|
||||||
|
|
||||||
def test_unknown_tool(self) -> None:
|
def test_unknown_tool(self) -> None:
|
||||||
with pytest.raises(ClickException, match="Unknown tool"):
|
with pytest.raises(ClickException, match="Unknown tool"):
|
||||||
install_tools._install_tool("unknown")
|
install_tools._install_tool("unknown")
|
||||||
@@ -269,7 +326,7 @@ class TestMain:
|
|||||||
with patch.object(install_tools, "_install_tool", return_value=True) as mock_install:
|
with patch.object(install_tools, "_install_tool", return_value=True) as mock_install:
|
||||||
result = runner.invoke(install_tools.main, [])
|
result = runner.invoke(install_tools.main, [])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert mock_install.call_count == 4
|
assert mock_install.call_count == 6
|
||||||
|
|
||||||
def test_install_specific_tool(self) -> None:
|
def test_install_specific_tool(self) -> None:
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
|
|||||||
@@ -101,7 +101,7 @@ class TestCli:
|
|||||||
os.environ,
|
os.environ,
|
||||||
{
|
{
|
||||||
"GITEA_URL": "https://gitea.example",
|
"GITEA_URL": "https://gitea.example",
|
||||||
"REPO_TOKEN": "token",
|
"CI_GITEA_TOKEN": "token",
|
||||||
"RUN_ID": "123",
|
"RUN_ID": "123",
|
||||||
"JOB_NAME": "integration-tests",
|
"JOB_NAME": "integration-tests",
|
||||||
"MATRIX_INDEX": "0",
|
"MATRIX_INDEX": "0",
|
||||||
@@ -148,7 +148,7 @@ class TestCli:
|
|||||||
os.environ,
|
os.environ,
|
||||||
{
|
{
|
||||||
"GITEA_URL": "https://gitea.example",
|
"GITEA_URL": "https://gitea.example",
|
||||||
"REPO_TOKEN": "token",
|
"CI_GITEA_TOKEN": "token",
|
||||||
"RUN_ID": "123",
|
"RUN_ID": "123",
|
||||||
"JOB_NAME": "integration-tests",
|
"JOB_NAME": "integration-tests",
|
||||||
"MATRIX_INDEX": "0",
|
"MATRIX_INDEX": "0",
|
||||||
@@ -193,7 +193,7 @@ class TestCli:
|
|||||||
os.environ,
|
os.environ,
|
||||||
{
|
{
|
||||||
"GITEA_URL": "https://gitea.example",
|
"GITEA_URL": "https://gitea.example",
|
||||||
"REPO_TOKEN": "token",
|
"CI_GITEA_TOKEN": "token",
|
||||||
"RUN_ID": "123",
|
"RUN_ID": "123",
|
||||||
"JOB_NAME": "integration-tests",
|
"JOB_NAME": "integration-tests",
|
||||||
"MATRIX_INDEX": "0",
|
"MATRIX_INDEX": "0",
|
||||||
@@ -239,7 +239,7 @@ class TestCli:
|
|||||||
assert "without cross-runner cancellation" in result.output
|
assert "without cross-runner cancellation" in result.output
|
||||||
|
|
||||||
def test_partial_env_vars_runs_without_polling(self) -> None:
|
def test_partial_env_vars_runs_without_polling(self) -> None:
|
||||||
"""Only GITEA_URL set (missing REPO_TOKEN and RUN_ID) — should skip polling."""
|
"""Only GITEA_URL set (missing CI_GITEA_TOKEN and RUN_ID) — should skip polling."""
|
||||||
with (
|
with (
|
||||||
patch.dict(
|
patch.dict(
|
||||||
os.environ,
|
os.environ,
|
||||||
|
|||||||
@@ -0,0 +1,436 @@
|
|||||||
|
"""Unit tests for devx.ci.lint_docs."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
from datetime import datetime, timedelta
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from click.testing import CliRunner
|
||||||
|
|
||||||
|
from devx.ci.lint_docs import (
|
||||||
|
check_docs_structure,
|
||||||
|
check_duplicate_headings,
|
||||||
|
check_heading_hierarchy,
|
||||||
|
check_internal_links,
|
||||||
|
check_required_files,
|
||||||
|
check_stale_docs,
|
||||||
|
check_todo_fixme,
|
||||||
|
check_trailing_whitespace,
|
||||||
|
extract_headings,
|
||||||
|
extract_links,
|
||||||
|
main,
|
||||||
|
slugify,
|
||||||
|
strip_code_blocks,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestSlugify:
|
||||||
|
def test_basic(self) -> None:
|
||||||
|
assert slugify("Hello World") == "hello-world"
|
||||||
|
|
||||||
|
def test_special_chars(self) -> None:
|
||||||
|
assert slugify("Hello, World!") == "hello-world"
|
||||||
|
|
||||||
|
def test_multiple_spaces(self) -> None:
|
||||||
|
assert slugify("Hello World") == "hello-world"
|
||||||
|
|
||||||
|
def test_trailing_dash(self) -> None:
|
||||||
|
assert slugify("Hello World -") == "hello-world--"
|
||||||
|
|
||||||
|
def test_empty(self) -> None:
|
||||||
|
assert slugify("") == ""
|
||||||
|
|
||||||
|
|
||||||
|
class TestExtractHeadings:
|
||||||
|
def test_extracts_headings(self, tmp_path: Path) -> None:
|
||||||
|
f = tmp_path / "test.md"
|
||||||
|
f.write_text("# Title\n\n## Section\n\n### Subsection\n")
|
||||||
|
headings = extract_headings(f)
|
||||||
|
assert "title" in headings
|
||||||
|
assert headings["title"] == 1
|
||||||
|
assert "section" in headings
|
||||||
|
assert headings["section"] == 2
|
||||||
|
assert "subsection" in headings
|
||||||
|
assert headings["subsection"] == 3
|
||||||
|
|
||||||
|
def test_no_headings(self, tmp_path: Path) -> None:
|
||||||
|
f = tmp_path / "test.md"
|
||||||
|
f.write_text("Just some text.\nNo headings here.\n")
|
||||||
|
headings = extract_headings(f)
|
||||||
|
assert headings == {}
|
||||||
|
|
||||||
|
def test_ignores_headings_in_code_blocks(self, tmp_path: Path) -> None:
|
||||||
|
"""Headings inside code blocks should not be detected."""
|
||||||
|
f = tmp_path / "test.md"
|
||||||
|
f.write_text("# Title\n\n```bash\n# Not a heading\n## Also not\n```\n\n## Real Section\n")
|
||||||
|
headings = extract_headings(f)
|
||||||
|
assert "title" in headings
|
||||||
|
assert "real-section" in headings
|
||||||
|
assert "not-a-heading" not in headings
|
||||||
|
assert "also-not" not in headings
|
||||||
|
|
||||||
|
|
||||||
|
class TestStripCodeBlocks:
|
||||||
|
def test_strips_fenced_blocks(self) -> None:
|
||||||
|
content = "Before\n```bash\n# comment\n```\nAfter"
|
||||||
|
result = strip_code_blocks(content)
|
||||||
|
assert "# comment" not in result
|
||||||
|
assert "Before" in result
|
||||||
|
assert "After" in result
|
||||||
|
|
||||||
|
def test_strips_multiple_blocks(self) -> None:
|
||||||
|
content = "# Title\n```python\ncode1\n```\nText\n```yaml\ncode2\n```\nEnd"
|
||||||
|
result = strip_code_blocks(content)
|
||||||
|
assert "code1" not in result
|
||||||
|
assert "code2" not in result
|
||||||
|
assert "Text" in result
|
||||||
|
assert "End" in result
|
||||||
|
|
||||||
|
def test_no_code_blocks(self) -> None:
|
||||||
|
content = "# Title\n\nSome text."
|
||||||
|
result = strip_code_blocks(content)
|
||||||
|
assert result == content
|
||||||
|
|
||||||
|
def test_preserves_line_numbers(self) -> None:
|
||||||
|
content = "Line1\n```\nLine3\n```\nLine5"
|
||||||
|
result = strip_code_blocks(content)
|
||||||
|
lines = result.splitlines()
|
||||||
|
assert len(lines) == 5
|
||||||
|
assert lines[0] == "Line1"
|
||||||
|
assert lines[4] == "Line5"
|
||||||
|
|
||||||
|
|
||||||
|
class TestExtractLinks:
|
||||||
|
def test_extracts_internal_links(self, tmp_path: Path) -> None:
|
||||||
|
f = tmp_path / "test.md"
|
||||||
|
f.write_text("[link](other.md)\n[external](https://example.com)\n[anchor](#section)\n")
|
||||||
|
links = extract_links(f)
|
||||||
|
# Should return internal + anchor links (not http or mailto)
|
||||||
|
assert len(links) == 2
|
||||||
|
assert links[0][2] == "other.md"
|
||||||
|
assert links[1][2] == "#section"
|
||||||
|
|
||||||
|
def test_extracts_links_with_anchors(self, tmp_path: Path) -> None:
|
||||||
|
f = tmp_path / "test.md"
|
||||||
|
f.write_text("[link](other.md#section)\n")
|
||||||
|
links = extract_links(f)
|
||||||
|
assert len(links) == 1
|
||||||
|
assert links[0][2] == "other.md#section"
|
||||||
|
|
||||||
|
def test_skips_mailto(self, tmp_path: Path) -> None:
|
||||||
|
f = tmp_path / "test.md"
|
||||||
|
f.write_text("[email](mailto:test@example.com)\n")
|
||||||
|
links = extract_links(f)
|
||||||
|
assert links == []
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckRequiredFiles:
|
||||||
|
def test_all_present(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("# README")
|
||||||
|
(tmp_path / "AGENTS.md").write_text("# AGENTS")
|
||||||
|
(tmp_path / "CHANGELOG.md").write_text("# CHANGELOG")
|
||||||
|
issues = check_required_files(tmp_path)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_missing_files(self, tmp_path: Path) -> None:
|
||||||
|
issues = check_required_files(tmp_path)
|
||||||
|
assert len(issues) == 3
|
||||||
|
assert any("README.md" in i for i in issues)
|
||||||
|
assert any("AGENTS.md" in i for i in issues)
|
||||||
|
assert any("CHANGELOG.md" in i for i in issues)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckDocsStructure:
|
||||||
|
def test_all_present(self, tmp_path: Path) -> None:
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "index.md").write_text("# Home")
|
||||||
|
(docs / "mapping.json").write_text(json.dumps({"index.md": "Home"}))
|
||||||
|
issues = check_docs_structure(tmp_path, docs)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_missing_docs_dir(self, tmp_path: Path) -> None:
|
||||||
|
issues = check_docs_structure(tmp_path, tmp_path / "docs")
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "Docs directory not found" in issues[0]
|
||||||
|
|
||||||
|
def test_missing_index(self, tmp_path: Path) -> None:
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
issues = check_docs_structure(tmp_path, docs)
|
||||||
|
assert any("index.md" in i for i in issues)
|
||||||
|
|
||||||
|
def test_invalid_mapping_json(self, tmp_path: Path) -> None:
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "index.md").write_text("# Home")
|
||||||
|
(docs / "mapping.json").write_text("{invalid json")
|
||||||
|
issues = check_docs_structure(tmp_path, docs)
|
||||||
|
assert any("invalid JSON" in i for i in issues)
|
||||||
|
|
||||||
|
def test_empty_mapping(self, tmp_path: Path) -> None:
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "index.md").write_text("# Home")
|
||||||
|
(docs / "mapping.json").write_text("{}")
|
||||||
|
issues = check_docs_structure(tmp_path, docs)
|
||||||
|
assert any("empty" in i for i in issues)
|
||||||
|
|
||||||
|
def test_mapping_not_object(self, tmp_path: Path) -> None:
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "index.md").write_text("# Home")
|
||||||
|
(docs / "mapping.json").write_text("[]")
|
||||||
|
issues = check_docs_structure(tmp_path, docs)
|
||||||
|
assert any("JSON object" in i for i in issues)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckInternalLinks:
|
||||||
|
def test_valid_links(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("[link](docs/guide.md)\n")
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "guide.md").write_text("# Guide\n")
|
||||||
|
issues = check_internal_links(tmp_path, docs)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_broken_file_link(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("[link](nonexistent.md)\n")
|
||||||
|
issues = check_internal_links(tmp_path, tmp_path / "docs")
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "file not found" in issues[0]
|
||||||
|
|
||||||
|
def test_broken_anchor(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("[link](#missing-section)\n")
|
||||||
|
issues = check_internal_links(tmp_path, tmp_path / "docs")
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "broken anchor" in issues[0]
|
||||||
|
|
||||||
|
def test_broken_anchor_in_target(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("[link](guide.md#missing)\n")
|
||||||
|
(tmp_path / "guide.md").write_text("# Guide\n")
|
||||||
|
issues = check_internal_links(tmp_path, tmp_path / "docs")
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "broken anchor" in issues[0]
|
||||||
|
|
||||||
|
def test_valid_anchor_in_target(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("[link](guide.md#section)\n")
|
||||||
|
(tmp_path / "guide.md").write_text("# Section\n")
|
||||||
|
issues = check_internal_links(tmp_path, tmp_path / "docs")
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_wiki_page_link_skipped(self, tmp_path: Path) -> None:
|
||||||
|
"""Links matching wiki page names in mapping.json should be skipped."""
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "index.md").write_text("[Architecture](Architecture)\n")
|
||||||
|
(docs / "mapping.json").write_text(json.dumps({"index.md": "Home", "tech/architecture.md": "Architecture"}))
|
||||||
|
issues = check_internal_links(tmp_path, docs)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_non_wiki_page_no_extension_skipped(self, tmp_path: Path) -> None:
|
||||||
|
"""Links without file extension and no slash should be skipped (can't verify)."""
|
||||||
|
(tmp_path / "README.md").write_text("[SomePage](SomePage)\n")
|
||||||
|
issues = check_internal_links(tmp_path, tmp_path / "docs")
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_broken_anchor_in_target_with_content(self, tmp_path: Path) -> None:
|
||||||
|
"""Broken anchor in an existing target file should be flagged."""
|
||||||
|
(tmp_path / "README.md").write_text("[link](guide.md#missing)\n")
|
||||||
|
(tmp_path / "guide.md").write_text("# Real Title\n\nSome content here.\n")
|
||||||
|
issues = check_internal_links(tmp_path, tmp_path / "docs")
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "broken anchor" in issues[0]
|
||||||
|
|
||||||
|
def test_valid_anchor_in_target_with_content(self, tmp_path: Path) -> None:
|
||||||
|
"""Valid anchor in an existing target file should pass."""
|
||||||
|
(tmp_path / "README.md").write_text("[link](guide.md#real-title)\n")
|
||||||
|
(tmp_path / "guide.md").write_text("# Real Title\n\nSome content.\n")
|
||||||
|
issues = check_internal_links(tmp_path, tmp_path / "docs")
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_invalid_mapping_json_ignored(self, tmp_path: Path) -> None:
|
||||||
|
"""Invalid mapping.json should not crash link checking."""
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "index.md").write_text("[link](guide.md)\n")
|
||||||
|
(docs / "guide.md").write_text("# Guide\n")
|
||||||
|
(docs / "mapping.json").write_text("{invalid json")
|
||||||
|
issues = check_internal_links(tmp_path, docs)
|
||||||
|
# Should still work — just without wiki page mappings
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckHeadingHierarchy:
|
||||||
|
def test_valid_hierarchy(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("# Title\n## Section\n### Sub\n")
|
||||||
|
issues = check_heading_hierarchy(tmp_path)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_skipped_level(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("# Title\n### Sub\n")
|
||||||
|
issues = check_heading_hierarchy(tmp_path)
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "hierarchy skip" in issues[0]
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckTodoFixme:
|
||||||
|
def test_no_todo(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("Just some text.\n")
|
||||||
|
issues = check_todo_fixme(tmp_path)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_found_todo(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("TODO: fix this later\n")
|
||||||
|
issues = check_todo_fixme(tmp_path)
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "TODO" in issues[0]
|
||||||
|
|
||||||
|
def test_found_fixme(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("FIXME: broken code\n")
|
||||||
|
issues = check_todo_fixme(tmp_path)
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "FIXME" in issues[0]
|
||||||
|
|
||||||
|
def test_ignores_todo_in_rules(self, tmp_path: Path) -> None:
|
||||||
|
"""References to 'TODO' in rules docs should not be flagged."""
|
||||||
|
(tmp_path / "README.md").write_text("Best practices (no `print()`, no `TODO`/`FIXME`)\n")
|
||||||
|
issues = check_todo_fixme(tmp_path)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_ignores_todo_without_colon(self, tmp_path: Path) -> None:
|
||||||
|
"""'TODO' without a colon should not be flagged."""
|
||||||
|
(tmp_path / "README.md").write_text("The TODO list is empty\n")
|
||||||
|
issues = check_todo_fixme(tmp_path)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckTrailingWhitespace:
|
||||||
|
def test_no_trailing(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("No trailing whitespace here\n")
|
||||||
|
issues = check_trailing_whitespace(tmp_path)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_trailing_spaces(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("Trailing spaces \n")
|
||||||
|
issues = check_trailing_whitespace(tmp_path)
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "trailing whitespace" in issues[0]
|
||||||
|
|
||||||
|
def test_trailing_tabs(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("Trailing tabs\t\n")
|
||||||
|
issues = check_trailing_whitespace(tmp_path)
|
||||||
|
assert len(issues) == 1
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckStaleDocs:
|
||||||
|
def test_fresh_doc(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("Fresh content\n")
|
||||||
|
issues = check_stale_docs(tmp_path)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_stale_doc(self, tmp_path: Path) -> None:
|
||||||
|
f = tmp_path / "README.md"
|
||||||
|
f.write_text("Old content\n")
|
||||||
|
# Set mtime to 200 days ago
|
||||||
|
old_time = (datetime.now() - timedelta(days=200)).timestamp()
|
||||||
|
import os
|
||||||
|
|
||||||
|
os.utime(f, (old_time, old_time))
|
||||||
|
issues = check_stale_docs(tmp_path)
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "stale" in issues[0]
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckDuplicateHeadings:
|
||||||
|
def test_no_duplicates(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("# Title\n## Section\n")
|
||||||
|
issues = check_duplicate_headings(tmp_path)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
def test_duplicates(self, tmp_path: Path) -> None:
|
||||||
|
(tmp_path / "README.md").write_text("# Title\n# Title\n")
|
||||||
|
issues = check_duplicate_headings(tmp_path)
|
||||||
|
assert len(issues) == 1
|
||||||
|
assert "duplicate heading" in issues[0]
|
||||||
|
|
||||||
|
def test_changelog_excluded(self, tmp_path: Path) -> None:
|
||||||
|
"""CHANGELOG.md should be excluded from duplicate heading checks."""
|
||||||
|
(tmp_path / "CHANGELOG.md").write_text("# Features\n# Features\n# Features\n")
|
||||||
|
issues = check_duplicate_headings(tmp_path)
|
||||||
|
assert issues == []
|
||||||
|
|
||||||
|
|
||||||
|
class TestMain:
|
||||||
|
def test_passes_clean_repo(self, tmp_path: Path) -> None:
|
||||||
|
"""A clean repo with all files should pass."""
|
||||||
|
(tmp_path / "README.md").write_text("# Title\n\nContent here.\n")
|
||||||
|
(tmp_path / "AGENTS.md").write_text("# AGENTS\n\nContent here.\n")
|
||||||
|
(tmp_path / "CHANGELOG.md").write_text("# Changelog\n\nContent here.\n")
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "index.md").write_text("# Home\n")
|
||||||
|
(docs / "mapping.json").write_text(json.dumps({"index.md": "Home"}))
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--root", str(tmp_path)])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "PASS" in result.output
|
||||||
|
|
||||||
|
def test_fails_on_missing_files(self, tmp_path: Path) -> None:
|
||||||
|
"""Missing required files should fail."""
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--root", str(tmp_path)])
|
||||||
|
assert result.exit_code == 1
|
||||||
|
assert "FAIL" in result.output
|
||||||
|
|
||||||
|
def test_fix_trailing_whitespace(self, tmp_path: Path) -> None:
|
||||||
|
"""--fix should auto-fix trailing whitespace."""
|
||||||
|
(tmp_path / "README.md").write_text("# Title\n\nContent here. \n")
|
||||||
|
(tmp_path / "AGENTS.md").write_text("# AGENTS\n\nContent here.\n")
|
||||||
|
(tmp_path / "CHANGELOG.md").write_text("# Changelog\n\nContent here.\n")
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "index.md").write_text("# Home\n")
|
||||||
|
(docs / "mapping.json").write_text(json.dumps({"index.md": "Home"}))
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--root", str(tmp_path), "--fix"])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
# Verify whitespace was fixed
|
||||||
|
content = (tmp_path / "README.md").read_text()
|
||||||
|
assert "Content here. \n" not in content
|
||||||
|
assert "Content here.\n" in content
|
||||||
|
|
||||||
|
def test_no_check_links(self, tmp_path: Path) -> None:
|
||||||
|
"""--no-check-links should skip link checking."""
|
||||||
|
(tmp_path / "README.md").write_text("# Title\n[broken](nonexistent.md)\n")
|
||||||
|
(tmp_path / "AGENTS.md").write_text("# AGENTS\n")
|
||||||
|
(tmp_path / "CHANGELOG.md").write_text("# Changelog\n")
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "index.md").write_text("# Home\n")
|
||||||
|
(docs / "mapping.json").write_text(json.dumps({"index.md": "Home"}))
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--root", str(tmp_path), "--no-check-links"])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
|
||||||
|
def test_stale_docs_warning(self, tmp_path: Path) -> None:
|
||||||
|
"""--check-stale should warn but not fail."""
|
||||||
|
(tmp_path / "README.md").write_text("# Title\n")
|
||||||
|
(tmp_path / "AGENTS.md").write_text("# AGENTS\n")
|
||||||
|
(tmp_path / "CHANGELOG.md").write_text("# Changelog\n")
|
||||||
|
docs = tmp_path / "docs"
|
||||||
|
docs.mkdir()
|
||||||
|
(docs / "index.md").write_text("# Home\n")
|
||||||
|
(docs / "mapping.json").write_text(json.dumps({"index.md": "Home"}))
|
||||||
|
# Make README stale
|
||||||
|
import os
|
||||||
|
|
||||||
|
f = tmp_path / "README.md"
|
||||||
|
old_time = (datetime.now() - timedelta(days=200)).timestamp()
|
||||||
|
os.utime(f, (old_time, old_time))
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(main, ["--root", str(tmp_path), "--check-stale"])
|
||||||
|
# Stale docs are warnings, not errors
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert "stale" in result.output
|
||||||
@@ -220,7 +220,7 @@ class TestCli:
|
|||||||
os.environ,
|
os.environ,
|
||||||
{
|
{
|
||||||
"GITEA_URL": "https://gitea.example",
|
"GITEA_URL": "https://gitea.example",
|
||||||
"REPO_TOKEN": "token",
|
"CI_GITEA_TOKEN": "token",
|
||||||
"RUN_ID": "123",
|
"RUN_ID": "123",
|
||||||
"JOB_NAME": "molecule-tests",
|
"JOB_NAME": "molecule-tests",
|
||||||
"MATRIX_INDEX": "0",
|
"MATRIX_INDEX": "0",
|
||||||
@@ -288,7 +288,7 @@ class TestCli:
|
|||||||
os.environ,
|
os.environ,
|
||||||
{
|
{
|
||||||
"GITEA_URL": "https://gitea.example",
|
"GITEA_URL": "https://gitea.example",
|
||||||
"REPO_TOKEN": "token",
|
"CI_GITEA_TOKEN": "token",
|
||||||
"RUN_ID": "123",
|
"RUN_ID": "123",
|
||||||
"JOB_NAME": "molecule-tests",
|
"JOB_NAME": "molecule-tests",
|
||||||
"MATRIX_INDEX": "0",
|
"MATRIX_INDEX": "0",
|
||||||
@@ -325,7 +325,7 @@ class TestCli:
|
|||||||
os.environ,
|
os.environ,
|
||||||
{
|
{
|
||||||
"GITEA_URL": "https://gitea.example",
|
"GITEA_URL": "https://gitea.example",
|
||||||
"REPO_TOKEN": "token",
|
"CI_GITEA_TOKEN": "token",
|
||||||
"RUN_ID": "123",
|
"RUN_ID": "123",
|
||||||
"JOB_NAME": "molecule-tests",
|
"JOB_NAME": "molecule-tests",
|
||||||
"MATRIX_INDEX": "0",
|
"MATRIX_INDEX": "0",
|
||||||
@@ -371,7 +371,7 @@ class TestCli:
|
|||||||
os.environ,
|
os.environ,
|
||||||
{
|
{
|
||||||
"GITEA_URL": "https://gitea.example",
|
"GITEA_URL": "https://gitea.example",
|
||||||
"REPO_TOKEN": "token",
|
"CI_GITEA_TOKEN": "token",
|
||||||
"RUN_ID": "123",
|
"RUN_ID": "123",
|
||||||
"JOB_NAME": "molecule-tests",
|
"JOB_NAME": "molecule-tests",
|
||||||
"MATRIX_INDEX": "0",
|
"MATRIX_INDEX": "0",
|
||||||
@@ -418,7 +418,7 @@ class TestCli:
|
|||||||
os.environ,
|
os.environ,
|
||||||
{
|
{
|
||||||
"GITEA_URL": "https://gitea.example",
|
"GITEA_URL": "https://gitea.example",
|
||||||
"REPO_TOKEN": "token",
|
"CI_GITEA_TOKEN": "token",
|
||||||
"RUN_ID": "123",
|
"RUN_ID": "123",
|
||||||
"JOB_NAME": "molecule-tests",
|
"JOB_NAME": "molecule-tests",
|
||||||
"MATRIX_INDEX": "0",
|
"MATRIX_INDEX": "0",
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ from devx.gitea_cli import TeaCLIError, configure_tea_login
|
|||||||
|
|
||||||
|
|
||||||
class TestNotifyFailure:
|
class TestNotifyFailure:
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.ci.notify_failure.TeaCLI")
|
@patch("devx.ci.notify_failure.TeaCLI")
|
||||||
def test_creates_issue_with_tea(self, mock_tea_cls: MagicMock) -> None:
|
def test_creates_issue_with_tea(self, mock_tea_cls: MagicMock) -> None:
|
||||||
mock_tea = MagicMock()
|
mock_tea = MagicMock()
|
||||||
@@ -36,7 +36,7 @@ class TestNotifyFailure:
|
|||||||
mock_tea.create_issue.assert_called_once()
|
mock_tea.create_issue.assert_called_once()
|
||||||
mock_tea.add_label.assert_called_once_with("owner/repo", 42, ["bug"])
|
mock_tea.add_label.assert_called_once_with("owner/repo", 42, ["bug"])
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.ci.notify_failure.TeaCLI")
|
@patch("devx.ci.notify_failure.TeaCLI")
|
||||||
def test_tea_creates_issue_without_bug_label(self, mock_tea_cls: MagicMock) -> None:
|
def test_tea_creates_issue_without_bug_label(self, mock_tea_cls: MagicMock) -> None:
|
||||||
mock_tea = MagicMock()
|
mock_tea = MagicMock()
|
||||||
@@ -53,7 +53,7 @@ class TestNotifyFailure:
|
|||||||
assert "issue #43" in result.output
|
assert "issue #43" in result.output
|
||||||
mock_tea.add_label.assert_not_called()
|
mock_tea.add_label.assert_not_called()
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.ci.notify_failure.TeaCLI")
|
@patch("devx.ci.notify_failure.TeaCLI")
|
||||||
def test_tea_error_raises(self, mock_tea_cls: MagicMock) -> None:
|
def test_tea_error_raises(self, mock_tea_cls: MagicMock) -> None:
|
||||||
"""When tea fails, the workflow fails — no fallback."""
|
"""When tea fails, the workflow fails — no fallback."""
|
||||||
@@ -70,7 +70,7 @@ class TestNotifyFailure:
|
|||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "tea" in result.output.lower()
|
assert "tea" in result.output.lower()
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.ci.notify_failure.TeaCLI")
|
@patch("devx.ci.notify_failure.TeaCLI")
|
||||||
def test_tea_list_labels_error_continues_without_labels(self, mock_tea_cls: MagicMock) -> None:
|
def test_tea_list_labels_error_continues_without_labels(self, mock_tea_cls: MagicMock) -> None:
|
||||||
"""If listing labels fails via tea, issue is still created without labels."""
|
"""If listing labels fails via tea, issue is still created without labels."""
|
||||||
@@ -87,7 +87,7 @@ class TestNotifyFailure:
|
|||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "issue #50" in result.output
|
assert "issue #50" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.ci.notify_failure.TeaCLI")
|
@patch("devx.ci.notify_failure.TeaCLI")
|
||||||
def test_tea_add_label_error_is_ignored(self, mock_tea_cls: MagicMock) -> None:
|
def test_tea_add_label_error_is_ignored(self, mock_tea_cls: MagicMock) -> None:
|
||||||
"""If adding label fails via tea, issue is still reported as created."""
|
"""If adding label fails via tea, issue is still reported as created."""
|
||||||
@@ -105,7 +105,7 @@ class TestNotifyFailure:
|
|||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "issue #51" in result.output
|
assert "issue #51" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": ""}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": ""}, clear=True)
|
||||||
def test_missing_token_exits(self) -> None:
|
def test_missing_token_exits(self) -> None:
|
||||||
runner = CliRunner()
|
runner = CliRunner()
|
||||||
result = runner.invoke(
|
result = runner.invoke(
|
||||||
@@ -113,9 +113,9 @@ class TestNotifyFailure:
|
|||||||
["--repo", "owner/repo", "--run-id", "1", "--workflow", "release", "--commit", "abc"],
|
["--repo", "owner/repo", "--run-id", "1", "--workflow", "release", "--commit", "abc"],
|
||||||
)
|
)
|
||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "REPO_TOKEN" in result.output
|
assert "CI_GITEA_TOKEN" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.gitea_cli.shutil.which", return_value=None)
|
@patch("devx.gitea_cli.shutil.which", return_value=None)
|
||||||
@patch("devx.ci.notify_failure.TeaCLI")
|
@patch("devx.ci.notify_failure.TeaCLI")
|
||||||
def test_auto_login_no_tea_skips(self, mock_tea_cls: MagicMock, mock_which: MagicMock) -> None:
|
def test_auto_login_no_tea_skips(self, mock_tea_cls: MagicMock, mock_which: MagicMock) -> None:
|
||||||
@@ -133,11 +133,11 @@ class TestNotifyFailure:
|
|||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "issue #60" in result.output
|
assert "issue #60" in result.output
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": ""}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": ""}, clear=True)
|
||||||
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
||||||
@patch("devx.ci.notify_failure.TeaCLI")
|
@patch("devx.ci.notify_failure.TeaCLI")
|
||||||
def test_auto_login_no_token_skips_login(self, mock_tea_cls: MagicMock, mock_which: MagicMock) -> None:
|
def test_auto_login_no_token_skips_login(self, mock_tea_cls: MagicMock, mock_which: MagicMock) -> None:
|
||||||
"""--auto-login with no REPO_TOKEN skips login but raises before creating issue."""
|
"""--auto-login with no CI_GITEA_TOKEN skips login but raises before creating issue."""
|
||||||
mock_tea = MagicMock()
|
mock_tea = MagicMock()
|
||||||
mock_tea_cls.return_value = mock_tea
|
mock_tea_cls.return_value = mock_tea
|
||||||
|
|
||||||
@@ -147,23 +147,23 @@ class TestNotifyFailure:
|
|||||||
["--repo", "owner/repo", "--run-id", "1", "--workflow", "release", "--commit", "abc", "--auto-login"],
|
["--repo", "owner/repo", "--run-id", "1", "--workflow", "release", "--commit", "abc", "--auto-login"],
|
||||||
)
|
)
|
||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "REPO_TOKEN" in result.output
|
assert "CI_GITEA_TOKEN" in result.output
|
||||||
|
|
||||||
|
|
||||||
class TestConfigureTeaLogin:
|
class TestConfigureTeaLogin:
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": ""}, clear=True)
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": ""}, clear=True)
|
||||||
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
||||||
def test_no_token_skips(self, mock_which: MagicMock) -> None:
|
def test_no_token_skips(self, mock_which: MagicMock) -> None:
|
||||||
"""configure_tea_login with no token prints skip message and returns."""
|
"""configure_tea_login with no token prints skip message and returns."""
|
||||||
configure_tea_login()
|
configure_tea_login()
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.gitea_cli.shutil.which", return_value=None)
|
@patch("devx.gitea_cli.shutil.which", return_value=None)
|
||||||
def test_no_tea_skips(self, mock_which: MagicMock) -> None:
|
def test_no_tea_skips(self, mock_which: MagicMock) -> None:
|
||||||
"""configure_tea_login with no tea binary prints skip message and returns."""
|
"""configure_tea_login with no tea binary prints skip message and returns."""
|
||||||
configure_tea_login()
|
configure_tea_login()
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
||||||
@patch("devx.gitea_cli.subprocess.run")
|
@patch("devx.gitea_cli.subprocess.run")
|
||||||
@patch("devx.ci.notify_failure.TeaCLI")
|
@patch("devx.ci.notify_failure.TeaCLI")
|
||||||
@@ -191,7 +191,7 @@ class TestConfigureTeaLogin:
|
|||||||
# tea login add was called
|
# tea login add was called
|
||||||
assert mock_subprocess.call_count >= 2
|
assert mock_subprocess.call_count >= 2
|
||||||
|
|
||||||
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
|
@patch.dict("os.environ", {"CI_GITEA_TOKEN": "tok"})
|
||||||
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
@patch("devx.gitea_cli.shutil.which", return_value="/usr/bin/tea")
|
||||||
@patch("devx.gitea_cli.subprocess.run")
|
@patch("devx.gitea_cli.subprocess.run")
|
||||||
@patch("devx.ci.notify_failure.TeaCLI")
|
@patch("devx.ci.notify_failure.TeaCLI")
|
||||||
|
|||||||
@@ -0,0 +1,84 @@
|
|||||||
|
"""Unit tests for devx.tools.pr_label."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from click.testing import CliRunner
|
||||||
|
|
||||||
|
from devx.tools.pr_label import cli
|
||||||
|
|
||||||
|
|
||||||
|
class TestCli:
|
||||||
|
def test_no_token_raises(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.delenv("CI_GITEA_TOKEN", raising=False)
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["--pr", "42", "--label", "ready-to-merge"])
|
||||||
|
assert result.exit_code != 0
|
||||||
|
assert "CI_GITEA_TOKEN" in result.output
|
||||||
|
|
||||||
|
@patch("devx.tools.pr_label.REPO_OWNER", "")
|
||||||
|
def test_no_owner_raises(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.setenv("CI_GITEA_TOKEN", "tok")
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["--pr", "42", "--label", "ready-to-merge"])
|
||||||
|
assert result.exit_code != 0
|
||||||
|
assert "owner" in result.output.lower()
|
||||||
|
|
||||||
|
@patch("devx.tools.pr_label.GiteaClient")
|
||||||
|
def test_adds_new_label(self, mock_client_cls: MagicMock, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.setenv("CI_GITEA_TOKEN", "tok")
|
||||||
|
monkeypatch.setenv("DEVX_REPO_OWNER", "owner")
|
||||||
|
monkeypatch.setenv("DEVX_REPO_NAME", "repo")
|
||||||
|
client = mock_client_cls.return_value
|
||||||
|
client.get_pr_label_names.return_value = []
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["--pr", "42", "--label", "ready-to-merge"])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
client.add_pr_label.assert_called_once_with(42, ["ready-to-merge"])
|
||||||
|
assert "Added label" in result.output
|
||||||
|
|
||||||
|
@patch("devx.tools.pr_label.GiteaClient")
|
||||||
|
def test_skips_existing_label(self, mock_client_cls: MagicMock, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.setenv("CI_GITEA_TOKEN", "tok")
|
||||||
|
monkeypatch.setenv("DEVX_REPO_OWNER", "owner")
|
||||||
|
monkeypatch.setenv("DEVX_REPO_NAME", "repo")
|
||||||
|
client = mock_client_cls.return_value
|
||||||
|
client.get_pr_label_names.return_value = ["ready-to-merge"]
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["--pr", "42", "--label", "ready-to-merge"])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
client.add_pr_label.assert_not_called()
|
||||||
|
assert "already" in result.output
|
||||||
|
|
||||||
|
@patch("devx.tools.pr_label.GiteaClient")
|
||||||
|
def test_mixed_new_and_existing(self, mock_client_cls: MagicMock, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.setenv("CI_GITEA_TOKEN", "tok")
|
||||||
|
monkeypatch.setenv("DEVX_REPO_OWNER", "owner")
|
||||||
|
monkeypatch.setenv("DEVX_REPO_NAME", "repo")
|
||||||
|
client = mock_client_cls.return_value
|
||||||
|
client.get_pr_label_names.return_value = ["reviewed"]
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["--pr", "42", "--label", "ready-to-merge", "--label", "reviewed"])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
client.add_pr_label.assert_called_once_with(42, ["ready-to-merge"])
|
||||||
|
assert "Added label" in result.output
|
||||||
|
assert "already" in result.output
|
||||||
|
|
||||||
|
@patch("devx.tools.pr_label.GiteaClient")
|
||||||
|
@patch("devx.tools.pr_status.subprocess.run")
|
||||||
|
def test_auto_detect_pr(
|
||||||
|
self, mock_subprocess: MagicMock, mock_client_cls: MagicMock, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
monkeypatch.setenv("CI_GITEA_TOKEN", "tok")
|
||||||
|
monkeypatch.setenv("DEVX_REPO_OWNER", "owner")
|
||||||
|
monkeypatch.setenv("DEVX_REPO_NAME", "repo")
|
||||||
|
mock_subprocess.return_value = MagicMock(returncode=0, stdout="feature-branch\n")
|
||||||
|
client = mock_client_cls.return_value
|
||||||
|
client.list_prs.return_value = [{"number": 42, "head": {"ref": "feature-branch"}}]
|
||||||
|
client.get_pr_label_names.return_value = []
|
||||||
|
runner = CliRunner()
|
||||||
|
result = runner.invoke(cli, ["--label", "ready-to-merge"])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
client.add_pr_label.assert_called_once_with(42, ["ready-to-merge"])
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user