Test suite

Tests are in directories tests and testsuite under each directory which has tests. This directory contains additional scripts and information to test functionality without a focus on a specific part of the code.

There are two testing mechanism in place, pytest which is the modern way of testing GRASS GIS. Tests using pytest are written just as any other Python tests.

In parallel, there is also custom unittest-based framework centered around grass.gunittest package. These tests run in the NC sample datasets and can be executed using pytest or directly. The unittest-based adds a number of custom assert methods to accommodate different data and outputs typical in GRASS GIS. grass.gunittest documentation: https://grass.osgeo.org/grass-devel/manuals/libpython/gunittest_testing.html

Running tests

Tests can be executed using pytest:

# Setup the Python environment (if not set up already).
# Replace grass by path to the executable if not installed on path.
export PYTHONPATH=\$(grass --config python_path):\$PYTHONPATH
export LD_LIBRARY_PATH=\$(grass --config path)/lib:\$LD_LIBRARY_PATH
# Run the test.
pytest

Test data

To test manually or to write tests, you may need to use the North Carolina Sample dataset, available from https://grass.osgeo.org/sampledata/north_carolina/.

CI

Most tests run in the CI. See the .github directory for details and use it as a reference.