Testing the plugin

The plugin uses pytest with pytest-qgis for comprehensive testing. Tests are organized in 2 separate folders with clear separation of concerns:

tests/unit: testing code which is independent of QGIS API (uses mocking)
tests/qgis: testing code which depends on QGIS API (integration tests)

Test Organization Principles

Unit Tests (`tests/unit/`)

Purpose: Test individual functions and classes in isolation
Dependencies: Use mocking to avoid QGIS dependencies
Markers: @pytest.mark.unit or @pytest.mark.integration (for complex interactions)
Speed: Fast execution, no external dependencies
Example: Testing mathematical calculations, utility functions

QGIS Integration Tests (`tests/qgis/`)

Purpose: Test functionality that requires actual QGIS environment
Dependencies: Real QGIS classes and interfaces
Markers: @pytest.mark.qgis
Speed: Slower execution due to QGIS initialization
Example: Testing map tools, layer operations, GUI components

Test Markers

Tests are organized using pytest markers that are automatically applied based on location and can be explicitly set:

@pytest.mark.unit: Unit tests that don’t require QGIS (auto-applied to tests/unit/)
@pytest.mark.qgis: Tests that require QGIS environment (auto-applied to tests/qgis/)
@pytest.mark.integration: Integration tests between components (explicit)

Automatic Marker Application

The test configuration (tests/conftest.py) automatically applies markers:

Files in tests/unit/ get @pytest.mark.unit unless explicitly marked
Files in tests/qgis/ get @pytest.mark.qgis unless explicitly marked
QGIS tests are automatically skipped if QGIS is not available

Run tests

Using justfile (recommended)

# Run all tests with coverage report
just test

# The justfile command is equivalent to:
uv sync --no-group ci
# the "--no-group ci" option might be required to avoid Qt library conflicts with qgis-plugin-ci dependencies
uv sync --group testing  
uv run pytest -v --cov=dip_strike_tools --cov-report=term-missing

Using pytest directly

# Run all tests
uv run pytest -v

# Run with coverage report
uv run pytest -v --cov=dip_strike_tools --cov-report=term-missing

# Run only unit tests (no QGIS required)
uv run pytest -m unit -v

# Run only integration tests
uv run pytest -m integration -v

# Run only QGIS tests  
uv run pytest -m qgis -v

# Run unit and integration tests (no QGIS required)
uv run pytest -m "unit or integration" -v

# Run tests excluding QGIS tests (useful when QGIS is not available)
uv run pytest -m "not qgis" -v

# Run specific test file
uv run pytest tests/unit/test_plugin_main.py -v
uv run pytest tests/qgis/test_plugin_main_qgis.py -v

# Run specific test class
uv run pytest tests/unit/test_plugin_main.py::TestDipStrikeToolsPluginBasic -v

# Run specific test method
uv run pytest tests/unit/test_plugin_main.py::TestDipStrikeToolsPluginBasic::test_plugin_import -v

Test Structure Examples

Unit Test Example

Unit tests use mocking to isolate functionality and don’t require a QGIS environment:

@pytest.mark.unit
class TestMyModule:
    @patch('my_module.QgsProject')
    def test_something(self, mock_project):
        # Test with mocked QGIS dependencies
        pass

Integration Test Example

Integration tests test interactions between components. They can be in the same file as unit tests but are marked separately:

@pytest.mark.integration
class TestMyModuleIntegration:
    def test_component_interaction(self):
        # Test interactions between mocked components
        pass

QGIS Integration Test Example

QGIS tests use pytest-qgis and run in a real QGIS environment:

@pytest.mark.qgis  
class TestMyModuleQGIS:
    def test_with_qgis(self, qgis_iface):
        # Test with real QGIS interface
        pass

Coverage

The project uses coverage.py to track test coverage:

# Generate coverage report
uv run pytest --cov=dip_strike_tools --cov-report=html

# View HTML coverage report
open htmlcov/index.html

Coverage configuration is in pyproject.toml:

[tool.coverage.run]
source = ["dip_strike_tools"]
omit = ["*/tests/*", "*/test_*", "*/__pycache__/*"]

Writing Tests

For new modules

Unit tests in tests/unit/test_module_name.py:
- Test basic functionality with mocked dependencies
- Test error handling and edge cases
- Test without requiring QGIS
Integration tests in tests/qgis/test_module_name_qgis.py:
- Test with real QGIS environment
- Test GUI components and user interactions
- Test QGIS API integration

Example test structure

# tests/unit/test_my_module.py
import pytest
from unittest.mock import Mock, patch

@pytest.mark.unit
class TestMyModule:
    def test_basic_functionality(self):
        # Basic unit test
        pass

    @patch('my_module.qgis_dependency')
    def test_with_mocked_qgis(self, mock_qgis):
        # Test with mocked QGIS
        pass

# tests/qgis/test_my_module_qgis.py  
import pytest

@pytest.mark.qgis
class TestMyModuleQGIS:
    def test_with_real_qgis(self, qgis_iface):
        # Test with real QGIS
        pass