# Unit tests

- The spacepy_testing module

  - Classes

  - Functions

  - Data

## The spacepy_testing module

The `spacepy_testing` module contains utilities for assistance with testing SpacePy. It is not installed as part of SpacePy and is thus only importable from the unit test scripts themselves (which are in the same directory). All unit test scripts import this module, and should do so before importing any spacepy modules to ensure pathing is correct.

On import, `add_build_to_path()` is run so that the `build` directory is added to the Python search path. This means the tests run against the latest build, not the installed version. Remove the build directory to run against the installed version instead. The build directory does not completely separate out Python versions, so removing the build directory (and rebuilding) is recommended when switching Python versions.

Build the package before running the tests:

    python setup.py build

- Classes

- Functions

- Data

### Classes

`assertWarns`(test[, action, message, ...]) | Tests that a warning is raised.
`assertDoesntWarn`(test[, action, message, ...]) | Tests that a warning is not raised.

### Functions

`add_build_to_path`() | Adds the python build directory to the search path.

### Data

`datadir` | Directory containing unit test data
`testsdir` | Directory containing the unit test scripts

Release

  0.3.0

Doc generation date

  Apr 27, 2022