1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
|
# The standard library importlib.metadata returns duplicate entrypoints
# for all python versions up to and including 3.11
# https://github.com/python/importlib_metadata/issues/410#issuecomment-1304258228
# see PR https://github.com/asdf-format/asdf/pull/1260
# see issue https://github.com/asdf-format/asdf/issues/1254
import importlib_metadata as metadata
import pytest
from asdf import entry_points
from asdf._version import version as asdf_package_version
from asdf.exceptions import AsdfWarning
from asdf.extension import ExtensionProxy
from asdf.resource import ResourceMappingProxy
@pytest.fixture
def mock_entry_points():
return []
@pytest.fixture(autouse=True)
def monkeypatch_entry_points(monkeypatch, mock_entry_points):
def _entry_points(*, group):
for candidate_group, name, func_name in mock_entry_points:
if candidate_group == group:
point = metadata.EntryPoint(name=name, group="asdf.tests.test_entry_points", value=func_name)
vars(point).update(dist=metadata.distribution("asdf"))
yield point
monkeypatch.setattr(entry_points, "entry_points", _entry_points)
def resource_mappings_entry_point_successful():
return [
{"http://somewhere.org/schemas/foo-1.0.0": b"foo"},
{"http://somewhere.org/schemas/bar-1.0.0": b"bar"},
]
def resource_mappings_entry_point_failing():
raise Exception("NOPE")
def resource_mappings_entry_point_bad_element():
return [
{"http://somewhere.org/schemas/baz-1.0.0": b"baz"},
object(),
{"http://somewhere.org/schemas/foz-1.0.0": b"foz"},
]
def test_get_resource_mappings(mock_entry_points):
mock_entry_points.append(
(
"asdf.resource_mappings",
"successful",
"asdf.tests.test_entry_points:resource_mappings_entry_point_successful",
)
)
mappings = entry_points.get_resource_mappings()
assert len(mappings) == 2
for m in mappings:
assert isinstance(m, ResourceMappingProxy)
assert m.package_name == "asdf"
assert m.package_version == asdf_package_version
mock_entry_points.clear()
mock_entry_points.append(
("asdf.resource_mappings", "failing", "asdf.tests.test_entry_points:resource_mappings_entry_point_failing")
)
with pytest.warns(AsdfWarning, match=r"Exception: NOPE"):
mappings = entry_points.get_resource_mappings()
assert len(mappings) == 0
mock_entry_points.clear()
mock_entry_points.append(
(
"asdf.resource_mappings",
"bad_element",
"asdf.tests.test_entry_points:resource_mappings_entry_point_bad_element",
)
)
with pytest.warns(AsdfWarning, match=r"TypeError: Resource mapping must implement the Mapping interface"):
mappings = entry_points.get_resource_mappings()
assert len(mappings) == 2
class MinimumExtension:
def __init__(self, extension_uri):
self._extension_uri = extension_uri
@property
def extension_uri(self):
return self._extension_uri
def extensions_entry_point_successful():
return [
MinimumExtension("http://somewhere.org/extensions/foo-1.0"),
MinimumExtension("http://somewhere.org/extensions/bar-1.0"),
]
def extensions_entry_point_failing():
raise Exception("NOPE")
def extensions_entry_point_bad_element():
return [
MinimumExtension("http://somewhere.org/extensions/baz-1.0"),
object(),
MinimumExtension("http://somewhere.org/extensions/foz-1.0"),
]
class LegacyExtension:
types = []
tag_mapping = []
url_mapping = []
class FauxLegacyExtension:
pass
def test_get_extensions(mock_entry_points):
mock_entry_points.append(
("asdf.extensions", "successful", "asdf.tests.test_entry_points:extensions_entry_point_successful")
)
extensions = entry_points.get_extensions()
assert len(extensions) == 2
for e in extensions:
assert isinstance(e, ExtensionProxy)
assert e.package_name == "asdf"
assert e.package_version == asdf_package_version
mock_entry_points.clear()
mock_entry_points.append(
("asdf.extensions", "failing", "asdf.tests.test_entry_points:extensions_entry_point_failing")
)
with pytest.warns(AsdfWarning, match=r"Exception: NOPE"):
extensions = entry_points.get_extensions()
assert len(extensions) == 0
mock_entry_points.clear()
mock_entry_points.append(
("asdf.extensions", "bad_element", "asdf.tests.test_entry_points:extensions_entry_point_bad_element")
)
with pytest.warns(
AsdfWarning, match=r"TypeError: Extension must implement the Extension or AsdfExtension interface"
):
extensions = entry_points.get_extensions()
assert len(extensions) == 2
mock_entry_points.clear()
mock_entry_points.append(("asdf_extensions", "legacy", "asdf.tests.test_entry_points:LegacyExtension"))
extensions = entry_points.get_extensions()
assert len(extensions) == 1
for e in extensions:
assert isinstance(e, ExtensionProxy)
assert e.package_name == "asdf"
assert e.package_version == asdf_package_version
assert e.legacy is True
mock_entry_points.clear()
mock_entry_points.append(("asdf_extensions", "failing", "asdf.tests.test_entry_points:FauxLegacyExtension"))
with pytest.warns(AsdfWarning, match=r"TypeError"):
extensions = entry_points.get_extensions()
assert len(extensions) == 0
|