Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[run]
branch = True
source =
ffmpegfyMe
relative_files = True
5 changes: 4 additions & 1 deletion .github/workflows/python-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ jobs:
- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
with:
python-version: "3.11"
- run: python -m unittest discover -v
- run: python -m pip install -r requirements-dev.txt
- run: python -m coverage run -m unittest discover -v
- name: Add branch coverage summary
run: python -m coverage report --show-missing --format=markdown >> "$GITHUB_STEP_SUMMARY"

container_smoke:
name: Container smoke
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ __pycache__/
*.pyc
*.pyo
.env
.coverage
.venv/

# Editor/OS metadata
.DS_Store
Expand Down
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,19 @@ Common types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`,

## Tests and CI

- Run the Python test suite locally with `python3 -m unittest discover -v`.
Use an isolated virtual environment to run tests with branch coverage:

```sh
python3 -m venv .venv
.venv/bin/python -m pip install -r requirements-dev.txt
.venv/bin/python -m coverage run -m unittest discover -v
.venv/bin/python -m coverage report --show-missing
```

The reported `ffmpegfyMe.py` percentage combines deterministic policy and
integration code. It is a module-level baseline, not core-policy-only
coverage. Issue #32 defines the target scope.

- The Python test suite runs on PRs and pushes to main.
- Watch the required CI checks on the pull request and run the current CI
checks before requesting review.
Expand Down
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,11 +152,7 @@ task ffmpegfy:run

## Tests

Run the Python test suite:

```bash
python3 -m unittest discover -v
```
Run the Python test suite with branch coverage. See [CONTRIBUTING.md](CONTRIBUTING.md#tests-and-ci) for the local environment and commands.

GitHub Actions runs it on pull requests to `main` and pushes to `main`.

Expand Down
1 change: 1 addition & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
coverage==7.17.0
Loading