# pytest_just

> A pytest plugin for testing justfile recipes

## Docs

### API Reference

#### Classes
> Core classes

- [JustfileFixture](https://databooth.github.io/pytest-just/reference/JustfileFixture.html): Helper for inspecting recipes and asserting justfile contract behaviour

#### JustfileFixture Methods
> Methods for the JustfileFixture class

- [JustfileFixture.recipe_names](https://databooth.github.io/pytest-just/reference/JustfileFixture.recipe_names.html)
- [JustfileFixture.dependencies](https://databooth.github.io/pytest-just/reference/JustfileFixture.dependencies.html)
- [JustfileFixture.parameters](https://databooth.github.io/pytest-just/reference/JustfileFixture.parameters.html)
- [JustfileFixture.parameter_names](https://databooth.github.io/pytest-just/reference/JustfileFixture.parameter_names.html)
- [JustfileFixture.is_shebang](https://databooth.github.io/pytest-just/reference/JustfileFixture.is_shebang.html)
- [JustfileFixture.is_private](https://databooth.github.io/pytest-just/reference/JustfileFixture.is_private.html)
- [JustfileFixture.doc](https://databooth.github.io/pytest-just/reference/JustfileFixture.doc.html)
- [JustfileFixture.body](https://databooth.github.io/pytest-just/reference/JustfileFixture.body.html)
- [JustfileFixture.show](https://databooth.github.io/pytest-just/reference/JustfileFixture.show.html)
- [JustfileFixture.assignments](https://databooth.github.io/pytest-just/reference/JustfileFixture.assignments.html)
- [JustfileFixture.aliases](https://databooth.github.io/pytest-just/reference/JustfileFixture.aliases.html)
- [JustfileFixture.assert_exists](https://databooth.github.io/pytest-just/reference/JustfileFixture.assert_exists.html)
- [JustfileFixture.assert_depends_on](https://databooth.github.io/pytest-just/reference/JustfileFixture.assert_depends_on.html)
- [JustfileFixture.assert_parameter](https://databooth.github.io/pytest-just/reference/JustfileFixture.assert_parameter.html)
- [JustfileFixture.assert_body_contains](https://databooth.github.io/pytest-just/reference/JustfileFixture.assert_body_contains.html)
- [JustfileFixture.assert_not_shebang](https://databooth.github.io/pytest-just/reference/JustfileFixture.assert_not_shebang.html)
- [JustfileFixture.assert_variable_referenced](https://databooth.github.io/pytest-just/reference/JustfileFixture.assert_variable_referenced.html)
- [JustfileFixture.dry_run](https://databooth.github.io/pytest-just/reference/JustfileFixture.dry_run.html)
- [JustfileFixture.assert_dry_run_contains](https://databooth.github.io/pytest-just/reference/JustfileFixture.assert_dry_run_contains.html)

#### Exceptions
> Exception classes

- [JustCommandError](https://databooth.github.io/pytest-just/reference/JustCommandError.html): Raised when invoking `just` fails
- [JustJsonFormatError](https://databooth.github.io/pytest-just/reference/JustJsonFormatError.html): Raised when `just --dump` JSON is malformed or incompatible
- [UnknownRecipeError](https://databooth.github.io/pytest-just/reference/UnknownRecipeError.html): Raised when a requested recipe does not exist