Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darrenburns/ward
Ward is a modern test framework for Python with a focus on productivity and readability.
https://github.com/darrenburns/ward
contributors-welcome python quality-assurance test-runner tester testing testing-framework unit-test ward
Last synced: 18 days ago
JSON representation
Ward is a modern test framework for Python with a focus on productivity and readability.
- Host: GitHub
- URL: https://github.com/darrenburns/ward
- Owner: darrenburns
- License: mit
- Created: 2019-01-08T08:50:58.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T22:39:12.000Z (6 months ago)
- Last Synced: 2024-04-29T23:41:06.097Z (6 months ago)
- Topics: contributors-welcome, python, quality-assurance, test-runner, tester, testing, testing-framework, unit-test, ward
- Language: Python
- Homepage: https://ward.readthedocs.io
- Size: 14.1 MB
- Stars: 1,177
- Watchers: 13
- Forks: 53
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-python-testing - Ward - is a modern test framework for Python with a focus on productivity and readability. (Testing Frameworks)
- jimsghstars - darrenburns/ward - Ward is a modern test framework for Python with a focus on productivity and readability. (Python)
README
[](https://codecov.io/gh/darrenburns/ward)
[](https://ward.readthedocs.io/en/latest/?badge=latest)
[](https://badge.fury.io/py/ward)
_Ward_ is a Python testing framework with a focus on productivity and readability. It gives you the tools you need to write **well-documented** and **scalable** tests.
> [!IMPORTANT]
> I am no longer actively maintaining this project.
## Features
See the full set of features in the [**documentation**](https://ward.readthedocs.io).
**Descriptive test names:** describe what your tests do using strings, not function names.
```python
@test("simple addition") # you can use markdown in these descriptions!
def _():
assert 1 + 2 == 3 # you can use plain assert statements!
```
**Modular test dependencies:** manage test setup/teardown code using fixtures that rely on Python's import system, not
name matching.
```python
@fixture
def user():
return User(name="darren")
@test("the user is called darren")
def _(u=user):
assert u.name == "darren"
```
**Support for asyncio**: define your tests and fixtures with `async def` and call asynchronous code within them.
```python
@fixture
async def user():
u = await create_user()
return await u.login()
@test("the logged in user has a last session date")
async def _(user=user):
last_session = await get_last_session_date(user.id)
assert is_recent(last_session, get_last_session_date)
```
**Powerful test selection:** limit your test run not only by matching test names/descriptions, but also on the code
contained in the body of the test.
```
ward --search "Database.get_all_users"
```
Or use tag expressions for more powerful filtering.
```
ward --tags "(unit or integration) and not slow"
```
**Parameterised testing:** write a test once, and run it multiple times with different inputs by writing it in a loop.
```python
for lhs, rhs, res in [
(1, 1, 2),
(2, 3, 5),
]:
@test("simple addition")
def _(left=lhs, right=rhs, result=res):
assert left + right == result
```
**Cross platform:** Tested on Mac OS, Linux, and Windows.
**Speedy:** Ward's suite of ~320 tests run in less than half a second on my machine.
**Zero config:** Sensible defaults mean running `ward` with no arguments is enough to get started. Can be configured using `pyproject.toml` or the command line if required.
**Extendable:** Ward has a plugin system built with pluggy, the same framework used by pytest.
**Colourful, human readable output:** quickly pinpoint and fix issues with detailed output for failing tests.
## Getting Started
Have a look at the [**documentation**](https://ward.readthedocs.io)!
## How to Contribute
Contributions are very welcome and encouraged!
See the [contributing guide](.github/CONTRIBUTING.md) for information on how you can take part in the development of Ward.