pytest-himark

A plugin that will filter pytest's test collection using a json file. It will read a json file provided with a --json argument in pytest command line (or in pytest.ini), and automatically create custom markers from specific keys that it will use with -m option to alter pytest test collection.

---

This pytest plugin was generated with Cookiecutter along with @hackebrot's cookiecutter-pytest-plugin template.

Requirements

• json >= 2.0.9

Installation

You can install "pytest-himark" via pip from PyPI:

$ pip install pytest-himark

Usage

After installing this plugin, pytest will automatically load it when launching tests. You will simply need to add the --json option to the command line with the path to the json containing the markers you want to enable. Alternatively, you can add the --json option and the path in the pytest.ini directly, in the addopts variable.

• In pytest.ini:

    addopts = --json=path/to/my/config.json

• Or by command line:

pytest --json=path/to/my/config.json

The markers can be configured in 3 ways to give more flexibility to the end user.

The first way is having a 'markers' keys containing a dictionary with the name of the markers as key, and a boolean as a value. If the boolean is true, the marker with the specified name will be created.

Example:

{
    'markers': {
        'marker1': true,
        'marker2': true,
        'marker3': false,
        'marker4': false
    }
}

This json will result in the following marker filtering:

-m '(marker1 or marker2)'

Another way of specifying markers is to define a 'devices' key, with a list of dictionaries as value. Each key from the list can be refered to as a 'device' and should contain a key named 'name' as a string and a key named 'used' as a boolean. If the 'used' key of a device is set to true, a marker will be created and named with the 'name' string.

Example:

{
    'devices': [
         {
            'name': 'device1',
            'used': true,
         },
         {
            'name': 'device2',
            'used': false,
         }
    }
}

This json will result in the following marker filtering:

-m '(device1)'

Another way to specifying markers is to have a key named 'type' in a device-specific dictionary (see above), defined as a string. A marker with the string value of 'type' will be created.

Example:

{
    'devices': [
         {
            'name': 'device1',
            'type': 'my_type',
            'used': true,
         },
         {
            'name': 'device2',
            'used': false,
         }
    }
}

This json will result in the following marker filtering:

-m '(device1 or my_type)'

One last way to specifying markers is to have keys named 'do', 'di' and/or 'ai' in a device-specific dictionary (see above), defined as list of strings. A marker will be created for every string in those arrays.

Example:

{
    'devices': [
         {  
            "name": "device1",
            "do": [
                "do1"
            ],
            "di": [
                "di1"
            ],
            "ai": [
                "ai1"
            ],
            "used": true,
         },
        {
            "name": "device2",
            "used": false,
         }
    ]
}

This json will result in the following marker filtering:

-m '(device1 or do1 or di1 or ai1)'

Launching pytest now will automatically add the result filter to the command line, e.g.:

>> pytest -m "(device1 or do1 or di1 or ai1)"

Finally, after pytest test collection has completed, this plugin will also filter out any test that is marked with an undefined marker.

For example consider the following config:

    {
        'markers': {
            'marker1': true
        }
    }

And the following test:

@pytest.mark.marker1
@pytest.mark.marker2
def test_mytest():
    assert True

This test is marked with marker1 which is defined in the configuration, but also with marker2 which is not. Therefore, despite being initially collected by pytest, this plugin will remove it from the selection.

Note that any empty string as marker will be ignored by the plugin, and any leading or trailing spaces will be removed.

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the MIT license, "pytest-himark" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.