Skip to main content

IssueTest framework — reusable functional test scaffolding and pytest plugin

Project description

IssueTest

IssueTest is a repo-agnostic functional test framework that treats GitHub Issues as the test specification, syncs them into YAML case files, scaffolds test stubs, runs those tests with pytest, and prepares status comments back to the originating issues.

What works now

  • issuetest init bootstraps a consumer repository with config, templates, workflows, and labels.
  • issuetest matrix builds an automation matrix from case YAMLs and discovered tests.
  • issuetest scaffold <case_id> creates discoverable pytest stubs with embedded case_id metadata.
  • issuetest run executes pytest and writes .issuetest/run_report.json.
  • issuetest report --dry-run renders the exact comment bodies that would be posted to GitHub issues.
  • The reusable composite Actions for sync, validate, run, and report exist under action/*.

Install

Until the package is published to PyPI, install from the local package directory or a built wheel.

python -m pip install ./tools/issuetest

Or build and install the wheel:

python -m build tools/issuetest -o tools/issuetest/dist
python -m pip install --no-deps tools/issuetest/dist/issuetest-1.0.0rc1-py3-none-any.whl

After PyPI publication, the intended install is:

python -m pip install issuetest

Commands

issuetest init
issuetest sync --dry-run
issuetest validate
issuetest matrix
issuetest scaffold SUB-PLAN-001
issuetest run
issuetest report --dry-run
issuetest doctor

Docs

  • docs/quickstart.md for setup.
  • docs/ci-recipes.md for reusable GitHub Actions.
  • docs/commercex-subscriptions.md for the worked CommerceX subscriptions example.
  • docs/threat_model.md for the security and trust model.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

issuetest-1.0.0rc3.tar.gz (645.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

issuetest-1.0.0rc3-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

Details for the file issuetest-1.0.0rc3.tar.gz.

File metadata

  • Download URL: issuetest-1.0.0rc3.tar.gz
  • Upload date:
  • Size: 645.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for issuetest-1.0.0rc3.tar.gz
Algorithm Hash digest
SHA256 38d71b917d3eef4e7107b8ae649c472a01700ab0307ff393450c98f7ddecb776
MD5 a7506aa46658b803586062ef655c8f0f
BLAKE2b-256 8bb3833f0e1893cf1905ad69053cd8515811f670602dc7479935fa6eb88739b8

See more details on using hashes here.

File details

Details for the file issuetest-1.0.0rc3-py3-none-any.whl.

File metadata

  • Download URL: issuetest-1.0.0rc3-py3-none-any.whl
  • Upload date:
  • Size: 33.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for issuetest-1.0.0rc3-py3-none-any.whl
Algorithm Hash digest
SHA256 7b9b6d16865498826175c819d1fdc9c9f93bc665ab6858e36ab7d48f7aa3e4d8
MD5 7494454014f03bd26c3fed4d6be0b7f2
BLAKE2b-256 d5628953c0c4032fc683345087bb8d617cda7bbd1641707f4de8a8957f1f9044

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page