pytest plugin

The pytest plugin helps ease the testing of apps that use craft-application.

By default, this plugin sets the application into debug mode, meaning the run() method will re-raise generic exceptions.

Fixtures

craft_application.pytest_plugin.production_mode(monkeypatch: MonkeyPatch) → None

Put the application into production mode.

This fixture puts the application into production mode rather than debug mode. It should only be used if the application needs to test behaviour that differs between debug mode and production mode.

craft_application.pytest_plugin.managed_mode(monkeypatch: MonkeyPatch) → None

Tell the application it’s running in managed mode.

This fixture sets up the application’s environment so that it appears to be using managed mode. Useful for testing behaviours that only occur in managed mode.

craft_application.pytest_plugin.destructive_mode(monkeypatch: MonkeyPatch) → None

Tell the application it’s running in destructive mode.

This fixture sets up the application’s environment so that it appears to be running in destructive mode with the “CRAFT_BUILD_ENVIRONMENT” environment variable set.

craft_application.pytest_plugin.fake_host_architecture(request: FixtureRequest, monkeypatch: MonkeyPatch) → Iterator[DebianArchitecture]

Run this test as though running on each supported architecture.

This parametrized fixture provides architecture values for all supported architectures, simulating running on that architecture. This fixture is limited to setting the architecture within this python process.

craft_application.pytest_plugin.project_path(request: FixtureRequest) → Path

Get a temporary path for a project.

This fixture creates a temporary path for a project. It does not create any files in the project directory, but rather provides a pristine project directory without the need to worry about other fixtures loading things.

This fixture can be used with or without pyfakefs.

craft_application.pytest_plugin.in_project_path(project_path: Path, monkeypatch: MonkeyPatch) → Path

Run the test inside the project path.

This fixture changes the working directory of the test to use the project path. Best to use with pytest.mark.usefixtures

Auto-used fixtures

Some fixtures are automatically enabled for tests, changing the default behaviour of applications during the testing process. Each auto-use fixture changes the default behaviour of Craft Application during testing.

craft_application.pytest_plugin.debug_mode() → None

Ensure that the application is in debug mode, raising exceptions from run().

This fixture is automatically used. To disable debug mode for specific tests, use the production_mode() fixture.