pytest-argus-server 0.3.0

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=2.7.0 tests/

Provided fixtures

The main fixtures provided by this plugin are the session-scoped argus_api_url and argus_source_system_token.

argus_api_url

When used by a test, this will ensure an Argus server is running and ready to take requests. It returns the base URL of the running API:

def test_url_should_be_as_expected(argus_api_url):
    assert argus_api_url == "http://127.0.0.1:8000/api/v2/"

argus_source_system_token

This token will create a test source system and return a valid API token for accessing the API as this test source.

def test_fetch_incidents(argus_api_url, argus_source_system_token):
    assert requests.get(
        f"{argus_api_url}/incidents/",
        headers={"Authorization": f"Token {argus_source_system_token}"}
    ).status_code == 200

Bugs

• The port number of the launched API server is hard-coded to 8000.

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.

All code needs to be formatted and linted by ruff. The pre-commit tool is used to enforce code styles at commit-time. To enable the pre-commit hooks in your repository run:

$ pre-commit install

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.