Default Test Suite

Default Test Suite test suite for BIRD Bench

Overview

This is a comprehensive test suite for BIRD regulatory templates and data validation.

Installation

Automatic Installation (Recommended)

# Clone and install via Django management command
python manage.py fetch_test_suite --repo github.com/benjamin-arfa/bird-default-test-suite --name bird_default_test_suite

Manual Installation

1. Clone this repository:

   git clone https://github.com/benjamin-arfa/bird-default-test-suite.git
   cd bird-default-test-suite

2. Run the installer:

   python install.py

3. Install dependencies:

   pip install -r requirements.txt

Structure

bird_default_test_suite/
├── suite_manifest.json           # Test suite metadata
├── tests/                        # Test files and fixtures
│   ├── fixtures/
│   │   └── templates/            # Test fixtures organized by template
│   │       └── {reg_tid}/       # Regulatory template ID
│   │           └── {dp_suffix}/ # Data point suffix
│   │               └── {scenario}/  # Test scenario
│   │                   └── sql_inserts.sql
│   └── test_results/             # Test execution results
├── configuration_file_tests.json # Test configuration
├── requirements.txt              # Dependencies
├── install.py                    # Installation script
└── README.md                     # This file

Usage

Running Tests

After installation, the test suite is automatically integrated:

# Run all tests (including this suite)
python pybirdai/utils/run_tests.py --config-file tests/configuration_file_tests.json

# Run only this suite's tests
python pybirdai/utils/run_tests.py --config-file tests/bird_default_test_suite/configuration_file_tests.json

Configuration

Edit tests/bird_default_test_suite/configuration_file_tests.json to configure your tests:

{
  "tests": [
    {
      "reg_tid": "F_05_01_REF_FINREP_3_0",
      "dp_suffix": "152589_REF",
      "dp_value": 83491250,
      "scenario": "basic_scenario",
      "_suite": "bird_default_test_suite"
    }
  ]
}

Adding Test Data

1. Create fixture directory: tests/fixtures/templates/{reg_tid}/{dp_suffix}/{scenario}/
2. Add SQL files:
   • sql_inserts.sql: Setup data for the test (cleanup handled automatically by database service)
3. Update configuration file with new test entry

Test Scenarios

This test suite includes scenarios for:

• Basic regulatory template validation
• Data point calculations
• Compliance checks
• Error handling

Dependencies

• Django >= 4.0
• pytest >= 6.0
• pyecore >= 0.15.1
• pytest-xdist >= 2.0

See requirements.txt for complete dependency list.

Contributing

1. Fork the repository
2. Create a feature branch
3. Add your test scenarios and fixtures
4. Update configuration as needed
5. Submit a pull request

License

Eclipse Public License 2.0 (EPL-2.0)

Version

1.0.0

Author

Test Suite Developer

---

Generated by BIRD Test Suite Packaging Tool