Skip to content

coherent-oss/pytest-ignore-flaky

Repository files navigation

tests Ruff https://readthedocs.org/projects/pytest-ignore-flaky/badge/?version=latest https://img.shields.io/badge/skeleton-2024-informational

pytest-ignore-flaky

ignore failures from flaky tests (pytest plugin)

A "flaky" test is a test that usually pass but sometimes it fails. You should always avoid flaky tests but not always possible.

This plugin can be used to optionally ignore failures from flaky tests.

First "mark" your tests with the flaky marker:

import random
import pytest

@pytest.mark.flaky
def test_mf():
    assert 0 == random.randint(0, 1)

By default this mark is just ignored, unless the plugin is activated from the command line (or py.test config file):

py.test --ignore-flaky

If a flaky test pass it will be reported normally as test succeed. If the test fails, instead of being reported as failure it will be reported as a xfail.

pytest compatibility

Tested with pytest 6.2 (2021-04-23).

Project Details

license

The MIT License Copyright (c) 2015-2019 Eduardo Naufel Schettino and Marcos Alfredo Camargo Leal Pinto

see LICENSE file