Skip to main content

Fixtures for Operators

Project description

pytest-operator

PyTest plugin to make it easy to create integration tests for Operator Charms.

Usage

Include pytest-operator in the deps of your tox.ini file:

[testenv]
deps =
  pytest
  pytest-operator

Then, just start using the ops_test fixture in your async tests. This module-scoped fixture provides a libjuju Model, helpers to build charms for testing, and the ability to abort testing so that the remaining tests in the module are automatically xfailed (you can also mark a test so that this happens automatically if the test fails; this is typically used on the initial deployment test, where subsequent tests depend on the deployment having succeeded).

As an additional nicety, you don't have to explicitly mark an async test with @pytest.mark.asyncio; if it's a test function / method and it's async, it will be marked automatically.

Example:

import pytest


@pytest.mark.abort_on_fail
async def test_build_and_deploy(ops_test):
    my_charm = await ops_test.build_charm(".")
    await ops_test.model.deploy(my_charm)
    await ops_test.model.wait_for_idle()


async def test_status(ops_test):
    assert ops_test.model.applications["my-charm"].units[0].workload_status == "active"

Reference

More details can be found in the reference docs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-operator-0.9.0.tar.gz (13.4 kB view details)

Uploaded Source

File details

Details for the file pytest-operator-0.9.0.tar.gz.

File metadata

  • Download URL: pytest-operator-0.9.0.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for pytest-operator-0.9.0.tar.gz
Algorithm Hash digest
SHA256 0960f88a4f1390544f49b24c7d2998d1190628f86793bf8e885462586e85ed2e
MD5 f55ec71c7ebb4846d395ffbade29174a
BLAKE2b-256 1c77fead558ded2d2ffb7e2f65e9a27b48d65d6efb7c4c2d96b4976250bd6ed9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page