Enable FQCNs for import_playbook to have subdirs (#4362)

The max repetitions of 100 for the RE_IS_FQCN_OR_NAME regular expression
was not chosen for any particular reason other than being a sane number
with more than enough overhead to account for a long fully qualified
collection name (FQCN).

Author: cavcrosby

collections/ansible_collections/local/testcollection/playbooks/test/bar/foo.yml

@@ -0,0 +1,9 @@
+---
+- name: Fixture
+  hosts: localhost
+  connection: local
+  gather_facts: false
+  tasks:
+    - name: Another task
+      ansible.builtin.debug:
+        msg: debug message

examples/playbooks/import_playbook_fqcn.yml

@@ -1,3 +1,6 @@
 ---
 - name: Import a playbook
   ansible.builtin.import_playbook: local.testcollection.foo
+
+- name: Import a playbook that is in a subdirectory
+  ansible.builtin.import_playbook: local.testcollection.test.bar.foo

src/ansiblelint/text.py

@@ -7,7 +7,7 @@
 
 RE_HAS_JINJA = re.compile(r"{[{%#].*[%#}]}", re.DOTALL)
 RE_HAS_GLOB = re.compile("[][*?]")
-RE_IS_FQCN_OR_NAME = re.compile(r"^\w+(\.\w+\.\w+)?$")
+RE_IS_FQCN_OR_NAME = re.compile(r"^\w+(\.\w+){2,100}$|^\w+$")
 
 
 def strip_ansi_escape(data: str | bytes) -> str:

src/ansiblelint/utils.py

@@ -450,7 +450,7 @@ def import_playbook_children(
     ) -> list[Lintable]:
         """Include import_playbook children."""
 
-        def append_playbook_path(loc: str, playbook_name: str) -> None:
+        def append_playbook_path(loc: str, playbook_path: list[str]) -> None:
             possible_paths.append(
                 Path(
                     path_dwim(
@@ -460,7 +460,7 @@ def append_playbook_path(loc: str, playbook_name: str) -> None:
                             namespace_name,
                             collection_name,
                             "playbooks",
-                            playbook_name,
+                            *playbook_path,
                         ),
                     ),
                 ),
@@ -471,11 +471,17 @@ def append_playbook_path(loc: str, playbook_name: str) -> None:
             return []
 
         possible_paths = []
-        namespace_name, collection_name, playbook_name = parse_fqcn(v)
+        namespace_name, collection_name, *playbook_path = parse_fqcn(v)
         if namespace_name and collection_name:
             for loc in get_app(cached=True).runtime.config.collections_paths:
-                append_playbook_path(loc, f"{playbook_name}.yml")
-                append_playbook_path(loc, f"{playbook_name}.yaml")
+                append_playbook_path(
+                    loc,
+                    playbook_path[:-1] + [f"{playbook_path[-1]}.yml"],
+                )
+                append_playbook_path(
+                    loc,
+                    playbook_path[:-1] + [f"{playbook_path[-1]}.yaml"],
+                )
         else:
             possible_paths.append(lintable.path.parent / v)
 

test/test_utils.py

@@ -520,3 +520,18 @@ def test_import_playbook_children() -> None:
         "Failed to load local.testcollection.foo playbook due to failing syntax check."
         not in result.stderr
     )
+
+
+def test_import_playbook_children_subdirs() -> None:
+    """Verify import_playbook_children() when playbook is in a subdirectory."""
+    result = run_ansible_lint(
+        Path("playbooks/import_playbook_fqcn.yml"),
+        cwd=Path(__file__).resolve().parent.parent / "examples",
+        env={
+            "ANSIBLE_COLLECTIONS_PATH": "../collections",
+        },
+    )
+    assert (
+        "Failed to find local.testcollection.test.bar.foo playbook."
+        not in result.stderr
+    )

tox.ini

@@ -76,7 +76,7 @@ setenv =
   PRE_COMMIT_COLOR = always
   # Number of expected test passes, safety measure for accidental skip of
   # tests. Update value if you add/remove tests. (tox-extra)
-  PYTEST_REQPASS = 895
+  PYTEST_REQPASS = 896
   FORCE_COLOR = 1
   pre: PIP_PRE = 1
 allowlist_externals =