Compare commits

...
36 Commits
Author SHA1 Message Date
devx-ci-bot 888cc4e3b2 release: v0.43.0 [skip ci] 2026-07-13 05:02:47 +00:00
emil f08ff0e7a3 DEVX-135: feat: add get_customer_vm_ip and get_observability_vm_ip to I/O check
Post-merge / detect-and-configure (push) Successful in 13s
Post-merge / release-and-maintain (push) Successful in 1m1s
2026-07-13 05:02:03 +00:00
gitea-actions-bot 772e1b1c6d chore: update badge URLs to commit 29e3ef9c [skip ci] 2026-07-13 02:59:23 +00:00
devx-ci-bot bdfe2c561b release: v0.42.0 [skip ci] 2026-07-13 02:58:46 +00:00
emil 02b27dd343 DEVX-134: feat: add I/O function isolation check and skip integration tests
Post-merge / detect-and-configure (push) Successful in 16s
Post-merge / release-and-maintain (push) Successful in 1m7s
2026-07-13 02:57:54 +00:00
gitea-actions-bot e5488fcfbd chore: update badge URLs to commit ae591a0c [skip ci] 2026-07-13 02:27:15 +00:00
devx-ci-bot 1a60739b5a release: v0.41.2 [skip ci] 2026-07-13 02:26:42 +00:00
emil 50dcb67083 DEVX-133: fix: auto-discover molecule root instead of hardcoding gitea-runner
Post-merge / detect-and-configure (push) Successful in 13s
Post-merge / release-and-maintain (push) Successful in 59s
2026-07-13 02:25:59 +00:00
gitea-actions-bot 7b624b0525 chore: update badge URLs to commit 9175bdc9 [skip ci] 2026-07-13 01:39:18 +00:00
devx-ci-bot 570de94575 release: v0.41.1 [skip ci] 2026-07-13 01:38:46 +00:00
emil 55583fe399 DEVX-132: fix: check_test_isolation accepts multiple --test-path values
Post-merge / detect-and-configure (push) Successful in 13s
Post-merge / release-and-maintain (push) Successful in 1m0s
2026-07-13 01:38:04 +00:00
gitea-actions-bot 35f4fb7172 chore: update badge URLs to commit 691cdd2c [skip ci] 2026-07-13 01:20:22 +00:00
emil b3d47753a8 DEVX-131: ci: fix build-images skipping on release commits via workflow_dispatch
Post-merge / detect-and-configure (push) Successful in 12s
Post-merge / release-and-maintain (push) Successful in 42s
2026-07-13 01:19:24 +00:00
emil 945b45b641 release: v0.41.0 [skip ci] 2026-07-13 03:10:59 +02:00
gitea-actions-bot 9e59acd485 chore: update badge URLs to commit 6b281bd3 [skip ci] 2026-07-13 01:06:16 +00:00
emil f44b321f37 DEVX-129: test: cover crypto.py line 37 (retry on leading dash)
Post-merge / detect-and-configure (push) Successful in 13s
Post-merge / release-and-maintain (push) Successful in 39s
2026-07-13 01:05:20 +00:00
emil 77c2f7e043 DEVX-129: feat: test isolation pytest plugin, shift-left quality gates, dep upgrades
Post-merge / detect-and-configure (push) Successful in 11s
Post-merge / release-and-maintain (push) Failing after 27s
2026-07-13 00:57:28 +00:00
gitea-actions-bot b923e47d81 chore: update badge URLs to commit f13acf06 [skip ci] 2026-07-12 20:02:08 +00:00
emil 63204c7cb0 DEVX-128: docs: add retrospective for self-approval fallback and CI consolidation
Post-merge / detect-and-configure (push) Successful in 29s
Post-merge / release-and-maintain (push) Successful in 1m10s
2026-07-12 20:00:30 +00:00
gitea-actions-bot 0c7837fb0e chore: update badge URLs to commit 51c7146d [skip ci] 2026-07-12 16:35:39 +00:00
devx-ci-bot 59d6fa1833 release: v0.40.1 [skip ci] 2026-07-12 16:34:45 +00:00
emil d035b620e0 DEVX-127: fix: fall back to CI token when reviewer self-approval is rejected
Post-merge / detect-and-configure (push) Successful in 17s
Post-merge / release-and-maintain (push) Successful in 1m25s
2026-07-12 16:33:53 +00:00
gitea-actions-bot 5987adee64 chore: update badge URLs to commit a22225af [skip ci] 2026-07-12 01:53:50 +00:00
emil cb84dae050 DEVX-126: ci: consolidate CI and post-merge workflows
Post-merge / detect-and-configure (push) Successful in 20s
Post-merge / release-and-maintain (push) Successful in 46s
2026-07-12 01:52:40 +00:00
gitea-actions-bot ed0dfce98b chore: update badge URLs to commit 2747061d [skip ci] 2026-07-11 23:09:11 +00:00
devx-ci-bot c244881f22 release: v0.40.0 [skip ci] 2026-07-11 23:08:23 +00:00
emil 4cde7de696 DEVX-125: feat: detect double-prefix in Vikunja task title during pre-merge validation
Post-merge / detect-type (push) Successful in 8s
Post-merge / validate-commit-msg (push) Successful in 8s
Post-merge / sync-wiki (push) Successful in 21s
Post-merge / release (push) Successful in 30s
Post-merge / vikunja (push) Successful in 13s
Post-merge / configure-repo (push) Successful in 10s
Post-merge / publish (push) Successful in 19s
Post-merge / badges (push) Successful in 41s
2026-07-11 23:07:45 +00:00
gitea-actions-bot d675889604 chore: update badge URLs to commit c9f25c13 [skip ci] 2026-07-09 11:54:42 +00:00
devx-ci-bot e23138e731 release: v0.39.0 [skip ci] 2026-07-09 11:53:12 +00:00
emil ef3b882e5b DEVX-124: feat: extract shared utilities from infra and grm into devx
Post-merge / detect-type (push) Successful in 13s
Post-merge / validate-commit-msg (push) Successful in 10s
Post-merge / configure-repo (push) Successful in 28s
Post-merge / vikunja (push) Successful in 44s
Post-merge / sync-wiki (push) Successful in 58s
Post-merge / release (push) Successful in 1m7s
Post-merge / publish (push) Successful in 44s
Post-merge / badges (push) Successful in 1m6s
2026-07-09 11:51:50 +00:00
gitea-actions-bot 8d9ee1ea26 chore: update badge URLs to commit 931a4a37 [skip ci] 2026-07-08 20:20:51 +00:00
emil 1497b29487 DEVX-123: ci: retrigger workflow after configuring secrets
Post-merge / detect-type (push) Successful in 9s
Post-merge / validate-commit-msg (push) Successful in 12s
Post-merge / release (push) Successful in 19s
Post-merge / configure-repo (push) Successful in 15s
Post-merge / vikunja (push) Successful in 17s
Post-merge / publish (push) Has been skipped
Post-merge / sync-wiki (push) Successful in 26s
Post-merge / badges (push) Successful in 31s
2026-07-08 20:19:44 +00:00
gitea-actions-bot cb126e83da chore: update badge URLs to commit 37543185 [skip ci] 2026-07-08 19:31:39 +00:00
devx-ci-bot 281193c741 release: v0.38.0 [skip ci] 2026-07-08 19:30:58 +00:00
emil 0228fce5b9 DEVX-123: feat: introduce role-based Gitea API token environment variables
Post-merge / detect-type (push) Successful in 10s
Post-merge / validate-commit-msg (push) Successful in 10s
Post-merge / configure-repo (push) Successful in 11s
Post-merge / sync-wiki (push) Successful in 17s
Post-merge / vikunja (push) Successful in 18s
Post-merge / release (push) Successful in 36s
Post-merge / publish (push) Successful in 20s
Post-merge / badges (push) Successful in 35s
2026-07-08 19:30:10 +00:00
gitea-actions-bot 981d3e41cc chore: update badge URLs to commit fe187115 [skip ci] 2026-07-07 22:02:05 +00:00
87 changed files with 4924 additions and 804 deletions
+15 -2
View File
@@ -1,6 +1,19 @@
# Gitea API token (required for CI scripts that interact with Gitea)
# Role-based Gitea API tokens.
# Each token serves a specific role. For small teams the developer and CI
# tokens may belong to the same user, but the reviewer token MUST belong to a
# different Gitea user than the PR author so Gitea accepts approval reviews.
# Create at: https://git.oblachno.oblachno.fyi/user/settings/applications
CI_GITEA_TOKEN=
# Developer token — used by local tooling: create-task, create-pr, setup, etc.
DEVELOPER_GITEA_API_TOKEN=
# CI token — used by CI workflows and scripts that do not post approvals.
# Legacy CI_GITEA_TOKEN is also accepted.
CI_GITEA_API_TOKEN=
# Reviewer token — used by the auto-merge workflow to post APPROVE reviews.
# This must be a different Gitea user from the developer/CI user.
REVIEWER_GITEA_API_TOKEN=
# Vikunja API token (required for post-merge task updates)
# Create at: https://work.oblachno.oblachno.fyi/settings/tokens
+25 -27
View File
@@ -10,9 +10,11 @@ name: Build Images
# to PyPI, so the image always has the latest released version.
# - Manually via workflow_dispatch
#
# Consolidated into 2 jobs (from 3):
# build-and-push (includes release-commit detection) ──→ cleanup
#
# The workflow builds 3 tier images in sequence:
# ci-base → ci-quality → ci-full
#
# Each tier builds FROM the previous one, so they must be built in order.
# After pushing, a cleanup job removes old versions (keeps last 2 + latest).
@@ -28,9 +30,9 @@ concurrency:
cancel-in-progress: false
jobs:
detect-type:
build-and-push:
runs-on: docker
timeout-minutes: 5
timeout-minutes: 30
outputs:
is-release: ${{ steps.check.outputs.is-release }}
steps:
@@ -38,7 +40,9 @@ jobs:
with:
fetch-depth: 1
- name: Set up environment
run: make setup-ci
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: make setup-release
- name: Check if this is a release commit
id: check
env:
@@ -46,34 +50,26 @@ jobs:
run: |
. .venv/bin/activate
python3 -m devx.ci.detect_release_commit
build-and-push:
needs: [detect-type]
if: >-
needs.detect-type.outputs.is-release == 'false' && (
github.event_name == 'workflow_dispatch' ||
(github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success')
)
runs-on: docker
timeout-minutes: 30
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up environment
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
run: make setup-release
- name: Docker registry login
if: >-
github.event_name == 'workflow_dispatch' ||
(github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success' && steps.check.outputs.is-release == 'false')
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
run: |
. .venv/bin/activate
echo "$CI_GITEA_TOKEN" | docker login git.oblachno.oblachno.fyi -u "$CI_GITEA_USERNAME" --password-stdin
_TOKEN="$CI_GITEA_API_TOKEN"
[ -z "$_TOKEN" ] && _TOKEN="$DEVELOPER_GITEA_API_TOKEN"
[ -z "$_TOKEN" ] && _TOKEN="$CI_GITEA_TOKEN"
if [ -z "$_TOKEN" ]; then echo "Gitea API token not set — skipping Docker login"; exit 1; fi
echo "$_TOKEN" | docker login git.oblachno.oblachno.fyi -u "$CI_GITEA_USERNAME" --password-stdin
- name: Build and push tier images
if: >-
github.event_name == 'workflow_dispatch' ||
(github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success' && steps.check.outputs.is-release == 'false')
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
PYTHONPATH: src
run: |
@@ -103,7 +99,7 @@ jobs:
- name: Notify on failure
if: failure()
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
PYTHONPATH: src
run: |
. .venv/bin/activate 2>/dev/null || true
@@ -125,10 +121,12 @@ jobs:
with:
fetch-depth: 1
- name: Set up environment
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: make setup-ci
- name: Clean up old image versions
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
PYTHONPATH: src
run: |
. .venv/bin/activate
+67 -77
View File
@@ -5,18 +5,35 @@ on:
types: [opened, synchronize]
workflow_dispatch:
env:
PIP_BREAK_SYSTEM_PACKAGES: "1"
PYTHONPATH: src
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
jobs:
quality:
# Single validation job that merges: quality, detect-changes,
# release-dry-run, pr-review, and pre-merge-check.
# Uses ci-full image (has git-cliff for release-dry-run).
# Saves ~4x checkout+setup overhead vs 5 separate jobs.
validate:
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-quality:latest
timeout-minutes: 10
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
timeout-minutes: 15
defaults:
run:
shell: bash
outputs:
user-facing-changed: ${{ steps.detect.outputs.user-facing-changed }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up environment
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: make setup-image
# --- quality steps ---
- name: Lint all
run: |
. .venv/bin/activate 2>/dev/null || true
@@ -27,14 +44,11 @@ jobs:
. .venv/bin/activate 2>/dev/null || true
make pytest-cov
- name: Check unit test speed
env:
PYTHONPATH: src
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.tools.check_test_speed --max-seconds 6 --max-single-seconds 0.5
- name: Documentation gate (coverage + stale refs + lint + version refs + prose)
env:
PYTHONPATH: src
DEVX_DOC_COVERAGE_STRICT: "1"
DEVX_VALE_LEVEL: warning
run: |
@@ -42,8 +56,6 @@ jobs:
export PATH="$HOME/.local/bin:$PATH"
make devx-docs-check
- name: Translation completeness check
env:
PYTHONPATH: src
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.ci.check_translations
@@ -64,92 +76,69 @@ jobs:
else
echo "act_runner not found — skipping workflow dry-run (static lint still passed)"
fi
detect-changes:
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
timeout-minutes: 10
defaults:
run:
shell: bash
outputs:
user-facing-changed: ${{ steps.detect.outputs.user-facing-changed }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up environment
run: make setup-image
# --- detect-changes step ---
- name: Detect changed paths
id: detect
env:
PYTHONPATH: src
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.ci.classify_changes \
--base "origin/master" \
--head "${{ github.event.pull_request.head.sha || github.sha }}" \
--github-output
release-dry-run:
needs: [quality, detect-changes]
if: needs.detect-changes.outputs.user-facing-changed == 'true'
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
timeout-minutes: 10
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up environment
# --- validate-pr + pr-review steps (PR only) ---
- name: Validate auto-merge preconditions
if: github.event_name == 'pull_request'
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
run: make setup-image
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
DEVX_VIKUNJA_PROJECT_ID: "8"
HEAD_REF: ${{ github.head_ref }}
PR_TITLE: ${{ github.event.pull_request.title }}
REPOSITORY: ${{ github.repository }}
PR_NUMBER: ${{ github.event.number }}
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.ci.check_auto_merge_ready \
--branch "$HEAD_REF" \
--pr-title "$PR_TITLE" \
--repo "$REPOSITORY" \
--pr-number "$PR_NUMBER"
- name: Run automated PR review
if: github.event_name == 'pull_request'
run: |
. .venv/bin/activate 2>/dev/null || true
set -euo pipefail
python3 -m devx.ci.pr_review \
"${{ github.event.number }}" \
"${{ github.repository }}"
# --- release-dry-run step (conditional) ---
- name: Release dry-run validation
env:
PYTHONPATH: src
if: steps.detect.outputs.user-facing-changed == 'true'
run: |
. .venv/bin/activate 2>/dev/null || true
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.release --dry-run
pr-review:
if: github.event_name == 'pull_request'
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
timeout-minutes: 10
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
- name: Set up environment
run: make setup-image
- name: Run automated PR review
- name: Notify on failure
if: failure()
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
PYTHONPATH: src
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: |
set -euo pipefail
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.ci.pr_review \
"${{ github.event.number }}" \
"${{ github.repository }}"
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.notify_failure \
--repo "${{ github.repository }}" \
--run-id "${{ github.run_id }}" \
--workflow "ci/validate" \
--commit "${{ github.sha }}" \
--auto-login
auto-merge:
# Auto-merge runs after all CI checks pass. It reads the task ID
# Auto-merge runs after validate passes. It reads the task ID
# from the branch name, validates the PR title, and squash-merges.
# Uses always() so it runs even when detect-changes skips (no user-facing changes).
needs: [quality, detect-changes, pr-review, release-dry-run]
needs: [validate]
if: >-
always() &&
github.event_name == 'pull_request' &&
needs.quality.result == 'success' &&
needs.pr-review.result == 'success' &&
(needs.release-dry-run.result == 'success' || needs.release-dry-run.result == 'skipped')
needs.validate.result == 'success'
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
timeout-minutes: 10
@@ -160,15 +149,17 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.CI_GITEA_TOKEN }}
token: ${{ secrets.CI_GITEA_API_TOKEN }}
- name: Set up environment
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: make setup-image
- name: Post approval review
env:
CI_GITEA_TOKEN: ${{ secrets.REVIEW_GITEA_TOKEN }}
REVIEWER_GITEA_API_TOKEN: ${{ secrets.REVIEWER_GITEA_API_TOKEN }}
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_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 \
@@ -177,13 +168,12 @@ jobs:
--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)."
--body "Auto-approved: all CI checks passed (validate job)."
- name: Squash merge with task ID
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
DEVX_VIKUNJA_PROJECT_ID: "8"
PYTHONPATH: src
HEAD_REF: ${{ github.head_ref }}
PR_TITLE: ${{ github.event.pull_request.title }}
REPOSITORY: ${{ github.repository }}
+115 -252
View File
@@ -1,39 +1,39 @@
name: Post-merge
# Runs on every push to master. A single workflow with conditional jobs
# for release, publish, wiki sync, badges, and Vikunja task updates.
# Runs on every push to master (after CI workflow merges a PR).
# Consolidated into 2 jobs (from 7) to reduce runner overhead:
# detect-and-configure ──→ release-and-maintain
#
# Job dependency graph:
# Job 1: detect release commit, validate commit msg, configure repo
# (branch protection, labels).
# Job 2: release + publish + sync-wiki + vikunja + badges.
# Individual steps are conditional on job 1 outputs.
#
# detect-type ──┬── validate-commit-msg (skip if release commit)
# ├── release (skip if release commit)
# │ └── publish (needs release — builds & publishes to PyPI)
# ├── badges (needs release — ALWAYS runs, waits for release
# │ so version badge picks up new __version__)
# ├── configure-repo (independent — skip if release commit)
# ├── sync-wiki (skip if release commit — runs for ALL merges)
# └── vikunja (skip if release commit — runs for ALL merges)
#
# sync-wiki and vikunja run for ALL non-release commits, not just when
# release succeeds. This ensures the wiki and task tracker are updated
# even for infrastructure-only changes (docs, CI config, etc.).
#
# The badges job uses `if: always()` and needs `release` so it waits for
# the release job to complete (whether it ran or was skipped). This ensures
# the version badge always reflects the latest __version__ on master.
# Badges run on every push to master, including release commits.
# The badges step always runs (even on release commits) so version
# badge picks up the new __version__. It runs last so it sees the
# new version if release created one.
#
# When release creates a "release: vX.Y.Z" commit and tag, the publish
# job (which depends on release) builds and publishes the package to the
# Gitea PyPI registry. The release commit's post-merge run still updates
# badges (version badge picks up the new version). Other jobs skip.
# step builds and publishes the package to the Gitea PyPI registry.
# The release commit's post-merge run still updates badges. Other
# steps (sync-wiki, vikunja) skip on release commits.
on:
push:
branches: [master]
concurrency:
group: post-merge-${{ github.ref }}
cancel-in-progress: true
env:
PIP_BREAK_SYSTEM_PACKAGES: "1"
PYTHONPATH: src
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
jobs:
detect-type:
detect-and-configure:
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
timeout-minutes: 10
@@ -42,175 +42,67 @@ jobs:
shell: bash
outputs:
is-release: ${{ steps.check.outputs.is-release }}
is-automated: ${{ steps.check.outputs.is-automated }}
user-facing-changed: ${{ steps.detect.outputs.user-facing-changed }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 1
fetch-depth: 0
- name: Set up environment
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: make setup-image
- name: Ensure branch protection and labels
env:
DEVX_REPO_NAME: devx
DEVX_REPO_OWNER: oblachno-oss
DEVX_STATUS_CHECKS: "CI / validate (pull_request)"
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.tools.configure_repo
- name: Check if this is a release commit
id: check
env:
PYTHONPATH: src
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.ci.detect_release_commit
validate-commit-msg:
needs: [detect-type]
if: needs.detect-type.outputs.is-release == 'false'
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
timeout-minutes: 5
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 1
- name: Set up environment
run: make setup-image
- name: Validate latest commit message
env:
PYTHONPATH: src
if: steps.check.outputs.is-automated == 'false'
run: |
. .venv/bin/activate 2>/dev/null || true
git log -1 --format=%B > commit-msg.txt
python3 -m devx.ci.validate_commit_msg commit-msg.txt --branch master
rm -f commit-msg.txt
- name: Detect changed paths
id: detect
if: steps.check.outputs.is-release == 'false'
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.ci.classify_changes \
--base "HEAD~1" \
--head "HEAD" \
--github-output
- name: Notify on failure
if: failure()
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: |
. .venv/bin/activate 2>/dev/null || true
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.notify_failure \
--repo "${{ github.repository }}" \
--run-id "${{ github.run_id }}" \
--workflow "post-merge/detect-and-configure" \
--commit "${{ github.sha }}" \
--auto-login
release:
needs: [detect-type]
if: needs.detect-type.outputs.is-release == 'false'
release-and-maintain:
needs: [detect-and-configure]
if: always() && needs.detect-and-configure.result == 'success'
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
timeout-minutes: 15
defaults:
run:
shell: bash
outputs:
tag: ${{ steps.release-tag.outputs.tag }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.CI_GITEA_TOKEN }}
- name: Set up environment
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
run: make setup-image
- name: Configure git
run: |
git config user.name "devx-ci-bot"
git config user.email "devx-ci-bot@oblachno.fyi"
- name: Run release
id: release-tag
env:
PYTHONPATH: src
run: |
. .venv/bin/activate 2>/dev/null || true
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.release
- name: Notify on failure
if: failure()
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
PYTHONPATH: src
run: |
. .venv/bin/activate 2>/dev/null || true
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.notify_failure \
--repo "${{ github.repository }}" \
--run-id "${{ github.run_id }}" \
--workflow "post-merge/release" \
--commit "${{ github.sha }}" \
--auto-login
publish:
needs: [release]
if: needs.release.outputs.tag != ''
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
timeout-minutes: 10
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
ref: ${{ needs.release.outputs.tag }}
- name: Set up environment
run: make setup-image EXTRAS=release
- name: Build and publish release
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
PYTHONPATH: src
run: |
. .venv/bin/activate 2>/dev/null || true
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.publish "${{ needs.release.outputs.tag }}" "${{ github.repository }}" --auto-login
- name: Notify on failure
if: failure()
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
PYTHONPATH: src
run: |
. .venv/bin/activate 2>/dev/null || true
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.notify_failure \
--repo "${{ github.repository }}" \
--run-id "${{ github.run_id }}" \
--workflow "post-merge/publish" \
--commit "${{ github.sha }}" \
--auto-login
sync-wiki:
needs: [detect-type]
if: needs.detect-type.outputs.is-release == 'false'
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
timeout-minutes: 15
concurrency:
group: sync-wiki-${{ github.repository }}
cancel-in-progress: false
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up environment
run: make setup-image
- name: Sync documentation to wiki
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
PYTHONPATH: src
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.ci.sync_wiki --repo "${{ github.repository }}" --verify
- name: Notify on failure
if: failure()
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
PYTHONPATH: src
run: |
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.notify_failure \
--repo "${{ github.repository }}" \
--run-id "${{ github.run_id }}" \
--workflow "post-merge/sync-wiki" \
--commit "${{ github.sha }}" \
--auto-login
badges:
needs: [detect-type, release]
if: always()
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-quality:latest
timeout-minutes: 10
defaults:
run:
shell: bash
@@ -219,102 +111,73 @@ jobs:
with:
fetch-depth: 0
ref: master
token: ${{ secrets.CI_GITEA_TOKEN }}
- name: Fetch latest master
run: |
git fetch origin master
git reset --hard origin/master
token: ${{ secrets.CI_GITEA_API_TOKEN }}
- name: Set up environment
run: make setup-image
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: make setup-image EXTRAS=release
- name: Configure git
run: |
git config user.name "devx-ci-bot"
git config user.email "devx-ci-bot@oblachno.fyi"
# --- release + publish (only if user-facing changes, not a release commit) ---
- name: Run release
id: release-tag
if: needs.detect-and-configure.outputs.is-release == 'false' && needs.detect-and-configure.outputs.user-facing-changed == 'true'
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: |
. .venv/bin/activate 2>/dev/null || true
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.release
- name: Build and publish release
if: steps.release-tag.outputs.tag != ''
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: |
. .venv/bin/activate 2>/dev/null || true
export PATH="$HOME/.local/bin:$PATH"
git fetch --tags
git checkout "${{ steps.release-tag.outputs.tag }}"
python3 -m devx.ci.publish "${{ steps.release-tag.outputs.tag }}" "${{ github.repository }}" --auto-login
# --- sync-wiki + vikunja (skip on automated/release commits) ---
- name: Sync documentation to wiki
if: needs.detect-and-configure.outputs.is-automated == 'false'
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.ci.sync_wiki --repo "${{ github.repository }}" --verify
- name: Update Vikunja task
if: needs.detect-and-configure.outputs.is-automated == 'false'
env:
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
DEVX_VIKUNJA_PROJECT_ID: "8"
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.ci.post_merge --git-sha "${{ github.sha }}"
# --- badges (always run — even on release commits) ---
- name: Generate and push badges
env:
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
PRE_COMMIT_ALLOW_NO_CONFIG: "1"
run: |
. .venv/bin/activate 2>/dev/null || true
export PATH="$HOME/.local/bin:$PATH"
# Fetch latest master to pick up any release commit that was pushed
git fetch origin master
git reset --hard origin/master
python3 -m devx.ci.push_badges
- name: Notify on failure
if: failure()
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
PYTHONPATH: src
run: |
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.notify_failure \
--repo "${{ github.repository }}" \
--run-id "${{ github.run_id }}" \
--workflow "post-merge/badges" \
--commit "${{ github.sha }}" \
--auto-login
vikunja:
needs: [detect-type]
if: needs.detect-type.outputs.is-release == 'false'
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
timeout-minutes: 10
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up environment
run: make setup-image
- name: Update Vikunja task
env:
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
DEVX_VIKUNJA_PROJECT_ID: "8"
PYTHONPATH: src
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.ci.post_merge --git-sha "${{ github.sha }}"
- name: Notify on failure
if: failure()
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
PYTHONPATH: src
run: |
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.notify_failure \
--repo "${{ github.repository }}" \
--run-id "${{ github.run_id }}" \
--workflow "post-merge/vikunja" \
--commit "${{ github.sha }}" \
--auto-login
configure-repo:
needs: [detect-type]
if: needs.detect-type.outputs.is-release == 'false'
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
timeout-minutes: 10
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
- name: Set up environment
run: make setup-image
- name: Ensure branch protection and labels
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
PYTHONPATH: src
DEVX_REPO_NAME: devx
DEVX_REPO_OWNER: oblachno-oss
run: |
. .venv/bin/activate 2>/dev/null || true
python3 -m devx.tools.configure_repo
- name: Notify on failure
if: failure()
env:
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
PYTHONPATH: src
run: |
export PATH="$HOME/.local/bin:$PATH"
python3 -m devx.ci.notify_failure \
--repo "${{ github.repository }}" \
--run-id "${{ github.run_id }}" \
--workflow "post-merge/configure-repo" \
--workflow "post-merge/release-and-maintain" \
--commit "${{ github.sha }}" \
--auto-login
+55 -46
View File
@@ -50,7 +50,7 @@ Workflow YAML files (`.gitea/workflows/*.yml`) are verified with two tools:
Both run via `make workflow-check` and are part of `make lint-all`.
The pre-commit hook runs actionlint automatically when workflow files change.
The CI `quality` job runs `make setup-quality` then `make lint-all`.
The CI `validate` job runs `make setup-image` then `make lint-all`.
CI also runs a best-effort `make workflow-dryrun` step (skipped if act_runner is not installed in the CI Docker image).
## Architecture
@@ -88,7 +88,9 @@ src/devx/
│ ├── integration_guard.py # Run pytest with cross-runner fail-fast
│ ├── check_translations.py # Translation completeness check
│ ├── doc_coverage.py # Documentation coverage check
── lint_docs.py # Documentation linter (structure, links, headings, code blocks, orphans)
── lint_docs.py # Documentation linter (structure, links, headings, code blocks, orphans)
│ ├── validate_deploy_ref.py # Validate git tag for deployments (--github-output)
│ └── record_deployed_tag.py # Record deployed tag to Gitea repo variable
├── tools/ # Developer tooling modules (run locally or by CI)
│ ├── setup.py # Environment setup (venv, deps, hooks)
│ ├── install_tools.py # Install actionlint, git-cliff, act_runner, tea, hadolint, vale
@@ -113,6 +115,16 @@ src/devx/
│ ├── 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)
├── utils/ # Shared utilities (reusable across projects)
│ ├── api.py # API response helpers (is_truthy, is_falsy)
│ ├── ssh.py # SSH exec + wait_for_ssh (pure-Python socket check)
│ ├── crypto.py # Secret generation (shell-safe passwords)
│ ├── vault.py # Ansible vault encrypt/decrypt helpers
│ ├── network.py # HTTP connectivity check + wait_for_ssh
│ ├── confirm.py # Typed confirmation validation for destructive ops
│ ├── json_registry.py # File-locked JSON registry for local state
│ ├── step_tracker.py # Multi-step operation tracking with reports
│ └── logging.py # XDG-compliant logging configuration
└── molecule/ # Optional molecule testing helpers (for Ansible projects)
├── discover_runners.py # Dynamic Gitea runner discovery
├── distribute_molecule.py # Distribute molecule scenarios across runners (LPT scheduling, --roles-root for multi-role)
@@ -136,18 +148,24 @@ Every change to master goes through this workflow. No exceptions.
### Branch Protection (Required Gitea Settings)
Branch protection and labels are automatically configured by
`python -m devx.tools.configure_repo`, which runs as a `configure-repo` job in
the post-merge workflow on every push to master.
`python -m devx.tools.configure_repo`, which runs as a step in the
`detect-and-configure` job in the post-merge workflow on every push to master.
The following rules are enforced for `master`:
- **Require pull request**: No direct pushes to master
- **Require approval review**: At least 1 `APPROVE` review before merge
- **Require status checks**: CI quality must pass
- **Require status checks**: CI validate must pass
- **Block force pushes**: No history rewriting on master
### 1. Create Vikunja Task
Create a task in Vikunja to get a `DEVX-N` identifier.
**IMPORTANT:** The task title must NOT include the `DEVX-N:` prefix.
The `make create-pr` and `check_auto_merge_ready` commands automatically
prepend `DEVX-N: ` to the Vikunja task title when forming the PR title.
If the Vikunja task title already includes the prefix, the PR title will
have a double prefix and auto-merge validation will fail.
### 2. Create Branch
```bash
git checkout master && git pull
@@ -174,8 +192,9 @@ docs: update README
### 6. Review the PR
**Automated review (CI `pr-review` job):** Every PR triggers an automated
review via `python -m devx.ci.pr_review`. This job posts a review with
**Automated review (CI `validate` job):** Every PR triggers an automated
review via `python -m devx.ci.pr_review` as a step in the `validate` job.
This posts a review with
`COMMENT` (no issues) or `REQUEST_CHANGES` (issues found):
- Architecture compliance (no subprocess in CLI, no hardcoded URLs)
@@ -198,7 +217,7 @@ Once all checklist items are verified and comments are addressed, approve
the PR. Then add the `ready-to-merge` label. The auto-merge workflow will:
1. **Validate** PR title format (`DEVX-N: <vikunja task title>`) and match against Vikunja task title
2. **Check** that at least one substantive APPROVE review exists
3. Wait for all CI checks to pass (including the `pr-review` job)
3. Wait for all CI checks to pass (including the `validate` job)
4. Squash-merge with title: `DEVX-N: <conventional commit message>`
5. The post-merge workflow marks the Vikunja task as done
6. The release workflow automatically versions, tags, and publishes
@@ -209,36 +228,27 @@ the PR. Then add the `ready-to-merge` label. The auto-merge workflow will:
### Automated Release Pipeline
After a PR is merged to master, the **post-merge workflow**
(`.gitea/workflows/post-merge.yml`) runs automatically:
(`.gitea/workflows/post-merge.yml`) runs automatically. Consolidated
into 2 jobs (from 7) to reduce runner overhead:
1. **detect-type** — Checks if the commit is a regular merge or a
release commit (`release: vX.Y.Z`). All subsequent jobs skip for
release commits (except badges).
1. **detect-and-configure** — Configures repo (branch protection, labels),
detects release commit, validates commit message. Outputs `is-release`
and `is-automated` for the next job.
2. **release** — Runs `python -m devx.ci.release` which:
- Checks for user-facing changes via `python -m devx.ci.classify_changes`
- Uses **git-cliff** to calculate the next semver version from conventional commits
- Updates `__version__` in `src/devx/__init__.py` (single source of truth)
- Updates `CHANGELOG.md` with the new version section
- Runs `make lint-ruff` and `make pytest-cov` to verify the release is healthy
- Commits with `release: vX.Y.Z [skip ci]` prefix
- Creates an annotated tag `vX.Y.Z` on the release commit
- Pushes both the commit and tag to master
3. **sync-wiki** — Syncs documentation to the Gitea wiki. Runs for ALL
non-release commits (not only when release succeeds), so docs-only
changes still update the wiki.
4. **badges** — Generates and pushes quality badge SVGs to the `badges` branch.
Uses `if: always()` so it runs on every push, including release commits.
5. **vikunja** — Marks the corresponding Vikunja task as done. Runs for ALL
non-release commits (not only when release succeeds), so infrastructure-only
changes still update the task tracker.
6. **publish** — Runs after release succeeds (needs: release). Builds and
publishes the package to the Gitea PyPI registry. Gets the tag from the
release job's `tag` output (written via `GITHUB_OUTPUT`).
2. **release-and-maintain** — Runs all post-merge maintenance as
conditional steps:
- **release** (if not a release commit) — Runs `python -m devx.ci.release`
which checks for user-facing changes via `classify_changes`, uses
git-cliff for semver, updates `__version__`, updates `CHANGELOG.md`,
runs lint+tests, commits with `release: vX.Y.Z [skip ci]`, creates
annotated tag, pushes to master.
- **publish** (if release created a tag) — Builds and publishes the
package to the Gitea PyPI registry. Checks out the release tag
within the same job.
- **sync-wiki** (if not automated) — Syncs documentation to the Gitea wiki.
- **vikunja** (if not automated) — Marks the corresponding Vikunja task as done.
- **badges** (always) — Generates and pushes quality badge SVGs to the
`badges` branch. Fetches latest master first to pick up release commits.
### Smart CI: User-Facing vs Workflow-Only Changes
@@ -344,12 +354,11 @@ dependency is skipped, even if the condition explicitly allows
```yaml
auto-merge:
needs: [quality, detect-changes, pr-review, molecule-tests]
needs: [validate, molecule-tests]
if: >-
always() &&
github.event_name == 'pull_request' &&
needs.quality.result == 'success' &&
needs.pr-review.result == 'success' &&
needs.validate.result == 'success' &&
(needs.molecule-tests.result == 'success' || needs.molecule-tests.result == 'skipped')
```
@@ -487,9 +496,9 @@ to eliminate the 40-120s setup tax on every CI job:
| 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-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-base-latest` | Python 3.12 + devx[ci] + tea | auto-merge, detect-and-configure |
| `ci-quality-latest` | ci-base + devx[lint] + actionlint + checkmake + hadolint | (badges in release-and-maintain uses ci-full) |
| `ci-full-latest` | ci-quality + devx[release,molecule,deploy] + git-cliff + OpenTofu | validate, release-and-maintain, molecule-tests, build-and-push |
**Build process** (in `build-images.yml` workflow):
1. `ci-base` builds FROM `gitea/runner-images:ubuntu-latest`
@@ -502,9 +511,9 @@ Each image is tagged `latest` and pushed to
**Using images in workflows**:
```yaml
jobs:
quality:
validate:
runs-on: docker
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-quality:latest
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
steps:
- uses: actions/checkout@v4
- name: Set up environment
@@ -586,7 +595,7 @@ the user should not need to specify which profile to use.
| Profile | Purpose |
|---------|---------|
| `ci-investigator` | Investigate CI failures (quality, release, publish, wiki sync, image build) |
| `ci-investigator` | Investigate CI failures (validate, release-and-maintain, build-images) |
| `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 |
@@ -596,7 +605,7 @@ the user should not need to specify which profile to use.
| Trigger | Profile | Mode |
|---------|---------|------|
| CI run failure (quality, release, publish, sync-wiki, build-images) | `ci-investigator` | Background |
| CI run failure (validate, release-and-maintain, 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 |
+54
View File
@@ -2,6 +2,60 @@
All notable changes to this project will be documented in this file.
## [0.43.0] - 2026-07-13
### Features
- Add get_customer_vm_ip and get_observability_vm_ip to I/O check
## [0.42.0] - 2026-07-13
### Features
- Add I/O function isolation check and skip integration tests
## [0.41.2] - 2026-07-13
### Bug Fixes
- Auto-discover molecule root instead of hardcoding gitea-runner
## [0.41.1] - 2026-07-13
### Bug Fixes
- Check_test_isolation accepts multiple --test-path values
## [0.41.0] - 2026-07-13
### Features
- Test isolation pytest plugin, shift-left quality gates, dep upgrades
## [0.40.1] - 2026-07-12
### Bug Fixes
- Fall back to CI token when reviewer self-approval is rejected
## [0.40.0] - 2026-07-11
### Features
- Detect double-prefix in Vikunja task title during pre-merge validation
## [0.39.0] - 2026-07-09
### Features
- Extract shared utilities from infra and grm into devx
## [0.38.0] - 2026-07-08
### Features
- Introduce role-based Gitea API token environment variables
## [0.37.0] - 2026-07-07
### Features
+3 -1
View File
@@ -81,7 +81,7 @@ install-tools: $(VENV)/bin/activate
.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: check-test-speed check-test-coverage check-docs check-test-isolation check-translations
.PHONY: create-task create-pr push-with-pr git-push rebase pr-rebase
.PHONY: lint-all lint-dockerfiles
lint-ruff: devx-lint-ruff
@@ -99,6 +99,8 @@ checkmake: devx-checkmake
check-mutable-globals: devx-check-mutable-globals
check-dep-docs: devx-check-dep-docs
check-test-speed: devx-check-test-speed
check-test-isolation: devx-check-test-isolation
check-translations: devx-check-translations
check-test-coverage: devx-check-test-coverage
check-docs: devx-check-docs
create-task: devx-create-task
+9 -9
View File
@@ -16,12 +16,12 @@ quality badges.
[![CI](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions/workflows/ci.yml/badge.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![License: GPL-3.0](https://img.shields.io/badge/license-GPL--3.0-blue)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/LICENSE)
[![Coverage](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/coverage.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Tests](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/tests.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Docs](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/docs.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
[![Code Quality](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/quality.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Version](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/version.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
[![Python](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/python.svg)](https://www.python.org/downloads/)
[![Coverage](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/coverage.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Tests](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/tests.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Docs](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/docs.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
[![Code Quality](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/quality.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Version](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/version.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
[![Python](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/python.svg)](https://www.python.org/downloads/)
## Why devx?
@@ -87,7 +87,7 @@ extra index and list devx in your dependencies:
```toml
[project]
dependencies = [
"devx>=0.37.0",
"devx>=0.43.0",
]
[tool.pip]
@@ -101,8 +101,8 @@ pip install -e .
```
> **Note:** If your project requires a specific devx version, pin it in
> `dependencies` (for example, `"devx==0.37.0"`) or use a version constraint
> (for example, `"devx>=0.37.0,<0.38"`).
> `dependencies` (for example, `"devx==0.43.0"`) or use a version constraint
> (for example, `"devx>=0.43.0,<0.44"`).
### Optional extras
+2 -8
View File
@@ -20,11 +20,5 @@ COPY . /tmp/devx
RUN pip install --no-cache-dir /tmp/devx[release,molecule,deploy] \
&& rm -rf /tmp/devx
# Install git-cliff (changelog generator for release job)
RUN python3 -m devx.tools.install_tools --tool git-cliff
# Install OpenTofu (for infra deploy jobs)
RUN ARCH=$(uname -m | sed 's/x86_64/amd64/') \
&& VERSION=1.12.3 \
&& curl -fsSL "https://github.com/opentofu/opentofu/releases/download/v${VERSION}/tofu_${VERSION}_$(uname -s | tr '[:upper:]' '[:lower:]')_${ARCH}.tar.gz" \
| tar -xz -C /usr/local/bin tofu
# Install git-cliff (changelog generator for release job) and OpenTofu (for infra deploy jobs)
RUN python3 -m devx.tools.install_tools --tool git-cliff --tool tofu
+1 -6
View File
@@ -13,10 +13,5 @@ RUN pip install --no-cache-dir /tmp/devx[lint] \
&& rm -rf /tmp/devx
# Install CI/CD binary tools
RUN python3 -m devx.tools.install_tools --tool actionlint --tool vale \
RUN python3 -m devx.tools.install_tools --tool actionlint --tool vale --tool hadolint \
&& python3 -m devx.tools.install_checkmake
# Install hadolint (Dockerfile linter)
RUN curl -fsSL "https://github.com/hadolint/hadolint/releases/download/v2.12.0/hadolint-Linux-x86_64" \
-o /usr/local/bin/hadolint \
&& chmod +x /usr/local/bin/hadolint
@@ -0,0 +1,142 @@
# ADR-0001: Test Isolation Pytest Plugin and Shift-Left Quality Gates
Date: 2026-07-13
Status: Accepted
## Context
Unit tests in devx were slow (10s+) and getting slower. Investigation
revealed two root causes:
1. **Unpatched subprocess calls** — test functions calling
`subprocess.run`, `update_doc_versions`, or `run_cmd` without
`@patch` decorators, causing real subprocess execution during tests.
2. **Excessive iterations** — statistical tests with 1000-iteration
loops that should use property-based testing or smaller samples.
These issues were discovered manually by profiling with
`pytest --durations=0`. There was no automated check to prevent
regressions — new tests could introduce the same patterns and slow
down the suite again.
Additionally, translation completeness checks
(`devx.ci.check_translations`) only ran in CI, not locally. Developers
discovered missing translations at CI time, wasting round-trips.
## Decision
### 1. Test Isolation as a Pytest Plugin (pytest11 entry point)
Implement the test isolation check as a **pytest plugin** registered
via the `pytest11` entry point in `pyproject.toml`:
```toml
[project.entry-points.pytest11]
devx_test_isolation = "devx.tools.check_test_isolation"
```
This makes the check **transparent and always-on** — every `pytest`
invocation in any repo with devx installed automatically runs the
static analysis. No extra Makefile target or CI step needed.
The plugin (`devx.tools.check_test_isolation`) statically analyzes
test files during `pytest_collection_finish` and emits
`UserWarning` for violations:
- **unpatched-subprocess**: `subprocess.run/call/Popen/check_call/check_output`
called in a test function without `@patch`
- **unpatched-sleep**: `time.sleep` called without `@patch`
- **unpatched-helper**: known subprocess-spawning helpers
(`update_doc_versions`, `run_cmd`, `run_tests`) called without
`@patch` (and without patching their internal dependencies)
- **excessive-iterations**: `for _ in range(N)` where N > 100
The plugin recognizes transitive safety: if `run_cmd` is patched,
`run_tests` (which calls `run_cmd`) is safe. This is tracked via
`HELPER_INTERNAL_CALLS`.
A standalone CLI (`python -m devx.tools.check_test_isolation`) is also
provided for CI gates and pre-commit hooks where pytest isn't run.
### 2. Shift-Left Quality Gates in `make lint`
Add `devx-check-translations` and `devx-check-test-isolation` to the
`devx-lint` target in `devx.mak`. This means `make lint` now runs:
- ruff check + format
- pyright typecheck
- bandit security scan
- **translation completeness** (missing keys, dead keys, missing languages)
- **test isolation** (unpatched subprocess, time.sleep, excessive loops)
These were previously CI-only checks. Running them in `make lint`
catches issues at the developer's machine, not in CI.
### 3. Pre-commit Hook Coverage
Update the pre-commit hook to run all three shift-left checks:
test speed, translation completeness, and test isolation. This
catches issues even earlier than `make lint` — before the commit
is even created.
## Consequences
### Positive
- **Automatic enforcement**: The pytest plugin runs on every `pytest`
invocation across devx, grm, and infra — no per-repo configuration
needed. New tests with unpatched subprocess calls emit warnings
immediately.
- **Shift-left**: Translation gaps and test isolation violations are
caught locally (pre-commit / `make lint`) instead of in CI.
- **Fast feedback**: Static analysis adds <0.1s to test runs — no
runtime overhead.
- **No false positives**: The transitive dependency tracking
(`HELPER_INTERNAL_CALLS`) correctly recognizes that patching
`run_cmd` makes `run_tests` safe, and patching `subprocess.run`
makes all helpers safe.
### Negative
- **Coverage instrumentation gap**: The pytest plugin module is loaded
before coverage starts, so module-level code (decorators, class
definitions) appears uncovered. Mitigated by `-p no:devx_test_isolation`
in devx's own `pyproject.toml` `addopts` and `# pragma: no cover` on
plugin hook functions.
- **Static analysis limitations**: The plugin only sees direct calls
in test function bodies, not indirect calls through `main()` or
other wrappers. This is acceptable — the `check_test_speed` tool
catches the symptom (slow tests) for indirect cases.
- **Translation burden**: Every new `_()` call in source requires
adding 6 language translations. This is by design (all supported
languages must be complete) but adds friction for quick prototypes.
## Implementation Details
### Pytest Plugin Discovery
The `pytest11` entry point is the standard mechanism for pytest
plugins. When devx is installed (via pip), pytest auto-discovers
the plugin. No `conftest.py` or `pytest_plugins` declaration needed
in consumer repos.
### Disabling the Plugin
- `--no-test-isolation` flag: disables analysis for a single run
- `-p no:devx_test_isolation` in `addopts`: disables for a repo
(used in devx's own `pyproject.toml` for coverage reasons)
### Strict Mode
- `--strict-test-isolation` flag: promotes warnings to errors and
prints a summary to stderr
- `filterwarnings = ["error:Test isolation:UserWarning"]` in
`pyproject.toml`: same effect via pytest's warning filter system
### Known Subprocess Helpers
The `KNOWN_SUBPROCESS_HELPERS` dict maps function names to
descriptions. `HELPER_INTERNAL_CALLS` maps each helper to the
function names it internally calls, enabling transitive safety
checks. Both are defined in `check_test_isolation.py` and can be
extended as new subprocess-spawning helpers are added to devx.
+8 -8
View File
@@ -12,12 +12,12 @@ project to be reusable across all oblachno-oss repositories.
[![CI](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions/workflows/ci.yml/badge.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![License: GPL-3.0](https://img.shields.io/badge/license-GPL--3.0-blue)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/LICENSE)
[![Coverage](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/coverage.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Tests](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/tests.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Docs](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/docs.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
[![Code Quality](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/quality.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Version](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/version.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
[![Python](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/bff19e053993255b932b7b20cb91dd6a056bf409/python.svg)](https://www.python.org/downloads/)
[![Coverage](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/coverage.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Tests](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/tests.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Docs](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/docs.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
[![Code Quality](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/quality.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
[![Version](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/version.svg)](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
[![Python](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/raw/commit/29e3ef9cfd8e7d5605c7189cf26f1fc0b0cff756/python.svg)](https://www.python.org/downloads/)
## Overview
@@ -74,14 +74,14 @@ Add devx to your `pyproject.toml` dependencies and configure the registry:
```toml
[project]
dependencies = [
"devx>=0.37.0",
"devx>=0.43.0",
]
[tool.pip]
extra-index-url = "https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple"
```
Pin a specific version if needed: `"devx==0.37.0"` or `"devx>=0.37.0,<0.38"`.
Pin a specific version if needed: `"devx==0.43.0"` or `"devx>=0.43.0,<0.44"`.
### Optional extras
@@ -0,0 +1,158 @@
# Retrospective: Self-Approval Fallback and CI Consolidation
## Date
2026-07-12
## Context
The devx package (reusable CI/CD tools) underwent two significant
changes during this period: workflow consolidation (DEVX-126) and the
self-approval fallback fix (DEVX-127). The self-approval bug was the
last remaining blocker for end-to-end automated CI/CD across all
oblachno repos. This retrospective covers devx v0.40.0 through v0.40.1.
## Scope
PRs: DEVX-125 (double-prefix detection), DEVX-126 (CI consolidation),
DEVX-127 (self-approval fallback). ~16 commits including release/badge
churn.
## Timeline of Key Failures
| Run | Issue | Fix Commit |
|--------|----------------------------------------------|------------|
| infra #2562 | Self-approval rejected (403) | `d035b62` |
| devx CI | Auto-merge review body too short (< 20 chars) | `fc613d4` |
| devx CI | test_setup flaky due to PIP_BREAK_SYSTEM_PACKAGES | `043f259` |
| devx CI | Missing translations for self-approval messages | `0d8c7f5` |
## What Served Us Well
- **Test-driven fix for pr_review.py.** The self-approval fallback was
implemented with full test coverage before being deployed. Tests
covered both the fallback-available and fallback-unavailable paths,
ensuring the code was correct before it hit CI.
- **i18n enforcement caught missing translations.** The translation
completeness check flagged the new self-approval error messages that
were added without corresponding translation entries. This prevented
untranslated strings from reaching production.
- **Consolidated CI workflow.** DEVX-126 merged 7 separate CI jobs into
a single `validate` job, reducing runner overhead and eliminating
inter-job dependency issues. The consolidation pattern was then
applied to grm and infra.
- **Conventional commit enforcement.** The `validate_commit_msg` check
caught a double-prefix in the Vikunja task title (DEVX-125), which
would have caused auto-merge validation failures downstream.
## What Slowed Us Down
### 1. Self-Approval Bug Not Caught Earlier (1 infra CI failure)
The `pr_review.py` script used the `REVIEWER_GITEA_API_TOKEN` for
APPROVE events. When the token belonged to the PR author, Gitea
rejected the self-approval with 403. This was only discovered when the
infra PR CI run #2562 failed — the devx CI had passed because devx PRs
were reviewed by a different user.
**Root cause:** No test simulated the self-approval rejection scenario.
The tests mocked the Gitea API to always return 200 for review
submissions.
**Time wasted:** ~2 hours (cross-repo investigation + fix + test).
**Fix:** Added fallback to `CI_GITEA_API_TOKEN` when the reviewer token
is rejected with self-approval. The fallback is transparent — the
script logs a warning and retries with the CI token.
**Lesson:** Test API interactions against all HTTP error codes the
external system can return, not only the happy path. For Gitea, this
includes 403 (self-approval), 409 (conflict), and 422 (validation).
### 2. Auto-Merge Review Body Length Check (1 CI failure)
The auto-merge validation requires APPROVE review bodies to be > 20
chars (to prevent perfunctory approvals). The automated review posted
by `pr_review.py` had a body of exactly 17 chars, failing the check.
**Root cause:** The review body was a generic "Automated review passed"
message that was too short. The length check was added to prevent
rubber-stamping by human reviewers, but it also affected automated
reviews.
**Time wasted:** ~1 CI run.
**Fix:** Expanded the automated review body to include a summary of
checked categories, ensuring it exceeds 20 chars.
**Lesson:** Automated reviews need substantive bodies too. The length
check doesn't distinguish between human and automated reviewers.
### 3. test_setup Flaky Due to Environment Variable (1 CI failure)
`test_setup.py` failed intermittently because `PIP_BREAK_SYSTEM_PACKAGES`
was set in the CI environment but not in local tests. The test didn't
isolate itself from the environment variable.
**Root cause:** The test assumed a clean environment but CI sets
`PIP_BREAK_SYSTEM_PACKAGES=1` globally. The test's behavior changed
based on this env var.
**Time wasted:** ~1 CI run.
**Fix:** Isolated the test from the env var using `monkeypatch.delenv`.
**Lesson:** Tests that interact with environment-dependent behavior
should explicitly set or unset the relevant env vars, not assume
defaults.
### 4. Missing Translations for New Messages (1 CI failure)
The self-approval fallback added new user-facing messages (warning
about token fallback) but didn't add translations for all supported
languages. The translation completeness check caught this.
**Root cause:** New `click.echo()` calls were added with `_()` wrappers
but the translation JSON wasn't updated.
**Time wasted:** ~1 CI run.
**Fix:** Added translations for all new messages in `translations.json`.
**Lesson:** When adding new `_()` wrapped strings, update
`translations.json` in the same commit. The i18n check is strict —
100% completeness is required.
## Improvements Implemented
### 1. Self-Approval Fallback (HIGH impact)
`pr_review.py` now falls back to `CI_GITEA_API_TOKEN` for APPROVE
events when the reviewer token is rejected as self-approval. This
unblocked auto-merge across all three repos.
### 2. Double-Prefix Detection (MEDIUM impact)
`check_auto_merge_ready.py` now detects and rejects Vikunja task titles
that include the identifier prefix (for example, "DEVX-127: Fix...").
The validator adds the prefix automatically, so a double prefix would
fail validation.
### 3. CI Workflow Consolidation (MEDIUM impact)
Merged 7 separate CI jobs into a single `validate` job, reducing runner
overhead by ~5 min per CI run and eliminating inter-job dependency
issues.
## Action Items for Future Sessions
1. **Test API interactions against all relevant HTTP error codes.**
Don't only test the happy path. For Gitea: 200, 201, 204, 403, 404,
409, 422.
2. **Update translations in the same commit as new `_()` strings.**
The i18n check will fail otherwise.
3. **Isolate tests from environment variables.** Use `monkeypatch.setenv`
or `monkeypatch.delenv` for any env var the test's behavior depends on.
4. **Ensure automated review bodies are substantive (> 20 chars).**
Include a summary of checked categories.
5. **When adding fallback logic, test both the fallback-available and
fallback-unavailable paths.** Both must be covered for 100% branch
coverage.
+58 -43
View File
@@ -41,6 +41,7 @@ src/devx/
│ ├── setup.py # Environment setup (venv, deps, hooks, tea login)
│ ├── install_tools.py # Install actionlint, git-cliff, act_runner, tea
│ ├── check_test_speed.py # Measure unit test execution time
│ ├── check_test_isolation.py # Pytest plugin: detect un-hermetic test patterns
│ ├── configure_repo.py # Branch protection and label setup
│ ├── generate_badges.py # Badge SVG generation
│ ├── generate_cliff_config.py # Generate cliff.toml with correct prefix
@@ -331,13 +332,22 @@ total suite time must not exceed `--max-seconds` (default: 10s), and no
individual test may exceed `--max-single-seconds` (default: 0.5s, 0 to
disable). Runs `make test-unit` with `PYTEST_ADDOPTS=--durations=0`.
### `check_test_isolation.py`
Pytest plugin (auto-discovered via `pytest11` entry point) that
statically analyzes test files for un-hermetic patterns causing slow
or flaky tests: unpatched `subprocess.run`/`time.sleep` calls, known
subprocess-spawning helpers called without `@patch`, and excessive
loop iterations (>100). Also available as a standalone CLI for CI
gates and pre-commit hooks. See ADR-0001 for design rationale.
### `configure_repo.py`
Configures repository branch protection and labels via the Gitea REST API.
Sets up master branch protection (required status checks, block on rejected
reviews, block on outdated branch) and creates standard labels. Status check
contexts are read from `DEVX_STATUS_CHECKS` or default to
`CI / quality (pull_request)`.
`CI / validate (pull_request)`.
### `generate_badges.py`
@@ -456,13 +466,14 @@ Developer pushes and creates PR (title: "DEVX-N: <vikunja task title>")
CI workflow (ci.yml) triggers:
├── quality (lint, tests, coverage, test speed, doc coverage,
translation check, dependency scan, workflow dry-run)
├── detect-changes (classify_changes.py → user-facing or workflow-only)
── if user-facing → release-dry-run (release.py --dry-run)
├── pr-review (pr_review.py → posts COMMENT or REQUEST_CHANGES)
├── validate (single job: quality + detect-changes +
release-dry-run + pr-review + pre-merge validation)
├── quality steps (lint, tests, coverage, test speed, doc coverage,
│ │ translation check, dependency scan, workflow dry-run)
── detect-changes (classify_changes.py → user-facing or workflow-only)
│ └── if user-facing → release-dry-run (release.py --dry-run)
├── pre-merge validation (check_auto_merge_ready.py)
│ └── pr-review (pr_review.py → posts COMMENT or REQUEST_CHANGES)
└── auto-merge (auto_merge.py)
├── validate PR title format
@@ -483,50 +494,54 @@ Push to master (squash-merge commit: "DEVX-N <conventional commit>")
Post-merge workflow (post-merge.yml) triggers:
├── detect-type (detect_release_commit.py)
── is-release? → skip all jobs except badges
├── detect-and-configure (single job)
── configure-repo (configure_repo.py)
│ ├── detect-type (detect_release_commit.py)
│ │ └── is-release? → skip all steps except badges
│ └── validate-commit-msg (validate_commit_msg.py --branch master)
── validate-commit-msg (validate_commit_msg.py --branch master)
├── release (release.py)
│ ├── classify_changes.py → skip if workflow-only
│ ├── git-cliff → calculate next version
│ ├── update __version__ in __init__.py
│ ├── update CHANGELOG.md
│ ├── run make lint-ruff && make pytest-cov
│ ├── commit "release: vX.Y.Z [skip ci]"
── create annotated tag vX.Y.Z
└── push commit + tag to master
│ ▼
Tag push triggers publish workflow (see below)
├── sync-wiki (sync_wiki.py --strict)
└── sync docs/ to Gitea wiki with integrity check
├── badges (push_badges.py) [ALWAYS runs, even on release commits]
├── fetch latest master
── generate_badges.py → SVG files
│ ├── push to orphan badges branch
── update README.md + docs/index.md with cache-busting URLs
├── vikunja (post_merge.py)
├── extract task ID from commit message
│ ├── mark Vikunja task as done
└── post comment with merge SHA
└── configure-repo (configure_repo.py)
└── ensure branch protection and labels
── release-and-maintain (needs detect-and-configure)
├── release (release.py) [skip if release commit or workflow-only]
│ ├── classify_changes.py → skip if workflow-only
│ ├── git-cliff → calculate next version
│ ├── update __version__ in __init__.py
│ ├── update CHANGELOG.md
│ ├── run make lint-ruff && make pytest-cov
│ ├── commit "release: vX.Y.Z [skip ci]"
│ ├── create annotated tag vX.Y.Z
── push commit + tag to master
│ publish (publish.py) [if release created a tag]
├── build package (python -m build)
│ ├── publish to Gitea PyPI registry (twine upload)
│ │ OR publish to standard PyPI (if PYPI_TOKEN set)
│ OR skip publish (if --skip-build)
│ └── create Gitea release with git-cliff notes
├── sync-wiki (sync_wiki.py --strict) [skip if automated]
── sync docs/ to Gitea wiki with integrity check
── vikunja (post_merge.py) [skip if automated]
│ ├── extract task ID from commit message
├── mark Vikunja task as done
│ └── post comment with merge SHA
└── badges (push_badges.py) [ALWAYS runs, even on release commits]
├── fetch latest master
├── generate_badges.py → SVG files
├── push to orphan badges branch
└── update README.md + docs/index.md with cache-busting URLs
```
### Publish flow
```text
Tag push (vX.Y.Z) triggers publish workflow (publish.yml):
Within release-and-maintain job (after release step creates a tag):
├── install build, twine, git-cliff, tea
├── configure tea login
├── checkout release tag
└── publish (publish.py)
├── build package (python -m build)
+146 -108
View File
@@ -1,32 +1,29 @@
# CI/CD Workflow
devx uses Gitea Actions for CI/CD automation. Three workflows implement a
complete pipeline: pull request validation, post-merge release automation, and
tag-triggered publishing.
devx uses Gitea Actions for CI/CD automation. Two workflows implement a
complete pipeline: pull request validation and post-merge release
automation (including publishing).
## Workflow overview
```text
PR opened/synchronized ──► CI (ci.yml)
│ ├── quality
├── detect-changes
├── release-dry-run (if user-facing)
│ ├── pr-review
│ ├── validate (quality + detect-changes +
│ release-dry-run + pr-review +
│ pre-merge validation)
│ └── auto-merge ──► squash-merge to master
│ │
▼ ▼
Push to master ──► Post-merge (post-merge.yml)
├── detect-type
├── validate-commit-msg
├── release ──► tag vX.Y.Z
── sync-wiki │
├── badges │
├── vikunja │
└── configure-repo │
Tag push (v*) ──► Publish (publish.yml)
└── publish ──► Gitea PyPI registry + Gitea release
├── detect-and-configure (detect-type +
validate-commit-msg +
│ configure-repo)
── release-and-maintain
├── release ──► tag vX.Y.Z
├── publish ──► Gitea PyPI registry + Gitea release
├── sync-wiki
├── vikunja
└── badges (always runs)
```
## CI workflow (`ci.yml`)
@@ -35,9 +32,15 @@ Runs on pull requests (opened and synchronize) and manual dispatch.
### Jobs
#### `quality`
#### `validate`
The main quality gate. Runs on every PR:
The single validation job. Consolidates the former `quality`,
`detect-changes`, `release-dry-run`, `pr-review`, and `pre-merge-check`
jobs into one job to save checkout+setup overhead. Runs on every PR.
**Quality steps**
The main quality gate:
1. **Lint all** — ruff check, ruff format check, pyright, bandit, actionlint
(via `make lint-all`)
@@ -52,21 +55,21 @@ The main quality gate. Runs on every PR:
7. **Workflow dry-run validation**`make workflow-dryrun` via act_runner
(best-effort, skipped if act_runner is not installed)
#### `detect-changes`
**`detect-changes` step**
Classifies changes between `origin/master` and the PR head as user-facing or
workflow-only using `python -m devx.ci.classify_changes --github-output`.
Writes `user-facing-changed=true|false` to the job output for use by
downstream jobs.
downstream steps.
#### `release-dry-run`
**`release-dry-run` step**
Depends on `quality` and `detect-changes`. Only runs if user-facing changes
are detected. Runs `python -m devx.ci.release --dry-run` to validate that
the release script can calculate the next version and generate the changelog
without making changes. Non-blocking (uses `|| true`).
Only runs if the detect-changes step detected user-facing changes. Runs
`python -m devx.ci.release --dry-run` to validate that the release script
can calculate the next version and generate the changelog without making
changes. Non-blocking (uses `|| true`).
#### `pr-review`
**`pr-review` step**
Runs on every pull request. Executes `python -m devx.ci.pr_review` with the
PR number and repository. Fetches the PR diff via the Gitea API and runs
@@ -87,11 +90,24 @@ Checks performed:
7. Test coverage — source changes must include test updates
8. Commit conventions — conventional commit format on PR commits
**Pre-merge validation step**
Runs on every pull request. Executes
`python -m devx.ci.check_auto_merge_ready` with the branch name, PR title,
repository, and PR number. Validates auto-merge preconditions before the
`auto-merge` job runs:
1. **Branch name** — must contain a valid task ID (for example,
`DEVX-12-fix-foo``DEVX-12`)
2. **PR title format** — must be `{PREFIX}-N: <vikunja task title>`
3. **Vikunja task** — must exist and the title must match the PR title
4. **Branch state** — must not be behind master
#### `auto-merge`
Depends on `quality`, `detect-changes`, and `pr-review`. The final job in the
CI workflow. Runs `python -m devx.ci.auto_merge` with the branch name, PR
title, repository, and PR number:
Depends on `validate`. The final job in the CI workflow. Runs
`python -m devx.ci.auto_merge` with the branch name, PR title, repository,
and PR number:
1. **Read task ID** from branch name (for example, `DEVX-12-fix-foo``DEVX-12`)
2. **Validate PR title format** — must be `{PREFIX}-N: <vikunja task title>`
@@ -107,8 +123,9 @@ The merge commit push to master triggers the post-merge workflow.
### Smart CI: user-facing vs workflow-only changes
Not all changes require a new release. The `detect-changes` job classifies
changes using `python -m devx.ci.classify_changes`:
Not all changes require a new release. The `detect-changes` step in the
`validate` job classifies changes using
`python -m devx.ci.classify_changes`:
**Workflow-only paths** (infrastructure — no release needed):
- `.gitea/**` — Gitea Actions workflows
@@ -137,55 +154,90 @@ Rule priority (first match wins):
## Post-merge workflow (`post-merge.yml`)
Runs on every push to master. A single workflow with conditional jobs
replaces separate workflows for release, wiki sync, badges, and Vikunja task
updates.
Runs on every push to master. Consolidated into 2 jobs (from 7) to reduce
runner overhead: `detect-and-configure` (detect-type + validate-commit-msg +
configure-repo) and `release-and-maintain` (release + publish + sync-wiki +
badges + vikunja). Individual steps within `release-and-maintain` are
conditional on the `detect-and-configure` job's outputs.
### Job dependency graph
```text
detect-type ──┬── validate-commit-msg (skip if release commit)
├── release (skip if release commit)
│ │
│ ├── sync-wiki (needs release)
│ ├── badges (needs release, ALWAYS runs)
│ └── vikunja (needs release)
└── configure-repo (independent, skip if release commit)
detect-and-configure
├── configure-repo (independent, skip if release commit)
├── detect-type → is-release? is-automated?
└── validate-commit-msg (skip if release commit)
release-and-maintain (needs detect-and-configure)
├── release (skip if release commit or workflow-only)
│ └── publish (if release created a tag)
├── sync-wiki (skip if automated)
├── vikunja (skip if automated)
└── badges (always runs)
```
`sync-wiki` and `vikunja` depend on `release` succeeding so that the wiki and
task tracker are only updated when the code is actually released. If release
fails, they are skipped to avoid leaving the wiki or Vikunja in an
inconsistent state.
`sync-wiki` and `vikunja` run only on non-automated commits (that is, real PR
merges) so that the wiki and task tracker are only updated when a human
change lands. They skip on release commits and automated commits.
The `badges` job uses `if: always()` with no is-release condition so it runs
on every push to master, including release commits. This ensures badges
(tests, coverage, version, etc.) are always current.
The `badges` step always runs (even on release commits) so badges (tests,
coverage, version, etc.) are always current. It runs last so it picks up
any version bump the release step created.
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
version). Other jobs skip. The tag push triggers `publish.yml`.
version). Other steps skip. The `publish` step builds and publishes the
package to the Gitea PyPI registry within the same `release-and-maintain`
job (it checks out the release tag).
### Post-merge jobs
#### `detect-type`
#### `detect-and-configure`
The first post-merge job. Consolidates the former `detect-type`,
`validate-commit-msg`, and `configure-repo` jobs. Outputs `is-release`,
`is-automated`, and `user-facing-changed` for the `release-and-maintain`
job.
**`detect-type` step**
Checks if the latest commit is a release commit (`release: vX.Y.Z [skip ci]`)
using `python -m devx.ci.detect_release_commit`. Writes `is-release=true` or
`is-release=false` to the job output. All subsequent jobs use this to
conditionally skip for release commits.
`is-release=false` (and `is-automated`) to the job output. The
`release-and-maintain` job uses these to conditionally skip steps for
release commits.
#### `validate-commit-msg`
**`validate-commit-msg` step**
Depends on `detect-type`. Skips for release commits. Validates the latest
commit message using `python -m devx.ci.validate_commit_msg --branch master`.
On master, commits must follow `{PREFIX}-N: <conventional commit>` format
(added by auto-merge).
Skips for release/automated commits. Validates the latest commit message
using `python -m devx.ci.validate_commit_msg --branch master`. On master,
commits must follow `{PREFIX}-N: <conventional commit>` format (added by
auto-merge).
#### `release`
**`configure-repo` step**
Depends on `detect-type`. Skips for release commits. The core release
automation job. Runs `python -m devx.ci.release`:
Ensures branch protection and labels are configured using
`python -m devx.tools.configure_repo --repo <name> --owner <owner>`:
- Sets up master branch protection (required status checks, block on rejected
reviews, block on outdated branch)
- Creates standard labels
- Status check contexts read from `DEVX_STATUS_CHECKS` or default to
`CI / validate (pull_request)`
On failure, the `notify_failure` step creates a Gitea issue.
#### `release-and-maintain`
Depends on `detect-and-configure`. The second post-merge job. Consolidates
the former `release`, `publish`, `sync-wiki`, `badges`, and `vikunja` jobs.
Individual steps are conditional on the `detect-and-configure` job's outputs.
**`release` step**
Skips for release commits and workflow-only changes. The core release
automation step. Runs `python -m devx.ci.release`:
1. **Classify changes** — calls `classify_changes.py` to check for user-facing
changes. If only infrastructure files changed, exits without releasing.
@@ -225,11 +277,10 @@ tag/version/commit alignment.
On failure, the `notify_failure` step creates a Gitea issue via
`python -m devx.ci.notify_failure`.
#### `sync-wiki`
**`sync-wiki` step**
Depends on `detect-type` and `release`. Skips for release commits. Syncs
documentation from `docs/` to the Gitea wiki using
`python -m devx.ci.sync_wiki --repo <owner/repo> --strict`:
Skips for automated commits. Syncs documentation from `docs/` to the Gitea
wiki using `python -m devx.ci.sync_wiki --repo <owner/repo> --strict`:
1. Reads `docs/mapping.json` to map file paths to wiki page titles
2. Lists existing wiki pages via the Gitea API
@@ -243,15 +294,14 @@ deleted).
On failure, the `notify_failure` step creates a Gitea issue.
#### `badges`
**`badges` step**
Depends on `detect-type` and `release`. Uses `if: always()` so it runs on
every push to master, including release commits. Generates and pushes quality
badges using `python -m devx.ci.push_badges`:
Always runs (even on release commits). Generates and pushes quality badges
using `python -m devx.ci.push_badges`:
1. **Fetch latest master** — `git fetch origin master && git reset --hard
origin/master` (ensures the version badge reflects the current state,
even if the release job recently pushed a new version)
even if the release step recently pushed a new version)
2. **Generate badges** — calls `devx.tools.generate_badges` which runs
pytest-cov, doc-coverage, lint checks, and version extraction, then writes
SVG files: `coverage.svg`, `tests.svg`, `docs.svg`, `quality.svg`,
@@ -268,11 +318,10 @@ and waits 10s between attempts).
On failure, the `notify_failure` step creates a Gitea issue.
#### `vikunja`
**`vikunja` step**
Depends on `detect-type` and `release`. Skips for release commits. Updates
the Vikunja task after a merge using `python -m devx.ci.post_merge --git-sha
<sha>`:
Skips for automated commits. Updates the Vikunja task after a merge using
`python -m devx.ci.post_merge --git-sha <sha>`:
1. Extracts the task ID from the first line of the commit message
2. Marks the corresponding Vikunja task as done
@@ -280,26 +329,11 @@ the Vikunja task after a merge using `python -m devx.ci.post_merge --git-sha
On failure, the `notify_failure` step creates a Gitea issue.
#### `configure-repo`
**`publish` step**
Depends on `detect-type`. Skips for release commits. Ensures branch
protection and labels are configured using
`python -m devx.tools.configure_repo --repo <name> --owner <owner>`:
- Sets up master branch protection (required status checks, block on rejected
reviews, block on outdated branch)
- Creates standard labels
- Status check contexts read from `DEVX_STATUS_CHECKS` or default to
`CI / quality (pull_request)`
On failure, the `notify_failure` step creates a Gitea issue.
## Publish workflow (`publish.yml`)
Runs on tag pushes matching `v*`. Triggered by the `release` job in the
post-merge workflow when it creates and pushes a new version tag.
### Job: `publish`
Only runs if the `release` step created a tag. Builds and publishes the
package within the same `release-and-maintain` job (checks out the release
tag). Runs `python -m devx.ci.publish <tag> <owner/repo>`:
1. **Install dependencies** — build, twine, requests, python-dotenv, click,
and the project itself
@@ -518,25 +552,29 @@ The complete release process from PR to published package:
1. **PR merged**`auto-merge` squash-merges the PR to master with
`{PREFIX}-N <conventional commit>` title
2. **Post-merge triggers** — the merge push triggers `post-merge.yml`
3. **detect-type** — confirms the commit is not a release commit
4. **release**`release.py` calculates the next version, updates files,
runs tests, commits `release: vX.Y.Z [skip ci]`, creates tag `vX.Y.Z`,
and pushes to master
5. **Tag push triggers publish** — the tag push triggers `publish.yml`
6. **publish**`publish.py` builds the package, publishes to the Gitea PyPI
registry, and creates a Gitea release with git-cliff notes
7. **sync-wiki** — documentation is synced to the Gitea wiki
8. **badges** — quality badges are regenerated and pushed to the `badges`
branch; README and docs/index.md are updated with cache-busting URLs
9. **vikunja** — the corresponding Vikunja task is marked as done
10. **configure-repo** — branch protection and labels are ensured
3. **detect-and-configure** — detects release commit, validates commit
message, and ensures branch protection/labels
4. **release** (step in `release-and-maintain`) — `release.py` calculates
the next version, updates files, runs tests, commits
`release: vX.Y.Z [skip ci]`, creates tag `vX.Y.Z`, and pushes to master
5. **publish** (step in `release-and-maintain`) `publish.py` builds the
package, publishes to the Gitea PyPI registry, and creates a Gitea
release with git-cliff notes (checks out the release tag within the
same job)
6. **sync-wiki** (step in `release-and-maintain`) — documentation is synced
to the Gitea wiki
7. **vikunja** (step in `release-and-maintain`) — the corresponding Vikunja
task is marked as done
8. **badges** (step in `release-and-maintain`) — quality badges are
regenerated and pushed to the `badges` branch; README and docs/index.md
are updated with cache-busting URLs
The release commit's post-merge run skips all jobs except `badges` (which
The release commit's post-merge run skips all steps except `badges` (which
picks up the new version number). This prevents infinite loops.
## Failure handling
Every job in the post-merge and publish workflows has a `notify_failure` step
Every job in the CI and post-merge workflows has a `notify_failure` step
that runs `if: failure()`. This creates a Gitea issue with the workflow name,
run ID, and commit SHA, ensuring failures that would otherwise go unnoticed
in the Actions tab are surfaced as issues. The issue is created via the tea
+29
View File
@@ -334,6 +334,35 @@ devx tools check-test-speed --max-seconds 10
devx tools check-test-speed --max-seconds 4 --max-single-seconds 0.5
```
### `devx tools check-test-isolation`
Statically analyze test files for un-hermetic patterns that cause slow
or flaky tests. Also available as a **pytest plugin** (auto-discovered
via the `pytest11` entry point when devx is installed — runs
automatically on every `pytest` invocation).
Detected patterns:
- **unpatched-subprocess**: `subprocess.run/call/Popen/check_call/check_output`
called in a test function without `@patch`
- **unpatched-sleep**: `time.sleep` called without `@patch`
- **unpatched-helper**: known subprocess-spawning helpers (`update_doc_versions`,
`run_cmd`, `run_tests`) called without `@patch` or patching their internal deps
- **excessive-iterations**: `for _ in range(N)` where N > 100
```bash
devx tools check-test-isolation
devx tools check-test-isolation --test-path tests/ --strict
devx tools check-test-isolation --categories unpatched-subprocess,unpatched-sleep
devx tools check-test-isolation --max-loop-iterations 50
```
Pytest plugin options (automatic when devx is installed):
- `--strict-test-isolation` — fail the test run on violations
- `--no-test-isolation` — disable analysis for this run
- `--test-isolation-max-loop N` — max iterations per loop (default: 100)
### `devx tools configure-repo`
Configure repository: branch protection and labels via the Gitea REST API.
+2 -2
View File
@@ -48,12 +48,12 @@ Add devx to your `pyproject.toml`:
```toml
[project]
dependencies = [
"devx>=0.37.0",
"devx>=0.43.0",
]
[project.optional-dependencies]
dev = [
"devx>=0.37.0",
"devx>=0.43.0",
]
```
+11 -3
View File
@@ -1,7 +1,15 @@
#!/usr/bin/env bash
# pre-commit hook: fail if unit tests are too slow.
# Checks both total suite time (10s) and per-test time (0.5s).
# Aligned with CI (ci.yml uses same thresholds).
# pre-commit hook: fast local quality gates that shift-left CI checks.
# Runs test speed, translation completeness, and test isolation checks.
# All of these run in CI — failing here saves a round-trip.
set -e
export PYTHONPATH=src
# Test speed: total suite < 4s, individual tests < 0.5s
python3 -m devx.tools.check_test_speed --max-seconds 4 --max-single-seconds 0.5
# Translation completeness: missing keys, dead keys, missing languages
python3 -m devx.ci.check_translations
# Test isolation: unpatched subprocess/time.sleep in test functions
python3 -m devx.tools.check_test_isolation --test-path tests/
+27 -7
View File
@@ -25,6 +25,12 @@ dependencies = [
[project.scripts]
devx = "devx.cli:cli"
# Pytest plugin — auto-discovered by pytest when devx is installed.
# Runs static analysis on test files during every pytest invocation
# to detect un-hermetic patterns (unpatched subprocess, time.sleep, etc.)
[project.entry-points.pytest11]
devx_test_isolation = "devx.tools.check_test_isolation"
[tool.setuptools.dynamic]
version = {attr = "devx.__version__"}
@@ -37,7 +43,7 @@ ci = [
]
# Lint and type-checking tools (quality job, badge generation)
lint = [
"ruff==0.15.20",
"ruff==0.15.21",
"pyright==1.1.411",
"bandit==1.9.4",
"pip-audit==2.10.1",
@@ -45,20 +51,20 @@ lint = [
]
# Release tools (build + publish to PyPI/Gitea registry)
release = [
"build==1.5.0",
"build==1.5.1",
"twine==6.2.0",
]
# Molecule testing (for projects with Ansible roles)
molecule = [
"molecule==26.4.0",
"molecule==26.6.0",
"molecule-docker==2.1.0",
"ansible-lint==26.4.0",
"ansible-lint==26.6.0",
"ansible-core==2.21.1",
]
# Deploy tools (for infra staging/production deployments)
deploy = [
"ansible-core==2.21.1",
"boto3==1.43.36",
"boto3==1.43.37",
"docker==7.1.0",
"jinja2==3.1.6",
"pyyaml==6.0.3",
@@ -67,7 +73,7 @@ deploy = [
# Full dev environment (local development)
dev = [
"devx[ci,lint,release,molecule]",
"build==1.5.0",
"build==1.5.1",
"twine==6.2.0",
]
@@ -80,11 +86,25 @@ devx = ["translations.json", "make/*.mak"]
[tool.pytest.ini_options]
testpaths = ["tests"]
pythonpath = ["src"]
addopts = "--cov=src/devx --cov-report=term-missing --cov-fail-under=100"
addopts = "--cov=src/devx --cov-report=term-missing --cov-fail-under=100 -p no:devx_test_isolation"
markers = [
"integration: marks tests as integration tests (not counted in coverage)",
]
[tool.coverage.run]
# The test isolation pytest plugin (check_test_isolation.py) is loaded
# by pytest before coverage instrumentation starts. Coverage config below
# excludes decorator lines and pragma-marked code from the coverage check.
branch = false
[tool.coverage.report]
exclude_lines = [
"pragma: no cover",
"if __name__ == .__main__",
# Click decorator lines are executed at import time, before coverage
"@click\\.command|@click\\.option|@click\\.argument",
]
[tool.ruff]
target-version = "py312"
line-length = 120
+1 -1
View File
@@ -1,3 +1,3 @@
"""devx — reusable development and CI/CD tools for oblachno-oss projects."""
__version__ = "0.37.0"
__version__ = "0.43.0"
+12 -8
View File
@@ -17,10 +17,9 @@ This allows the PR title to be a human-friendly Vikunja task title
while the squashed commit follows conventional commits.
Usage:
CI_GITEA_TOKEN=<token> python3 -m devx.ci.auto_merge <branch> <pr_title> <repo> <pr_number>
CI_GITEA_API_TOKEN=<token> VIKUNJA_TOKEN=<token> python3 -m devx.ci.auto_merge <branch> <pr_title> <repo> <pr_number>
"""
import os
import re
from pathlib import Path
from typing import Any
@@ -40,6 +39,7 @@ from devx.config import (
)
from devx.exceptions import APIError
from devx.i18n import _
from devx.tokens import get_ci_token, get_vikunja_token
# 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*")
@@ -115,9 +115,12 @@ def get_vikunja_task_title(task_id: str) -> str:
Raises ClickException if VIKUNJA_TOKEN is not set or the task is not found.
"""
token = os.environ.get("VIKUNJA_TOKEN", "")
if not token:
raise click.ClickException(_("VIKUNJA_TOKEN is not set. This is required in CI to validate PR titles."))
try:
token = get_vikunja_token()
except click.ClickException:
raise click.ClickException(
_("VIKUNJA_TOKEN is not set. This is required in CI to validate PR titles.")
) from None
client = VikunjaClient(VIKUNJA_API_URL, token)
page = 1
while True:
@@ -197,9 +200,10 @@ def extract_conventional_msg(commits: list[dict[str, Any]]) -> str:
@click.argument("repo")
@click.argument("pr_number")
def main(branch: str, pr_title: str, repo: str, pr_number: str) -> None:
token = os.environ.get("CI_GITEA_TOKEN", "")
if not token:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
try:
token = get_ci_token()
except click.ClickException:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set.")) from None
# Validate PR number is an integer
try:
+39 -15
View File
@@ -15,7 +15,7 @@ Exit code 1 = NOT ready — fix issues before pushing.
Usage::
# CI (with VIKUNJA_TOKEN and CI_GITEA_TOKEN):
# CI (with VIKUNJA_TOKEN and CI_GITEA_API_TOKEN):
python3 -m devx.ci.check_auto_merge_ready \\
--branch "$HEAD_REF" \\
--pr-title "$PR_TITLE" \\
@@ -34,13 +34,12 @@ 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
mandatory.
If ``CI_GITEA_TOKEN`` is not set and ``--pr-number`` is not provided, only
If ``CI_GITEA_API_TOKEN`` is not set and ``--pr-number`` is not provided, only
branch-name and PR-title-format checks run (local mode).
"""
from __future__ import annotations
import os
import subprocess # nosec B404
import click
@@ -55,6 +54,7 @@ from devx.config import (
)
from devx.exceptions import APIError
from devx.i18n import _
from devx.tokens import get_ci_token, get_vikunja_token
load_dotenv()
@@ -99,10 +99,13 @@ def is_branch_behind_master(branch: str) -> bool:
def get_pr_title_from_gitea(repo: str, pr_number: int) -> str | None:
"""Fetch the PR title from the Gitea API.
Returns ``None`` if ``CI_GITEA_TOKEN`` is not set or the PR cannot be fetched.
Returns ``None`` if no token is set or the PR cannot be fetched.
"""
token = os.environ.get("CI_GITEA_TOKEN", "")
if not token or "/" not in repo:
try:
token = get_ci_token()
except click.ClickException:
return None
if "/" not in repo:
return None
owner, repo_name = repo.split("/", 1)
client = GiteaClient(GITEA_API_URL, token, owner, repo_name)
@@ -120,8 +123,9 @@ def get_vikunja_title_optional(task_id: str) -> str | None:
raise when ``VIKUNJA_TOKEN`` is missing it returns ``None`` so the
caller can skip the check in local mode.
"""
token = os.environ.get("VIKUNJA_TOKEN", "")
if not token:
try:
token = get_vikunja_token()
except click.ClickException:
return None
client = VikunjaClient(VIKUNJA_API_URL, token)
from devx.config import DEFAULT_PER_PAGE
@@ -221,7 +225,11 @@ def cli(
if not skip_vikunja:
vikunja_title = get_vikunja_title_optional(task_id)
if vikunja_title is None:
token_set = bool(os.environ.get("VIKUNJA_TOKEN", ""))
try:
get_vikunja_token()
token_set = True
except click.ClickException:
token_set = False
if token_set:
errors.append(
_(
@@ -233,17 +241,33 @@ def cli(
else:
click.echo("[pre-merge-check] WARNING: VIKUNJA_TOKEN not set — skipping Vikunja title match check.")
else:
expected = f"{task_id}: {vikunja_title}"
if pr_title != expected:
# Defensive check: warn if the Vikunja task title already includes
# the task ID prefix. The expected PR title is
# f"{task_id}: {vikunja_title}" — if vikunja_title already starts
# with "{task_id}:", the PR title will have a double prefix.
if vikunja_title.startswith(f"{task_id}:"):
errors.append(
_(
"PR title does not match Vikunja task title.\n Expected: {expected}\n Got: {title}",
expected=expected,
title=pr_title,
"Vikunja task title '{title}' starts with '{prefix}:'. "
"The task title should NOT include the '{prefix}' prefix — "
"it is automatically added to the PR title. "
"Update the Vikunja task title to remove the prefix.",
title=vikunja_title,
prefix=task_id,
),
)
else:
click.echo(f"[pre-merge-check] Vikunja title match OK: {expected}")
expected = f"{task_id}: {vikunja_title}"
if pr_title != expected:
errors.append(
_(
"PR title does not match Vikunja task title.\n Expected: {expected}\n Got: {title}",
expected=expected,
title=pr_title,
),
)
else:
click.echo(f"[pre-merge-check] Vikunja title match OK: {expected}")
# 6. Branch behind master (skip if --skip-behind-check)
if not skip_behind_check:
+6 -2
View File
@@ -31,6 +31,7 @@ import requests
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
from devx.i18n import _
from devx.tokens import get_ci_token
DEFAULT_MAX_RUNNERS = 3
@@ -96,7 +97,7 @@ def query_runners(api_url: str, token: str, owner: str, repo: str) -> int:
return total
def get_runner_count(api_url: str, token: str, owner: str, repo: str) -> int:
def get_runner_count(api_url: str, token: str | None, owner: str, repo: str) -> int:
"""Determine the number of available runners.
Tries the Gitea API first, then falls back to env vars, then default.
@@ -152,7 +153,10 @@ def main(
output_indices: bool,
github_output: bool,
) -> None:
token = os.environ.get("CI_GITEA_TOKEN", "")
try:
token = get_ci_token()
except click.ClickException:
token = None
if owner is None:
owner = os.environ.get("DEVX_REPO_OWNER", "") or REPO_OWNER
+6 -2
View File
@@ -17,7 +17,7 @@ Usage::
Environment variables:
GITEA_URL Base URL of the Gitea instance.
CI_GITEA_TOKEN API token with repo access.
CI_GITEA_API_TOKEN API token with repo access (CI_GITEA_TOKEN accepted for legacy).
RUN_ID Workflow run ID (GITHUB_RUN_ID).
JOB_NAME Base job name (GITHUB_JOB), e.g. "integration-tests".
MATRIX_INDEX Current matrix index (runner-index).
@@ -41,6 +41,7 @@ from devx.i18n import _
from devx.molecule.molecule_ci_guard import (
poll_for_other_failures,
)
from devx.tokens import get_ci_token
POLL_INTERVAL = 10
@@ -50,7 +51,10 @@ POLL_INTERVAL = 10
def cli(pytest_args: tuple[str, ...]) -> None:
"""Run pytest with cross-runner failure detection."""
gitea_url = os.environ.get("GITEA_URL", "")
token = os.environ.get("CI_GITEA_TOKEN", "")
try:
token = get_ci_token()
except click.ClickException:
token = None
run_id = int(os.environ.get("RUN_ID", "0"))
job_name = os.environ.get("JOB_NAME", "integration-tests")
current_index = int(os.environ.get("MATRIX_INDEX", "0"))
+7 -6
View File
@@ -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.
Usage:
CI_GITEA_TOKEN=<token> python3 -m devx.ci.notify_failure \
CI_GITEA_API_TOKEN=<token> python3 -m devx.ci.notify_failure \
--repo <owner/repo> \
--run-id <run_id> \
--workflow <workflow_name> \
@@ -14,14 +14,13 @@ Usage:
--auto-login
With ``--auto-login``, the script configures the tea CLI login profile
from ``CI_GITEA_TOKEN`` and ``DEVX_GITEA_API_URL`` before creating the issue,
from the CI API token and ``DEVX_GITEA_API_URL`` before creating the issue,
eliminating the need for a separate ``tea login add`` step in the workflow.
"""
from __future__ import annotations
import logging
import os
import click
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
@@ -29,6 +28,7 @@ from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnk
from devx.config import GITEA_API_URL
from devx.gitea_cli import TeaCLI, TeaCLIError, configure_tea_login
from devx.i18n import _
from devx.tokens import get_ci_token
load_dotenv()
@@ -74,9 +74,10 @@ def _create_issue_via_tea(repo: str, title: str, body: str) -> int:
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:
token = os.environ.get("CI_GITEA_TOKEN", "")
if not token:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
try:
get_ci_token()
except click.ClickException:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set.")) from None
if auto_login:
configure_tea_login()
+5 -4
View File
@@ -5,7 +5,6 @@ Usage:
VIKUNJA_TOKEN=<token> python3 -m devx.ci.post_merge <commit_msg> [--commit-sha <sha>]
"""
import os
import re
import subprocess # nosec B404
@@ -17,6 +16,7 @@ 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.i18n import _
from devx.tokens import get_vikunja_token
load_dotenv()
@@ -127,9 +127,10 @@ def main(commit_msg: str | None, commit_sha: str, from_git: bool, git_sha: str)
commit_sha = _get_git_commit_sha()
if not commit_msg:
raise click.ClickException("commit_msg argument is required (or use --from-git or --git-sha)")
token = os.environ.get("VIKUNJA_TOKEN", "")
if not token:
raise click.ClickException(_("ERROR: VIKUNJA_TOKEN is not set."))
try:
token = get_vikunja_token()
except click.ClickException:
raise click.ClickException(_("ERROR: VIKUNJA_TOKEN is not set.")) from None
task_id = extract_task_id(commit_msg)
if not task_id:
+38 -8
View File
@@ -17,7 +17,7 @@ Checks performed:
8. Commit conventions conventional commit format on branch commits
Usage:
CI_GITEA_TOKEN=<token> python3 -m devx.ci.pr_review <pr_number> <owner/repo>
CI_GITEA_API_TOKEN=<token> [REVIEWER_GITEA_API_TOKEN=<token>] python3 -m devx.ci.pr_review <pr_number> <owner/repo>
"""
from __future__ import annotations
@@ -34,6 +34,7 @@ from devx.api_clients import GiteaClient
from devx.config import GITEA_API_URL
from devx.exceptions import APIError
from devx.i18n import _
from devx.tokens import get_ci_token, get_reviewer_token
load_dotenv()
@@ -548,8 +549,14 @@ def _post_manual_review(
checklist_confirmed: bool,
checklist_categories: str | None,
dry_run: bool,
owner: str | None = None,
repo_name: str | None = None,
) -> None:
"""Post a manual review with validation for APPROVE events."""
"""Post a manual review with validation for APPROVE events.
When self-approval is rejected (reviewer token belongs to PR author),
falls back to the CI token (different user) if available.
"""
if not body or len(body) < 50:
raise click.ClickException(_("Review body must be at least 50 characters."))
@@ -585,8 +592,20 @@ def _post_manual_review(
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)
# Self-approval not allowed (reviewer token belongs to PR author).
# Fall back to CI token (different user) if available.
ci_token = os.environ.get("CI_GITEA_API_TOKEN", "").strip()
if ci_token and owner and repo_name:
click.echo(_("Note: Self-approval not allowed with reviewer token. Retrying with CI token."))
ci_client = GiteaClient(GITEA_API_URL, ci_token, owner, repo_name)
try:
review = ci_client.create_review(pr_number, event=event, body=body)
except APIError:
click.echo(_("Note: CI token also cannot approve. Posting COMMENT instead."))
review = client.create_review(pr_number, event="COMMENT", body=body)
else:
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", "?")
@@ -636,15 +655,26 @@ def main(
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:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
try:
token = get_reviewer_token() if (event and event.upper() == "APPROVE") else get_ci_token()
except click.ClickException:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set.")) from None
owner, repo_name = repo.split("/")
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)
_post_manual_review(
client,
pr_number,
event.upper(),
body,
checklist_confirmed,
checklist_categories,
dry_run,
owner=owner,
repo_name=repo_name,
)
return
result = run_review(client, pr_number)
+8 -6
View File
@@ -9,14 +9,14 @@ Publishing destinations (checked in order):
``DEVX_PYPI_REGISTRY_URL`` env var is set, or ``GITEA_API_URL``
is converted to a packages URL). Uses ``twine upload
--repository-url <url> -u <token> -p <token>`` with the
``CI_GITEA_TOKEN`` as both username and password.
CI API token as both username and password.
2. **Standard PyPI** if ``PYPI_TOKEN`` is set. Uses the standard
``twine upload -u __token__ -p <token>`` flow.
3. **Skip** if neither is configured, only the Gitea release is created.
Usage:
CI_GITEA_TOKEN=<token> [PYPI_TOKEN=<token>] python3 -m devx.ci.publish <tag> <repo>
CI_GITEA_TOKEN=<token> python3 -m devx.ci.publish <tag> <repo> --registry-url https://git.example.com/api/packages/owner/pypi
CI_GITEA_API_TOKEN=<token> [PYPI_TOKEN=<token>] python3 -m devx.ci.publish <tag> <repo>
CI_GITEA_API_TOKEN=<token> python3 -m devx.ci.publish <tag> <repo> --registry-url https://git.example.com/api/packages/owner/pypi
"""
import os
@@ -31,6 +31,7 @@ from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnk
from devx.config import GITEA_API_URL, REPO_OWNER
from devx.gitea_cli import TeaCLI, TeaCLIError, configure_tea_login
from devx.i18n import _
from devx.tokens import get_ci_token
load_dotenv()
@@ -253,9 +254,10 @@ def main(
if not tag:
raise click.ClickException(_("Tag is required (or use --from-tag)."))
gitea_token = os.environ.get("CI_GITEA_TOKEN", "")
if not gitea_token:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
try:
gitea_token = get_ci_token()
except click.ClickException:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set.")) from None
pypi_token = os.environ.get("PYPI_TOKEN", "")
+48
View File
@@ -0,0 +1,48 @@
#!/usr/bin/env python3
"""Record the deployed git tag for a given environment.
Writes the tag to a Gitea repository variable so it can be queried
later via the Gitea API or ``devx.ci.get_deployed_tag``.
Usage::
python -m devx.ci.record_deployed_tag --env production --tag v0.28.1
python -m devx.ci.record_deployed_tag --env staging --tag master-abc1234
"""
from __future__ import annotations
import sys
import click
from devx.api_clients import GiteaClient
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
from devx.i18n import _
from devx.tokens import get_ci_token
@click.command()
@click.option(
"--env",
"env_name",
type=click.Choice(["staging", "production"]),
required=True,
)
@click.option("--tag", required=True, help=_("Git tag or ref that was deployed"))
def main(env_name: str, tag: str) -> None:
"""Record the deployed tag for the given environment."""
try:
token = get_ci_token()
except click.ClickException as exc:
click.echo(f"Error: {exc.message}", err=True)
sys.exit(1)
var_name = f"{env_name.upper()}_DEPLOY_TAG"
client = GiteaClient(GITEA_API_URL, token, REPO_OWNER, REPO_NAME)
client.set_repo_variable(var_name, tag)
click.echo(f"Recorded {var_name} = {tag}")
if __name__ == "__main__": # pragma: no cover
main()
+1 -1
View File
@@ -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.
Usage:
CI_GITEA_TOKEN=<token> python3 -m devx.ci.release [--dry-run] [--skip-tests]
CI_GITEA_API_TOKEN=<token> python3 -m devx.ci.release [--dry-run] [--skip-tests]
python3 -m devx.ci.release --verify # Check tag/version/release alignment
"""
+6 -4
View File
@@ -21,7 +21,7 @@ Link transformations:
- Anchor-only links (``#section``) are preserved
Usage:
CI_GITEA_TOKEN=<token> python3 -m devx.ci.sync_wiki [--dry-run] [--repo owner/repo]
CI_GITEA_API_TOKEN=<token> python3 -m devx.ci.sync_wiki [--dry-run] [--repo owner/repo]
"""
from __future__ import annotations
@@ -40,6 +40,7 @@ from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnk
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
from devx.i18n import _
from devx.tokens import get_ci_token
load_dotenv()
@@ -274,9 +275,10 @@ def commit_and_push(wiki_dir: Path, wiki_url: str, dry_run: bool) -> bool:
)
def main(dry_run: bool, repo: str | None, verify: bool) -> None:
"""Sync documentation to the Gitea wiki via Git."""
token = os.environ.get("CI_GITEA_TOKEN", "")
if not token:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
try:
token = get_ci_token()
except click.ClickException:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set.")) from None
if repo is None:
owner = os.environ.get("DEVX_REPO_OWNER", "") or REPO_OWNER
+85
View File
@@ -0,0 +1,85 @@
#!/usr/bin/env python3
"""Resolve and validate the git tag to deploy.
Shared between staging and production deployments. Ensures a concrete
git tag is used never a moving branch ref so deployments are
reproducible and rollback-friendly.
Usage in workflows::
# Production (tag required)
python -m devx.ci.validate_deploy_ref --tag "$TAG" --github-output
# Staging force-deploy (tag required)
python -m devx.ci.validate_deploy_ref --tag "$TAG" --github-output
# Staging PR-triggered (PR SHA is already concrete, no tag needed)
python -m devx.ci.validate_deploy_ref --allow-empty --github-output
Writes ``deploy-ref=<tag>`` to ``$GITHUB_OUTPUT`` when ``--github-output``
is passed, otherwise prints the ref to stdout.
"""
from __future__ import annotations
import os
import subprocess # nosec B404
import sys
import click
from devx.i18n import _
@click.command()
@click.option("--tag", default="", help=_("Git tag to deploy (e.g. v0.28.1)."))
@click.option(
"--allow-empty",
is_flag=True,
help=_("Allow empty tag (PR mode where SHA is concrete)."),
)
@click.option(
"--github-output",
is_flag=True,
help=_("Write deploy-ref to $GITHUB_OUTPUT file."),
)
def main(tag: str, allow_empty: bool, github_output: bool) -> None:
"""Resolve and validate the deploy ref, exiting non-zero on failure."""
if not tag:
if not allow_empty:
click.echo(
"::error::No tag specified. Deployments require a concrete git tag "
"(e.g. v0.28.1). Use --allow-empty only for PR-triggered staging deploys "
"where the checkout SHA is already concrete.",
err=True,
)
sys.exit(1)
ref = ""
click.echo("No tag specified — using checkout ref (PR mode).")
else:
result = subprocess.run( # nosec B603, B607
["git", "rev-parse", "-q", "--verify", f"refs/tags/{tag}"],
capture_output=True,
text=True,
check=False,
)
if result.returncode != 0:
click.echo(f"::error::Tag '{tag}' does not exist in the repository.", err=True)
sys.exit(1)
ref = tag
commit = result.stdout.strip()[:8]
click.echo(f"Deploying tag: {tag} (commit {commit})")
if github_output:
github_output_path = os.environ.get("GITHUB_OUTPUT")
if not github_output_path:
click.echo("::error::GITHUB_OUTPUT environment variable not set.", err=True)
sys.exit(1)
with open(github_output_path, "a") as f:
f.write(f"deploy-ref={ref}\n")
else:
click.echo(ref)
if __name__ == "__main__": # pragma: no cover
main()
+6 -5
View File
@@ -40,7 +40,6 @@ Usage::
from __future__ import annotations
import json
import os
import shutil
import subprocess # nosec B404
from typing import Any
@@ -49,6 +48,7 @@ import click
from devx.config import GITEA_API_URL
from devx.i18n import _
from devx.tokens import get_ci_token
class TeaCLIError(Exception):
@@ -56,10 +56,10 @@ class TeaCLIError(Exception):
def configure_tea_login(login_name: str = "devx") -> None:
"""Configure tea CLI login from CI_GITEA_TOKEN and DEVX_GITEA_API_URL.
"""Configure tea CLI login from CI_GITEA_API_TOKEN and DEVX_GITEA_API_URL.
Idempotent: if a login with the same name already exists, it is not re-added.
Skips silently if tea is not installed or CI_GITEA_TOKEN is not set.
Skips silently if tea is not installed or no token is set.
Used by CI scripts (publish, notify_failure) that need tea login but
run in containerized environments where ``make setup`` was not called.
@@ -69,8 +69,9 @@ def configure_tea_login(login_name: str = "devx") -> None:
click.echo(_("tea not installed — skipping login configuration."))
return
token = os.environ.get("CI_GITEA_TOKEN", "")
if not token:
try:
token = get_ci_token()
except click.ClickException:
click.echo(_("CI_GITEA_TOKEN not set — skipping login configuration."))
return
+27 -11
View File
@@ -61,10 +61,12 @@ DEVX_VALE_LEVEL ?= warning
# Usage: $(DEVX_PIP_INSTALL) install -e '.[ci,lint]'
# CI_GITEA_USERNAME can be set in .env, as an env var, or as a Make variable.
# Projects can alias: PIP_INSTALL = $(DEVX_PIP_INSTALL)
DEVX_PIP_INSTALL := if [ -z "$$CI_GITEA_TOKEN" ]; then . ./.env 2>/dev/null; fi; \
CI_GITEA_TOKEN="$$CI_GITEA_TOKEN"; \
DEVX_PIP_INSTALL := if [ -z "$$CI_GITEA_API_TOKEN" ] && [ -z "$$DEVELOPER_GITEA_API_TOKEN" ] && [ -z "$$CI_GITEA_TOKEN" ]; then . ./.env 2>/dev/null; fi; \
_TOKEN="$$CI_GITEA_API_TOKEN"; \
[ -z "$$_TOKEN" ] && _TOKEN="$$DEVELOPER_GITEA_API_TOKEN"; \
[ -z "$$_TOKEN" ] && _TOKEN="$$CI_GITEA_TOKEN"; \
_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; \
if [ -n "$$_TOKEN" ] && [ -n "$$_PYPI_USER" ]; then export PIP_EXTRA_INDEX_URL="https://$$_PYPI_USER:$$_TOKEN@$(DEVX_GITEA_PYPI_HOST)/api/packages/$(DEVX_GITEA_PYPI_ORG)/pypi/simple/"; fi; \
$(DEVX_BIN)/pip
# ── Virtual environment management ────────────────────────────────────────────
@@ -113,7 +115,7 @@ devx-ensure-venv:
.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-clean devx-pre-push
.PHONY: devx-check-mutable-globals devx-check-dep-docs devx-check-test-coverage devx-check-docs devx-check-test-speed devx-check-doc-versions devx-vale
.PHONY: devx-check-mutable-globals devx-check-dep-docs devx-check-test-coverage devx-check-docs devx-check-test-speed devx-check-test-isolation devx-check-translations devx-check-doc-versions devx-vale
.PHONY: devx-check-api-identity-checks devx-setup-ssh-key
.PHONY: devx-test-unit devx-pytest-cov
.PHONY: devx-setup-image devx-lint-dockerfiles
@@ -196,12 +198,14 @@ devx-pr-rebase:
# ── Environment setup ─────────────────────────────────────────────────────────
# Configure Gitea private PyPI registry so pip can find devx and other
# private packages. In CI, CI_GITEA_TOKEN is set as a secret. Locally, it's in .env.
# private packages. In CI, CI_GITEA_API_TOKEN is set as a secret. Locally, DEVELOPER_GITEA_API_TOKEN or CI_GITEA_TOKEN can be used.
devx-configure-gitea-pypi:
@if [ -z "$$CI_GITEA_TOKEN" ]; then . ./.env 2>/dev/null; fi; \
CI_GITEA_TOKEN="$$CI_GITEA_TOKEN"; \
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 (CI_GITEA_TOKEN present)."
@if [ -z "$$CI_GITEA_API_TOKEN" ] && [ -z "$$DEVELOPER_GITEA_API_TOKEN" ] && [ -z "$$CI_GITEA_TOKEN" ]; then . ./.env 2>/dev/null; fi; \
_TOKEN="$$CI_GITEA_API_TOKEN"; \
[ -z "$$_TOKEN" ] && _TOKEN="$$DEVELOPER_GITEA_API_TOKEN"; \
[ -z "$$_TOKEN" ] && _TOKEN="$$CI_GITEA_TOKEN"; \
if [ -z "$$_TOKEN" ]; then echo "[configure-gitea-pypi] Gitea API token not set — skipping (devx must be on public PyPI)"; exit 0; fi; \
echo "[configure-gitea-pypi] Gitea PyPI registry configured (token present)."
# Create .env from .env.example if it doesn't exist
devx-env:
@@ -268,7 +272,7 @@ devx-workflow-check: devx-workflow-lint devx-workflow-dryrun
# Notify on CI failure — creates a Gitea issue via devx.ci.notify_failure.
# Usage: make devx-notify-failure WORKFLOW=post-merge/release
# Requires: CI_GITEA_TOKEN, GITHUB_REPOSITORY, GITHUB_RUN_ID, GITHUB_SHA
# Requires: CI_GITEA_API_TOKEN, GITHUB_REPOSITORY, GITHUB_RUN_ID, GITHUB_SHA
devx-notify-failure:
@. $(DEVX_VENV)/bin/activate 2>/dev/null || true; \
export PATH="$(HOME)/.local/bin:$$PATH"; \
@@ -299,7 +303,7 @@ devx-lint-deps:
@PIPAPI_PYTHON_LOCATION=$$(pwd)/$(DEVX_VENV)/bin/python \
$(DEVX_BIN)/pip-audit --desc --skip-editable 2>&1 || true
devx-lint: devx-lint-ruff devx-lint-format devx-typecheck devx-lint-bandit
devx-lint: devx-lint-ruff devx-lint-format devx-typecheck devx-lint-bandit devx-check-translations devx-check-test-isolation
@echo "[devx-lint] Linting checks passed."
# ── Testing ───────────────────────────────────────────────────────────────────
@@ -377,6 +381,18 @@ devx-vale:
devx-check-test-speed:
@$(DEVX_PYTHON) -m devx.tools.check_test_speed
# Check test files for un-hermetic patterns (unpatched subprocess, time.sleep, etc.)
# This is also automatically enforced by the pytest plugin (pytest11 entry point).
# Use this target for CI gates or pre-commit hooks.
devx-check-test-isolation:
@$(DEVX_PYTHON) -m devx.tools.check_test_isolation $(addprefix --test-path ,$(DEVX_TEST_PATHS))
# Check translation files for missing keys, dead keys, and missing languages.
# Runs automatically as part of devx-lint to shift-left translation issues
# (fail locally instead of in CI).
devx-check-translations:
@$(DEVX_PYTHON) -m devx.ci.check_translations
# Scan integration tests for unsafe is True/is False identity checks
devx-check-api-identity-checks:
@$(DEVX_PYTHON) -m devx.tools.check_api_identity_checks
+6 -2
View File
@@ -30,6 +30,7 @@ import click
import requests
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
from devx.tokens import get_ci_token
DEFAULT_MAX_RUNNERS = 3
@@ -86,7 +87,7 @@ def query_runners(api_url: str, token: str, owner: str, repo: str) -> int:
return total
def get_runner_count(api_url: str, token: str, owner: str, repo: str) -> int:
def get_runner_count(api_url: str, token: str | None, owner: str, repo: str) -> int:
"""Determine the number of available runners.
Tries the Gitea API first, then falls back to env vars, then default.
@@ -142,7 +143,10 @@ def main(
output_indices: bool,
github_output: bool,
) -> None:
token = os.environ.get("CI_GITEA_TOKEN", "")
try:
token = get_ci_token()
except click.ClickException:
token = None
if owner is None:
owner = os.environ.get("DEVX_REPO_OWNER", "") or REPO_OWNER
+17 -3
View File
@@ -30,10 +30,24 @@ from devx.i18n import _
from devx.molecule.platforms import PLATFORMS, load_platforms
DEFAULT_MAX_RUNNERS = 3
MOLECULE_ROOT = Path("ansible/roles/gitea-runner/molecule")
DEFAULT_ROLES_ROOT = Path("ansible/roles")
def _default_molecule_root() -> Path:
"""Auto-discover the single molecule directory under ansible/roles/.
If exactly one role has a molecule/ subdirectory, return it.
Otherwise, fall back to the first role with a molecule/ directory.
"""
roles_root = DEFAULT_ROLES_ROOT
if not roles_root.is_dir():
return roles_root / "gitea_runner" / "molecule" # sensible default for error message
mol_dirs = sorted(d / "molecule" for d in roles_root.iterdir() if (d / "molecule").is_dir())
if mol_dirs:
return mol_dirs[0]
return roles_root / "molecule" # will produce a clear "not found" error
@dataclass(frozen=True)
class TestPair:
"""A (scenario, platform) combination to test."""
@@ -83,7 +97,7 @@ class MultiRoleTestPair:
def discover_scenarios(root: Path | None = None) -> list[str]:
"""Return sorted list of molecule scenario directory names."""
if root is None:
root = MOLECULE_ROOT
root = _default_molecule_root()
if not root.is_dir():
raise click.ClickException(_("Molecule directory not found: {path}", path=str(root)))
scenarios = [d.name for d in root.iterdir() if d.is_dir() and not d.name.startswith("_") and d.name != "common"]
@@ -318,7 +332,7 @@ def _write_github_env(key: str, value: str) -> None:
"--molecule-root",
type=click.Path(exists=True, file_okay=False, path_type=Path),
default=None,
help="Custom molecule directory (single-role mode). Default: ansible/roles/gitea-runner/molecule.",
help="Custom molecule directory (single-role mode). Default: auto-discovered under ansible/roles/*/molecule.",
)
@click.option(
"--roles-root",
+18 -4
View File
@@ -21,7 +21,20 @@ import click
from devx.molecule.platforms import PLATFORMS
ROLE_DIR = Path("ansible/roles/gitea-runner")
DEFAULT_ROLES_ROOT = Path("ansible/roles")
def _default_role_dir() -> Path:
"""Auto-discover the single role directory with molecule scenarios."""
roles_root = DEFAULT_ROLES_ROOT
if not roles_root.is_dir():
return roles_root / "gitea_runner" # sensible default for error message
role_dirs = sorted(d for d in roles_root.iterdir() if (d / "molecule").is_dir())
if role_dirs:
return role_dirs[0]
return roles_root / "role" # will produce a clear error
SCENARIOS = ["default", "multi-instance", "lifecycle", "template-content", "deregister", "update"]
@@ -72,15 +85,16 @@ def main(bin_dir: str) -> None:
if not Path(molecule_bin).exists():
raise click.ClickException(f"molecule not found at {molecule_bin}. Run 'make setup' first.")
if not ROLE_DIR.exists():
raise click.ClickException(f"Role directory not found: {ROLE_DIR}")
role_dir = _default_role_dir()
if not role_dir.exists():
raise click.ClickException(f"Role directory not found: {role_dir}")
base_env = dict(os.environ)
base_env["ANSIBLE_ALLOW_BROKEN_CONDITIONALS"] = "true"
base_env["ANSIBLE_INJECT_INVOCATION"] = "1"
for platform in PLATFORMS:
rc = _run_platform(molecule_bin, platform, ROLE_DIR, SCENARIOS, base_env)
rc = _run_platform(molecule_bin, platform, role_dir, SCENARIOS, base_env)
if rc != 0:
click.echo(f"FAILED on platform {platform['name']}", err=True)
sys.exit(rc)
+14 -4
View File
@@ -22,7 +22,7 @@ Usage::
Environment variables:
GITEA_URL Base URL of the Gitea instance.
CI_GITEA_TOKEN API token with repo access.
CI_GITEA_API_TOKEN API token with repo access (CI_GITEA_TOKEN accepted for legacy).
RUN_ID Workflow run ID (GITHUB_RUN_ID).
JOB_NAME Base job name (GITHUB_JOB), e.g. "molecule-tests".
MATRIX_INDEX Current matrix index (runner-index).
@@ -45,6 +45,7 @@ import requests
from devx.config import REPO_NAME, REPO_OWNER
from devx.i18n import _
from devx.tokens import get_ci_token
POLL_INTERVAL = 10
@@ -144,13 +145,19 @@ def resolve_role_dir(role: str, roles_root: Path | None, repo_root: Path) -> Pat
"""Resolve the working directory for a molecule pair.
For multi-role pairs (role non-empty), uses ``roles_root/role``.
For single-role pairs, uses ``repo_root/ansible/roles/gitea-runner``.
For single-role pairs, auto-discovers the first role with a molecule/
subdirectory under ``repo_root/ansible/roles/``.
"""
if role:
if roles_root is None:
roles_root = repo_root / "ansible" / "roles"
return roles_root / role
return repo_root / "ansible" / "roles" / "gitea-runner"
roles_dir = repo_root / "ansible" / "roles"
if roles_dir.is_dir():
role_dirs = sorted(d for d in roles_dir.iterdir() if (d / "molecule").is_dir())
if role_dirs:
return role_dirs[0]
return roles_dir / "role" # will produce a clear "not found" error
@click.command()
@@ -164,7 +171,10 @@ def resolve_role_dir(role: str, roles_root: Path | None, repo_root: Path) -> Pat
def cli(pairs: tuple[str, ...], roles_root: Path | None) -> None:
"""Run molecule pairs sequentially, stop if another CI runner fails."""
gitea_url = os.environ.get("GITEA_URL", "")
token = os.environ.get("CI_GITEA_TOKEN", "")
try:
token = get_ci_token()
except click.ClickException:
token = None
run_id = int(os.environ.get("RUN_ID", "0"))
job_name = os.environ.get("JOB_NAME", "molecule-tests")
current_index = int(os.environ.get("MATRIX_INDEX", "0"))
+76
View File
@@ -0,0 +1,76 @@
"""Token resolution helpers for devx tools.
Centralizes Gitea/Vikunja token discovery with role-based environment
variable names and backwards compatibility with the legacy
``CI_GITEA_TOKEN`` / ``REVIEW_GITEA_TOKEN`` naming convention.
Roles:
- ``CI_GITEA_API_TOKEN``: CI workflows (read actions, post status, merge, etc.)
- ``REVIEWER_GITEA_API_TOKEN``: PR approval reviews (must be a different user
from the PR author for Gitea to accept the review as an approval)
- ``DEVELOPER_GITEA_API_TOKEN``: local development tools (create-task,
create-pr, setup, etc.)
Fallbacks:
- New role names are checked first.
- Legacy names (``CI_GITEA_TOKEN``, ``REVIEW_GITEA_TOKEN``) are accepted for
backwards compatibility.
- If no role-specific token is set, the generic CI tokens are tried last.
"""
from __future__ import annotations
import os
import click
from devx.i18n import _
# Token environment variable names, in lookup priority order.
CI_TOKEN_NAMES = ["CI_GITEA_API_TOKEN", "CI_GITEA_TOKEN"]
REVIEWER_TOKEN_NAMES = [
"REVIEWER_GITEA_API_TOKEN",
# Legacy name used before role-based tokens.
"REVIEW_GITEA_TOKEN",
*CI_TOKEN_NAMES,
]
DEVELOPER_TOKEN_NAMES = ["DEVELOPER_GITEA_API_TOKEN", *CI_TOKEN_NAMES]
VIKUNJA_TOKEN_NAMES = ["VIKUNJA_TOKEN"]
def get_token(*names: str) -> str:
"""Return the first non-empty value from the listed environment variables.
Raises a ``click.ClickException`` if none of the listed variables are set.
"""
for name in names:
token = os.environ.get(name, "").strip()
if token:
return token
raise click.ClickException(
_(
"Gitea API token not set. Set one of: {names}",
names=", ".join(names),
)
)
def get_ci_token() -> str:
"""Resolve the CI Gitea API token."""
return get_token(*CI_TOKEN_NAMES)
def get_reviewer_token() -> str:
"""Resolve the reviewer Gitea API token used for PR approvals."""
return get_token(*REVIEWER_TOKEN_NAMES)
def get_developer_token() -> str:
"""Resolve the developer Gitea API token used for local tooling."""
return get_token(*DEVELOPER_TOKEN_NAMES)
def get_vikunja_token() -> str:
"""Resolve the Vikunja API token."""
return get_token(*VIKUNJA_TOKEN_NAMES)
+5 -2
View File
@@ -8,6 +8,8 @@ import subprocess # nosec B404
import click
from devx.tokens import get_developer_token
def arch_string() -> str:
"""Return the architecture string used by release assets.
@@ -45,8 +47,9 @@ def detect_pr_number() -> int | None:
if branch == "HEAD":
return None
token = os.environ.get("CI_GITEA_TOKEN", "")
if not token:
try:
token = get_developer_token()
except click.ClickException:
return None
owner = os.environ.get("DEVX_REPO_OWNER", "")
+8 -4
View File
@@ -34,8 +34,8 @@ The manifest file is a JSON list of dicts, each with:
- ``context``: build context directory (optional, defaults to repo root)
- ``tags``: list of tags (optional, defaults to ``["latest"]``)
Registry authentication uses ``CI_GITEA_TOKEN`` and ``CI_GITEA_USERNAME``
environment variables, matching the existing CI workflow patterns.
Registry authentication uses ``CI_GITEA_API_TOKEN`` (or legacy ``CI_GITEA_TOKEN``)
and ``CI_GITEA_USERNAME`` environment variables, matching the existing CI workflow patterns.
"""
from __future__ import annotations
@@ -49,6 +49,7 @@ from pathlib import Path
import click
from devx.i18n import _
from devx.tokens import get_developer_token
@dataclass
@@ -221,9 +222,12 @@ def push_image(
def _get_registry_creds() -> tuple[str, str]:
"""Get registry credentials from environment variables."""
token = os.environ.get("CI_GITEA_TOKEN", "")
try:
token = get_developer_token()
except click.ClickException:
token = None
username = os.environ.get("CI_GITEA_USERNAME", "")
return username, token
return username, token or ""
@click.command()
+597
View File
@@ -0,0 +1,597 @@
#!/usr/bin/env python3
"""Static analysis to detect un-hermetic test patterns that cause slow or flaky tests.
This module is used in two ways:
1. **As a pytest plugin** (automatic no configuration needed):
When devx is installed, pytest auto-discovers this plugin via the
``pytest11`` entry point. Every ``pytest`` run statically analyzes
test files for patterns that cause slow, non-deterministic, or
non-hermetic tests and reports violations as warnings.
To promote warnings to errors (fail the test run), add to pyproject.toml::
[tool.pytest.ini_options]
filterwarnings = ["error:Test isolation:UserWarning"]
Or use the ``--strict-test-isolation`` flag on the command line.
2. **As a standalone CLI** (for CI gates)::
python3 -m devx.tools.check_test_isolation [--test-path tests/]
python3 -m devx.tools.check_test_isolation --strict
Patterns detected:
1. **Unpatched subprocess calls** test functions that call
``subprocess.run/call/Popen/check_call/check_output`` without a
corresponding ``@patch`` decorator.
2. **Unpatched ``time.sleep``** test functions that call ``time.sleep``
without patching it.
3. **Unpatched known-subprocess-helpers** functions known to spawn
subprocesses (e.g. ``update_doc_versions``) called without patching.
4. **Unpatched I/O functions** functions known to do filesystem or
network I/O (e.g. ``get_pat``, ``load_secrets``, ``requests.get``)
called without patching.
5. **Excessive iteration loops** ``for _ in range(N)`` where N > 100.
"""
from __future__ import annotations
import ast
import sys
from dataclasses import dataclass, field
from pathlib import Path
import click
from devx.i18n import _
# ── Configuration ─────────────────────────────────────────────────────────────
DEFAULT_MAX_LOOP_ITERATIONS = 100
# Functions known to spawn subprocesses. When a test calls any of these
# without patching them, the real subprocess runs.
# Maps function name → human-readable description.
KNOWN_SUBPROCESS_HELPERS: dict[str, str] = {
"update_doc_versions": "calls subprocess.run to run check_doc_versions --fix",
"run_tests": "calls run_cmd to run make lint-ruff and make pytest-cov",
"run_cmd": "calls subprocess.run for shell commands",
}
# Functions known to do filesystem or network I/O that should be mocked in tests.
# Maps function name → description of what I/O it does.
# If a test calls one of these without a corresponding @patch, it's a violation.
KNOWN_IO_FUNCTIONS: dict[str, str] = { # nosec B105 — descriptions, not passwords
"get_pat": "reads ZITADEL PAT from filesystem/env (ZitadelAuth._iter_sources)",
"load_secrets": "reads YAML config file from disk",
"get_customer_secret": "reads customer-specific config from disk",
"get_customer_vm_ip": "queries Hetzner Cloud API for VM IP (network I/O)",
"get_observability_vm_ip": "queries Hetzner Cloud API for observability VM IP (network I/O)",
"requests.get": "performs HTTP GET to a real server",
"requests.post": "performs HTTP POST to a real server",
"requests.put": "performs HTTP PUT to a real server",
"requests.patch": "performs HTTP PATCH to a real server",
"requests.delete": "performs HTTP DELETE to a real server",
"urlopen": "performs HTTP request to a real server",
"httpx.get": "performs HTTP GET to a real server",
"httpx.post": "performs HTTP POST to a real server",
}
# Transitive dependencies: if a helper calls another helper that is patched,
# the call is safe. Maps helper → set of function names it internally calls.
# If ANY of these are in the test's patches, the helper call is safe.
HELPER_INTERNAL_CALLS: dict[str, set[str]] = {
"run_tests": {"run_cmd", "subprocess"},
"update_doc_versions": {"subprocess"},
"run_cmd": {"subprocess"},
}
# ── Data structures ───────────────────────────────────────────────────────────
@dataclass
class Violation:
"""A single isolation violation found in a test file."""
file: Path
line: int
col: int
category: str
message: str
def format(self) -> str:
try:
rel = self.file.relative_to(Path.cwd())
except ValueError:
rel = self.file
return f"{rel}:{self.line}:{self.col}: [{self.category}] {self.message}"
@dataclass
class TestFunctionInfo:
"""Information about a test function or method."""
name: str
node: ast.FunctionDef | ast.AsyncFunctionDef
patches: set[str] = field(default_factory=set)
class_patches: set[str] = field(default_factory=set)
is_test: bool = False
# ── AST helpers ───────────────────────────────────────────────────────────────
def _extract_patch_targets(node: ast.FunctionDef | ast.AsyncFunctionDef | ast.ClassDef) -> set[str]:
"""Extract @patch targets from decorators on a function or class."""
targets: set[str] = set()
for decorator in node.decorator_list:
if isinstance(decorator, ast.Call):
func = decorator.func
is_patch = (
isinstance(func, ast.Name)
and func.id == "patch"
or isinstance(func, ast.Attribute)
and func.attr == "patch"
)
if is_patch and decorator.args and isinstance(decorator.args[0], ast.Constant):
target = decorator.args[0].value
if isinstance(target, str):
targets.add(target)
targets.add(target.rsplit(".", 1)[-1])
return targets
def _is_test_function(node: ast.FunctionDef | ast.AsyncFunctionDef) -> bool:
return node.name.startswith("test_")
def _has_integration_marker(node: ast.FunctionDef | ast.AsyncFunctionDef) -> bool:
"""Check if a test function has @pytest.mark.integration decorator."""
for decorator in node.decorator_list:
# @pytest.mark.integration → ast.Attribute(attr='integration')
if isinstance(decorator, ast.Attribute) and decorator.attr == "integration":
return True
# @pytest.mark.integration(...) → ast.Call(func=ast.Attribute(attr='integration'))
if isinstance(decorator, ast.Call):
func = decorator.func
if isinstance(func, ast.Attribute) and func.attr == "integration":
return True
return False
def _get_called_name(node: ast.Call) -> str | None:
func = node.func
if isinstance(func, ast.Name):
return func.id
if isinstance(func, ast.Attribute):
return func.attr
return None
def _get_full_called_name(node: ast.Call) -> str | None:
func = node.func
parts: list[str] = []
current = func
while isinstance(current, ast.Attribute):
parts.append(current.attr)
current = current.value
if isinstance(current, ast.Name):
parts.append(current.id)
parts.reverse()
if not parts:
return None
return ".".join(parts)
def _get_range_count(node: ast.Call) -> int | None:
if not isinstance(node.func, ast.Name) or node.func.id != "range":
return None
if not node.args:
return None
# range(N) — single argument
if len(node.args) == 1:
arg = node.args[0]
if isinstance(arg, ast.Constant) and isinstance(arg.value, int):
return arg.value
return None
# range(start, stop) — two or more arguments
if len(node.args) >= 2:
stop = node.args[1]
if not isinstance(stop, ast.Constant) or not isinstance(stop.value, int):
return None
start = node.args[0]
if isinstance(start, ast.Constant) and isinstance(start.value, int):
return stop.value - start.value
# Non-constant start — assume 0
return stop.value
return None # pragma: no cover
# ── Analyzers ─────────────────────────────────────────────────────────────────
class TestIsolationVisitor(ast.NodeVisitor):
"""AST visitor that detects un-hermetic test patterns."""
def __init__(self, file_path: Path, max_loop_iterations: int = DEFAULT_MAX_LOOP_ITERATIONS):
self.file_path = file_path
self.max_loop_iterations = max_loop_iterations
self.violations: list[Violation] = []
self._current_function: TestFunctionInfo | None = None
self._current_class_patches: set[str] = set()
self._in_test_class = False
def visit_ClassDef(self, node: ast.ClassDef) -> None:
old_class_patches = self._current_class_patches
old_in_test = self._in_test_class
self._current_class_patches = _extract_patch_targets(node)
self._in_test_class = node.name.startswith("Test")
self.generic_visit(node)
self._current_class_patches = old_class_patches
self._in_test_class = old_in_test
def visit_FunctionDef(self, node: ast.FunctionDef) -> None:
self._visit_function(node)
def visit_AsyncFunctionDef(self, node: ast.AsyncFunctionDef) -> None:
self._visit_function(node)
def _visit_function(self, node: ast.FunctionDef | ast.AsyncFunctionDef) -> None:
if not _is_test_function(node):
self.generic_visit(node)
return
# Skip integration tests — they intentionally do real I/O
if _has_integration_marker(node):
self.generic_visit(node)
return
patches = _extract_patch_targets(node)
info = TestFunctionInfo(
name=node.name,
node=node,
patches=patches,
class_patches=self._current_class_patches,
is_test=True,
)
old_func = self._current_function
self._current_function = info
self.generic_visit(node)
self._current_function = old_func
def visit_Call(self, node: ast.Call) -> None:
if self._current_function is None:
self.generic_visit(node)
return
full_name = _get_full_called_name(node)
short_name = _get_called_name(node)
all_patches = self._current_function.patches | self._current_function.class_patches
# Check 1: subprocess.run / subprocess.call / subprocess.Popen etc.
if full_name and full_name.startswith("subprocess."):
method = full_name.split(".", 1)[1]
if method in ("run", "call", "Popen", "check_call", "check_output") and not any(
"subprocess" in p for p in all_patches
):
self.violations.append(
Violation(
file=self.file_path,
line=node.lineno,
col=node.col_offset,
category="unpatched-subprocess",
message=_(
"{call} called in test '{test}' without @patch — "
"this spawns a real subprocess. Add "
'@patch("<module>.subprocess.run") or patch the calling function.',
call=full_name,
test=self._current_function.name,
),
)
)
# Check 2: time.sleep
if (
(full_name == "time.sleep" or (short_name == "sleep" and "sleep" not in all_patches))
and "sleep" not in all_patches
and "time.sleep" not in all_patches
and not any("sleep" in p for p in all_patches)
):
self.violations.append(
Violation(
file=self.file_path,
line=node.lineno,
col=node.col_offset,
category="unpatched-sleep",
message=_(
"time.sleep called in test '{test}' without @patch — "
"this causes real wall-clock delays. Add "
'@patch("<module>.time.sleep").',
test=self._current_function.name,
),
)
)
# Check 3: Known subprocess helpers
if short_name in KNOWN_SUBPROCESS_HELPERS and not (
short_name in all_patches
or any("subprocess" in p for p in all_patches)
or any(
dep in all_patches or any(dep in p for p in all_patches)
for dep in HELPER_INTERNAL_CALLS.get(short_name, set())
)
):
self.violations.append(
Violation(
file=self.file_path,
line=node.lineno,
col=node.col_offset,
category="unpatched-helper",
message=_(
"{func} called in test '{test}' without @patch — "
'this function {desc}. Add @patch("<module>.{func}").',
func=short_name,
test=self._current_function.name,
desc=KNOWN_SUBPROCESS_HELPERS[short_name],
),
)
)
# Check 4: Known I/O functions (filesystem/network)
# Match by short name (e.g. "get_pat") or full name (e.g. "requests.get")
sn = short_name or ""
io_key = sn if sn in KNOWN_IO_FUNCTIONS else None
if io_key is None and full_name and full_name in KNOWN_IO_FUNCTIONS:
io_key = full_name
if io_key and not (
io_key in all_patches
or sn in all_patches
or any(io_key in p or sn in p for p in all_patches)
or any(p.endswith(f".{sn}") for p in all_patches)
):
self.violations.append(
Violation(
file=self.file_path,
line=node.lineno,
col=node.col_offset,
category="unpatched-io",
message=_(
"{func} called in test '{test}' without @patch — "
'this function {desc}. Add @patch("<module>.{func}").',
func=io_key,
test=self._current_function.name,
desc=KNOWN_IO_FUNCTIONS[io_key],
),
)
)
self.generic_visit(node)
def visit_For(self, node: ast.For) -> None:
if self._current_function is not None and isinstance(node.iter, ast.Call):
count = _get_range_count(node.iter)
if count is not None and count > self.max_loop_iterations:
self.violations.append(
Violation(
file=self.file_path,
line=node.lineno,
col=node.col_offset,
category="excessive-iterations",
message=_(
"Loop with {count} iterations in test '{test}'"
"consider property-based testing (hypothesis) or reduce to <= {max} iterations.",
count=count,
test=self._current_function.name,
max=self.max_loop_iterations,
),
)
)
self.generic_visit(node)
# ── File scanning (shared by CLI and pytest plugin) ──────────────────────────
def find_test_files(test_path: Path) -> list[Path]:
"""Find all Python test files under the given path."""
if test_path.is_file():
return [test_path] if test_path.suffix == ".py" else []
return sorted(test_path.rglob("test_*.py"))
def analyze_file(file_path: Path, max_loop_iterations: int = DEFAULT_MAX_LOOP_ITERATIONS) -> list[Violation]:
"""Analyze a single test file for isolation violations.
Files in ``integration/`` directories are skipped integration tests
intentionally do real I/O (subprocess, network, filesystem).
"""
if "integration" in file_path.parts:
return []
try:
source = file_path.read_text()
tree = ast.parse(source, filename=str(file_path))
except SyntaxError as exc:
return [
Violation(
file=file_path,
line=exc.lineno or 0,
col=exc.offset or 0,
category="syntax-error",
message=f"Could not parse file: {exc}",
)
]
visitor = TestIsolationVisitor(file_path, max_loop_iterations)
visitor.visit(tree)
return visitor.violations
def analyze_test_files(
test_path: Path,
max_loop_iterations: int = DEFAULT_MAX_LOOP_ITERATIONS,
categories: set[str] | None = None,
) -> list[Violation]:
"""Analyze all test files under test_path. Returns list of violations."""
test_files = find_test_files(test_path)
all_violations: list[Violation] = []
for file_path in test_files:
violations = analyze_file(file_path, max_loop_iterations)
if categories:
violations = [v for v in violations if v.category in categories]
all_violations.extend(violations)
return all_violations
# ── Pytest plugin ─────────────────────────────────────────────────────────────
#
# When devx is installed, pytest auto-discovers this plugin via the
# `pytest11` entry point. The plugin runs static analysis on every
# test file during collection and emits warnings for violations.
# Use --strict-test-isolation to promote warnings to errors.
def pytest_addoption(parser): # type: ignore[no-untyped-def] # pragma: no cover
"""Register pytest command-line options."""
parser.addoption(
"--strict-test-isolation",
action="store_true",
default=False,
help="Fail the test run if any test isolation violations are found.",
)
parser.addoption(
"--no-test-isolation",
action="store_true",
default=False,
help="Disable test isolation static analysis.",
)
parser.addoption(
"--test-isolation-max-loop",
type=int,
default=DEFAULT_MAX_LOOP_ITERATIONS,
help=f"Max iterations allowed in a test loop (default: {DEFAULT_MAX_LOOP_ITERATIONS}).",
)
def pytest_collection_finish(session): # type: ignore[no-untyped-def] # pragma: no cover
"""Run static analysis after all test files are collected."""
if session.config.getoption("--no-test-isolation"):
return
strict = session.config.getoption("--strict-test-isolation")
max_loop = session.config.getoption("--test-isolation-max-loop")
# Analyze all collected test files
test_files: set[Path] = set()
for item in session.items:
test_files.add(Path(str(item.fspath)))
all_violations: list[Violation] = []
for file_path in sorted(test_files):
violations = analyze_file(file_path, max_loop)
all_violations.extend(violations)
if not all_violations:
return
# Emit warnings
import warnings
for v in sorted(all_violations, key=lambda x: (str(x.file), x.line)):
msg = f"Test isolation violation: {v.format()}"
warnings.warn(msg, UserWarning, stacklevel=2)
if strict:
count = len(all_violations)
files = len({v.file for v in all_violations})
click.echo(
_(
"\nTest isolation check FAILED: {count} violation(s) in {files} file(s).\n"
"Fix: add @patch decorators for subprocess/time.sleep calls, "
"or patch the calling function.\n",
count=count,
files=files,
),
err=True,
)
# ── Standalone CLI ────────────────────────────────────────────────────────────
@click.command()
@click.option(
"--test-path",
"test_paths",
type=click.Path(exists=True, path_type=Path),
multiple=True,
default=[Path("tests/")],
show_default=True,
help="Path to test directory or file to analyze (can be specified multiple times).",
)
@click.option(
"--max-loop-iterations",
type=int,
default=DEFAULT_MAX_LOOP_ITERATIONS,
show_default=True,
help="Maximum allowed iterations in a single test loop.",
)
@click.option(
"--strict",
is_flag=True,
default=False,
help="Treat warnings as errors (non-zero exit on any violation).",
)
@click.option(
"--categories",
type=str,
default="",
help="Comma-separated list of categories to check (default: all). "
"Available: unpatched-subprocess, unpatched-sleep, unpatched-helper, excessive-iterations",
)
def cli(test_paths: tuple[Path, ...], max_loop_iterations: int, strict: bool, categories: str) -> None:
"""Check test files for un-hermetic patterns that cause slow or flaky tests."""
allowed: set[str] | None = None
if categories:
allowed = {c.strip() for c in categories.split(",")}
all_violations: list[Violation] = []
total_files = 0
for test_path in test_paths:
violations = analyze_test_files(test_path, max_loop_iterations, allowed)
all_violations.extend(violations)
total_files += len(find_test_files(test_path))
if not all_violations:
click.echo(
_("Test isolation check passed: {count} test files analyzed, no violations found.", count=total_files)
)
sys.exit(0)
click.echo(
_(
"Test isolation check FAILED: {count} violation(s) found in {files} test file(s).",
count=len(all_violations),
files=len({v.file for v in all_violations}),
),
err=True,
)
click.echo("")
for v in sorted(all_violations, key=lambda x: (str(x.file), x.line)):
click.echo(f" {v.format()}", err=True)
click.echo("")
click.echo(
_(
"Fix: add @patch decorators for subprocess/time.sleep calls, "
"or patch the calling function. Use property-based testing for statistical tests."
),
err=True,
)
sys.exit(1)
if __name__ == "__main__": # pragma: no cover
cli() # pragma: no cover
+6 -5
View File
@@ -28,12 +28,11 @@ Usage::
--keep 2 \\
--dry-run
Authentication uses ``CI_GITEA_TOKEN`` environment variable.
Authentication uses ``CI_GITEA_API_TOKEN`` environment variable (or legacy ``CI_GITEA_TOKEN``).
"""
from __future__ import annotations
import os
import time
from typing import Any
@@ -42,6 +41,7 @@ import requests
from devx.config import GITEA_API_URL, REPO_OWNER
from devx.i18n import _
from devx.tokens import get_developer_token
def list_package_versions(
@@ -187,9 +187,10 @@ def main(
api_url: str | None,
) -> None:
"""Clean up old Docker image versions from a Gitea registry."""
token = os.environ.get("CI_GITEA_TOKEN", "")
if not token:
raise click.ClickException(_("CI_GITEA_TOKEN environment variable required"))
try:
token = get_developer_token()
except click.ClickException:
raise click.ClickException(_("CI_GITEA_TOKEN environment variable required")) from None
if not owner:
owner = REPO_OWNER
if not owner:
+7 -3
View File
@@ -7,8 +7,8 @@ ci-improvement, doc-improvement, workflow-improvement) are created
idempotently via ``ensure_label``.
Usage:
CI_GITEA_TOKEN=<token> python3 -m devx.tools.configure_repo --repo my-repo
CI_GITEA_TOKEN=<token> python3 -m devx.tools.configure_repo --repo my-repo --owner my-org
DEVELOPER_GITEA_API_TOKEN=<token> python3 -m devx.tools.configure_repo --repo my-repo
DEVELOPER_GITEA_API_TOKEN=<token> python3 -m devx.tools.configure_repo --repo my-repo --owner my-org
"""
from __future__ import annotations
@@ -23,6 +23,7 @@ from devx.api_clients import GiteaClient
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
from devx.exceptions import APIError
from devx.i18n import _
from devx.tokens import get_developer_token
def _default_status_checks() -> list[str]:
@@ -175,7 +176,10 @@ def configure_repo(
)
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."""
token = os.environ.get("CI_GITEA_TOKEN", "")
try:
token = get_developer_token()
except click.ClickException:
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set.")) from None
if repo is None:
repo = os.environ.get("DEVX_REPO_NAME", "") or REPO_NAME
+9 -6
View File
@@ -42,6 +42,7 @@ from devx.config import (
VIKUNJA_PROJECT_ID,
)
from devx.i18n import _
from devx.tokens import get_developer_token, get_vikunja_token
load_dotenv()
@@ -72,9 +73,10 @@ def get_vikunja_task_title(task_id: str) -> str:
Raises ClickException if VIKUNJA_TOKEN is not set or the task is not found.
"""
token = os.environ.get("VIKUNJA_TOKEN", "")
if not token:
raise click.ClickException(_("VIKUNJA_TOKEN is not set. Required to derive PR title."))
try:
token = get_vikunja_token()
except click.ClickException:
raise click.ClickException(_("VIKUNJA_TOKEN is not set. Required to derive PR title.")) from None
client = VikunjaClient(VIKUNJA_API_URL, token)
task = client.find_task_by_identifier(VIKUNJA_PROJECT_ID, task_id, per_page=DEFAULT_PER_PAGE)
if not task:
@@ -118,9 +120,10 @@ def create_pr(
),
)
token = os.environ.get("CI_GITEA_TOKEN", "")
if not token:
raise click.ClickException(_("CI_GITEA_TOKEN is not set. Required to create a PR."))
try:
token = get_developer_token()
except click.ClickException:
raise click.ClickException(_("CI_GITEA_TOKEN is not set. Required to create a PR.")) from None
vikunja_title = get_vikunja_task_title(task_id)
pr_title = f"{task_id}: {vikunja_title}"
+5 -5
View File
@@ -17,14 +17,13 @@ and ``DEVX_TASK_PREFIX`` environment variables (or ``.env``).
from __future__ import annotations
import os
import click
from dotenv import load_dotenv
from devx.api_clients import VikunjaClient
from devx.config import TASK_PREFIX, VIKUNJA_API_URL, VIKUNJA_PROJECT_ID
from devx.i18n import _
from devx.tokens import get_vikunja_token
load_dotenv()
@@ -39,9 +38,10 @@ load_dotenv()
@click.option("--project-id", type=int, default=None, help="Vikunja project ID (default: DEVX_VIKUNJA_PROJECT_ID).")
def cli(title: str, description: str, project_id: int | None) -> None:
"""Create a Vikunja task and print its identifier."""
token = os.environ.get("VIKUNJA_TOKEN", "")
if not token:
raise click.ClickException(_("VIKUNJA_TOKEN is not set. Set it in .env or environment."))
try:
token = get_vikunja_token()
except click.ClickException:
raise click.ClickException(_("VIKUNJA_TOKEN is not set. Set it in .env or environment.")) from None
pid = project_id if project_id is not None else VIKUNJA_PROJECT_ID
+4 -4
View File
@@ -35,17 +35,17 @@ TARGET_DIR = Path.home() / ".local" / "bin"
ACTIONLINT_VERSION = "1.7.12"
GIT_CLIFF_VERSION = "2.13.0"
GIT_CLIFF_VERSION = "2.13.1"
ACT_RUNNER_VERSION = "0.2.11"
TEA_VERSION = "0.14.1"
TEA_VERSION = "0.14.2"
HADOLINT_VERSION = "2.12.0"
HADOLINT_VERSION = "2.14.0"
TOFU_VERSION = "1.12.3"
VALE_VERSION = "3.12.0"
VALE_VERSION = "3.15.1"
def _arch() -> str:
+5 -5
View File
@@ -22,14 +22,13 @@ The repository is auto-detected from ``DEVX_REPO_OWNER`` /
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.tokens import get_developer_token
from devx.tools.create_pr import get_repo_name
from devx.tools.pr_status import _get_current_branch_pr
@@ -48,9 +47,10 @@ def cli(
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."))
try:
token = get_developer_token()
except click.ClickException:
raise click.ClickException(_("CI_GITEA_TOKEN is not set.")) from None
repo_owner = owner or REPO_OWNER
if not repo_owner:
+5 -5
View File
@@ -25,14 +25,13 @@ The repository is auto-detected from ``DEVX_REPO_OWNER`` /
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.tokens import get_developer_token
from devx.tools.create_pr import get_repo_name
from devx.tools.pr_status import _get_current_branch_pr
@@ -126,9 +125,10 @@ def cli(
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."))
try:
token = get_developer_token()
except click.ClickException:
raise click.ClickException(_("CI_GITEA_TOKEN is not set.")) from None
repo_owner = owner or REPO_OWNER
if not repo_owner:
+5 -3
View File
@@ -32,6 +32,7 @@ from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnk
from devx.api_clients import APIError, GiteaClient
from devx.config import GITEA_API_URL
from devx.i18n import _
from devx.tokens import get_developer_token
from devx.tools._shared import detect_pr_number
@@ -41,9 +42,10 @@ 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."))
try:
token = get_developer_token()
except click.ClickException:
raise click.ClickException(_("CI_GITEA_TOKEN is not set. Add it to .env or export it.")) from None
pr_num = pr or detect_pr_number()
if not pr_num:
+5 -4
View File
@@ -24,7 +24,6 @@ The repository is auto-detected from ``DEVX_REPO_OWNER`` /
from __future__ import annotations
import os
import subprocess # nosec B404
import time
@@ -34,6 +33,7 @@ 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.tokens import get_developer_token
from devx.tools.create_pr import get_repo_name
load_dotenv()
@@ -139,9 +139,10 @@ def cli(
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."))
try:
token = get_developer_token()
except click.ClickException:
raise click.ClickException(_("CI_GITEA_TOKEN is not set.")) from None
repo_owner = owner or REPO_OWNER
if not repo_owner:
+7 -5
View File
@@ -20,7 +20,6 @@ Exit codes:
from __future__ import annotations
import os
import subprocess # nosec B404
import click
@@ -29,6 +28,7 @@ from dotenv import load_dotenv
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.i18n import _
from devx.tokens import get_vikunja_token
load_dotenv()
@@ -55,8 +55,9 @@ def task_exists(task_id: str) -> bool:
Returns ``False`` if VIKUNJA_TOKEN is not set (soft-fail in local mode).
"""
token = os.environ.get("VIKUNJA_TOKEN", "")
if not token:
try:
token = get_vikunja_token()
except click.ClickException:
return False
client = VikunjaClient(VIKUNJA_API_URL, token)
return client.find_task_by_identifier(VIKUNJA_PROJECT_ID, task_id, per_page=DEFAULT_PER_PAGE) is not None
@@ -84,8 +85,9 @@ def validate(branch: str) -> None:
)
)
token = os.environ.get("VIKUNJA_TOKEN", "")
if not token:
try:
get_vikunja_token()
except click.ClickException:
click.echo(
_(
"WARNING: VIKUNJA_TOKEN not set — skipping task existence check. "
+8 -5
View File
@@ -16,6 +16,8 @@ from pathlib import Path
import click
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
from devx.tokens import get_developer_token
load_dotenv()
@@ -64,19 +66,20 @@ def _install_ansible_collections(bin_dir: str) -> None:
def _configure_tea_login() -> None:
"""Configure tea CLI login from .env if CI_GITEA_TOKEN is set.
"""Configure tea CLI login from .env if a Gitea token is set.
Idempotent: if a login with the same name already exists, it is not re-added.
Skips if tea is not installed or CI_GITEA_TOKEN is not set.
Skips if tea is not installed or no Gitea token is set.
"""
tea_bin = shutil.which("tea")
if tea_bin is None:
click.echo("tea: not installed — run 'make install-tools' to install it.")
return
token = os.environ.get("CI_GITEA_TOKEN", "")
if not token:
click.echo("tea: CI_GITEA_TOKEN not set — skipping login configuration.")
try:
token = get_developer_token()
except click.ClickException:
click.echo("tea: Gitea API token not set — skipping login configuration.")
return
api_url = os.environ.get("DEVX_GITEA_API_URL", "https://git.oblachno.oblachno.fyi/api/v1")
+6 -1
View File
@@ -24,6 +24,8 @@ from pathlib import Path
import click
from devx.tokens import get_developer_token
DEFAULT_VENV = ".venv"
OPT_VENV = "/opt/venv"
FALLBACK_TARGET = "setup-ci"
@@ -67,7 +69,10 @@ def _install_in_image(
cmd = [pip_bin, "install", "--no-cache-dir", "-e", spec]
env = os.environ.copy()
token = env.get("CI_GITEA_TOKEN", "")
try:
token = get_developer_token()
except click.ClickException:
token = None
if token:
username = env.get("CI_GITEA_USERNAME", "emil")
env["PIP_EXTRA_INDEX_URL"] = _build_pip_extra_index_url(
+163 -35
View File
@@ -183,6 +183,14 @@
"ru": "\nTag → Commit alignment:",
"zh": "\nTag → Commit alignment:"
},
"\nTest isolation check FAILED: {count} violation(s) in {files} file(s).\nFix: add @patch decorators for subprocess/time.sleep calls, or patch the calling function.\n": {
"bg": "\nПроверката за изолация на тестове НЕ ПРЕМИНА: {count} нарушения в {files} файла.\nРешение: добавете @patch декоратори за subprocess/time.sleep извиквания или patch-нете извикващата функция.\n",
"de": "\nTestisolationsprüfung FEHLGESCHLAGEN: {count} Verstoß/Verstöße in {files} Datei(en).\nBehebung: @patch-Dekoratoren für subprocess/time.sleep-Aufrufe hinzufügen oder die aufrufende Funktion patchen.\n",
"en": "\nTest isolation check FAILED: {count} violation(s) in {files} file(s).\nFix: add @patch decorators for subprocess/time.sleep calls, or patch the calling function.\n",
"pl": "\nSprawdzenie izolacji testów NIE ZALICZONE: {count} naruszeń w {files} plikach.\nNaprawa: dodaj dekoratory @patch dla wywołań subprocess/time.sleep lub patchuj wywołującą funkcję.\n",
"ru": "\nПроверка изоляции тестов НЕ ПРОЙДЕНА: {count} нарушений в {files} файлах.\nИсправление: добавьте декораторы @patch для вызовов subprocess/time.sleep или patch вызывающую функцию.\n",
"zh": "\n测试隔离检查失败:在 {files} 个文件中有 {count} 个违规。\n修复:为 subprocess/time.sleep 调用添加 @patch 装饰器,或 patch 调用函数。\n"
},
"\nUntagged release commits:": {
"bg": "\nUntagged release commits:",
"de": "\nUntagged release commits:",
@@ -368,9 +376,9 @@
"zh": " - {count} standard labels verified"
},
" -> {dir}": {
"en": " -> {dir}",
"bg": " -> {dir}",
"de": " -> {dir}",
"en": " -> {dir}",
"pl": " -> {dir}",
"ru": " -> {dir}",
"zh": " -> {dir}"
@@ -552,9 +560,9 @@
"zh": " Repo root: {root}"
},
" Run 'make install-checkmake' to install the Makefile linter.": {
"en": " Run 'make install-checkmake' to install the Makefile linter.",
"bg": " Изпълнете 'make install-checkmake' за инсталиране на Makefile линтера.",
"de": " Führen Sie 'make install-checkmake' aus, um den Makefile-Linter zu installieren.",
"en": " Run 'make install-checkmake' to install the Makefile linter.",
"pl": " Uruchom 'make install-checkmake', aby zainstalować linter Makefile.",
"ru": " Выполните 'make install-checkmake' для установки линтера Makefile.",
"zh": " 运行 'make install-checkmake' 来安装 Makefile 检查器。"
@@ -704,9 +712,9 @@
"zh": " {n} stale docs found (warnings only)"
},
" {tool}: found at {path}": {
"en": " {tool}: found at {path}",
"bg": " {tool}: намерен на {path}",
"de": " {tool}: gefunden unter {path}",
"en": " {tool}: found at {path}",
"pl": " {tool}: znaleziono w {path}",
"ru": " {tool}: найден в {path}",
"zh": " {tool}: 在 {path} 找到"
@@ -791,6 +799,14 @@
"ru": "All molecule tests passed.",
"zh": "All molecule tests passed."
},
"Allow empty tag (PR mode where SHA is concrete).": {
"bg": "Позволи празен таг (PR режим, където SHA е конкретен).",
"de": "Leeren Tag zulassen (PR-Modus, in dem SHA konkret ist).",
"en": "Allow empty tag (PR mode where SHA is concrete).",
"pl": "Zezwalaj na pusty tag (tryb PR, w którym SHA jest konkretne).",
"ru": "Разрешить пустой тег (режим PR, где SHA конкретен).",
"zh": "允许空标签(SHA 为具体值的 PR 模式)。"
},
"Another molecule runner failed. Stopping this runner early.": {
"bg": "Another molecule runner failed. Stopping this runner early.",
"de": "Another molecule runner failed. Stopping this runner early.",
@@ -1360,9 +1376,9 @@
"zh": "Dependencies must have documentation comments."
},
"Directory to scan (default: tests/integration). Can be repeated.": {
"en": "Directory to scan (default: tests/integration). Can be repeated.",
"bg": "Директория за сканиране (по подразбиране: tests/integration). Може да се повтаря.",
"de": "Zu scannendes Verzeichnis (Standard: tests/integration). Kann wiederholt werden.",
"en": "Directory to scan (default: tests/integration). Can be repeated.",
"pl": "Katalog do skanowania (domyślnie: tests/integration). Można powtarzać.",
"ru": "Директория для сканирования (по умолчанию: tests/integration). Можно повторять.",
"zh": "要扫描的目录(默认:tests/integration)。可重复。"
@@ -1536,9 +1552,9 @@
"zh": "Failed to push release commit after 3 attempts. Manual intervention required."
},
"Failed to start ssh-agent: {error}": {
"en": "Failed to start ssh-agent: {error}",
"bg": "Неуспешно стартиране на ssh-agent: {error}",
"de": "Starten von ssh-agent fehlgeschlagen: {error}",
"en": "Failed to start ssh-agent: {error}",
"pl": "Nie udało się uruchomić ssh-agent: {error}",
"ru": "Не удалось запустить ssh-agent: {error}",
"zh": "启动 ssh-agent 失败: {error}"
@@ -1567,6 +1583,14 @@
"ru": "Fetching origin/master...",
"zh": "Fetching origin/master..."
},
"Fix: add @patch decorators for subprocess/time.sleep calls, or patch the calling function. Use property-based testing for statistical tests.": {
"bg": "Решение: добавете @patch декоратори за subprocess/time.sleep извиквания или patch-нете извикващата функция. Използвайте property-based тестове за статистически тестове.",
"de": "Behebung: @patch-Dekoratoren für subprocess/time.sleep-Aufrufe hinzufügen oder die aufrufende Funktion patchen. Property-based testing für statistische Tests verwenden.",
"en": "Fix: add @patch decorators for subprocess/time.sleep calls, or patch the calling function. Use property-based testing for statistical tests.",
"pl": "Naprawa: dodaj dekoratory @patch dla wywołań subprocess/time.sleep lub patchuj wywołującą funkcję. Użyj testów opartych na właściwościach dla testów statystycznych.",
"ru": "Исправление: добавьте декораторы @patch для вызовов subprocess/time.sleep или patch вызывающую функцию. Используйте property-based тестирование для статистических тестов.",
"zh": "修复:为 subprocess/time.sleep 调用添加 @patch 装饰器,或 patch 调用函数。对统计测试使用基于属性的测试。"
},
"Force-push failed:\n{error}\nThe remote may have unexpected commits. Fetch and try again.": {
"bg": "Force-push failed:\n{error}\nThe remote may have unexpected commits. Fetch and try again.",
"de": "Force-push failed:\n{error}\nThe remote may have unexpected commits. Fetch and try again.",
@@ -1600,9 +1624,9 @@
"zh": "Found {count} stale documentation reference(s)"
},
"Found {count} unsafe identity check(s) in integration tests.": {
"en": "Found {count} unsafe identity check(s) in integration tests.",
"bg": "Намерени са {count} небрежни проверки за идентичност в интеграционните тестове.",
"de": "{count} unsichere Identitätsprüfung(en) in Integrationstests gefunden.",
"en": "Found {count} unsafe identity check(s) in integration tests.",
"pl": "Znaleziono {count} niebezpiecznych sprawdzeń tożsamości w testach integracyjnych.",
"ru": "Найдено {count} небезопасных проверок идентичности в интеграционных тестах.",
"zh": "在集成测试中发现 {count} 个不安全的身份检查。"
@@ -1647,6 +1671,30 @@
"ru": "Generating badges in {out}...",
"zh": "Generating badges in {out}..."
},
"Git tag or ref that was deployed": {
"bg": "Git таг или референция, която беше разгърната",
"de": "Git-Tag oder Ref, der bereitgestellt wurde",
"en": "Git tag or ref that was deployed",
"pl": "Tag Git lub ref, który został wdrożony",
"ru": "Git-тег или ссылка, которые были развёрнуты",
"zh": "已部署的 Git 标签或引用"
},
"Git tag to deploy (e.g. v0.28.1).": {
"bg": "Git таг за разгръщане (напр. v0.28.1).",
"de": "Git-Tag für Bereitstellung (z.B. v0.28.1).",
"en": "Git tag to deploy (e.g. v0.28.1).",
"pl": "Tag Git do wdrożenia (np. v0.28.1).",
"ru": "Git-тег для развёртывания (напр. v0.28.1).",
"zh": "要部署的 Git 标签(例如 v0.28.1)。"
},
"Gitea API token not set. Set one of: {names}": {
"bg": "Gitea API token not set. Set one of: {names}",
"de": "Gitea API token not set. Set one of: {names}",
"en": "Gitea API token not set. Set one of: {names}",
"pl": "Gitea API token not set. Set one of: {names}",
"ru": "Gitea API token not set. Set one of: {names}",
"zh": "Gitea API token not set. Set one of: {names}"
},
"Gitea PyPI registry: {tag} already published — continuing.": {
"bg": "Gitea PyPI registry: {tag} вече е публикуван — продължава.",
"de": "Gitea PyPI-Registry: {tag} bereits veröffentlicht — wird fortgesetzt.",
@@ -1832,13 +1880,21 @@
"zh": "Linting documentation in {root}..."
},
"Login to {registry} failed: {error}": {
"en": "Login to {registry} failed: {error}",
"bg": "Влизането в {registry} не успя: {error}",
"de": "Anmeldung bei {registry} fehlgeschlagen: {error}",
"en": "Login to {registry} failed: {error}",
"pl": "Logowanie do {registry} nie powiodło się: {error}",
"ru": "Ошибка входа в {registry}: {error}",
"zh": "登录 {registry} 失败: {error}"
},
"Loop with {count} iterations in test '{test}' — consider property-based testing (hypothesis) or reduce to <= {max} iterations.": {
"bg": "Цикъл с {count} итерации в тест '{test}' — използвайте property-based тестове (hypothesis) или намалете до <= {max} итерации.",
"de": "Schleife mit {count} Iterationen in Test '{test}' — property-based testing (hypothesis) verwenden oder auf <= {max} Iterationen reduzieren.",
"en": "Loop with {count} iterations in test '{test}' — consider property-based testing (hypothesis) or reduce to <= {max} iterations.",
"pl": "Pętla z {count} iteracjami w teście '{test}' — rozważ testy oparte na właściwościach (hypothesis) lub zmniejsz do <= {max} iteracji.",
"ru": "Цикл с {count} итерациями в тесте '{test}' — используйте property-based тестирование (hypothesis) или уменьшите до <= {max} итераций.",
"zh": "测试 '{test}' 中有 {count} 次迭代的循环 — 考虑使用基于属性的测试 (hypothesis) 或减少到 <= {max} 次迭代。"
},
"Manifest file not found: {path}": {
"bg": "Manifest file not found: {path}",
"de": "Manifest file not found: {path}",
@@ -2095,13 +2151,29 @@
"ru": "No workflow runs found for SHA {sha}.",
"zh": "No workflow runs found for SHA {sha}."
},
"Note: CI token also cannot approve. Posting COMMENT instead.": {
"bg": "Забележка: CI тоукънът също не може да одобри. Публикуване на COMMENT вместо това.",
"de": "Hinweis: CI-Token kann ebenfalls nicht genehmigen. COMMENT wird stattdessen gesendet.",
"en": "Note: CI token also cannot approve. Posting COMMENT instead.",
"pl": "Uwaga: Token CI również nie może zatwierdzić. Publikowanie COMMENT zamiast tego.",
"ru": "Примечание: CI токен также не может одобрить. Публикация COMMENT вместо этого.",
"zh": "注意:CI 令牌也无法批准。改为发布 COMMENT。"
},
"Note: Self-approval not allowed with reviewer token. Retrying with CI token.": {
"bg": "Забележка: Само-одобрението не е разрешено с тоукън на рецензента. Повторен опит с CI тоукън.",
"de": "Hinweis: Selbstgenehmigung mit Reviewer-Token nicht erlaubt. Wiederholung mit CI-Token.",
"en": "Note: Self-approval not allowed with reviewer token. Retrying with CI token.",
"pl": "Uwaga: Samo-zatwierdzenie niedozwolone tokenem recenzenta. Ponawianie tokenem CI.",
"ru": "Примечание: Самоодобрение токеном ревьюера не разрешено. Повторная попытка с CI токеном.",
"zh": "注意:不允许使用审阅者令牌进行自我批准。正在使用 CI 令牌重试。"
},
"Note: Self-approval not allowed. Posting COMMENT instead.": {
"bg": "Note: Self-approval not allowed. Posting COMMENT instead.",
"de": "Note: Self-approval not allowed. Posting COMMENT instead.",
"bg": "Забележка: Само-одобрението не е разрешено. Публикуване на COMMENT вместо това.",
"de": "Hinweis: Selbstgenehmigung nicht erlaubt. COMMENT wird stattdessen gesendet.",
"en": "Note: Self-approval not allowed. Posting COMMENT instead.",
"pl": "Uwaga: Samo-zatwierdzenie niedozwolone. Publikowanie COMMENT zamiast tego.",
"ru": "Note: Self-approval not allowed. Posting COMMENT instead.",
"zh": "Note: Self-approval not allowed. Posting COMMENT instead."
"ru": "Примечание: Самоодобрение не разрешено. Публикация COMMENT вместо этого.",
"zh": "注意:不允许自我批准。改为发布 COMMENT。"
},
"Nothing to push.": {
"bg": "Nothing to push.",
@@ -2600,9 +2672,9 @@
"zh": "仓库所有者未设置。使用 --owner 或 DEVX_REPO_OWNER 环境变量。"
},
"Required tools missing.": {
"en": "Required tools missing.",
"bg": "Липсват задължителни инструменти.",
"de": "Erforderliche Werkzeuge fehlen.",
"en": "Required tools missing.",
"pl": "Brak wymaganych narzędzi.",
"ru": "Отсутствуют обязательные инструменты.",
"zh": "缺少必需的工具。"
@@ -2696,25 +2768,25 @@
"zh": "Running: {scenario} on {platform}"
},
"SSH key set up successfully": {
"en": "SSH key set up successfully",
"bg": "SSH ключът е настроен успешно",
"de": "SSH-Schlüssel erfolgreich eingerichtet",
"en": "SSH key set up successfully",
"pl": "Klucz SSH skonfigurowany pomyślnie",
"ru": "SSH-ключ успешно настроен",
"zh": "SSH 密钥设置成功"
},
"SSH key setup skipped (no key provided)": {
"en": "SSH key setup skipped (no key provided)",
"bg": "Настройката на SSH ключ е пропусната (не е предоставен ключ)",
"de": "SSH-Schlüssel-Setup übersprungen (kein Schlüssel bereitgestellt)",
"en": "SSH key setup skipped (no key provided)",
"pl": "Pominięto konfigurację klucza SSH (brak klucza)",
"ru": "Настройка SSH-ключа пропущена (ключ не предоставлен)",
"zh": "SSH 密钥设置已跳过(未提供密钥)"
},
"SSH_PRIVATE_KEY not set — skipping SSH key setup": {
"en": "SSH_PRIVATE_KEY not set — skipping SSH key setup",
"bg": "SSH_PRIVATE_KEY не е зададен — пропускане на SSH ключ настройката",
"de": "SSH_PRIVATE_KEY nicht gesetzt — SSH-Schlüssel-Setup übersprungen",
"en": "SSH_PRIVATE_KEY not set — skipping SSH key setup",
"pl": "SSH_PRIVATE_KEY nie ustawione — pomijanie konfiguracji klucza SSH",
"ru": "SSH_PRIVATE_KEY не задан — пропуск настройки SSH-ключа",
"zh": "SSH_PRIVATE_KEY 未设置 — 跳过 SSH 密钥设置"
@@ -2831,6 +2903,22 @@
"ru": "Test '{name}' took {elapsed:.2f}s (limit: {limit}s). Optimise: use lighter fixtures, reduce I/O, or mock external calls.",
"zh": "Test '{name}' took {elapsed:.2f}s (limit: {limit}s). Optimise: use lighter fixtures, reduce I/O, or mock external calls."
},
"Test isolation check FAILED: {count} violation(s) found in {files} test file(s).": {
"bg": "Проверката за изолация на тестове НЕ ПРЕМИНА: открити са {count} нарушения в {files} тестови файла.",
"de": "Testisolationsprüfung FEHLGESCHLAGEN: {count} Verstoß/Verstöße in {files} Testdatei(en) gefunden.",
"en": "Test isolation check FAILED: {count} violation(s) found in {files} test file(s).",
"pl": "Sprawdzenie izolacji testów NIE ZALICZONE: znaleziono {count} naruszeń w {files} plikach testowych.",
"ru": "Проверка изоляции тестов НЕ ПРОЙДЕНА: найдено {count} нарушений в {files} тестовых файлах.",
"zh": "测试隔离检查失败:在 {files} 个测试文件中发现 {count} 个违规。"
},
"Test isolation check passed: {count} test files analyzed, no violations found.": {
"bg": "Проверката за изолация на тестове премина: анализирани са {count} тестови файла, няма нарушения.",
"de": "Testisolationsprüfung bestanden: {count} Testdateien analysiert, keine Verstöße gefunden.",
"en": "Test isolation check passed: {count} test files analyzed, no violations found.",
"pl": "Sprawdzenie izolacji testów zaliczone: przeanalizowano {count} plików testowych, brak naruszeń.",
"ru": "Проверка изоляции тестов пройдена: проанализировано {count} тестовых файлов, нарушений не найдено.",
"zh": "测试隔离检查通过:已分析 {count} 个测试文件,未发现违规。"
},
"Tests failed — refusing to release. Fix test failures first.\n{stderr}": {
"bg": "Tests failed — refusing to release. Fix test failures first.\n{stderr}",
"de": "Tests failed — refusing to release. Fix test failures first.\n{stderr}",
@@ -2912,9 +3000,9 @@
"zh": "Updated {changelog_file}"
},
"Use string comparison or _is_truthy()/_is_falsy() helpers instead. Add '{marker}' to suppress individual lines.": {
"en": "Use string comparison or _is_truthy()/_is_falsy() helpers instead. Add '{marker}' to suppress individual lines.",
"bg": "Използвайте сравнение на низове или _is_truthy()/_is_falsy() помощници. Добавете '{marker}' за потискане на отделни редове.",
"de": "Verwenden Sie String-Vergleich oder _is_truthy()/_is_falsy() Hilfsfunktionen. Fügen Sie '{marker}' hinzu, um einzelne Zeilen zu unterdrücken.",
"en": "Use string comparison or _is_truthy()/_is_falsy() helpers instead. Add '{marker}' to suppress individual lines.",
"pl": "Użyj porównania ciągów lub pomocników _is_truthy()/_is_falsy(). Dodaj '{marker}', aby pominąć pojedyncze linie.",
"ru": "Используйте строковое сравнение или помощники _is_truthy()/_is_falsy(). Добавьте '{marker}' для подавления отдельных строк.",
"zh": "使用字符串比较或 _is_truthy()/_is_falsy() 辅助函数。添加 '{marker}' 以抑制个别行。"
@@ -2967,6 +3055,14 @@
"ru": "Vikunja API error (HTTP {status}): {message}. Task {task_id} was NOT updated. The merge succeeded but the Vikunja task needs manual update.",
"zh": "Vikunja API error (HTTP {status}): {message}. Task {task_id} was NOT updated. The merge succeeded but the Vikunja task needs manual update."
},
"Vikunja task title '{title}' starts with '{prefix}:'. The task title should NOT include the '{prefix}' prefix — it is automatically added to the PR title. Update the Vikunja task title to remove the prefix.": {
"bg": "Заглавието на задачата във Vikunja '{title}' започва с '{prefix}:'. Заглавието на задачата НЕ трябва да съдържа префикса '{prefix}' — той се добавя автоматично към заглавието на PR. Актуализирайте заглавието на задачата във Vikunja, за да премахнете префикса.",
"de": "Der Vikunja-Aufgabentitel '{title}' beginnt mit '{prefix}:'. Der Aufgabentitel darf NICHT den Präfix '{prefix}' enthalten — er wird automatisch zum PR-Titel hinzugefügt. Aktualisieren Sie den Vikunja-Aufgabentitel, um den Präfix zu entfernen.",
"en": "Vikunja task title '{title}' starts with '{prefix}:'. The task title should NOT include the '{prefix}' prefix — it is automatically added to the PR title. Update the Vikunja task title to remove the prefix.",
"pl": "Tytuł zadania Vikunja '{title}' zaczyna się od '{prefix}:'. Tytuł zadania nie powinien zawierać prefiksu '{prefix}' — jest on automatycznie dodawany do tytułu PR. Zaktualizuj tytuł zadania Vikunja, aby usunąć prefiks.",
"ru": "Заголовок задачи Vikunja '{title}' начинается с '{prefix}:'. Заголовок задачи НЕ должен включать префикс '{prefix}' — он автоматически добавляется к заголовку PR. Обновите заголовок задачи Vikunja, чтобы удалить префикс.",
"zh": "Vikunja 任务标题 '{title}' 以 '{prefix}:' 开头。任务标题不应包含 '{prefix}' 前缀 — 它会自动添加到 PR 标题中。请更新 Vikunja 任务标题以删除前缀。"
},
"Vikunja task {task_id} not found in project {project_id}.\n Create it first:\n python -m devx.tools.create_task --title \"Task title\"\n Or check that the task ID in the branch name is correct.": {
"bg": "Vikunja задача {task_id} не е намерена в проект {project_id}.\n Създайте я първо:\n python -m devx.tools.create_task --title \"Заглавие на задача\"\n Или проверете че ID на задачата в името на клона е правилно.",
"de": "Vikunja-Task {task_id} in Projekt {project_id} nicht gefunden.\n Zuerst erstellen:\n python -m devx.tools.create_task --title \"Task-Titel\"\n Oder prüfen, ob die Task-ID im Branch-Namen korrekt ist.",
@@ -2976,33 +3072,33 @@
"zh": "在项目 {project_id} 中找不到 Vikunja 任务 {task_id}。\n 请先创建:\n python -m devx.tools.create_task --title \"任务标题\"\n 或检查分支名称中的任务 ID 是否正确。"
},
"WARN: .venv has Python {version}, but >={req} is required.": {
"en": "WARN: .venv has Python {version}, but >={req} is required.",
"bg": "ПРЕДУПРЕЖДЕНИЕ: .venv има Python {version}, но се изисква >={req}.",
"de": "WARNUNG: .venv hat Python {version}, aber >={req} ist erforderlich.",
"en": "WARN: .venv has Python {version}, but >={req} is required.",
"pl": "OSTRZEŻENIE: .venv ma Python {version}, ale wymagane jest >={req}.",
"ru": "ПРЕДУПРЕЖДЕНИЕ: в .venv установлен Python {version}, но требуется >={req}.",
"zh": "警告: .venv 的 Python 版本为 {version},但要求 >={req}。"
},
"WARN: .venv not found. Run 'make setup-venv' to create it.": {
"en": "WARN: .venv not found. Run 'make setup-venv' to create it.",
"bg": "ПРЕДУПРЕЖДЕНИЕ: .venv не е намерен. Изпълнете 'make setup-venv' за създаване.",
"de": "WARNUNG: .venv nicht gefunden. Führen Sie 'make setup-venv' aus, um es zu erstellen.",
"en": "WARN: .venv not found. Run 'make setup-venv' to create it.",
"pl": "OSTRZEŻENIE: Nie znaleziono .venv. Uruchom 'make setup-venv', aby utworzyć.",
"ru": "ПРЕДУПРЕЖДЕНИЕ: .venv не найден. Выполните 'make setup-venv' для создания.",
"zh": "警告: 未找到 .venv。运行 'make setup-venv' 来创建。"
},
"WARN: Could not determine Python version in .venv.": {
"en": "WARN: Could not determine Python version in .venv.",
"bg": "ПРЕДУПРЕЖДЕНИЕ: Не може да се определи версията на Python в .venv.",
"de": "WARNUNG: Python-Version in .venv konnte nicht bestimmt werden.",
"en": "WARN: Could not determine Python version in .venv.",
"pl": "OSTRZEŻENIE: Nie można określić wersji Python w .venv.",
"ru": "ПРЕДУПРЕЖДЕНИЕ: Не удалось определить версию Python в .venv.",
"zh": "警告: 无法确定 .venv 中的 Python 版本。"
},
"WARN: Could not parse Python version '{version}'.": {
"en": "WARN: Could not parse Python version '{version}'.",
"bg": "ПРЕДУПРЕЖДЕНИЕ: Не може да се анализира версията на Python '{version}'.",
"de": "WARNUNG: Python-Version '{version}' konnte nicht analysiert werden.",
"en": "WARN: Could not parse Python version '{version}'.",
"pl": "OSTRZEŻENIE: Nie można przeanalizować wersji Python '{version}'.",
"ru": "ПРЕДУПРЕЖДЕНИЕ: Не удалось разобрать версию Python '{version}'.",
"zh": "警告: 无法解析 Python 版本 '{version}'。"
@@ -3151,6 +3247,14 @@
"ru": "",
"zh": ""
},
"Write deploy-ref to $GITHUB_OUTPUT file.": {
"bg": "Запиши deploy-ref в $GITHUB_OUTPUT файла.",
"de": "Deploy-ref in $GITHUB_OUTPUT-Datei schreiben.",
"en": "Write deploy-ref to $GITHUB_OUTPUT file.",
"pl": "Zapisz deploy-ref do pliku $GITHUB_OUTPUT.",
"ru": "Записать deploy-ref в файл $GITHUB_OUTPUT.",
"zh": "将 deploy-ref 写入 $GITHUB_OUTPUT 文件。"
},
"Wrote tag {tag} to GITHUB_OUTPUT.": {
"bg": "Wrote tag {tag} to GITHUB_OUTPUT.",
"de": "Wrote tag {tag} to GITHUB_OUTPUT.",
@@ -3160,9 +3264,9 @@
"zh": "Wrote tag {tag} to GITHUB_OUTPUT."
},
"[check-api-identity-checks] Passed: no unsafe identity checks found": {
"en": "[check-api-identity-checks] Passed: no unsafe identity checks found",
"bg": "[check-api-identity-checks] Мина: не са намерени небрежни проверки за идентичност",
"de": "[check-api-identity-checks] Bestanden: keine unsicheren Identitätsprüfungen gefunden",
"en": "[check-api-identity-checks] Passed: no unsafe identity checks found",
"pl": "[check-api-identity-checks] Passed: nie znaleziono niebezpiecznych sprawdzeń tożsamości",
"ru": "[check-api-identity-checks] Пройдено: небезопасных проверок идентичности не найдено",
"zh": "[check-api-identity-checks] 通过:未发现不安全的身份检查"
@@ -3176,25 +3280,25 @@
"zh": "[check-dep-docs] Passed: all dependencies are documented"
},
"[check-deps] All core tools present.": {
"en": "[check-deps] All core tools present.",
"bg": "[check-deps] Всички основни инструменти са налични.",
"de": "[check-deps] Alle Kernwerkzeuge vorhanden.",
"en": "[check-deps] All core tools present.",
"pl": "[check-deps] Wszystkie podstawowe narzędzia są dostępne.",
"ru": "[check-deps] Все основные инструменты доступны.",
"zh": "[check-deps] 所有核心工具均已就绪。"
},
"[check-deps] Verifying tools...": {
"en": "[check-deps] Verifying tools...",
"bg": "[check-deps] Проверка на инструментите...",
"de": "[check-deps] Werkzeuge werden überprüft...",
"en": "[check-deps] Verifying tools...",
"pl": "[check-deps] Sprawdzanie narzędzi...",
"ru": "[check-deps] Проверка инструментов...",
"zh": "[check-deps] 正在验证工具..."
},
"[check-deps] Virtualenv .venv ready (Python {version}).": {
"en": "[check-deps] Virtualenv .venv ready (Python {version}).",
"bg": "[check-deps] Виртуална среда .venv готова (Python {version}).",
"de": "[check-deps] Virtuelle Umgebung .venv bereit (Python {version}).",
"en": "[check-deps] Virtualenv .venv ready (Python {version}).",
"pl": "[check-deps] Środowisko wirtualne .venv gotowe (Python {version}).",
"ru": "[check-deps] Виртуальное окружение .venv готово (Python {version}).",
"zh": "[check-deps] 虚拟环境 .venv 已就绪 (Python {version})。"
@@ -3224,25 +3328,25 @@
"zh": "[check_test_coverage] No changed files to check."
},
"[docker-login] Logged in to {registry}.": {
"en": "[docker-login] Logged in to {registry}.",
"bg": "[docker-login] Влязъл в {registry}.",
"de": "[docker-login] Angemeldet bei {registry}.",
"en": "[docker-login] Logged in to {registry}.",
"pl": "[docker-login] Zalogowano do {registry}.",
"ru": "[docker-login] Выполнен вход в {registry}.",
"zh": "[docker-login] 已登录到 {registry}。"
},
"[docker-login] Login to {registry} failed (continuing).": {
"en": "[docker-login] Login to {registry} failed (continuing).",
"bg": "[docker-login] Влизането в {registry} не успя (продължава).",
"de": "[docker-login] Anmeldung bei {registry} fehlgeschlagen (wird fortgesetzt).",
"en": "[docker-login] Login to {registry} failed (continuing).",
"pl": "[docker-login] Logowanie do {registry} nie powiodło się (kontynuowanie).",
"ru": "[docker-login] Ошибка входа в {registry} (продолжаем).",
"zh": "[docker-login] 登录 {registry} 失败(继续)。"
},
"[docker-login] Skipping {registry} (token {env} not set).": {
"en": "[docker-login] Skipping {registry} (token {env} not set).",
"bg": "[docker-login] Пропускане на {registry} (токен {env} не е зададен).",
"de": "[docker-login] {registry} übersprungen (Token {env} nicht gesetzt).",
"en": "[docker-login] Skipping {registry} (token {env} not set).",
"pl": "[docker-login] Pomijanie {registry} (token {env} nie ustawiony).",
"ru": "[docker-login] Пропуск {registry} (токен {env} не задан).",
"zh": "[docker-login] 跳过 {registry}(未设置令牌 {env})。"
@@ -3320,33 +3424,33 @@
"zh": "[dry-run] Would update {init}"
},
"[tofu-init] Done.": {
"en": "[tofu-init] Done.",
"bg": "[tofu-init] Готово.",
"de": "[tofu-init] Fertig.",
"en": "[tofu-init] Done.",
"pl": "[tofu-init] Gotowe.",
"ru": "[tofu-init] Готово.",
"zh": "[tofu-init] 完成。"
},
"[tofu-init] Initializing {dir}...": {
"en": "[tofu-init] Initializing {dir}...",
"bg": "[tofu-init] Инициализиране на {dir}...",
"de": "[tofu-init] Initialisiere {dir}...",
"en": "[tofu-init] Initializing {dir}...",
"pl": "[tofu-init] Inicjalizacja {dir}...",
"ru": "[tofu-init] Инициализация {dir}...",
"zh": "[tofu-init] 正在初始化 {dir}..."
},
"[tofu-{mode}] All configurations valid.": {
"en": "[tofu-{mode}] All configurations valid.",
"bg": "[tofu-{mode}] Всички конфигурации са валидни.",
"de": "[tofu-{mode}] Alle Konfigurationen gültig.",
"en": "[tofu-{mode}] All configurations valid.",
"pl": "[tofu-{mode}] Wszystkie konfiguracje są poprawne.",
"ru": "[tofu-{mode}] Все конфигурации валидны.",
"zh": "[tofu-{mode}] 所有配置有效。"
},
"[tofu-{mode}] Validating OpenTofu configurations...": {
"en": "[tofu-{mode}] Validating OpenTofu configurations...",
"bg": "[tofu-{mode}] Проверка на OpenTofu конфигурациите...",
"de": "[tofu-{mode}] Validiere OpenTofu-Konfigurationen...",
"en": "[tofu-{mode}] Validating OpenTofu configurations...",
"pl": "[tofu-{mode}] Sprawdzanie konfiguracji OpenTofu...",
"ru": "[tofu-{mode}] Проверка конфигураций OpenTofu...",
"zh": "[tofu-{mode}] 正在验证 OpenTofu 配置..."
@@ -3503,10 +3607,18 @@
"ru": "tea not installed — skipping login configuration.",
"zh": "tea not installed — skipping login configuration."
},
"time.sleep called in test '{test}' without @patch — this causes real wall-clock delays. Add @patch(\"<module>.time.sleep\").": {
"bg": "time.sleep извикано в тест '{test}' без @patch — това причинява реални забавяния. Добавете @patch(\"<module>.time.sleep\").",
"de": "time.sleep in Test '{test}' ohne @patch aufgerufen — dies verursacht echte Wanduhr-Verzögerungen. @patch(\"<module>.time.sleep\") hinzufügen.",
"en": "time.sleep called in test '{test}' without @patch — this causes real wall-clock delays. Add @patch(\"<module>.time.sleep\").",
"pl": "time.sleep wywołane w teście '{test}' bez @patch — to powoduje rzeczywiste opóźnienia. Dodaj @patch(\"<module>.time.sleep\").",
"ru": "time.sleep вызвано в тесте '{test}' без @patch — это вызывает реальные задержки. Добавьте @patch(\"<module>.time.sleep\").",
"zh": "time.sleep 在测试 '{test}' 中被调用但没有 @patch — 这会导致真实的挂钟延迟。请添加 @patch(\"<module>.time.sleep\")。"
},
"tofu command failed in {dir}: {error}": {
"en": "tofu command failed in {dir}: {error}",
"bg": "командата tofu не успя в {dir}: {error}",
"de": "tofu-Befehl fehlgeschlagen in {dir}: {error}",
"en": "tofu command failed in {dir}: {error}",
"pl": "polecenie tofu nie powiodło się w {dir}: {error}",
"ru": "команда tofu не удалась в {dir}: {error}",
"zh": "tofu 命令在 {dir} 中失败: {error}"
@@ -3519,18 +3631,26 @@
"ru": "неизвестно",
"zh": "未知"
},
"{call} called in test '{test}' without @patch — this spawns a real subprocess. Add @patch(\"<module>.subprocess.run\") or patch the calling function.": {
"bg": "{call} извикано в тест '{test}' без @patch — това стартира реален subprocess. Добавете @patch(\"<module>.subprocess.run\") или patch-нете извикващата функция.",
"de": "{call} in Test '{test}' ohne @patch aufgerufen — dies startet einen echten subprocess. @patch(\"<module>.subprocess.run\") hinzufügen oder die aufrufende Funktion patchen.",
"en": "{call} called in test '{test}' without @patch — this spawns a real subprocess. Add @patch(\"<module>.subprocess.run\") or patch the calling function.",
"pl": "{call} wywołane w teście '{test}' bez @patch — to uruchamia rzeczywisty subprocess. Dodaj @patch(\"<module>.subprocess.run\") lub patchuj wywołującą funkcję.",
"ru": "{call} вызвано в тесте '{test}' без @patch — это запускает реальный subprocess. Добавьте @patch(\"<module>.subprocess.run\") или patch вызывающую функцию.",
"zh": "{call} 在测试 '{test}' 中被调用但没有 @patch — 这会启动真实的子进程。请添加 @patch(\"<module>.subprocess.run\") 或 patch 调用函数。"
},
"{env} is not set. Set it in your .env file or pass it as an environment variable.": {
"en": "{env} is not set. Set it in your .env file or pass it as an environment variable.",
"bg": "{env} не е зададен. Задайте го във вашия .env файл или го подайте като променлива на средата.",
"de": "{env} ist nicht gesetzt. Setzen Sie es in Ihrer .env-Datei oder übergeben Sie es als Umgebungsvariable.",
"en": "{env} is not set. Set it in your .env file or pass it as an environment variable.",
"pl": "{env} nie jest ustawiony. Ustaw go w pliku .env lub przekaż jako zmienną środowiskową.",
"ru": "{env} не задан. Установите его в файле .env или передайте как переменную окружения.",
"zh": "{env} 未设置。请在 .env 文件中设置或作为环境变量传递。"
},
"{env} is not set. Set it in your .env file.": {
"en": "{env} is not set. Set it in your .env file.",
"bg": "{env} не е зададен. Задайте го във вашия .env файл.",
"de": "{env} ist nicht gesetzt. Setzen Sie es in Ihrer .env-Datei.",
"en": "{env} is not set. Set it in your .env file.",
"pl": "{env} nie jest ustawiony. Ustaw go w pliku .env.",
"ru": "{env} не задан. Установите его в файле .env.",
"zh": "{env} 未设置。请在 .env 文件中设置。"
@@ -3543,10 +3663,18 @@
"ru": "{file} already exists. Use --force to overwrite.",
"zh": "{file} already exists. Use --force to overwrite."
},
"{func} called in test '{test}' without @patch — this function {desc}. Add @patch(\"<module>.{func}\").": {
"bg": "{func} извикано в тест '{test}' без @patch — тази функция {desc}. Добавете @patch(\"<module>.{func}\").",
"de": "{func} in Test '{test}' ohne @patch aufgerufen — diese Funktion {desc}. @patch(\"<module>.{func}\") hinzufügen.",
"en": "{func} called in test '{test}' without @patch — this function {desc}. Add @patch(\"<module>.{func}\").",
"pl": "{func} wywołane w teście '{test}' bez @patch — ta funkcja {desc}. Dodaj @patch(\"<module>.{func}\").",
"ru": "{func} вызвано в тесте '{test}' без @patch — эта функция {desc}. Добавьте @patch(\"<module>.{func}\").",
"zh": "{func} 在测试 '{test}' 中被调用但没有 @patch — 此函数 {desc}。请添加 @patch(\"<module>.{func}\")。"
},
"{level}: {tool} not found.{hint}": {
"en": "{level}: {tool} not found.{hint}",
"bg": "{level}: {tool} не е намерен.{hint}",
"de": "{level}: {tool} nicht gefunden.{hint}",
"en": "{level}: {tool} not found.{hint}",
"pl": "{level}: {tool} nie znaleziono.{hint}",
"ru": "{level}: {tool} не найден.{hint}",
"zh": "{level}: 未找到 {tool}。{hint}"
+27
View File
@@ -0,0 +1,27 @@
"""Typed confirmation validation for destructive operations.
Ensures the user typed an exact confirmation phrase before proceeding
with dangerous operations (e.g. production deploys, database migrations).
Usage::
from devx.utils.confirm import validate_confirmation
if not validate_confirmation(user_input, expected="deploy-production"):
raise SystemExit("Confirmation does not match")
"""
from __future__ import annotations
def validate_confirmation(confirm: str, expected: str) -> bool:
"""Check if confirmation text matches the expected phrase.
Args:
confirm: The confirmation text entered by the user.
expected: The exact phrase that must be matched.
Returns:
True if confirmation matches exactly, False otherwise.
"""
return confirm == expected
+73
View File
@@ -0,0 +1,73 @@
"""Cryptographic secret generation helpers.
Provides safe secret/password generators that avoid shell-option
interpretation issues (e.g. leading ``-`` being parsed as a flag by
``su -c`` in Docker entrypoints).
Usage::
from devx.utils.crypto import generate_secret, generate_password
api_key = generate_secret()
db_password = generate_password(length=32)
"""
from __future__ import annotations
import secrets
_SYMBOLS = "!@#$%^&*()-_=+[]{}|;:,.<>?"
_UPPER = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
_LOWER = "abcdefghijklmnopqrstuvwxyz"
_DIGITS = "0123456789"
def generate_secret() -> str:
"""Generate a URL-safe secret that never starts with ``-``.
A leading ``-`` causes passwords to be interpreted as command-line
options when passed through shell expansion chains (e.g. Nextcloud's
Docker entrypoint uses ``su -c`` which strips quoting).
Returns:
A 43-character URL-safe base64 secret.
"""
value = secrets.token_urlsafe(32)
while value.startswith("-"):
value = secrets.token_urlsafe(32)
return value
def generate_password(length: int = 32) -> str:
"""Generate a password guaranteed to contain upper, lower, digit, and symbol.
The first character is always alphanumeric to avoid being interpreted
as a command-line option when passed through shell expansion chains.
Args:
length: Desired password length (minimum 4).
Returns:
A password string with guaranteed character class coverage.
"""
pools = [_UPPER, _LOWER, _DIGITS, _SYMBOLS]
chars = [secrets.choice(p) for p in pools]
all_chars = "".join(pools)
chars += [secrets.choice(all_chars) for _ in range(length - len(pools))]
secrets.SystemRandom().shuffle(chars)
while chars[0] in _SYMBOLS:
secrets.SystemRandom().shuffle(chars)
return "".join(chars)
def generate_hex_secret(length: int = 32) -> str:
"""Generate a hexadecimal secret of the given length.
Args:
length: Desired number of hex characters (doubled internally
since ``token_hex`` produces pairs).
Returns:
A hexadecimal string.
"""
return secrets.token_hex(length // 2)
+128
View File
@@ -0,0 +1,128 @@
"""File-locked JSON registry for local state management.
Provides a simple JSON-backed key-value store with ``fcntl`` file
locking for safe concurrent access. Useful for CLI tools that need
to track remote resources (runners, VMs, deployments) on the local
machine.
Usage::
from devx.utils.json_registry import JsonRegistry
registry = JsonRegistry(Path("~/.local/share/myapp/state.json"))
registry.add("item1", host="10.0.0.1", user="deploy")
info = registry.get("item1")
registry.remove("item1")
"""
from __future__ import annotations
import copy
import fcntl
import json
from datetime import UTC, datetime
from pathlib import Path
from typing import Any, cast
class JsonRegistry:
"""Manages a local JSON file mapping names to arbitrary metadata.
Uses ``fcntl`` for file locking (shared lock for reads, exclusive
lock for writes) to prevent race conditions in concurrent scenarios.
"""
def __init__(self, path: Path | None = None) -> None:
"""Initialise the registry.
Args:
path: Path to the JSON file. Defaults to
``~/.local/share/devx/registry.json``.
"""
self._path = path or Path.home() / ".local" / "share" / "devx" / "registry.json"
self._data: dict[str, dict[str, Any]] = self._load()
def _load(self) -> dict[str, dict[str, Any]]:
if not self._path.exists():
return {}
try:
with open(self._path) as f:
fcntl.flock(f.fileno(), fcntl.LOCK_SH)
try:
data: Any = json.load(f)
if isinstance(data, dict):
return cast(dict[str, dict[str, Any]], data)
finally:
fcntl.flock(f.fileno(), fcntl.LOCK_UN)
except (json.JSONDecodeError, OSError):
pass
return {}
def _save(self) -> None:
self._path.parent.mkdir(parents=True, exist_ok=True)
with open(self._path, "w") as f:
fcntl.flock(f.fileno(), fcntl.LOCK_EX)
try:
json.dump(self._data, f, indent=2)
finally:
fcntl.flock(f.fileno(), fcntl.LOCK_UN)
def add(self, name: str, **fields: Any) -> None:
"""Register or overwrite an entry in the registry.
Args:
name: Unique key for the entry.
**fields: Arbitrary metadata fields to store.
"""
self._data[name] = {
**fields,
"created_at": datetime.now(UTC).isoformat(),
}
self._save()
def get(self, name: str) -> dict[str, Any] | None:
"""Retrieve entry metadata by name.
Args:
name: Key to look up.
Returns:
A copy of the entry's metadata, or None if not found.
"""
info = self._data.get(name)
if info:
return copy.deepcopy(info)
return None
def remove(self, name: str) -> None:
"""Remove an entry from the registry.
Args:
name: Key to remove. No-op if not found.
"""
if name in self._data:
del self._data[name]
self._save()
def list(self) -> dict[str, dict[str, Any]]:
"""Return a copy of all registered entries.
Returns:
Dict mapping names to metadata copies.
"""
return {name: copy.deepcopy(info) for name, info in self._data.items()}
def update(self, name: str, **fields: Any) -> None:
"""Update fields for an existing entry.
Args:
name: Key to update.
**fields: Fields to update (None values are skipped).
Raises:
KeyError: If the entry doesn't exist.
"""
if name not in self._data:
raise KeyError(name)
self._data[name].update({k: v for k, v in fields.items() if v is not None})
self._save()
+48
View File
@@ -0,0 +1,48 @@
"""XDG-compliant logging configuration for CLI tools.
Provides a standardised logging setup that writes to
``~/.local/state/<app>/logs/<app>.log`` following the XDG state
directory specification. Console output is handled separately by
the application (e.g. via ``click.echo``).
Usage::
from devx.utils.logging import get_logger
logger = get_logger("myapp")
logger.info("Application started")
"""
from __future__ import annotations
import logging
from pathlib import Path
def get_logger(name: str = "devx") -> logging.Logger:
"""Return a configured logger that writes to an XDG state directory.
All messages (including DEBUG) are written to
``~/.local/state/<name>/logs/<name>.log``. Console output is
expected to be handled by the application via ``click.echo``.
Args:
name: Logger name and subdirectory name for log files.
Returns:
A configured :class:`logging.Logger` instance.
"""
logger = logging.getLogger(name)
if logger.handlers:
return logger
logger.setLevel(logging.DEBUG)
log_dir = Path.home() / ".local" / "state" / name / "logs"
log_dir.mkdir(parents=True, exist_ok=True)
file_handler = logging.FileHandler(log_dir / f"{name}.log")
file_handler.setLevel(logging.DEBUG)
file_handler.setFormatter(logging.Formatter("%(asctime)s %(levelname)s %(name)s: %(message)s"))
logger.addHandler(file_handler)
return logger
+102
View File
@@ -0,0 +1,102 @@
"""Network connectivity helpers.
Provides retry-aware HTTP connectivity checks and SSH availability
checks for deployment workflows. Uses ``tenacity`` for exponential
backoff retry logic.
Usage::
from devx.utils.network import check_http_connectivity, wait_for_ssh
check_http_connectivity("https://auth.example.com")
wait_for_ssh("178.105.254.83")
"""
from __future__ import annotations
import logging
import socket
import time
from collections.abc import Callable
import requests
from tenacity import (
Retrying,
before_sleep_log,
retry_if_exception_type,
stop_after_attempt,
wait_exponential,
)
def check_http_connectivity(
base_url: str,
max_attempts: int = 30,
*,
verify: bool = True,
sleep: Callable[[float], None] | None = None,
) -> None:
"""Verify HTTP reachability of *base_url* with retry.
Uses tenacity for retry with exponential backoff (2 s min, 10 s max).
Args:
base_url: URL to check via GET request.
max_attempts: Maximum retry attempts.
verify: Whether to verify TLS certificates.
sleep: Custom sleep function for testing (defaults to ``time.sleep``).
Raises:
requests.exceptions.ConnectionError: If the URL is not reachable
after *max_attempts*.
"""
retrying = Retrying(
stop=stop_after_attempt(max_attempts),
wait=wait_exponential(multiplier=2, min=2, max=10),
retry=retry_if_exception_type(requests.exceptions.ConnectionError),
before_sleep=before_sleep_log(logging.getLogger("devx.utils.network"), logging.WARNING),
sleep=sleep if sleep is not None else time.sleep,
reraise=True,
)
def _check() -> None:
requests.get(base_url, timeout=10, verify=verify) # nosec B501
retrying(_check)
def wait_for_ssh(
host: str,
port: int = 22,
max_attempts: int = 30,
interval: int = 10,
*,
sleep: Callable[[float], None] | None = None,
) -> None:
"""Wait for SSH to be available on a host using a pure-Python socket check.
Uses socket instead of ``nc(1)`` so it works on CI runners without
netcat. Uses exponential backoff: starts at 2 s, doubles each
attempt up to 10 s max.
Args:
host: VM IP address or hostname.
port: SSH port (default 22).
max_attempts: Maximum number of connection attempts.
interval: Base interval for backoff calculation (seconds).
sleep: Custom sleep function for testing (defaults to ``time.sleep``).
Raises:
RuntimeError: If SSH is not available after *max_attempts*.
"""
_sleep = sleep if sleep is not None else time.sleep
for i in range(max_attempts):
try:
with socket.create_connection((host, port), timeout=5):
return
except OSError:
pass
if i < max_attempts - 1:
wait = min(2 * (2**i), 10)
_sleep(wait)
raise RuntimeError(f"SSH not available on {host}:{port} after {max_attempts} attempts")
+132
View File
@@ -0,0 +1,132 @@
"""SSH helpers for running commands on remote hosts.
Provides a simple wrapper around the ``ssh`` CLI for executing commands
on remote machines (e.g. customer VMs, CI runners) without requiring
Ansible. Includes a pure-Python ``wait_for_ssh`` that uses socket
instead of ``nc(1)`` so it works on minimal CI containers.
Usage::
from devx.utils.ssh import ssh_exec, wait_for_ssh
wait_for_ssh("178.105.254.83")
result = ssh_exec("178.105.254.83", "uname -a")
print(result.stdout)
"""
from __future__ import annotations
import socket
import subprocess # nosec B404
import sys
import time
SSH_CONNECT_TIMEOUT = "10"
SSH_HOST_KEY_CHECKING = "no"
def ssh_exec(
host: str,
command: str,
*,
user: str = "deploy",
timeout: int = 30,
check: bool = True,
) -> subprocess.CompletedProcess[str]:
"""Run *command* on *host* via SSH and return the result.
Args:
host: VM IP address or hostname.
command: Shell command to execute on the remote host.
user: SSH user (default ``deploy``).
timeout: Subprocess timeout in seconds.
check: If True, raise ``CalledProcessError`` on non-zero exit.
Returns:
The completed process result with stdout/stderr captured.
"""
result = subprocess.run( # nosec B603, B607, B607
[
"ssh",
"-o",
f"StrictHostKeyChecking={SSH_HOST_KEY_CHECKING}",
"-o",
f"ConnectTimeout={SSH_CONNECT_TIMEOUT}",
f"{user}@{host}",
command,
],
capture_output=True,
text=True,
check=False,
timeout=timeout,
)
if check and result.returncode != 0:
print(f"SSH command failed on {host}: {command}", file=sys.stderr)
print(f" stdout: {result.stdout.strip()}", file=sys.stderr)
print(f" stderr: {result.stderr.strip()}", file=sys.stderr)
result.check_returncode()
return result
def docker_exec_on_vm(
host: str,
container: str,
command: str,
*,
user: str = "deploy",
db_user: str | None = None,
db_name: str | None = None,
timeout: int = 30,
) -> str:
"""Run a command inside a Docker container on a remote VM via SSH.
For PostgreSQL commands, set *db_user* and *db_name* to run
``psql -U <db_user> -d <db_name> -c <command>`` inside the container.
Args:
host: VM IP address or hostname.
container: Docker container name on the remote host.
command: Command to execute inside the container (or SQL if db_user/db_name set).
user: SSH user (default ``deploy``).
db_user: PostgreSQL user name (enables psql mode).
db_name: PostgreSQL database name (enables psql mode).
timeout: Subprocess timeout in seconds.
Returns:
Stripped stdout from the command.
"""
if db_user and db_name:
escaped_sql = command.replace("'", "'\"'\"'")
remote_cmd = f'docker exec {container} psql -U {db_user} -d {db_name} -t -A -c "{escaped_sql}"'
else:
remote_cmd = f"docker exec {container} {command}"
result = ssh_exec(host, remote_cmd, user=user, timeout=timeout)
return result.stdout.strip()
def wait_for_ssh(host: str, port: int = 22, max_attempts: int = 30, interval: int = 10) -> None:
"""Wait for SSH to be available on a host using a pure-Python socket check.
Uses socket instead of ``nc(1)`` so it works on CI runners without
netcat. Uses exponential backoff: starts at 2 s, doubles each
attempt up to 10 s max.
Args:
host: VM IP address or hostname.
port: SSH port (default 22).
max_attempts: Maximum number of connection attempts.
interval: Base interval for backoff calculation (seconds).
Raises:
RuntimeError: If SSH is not available after *max_attempts*.
"""
for i in range(max_attempts):
try:
with socket.create_connection((host, port), timeout=5):
return
except OSError:
pass
if i < max_attempts - 1:
wait = min(2 * (2**i), 10)
time.sleep(wait)
raise RuntimeError(f"SSH not available on {host}:{port} after {max_attempts} attempts")
+102
View File
@@ -0,0 +1,102 @@
"""Operation step tracking with translated reports.
Provides a context manager that tracks multi-step operations and prints
a status report on exit. Steps are marked as pending, in_progress,
completed, or failed. On exception, the last in-progress step is
marked as failed.
Usage::
from devx.utils.step_tracker import track_steps
with track_steps() as tracker:
tracker.begin("Install dependencies")
install_deps()
tracker.done()
tracker.begin("Run tests")
run_tests()
tracker.done()
"""
from __future__ import annotations
from collections.abc import Generator
from contextlib import contextmanager
import click
_STATUS_ICONS = {
"completed": "",
"failed": "",
"pending": "",
"in_progress": "",
}
_STATUS_COLORS = {
"completed": "green",
"failed": "red",
"in_progress": "yellow",
"pending": "white",
}
class Step:
"""A single tracked step in an operation."""
def __init__(self, name: str) -> None:
self.name = name
self.status = "pending"
class StepTracker:
"""Tracks steps of an operation and prints a report on exit."""
def __init__(self) -> None:
self.steps: list[Step] = []
def begin(self, name: str) -> None:
"""Start a new step.
Args:
name: Human-readable step name.
"""
step = Step(name)
self.steps.append(step)
step.status = "in_progress"
def done(self) -> None:
"""Mark the most recent in-progress step as completed."""
if self.steps and self.steps[-1].status == "in_progress":
self.steps[-1].status = "completed"
@contextmanager
def track_steps() -> Generator[StepTracker, None, None]:
"""Context manager that tracks steps and prints a report on exit.
On exception the last in-progress step is marked as failed.
The report is printed in the ``finally`` block so it always appears.
Yields:
A :class:`StepTracker` instance to track steps with.
"""
tracker = StepTracker()
try:
yield tracker
except Exception:
for step in reversed(tracker.steps):
if step.status == "in_progress":
step.status = "failed"
raise
finally:
_print_report(tracker.steps)
def _print_report(steps: list[Step]) -> None:
"""Print an operation report to stdout."""
click.secho("=== Operation Report ===", fg="bright_cyan")
for step in steps:
icon = _STATUS_ICONS.get(step.status, "?")
color = _STATUS_COLORS.get(step.status)
click.secho(f" {icon} {step.name} ({step.status})", fg=color)
+135
View File
@@ -0,0 +1,135 @@
"""Ansible Vault helpers for encrypting and decrypting YAML files.
Wraps ``ansible-vault`` to provide a convenient API for loading and
saving vault-encrypted YAML files. Falls back to plain YAML when no
vault-password file is available, making it safe to use in both
local (with vault) and CI (without vault) environments.
Usage::
from devx.utils.vault import load_vault_yaml, save_vault_yaml
data = load_vault_yaml(Path("secrets.yml"), vault_pass=Path("vault-password"))
data["new_key"] = "value"
save_vault_yaml(Path("secrets.yml"), data, vault_pass=Path("vault-password"))
"""
from __future__ import annotations
import subprocess # nosec B404
from pathlib import Path
import yaml
def encrypt_file(path: Path, vault_pass: Path) -> None:
"""Encrypt a file in-place using ansible-vault.
Args:
path: File to encrypt.
vault_pass: Path to the vault-password file.
"""
subprocess.run( # nosec B603, B607
[
"ansible-vault",
"encrypt",
str(path),
"--vault-password-file",
str(vault_pass),
"--encrypt-vault-id",
"default",
],
check=True,
)
def decrypt_file(path: Path, vault_pass: Path) -> None:
"""Decrypt a file in-place using ansible-vault.
Args:
path: File to decrypt.
vault_pass: Path to the vault-password file.
"""
subprocess.run( # nosec B603, B607
[
"ansible-vault",
"decrypt",
str(path),
"--vault-password-file",
str(vault_pass),
],
check=True,
)
def load_vault_yaml(path: Path, vault_pass: Path | None = None) -> dict:
"""Load a YAML file, decrypting with ansible-vault if vault-password exists.
If *vault_pass* is None or doesn't exist, the file is read as plain
YAML. If decryption fails (file not vault-encrypted), it falls back
to plain YAML.
Args:
path: YAML file path.
vault_pass: Path to the vault-password file (optional).
Returns:
Parsed YAML content as a dict (empty dict if file is empty).
"""
if vault_pass is None or not vault_pass.exists():
with open(path, encoding="utf-8") as f:
return yaml.safe_load(f) or {}
result = subprocess.run( # nosec B603, B607
["ansible-vault", "view", str(path), "--vault-password-file", str(vault_pass)],
capture_output=True,
text=True,
check=False,
)
if result.returncode == 0:
return yaml.safe_load(result.stdout) or {}
if "is not vault encrypted" in result.stderr:
with open(path, encoding="utf-8") as f:
return yaml.safe_load(f) or {}
result.check_returncode() # pragma: no cover
return {} # pragma: no cover
def save_vault_yaml(path: Path, data: dict, vault_pass: Path | None = None) -> None:
"""Write YAML data, encrypting with ansible-vault if vault-password exists.
Args:
path: Destination YAML file path.
data: Data to serialize.
vault_pass: Path to the vault-password file (optional).
"""
plain = yaml.dump(data, default_flow_style=False, sort_keys=False)
with open(path, "w", encoding="utf-8") as f:
f.write(plain)
if vault_pass is not None and vault_pass.exists():
subprocess.run( # nosec B603, B607
[
"ansible-vault",
"encrypt",
str(path),
"--vault-password-file",
str(vault_pass),
"--encrypt-vault-id",
"default",
],
capture_output=True,
check=True,
)
def is_encrypted(path: Path) -> bool:
"""Check if a file is ansible-vault encrypted.
Args:
path: File to check.
Returns:
True if the file starts with the ``$ANSIBLE_VAULT`` marker.
"""
with open(path, encoding="utf-8") as f:
first_line = f.readline()
return "$ANSIBLE_VAULT" in first_line
+9 -3
View File
@@ -237,15 +237,21 @@ class TestExtractConventionalMsg:
class TestRunCmd:
def test_success(self) -> None:
@patch("devx.ci._shared.subprocess.run")
def test_success(self, mock_run: MagicMock) -> None:
mock_run.return_value = MagicMock(returncode=0, stdout="hello\n", stderr="")
result = run_cmd(["echo", "hello"])
assert result.returncode == 0
def test_failure_raises(self) -> None:
@patch("devx.ci._shared.subprocess.run")
def test_failure_raises(self, mock_run: MagicMock) -> None:
mock_run.return_value = MagicMock(returncode=1, stdout="", stderr="error")
with pytest.raises(click.ClickException, match="Command failed"):
run_cmd(["false"])
def test_failure_no_check(self) -> None:
@patch("devx.ci._shared.subprocess.run")
def test_failure_no_check(self, mock_run: MagicMock) -> None:
mock_run.return_value = MagicMock(returncode=1, stdout="", stderr="")
result = run_cmd(["false"], check=False)
assert result.returncode != 0
+15
View File
@@ -292,3 +292,18 @@ class TestCli:
)
assert result.exit_code != 0
assert "does not match Vikunja" in result.output
def test_fails_with_double_prefix_in_vikunja_title(self) -> None:
"""Vikunja title with task ID prefix causes double-prefix in PR title."""
runner = CliRunner()
with (
patch.dict("os.environ", {"DEVX_TASK_PREFIX": "DEVX", "VIKUNJA_TOKEN": "tok"}, clear=True),
patch("devx.ci.check_auto_merge_ready.is_branch_behind_master", return_value=False),
patch("devx.ci.check_auto_merge_ready.get_vikunja_title_optional", return_value="DEVX-1: Fix foo"),
):
result = runner.invoke(
cli,
["--branch", "DEVX-1-fix-foo", "--pr-title", "DEVX-1: Fix foo"],
)
assert result.exit_code != 0
assert "should NOT include" in result.output
+918
View File
@@ -0,0 +1,918 @@
"""Unit tests for devx.tools.check_test_isolation."""
from __future__ import annotations
import textwrap
from pathlib import Path
from click.testing import CliRunner
from devx.tools.check_test_isolation import (
HELPER_INTERNAL_CALLS,
KNOWN_SUBPROCESS_HELPERS,
analyze_file,
analyze_test_files,
cli,
find_test_files,
)
def _write_test_file(tmp_path: Path, content: str) -> Path:
"""Write content to a test file and return the path."""
file = tmp_path / "test_example.py"
file.write_text(textwrap.dedent(content))
return file
class TestFindTestFiles:
def test_finds_test_files_in_directory(self, tmp_path: Path) -> None:
(tmp_path / "test_foo.py").touch()
(tmp_path / "test_bar.py").touch()
(tmp_path / "helper.py").touch()
result = find_test_files(tmp_path)
assert len(result) == 2
assert all(f.name.startswith("test_") for f in result)
def test_single_file(self, tmp_path: Path) -> None:
file = tmp_path / "test_single.py"
file.touch()
result = find_test_files(file)
assert result == [file]
def test_non_python_file(self, tmp_path: Path) -> None:
file = tmp_path / "test_readme.md"
file.touch()
result = find_test_files(file)
assert result == []
class TestAnalyzeFile:
def test_clean_file_no_violations(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
from unittest.mock import patch, MagicMock
class TestExample:
@patch("mymodule.subprocess.run")
def test_with_patch(self, mock_run: MagicMock) -> None:
mymodule.do_thing()
""",
)
violations = analyze_file(file)
assert violations == []
def test_unpatched_subprocess_run(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
def test_direct_subprocess(self) -> None:
subprocess.run(["echo", "hi"])
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-subprocess"
assert "subprocess.run" in violations[0].message
def test_patched_subprocess_no_violation(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
from unittest.mock import patch, MagicMock
import subprocess
class TestExample:
@patch("subprocess.run")
def test_patched(self, mock_run: MagicMock) -> None:
subprocess.run(["echo", "hi"])
""",
)
violations = analyze_file(file)
assert violations == []
def test_unpatched_time_sleep(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
import time
class TestExample:
def test_with_sleep(self) -> None:
time.sleep(5)
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-sleep"
def test_patched_time_sleep_no_violation(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
from unittest.mock import patch, MagicMock
import time
class TestExample:
@patch("time.sleep")
def test_patched_sleep(self, mock_sleep: MagicMock) -> None:
time.sleep(5)
""",
)
violations = analyze_file(file)
assert violations == []
def test_unpatched_known_helper(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
from mymodule import update_doc_versions
class TestExample:
def test_calls_helper(self) -> None:
update_doc_versions("1.0.0")
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-helper"
assert "update_doc_versions" in violations[0].message
def test_patched_helper_no_violation(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
from unittest.mock import patch, MagicMock
from mymodule import update_doc_versions
class TestExample:
@patch("mymodule.update_doc_versions")
def test_patched_helper(self, mock: MagicMock) -> None:
update_doc_versions("1.0.0")
""",
)
violations = analyze_file(file)
assert violations == []
def test_helper_safe_when_subprocess_patched(self, tmp_path: Path) -> None:
"""update_doc_versions is safe if subprocess.run is patched."""
file = _write_test_file(
tmp_path,
"""
from unittest.mock import patch, MagicMock
from mymodule import update_doc_versions
class TestExample:
@patch("subprocess.run")
def test_subprocess_patched(self, mock: MagicMock) -> None:
update_doc_versions("1.0.0")
""",
)
violations = analyze_file(file)
assert violations == []
def test_helper_safe_when_internal_dep_patched(self, tmp_path: Path) -> None:
"""run_tests is safe if run_cmd is patched (run_tests calls run_cmd)."""
file = _write_test_file(
tmp_path,
"""
from unittest.mock import patch, MagicMock
from mymodule import run_tests
class TestExample:
@patch("mymodule.run_cmd")
def test_run_cmd_patched(self, mock: MagicMock) -> None:
run_tests()
""",
)
violations = analyze_file(file)
assert violations == []
def test_excessive_iterations(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_many_iterations(self) -> None:
for _ in range(500):
assert True
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "excessive-iterations"
assert "500" in violations[0].message
def test_acceptable_iterations(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_few_iterations(self) -> None:
for _ in range(50):
assert True
""",
)
violations = analyze_file(file)
assert violations == []
def test_range_with_start_stop(self, tmp_path: Path) -> None:
"""range(0, 500) should also be flagged."""
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_range_start_stop(self) -> None:
for _ in range(0, 500):
assert True
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "excessive-iterations"
def test_subprocess_check_output(self, tmp_path: Path) -> None:
"""subprocess.check_output should also be flagged."""
file = _write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
def test_check_output(self) -> None:
result = subprocess.check_output(["echo", "hi"])
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-subprocess"
def test_subprocess_popen(self, tmp_path: Path) -> None:
"""subprocess.Popen should also be flagged."""
file = _write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
def test_popen(self) -> None:
p = subprocess.Popen(["echo", "hi"])
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-subprocess"
def test_attribute_style_patch(self, tmp_path: Path) -> None:
"""mock.patch.object style should be recognized."""
file = _write_test_file(
tmp_path,
"""
from unittest.mock import mock
import subprocess
class TestExample:
@mock.patch("subprocess.run")
def test_attr_patch(self, mock_run) -> None:
subprocess.run(["echo"])
""",
)
violations = analyze_file(file)
assert violations == []
def test_subprocess_check_call(self, tmp_path: Path) -> None:
"""subprocess.check_call should also be flagged."""
file = _write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
def test_check_call(self) -> None:
subprocess.check_call(["echo", "hi"])
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-subprocess"
def test_subprocess_call(self, tmp_path: Path) -> None:
"""subprocess.call should also be flagged."""
file = _write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
def test_call(self) -> None:
subprocess.call(["echo", "hi"])
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-subprocess"
def test_non_subprocess_attribute_not_flagged(self, tmp_path: Path) -> None:
"""subprocess.something_else should not be flagged."""
file = _write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
def test_other(self) -> None:
x = subprocess.PIPE
""",
)
violations = analyze_file(file)
assert violations == []
def test_async_test_function(self, tmp_path: Path) -> None:
"""Async test functions should be analyzed too."""
file = _write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
async def test_async(self) -> None:
subprocess.run(["echo"])
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-subprocess"
def test_call_with_no_name(self, tmp_path: Path) -> None:
"""Calls with complex expressions (e.g. lambda) should not crash."""
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_lambda_call(self) -> None:
(lambda: None)()
""",
)
violations = analyze_file(file)
assert violations == []
def test_range_with_no_args(self, tmp_path: Path) -> None:
"""range() with no args should not crash."""
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_empty_range(self) -> None:
for _ in range():
pass
""",
)
violations = analyze_file(file)
assert violations == []
def test_range_with_non_constant_stop(self, tmp_path: Path) -> None:
"""range(0, variable) should not be flagged (can't determine count)."""
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_variable_range(self) -> None:
n = 100
for _ in range(0, n):
pass
""",
)
violations = analyze_file(file)
assert violations == []
def test_range_with_non_constant_start(self, tmp_path: Path) -> None:
"""range(variable, 500) should be flagged with stop value."""
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_variable_start(self) -> None:
s = 0
for _ in range(s, 500):
pass
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "excessive-iterations"
def test_for_loop_with_non_range_call(self, tmp_path: Path) -> None:
"""for loop with a non-range call should not crash."""
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_iter_func(self) -> None:
for _ in list([1, 2, 3]):
pass
""",
)
violations = analyze_file(file)
assert violations == []
def test_for_loop_with_list(self, tmp_path: Path) -> None:
"""for loop with a list literal should not crash."""
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_iter_list(self) -> None:
for _ in [1, 2, 3]:
pass
""",
)
violations = analyze_file(file)
assert violations == []
def test_range_with_single_non_int_arg(self, tmp_path: Path) -> None:
"""range(variable) should not crash or flag."""
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_range_var(self) -> None:
n = 50
for _ in range(n):
pass
""",
)
violations = analyze_file(file)
assert violations == []
def test_range_with_three_args(self, tmp_path: Path) -> None:
"""range(0, 500, 1) should be flagged (3 args, stop=500)."""
file = _write_test_file(
tmp_path,
"""
class TestExample:
def test_range_step(self) -> None:
for _ in range(0, 500, 1):
pass
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "excessive-iterations"
def test_non_test_function_not_analyzed(self, tmp_path: Path) -> None:
"""Non-test functions should not be analyzed."""
file = _write_test_file(
tmp_path,
"""
import subprocess
def helper_function() -> None:
subprocess.run(["echo", "hi"])
class TestExample:
def test_uses_helper(self) -> None:
helper_function()
""",
)
violations = analyze_file(file)
# helper_function is not a test, so no violation for its subprocess call
# test_uses_helper calls helper_function, not subprocess directly
assert violations == []
def test_class_level_patch_satisfies_check(self, tmp_path: Path) -> None:
"""@patch on the class should satisfy the check for all methods."""
file = _write_test_file(
tmp_path,
"""
from unittest.mock import patch, MagicMock
import subprocess
@patch("subprocess.run")
class TestExample:
def test_method_a(self, mock: MagicMock) -> None:
subprocess.run(["echo", "a"])
def test_method_b(self, mock: MagicMock) -> None:
subprocess.run(["echo", "b"])
""",
)
violations = analyze_file(file)
assert violations == []
def test_syntax_error_returns_violation(self, tmp_path: Path) -> None:
file = tmp_path / "test_broken.py"
file.write_text("def test(:\n pass\n")
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "syntax-error"
class TestAnalyzeTestFiles:
def test_multiple_files(self, tmp_path: Path) -> None:
_write_test_file(
tmp_path,
"""
import subprocess
class TestA:
def test_a(self) -> None:
subprocess.run(["echo"])
""",
)
file2 = tmp_path / "test_other.py"
file2.write_text(
textwrap.dedent("""
import time
class TestB:
def test_b(self) -> None:
time.sleep(1)
""")
)
violations = analyze_test_files(tmp_path)
assert len(violations) == 2
categories = {v.category for v in violations}
assert "unpatched-subprocess" in categories
assert "unpatched-sleep" in categories
def test_category_filter(self, tmp_path: Path) -> None:
_write_test_file(
tmp_path,
"""
import subprocess
class TestA:
def test_a(self) -> None:
subprocess.run(["echo"])
""",
)
file2 = tmp_path / "test_other.py"
file2.write_text(
textwrap.dedent("""
import time
class TestB:
def test_b(self) -> None:
time.sleep(1)
""")
)
violations = analyze_test_files(tmp_path, categories={"unpatched-sleep"})
assert len(violations) == 1
assert violations[0].category == "unpatched-sleep"
class TestKnownHelpers:
def test_all_helpers_have_internal_calls(self) -> None:
"""Every known helper should have its internal calls documented."""
for helper in KNOWN_SUBPROCESS_HELPERS:
assert helper in HELPER_INTERNAL_CALLS, f"Missing HELPER_INTERNAL_CALLS entry for {helper}"
def test_run_tests_internal_calls_include_run_cmd(self) -> None:
assert "run_cmd" in HELPER_INTERNAL_CALLS["run_tests"]
def test_update_doc_versions_internal_calls_include_subprocess(self) -> None:
assert "subprocess" in HELPER_INTERNAL_CALLS["update_doc_versions"]
class TestIOFunctionChecks:
"""Tests for unpatched I/O function detection."""
def test_unpatched_get_pat_violation(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
from mymodule import get_pat
class TestExample:
def test_calls_get_pat(self) -> None:
result = get_pat("staging")
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-io"
assert "get_pat" in violations[0].message
def test_patched_get_pat_no_violation(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
from unittest.mock import patch
from mymodule import get_pat
class TestExample:
@patch("mymodule.get_pat", return_value="pat")
def test_patched(self, mock) -> None:
result = get_pat("staging")
""",
)
violations = analyze_file(file)
assert violations == []
def test_unpatched_load_secrets_violation(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
from mymodule import load_secrets
class TestExample:
def test_calls_load_secrets(self) -> None:
result = load_secrets("staging")
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-io"
assert "load_secrets" in violations[0].message
def test_patched_load_secrets_no_violation(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
from unittest.mock import patch
from mymodule import load_secrets
class TestExample:
@patch("mymodule.load_secrets", return_value={})
def test_patched(self, mock) -> None:
result = load_secrets("staging")
""",
)
violations = analyze_file(file)
assert violations == []
def test_unpatched_requests_get_violation(self, tmp_path: Path) -> None:
file = _write_test_file(
tmp_path,
"""
import requests
class TestExample:
def test_calls_requests(self) -> None:
resp = requests.get("https://example.com")
""",
)
violations = analyze_file(file)
assert len(violations) == 1
assert violations[0].category == "unpatched-io"
assert "requests.get" in violations[0].message or "get" in violations[0].message
def test_integration_marker_skips_subprocess(self, tmp_path: Path) -> None:
"""@pytest.mark.integration tests should not be flagged for subprocess.run."""
file = _write_test_file(
tmp_path,
"""
import subprocess
import pytest
@pytest.mark.integration
def test_real_subprocess():
subprocess.run(["echo", "hello"])
""",
)
violations = analyze_file(file)
assert violations == []
def test_integration_marker_skips_sleep(self, tmp_path: Path) -> None:
"""@pytest.mark.integration tests should not be flagged for time.sleep."""
file = _write_test_file(
tmp_path,
"""
import time
import pytest
@pytest.mark.integration
def test_real_sleep():
time.sleep(1)
""",
)
violations = analyze_file(file)
assert violations == []
def test_integration_marker_with_args_skips(self, tmp_path: Path) -> None:
"""@pytest.mark.integration(...) with args should also be skipped."""
file = _write_test_file(
tmp_path,
"""
import subprocess
import pytest
@pytest.mark.integration(scope="module")
def test_real_subprocess():
subprocess.run(["echo", "hello"])
""",
)
violations = analyze_file(file)
assert violations == []
def test_integration_directory_skipped(self, tmp_path: Path) -> None:
"""Files in integration/ directories should be skipped entirely."""
integration_dir = tmp_path / "integration"
integration_dir.mkdir()
file = integration_dir / "test_real_io.py"
file.write_text("import subprocess\ndef test_real_subprocess():\n subprocess.run(['echo', 'hello'])\n")
violations = analyze_file(file)
assert violations == []
class TestCli:
"""Tests for the standalone CLI interface."""
def test_clean_directory_exits_zero(self, tmp_path: Path) -> None:
_write_test_file(
tmp_path,
"""
from unittest.mock import patch, MagicMock
class TestExample:
@patch("subprocess.run")
def test_ok(self, mock: MagicMock) -> None:
pass
""",
)
runner = CliRunner()
result = runner.invoke(cli, ["--test-path", str(tmp_path)])
assert result.exit_code == 0
assert "no violations" in result.output
def test_violations_exit_nonzero(self, tmp_path: Path) -> None:
_write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
def test_bad(self) -> None:
subprocess.run(["echo"])
""",
)
runner = CliRunner()
result = runner.invoke(cli, ["--test-path", str(tmp_path)])
assert result.exit_code == 1
assert "FAILED" in result.output
assert "unpatched-subprocess" in result.output
def test_strict_flag(self, tmp_path: Path) -> None:
_write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
def test_bad(self) -> None:
subprocess.run(["echo"])
""",
)
runner = CliRunner()
result = runner.invoke(cli, ["--test-path", str(tmp_path), "--strict"])
assert result.exit_code == 1
def test_category_filter(self, tmp_path: Path) -> None:
_write_test_file(
tmp_path,
"""
import subprocess, time
class TestExample:
def test_bad(self) -> None:
subprocess.run(["echo"])
time.sleep(1)
""",
)
runner = CliRunner()
result = runner.invoke(cli, ["--test-path", str(tmp_path), "--categories", "unpatched-sleep"])
assert result.exit_code == 1
assert "unpatched-sleep" in result.output
assert "unpatched-subprocess" not in result.output
def test_max_loop_iterations_option(self, tmp_path: Path) -> None:
_write_test_file(
tmp_path,
"""
class TestExample:
def test_loop(self) -> None:
for _ in range(10):
assert True
""",
)
runner = CliRunner()
# With max=5, 10 iterations is a violation
result = runner.invoke(cli, ["--test-path", str(tmp_path), "--max-loop-iterations", "5"])
assert result.exit_code == 1
assert "excessive-iterations" in result.output
def test_no_test_files(self, tmp_path: Path) -> None:
runner = CliRunner()
result = runner.invoke(cli, ["--test-path", str(tmp_path)])
assert result.exit_code == 0
assert "no violations" in result.output
def test_strict_clean_directory_exits_zero(self, tmp_path: Path) -> None:
"""Strict mode with no violations should still exit 0."""
_write_test_file(
tmp_path,
"""
from unittest.mock import patch, MagicMock
class TestExample:
@patch("subprocess.run")
def test_ok(self, mock: MagicMock) -> None:
pass
""",
)
runner = CliRunner()
result = runner.invoke(cli, ["--test-path", str(tmp_path), "--strict"])
assert result.exit_code == 0
class TestPytestPlugin:
"""Tests for the pytest plugin hooks.
These hooks are marked with pragma: no cover because they're loaded
by pytest before coverage instrumentation starts. We test them via
direct calls to verify correctness.
"""
def test_pytest_addoption_registers_options(self) -> None:
"""Verify that pytest_addoption registers the expected options."""
from unittest.mock import MagicMock
from devx.tools.check_test_isolation import pytest_addoption
parser = MagicMock()
pytest_addoption(parser)
addoption_calls = parser.addoption.call_args_list
assert len(addoption_calls) >= 3
def test_pytest_collection_finish_noop_when_disabled(self) -> None:
"""Plugin should skip analysis when --no-test-isolation is set."""
from unittest.mock import MagicMock
from devx.tools.check_test_isolation import pytest_collection_finish
session = MagicMock()
session.config.getoption.side_effect = lambda opt: opt == "--no-test-isolation"
pytest_collection_finish(session)
def test_pytest_collection_finish_no_violations(self) -> None:
"""Plugin should not emit warnings when there are no violations."""
from unittest.mock import MagicMock
from devx.tools.check_test_isolation import pytest_collection_finish
session = MagicMock()
session.config.getoption.side_effect = lambda opt: False
session.items = []
pytest_collection_finish(session)
def test_pytest_collection_finish_with_violation(self, tmp_path: Path) -> None:
"""Plugin should emit warnings when violations are found."""
import warnings
from unittest.mock import MagicMock
from devx.tools.check_test_isolation import pytest_collection_finish
test_file = _write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
def test_bad(self) -> None:
subprocess.run(["echo"])
""",
)
session = MagicMock()
session.config.getoption.side_effect = lambda opt: False
item = MagicMock()
item.fspath = str(test_file)
session.items = [item]
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
pytest_collection_finish(session)
assert len(w) >= 1
assert any("Test isolation violation" in str(warning.message) for warning in w)
def test_pytest_collection_finish_strict_mode(self, tmp_path: Path) -> None:
"""Plugin should emit warnings and print summary in strict mode."""
import warnings
from unittest.mock import MagicMock
from devx.tools.check_test_isolation import pytest_collection_finish
test_file = _write_test_file(
tmp_path,
"""
import subprocess
class TestExample:
def test_bad(self) -> None:
subprocess.run(["echo"])
""",
)
session = MagicMock()
session.config.getoption.side_effect = lambda opt: {
"--no-test-isolation": False,
"--strict-test-isolation": True,
"--test-isolation-max-loop": 100,
}.get(opt, False)
item = MagicMock()
item.fspath = str(test_file)
session.items = [item]
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
pytest_collection_finish(session)
assert len(w) >= 1
assert any("Test isolation violation" in str(warning.message) for warning in w)
+12
View File
@@ -4,6 +4,7 @@ import json
from pathlib import Path
from unittest.mock import MagicMock, patch
import click
import pytest
from click.testing import CliRunner
@@ -249,3 +250,14 @@ class TestMain:
args, kwargs = mock_count.call_args
assert "myorg" in args
assert "myrepo" in args
@patch("devx.ci.discover_runners.get_ci_token", side_effect=click.ClickException("no token"))
@patch("devx.ci.discover_runners.get_runner_count", return_value=3)
def test_missing_token_runs_without_api(self, mock_count: MagicMock, mock_token: MagicMock) -> None:
"""When no token is available, runner discovery falls back to env/default."""
runner = CliRunner()
result = runner.invoke(main, ["--count"])
assert result.exit_code == 0
assert result.output.strip() == "3"
args, _ = mock_count.call_args
assert args[1] is None # token passed as None when missing
+26 -9
View File
@@ -9,10 +9,10 @@ from click.testing import CliRunner
from devx.molecule.distribute_molecule import (
DEFAULT_ROLES_ROOT,
MOLECULE_ROOT,
PLATFORMS,
MultiRoleTestPair,
TestPair,
_default_molecule_root,
_load_molecule_weights,
_lpt_distribute,
_scenario_weight,
@@ -43,8 +43,25 @@ class TestDiscoverScenarios:
discover_scenarios(tmp_path / "nonexistent")
assert "not found" in str(exc.value)
def test_default_root_constant(self) -> None:
assert Path("ansible/roles/gitea-runner/molecule") == MOLECULE_ROOT
def test_default_root_auto_discovery(self, tmp_path: Path) -> None:
"""_default_molecule_root auto-discovers first role with molecule/ dir."""
# When no roles exist, returns a fallback path
with patch("devx.molecule.distribute_molecule.DEFAULT_ROLES_ROOT", tmp_path / "roles"):
result = _default_molecule_root()
assert "molecule" in str(result)
# When a role has molecule/, it's discovered
(tmp_path / "roles" / "my_role" / "molecule").mkdir(parents=True)
with patch("devx.molecule.distribute_molecule.DEFAULT_ROLES_ROOT", tmp_path / "roles"):
result = _default_molecule_root()
assert result == tmp_path / "roles" / "my_role" / "molecule"
def test_default_root_no_molecule_dirs(self, tmp_path: Path) -> None:
"""When roles exist but none have molecule/, returns fallback path."""
(tmp_path / "roles" / "role_without_molecule").mkdir(parents=True)
with patch("devx.molecule.distribute_molecule.DEFAULT_ROLES_ROOT", tmp_path / "roles"):
result = _default_molecule_root()
assert result == tmp_path / "roles" / "molecule"
class TestPairEncoding:
@@ -150,7 +167,7 @@ class TestCli:
root = tmp_path / "molecule"
(root / "alpha").mkdir(parents=True)
(root / "beta").mkdir(parents=True)
with patch("devx.molecule.distribute_molecule.MOLECULE_ROOT", root):
with patch("devx.molecule.distribute_molecule._default_molecule_root", return_value=root):
runner = CliRunner()
result = runner.invoke(cli, ["--list"])
assert result.exit_code == 0
@@ -176,7 +193,7 @@ class TestCli:
root = tmp_path / "molecule"
for s in ["a", "b", "c"]:
(root / s).mkdir(parents=True)
with patch("devx.molecule.distribute_molecule.MOLECULE_ROOT", root):
with patch("devx.molecule.distribute_molecule._default_molecule_root", return_value=root):
runner = CliRunner()
result = runner.invoke(cli, ["--max-runners", "3"])
assert result.exit_code == 0
@@ -191,7 +208,7 @@ class TestCli:
root = tmp_path / "molecule"
(root / "alpha").mkdir(parents=True)
with patch("devx.molecule.distribute_molecule.MOLECULE_ROOT", root):
with patch("devx.molecule.distribute_molecule._default_molecule_root", return_value=root):
runner = CliRunner()
# 1-based index: "1" maps to internal 0
result = runner.invoke(cli, ["--runner-index", "1", "--max-runners", "3"])
@@ -209,7 +226,7 @@ class TestGithubEnv:
scenario = root / "alpha"
scenario.mkdir(parents=True)
(scenario / "molecule.yml").write_text("name: alpha\n")
with patch("devx.molecule.distribute_molecule.MOLECULE_ROOT", root):
with patch("devx.molecule.distribute_molecule._default_molecule_root", return_value=root):
runner = CliRunner()
result = runner.invoke(cli, ["--runner-index", "1", "--max-runners", "3", "--github-env"])
assert result.exit_code == 0
@@ -224,7 +241,7 @@ class TestGithubEnv:
scenario = root / "alpha"
scenario.mkdir(parents=True)
(scenario / "molecule.yml").write_text("name: alpha\n")
with patch("devx.molecule.distribute_molecule.MOLECULE_ROOT", root):
with patch("devx.molecule.distribute_molecule._default_molecule_root", return_value=root):
runner = CliRunner()
result = runner.invoke(
cli, ["--runner-index", "5", "--max-runners", "3", "--github-env", "--skip-if-excess"]
@@ -240,7 +257,7 @@ class TestGithubEnv:
scenario = root / "alpha"
scenario.mkdir(parents=True)
(scenario / "molecule.yml").write_text("name: alpha\n")
with patch("devx.molecule.distribute_molecule.MOLECULE_ROOT", root):
with patch("devx.molecule.distribute_molecule._default_molecule_root", return_value=root):
runner = CliRunner()
result = runner.invoke(cli, ["--runner-index", "1", "--max-runners", "3", "--github-env"])
assert result.exit_code != 0
+14 -2
View File
@@ -104,12 +104,24 @@ class TestMain:
assert result.exit_code != 0
assert "Role directory not found" in result.output
def test_role_dir_no_molecule(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
"""Roles dir exists but no role has molecule/ — should error."""
monkeypatch.chdir(tmp_path)
bin_dir = tmp_path / ".venv" / "bin"
bin_dir.mkdir(parents=True)
(bin_dir / "molecule").touch()
(tmp_path / "ansible" / "roles" / "role_without_molecule").mkdir(parents=True)
runner = CliRunner()
result = runner.invoke(molecule_all.main, ["--bin", str(bin_dir)])
assert result.exit_code != 0
assert "Role directory not found" in result.output
def test_all_pass(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.chdir(tmp_path)
bin_dir = tmp_path / ".venv" / "bin"
bin_dir.mkdir(parents=True)
(bin_dir / "molecule").touch()
(tmp_path / "ansible" / "roles" / "gitea-runner").mkdir(parents=True)
(tmp_path / "ansible" / "roles" / "gitea-runner" / "molecule").mkdir(parents=True)
runner = CliRunner()
with patch("devx.molecule.molecule_all._run_platform", return_value=0):
@@ -122,7 +134,7 @@ class TestMain:
bin_dir = tmp_path / ".venv" / "bin"
bin_dir.mkdir(parents=True)
(bin_dir / "molecule").touch()
(tmp_path / "ansible" / "roles" / "gitea-runner").mkdir(parents=True)
(tmp_path / "ansible" / "roles" / "gitea-runner" / "molecule").mkdir(parents=True)
runner = CliRunner()
with patch("devx.molecule.molecule_all._run_platform", return_value=1):
+32 -2
View File
@@ -186,6 +186,28 @@ class TestCli:
timeout=60,
)
@patch("devx.molecule.molecule_ci_guard.get_ci_token", side_effect=click.ClickException("no token"))
def test_missing_token_runs_without_polling(self, mock_token: MagicMock) -> None:
"""When no token is available, cross-runner polling is skipped."""
from click.testing import CliRunner
with (
patch("devx.molecule.molecule_ci_guard.subprocess.Popen") as mock_popen,
patch("devx.molecule.molecule_ci_guard.subprocess.run") as mock_run,
patch("devx.molecule.molecule_ci_guard.poll_for_other_failures") as mock_poll,
patch("time.sleep"),
):
proc = MagicMock()
proc.poll.return_value = 0
proc.returncode = 0
mock_popen.return_value = proc
mock_run.return_value = MagicMock(returncode=0)
runner = CliRunner()
result = runner.invoke(cli, ["default|ubuntu-2204|img:latest|"])
assert result.exit_code == 0
mock_poll.assert_not_called()
def test_invalid_pair_format_raises(self) -> None:
"""Pair with fewer than 2 parts should raise."""
from click.testing import CliRunner
@@ -502,9 +524,17 @@ class TestResolveRoleDir:
result = resolve_role_dir("docker-base", None, tmp_path)
assert result == tmp_path / "ansible" / "roles" / "docker-base"
def test_single_role_uses_default(self, tmp_path: Path) -> None:
def test_single_role_auto_discovers(self, tmp_path: Path) -> None:
"""Single-role mode auto-discovers first role with molecule/ dir."""
roles_dir = tmp_path / "ansible" / "roles"
(roles_dir / "my_role" / "molecule").mkdir(parents=True)
result = resolve_role_dir("", None, tmp_path)
assert result == tmp_path / "ansible" / "roles" / "gitea-runner"
assert result == roles_dir / "my_role"
def test_single_role_no_roles_returns_fallback(self, tmp_path: Path) -> None:
"""When no roles exist, returns a fallback path (will error at runtime)."""
result = resolve_role_dir("", None, tmp_path)
assert "roles" in str(result)
class TestCliMultiRole:
@@ -4,6 +4,7 @@ import json
from pathlib import Path
from unittest.mock import MagicMock, patch
import click
import pytest
from click.testing import CliRunner
@@ -219,3 +220,14 @@ class TestMain:
args, kwargs = mock_count.call_args
assert "myorg" in args
assert "myrepo" in args
@patch("devx.molecule.discover_runners.get_ci_token", side_effect=click.ClickException("no token"))
@patch("devx.molecule.discover_runners.get_runner_count", return_value=3)
def test_missing_token_runs_without_api(self, mock_count: MagicMock, mock_token: MagicMock) -> None:
"""When no token is available, runner discovery falls back to env/default."""
runner = CliRunner()
result = runner.invoke(main, ["--count"])
assert result.exit_code == 0
assert result.output.strip() == "3"
args, _ = mock_count.call_args
assert args[1] is None # token passed as None when missing
+7 -2
View File
@@ -12,9 +12,14 @@ 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)
for name in ("DEVELOPER_GITEA_API_TOKEN", "CI_GITEA_API_TOKEN", "CI_GITEA_TOKEN"):
monkeypatch.delenv(name, raising=False)
runner = CliRunner()
result = runner.invoke(cli, ["--pr", "42", "--label", "ready-to-merge"])
result = runner.invoke(
cli,
["--pr", "42", "--label", "ready-to-merge"],
env={"DEVELOPER_GITEA_API_TOKEN": "", "CI_GITEA_API_TOKEN": "", "CI_GITEA_TOKEN": ""},
)
assert result.exit_code != 0
assert "CI_GITEA_TOKEN" in result.output
+7 -2
View File
@@ -153,9 +153,14 @@ class TestPrintLogs:
class TestCli:
def test_no_token_raises(self, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.delenv("CI_GITEA_TOKEN", raising=False)
for name in ("DEVELOPER_GITEA_API_TOKEN", "CI_GITEA_API_TOKEN", "CI_GITEA_TOKEN"):
monkeypatch.delenv(name, raising=False)
runner = CliRunner()
result = runner.invoke(cli, ["--pr", "42"])
result = runner.invoke(
cli,
["--pr", "42"],
env={"DEVELOPER_GITEA_API_TOKEN": "", "CI_GITEA_API_TOKEN": "", "CI_GITEA_TOKEN": ""},
)
assert result.exit_code != 0
assert "CI_GITEA_TOKEN" in result.output
+77 -3
View File
@@ -2,6 +2,7 @@
from unittest.mock import MagicMock, patch
import pytest
from click.testing import CliRunner
from devx.ci.pr_review import (
@@ -756,9 +757,10 @@ class TestMain:
result = runner.invoke(main, ["42", "my-org/my-repo"], env={"CI_GITEA_TOKEN": "fake"})
assert result.exit_code != 0
@patch.dict("os.environ", {"CI_GITEA_API_TOKEN": "", "CI_GITEA_TOKEN": ""})
def test_no_token_raises(self) -> None:
runner = CliRunner()
result = runner.invoke(main, ["42", "my-org/my-repo"], env={"CI_GITEA_TOKEN": ""})
result = runner.invoke(main, ["42", "my-org/my-repo"], env={"CI_GITEA_API_TOKEN": "", "CI_GITEA_TOKEN": ""})
assert result.exit_code != 0
assert "CI_GITEA_TOKEN" in result.output
@@ -901,7 +903,12 @@ class TestManualReview:
mock_client_class.return_value.create_review.assert_not_called()
@patch("devx.ci.pr_review.GiteaClient")
def test_manual_review_self_approval_fallback(self, mock_client_class: MagicMock) -> None:
def test_manual_review_self_approval_fallback_to_comment(
self, mock_client_class: MagicMock, monkeypatch: pytest.MonkeyPatch
) -> None:
"""Self-approval with no CI token available → fall back to COMMENT."""
monkeypatch.delenv("CI_GITEA_API_TOKEN", raising=False)
monkeypatch.delenv("CI_GITEA_TOKEN", raising=False)
client = mock_client_class.return_value
client.create_review.side_effect = [
APIError(422, "approve your own pull is not allowed"),
@@ -921,10 +928,77 @@ class TestManualReview:
"--checklist-categories",
"1,2,3,4,5,6,7,8",
],
env={"CI_GITEA_TOKEN": "fake"},
env={"REVIEWER_GITEA_API_TOKEN": "fake-reviewer"},
)
assert result.exit_code == 0
assert "Review #202" in result.output
# Without CI_GITEA_API_TOKEN, the fallback is COMMENT
assert "Self-approval not allowed. Posting COMMENT instead." in result.output
assert client.create_review.call_count == 2
assert client.create_review.call_args_list[1].kwargs.get("event") == "COMMENT"
@patch("devx.ci.pr_review.GiteaClient")
def test_manual_review_self_approval_falls_back_to_ci_token(self, mock_client_class: MagicMock) -> None:
"""Self-approval with CI token available → retry APPROVE with CI token (different user)."""
client = mock_client_class.return_value
client.create_review.side_effect = [
APIError(422, "approve your own pull is not allowed"),
{"id": 303},
]
runner = CliRunner()
result = runner.invoke(
main,
[
"42",
"oblachno-oss/devx",
"--event",
"APPROVE",
"--body",
"x" * 60,
"--checklist-confirmed",
"--checklist-categories",
"1,2,3,4,5,6,7,8",
],
env={"REVIEWER_GITEA_API_TOKEN": "fake-reviewer", "CI_GITEA_API_TOKEN": "fake-ci"},
)
assert result.exit_code == 0
assert "Review #303" in result.output
assert "Retrying with CI token" in result.output
# Second call should still be APPROVE (CI token retry)
assert client.create_review.call_count == 2
assert client.create_review.call_args_list[1].kwargs.get("event") == "APPROVE"
@patch("devx.ci.pr_review.GiteaClient")
def test_manual_review_ci_token_also_fails_falls_back_to_comment(self, mock_client_class: MagicMock) -> None:
"""Self-approval + CI token retry also fails → fall back to COMMENT."""
client = mock_client_class.return_value
client.create_review.side_effect = [
APIError(422, "approve your own pull is not allowed"),
APIError(422, "approve your own pull is not allowed"),
{"id": 404},
]
runner = CliRunner()
result = runner.invoke(
main,
[
"42",
"oblachno-oss/devx",
"--event",
"APPROVE",
"--body",
"x" * 60,
"--checklist-confirmed",
"--checklist-categories",
"1,2,3,4,5,6,7,8",
],
env={"REVIEWER_GITEA_API_TOKEN": "fake-reviewer", "CI_GITEA_API_TOKEN": "fake-ci"},
)
assert result.exit_code == 0
assert "Review #404" in result.output
assert "CI token also cannot approve" in result.output
# Third call should be COMMENT (final fallback)
assert client.create_review.call_count == 3
assert client.create_review.call_args_list[2].kwargs.get("event") == "COMMENT"
@patch("devx.ci.pr_review.GiteaClient")
def test_manual_review_other_error_re_raises(self, mock_client_class: MagicMock) -> None:
+7 -2
View File
@@ -122,9 +122,14 @@ class TestWaitForCompletion:
class TestCli:
def test_no_token_raises(self, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.delenv("CI_GITEA_TOKEN", raising=False)
for name in ("DEVELOPER_GITEA_API_TOKEN", "CI_GITEA_API_TOKEN", "CI_GITEA_TOKEN"):
monkeypatch.delenv(name, raising=False)
runner = CliRunner()
result = runner.invoke(cli, ["--pr", "42"])
result = runner.invoke(
cli,
["--pr", "42"],
env={"DEVELOPER_GITEA_API_TOKEN": "", "CI_GITEA_API_TOKEN": "", "CI_GITEA_TOKEN": ""},
)
assert result.exit_code != 0
assert "CI_GITEA_TOKEN" in result.output
+62
View File
@@ -0,0 +1,62 @@
"""Unit tests for devx.ci.record_deployed_tag."""
from __future__ import annotations
from unittest.mock import MagicMock, patch
from click.testing import CliRunner
from devx.ci.record_deployed_tag import main
class TestRecordDeployedTag:
@patch("devx.ci.record_deployed_tag.GiteaClient")
@patch("devx.ci.record_deployed_tag.get_ci_token")
def test_records_production_tag(self, mock_token: MagicMock, mock_client: MagicMock) -> None:
mock_token.return_value = "fake-token"
client_instance = MagicMock()
mock_client.return_value = client_instance
runner = CliRunner()
result = runner.invoke(main, ["--env", "production", "--tag", "v1.0.0"])
assert result.exit_code == 0
assert "PRODUCTION_DEPLOY_TAG" in result.output
assert "v1.0.0" in result.output
client_instance.set_repo_variable.assert_called_once_with("PRODUCTION_DEPLOY_TAG", "v1.0.0")
@patch("devx.ci.record_deployed_tag.GiteaClient")
@patch("devx.ci.record_deployed_tag.get_ci_token")
def test_records_staging_tag(self, mock_token: MagicMock, mock_client: MagicMock) -> None:
mock_token.return_value = "fake-token"
client_instance = MagicMock()
mock_client.return_value = client_instance
runner = CliRunner()
result = runner.invoke(main, ["--env", "staging", "--tag", "master-abc123"])
assert result.exit_code == 0
assert "STAGING_DEPLOY_TAG" in result.output
client_instance.set_repo_variable.assert_called_once_with("STAGING_DEPLOY_TAG", "master-abc123")
@patch("devx.ci.record_deployed_tag.get_ci_token")
def test_token_error_exits_nonzero(self, mock_token: MagicMock) -> None:
import click
mock_token.side_effect = click.ClickException("No token available")
runner = CliRunner()
result = runner.invoke(main, ["--env", "production", "--tag", "v1.0.0"])
assert result.exit_code == 1
assert "No token available" in result.output
def test_invalid_env_choice(self) -> None:
runner = CliRunner()
result = runner.invoke(main, ["--env", "invalid", "--tag", "v1.0.0"])
assert result.exit_code != 0
def test_missing_tag_option(self) -> None:
runner = CliRunner()
result = runner.invoke(main, ["--env", "production"])
assert result.exit_code != 0
+8
View File
@@ -34,19 +34,25 @@ class TestRun:
class TestInstallPythonDeps:
@patch("devx.tools.setup.subprocess.run")
@patch.dict(os.environ, {}, clear=False)
def test_install_dev(self, mock_run: MagicMock) -> None:
os.environ.pop("PIP_BREAK_SYSTEM_PACKAGES", None)
mock_run.return_value = MagicMock(returncode=0)
_install_python_deps(".venv/bin", "dev")
mock_run.assert_called_once_with([".venv/bin/pip", "install", "-e", ".[dev]"], check=False)
@patch("devx.tools.setup.subprocess.run")
@patch.dict(os.environ, {}, clear=False)
def test_install_ci(self, mock_run: MagicMock) -> None:
os.environ.pop("PIP_BREAK_SYSTEM_PACKAGES", None)
mock_run.return_value = MagicMock(returncode=0)
_install_python_deps(".venv/bin", "ci")
mock_run.assert_called_once_with([".venv/bin/pip", "install", "-e", ".[ci]"], check=False)
@patch("devx.tools.setup.subprocess.run")
@patch.dict(os.environ, {}, clear=False)
def test_install_custom_extras(self, mock_run: MagicMock) -> None:
os.environ.pop("PIP_BREAK_SYSTEM_PACKAGES", None)
mock_run.return_value = MagicMock(returncode=0)
_install_python_deps(".venv/bin", "ci,lint")
mock_run.assert_called_once_with([".venv/bin/pip", "install", "-e", ".[ci,lint]"], check=False)
@@ -71,7 +77,9 @@ class TestInstallPythonDeps:
)
@patch("devx.tools.setup.subprocess.run")
@patch.dict(os.environ, {}, clear=False)
def test_install_failure_without_break_system(self, mock_run: MagicMock) -> None:
os.environ.pop("PIP_BREAK_SYSTEM_PACKAGES", None)
mock_run.return_value = MagicMock(returncode=1)
with pytest.raises(subprocess.CalledProcessError):
_install_python_deps(".venv/bin", "ci")
+3 -2
View File
@@ -256,9 +256,10 @@ class TestCommitAndPush:
class TestMain:
def test_no_token_raises(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.delenv("CI_GITEA_TOKEN", raising=False)
for name in ("CI_GITEA_API_TOKEN", "CI_GITEA_TOKEN"):
monkeypatch.delenv(name, raising=False)
runner = CliRunner()
result = runner.invoke(main, [])
result = runner.invoke(main, [], env={"CI_GITEA_API_TOKEN": "", "CI_GITEA_TOKEN": ""})
assert result.exit_code != 0
assert "CI_GITEA_TOKEN" in result.output
+28
View File
@@ -0,0 +1,28 @@
"""Unit tests for devx.utils.confirm."""
from __future__ import annotations
from devx.utils.confirm import validate_confirmation
class TestValidateConfirmation:
def test_exact_match(self) -> None:
assert validate_confirmation("deploy-production", "deploy-production") is True
def test_mismatch(self) -> None:
assert validate_confirmation("deploy-staging", "deploy-production") is False
def test_empty_string(self) -> None:
assert validate_confirmation("", "deploy-production") is False
def test_case_sensitive(self) -> None:
assert validate_confirmation("Deploy-Production", "deploy-production") is False
def test_partial_match(self) -> None:
assert validate_confirmation("deploy", "deploy-production") is False
def test_extra_whitespace(self) -> None:
assert validate_confirmation("deploy-production ", "deploy-production") is False
def test_custom_expected(self) -> None:
assert validate_confirmation("yes-delete-all", "yes-delete-all") is True
+84
View File
@@ -0,0 +1,84 @@
"""Unit tests for devx.utils.crypto."""
from __future__ import annotations
import re
from unittest.mock import patch
from devx.utils.crypto import (
_DIGITS,
_LOWER,
_SYMBOLS,
_UPPER,
generate_hex_secret,
generate_password,
generate_secret,
)
class TestGenerateSecret:
def test_returns_url_safe_string(self) -> None:
secret = generate_secret()
assert isinstance(secret, str)
assert len(secret) > 0
# URL-safe base64 characters only
assert re.match(r"^[A-Za-z0-9_-]+$", secret)
def test_never_starts_with_dash(self) -> None:
for _ in range(50):
secret = generate_secret()
assert not secret.startswith("-")
def test_url_safe_no_plus_slash(self) -> None:
# token_urlsafe uses base64url which has no + or /
for _ in range(50):
secret = generate_secret()
assert "+" not in secret
assert "/" not in secret
def test_retries_on_leading_dash(self) -> None:
"""When token_urlsafe returns a value starting with '-', it retries."""
# First call returns a dash-prefixed value, second returns a clean one
with patch("devx.utils.crypto.secrets.token_urlsafe", side_effect=["-bad-value", "good-value"]):
secret = generate_secret()
assert secret == "good-value"
class TestGeneratePassword:
def test_default_length(self) -> None:
pw = generate_password()
assert len(pw) == 32
def test_custom_length(self) -> None:
pw = generate_password(length=64)
assert len(pw) == 64
def test_contains_all_char_classes(self) -> None:
pw = generate_password(length=32)
assert any(c in _UPPER for c in pw), "Missing uppercase"
assert any(c in _LOWER for c in pw), "Missing lowercase"
assert any(c in _DIGITS for c in pw), "Missing digits"
assert any(c in _SYMBOLS for c in pw), "Missing symbols"
def test_first_char_alphanumeric(self) -> None:
for _ in range(50):
pw = generate_password()
assert pw[0] not in _SYMBOLS, f"First char '{pw[0]}' is a symbol"
def test_minimum_length_4(self) -> None:
pw = generate_password(length=4)
assert len(pw) == 4
class TestGenerateHexSecret:
def test_returns_hex_string(self) -> None:
secret = generate_hex_secret(length=32)
assert re.match(r"^[0-9a-f]+$", secret)
def test_correct_length(self) -> None:
secret = generate_hex_secret(length=20)
assert len(secret) == 20
def test_empty_for_zero(self) -> None:
secret = generate_hex_secret(length=0)
assert secret == ""
+110
View File
@@ -0,0 +1,110 @@
"""Unit tests for devx.utils.json_registry."""
from __future__ import annotations
from pathlib import Path
import pytest
from devx.utils.json_registry import JsonRegistry
class TestJsonRegistry:
def test_add_and_get(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
reg.add("item1", host="10.0.0.1", user="deploy")
info = reg.get("item1")
assert info is not None
assert info["host"] == "10.0.0.1"
assert info["user"] == "deploy"
assert "created_at" in info
def test_get_nonexistent(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
assert reg.get("nope") is None
def test_remove(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
reg.add("item1", host="10.0.0.1")
reg.remove("item1")
assert reg.get("item1") is None
def test_remove_nonexistent_is_noop(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
reg.remove("nonexistent") # should not raise
def test_list(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
reg.add("a", host="1.1.1.1")
reg.add("b", host="2.2.2.2")
items = reg.list()
assert set(items.keys()) == {"a", "b"}
assert items["a"]["host"] == "1.1.1.1"
def test_list_empty(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
assert reg.list() == {}
def test_update_existing(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
reg.add("item", host="1.1.1.1", status="active")
reg.update("item", status="inactive")
info = reg.get("item")
assert info["status"] == "inactive"
assert info["host"] == "1.1.1.1" # unchanged
def test_update_nonexistent_raises(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
with pytest.raises(KeyError):
reg.update("nonexistent", host="1.1.1.1")
def test_update_skips_none_values(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
reg.add("item", host="1.1.1.1")
reg.update("item", host=None, status="active")
info = reg.get("item")
assert info["host"] == "1.1.1.1" # not overwritten by None
assert info["status"] == "active"
def test_persistence_across_instances(self, tmp_path: Path) -> None:
path = tmp_path / "state.json"
reg1 = JsonRegistry(path)
reg1.add("item", host="10.0.0.1")
reg2 = JsonRegistry(path)
info = reg2.get("item")
assert info is not None
assert info["host"] == "10.0.0.1"
def test_overwrite_existing(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
reg.add("item", host="1.1.1.1")
reg.add("item", host="2.2.2.2")
info = reg.get("item")
assert info["host"] == "2.2.2.2"
def test_corrupt_json_returns_empty(self, tmp_path: Path) -> None:
path = tmp_path / "state.json"
path.write_text("{invalid json")
reg = JsonRegistry(path)
assert reg.list() == {}
def test_nonexistent_file_returns_empty(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "nonexistent.json")
assert reg.list() == {}
def test_creates_parent_dirs(self, tmp_path: Path) -> None:
path = tmp_path / "subdir" / "deeper" / "state.json"
reg = JsonRegistry(path)
reg.add("item", host="1.1.1.1")
assert path.exists()
def test_get_returns_copy(self, tmp_path: Path) -> None:
reg = JsonRegistry(tmp_path / "state.json")
reg.add("item", host="1.1.1.1", tags=["a", "b"])
info = reg.get("item")
assert info is not None
info["tags"].append("c")
# Original should be unchanged
info2 = reg.get("item")
assert info2 is not None
assert info2["tags"] == ["a", "b"]
+53
View File
@@ -0,0 +1,53 @@
"""Unit tests for devx.utils.logging."""
from __future__ import annotations
import logging
from pathlib import Path
from unittest.mock import patch
from devx.utils.logging import get_logger
class TestGetLogger:
def test_returns_logger_with_handlers(self) -> None:
logger = get_logger("test_devx_unit_1")
assert logger.handlers
assert isinstance(logger.handlers[0], logging.FileHandler)
def test_idempotent(self) -> None:
logger1 = get_logger("test_devx_unit_2")
initial_count = len(logger1.handlers)
logger2 = get_logger("test_devx_unit_2")
assert logger1 is logger2
assert len(logger2.handlers) == initial_count
def test_log_level_is_debug(self) -> None:
logger = get_logger("test_devx_unit_3")
assert logger.level == logging.DEBUG
def test_file_handler_level_is_debug(self) -> None:
logger = get_logger("test_devx_unit_4")
file_handler = logger.handlers[0]
assert file_handler.level == logging.DEBUG
def test_default_name(self) -> None:
logger = get_logger()
assert logger.name == "devx"
def test_creates_log_directory(self, tmp_path: Path) -> None:
with patch.object(Path, "home", return_value=tmp_path):
get_logger("test_app_creates_dir")
log_dir = tmp_path / ".local" / "state" / "test_app_creates_dir" / "logs"
assert log_dir.exists()
assert (log_dir / "test_app_creates_dir.log").exists()
def test_formatter_includes_timestamp(self) -> None:
logger = get_logger("test_devx_unit_5")
file_handler = logger.handlers[0]
fmt = file_handler.formatter
assert fmt is not None
assert "%(asctime)s" in fmt._fmt
assert "%(levelname)s" in fmt._fmt
assert "%(name)s" in fmt._fmt
assert "%(message)s" in fmt._fmt
+71
View File
@@ -0,0 +1,71 @@
"""Unit tests for devx.utils.network."""
from __future__ import annotations
from unittest.mock import MagicMock, patch
import pytest
import requests
from devx.utils.network import check_http_connectivity, wait_for_ssh
_no_sleep = MagicMock()
class TestCheckHttpConnectivity:
@patch("devx.utils.network.requests.get")
def test_success(self, mock_get: MagicMock) -> None:
mock_get.return_value = MagicMock(status_code=200)
check_http_connectivity("https://example.com", max_attempts=3)
mock_get.assert_called_once()
@patch("devx.utils.network.requests.get")
def test_retries_on_connection_error(self, mock_get: MagicMock) -> None:
mock_get.side_effect = [
requests.exceptions.ConnectionError("refused"),
requests.exceptions.ConnectionError("refused"),
MagicMock(status_code=200),
]
check_http_connectivity("https://example.com", max_attempts=5, sleep=_no_sleep)
assert mock_get.call_count == 3
@patch("devx.utils.network.requests.get")
def test_raises_after_max_attempts(self, mock_get: MagicMock) -> None:
mock_get.side_effect = requests.exceptions.ConnectionError("refused")
with pytest.raises(requests.exceptions.ConnectionError):
check_http_connectivity("https://example.com", max_attempts=2, sleep=_no_sleep)
assert mock_get.call_count == 2
@patch("devx.utils.network.requests.get")
def test_verify_false(self, mock_get: MagicMock) -> None:
mock_get.return_value = MagicMock(status_code=200)
check_http_connectivity("https://example.com", verify=False)
mock_get.assert_called_once_with("https://example.com", timeout=10, verify=False)
class TestWaitForSsh:
@patch("devx.utils.network.socket.create_connection")
def test_immediate_success(self, mock_conn: MagicMock) -> None:
mock_conn.return_value.__enter__ = MagicMock()
mock_conn.return_value.__exit__ = MagicMock(return_value=False)
wait_for_ssh("10.0.0.1")
mock_conn.assert_called_once()
@patch("devx.utils.network.socket.create_connection")
def test_retries_until_success(self, mock_conn: MagicMock) -> None:
mock_conn.side_effect = [
OSError("refused"),
OSError("refused"),
MagicMock(),
]
mock_conn.return_value.__enter__ = MagicMock()
mock_conn.return_value.__exit__ = MagicMock(return_value=False)
wait_for_ssh("10.0.0.1", max_attempts=5, sleep=_no_sleep)
assert mock_conn.call_count == 3
@patch("devx.utils.network.socket.create_connection")
def test_timeout_after_max_attempts(self, mock_conn: MagicMock) -> None:
mock_conn.side_effect = OSError("refused")
with pytest.raises(RuntimeError, match="SSH not available"):
wait_for_ssh("10.0.0.1", max_attempts=3, sleep=_no_sleep)
assert mock_conn.call_count == 3
+96
View File
@@ -0,0 +1,96 @@
"""Unit tests for devx.utils.ssh."""
from __future__ import annotations
import subprocess
from unittest.mock import MagicMock, patch
import pytest
from devx.utils.ssh import docker_exec_on_vm, ssh_exec, wait_for_ssh
class TestSshExec:
@patch("devx.utils.ssh.subprocess.run")
def test_success(self, mock_run: MagicMock) -> None:
mock_run.return_value = MagicMock(returncode=0, stdout="ok", stderr="")
result = ssh_exec("10.0.0.1", "uname -a")
assert result.returncode == 0
mock_run.assert_called_once()
@patch("devx.utils.ssh.subprocess.run")
def test_failure_with_check(self, mock_run: MagicMock) -> None:
mock_result = MagicMock(returncode=1, stdout="", stderr="error")
mock_result.check_returncode.side_effect = subprocess.CalledProcessError(1, "ssh")
mock_run.return_value = mock_result
with pytest.raises(subprocess.CalledProcessError):
ssh_exec("10.0.0.1", "false")
@patch("devx.utils.ssh.subprocess.run")
def test_failure_without_check(self, mock_run: MagicMock) -> None:
mock_run.return_value = MagicMock(returncode=1, stdout="", stderr="error")
result = ssh_exec("10.0.0.1", "false", check=False)
assert result.returncode == 1
@patch("devx.utils.ssh.subprocess.run")
def test_custom_user(self, mock_run: MagicMock) -> None:
mock_run.return_value = MagicMock(returncode=0, stdout="", stderr="")
ssh_exec("10.0.0.1", "whoami", user="root")
cmd = mock_run.call_args[0][0]
assert "root@10.0.0.1" in cmd
class TestDockerExecOnVm:
@patch("devx.utils.ssh.ssh_exec")
def test_simple_command(self, mock_ssh: MagicMock) -> None:
mock_ssh.return_value = MagicMock(stdout="output\n")
result = docker_exec_on_vm("10.0.0.1", "mycontainer", "ls /")
assert result == "output"
mock_ssh.assert_called_once_with("10.0.0.1", "docker exec mycontainer ls /", user="deploy", timeout=30)
@patch("devx.utils.ssh.ssh_exec")
def test_psql_mode(self, mock_ssh: MagicMock) -> None:
mock_ssh.return_value = MagicMock(stdout="result\n")
result = docker_exec_on_vm("10.0.0.1", "db", "SELECT 1", db_user="postgres", db_name="mydb")
assert result == "result"
call_args = mock_ssh.call_args[0][1]
assert "psql -U postgres -d mydb" in call_args
assert "SELECT 1" in call_args
@patch("devx.utils.ssh.ssh_exec")
def test_psql_escapes_single_quotes(self, mock_ssh: MagicMock) -> None:
mock_ssh.return_value = MagicMock(stdout="\n")
docker_exec_on_vm("10.0.0.1", "db", "SELECT 'it''s ok'", db_user="pg", db_name="db")
call_args = mock_ssh.call_args[0][1]
assert "'\"'\"'" in call_args
class TestWaitForSsh:
@patch("devx.utils.ssh.socket.create_connection")
def test_immediate_success(self, mock_conn: MagicMock) -> None:
mock_conn.return_value.__enter__ = MagicMock()
mock_conn.return_value.__exit__ = MagicMock(return_value=False)
wait_for_ssh("10.0.0.1")
mock_conn.assert_called_once()
@patch("devx.utils.ssh.socket.create_connection")
@patch("devx.utils.ssh.time.sleep")
def test_retries_until_success(self, mock_sleep: MagicMock, mock_conn: MagicMock) -> None:
# Fail twice, then succeed
mock_conn.side_effect = [
OSError("refused"),
OSError("refused"),
MagicMock(),
]
mock_conn.return_value.__enter__ = MagicMock()
mock_conn.return_value.__exit__ = MagicMock(return_value=False)
wait_for_ssh("10.0.0.1", max_attempts=5)
assert mock_conn.call_count == 3
@patch("devx.utils.ssh.socket.create_connection")
@patch("devx.utils.ssh.time.sleep")
def test_timeout_after_max_attempts(self, mock_sleep: MagicMock, mock_conn: MagicMock) -> None:
mock_conn.side_effect = OSError("refused")
with pytest.raises(RuntimeError, match="SSH not available"):
wait_for_ssh("10.0.0.1", max_attempts=3)
assert mock_conn.call_count == 3
+124
View File
@@ -0,0 +1,124 @@
"""Unit tests for devx.utils.step_tracker."""
from __future__ import annotations
import click
import pytest
from click.testing import CliRunner
from devx.utils.step_tracker import Step, StepTracker, track_steps
class TestStep:
def test_initial_status_is_pending(self) -> None:
step = Step("install")
assert step.status == "pending"
assert step.name == "install"
class TestStepTracker:
def test_begin_adds_step_as_in_progress(self) -> None:
tracker = StepTracker()
tracker.begin("install deps")
assert len(tracker.steps) == 1
assert tracker.steps[0].status == "in_progress"
def test_done_marks_last_in_progress_as_completed(self) -> None:
tracker = StepTracker()
tracker.begin("step1")
tracker.done()
assert tracker.steps[0].status == "completed"
def test_done_no_op_if_no_in_progress(self) -> None:
tracker = StepTracker()
tracker.begin("step1")
tracker.done()
tracker.done() # should not raise, no-op
assert tracker.steps[0].status == "completed"
def test_done_no_op_if_empty(self) -> None:
tracker = StepTracker()
tracker.done() # should not raise
def test_multiple_steps(self) -> None:
tracker = StepTracker()
tracker.begin("step1")
tracker.done()
tracker.begin("step2")
tracker.done()
assert len(tracker.steps) == 2
assert tracker.steps[0].status == "completed"
assert tracker.steps[1].status == "completed"
class TestTrackSteps:
def test_successful_operation(self) -> None:
runner = CliRunner()
with runner.isolation():
with track_steps() as tracker:
tracker.begin("step1")
tracker.done()
tracker.begin("step2")
tracker.done()
assert len(tracker.steps) == 2
assert all(s.status == "completed" for s in tracker.steps)
def test_exception_marks_in_progress_as_failed(self) -> None:
runner = CliRunner()
with runner.isolation():
with pytest.raises(ValueError, match="boom"):
with track_steps() as tracker:
tracker.begin("step1")
tracker.done()
tracker.begin("step2")
raise ValueError("boom")
assert tracker.steps[0].status == "completed"
assert tracker.steps[1].status == "failed"
def test_pending_step_stays_pending_on_exception(self) -> None:
runner = CliRunner()
with runner.isolation():
with pytest.raises(ValueError):
with track_steps() as tracker:
tracker.begin("step1")
tracker.done()
tracker.begin("step2")
tracker.done()
tracker.begin("step3") # in_progress
# step4 is pending (not started)
raise ValueError("oops")
assert tracker.steps[2].status == "failed"
def test_empty_operation(self) -> None:
runner = CliRunner()
with runner.isolation():
with track_steps() as tracker:
pass
assert tracker.steps == []
def test_report_printed_on_success(self) -> None:
runner = CliRunner()
result = runner.invoke(_cmd_success, [], color=False)
assert result.exit_code == 0
assert "Operation Report" in result.output
assert "step1" in result.output
def test_report_printed_on_failure(self) -> None:
runner = CliRunner()
result = runner.invoke(_cmd_failure, [], color=False)
assert result.exit_code != 0
assert "Operation Report" in result.output
@click.command()
def _cmd_success() -> None:
with track_steps() as tracker:
tracker.begin("step1")
tracker.done()
@click.command()
def _cmd_failure() -> None:
with track_steps() as tracker:
tracker.begin("step1")
raise ValueError("oops")
+134
View File
@@ -0,0 +1,134 @@
"""Unit tests for devx.utils.vault."""
from __future__ import annotations
from pathlib import Path
from unittest.mock import MagicMock, patch
from devx.utils.vault import (
decrypt_file,
encrypt_file,
is_encrypted,
load_vault_yaml,
save_vault_yaml,
)
class TestIsEncrypted:
def test_encrypted_file(self, tmp_path: Path) -> None:
f = tmp_path / "secret.yml"
f.write_text("$ANSIBLE_VAULT;1.1;AES256\n9382928...\n")
assert is_encrypted(f) is True
def test_plain_file(self, tmp_path: Path) -> None:
f = tmp_path / "plain.yml"
f.write_text("key: value\n")
assert is_encrypted(f) is False
class TestLoadVaultYaml:
def test_plain_yaml_no_vault_pass(self, tmp_path: Path) -> None:
f = tmp_path / "data.yml"
f.write_text("key: value\nlist:\n - a\n - b\n")
data = load_vault_yaml(f)
assert data == {"key": "value", "list": ["a", "b"]}
def test_empty_file(self, tmp_path: Path) -> None:
f = tmp_path / "empty.yml"
f.write_text("")
data = load_vault_yaml(f)
assert data == {}
def test_vault_pass_not_exists(self, tmp_path: Path) -> None:
f = tmp_path / "data.yml"
f.write_text("key: value\n")
data = load_vault_yaml(f, vault_pass=tmp_path / "nonexistent")
assert data == {"key": "value"}
@patch("devx.utils.vault.subprocess.run")
def test_encrypted_file_success(self, mock_run: MagicMock, tmp_path: Path) -> None:
f = tmp_path / "secret.yml"
f.write_text("$ANSIBLE_VAULT\n...")
vp = tmp_path / "vault-password"
vp.write_text("secret")
mock_run.return_value = MagicMock(returncode=0, stdout="key: decrypted\n", stderr="")
data = load_vault_yaml(f, vault_pass=vp)
assert data == {"key": "decrypted"}
@patch("devx.utils.vault.subprocess.run")
def test_not_vault_encrypted_fallback(self, mock_run: MagicMock, tmp_path: Path) -> None:
f = tmp_path / "plain.yml"
f.write_text("key: value\n")
vp = tmp_path / "vault-password"
vp.write_text("secret")
mock_run.return_value = MagicMock(returncode=1, stdout="", stderr="is not vault encrypted")
data = load_vault_yaml(f, vault_pass=vp)
assert data == {"key": "value"}
class TestSaveVaultYaml:
def test_save_plain(self, tmp_path: Path) -> None:
f = tmp_path / "output.yml"
save_vault_yaml(f, {"key": "value"})
content = f.read_text()
assert "key: value" in content
def test_save_with_vault_pass_not_exists(self, tmp_path: Path) -> None:
f = tmp_path / "output.yml"
vp = tmp_path / "nonexistent"
save_vault_yaml(f, {"key": "value"}, vault_pass=vp)
# Should save as plain YAML
content = f.read_text()
assert "key: value" in content
assert "$ANSIBLE_VAULT" not in content
@patch("devx.utils.vault.subprocess.run")
def test_save_and_encrypt(self, mock_run: MagicMock, tmp_path: Path) -> None:
f = tmp_path / "output.yml"
vp = tmp_path / "vault-password"
vp.write_text("secret")
save_vault_yaml(f, {"key": "value"}, vault_pass=vp)
# File should be written
assert f.exists()
# ansible-vault encrypt should be called
mock_run.assert_called_once()
cmd = mock_run.call_args[0][0]
assert "ansible-vault" in cmd
assert "encrypt" in cmd
class TestEncryptFile:
@patch("devx.utils.vault.subprocess.run")
def test_calls_ansible_vault(self, mock_run: MagicMock, tmp_path: Path) -> None:
f = tmp_path / "file.yml"
f.write_text("key: value")
vp = tmp_path / "vault-password"
vp.write_text("secret")
encrypt_file(f, vp)
mock_run.assert_called_once()
cmd = mock_run.call_args[0][0]
assert "ansible-vault" in cmd
assert "encrypt" in cmd
assert str(f) in cmd
assert str(vp) in cmd
class TestDecryptFile:
@patch("devx.utils.vault.subprocess.run")
def test_calls_ansible_vault(self, mock_run: MagicMock, tmp_path: Path) -> None:
f = tmp_path / "file.yml"
f.write_text("$ANSIBLE_VAULT\n...")
vp = tmp_path / "vault-password"
vp.write_text("secret")
decrypt_file(f, vp)
mock_run.assert_called_once()
cmd = mock_run.call_args[0][0]
assert "ansible-vault" in cmd
assert "decrypt" in cmd
assert str(f) in cmd
assert str(vp) in cmd
+70
View File
@@ -0,0 +1,70 @@
"""Unit tests for devx.ci.validate_deploy_ref."""
from __future__ import annotations
from pathlib import Path
from unittest.mock import MagicMock, patch
from click.testing import CliRunner
from devx.ci.validate_deploy_ref import main
class TestValidateDeployRef:
def test_valid_tag_prints_ref(self, tmp_path: Path) -> None:
runner = CliRunner()
with patch("devx.ci.validate_deploy_ref.subprocess.run") as mock_run:
mock_run.return_value = MagicMock(returncode=0, stdout="abcdef1234567890\n", stderr="")
result = runner.invoke(main, ["--tag", "v1.0.0"])
assert result.exit_code == 0
assert "v1.0.0" in result.output
def test_invalid_tag_exits_nonzero(self) -> None:
runner = CliRunner()
with patch("devx.ci.validate_deploy_ref.subprocess.run") as mock_run:
mock_run.return_value = MagicMock(returncode=1, stdout="", stderr="error")
result = runner.invoke(main, ["--tag", "nonexistent"])
assert result.exit_code == 1
assert "does not exist" in result.output
def test_no_tag_without_allow_empty_exits_nonzero(self) -> None:
runner = CliRunner()
result = runner.invoke(main, [])
assert result.exit_code == 1
assert "No tag specified" in result.output
def test_allow_empty_prints_pr_mode(self) -> None:
runner = CliRunner()
result = runner.invoke(main, ["--allow-empty"])
assert result.exit_code == 0
assert "PR mode" in result.output
def test_github_output_writes_ref(self, tmp_path: Path) -> None:
runner = CliRunner()
gh_output = tmp_path / "github_output"
gh_output.write_text("")
with patch("devx.ci.validate_deploy_ref.subprocess.run") as mock_run:
mock_run.return_value = MagicMock(returncode=0, stdout="abcdef12\n", stderr="")
with runner.isolation(env={"GITHUB_OUTPUT": str(gh_output)}):
result = runner.invoke(main, ["--tag", "v1.0.0", "--github-output"])
assert result.exit_code == 0
content = gh_output.read_text()
assert "deploy-ref=v1.0.0" in content
def test_github_output_without_env_var_exits_nonzero(self) -> None:
runner = CliRunner()
with patch("devx.ci.validate_deploy_ref.subprocess.run") as mock_run:
mock_run.return_value = MagicMock(returncode=0, stdout="abcdef12\n", stderr="")
with runner.isolation(env={"GITHUB_OUTPUT": ""}):
result = runner.invoke(main, ["--tag", "v1.0.0", "--github-output"])
assert result.exit_code == 1
assert "GITHUB_OUTPUT" in result.output
def test_allow_empty_with_github_output(self, tmp_path: Path) -> None:
runner = CliRunner()
gh_output = tmp_path / "github_output"
gh_output.write_text("")
with runner.isolation(env={"GITHUB_OUTPUT": str(gh_output)}):
result = runner.invoke(main, ["--allow-empty", "--github-output"])
assert result.exit_code == 0
assert "deploy-ref=" in gh_output.read_text()