Skip to content

[ Tools ] : move logger documentation validation to standalone script#32111

Closed
Dijo-404 wants to merge 1 commit intoArduPilot:masterfrom
Dijo-404:fix/move-logging-validation
Closed

[ Tools ] : move logger documentation validation to standalone script#32111
Dijo-404 wants to merge 1 commit intoArduPilot:masterfrom
Dijo-404:fix/move-logging-validation

Conversation

@Dijo-404
Copy link

@Dijo-404 Dijo-404 commented Feb 5, 2026

  • Added Tools/autotest/logger_metadata/validate.py with combined generation and validation logic
  • Simplified LoggerDocumentation() in vehicle_test_suite.py to call validate.py
  • Updated build_ci.sh logger_metadata target to use validate.py

Closes #17579

Note: I noticed that there are pre-existing undocumented messages in Blimp (BSC, VNF) which cause a failure in the CI logger_metadata target. This is a known issue within the Blimp vehicle code and is not introduced by this PR's move to a standalone script.

Blimp issue
Build_error

validate.py
Build_success

Copilot AI review requested due to automatic review settings February 5, 2026 16:32
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refactors logger documentation validation by moving it from the autotest suite into a standalone script, addressing issue #17579. The change enables earlier validation in the CI pipeline without requiring the full autotest suite to run.

Changes:

  • Created Tools/autotest/logger_metadata/validate.py as a standalone script that combines documentation generation (via parse.py) with validation logic
  • Simplified LoggerDocumentation() in vehicle_test_suite.py to call the new validate.py script instead of performing validation inline
  • Updated build_ci.sh logger_metadata target to use validate.py instead of parse.py

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File Description
Tools/autotest/logger_metadata/validate.py New standalone script that generates and validates logger documentation for all vehicles
Tools/autotest/vehicle_test_suite.py Refactored LoggerDocumentation() method to delegate to standalone validate.py script
Tools/scripts/build_ci.sh Updated CI build script to call validate.py instead of parse.py for logger_metadata target

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Extracted validation logic from vehicle_test_suite.py to validate.py
- Improved temp directory cleanup
- Added Helicopter whitelist support
- Fixed KeyError during validation
@Dijo-404 Dijo-404 force-pushed the fix/move-logging-validation branch from 59d5f3d to 7b7a1e7 Compare February 5, 2026 17:14
@peterbarker
Copy link
Contributor

Sorry, I think you mis-understood the issue. This was done in 9e4bdf3

Feel free to create another PR to fix the Blimp problems you saw.

@peterbarker peterbarker closed this Feb 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Move test_onboard_logging_generation outside autotest.py

2 participants