Add descriptive error message to Linode inventory plugin file checkin…

[GideonStowell]

SUMMARY

#6279 Raised issue with the linode inventory plugin validation function not providing a useful error message when it fails. Other inventory plugins do have useful error message on failure. This PR aligns the linode inventory plugin with other plugins.

Fixes #6279

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

community.general.plugins.inventory.linode

ADDITIONAL INFORMATION

Before:

$ ansible-inventory -i foo.yml --list -vvv
ansible-inventory [core 2.16.4]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/gideons/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/gideons/.local/lib/python3.10/site-packages/ansible
  ansible collection location = /home/gideons/.ansible/collections:/usr/share/ansible/collections
  executable location = /home/gideons/.local/bin/ansible-inventory
  python version = 3.10.12 (main, Nov 20 2023, 15:14:05) [GCC 11.4.0] (/usr/bin/python3)
  jinja version = 3.0.3
  libyaml = True
Using /etc/ansible/ansible.cfg as config file
host_list declined parsing /home/gideons/foo.yml as it did not pass its verify_file() method
script declined parsing /home/gideons/foo.yml as it did not pass its verify_file() method
redirecting (type: inventory) ansible.builtin.linode to community.general.linode
toml declined parsing /home/gideons/foo.yml as it did not pass its verify_file() method
[WARNING]:  * Failed to parse /home/gideons/foo.yml with auto plugin: inventory source
'/home/gideons/foo.yml' could not be verified by inventory plugin 'linode'
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/inventory/manager.py", line 293, in parse_source
    plugin.parse(self._inventory, self._loader, source, cache=cache)
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/plugins/inventory/auto.py", line 56, in parse
    raise AnsibleParserError("inventory source '{0}' could not be verified by inventory plugin '{1}'".format(path, plugin_name))
[WARNING]:  * Failed to parse /home/gideons/foo.yml with yaml plugin: Plugin configuration YAML file,
not YAML inventory
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/inventory/manager.py", line 293, in parse_source
    plugin.parse(self._inventory, self._loader, source, cache=cache)
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/plugins/inventory/yaml.py", line 114, in parse
    raise AnsibleParserError('Plugin configuration YAML file, not YAML inventory')
[WARNING]:  * Failed to parse /home/gideons/foo.yml with ini plugin: Invalid host pattern 'plugin:'
supplied, ending in ':' is not allowed, this character is reserved to provide a port.
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/inventory/manager.py", line 293, in parse_source
    plugin.parse(self._inventory, self._loader, source, cache=cache)
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/plugins/inventory/ini.py", line 138, in parse
    raise AnsibleParserError(e)
[WARNING]: Unable to parse /home/gideons/foo.yml as an inventory source
[WARNING]: No inventory was parsed, only implicit localhost is available
{
    "_meta": {
        "hostvars": {}
    },
    "all": {
        "children": [
            "ungrouped"
        ]
    }
}

After:

$ ANSIBLE_INVENTORY_PLUGINS=~/ansible-collections.community.general/ansible_collections/community/general/plugins/inventory ansible-inventory -i foo.yml --list -vvv
ansible-inventory [core 2.16.4]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/gideons/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/gideons/.local/lib/python3.10/site-packages/ansible
  ansible collection location = /home/gideons/.ansible/collections:/usr/share/ansible/collections
  executable location = /home/gideons/.local/bin/ansible-inventory
  python version = 3.10.12 (main, Nov 20 2023, 15:14:05) [GCC 11.4.0] (/usr/bin/python3)
  jinja version = 3.0.3
  libyaml = True
Using /etc/ansible/ansible.cfg as config file
host_list declined parsing /home/gideons/foo.yml as it did not pass its verify_file() method
script declined parsing /home/gideons/foo.yml as it did not pass its verify_file() method
Inventory source not ending in "linode.yaml" or "linode.yml"
toml declined parsing /home/gideons/foo.yml as it did not pass its verify_file() method
[WARNING]:  * Failed to parse /home/gideons/foo.yml with auto plugin: inventory source
'/home/gideons/foo.yml' could not be verified by inventory plugin 'linode'
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/inventory/manager.py", line 293, in parse_source
    plugin.parse(self._inventory, self._loader, source, cache=cache)
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/plugins/inventory/auto.py", line 56, in parse
    raise AnsibleParserError("inventory source '{0}' could not be verified by inventory plugin '{1}'".format(path, plugin_name))
[WARNING]:  * Failed to parse /home/gideons/foo.yml with yaml plugin: Plugin configuration YAML file,
not YAML inventory
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/inventory/manager.py", line 293, in parse_source
    plugin.parse(self._inventory, self._loader, source, cache=cache)
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/plugins/inventory/yaml.py", line 114, in parse
    raise AnsibleParserError('Plugin configuration YAML file, not YAML inventory')
[WARNING]:  * Failed to parse /home/gideons/foo.yml with ini plugin: Invalid host pattern 'plugin:'
supplied, ending in ':' is not allowed, this character is reserved to provide a port.
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/inventory/manager.py", line 293, in parse_source
    plugin.parse(self._inventory, self._loader, source, cache=cache)
  File "/home/gideons/.local/lib/python3.10/site-packages/ansible/plugins/inventory/ini.py", line 138, in parse
    raise AnsibleParserError(e)
[WARNING]: Unable to parse /home/gideons/foo.yml as an inventory source
[WARNING]: No inventory was parsed, only implicit localhost is available
{
    "_meta": {
        "hostvars": {}
    },
    "all": {
        "children": [
            "ungrouped"
        ]
    }
}

[ansibullbot]

cc @Charliekenney23 @InTheCloudDan @LBGarber @decentral1se @displague @rmcintosh
click here for bot help

[displague]

shipit

[patchback]

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/b389f8637f3bcc4f794c708379c9e65ff4f26f6f/pr-8133

Backported as #8143

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

[patchback]

Backport to stable-8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-8/b389f8637f3bcc4f794c708379c9e65ff4f26f6f/pr-8133

Backported as #8144

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

[felixfontein]

@GideonStowell thanks for your contribution!
@displague thanks for reviewing!