pytest-github 0.0.8

Marker

The following py.test marker is available:

@pytest.mark.github(*args): GitHub issue integration

The marker can be used to influence the outcome of tests. See the examples below for guidance.

Example: xfail

Often, when a test fails, one might file a GitHub issue to track the resolution of the problem. Alternatively, you could use the built-in xfail marker. This is where pytest-github can be of use. To avoid having to review known failures with each test run, and to avoid always using xfail, consider the github marker to dynamically influence the test outcome based on the state of the GitHub issue.

The following example demonstrates using the github marker to influence the outcome of a known failing test.

@pytest.mark.github('https://github.com/some/open/issues/1')
def test_will_xfail():
    assert False

Running this test with py.test will produce the following output:

test.py::test_will_xfail xfail

Example: XPASS

The following example demonstrates a test that succeeds, despite being associated with an open GitHub issue.

@pytest.mark.github('https://github.com/some/open/issues/1')
def test_will_xpass():
    assert True

In this example, the XPASS outcome (a.k.a. unexpected pass) is used.

test.py::test_will_xpass XPASS

Example: PASSED

The following example demonstrates a test that succeeds, while it is associated with a closed GitHub issue. When a test associated with a GitHub

@pytest.mark.github('https://github.com/some/closed/issues/2')
def test_will_pass():
    assert True

In this example, the PASSED outcome is used.

test.py::test_will_pass PASSED

Example: FAILED

The following example demonstrates a test that fails, while it is associated with a closed GitHub issue.

@pytest.mark.github('https://github.com/some/closed/issues/2')
def test_will_fail():
    assert False

In this example, the FAILED outcome is used.

test.py::test_will_fail FAILED

Example: SKIPPED

The following example demonstrates a test that fails, while it is associated with an open GitHub issue.

@pytest.mark.github('https://github.com/some/open/issues/1', skip=True)
def test_will_skip():
    assert False

In this example, the SKIPPED outcome is used.

test.py::test_will_skip SKIPPED