role arg spec - allow file extensions in tasks_from

[samdoran]

SUMMARY

Lookup the spec using the basename of the last part of the path or file specified in tasks_from. Since tasks_form accepts a file or path both with and without an extension, the argument spec lookup should as well.

Fixes #75456

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

lib/ansible/playbook/role/__init__.py

To do:

• Add tests

[samdoran]

I created a stem() function. This may make it unable to backport, but I can use the previous solution in the backport if we don't want to backport the new function.

[sivel]

I do question whether we should have a list of candidates to try. We might just say this isn't supported, but here it is.

Consider the following tree:

.
└── roles
    └── foo
        └── tasks
            ├── install.yml
            └── ubuntu
                └── install.yml

What about calculating the relative path based on role_path? And looping from most specific to least specific?

That way if someone provided tasks_from: ubuntu/install.yml it could have a different entry point than tasks_from: install.yml?

Just a thought, based on the current solution being naive about paths. Although this PR is an improvement from one view, it actually takes away the potential features.

Again, maybe this is just something we document as not being possible.

[bcoca]

@sivel, iirc, tasks_from does not allow subdirs

[sivel]

It works fine with subdirs, I tested it before I posted my last comment.

[samdoran]

That way if someone provided tasks_from: ubuntu/install.yml it could have a different entry point than tasks_from: install.yml?

In general, I do like this idea. The current behavior can be a bit surprising since it's pretty flexible/naive with its path searching.

One concern I have is how we would then match the role arg spec to the correct entry point if the stem is the same but the relative path is different. It seems like that would complicate the arg spec names and matching quite a bit.

Naming the spec install becomes ambiguous (though it already is). Would it need to be named based on the relative path inside tasks/? Something like install and ubunutu_install?

[sivel]

Naming the spec install becomes ambiguous (though it already is). Would it need to be named based on the relative path inside tasks/? Something like install and ubunutu_install?

I was thinking literally install and ubuntu/install to basically align with the functionality already achievable prior to this PR.

[bcoca]

per discussion, you might want to look at is_subpath (ansible.utils.path) and also put this in common/file.py or create a common/path.py?

[samdoran]

I have been looking into this more and found that subdirs for tasks_from work with include_role but not import_role. I need to track down and reconcile that behavior.

 0.1s _load_role_data: self._from_files.get('tasks')='ubuntu/install'  # include_tasks

 0.1s _load_role_data: self._from_files.get('tasks')='install'         # import_tasks

The more I think about it, I do like the flexibility of having specs match the tasks_from hierarchy. I'm a bit leery of how tricky it will be to implement that since the task loading/finding code is separate from the spec finding code/logic.

[Veratil]

I have been looking into this more and found that subdirs for tasks_from work with include_role but not import_role. I need to track down and reconcile that behavior.

 0.1s _load_role_data: self._from_files.get('tasks')='ubuntu/install'  # include_tasks

 0.1s _load_role_data: self._from_files.get('tasks')='install'         # import_tasks

The more I think about it, I do like the flexibility of having specs match the tasks_from hierarchy. I'm a bit leery of how tricky it will be to implement that since the task loading/finding code is separate from the spec finding code/logic.

https://github.com/ansible/ansible/blob/devel/lib/ansible/playbook/role_include.py#L154

Remove basename here. I wrote some tests and tested on devel and your branch, all passed. Validation is still run on the path and will fail when it's out of the role folder.