pytest-argus-server 0.1.1

A plugin that provides a running Argus API server for tests

A pytest plugin that provides a running Argus API server for tests.

---

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

Features

• Fixtures that will provide tests with a running Argus API server (using Docker Compose)

Requirements

• Docker Compose

Installation

You can install “pytest-argus-server” via pip from PyPI:

$ pip install pytest-argus-server

Usage

Installing this package will automatically make it available in pytest.

Extra pytest command line arguments

By default, this plugin will run the latest available Argus server Docker image. The actually deployed version can be controlled by adding the --argus-version command line option to pytest:

pytest --argus-version=1.30.0 tests/

Provided fixtures

The main fixture provided by this plugin is the session-scoped argus_api. When used by a test, this will ensure an Argus server is running with a pre-made test incident source and API token, and ready to take requests. It returns a two-tuple value that provides a URL to the running API and a valid API token that can be used by the test:

def test_url_should_be_as_expected(argus_api):
    url, token = argus_api
    assert url == "http://localhost:8000/api/v2"

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 Apache Software License 2.0 license, “pytest-argus-server” is free and open source software

Issues

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