Implement XTCE validation

- Ruff formatted and ruff lint fixes
- Remove namespace on test_xtce_no_namespace.xml and make namespace handling on definitions.py clearer
- Fix XML structure for XTCE test files
- Fix CTIM XTCE for validity
- Update changelog
- Tighten up warnings for no namespace for XtcePacketDefinition
- Add tests for XSD schema validity
- Add tests for different inputs to validation function
- Add test for different inputs to definition from_xtce
- Add structural validation and tests
- Add validate_xtce to top level module
- Add simple CLI to validation tool
- Add codecov.yaml
- Mock out XSD retrieval from omg.org to prevent DOSing the schema server when testing
- Add caching mechanism for XSD retrievals during validation
- Clean up CLI handling of common error

Author: medley56

.devcontainer/Dockerfile

@@ -92,4 +92,4 @@ USER $USERNAME
 
 # Copy CLAUDE.md and settings to Claude config directory
 COPY CLAUDE.md /home/$USERNAME/.claude/
-COPY claude-settings.json /home/$USERNAME/.claude/.claude.json
+COPY claude-settings.json /home/$USERNAME/.claude/settings.json

.devcontainer/claude-settings.json

@@ -1,4 +1,5 @@
 {
+  "model": "sonnet",
   "autoUpdates": true,
   "hasCompletedOnboarding": false,
   "shiftEnterKeyBindingInstalled": true,

.devcontainer/devcontainer.json

@@ -27,13 +27,15 @@
         "github.copilot",
         "github.copilot-chat",
         "anthropic.claude-code",
-        "GitHub.vscode-pull-request-github"
+        "GitHub.vscode-pull-request-github",
+        "github.vscode-github-actions"
       ],
       "settings": {
         "dev.containers.copyGitConfig": true,
         "python.terminal.activateEnvironment": false,
         "python-envs.terminal.autoActivationType": "off",
         "python.defaultInterpreterPath": "python",
+        "python.REPL.enableREPLSmartSend": false,
         "python.testing.pytestEnabled": true,
         "python.testing.unittestEnabled": false,
         "python.testing.pytestArgs": [

.gitignore

@@ -60,6 +60,9 @@ Thumbs.db
 .idea
 .project
 .run
+.vscode
+core
+# Sometimes devcontainers create a core dump file when restarting
 
 # Virtual environment #
 #######################

codecov.yml

@@ -0,0 +1,24 @@
+# Codecov configuration for space_packet_parser
+# https://docs.codecov.com/docs/codecovyml-reference
+
+coverage:
+  status:
+    project:
+      default:
+        target: 95%  # Target coverage percentage
+        threshold: 5%  # Allow 5% drop without failing
+        if_no_uploads: error  # Fail if no coverage data
+        only_pulls: false  # Check coverage on all commits
+    patch:
+      default:
+        target: 85%  # Lower threshold for new code
+        threshold: 5%
+        only_pulls: true  # Only check patch coverage on PRs
+
+  ignore:
+    - "tests/**/*"  # Don't include test files in coverage
+    - "scripts/**/*"  # Don't include utility scripts
+    - "examples/**/*"  # Don't include examples
+    - "docs/**/*"  # Don't include documentation
+    - "**/__init__.py"  # Ignore init files
+    - "**/conftest.py"  # Ignore pytest configuration

docs/source/changelog.md

@@ -14,6 +14,7 @@ Release notes for the `space_packet_parser` library
 - *BREAKING*: Removed mid-level abstraction methods `packet_generator()` and `ccsds_packet_generator()`
   from `XtcePacketDefinition`. Use low-level `parse_bytes()` with bytes generators directly, or high-level
   `space_packet_parser.xarr.create_dataset()` for xarray integration.
+- Add validation support for XTCE documents.
 - Add support for creating a packet definition from Python objects and serializing it as XML.
 - BUGFIX: Fix kbps calculation in packet generator for showing progress.
 - Add support for string and float encoded enumerated lookup parameters.

docs/source/users.md

@@ -376,6 +376,62 @@ This equation can be implemented in XTCE by referencing the packet length field
 </xtce:BinaryParameterType>
 ```
 
+## XTCE Document Validation
+
+Space Packet Parser provides comprehensive validation capabilities for XTCE documents to help ensure they are correct and will work properly for parsing packets. The validation system operates in three modes: "schema", "structure", and a default mode of "all" (both schema and structure validation).
+
+- **Schema Validation**: Validates the XML document against the in-document referenced XTCE XSD schema
+- **Structural Validation**: Validates XTCE-specific structure and reference integrity
+
+Schema validation requires correct namespacing declarations at the top of your XTCE document.
+e.g.
+
+```xml
+<xtce:SpaceSystem name="SpacePacketParser"
+                  xmlns:xtce="http://www.omg.org/spec/XTCE/20180204"
+                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                  xsi:schemaLocation="http://www.omg.org/spec/XTCE/20180204
+                                      https://www.omg.org/spec/XTCE/20180204/SpaceSystem.xsd">
+```
+
+### CLI Validation
+
+```shell
+spp --log-level=DEBUG validate my_xtce.xml --local-schema my_xsd.xml --level all
+```
+
+### Programmatic Validation
+
+```python
+from space_packet_parser import validate_xtce
+
+# Validate an XTCE file against the referenced schema
+result = validate_xtce("my_xtce.xml", level="schema")
+if result.errors:
+    for error in result.errors:
+        print(f"Error: {error}")
+else:
+    print("Document is valid")
+
+# Validate an XTCE document structure to check for
+# unused Parameters ParameterTypes and nonexistent references
+result = validate_xtce("my_xtce.xml", level="structure")
+if result.errors:
+    for error in result.errors:
+        print(f"Error: {error}")
+else:
+    print("Document is valid")
+
+# Comprehensive validation (both schema and structure)
+result = validate_xtce("my_xtce.xml", level="all")
+print(f"Validation completed in {result.validation_time_ms:.1f}ms")
+if result.errors:
+    for error in result.errors:
+        print(f"Error: {error}")
+else:
+    print("Document is valid")
+```
+
 ## Troubleshooting Packet Parsing
 Parsing binary packets is error-prone and getting the XTCE definition correct can be a challenge at first.
 Most flight software teams can export XTCE from their command and telemetry database but these exports usually require

pyproject.toml

@@ -150,4 +150,7 @@ select = [
     "UP"  # pyupgrade syntax upgrader
 ]
 per-file-ignores = { "tests/*" = ["S"] }
-ignore = ["E501"] # Ignore line length errors, as we trust ruff format to handle this.
+ignore = [
+    "E501", # Ignore line length errors, as we trust ruff format to handle this.
+    "F541" # Allow f strings as docstrings
+]

space_packet_parser/__init__.py

@@ -6,12 +6,14 @@
 from space_packet_parser.ccsds import ccsds_generator
 from space_packet_parser.common import SpacePacket
 from space_packet_parser.xtce.definitions import XtcePacketDefinition
+from space_packet_parser.xtce.validation import validate_xtce
 
 __all__ = [
     "ccsds_generator",
     "SpacePacket",
     "XtcePacketDefinition",
     "load_xtce",
+    "validate_xtce",
 ]
 
 

space_packet_parser/cli.py

@@ -26,6 +26,7 @@
 from space_packet_parser import ccsds
 from space_packet_parser.ccsds import ccsds_generator
 from space_packet_parser.xtce.definitions import DEFAULT_ROOT_CONTAINER, XtcePacketDefinition
+from space_packet_parser.xtce.validation import validate_xtce
 
 # Initialize a console instance for rich output
 console = Console()
@@ -208,3 +209,55 @@ def parse(
     # Limit the number of packets and variables printed
     # also limit the length of strings (binary data can be long)
     pretty.pprint(packets, indent_guides=False, max_length=max_items, max_string=max_string)
+
+
+@spp.command()
+@click.argument("file_path", type=click.Path(exists=True, path_type=Path))
+@click.option(
+    "--level",
+    type=click.Choice(["schema", "structure", "all"], case_sensitive=False),
+    default="all",
+    help="Validation level to perform",
+)
+@click.option("--timeout", type=int, default=30, help="Timeout in seconds for schema downloads")
+@click.option("--local-xsd", type=click.Path(exists=True, path_type=Path), help="Local XSD file for schema validation")
+def validate(file_path: Path, level: str, timeout: int, local_xsd: Path) -> None:
+    """Validate an XTCE document."""
+    logging.info(f"Validating XTCE file: {file_path}")
+    logging.info(f"Validation level: {level}")
+    logging.debug(f"Timeout: {timeout}")
+    logging.debug(f"Local XSD: {local_xsd}")
+
+    result = validate_xtce(
+        file_path,
+        level=level.lower(),
+        timeout=timeout,
+        print_results=False,
+        raise_on_error=False,
+        local_xsd=local_xsd,
+    )
+
+    # Display results in rich format (complementing the print_results from validate_xtce)
+    if result.valid:
+        console.print(f"[bold green]✓ VALID[/bold green] ({result.validation_level.value} level)")
+    else:
+        console.print(f"[bold red]✗ INVALID[/bold red] ({result.validation_level.value} level)")
+
+    if result.schema_location:
+        console.print(f"Schema: {result.schema_location}")
+    if result.schema_version:
+        console.print(f"Version: {result.schema_version}")
+
+    if result.validation_time_ms:
+        console.print(f"Validation time: {result.validation_time_ms:.1f}ms")
+
+    if result.errors:
+        console.print(f"\n[bold red]Errors ({len(result.errors)}):[/bold red]")
+        for error in result.errors:
+            console.print(f"  {error}")
+            if error.context:
+                console.print(f"  - Additional context: {error.context}")
+
+    # Exit with error code if validation failed (unless raise_on_error is True, which already raised)
+    if not result.valid:
+        raise click.ClickException("Validation failed")