Add entry points for supported inventory sources

[jessicamack]

A related change for ansible/awx#15658

[codecov]

❌ 2 Tests Failed:

Tests completed	Failed	Passed	Skipped
57	2	55	0

View the top 2 failed tests by shortest run time

tests/importable_test.py::::test_entry_points_are_inventory_plugin[azure-rm=awx_plugins.inventory.plugins:azure_rm@awx_plugins.inventory]

Stack Traces | 0.002s run time

self = [EntryPoint(name='azure_rm', value='awx_plugins.inventory.plugins:azure_rm', group='awx_plugins.inventory'), EntryPoin...ns.inventory'), EntryPoint(name='vmware', value='awx_plugins.inventory.plugins:vmware', group='awx_plugins.inventory')]
name = 'azure-rm'

    def __getitem__(self, name):  # -> EntryPoint:
        """
        Get the EntryPoint in self matching name.
        """
        if isinstance(name, int):
            warnings.warn(
                "Accessing entry points by index is deprecated. "
                "Cast to tuple if needed.",
                DeprecationWarning,
                stacklevel=2,
            )
            return super().__getitem__(name)
        try:
>           return next(iter(self.select(name=name)))
#x1B[1m#x1B[31mE           StopIteration#x1B[0m

__class__  = <class 'importlib.metadata.EntryPoints'>
name       = 'azure-rm'
self       = [EntryPoint(name='azure_rm', value='awx_plugins.inventory.plugins:azure_rm', group='awx_plugins.inventory'), EntryPoin...ns.inventory'), EntryPoint(name='vmware', value='awx_plugins.inventory.plugins:vmware', group='awx_plugins.inventory')]

#x1B[1m#x1B[.../Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11....../importlib/metadata/__init__.py#x1B[0m:371: StopIteration

#x1B[33mDuring handling of the above exception, another exception occurred:#x1B[0m

entry_point = EntryPointParam(group='awx_plugins.inventory', name='azure-rm', spec='awx_plugins.inventory.plugins:azure_rm')

    @with_inventory_plugins
    def test_entry_points_are_inventory_plugin(
            entry_point: EntryPointParam,
    ) -> None:
        """Ensure all exposed inventory plugins are of the same class."""  # noqa: D200, DAR101; FIXME
        entry_points = _discover_entry_points(group=entry_point.group)
>       loaded_plugin_class = entry_points[entry_point.name].load()

entry_point = EntryPointParam(group='awx_plugins.inventory', name='azure-rm', spec='awx_plugins.inventory.plugins:azure_rm')
entry_points = [EntryPoint(name='azure_rm', value='awx_plugins.inventory.plugins:azure_rm', group='awx_plugins.inventory'), EntryPoin...ns.inventory'), EntryPoint(name='vmware', value='awx_plugins.inventory.plugins:vmware', group='awx_plugins.inventory')]

#x1B[1m#x1B[31mtests/importable_test.py#x1B[0m:192: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

self = [EntryPoint(name='azure_rm', value='awx_plugins.inventory.plugins:azure_rm', group='awx_plugins.inventory'), EntryPoin...ns.inventory'), EntryPoint(name='vmware', value='awx_plugins.inventory.plugins:vmware', group='awx_plugins.inventory')]
name = 'azure-rm'

    def __getitem__(self, name):  # -> EntryPoint:
        """
        Get the EntryPoint in self matching name.
        """
        if isinstance(name, int):
            warnings.warn(
                "Accessing entry points by index is deprecated. "
                "Cast to tuple if needed.",
                DeprecationWarning,
                stacklevel=2,
            )
            return super().__getitem__(name)
        try:
            return next(iter(self.select(name=name)))
        except StopIteration:
>           raise KeyError(name)
#x1B[1m#x1B[31mE           KeyError: 'azure-rm'#x1B[0m

__class__  = <class 'importlib.metadata.EntryPoints'>
name       = 'azure-rm'
self       = [EntryPoint(name='azure_rm', value='awx_plugins.inventory.plugins:azure_rm', group='awx_plugins.inventory'), EntryPoin...ns.inventory'), EntryPoint(name='vmware', value='awx_plugins.inventory.plugins:vmware', group='awx_plugins.inventory')]

#x1B[1m#x1B[.../Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11....../importlib/metadata/__init__.py#x1B[0m:373: KeyError

tests/importable_test.py::::test_entry_points_exposed[azure-rm=awx_plugins.inventory.plugins:azure_rm@awx_plugins.inventory]

Stack Traces | 0.002s run time

entry_point = EntryPointParam(group='awx_plugins.inventory', name='azure-rm', spec='awx_plugins.inventory.plugins:azure_rm')

    @with_all_plugins
    def test_entry_points_exposed(entry_point: EntryPointParam) -> None:
        """Verify the plugin entry points are discoverable.
    
        This check relies on the plugin-declaring distribution package to be
        pre-installed.
        """  # noqa: DAR101; FIXME
        entry_points = _discover_entry_points(group=entry_point.group)
    
>       assert entry_point.name in entry_points.names
#x1B[1m#x1B[31mE       AssertionError: assert 'azure-rm' in {'azure_rm', 'constructed', 'controller', 'ec2', 'gce', 'insights', ...}#x1B[0m
#x1B[1m#x1B[31mE        +  where 'azure-rm' = EntryPointParam(group='awx_plugins.inventory', name='azure-rm', spec='awx_plugins.inventory.plugins:azure_rm').name#x1B[0m
#x1B[1m#x1B[31mE        +  and   {'azure_rm', 'constructed', 'controller', 'ec2', 'gce', 'insights', ...} = [EntryPoint(name='azure_rm', value='awx_plugins.inventory.plugins:azure_rm', group='awx_plugins.inventory'), EntryPoin...ns.inventory'), EntryPoint(name='vmware', value='awx_plugins.inventory.plugins:vmware', group='awx_plugins.inventory')].names#x1B[0m

entry_point = EntryPointParam(group='awx_plugins.inventory', name='azure-rm', spec='awx_plugins.inventory.plugins:azure_rm')
entry_points = [EntryPoint(name='azure_rm', value='awx_plugins.inventory.plugins:azure_rm', group='awx_plugins.inventory'), EntryPoin...ns.inventory'), EntryPoint(name='vmware', value='awx_plugins.inventory.plugins:vmware', group='awx_plugins.inventory')]

#x1B[1m#x1B[31mtests/importable_test.py#x1B[0m:170: AssertionError

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

[webknjaz]

The tests must be adjusted for this, so they don't fail.

[jessicamack]

Which tests? When I point the requirements for awx at this branch on my repo the related tests pass. I'll run them again to confirm.

[webknjaz]

Ones failing in CI — smoke: https://github.com/ansible/awx-plugins/blob/8e8d03b/tests/importable_test.py#L76 / https://github.com/ansible/awx-plugins/actions/runs/12121157958/job/33791551145?pr=61#step:17:51

[webknjaz]

These should probably be mentioned in the tests too.