Fix relative imports in args rule (#4216)

corubba · ssbarnea · web-flow · commit 47b10b2b39af · 2024-06-19T21:50:38.000+01:00
Co-authored-by: Sorin Sbarnea &lt;ssbarnea@redhat.com&gt;
diff --git a/.config/dictionary.txt b/.config/dictionary.txt
@@ -366,6 +366,7 @@ taskincludes
 taskshandlers
 templatevars
 templating
+testcollection
 testinfra
 testmon
 testns
diff --git a/.github/workflows/tox.yml b/.github/workflows/tox.yml
@@ -72,7 +72,7 @@ jobs:
     env:
       # Number of expected test passes, safety measure for accidental skip of
       # tests. Update value if you add/remove tests.
-      PYTEST_REQPASS: 883
+      PYTEST_REQPASS: 884
     steps:
       - uses: actions/checkout@v4
         with:
diff --git a/.gitignore b/.gitignore
@@ -72,8 +72,10 @@ src/ansiblelint/_version.py
 test/eco/CODENOTIFY.html
 test/eco
 test/schemas/node_modules
+test/local-content
 .envrc
-collections
+# collections
+# !/collections
 site
 _readthedocs
 *.tmp.*
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -173,6 +173,7 @@ repos:
           - wcmatch
         exclude: >
           (?x)^(
+            collections/.*|
             test/local-content/.*|
             plugins/.*
           )$
diff --git a/ansible.cfg b/ansible.cfg
@@ -1,2 +1,2 @@
 [defaults]
-collections_path = examples/playbooks/collections
+collections_path = collections:examples/playbooks/collections
diff --git a/collections/ansible_collections/local/testcollection/README.md b/collections/ansible_collections/local/testcollection/README.md
@@ -0,0 +1,3 @@
+# Ansible Collection - local.testcollection
+
+Documentation for the collection.
diff --git a/collections/ansible_collections/local/testcollection/galaxy.yml b/collections/ansible_collections/local/testcollection/galaxy.yml
@@ -0,0 +1,7 @@
+---
+namespace: local
+name: testcollection
+version: 1.0.0
+readme: README.md
+authors:
+  - your name <example@domain.com>
diff --git a/collections/ansible_collections/local/testcollection/plugins/module_utils/__init__.py b/collections/ansible_collections/local/testcollection/plugins/module_utils/__init__.py
@@ -0,0 +1,4 @@
+"""module_utils package."""
+
+# Some value that can be imported from a module
+MY_STRING: str = "foo"
diff --git a/collections/ansible_collections/local/testcollection/plugins/module_utils/py.typed b/collections/ansible_collections/local/testcollection/plugins/module_utils/py.typed
diff --git a/collections/ansible_collections/local/testcollection/plugins/modules/__init__.py b/collections/ansible_collections/local/testcollection/plugins/modules/__init__.py
@@ -0,0 +1 @@
+"""modules package."""
diff --git a/collections/ansible_collections/local/testcollection/plugins/modules/module_with_relative_import.py b/collections/ansible_collections/local/testcollection/plugins/modules/module_with_relative_import.py
@@ -0,0 +1,25 @@
+"""module_with_relative_import module."""
+
+from ansible.module_utils.basic import AnsibleModule
+
+# pylint: disable=E0402
+from ..module_utils import MY_STRING  # noqa: TID252 # type: ignore[import-untyped]
+
+DOCUMENTATION = r"""
+options:
+  name:
+    required: True
+"""
+
+
+def main() -> AnsibleModule:
+    """The main function."""
+    return AnsibleModule(
+        argument_spec={
+            "name": {"required": True, "aliases": [MY_STRING]},
+        },
+    )
+
+
+if __name__ == "__main__":
+    main()
diff --git a/examples/playbooks/module_relative_import.yml b/examples/playbooks/module_relative_import.yml
@@ -0,0 +1,6 @@
+---
+- name: Module relative import
+  hosts: localhost
+  tasks:
+    - name: Module with relative import
+      local.testcollection.module_with_relative_import: {}
diff --git a/src/ansiblelint/rules/args.py b/src/ansiblelint/rules/args.py
@@ -144,7 +144,7 @@ def matchtask(
             CustomAnsibleModule,
         ):
             spec = importlib.util.spec_from_file_location(
-                name=loaded_module.resolved_fqcn,
+                name=loaded_module.plugin_resolved_name,
                 location=loaded_module.plugin_resolved_path,
             )
             if not spec:
diff --git a/test/rules/test_args.py b/test/rules/test_args.py
@@ -0,0 +1,19 @@
+"""Tests for args rule."""
+
+from ansiblelint.file_utils import Lintable
+from ansiblelint.rules import RulesCollection
+from ansiblelint.runner import Runner
+
+
+def test_args_module_relative_import(default_rules_collection: RulesCollection) -> None:
+    """Validate args check of a module with a relative import."""
+    lintable = Lintable(
+        "examples/playbooks/module_relative_import.yml",
+        kind="playbook",
+    )
+    result = Runner(lintable, rules=default_rules_collection).run()
+    assert len(result) == 1, result
+    assert result[0].lineno == 5
+    assert result[0].filename == "examples/playbooks/module_relative_import.yml"
+    assert result[0].tag == "args[module]"
+    assert result[0].message == "missing required arguments: name"

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`[defaults]`
`2`		`-collections_path = examples/playbooks/collections`
	`2`	`+collections_path = collections:examples/playbooks/collections`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Ansible Collection - local.testcollection`
	`2`	`+`
	`3`	`+Documentation for the collection.`