ward

Adds when param to @skip and @xfail decorators, allowing you to only apply them when some boolean or Callable predicate holds. e.g.

@skip("Skipped on Windows", when=platform.system() == "Windows")
@test("_build_package_name constructs package name '{pkg}' from '{path}'")
def _(
    pkg=each("", "foo", "foo.bar"),
    path=each("foo.py", "foo/bar.py", "foo/bar/baz.py"),
):
    m = ModuleType(name="")
    m.__file__ = path
    assert _build_package_name(m) == pkg


@skip("Skipped on Unix", when=platform.system() != "Windows")
@test("_build_package_name constructs package name '{pkg}' from '{path}'")
def _(
    pkg=each("", "foo", "foo.bar"),
    path=each("foo.py", "foo\\bar.py", "foo\\bar\\baz.py"),
):
    m = ModuleType(name="")
    m.__file__ = path
    assert _build_package_name(m) == pkg

When run on a non-Windows system:

Relative imports are now supported in test modules and dependencies.

Test modules will now be added to sys.modules.

Ward will automatically stop capturing output when a debugging session is started via pdb.set_trace() or breakpoint().

Fixes a minor display issue where an extra line of space was being displayed above the code snippet output when an assertion failed.

Bugfix means that using lambdas inside each works as you would expect.

Thanks to @JoshKarpel for contributing this fix!

ward fixtures allows you to find test fixture dependencies and unused fixtures in your project by printing out

The ward fixtures --show-dependency-trees command now uses the Tree class from Rich to construct it's output:

The standard ward fixtures command which simply lists all fixtures that Ward is able to find in a project now also uses Rich for output:

Contribution by @JoshKarpel
Rich: https://github.com/willmcgugan/rich/

Running ward completions will install a tab completion script for your terminal.

Migrates all output associated with ward test to the Rich library for terminal output.

Refactor and improvements to ward fixtures output, which allows you to view information about fixtures in your project and the tests that use them. Thanks @JoshKarpel!

• Exiting during a test or fixture will trigger a failure #165
• Bump toml to 0.10.0 #164
• Add coverage reporting with Codecov #167

Thanks @hoefling and @JoshKarpel!

If tests are incorrectly parameterised (e.g. mismatch in each argument counts), they will now fail without running and won't be expanded into parameterised instances.

The --show-diff-symbols option has been added, which allows you to present diffs using symbols rather than background colours. This improves accessibility and support for CI systems that don't support ANSI terminal output.

Workaround for a bug in virtualenv which means site.getsitepackages() is not available inside virtual envs. https://github.com/pypa/virtualenv/issues/228

Ward will no longer look in site-packages when discovering tests, preventing interference from third party packages that don't exclude tests from their distributions.

Thanks to @anlutro for this!

Adds the fixtures subcommand. By default this command lists out all fixtures present in the project. For example, running ward fixtures gives us the following output:

We can also run ward fixtures --show-dependency-tree to see the relationship between fixtures:

Thanks to @JoshKarpel for this contribution!

You can now tag tests using the tags keyword argument of the @test decorator:

@test("simple addition", tags=["unit", "regression"])
def _():
    assert 1 + 2 == 3

To query these tags, you can use a tag expression.

ward --tags EXPR

More examples of tag expressions:

You can use parentheses in tag expressions to change precedence rules to suit your needs.

Thanks @thebigmunch for adding this feature.

• Migrates Ward to use Poetry instead of Flit/pip.
• Removes chart output after tests run. The chart was causing me maintenance issues and I don't believe it's worth the effort for something that doesn't provide a great deal of value when it comes down to it.
• Updates Makefile and contribution guide
• Updates GitHub Actions to make use of Poetry for dependency management and releasing to PyPI.

A release earlier today (11 March 2020) introduced an issue where Ward would raise an exception when a non-comparison based assertion failed. This release fixes that issue.

User is informed if Ward finds and uses their pyproject.toml. Thanks to @mandarvaze.