From 30f740110b7a1a7670576f4028b78007e5ff0794 Mon Sep 17 00:00:00 2001 From: s-hertel <19572925+s-hertel@users.noreply.github.com> Date: Tue, 19 Nov 2024 13:31:36 -0500 Subject: [PATCH] ci_complete --- lib/ansible/playbook/included_file.py | 78 ++++--------------- .../targets/includes/playbook_relative.yml | 0 .../tasks/calling_role_relative.yml | 0 .../test_calling_role_relative/tasks/main.yml | 4 + .../test_relative_includes/tasks/main.yml | 3 + .../tasks/subdir/main.yml | 18 +++++ .../tasks/subdir/task_relative.yml | 0 .../includes/test_include_relative.yml | 4 + .../targets/includes/test_includes.yml | 2 + 9 files changed, 44 insertions(+), 65 deletions(-) create mode 100644 test/integration/targets/includes/playbook_relative.yml create mode 100644 test/integration/targets/includes/roles/test_calling_role_relative/tasks/calling_role_relative.yml create mode 100644 test/integration/targets/includes/roles/test_calling_role_relative/tasks/main.yml create mode 100644 test/integration/targets/includes/roles/test_relative_includes/tasks/main.yml create mode 100644 test/integration/targets/includes/roles/test_relative_includes/tasks/subdir/main.yml create mode 100644 test/integration/targets/includes/roles/test_relative_includes/tasks/subdir/task_relative.yml create mode 100644 test/integration/targets/includes/test_include_relative.yml diff --git a/lib/ansible/playbook/included_file.py b/lib/ansible/playbook/included_file.py index d2fdb76364d..3e937cc8ce5 100644 --- a/lib/ansible/playbook/included_file.py +++ b/lib/ansible/playbook/included_file.py @@ -20,12 +20,8 @@ from __future__ import annotations import os from ansible import constants as C -from ansible.errors import AnsibleError from ansible.executor.task_executor import remove_omit -from ansible.module_utils.common.text.converters import to_text from ansible.playbook.handler import Handler -from ansible.playbook.task_include import TaskInclude -from ansible.playbook.role_include import IncludeRole from ansible.template import Templar from ansible.utils.display import Display @@ -118,68 +114,20 @@ class IncludedFile: if original_task.action in C._ACTION_INCLUDE_TASKS: include_file = None + dirname = 'handlers' if isinstance(original_task, Handler) else 'tasks' + include_target = templar.template(include_result['include']) + candidates = [loader.path_dwim_relative(_path, dirname, include_target, is_role=True) for _path in task_vars['ansible_search_path']] + for include_file in candidates: + try: + # may throw OSError + os.stat(include_file) + # or select the task file if it exists + break + except OSError: + pass + else: + include_file = loader.path_dwim(include_target) - if original_task._parent: - # handle relative includes by walking up the list of parent include - # tasks and checking the relative result to see if it exists - parent_include = original_task._parent - cumulative_path = None - while parent_include is not None: - if not isinstance(parent_include, TaskInclude): - parent_include = parent_include._parent - continue - if isinstance(parent_include, IncludeRole): - parent_include_dir = parent_include._role_path - else: - try: - parent_include_dir = os.path.dirname(templar.template(parent_include.args.get('_raw_params'))) - except AnsibleError as e: - parent_include_dir = '' - display.warning( - 'Templating the path of the parent %s failed. The path to the ' - 'included file may not be found. ' - 'The error was: %s.' % (original_task.action, to_text(e)) - ) - if cumulative_path is not None and not os.path.isabs(cumulative_path): - cumulative_path = os.path.join(parent_include_dir, cumulative_path) - else: - cumulative_path = parent_include_dir - include_target = templar.template(include_result['include']) - if original_task._role: - dirname = 'handlers' if isinstance(original_task, Handler) else 'tasks' - new_basedir = os.path.join(original_task._role._role_path, dirname, cumulative_path) - candidates = [ - loader.path_dwim_relative(original_task._role._role_path, dirname, include_target, is_role=True), - loader.path_dwim_relative(new_basedir, dirname, include_target, is_role=True) - ] - for include_file in candidates: - try: - # may throw OSError - os.stat(include_file) - # or select the task file if it exists - break - except OSError: - pass - else: - include_file = loader.path_dwim_relative(loader.get_basedir(), cumulative_path, include_target) - - if os.path.exists(include_file): - break - else: - parent_include = parent_include._parent - - if include_file is None: - if original_task._role: - include_target = templar.template(include_result['include']) - include_file = loader.path_dwim_relative( - original_task._role._role_path, - 'handlers' if isinstance(original_task, Handler) else 'tasks', - include_target, - is_role=True) - else: - include_file = loader.path_dwim(include_result['include']) - - include_file = templar.template(include_file) inc_file = IncludedFile(include_file, include_args, special_vars, original_task) else: # template the included role's name here diff --git a/test/integration/targets/includes/playbook_relative.yml b/test/integration/targets/includes/playbook_relative.yml new file mode 100644 index 00000000000..e69de29bb2d diff --git a/test/integration/targets/includes/roles/test_calling_role_relative/tasks/calling_role_relative.yml b/test/integration/targets/includes/roles/test_calling_role_relative/tasks/calling_role_relative.yml new file mode 100644 index 00000000000..e69de29bb2d diff --git a/test/integration/targets/includes/roles/test_calling_role_relative/tasks/main.yml b/test/integration/targets/includes/roles/test_calling_role_relative/tasks/main.yml new file mode 100644 index 00000000000..aeeaa0e1f3e --- /dev/null +++ b/test/integration/targets/includes/roles/test_calling_role_relative/tasks/main.yml @@ -0,0 +1,4 @@ +- name: Include role with tasks_from + include_role: + name: test_relative_includes + tasks_from: subdir/main.yml diff --git a/test/integration/targets/includes/roles/test_relative_includes/tasks/main.yml b/test/integration/targets/includes/roles/test_relative_includes/tasks/main.yml new file mode 100644 index 00000000000..20ed5b8b5ce --- /dev/null +++ b/test/integration/targets/includes/roles/test_relative_includes/tasks/main.yml @@ -0,0 +1,3 @@ +- name: Set variable to indicate the resolved include + set_fact: + role_relative: true diff --git a/test/integration/targets/includes/roles/test_relative_includes/tasks/subdir/main.yml b/test/integration/targets/includes/roles/test_relative_includes/tasks/subdir/main.yml new file mode 100644 index 00000000000..00747c5e8c1 --- /dev/null +++ b/test/integration/targets/includes/roles/test_relative_includes/tasks/subdir/main.yml @@ -0,0 +1,18 @@ +- name: Include role relative file tasks/main.yml + include_tasks: + file: main.yml + +- assert: + that: role_relative is defined + +- name: Include a relative file from a calling role + include_tasks: + file: calling_role_relative.yml + +- name: Include a task relative file + include_tasks: + file: task_relative.yml + +- name: Include a task relative to the playbook + include_tasks: + file: playbook_relative.yml diff --git a/test/integration/targets/includes/roles/test_relative_includes/tasks/subdir/task_relative.yml b/test/integration/targets/includes/roles/test_relative_includes/tasks/subdir/task_relative.yml new file mode 100644 index 00000000000..e69de29bb2d diff --git a/test/integration/targets/includes/test_include_relative.yml b/test/integration/targets/includes/test_include_relative.yml new file mode 100644 index 00000000000..5beab56198e --- /dev/null +++ b/test/integration/targets/includes/test_include_relative.yml @@ -0,0 +1,4 @@ +- hosts: all + gather_facts: no + roles: + - test_calling_role_relative diff --git a/test/integration/targets/includes/test_includes.yml b/test/integration/targets/includes/test_includes.yml index 80b009c94f9..f8716c30d37 100644 --- a/test/integration/targets/includes/test_includes.yml +++ b/test/integration/targets/includes/test_includes.yml @@ -8,3 +8,5 @@ - import_playbook: test_include_free.yml - import_playbook: test_include_host_pinned.yml + +- import_playbook: test_include_relative.yml