Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use .select() for entrypoints under importlib_metadata>=5.0.0 #62854

Merged
merged 5 commits into from
Oct 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/62854.fixed
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Use select instead of iterating over entrypoints as a dictionary for importlib_metadata>=5.0.0
15 changes: 11 additions & 4 deletions salt/utils/entrypoints.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,20 @@ def iter_entry_points(group, name=None):
entry_points_listing = []
entry_points = importlib_metadata.entry_points()

for entry_point_group, entry_points_list in entry_points.items():
if entry_point_group != group:
continue
for entry_point in entry_points_list:
try:
for entry_point in entry_points.select(group=group):
if name is not None and entry_point.name != name:
continue
entry_points_listing.append(entry_point)
except AttributeError:
# importlib-metadata<5.0.0
for entry_point_group, entry_points_list in entry_points.items():
if entry_point_group != group:
continue
for entry_point in entry_points_list:
if name is not None and entry_point.name != name:
continue
entry_points_listing.append(entry_point)

return entry_points_listing

Expand Down
67 changes: 62 additions & 5 deletions tests/pytests/functional/loader/test_loader.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import json
import sys

import pytest

Expand Down Expand Up @@ -144,10 +143,6 @@ def test_utils_loader_does_not_load_extensions(
assert "foobar.echo" not in loader_functions


@pytest.mark.skipif(
sys.version_info < (3, 6),
reason="importlib-metadata>=3.3.0 does not exist for Py3.5",
)
def test_extension_discovery_without_reload_with_importlib_metadata_installed(
venv, salt_extension, salt_minion_factory
):
Expand Down Expand Up @@ -210,6 +205,68 @@ def test_extension_discovery_without_reload_with_importlib_metadata_installed(
assert "foobar.echo2" in loader_functions


def test_extension_discovery_without_reload_with_importlib_metadata_5_installed(
venv, salt_extension, salt_minion_factory
):
# Install our extension into the virtualenv
installed_packages = venv.get_installed_packages()
assert salt_extension.name not in installed_packages
venv.install("importlib-metadata>=3.3.0")
code = """
import sys
import json
import subprocess
import salt._logging
import salt.loader

extension_path = "{}"

minion_config = json.loads(sys.stdin.read())
salt._logging.set_logging_options_dict(minion_config)
salt._logging.setup_logging()
loader = salt.loader.minion_mods(minion_config)

if "foobar.echo1" in loader:
sys.exit(1)

# Install the extension
proc = subprocess.run(
[sys.executable, "-m", "pip", "install", extension_path],
check=False,
shell=False,
stdout=subprocess.PIPE,
)
if proc.returncode != 0:
sys.exit(2)

loader = salt.loader.minion_mods(minion_config)
if "foobar.echo1" not in loader:
sys.exit(3)

print(json.dumps(list(loader)))
""".format(
salt_extension.srcdir
)
ret = venv.run_code(
code, input=json.dumps(salt_minion_factory.config.copy()), check=False
)
# Exitcode 1 - Extension was already installed
# Exitcode 2 - Failed to install the extension
# Exitcode 3 - Extension was not found within the same python process after being installed
assert ret.returncode == 0
installed_packages = venv.get_installed_packages()
assert salt_extension.name in installed_packages

loader_functions = json.loads(ret.stdout)

# A non existing module should not appear in the loader
assert "monty.python" not in loader_functions

# But our extension's modules should appear on the loader
assert "foobar.echo1" in loader_functions
assert "foobar.echo2" in loader_functions


def test_extension_discovery_without_reload_with_bundled_importlib_metadata(
venv, salt_extension, salt_minion_factory
):
Expand Down