Skip to content

Mark the examples' essential subscriptions required and validate their deployments - #56

Merged
tsaubergine merged 1 commit into
mainfrom
use-necessity
Nov 12, 2026
Merged

tsaubergine merged 1 commit into
mainfrom
use-necessity

Conversation

@tsaubergine

Copy link
Copy Markdown
Member

Summary

  • The subscriptions these examples can't work without now use Necessity::REQUIRED:
    • groups::nav in the ZeroMQ, UDPM and intervehicle basic subscribers;
    • the JSON subscriber's typed groups::nav;
    • both directions of the state machine (state_control into it, state_report back to the controller).
  • Removed the state machine controller's placeholder required subscription to groups::gps_control, which nothing publishes.
  • json_deployment.yml shows a deployment-level necessity override: it marks the JSON subscriber's type-regex subscription recommended.
  • With export_goby_interfaces=ON and enable_tests=ON, each deployment that has a test harness also gets a goby3_example_interfaces_<name> test. It runs goby interface validate --strict, so a required subscription with no publisher fails before anything is launched.

Dependencies

The validation tests need a goby that provides goby_validate_interfaces() (GobySoft/goby3#448). With an older goby they're skipped with a status message, so the CI build against the current continuous packages is unaffected.

Test plan

  • Built against the goby3 interface-* branches with export_goby_interfaces=ON enable_tests=ON. The validate tests pass, and they fail as expected when a required publisher is removed from a deployment.

Generated by Claude Code

…r deployments

The subscriptions these examples cannot work without now say so with
Necessity::REQUIRED: the ZeroMQ and UDPM basic subscribers' groups::nav,
the JSON subscriber's typed groups::nav, the intervehicle basic
subscriber's groups::nav, and both directions of the state machine
(state_control into the machine, state_report back to the controller).
The state machine controller's placeholder required subscription to
groups::gps_control, which nothing publishes, is removed.

json_deployment.yml shows a deployment setting a necessity: the JSON
subscriber's type-regex subscription is marked recommended there.

With export_goby_interfaces and enable_tests, each deployment with a
test harness is also checked by 'goby interface validate --strict' as a
goby3_example_interfaces_<name> test, so a required subscription left
without a publisher fails before anything is launched. This needs a goby
that provides goby_validate_interfaces(); with an older one the tests
are skipped with a status message.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TCmHEtuYatVV6nSaJPTa6z
@tsaubergine
tsaubergine merged commit f3c3a91 into main Nov 12, 2026
5 checks passed
@tsaubergine
tsaubergine deleted the use-necessity branch November 12, 2026 08:16
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.

2 participants