feat(plugins): add plugin groups #1393

lengau · 2025-11-08T19:02:13Z

This adds plugin groups as a way to set a collection of plugins all at once. Setting a plugin group will remove any manually registered plugins so it is crucial that this happen before registering other plugins.

CRAFT-4915

Have you followed the guidelines for contributing?
Have you signed the CLA?
Have you successfully run make lint && make test?
Have you added an entry to the changelog (docs/reference/changelog.rst)?

This adds plugin groups as a way to set a collection of plugins all at once. Setting a plugin group will remove any manually registered plugins so it is crucial that this happen before registering other plugins.

Copilot

Pull Request Overview

This PR introduces plugin groups to allow setting collections of plugins at once. The implementation adds three plugin groups: MINIMAL (dump and nil plugins), DEFAULT (all existing plugins), and QUESTING (DEFAULT plus v2 versions of dotnet and python plugins for Ubuntu 25.10+).

Key changes:

Plugin groups are defined as an enum with plugin dictionaries as values
New set_plugin_group() function replaces registered plugins with the specified group
The registry now initializes with the DEFAULT group instead of copying from a static dictionary

Reviewed Changes

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

File	Description
craft_parts/plugins/plugins.py	Implements PluginGroup enum and set_plugin_group() function, refactors plugin registration
craft_parts/plugins/python_v2/python_plugin.py	Updates imports to use specific base and properties modules
tests/unit/plugins/test_plugins.py	Adds test fixture for plugin cleanup and parametrized test for plugin groups
tests/integration/plugins/test_plugin_registry.py	Adds integration test verifying MINIMAL group excludes autotools plugin

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

craft_parts/plugins/plugins.py

tests/unit/plugins/test_plugins.py

craft_parts/plugins/plugins.py

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

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

tests/unit/plugins/test_plugins.py

bepri · 2025-11-12T22:00:23Z

craft_parts/plugins/plugins.py

+    The plugins in this group are generally considered functional on most legacy bases.
+    """
+
+    QUESTING = DEFAULT | {


What about naming it "EXPERIMENTAL" or "DEVEL"? I don't like the idea of having another place with an Ubuntu codename to update someday

Well we'd definitely need to change EXPERIMENTAL or DEVEL, but this name is a placeholder for "the plugin set we should use starting with Ubuntu questing."

I'm open to better names, but I don't think EXPERIMENTAL or DEVEL is it.

cc @tigarmo for name bikeshedding :-)

For this initial implementation I'm actually tending towards not having this per-base definition in craft-parts at all. My thinking is that ultimately it's the applications that dictate which plugins are even valid/possible for a given base, ideally after the plugins have been tested and validated. So it feels to me like any decision me make here regarding the 'default' plugins for a given base might be incorrect.

Any name suggestions? Otherwise I'll probably just call them ALICE and BOB

Well, at the moment it just contains usrmerge-fixed plugins, how about something like USRMERGE_READY?

Any name suggestions? Otherwise I'll probably just call them ALICE and BOB

My suggestion is only having DEFAULT

We are no longer questing for anything.

bepri · 2025-11-12T22:01:46Z

craft_parts/plugins/plugins.py

    """Unregister all user-registered plugins."""
-    global _plugins  # noqa: PLW0603
-    _plugins = copy.deepcopy(_BUILTIN_PLUGINS)
+    set_plugin_group(PluginGroup.DEFAULT)


I think unregister_all should reset to _plugins = {}, or _plugins should be PluginGroup.DEFAULT as its initial value. Having the two different possibilities is confusing.

The latter is the case already (see line 124).

I would prefer unregister_all to set it to empty, but that would be a breaking change.

oooh, sneaky...

bepri · 2025-11-17T14:38:22Z

craft_parts/plugins/plugins.py

    """Unregister all user-registered plugins."""
-    global _plugins  # noqa: PLW0603
-    _plugins = copy.deepcopy(_BUILTIN_PLUGINS)
+    set_plugin_group(PluginGroup.DEFAULT)


oooh, sneaky...

tigarmo · 2025-11-26T17:52:24Z

craft_parts/plugins/plugins.py

-}
-
-_plugins = copy.deepcopy(_BUILTIN_PLUGINS)
+class PluginGroup(enum.Enum):


is client code (the applications) meant to subclass this?

No, the application simply passes a similar looking dictionary to register to override the plugins. Something like...

if base < JAMMY: set_plugin_group(PluginGroup.MINIMAL) register(APP_SUPER_OLD_PLUGINS) elif base <= NOBLE: set_plugin_group(PluginGroup.DEFAULT) register(APP_PLUGINS_FOR_JAMMY_AND_NOBLE) elif base <= RESOLUTE: set_plugin_group(PluginGroup.THE_ONE_WITH_THE_NEW_PYTHON_AND_DOTNET) register(APP_PLUGINS_FOR_RESOLUTE) else: raise WeHaventThoughtThatFarInTheFutureError()

If the app wants to store those in their own enum it can, but then the likely steps would be to do:

set_plugin_group(PluginGroup.MINIMAL) register(AppPluginGroup.MY_GROUP)

I could generalise set_plugin_group though to take that dictionary?

I could generalise set_plugin_group though to take that dictionary?

I think this might be a good idea, otherwise it kind of looks like one needs to subclass the enum (and the linters might complain)

tigarmo

Thanks! Now I believe we should add a task in craft-app to provide a 'blessed' way for an application to fully define the set of plugins, right?

lengau added 2 commits November 8, 2025 20:02

feat(plugins): add plugin groups

31bc73c

This adds plugin groups as a way to set a collection of plugins all at once. Setting a plugin group will remove any manually registered plugins so it is crucial that this happen before registering other plugins.

fix(test): rearrange imports

3a04460

lengau requested a review from Copilot November 9, 2025 13:01

Copilot AI reviewed Nov 9, 2025

View reviewed changes

craft_parts/plugins/plugins.py Outdated Show resolved Hide resolved

tests/unit/plugins/test_plugins.py Show resolved Hide resolved

craft_parts/plugins/plugins.py Outdated Show resolved Hide resolved

lengau requested a review from Copilot November 9, 2025 14:40

lengau marked this pull request as ready for review November 9, 2025 14:40

lengau requested a review from a team as a code owner November 9, 2025 14:40

Copilot AI reviewed Nov 9, 2025

View reviewed changes

tests/unit/plugins/test_plugins.py Show resolved Hide resolved

bepri reviewed Nov 12, 2025

View reviewed changes

lengau requested review from bepri and tigarmo November 13, 2025 16:51

bepri approved these changes Nov 17, 2025

View reviewed changes

Merge branch 'main' into work/prototype-CRAFT-4339

2e052d4

tigarmo reviewed Nov 26, 2025

View reviewed changes

lengau added 3 commits December 2, 2025 15:25

chore: Merge branch 'main' into work/prototype-CRAFT-4339

350fd20

fix: pr feedback

76c7815

fix: PR suggestion

9abad6b

lengau requested a review from tigarmo December 2, 2025 20:32

tigarmo approved these changes Dec 3, 2025

View reviewed changes

feat(plugins): add plugin groups #1393

Are you sure you want to change the base?

feat(plugins): add plugin groups #1393

Conversation

lengau commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tigarmo left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lengau commented Nov 8, 2025 •

edited

Loading