Pull the correct collection plugin for the product #15658
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jessicamack
force-pushed
the
inv-plugin-split
branch
from
126d887
to
4bf0ba8
Compare
webknjaz
reviewed
Nov 27, 2024
Comment on lines
+1408
to
+1410
| awx_entry_points = {ep.name: ep for ep in entry_points(group='awx_plugins.inventory')} | ||
| supported_entry_points = {ep.name: ep for ep in entry_points(group='awx_plugins.inventory.supported')} | ||
| entry_points = awx_entry_points if detect_server_product_name() == 'AWX' else {**awx_entry_points, **supported_entry_points} |
There was a problem hiding this comment.
Perhaps, it's better to skip the lookup altogether when not needed?
Suggested change
| awx_entry_points = {ep.name: ep for ep in entry_points(group='awx_plugins.inventory')} | |
| supported_entry_points = {ep.name: ep for ep in entry_points(group='awx_plugins.inventory.supported')} | |
| entry_points = awx_entry_points if detect_server_product_name() == 'AWX' else {**awx_entry_points, **supported_entry_points} | |
| awx_entry_points = {ep.name: ep for ep in entry_points(group='awx_plugins.inventory')} | |
| supported_entry_points = dict() if detect_server_product_name() == 'AWX' else {ep.name: ep for ep in entry_points(group='awx_plugins.inventory.supported')} | |
| entry_points = {**awx_entry_points, **supported_entry_points} |
webknjaz
reviewed
Nov 27, 2024
Comment on lines
+1412
to
+1414
| for entry_point_name, entry_point in entry_points.items(): | ||
| cls = entry_point.load() | ||
| InventorySourceOptions.injectors[entry_point_name] = cls |
There was a problem hiding this comment.
It'd be best if this wasn't happening during the import time but called in some predictable hook point, early in django's lifecycle.
There was a problem hiding this comment.
Yep, here is a better place
webknjaz
reviewed
Nov 27, 2024
Comment on lines
+1408
to
+1410
| awx_entry_points = {ep.name: ep for ep in entry_points(group='awx_plugins.inventory')} | ||
| supported_entry_points = {ep.name: ep for ep in entry_points(group='awx_plugins.inventory.supported')} | ||
| entry_points = awx_entry_points if detect_server_product_name() == 'AWX' else {**awx_entry_points, **supported_entry_points} |
There was a problem hiding this comment.
How about
Suggested change
| awx_entry_points = {ep.name: ep for ep in entry_points(group='awx_plugins.inventory')} | |
| supported_entry_points = {ep.name: ep for ep in entry_points(group='awx_plugins.inventory.supported')} | |
| entry_points = awx_entry_points if detect_server_product_name() == 'AWX' else {**awx_entry_points, **supported_entry_points} | |
| def _load_all_entry_points_for(entry_point_subsections: list[str], /) -> dict[str, EntryPoint]: | |
| return { | |
| ep.name: ep | |
| for entry_point_category in entry_point_subsections | |
| for ep in entry_points(group=f'awx_plugins.{entry_point_category}') | |
| } | |
| is_awx = detect_server_product_name() == 'AWX' | |
| extra_entry_point_groups = () if is_awx else ('inventory.supported', ) | |
| entry_points = _load_all_entry_points_for(['inventory', *extra_entry_point_groups]) |
?
There was a problem hiding this comment.
Although, it probably makes sense to put _load_all_entry_points_for() into awx_plugins.interfaces, making it reusable.
There was a problem hiding this comment.
I lean towards not putting it in awx_plugins.interfaces right now. AWX is the only thing we plan on consuming these entry points at this time.
| @@ -9,6 +9,7 @@ | |||
| import copy | |||
| import os.path | |||
| from urllib.parse import urljoin | |||
| from importlib.metadata import entry_points | |||
There was a problem hiding this comment.
Suggested change
| from importlib.metadata import entry_points | |
| from importlib.metadata import entry_points, EntryPoint |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
There exist several cases of inventory plugins with the same name but different implementations. Historically, AWX/Controller pivoted on attributes on the inventory source to figure out which ansible inventory to call. Now, instead of a single implementation we've split them into two implementations completely. This PR is to implement the change to pick which one we want and when.
Requires: ansible/awx-plugins#61
ISSUE TYPE
COMPONENT NAME
AWX VERSION
ADDITIONAL INFORMATION