Testing¶

This guide covers how to run and write tests for JobShopLab, ensuring the framework’s reliability and stability.

Running Tests¶

JobShopLab uses pytest for testing. All tests are located in the tests/ directory and are organized by test type.

To run the full test suite:

pytest

To run specific test categories:

# Run only unit tests
pytest tests/unit_tests/

# Run only integration tests
pytest tests/integration_tests/

# Run only end-to-end tests
pytest tests/end_to_end_tests/

# Run a specific test file
pytest tests/unit_tests/test_state_machine.py

# Run a specific test function
pytest tests/unit_tests/test_state_machine.py::test_function_name

Check Test Coverage¶

To generate a test coverage report:

./scripts/get_test_coverage.sh

This will run tests with coverage analysis and generate an HTML report in the htmlcov/ directory.

Test Structure¶

Tests in JobShopLab follow these organizational principles:

Unit Tests (tests/unit_tests/)

Test individual components in isolation. Each module typically has its own test file.
Integration Tests (tests/integration_tests/)

Test interactions between components. These tests verify that modules work correctly together.
End-to-End Tests (tests/end_to_end_tests/)

Test complete workflows from environment creation to step execution and rendering.
Fuzzy Tests (tests/fuzzy_testing/)

Explore edge cases through randomized inputs.

Writing Tests¶

When writing tests for JobShopLab, follow these guidelines:

Name tests descriptively

Test names should describe what they’re testing and the expected outcome.
```
def test_machine_processes_job_correctly():
    # Test implementation
```

Use fixtures for setup

JobShopLab has several fixtures defined in conftest.py files to help with test setup.

def test_with_standard_config(standard_config):
    # Test using the standard_config fixture
    assert standard_config["machines"] > 0

Test both success and failure cases

Ensure both valid and invalid inputs are tested.

def test_invalid_transition_raises_exception():
    # Setup
    state_machine = create_test_state_machine()

    # Test that invalid transition raises the correct exception
    with pytest.raises(InvalidTransitionError):
        state_machine.transition(invalid_action)

Test Data¶

Test data is stored in tests/data/ and includes:

Sample configuration files
Test problem instances
Invalid configurations for testing error handling

When adding new features, ensure that appropriate test data is included.

Troubleshooting Tests¶

If tests are failing:

Check if you’ve installed all dependencies
Ensure your code follows the established patterns
Run failing tests with the -v flag for more details:
```
pytest tests/failing_test.py -v
```
Use the --pdb flag to drop into a debugger when a test fails:
```
pytest tests/failing_test.py --pdb
```