https://github.com/greschd/aiida_pytest
Helper module to run pytest on AiiDA plugins.
https://github.com/greschd/aiida_pytest
Last synced: 11 months ago
JSON representation
Helper module to run pytest on AiiDA plugins.
- Host: GitHub
- URL: https://github.com/greschd/aiida_pytest
- Owner: greschd
- License: apache-2.0
- Created: 2017-06-19T15:25:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-04-19T08:58:09.000Z (almost 5 years ago)
- Last Synced: 2025-01-25T21:11:25.373Z (about 1 year ago)
- Language: Python
- Size: 141 KB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
**NOTE:** The ``aiida-pytest`` package is in maintenance mode: bugs will continue to be fixed for the foreseeable future, but no new features will be implemented. Users considering using ``aiida-pytest`` are **strongly** encouraged to use the built-in AiiDA fixtures instead.
# aiida-pytest
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
```python
from aiida_pytest import *
```
This defines the ``configure`` and ``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 ``bands-inspect`` code:
```
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
```
**Note:** ``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
Tests with ``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 ``py.test``.