A module to simplify using pytest for AiiDA plugins.
This is a helper to enable testing AiiDA plugins with
pytest. The main purpose is to create a fixture which sets up a temporary AiiDA database and user, and simplify setting up the computers and calculations.
To get started, create a
tests folder where your
pytest tests will be located. In
conftests.py, you need to write
from aiida_pytest import *
This defines the
configure_with_daemon fixtures. To set up computers and codes for the test run, you need a
config.yml file in the
tests folder (and run
pytest from there). The following example config file sets up
localhost and the
computers: localhost: hostname: localhost description: localhost transport: local scheduler: direct work_directory: /tmp/test_aiida prepend_text: 'unset PYTHONPATH' codes: bands_inspect: description: bands_inspect code default_plugin: bands_inspect.difference remote_computer: localhost remote_abspath: /home/a-dogres/.virtualenvs/bands-inspect/bin/bands-inspect
aiida-pytest is not compatible with the
aiida-xdist plugin, since the fixtures with
scope=session are then called for each running worker.
Defining and running tests
aiida-pytest are defined and run exactly like "regular"
pytest tests. If a test needs the AiiDA database, it should use the
configure fixture. If the test also requires the Daemon to run, it should use the
configure_with_daemon fixture. Note that, since certain AiiDA import statements require the database backend to be set, these imports should be done inside the test function.
After the tests have run, the code will wait for you to press
Enter before deleting the testing database and repository. This gives you the opportunity to manually inspect the final state. If you want to avoid this step (for example in a CI system), pass the
--quiet-wipe flag to
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size aiida-pytest-0.1.0a4.tar.gz (6.6 kB)||File type Source||Python version None||Upload date||Hashes View hashes|