Initial import_playbook support #268
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ansible_bender/core.py
Outdated
| @@ -173,6 +174,29 @@ def _get_path_our_site(self): | |||
| # hence, let's add the site ab is installed in to sys.path | |||
| return os.path.dirname(os.path.dirname(ansible_bender.__file__)) | |||
|
|
|||
| def _correct_host_entries(self, playbook_path, tmpDir): | |||
| """ Correct the host entries in the playbook and all imported playbooks """ | |||
| tmp_pb_path = os.path.join(tmpDir, str(uuid.uuid4()) + ".yaml") | |||
There was a problem hiding this comment.
love using the uuid here! could we please prefix the uuid string with e.g. ab_ so that people know the file is coming from ansible-bender?
ansible_bender/core.py
Outdated
Comment on lines
187
to
189
| import_base_path = os.path.dirname(playbook_path) | ||
| imported_playbook_path = os.path.join(import_base_path, imported_playbook) | ||
| doc["import_playbook"] = self._correct_host_entries(imported_playbook_path, tmpDir) |
There was a problem hiding this comment.
would some logger.debug make sense here as well? especially when it's called recursively
There was a problem hiding this comment.
Made a simple one in 2abc606 🙂 Does it look okay?
|
merging, thank you so much for taking time to improve bender! I'll try to fix some of the test runs in a separate PR so we can get green CI |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Basics
Ignores adjusting hosts for import_playbooks statements, as those should not have a host entry. Instead we have to read the imported playbook and correct the possible hosts entries there (this goes on recursively by need, so can support a very big import_playbook-depth). The hosts-corrected imported playbook path/name will need to be used in place of the old one in the playbook that imports it. I decided on a uuid based filename for the temp files, because of the low likelihood of "name-crashes". Currently the temp-file was named p.yaml, and if we have several ones that would off course not work. This PR implements those fixes.
tl;dr: fixes #109
About the testing
I initially planned to do everything in tests_core.py, but after some thinking decided to create e2e'ish test in tests_api.py instead. This is because the tests in core would have needed either a lot of setup (duplication of api.py-code maybe), or mocking (in which I think it wouldn't be as useful). Hopefully this is not an issue, as I think the tests I made still verifies the functionality in an ok way.
The tests tests the example from #109, as well as a recursive one (import_playbook inside an imported playbook). The last one might be overkills. I have also tested manually, and it seems to work as expected in the tests I've done so far 🙂