HED Test Suite¶
Welcome to the HED Test Suite documentation! This repository provides the official JSON test cases for validating HED (Hierarchical Event Descriptors) validator implementations across all platforms.
What is the HED Test Suite?¶
The HED Test Suite is a centralized, version-controlled collection of JSON test cases that ensure consistent validation behavior across all HED validator implementations. Tests are designed to:
Validate validators: Ensure Python, JavaScript, and future implementations produce consistent results
Specify behavior: Provide machine-readable examples of HED validation rules
Enable AI training: Include structured explanations and correction examples for AI systems
Prevent regressions: Catch validation changes across versions
Key Features¶
Comprehensive coverage: 136 test cases covering 33 error codes
Multiple test types: String, sidecar, event, and combo tests
AI-friendly: 100% of tests include explanations and correction strategies
Cross-platform: Single source of truth for all validator implementations
Automated validation: JSON schema validation ensures test quality
Getting started¶
Test suite documentation¶
- Test format specification
- Test coverage report
- Test index
- Quick Navigation
- CHARACTER_INVALID
- COMMA_MISSING
- DEFINITION_INVALID
- DEF_EXPAND_INVALID
- DEF_INVALID
- ELEMENT_DEPRECATED
- PARENTHESES_MISMATCH
- PLACEHOLDER_INVALID
- SCHEMA_ATTRIBUTE_INVALID
- SCHEMA_ATTRIBUTE_VALUE_INVALID
- SCHEMA_CHARACTER_INVALID
- SCHEMA_DEPRECATION_ERROR
- SCHEMA_DUPLICATE_NODE
- SCHEMA_HEADER_INVALID
- SCHEMA_LIBRARY_INVALID
- SCHEMA_LOAD_FAILED
- SCHEMA_SECTION_MISSING
- SIDECAR_BRACES_INVALID
- SIDECAR_INVALID
- SIDECAR_KEY_MISSING
- TAG_EMPTY
- TAG_EXPRESSION_REPEATED
- TAG_EXTENDED
- TAG_EXTENSION_INVALID
- TAG_GROUP_ERROR
- TAG_INVALID
- TAG_NAMESPACE_PREFIX_INVALID
- TAG_NOT_UNIQUE
- TAG_REQUIRES_CHILD
- TEMPORAL_TAG_ERROR
- UNITS_INVALID
- VALUE_INVALID
- WIKI_DELIMITERS_INVALID
For validator developers¶
If you’re building or maintaining a HED validator, the test suite provides comprehensive test cases to ensure your implementation matches the specification. See the Validator integration guide guide for details on consuming these tests.
For contributors¶
Want to add new test cases or improve existing ones? See our ../CONTRIBUTING guide for guidelines on test file format, naming conventions, and the contribution process.
Repository¶
License: MIT
User guide <user_guide>