feat: generic plugin protocol with dgoss as builtin plugin by ianpittwood · Pull Request #406 · posit-dev/images-shared

ianpittwood · 2026-03-30T23:39:34Z

Summary

Introduces a BakeryToolPlugin protocol that defines a generic contract for tool plugins (CLI registration, execution, and optional tool configuration)
Refactors dgoss as the first builtin plugin at posit_bakery/plugins/builtin/dgoss/, fully self-contained with its own command model, suite orchestrator, report models, error types, and YAML tool options
Adds plugin discovery via Python entry points (bakery.plugins group), supporting both builtin and future external plugins
Moves the canonical CLI path to bakery dgoss run with a deprecation bridge at bakery run dgoss
Implements dynamic tool options registration — plugins expose a tool_options_class that is automatically wired into bakery.yaml deserialization via pydantic model_rebuild

Test plan

All 1211 existing tests pass (verified locally, 26 slow tests deselected)
bakery dgoss run --help shows the new command group
bakery run dgoss --help shows deprecation notice and still works
Plugin registry discovers dgoss via entry points
GossOptions from bakery.yaml parses correctly through the plugin's dynamic tool field
Run bakery dgoss run against a product repo to verify end-to-end

🤖 Generated with Claude Code

Documents the design for refactoring dgoss as a builtin plugin implementing the BakeryToolPlugin protocol, including plugin discovery via entry points, CLI registration, and deprecation bridge. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

13-task plan covering protocol update, registry, dgoss plugin migration, CLI wiring, deprecation bridge, and cleanup. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…time_checkable Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Implements discover_plugins() with entry-point-based loading and caching, and get_plugin() with a KeyError for unknown names. Adds TestDiscoverPlugins and TestGetPlugin test classes (dgoss-dependent tests will pass in Task 7+8). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Remove posit_bakery/image/goss/ and test/image/goss/ now that all functionality has been migrated to the dgoss plugin. Update image/__init__.py to drop the DGossSuite re-export, and update test/test_error.py to import BakeryDGossError from its new location in the dgoss plugin.

…stry Plugins can now provide tool configuration by exposing a tool_options_class attribute. The config system dynamically builds the discriminated union for YAML deserialization from registered plugin tool options, with model_rebuild after plugin discovery. - Move GossOptions to plugins/builtin/dgoss/options.py - Add config/tools/registry.py for tool options registration - Update config/tools/__init__.py with dynamic ToolField building - Plugin registry registers tool options and rebuilds config models - Break circular import in protocol.py with TYPE_CHECKING guard Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions · 2026-03-30T23:53:25Z

Test Results

1 237 tests +8 1 237 ✅ +8 13m 3s ⏱️ +28s
1 suites ±0 0 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit cd43674. ± Comparison against base commit ea57e2b.

♻️ This comment has been updated with latest results.

Plugin invocation is handled by the plugin's CLI command or by calling get_plugin().execute() directly. No config wrapper needed. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…tion bridge The dgoss result display logic now lives in DGossPlugin.display_results(). Both the plugin CLI command and the deprecation bridge call it. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

ianpittwood · 2026-03-31T14:08:47Z

posit-bakery/posit_bakery/config/tools/registry.py

+    :param cls: The ToolOptions subclass to register.
+    """
+    if name in _tool_options_classes:
+        log.warning(f"Tool options for '{name}' already registered, overwriting.")


I'm debating whether this should warn or raise.

Hmmm... At this point I think it is fine to warn, but if we want to open this up to make it easier to register plugins, we will definitely want to raise.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

bschwedler

I am really liking this approach.

My only comment/concern is the difference in CLI structure between core bakery commands and the plugins. I am not suggesting any changes now.

bschwedler · 2026-04-02T14:37:57Z

posit-bakery/posit_bakery/cli/run.py

    """Runs dgoss tests against images in the context path

+    \b
+    DEPRECATED: Use 'bakery dgoss run' instead.


This is moving more towards a mixed convention the CLI UX

For bakery operations we use the verb-noun pattern (similar to kubectl). The plugin operations follow more of a namespace-verb pattern (similar to docker and podman).
We already kind of already straddle this with bakery ci.

What are your thoughts here?

The benefit would be a clear delineation if every plugin is nested under run, but I'm concerned we may go away from that being our desired approach at some point.

bschwedler · 2026-04-02T14:43:59Z

posit-bakery/posit_bakery/config/tools/registry.py

+    :param cls: The ToolOptions subclass to register.
+    """
+    if name in _tool_options_classes:
+        log.warning(f"Tool options for '{name}' already registered, overwriting.")


Hmmm... At this point I think it is fine to warn, but if we want to open this up to make it easier to register plugins, we will definitely want to raise.

bschwedler · 2026-04-02T14:44:30Z

posit-bakery/posit_bakery/config/tools/registry.py

+"""
+
+import logging
+from typing import TYPE_CHECKING


We should probably start enforcing type checking, but not in this PR. 😀

ianpittwood and others added 16 commits March 30, 2026 12:50

Initial plugin protocol design

bff7c4c

Add plugin protocol implementation plan

4eacb40

13-task plan covering protocol update, registry, dgoss plugin migration, CLI wiring, deprecation bridge, and cleanup. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

feat: update BakeryToolPlugin protocol with execute signature and run…

14c51ab

…time_checkable Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

feat: add BakeryDGossError to dgoss plugin package

edc35ab

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

feat: move goss report models to dgoss plugin

7eb17d0

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

feat: move DGossCommand to dgoss plugin

246a733

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

feat: move DGossSuite to dgoss plugin

ed039c5

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

feat: implement DGossPlugin with CLI registration and execute method

281f156

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

feat: register dgoss plugin via entry points and wire CLI startup

ac214c8

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

feat: add deprecation bridge for 'bakery run dgoss'

4034e9e

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

refactor: decouple config.py from goss module, use plugin registry

d8b154a

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

refactor: remove BakeryDGossError from error.py (moved to dgoss plugin)

5091c04

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

ianpittwood and others added 2 commits March 31, 2026 07:54

refactor: remove dgoss_targets from BakeryConfig

2a8bee1

Plugin invocation is handled by the plugin's CLI command or by calling get_plugin().execute() directly. No config wrapper needed. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

ianpittwood commented Mar 31, 2026

View reviewed changes

ianpittwood and others added 2 commits March 31, 2026 08:13

refactor: make DGossPlugin explicitly inherit from BakeryToolPlugin

fae7b19

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Remove spec and plan

cd43674

ianpittwood marked this pull request as ready for review March 31, 2026 14:25

ianpittwood requested a review from bschwedler as a code owner March 31, 2026 14:25

bschwedler mentioned this pull request Apr 1, 2026

Handle tools used for images as plugins #91

Open

bschwedler approved these changes Apr 2, 2026

View reviewed changes

ianpittwood added this pull request to the merge queue Apr 2, 2026

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 2, 2026

ianpittwood added this pull request to the merge queue Apr 2, 2026

Merged via the queue into main with commit 6990052 Apr 2, 2026
16 checks passed

ianpittwood deleted the feature/plugin-protocol branch April 2, 2026 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: generic plugin protocol with dgoss as builtin plugin#406

feat: generic plugin protocol with dgoss as builtin plugin#406
ianpittwood merged 20 commits intomainfrom
feature/plugin-protocol

ianpittwood commented Mar 30, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 30, 2026 •

edited

Loading

Uh oh!

ianpittwood Mar 31, 2026

Uh oh!

bschwedler Apr 2, 2026

Uh oh!

bschwedler left a comment

Uh oh!

bschwedler Apr 2, 2026

Uh oh!

ianpittwood Apr 2, 2026

Uh oh!

bschwedler Apr 2, 2026

Uh oh!

bschwedler Apr 2, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

ianpittwood commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

github-actions bot commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

ianpittwood Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

bschwedler Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

bschwedler left a comment

Choose a reason for hiding this comment

Uh oh!

bschwedler Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

ianpittwood Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

bschwedler Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

bschwedler Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ianpittwood commented Mar 30, 2026 •

edited

Loading

github-actions bot commented Mar 30, 2026 •

edited

Loading