binary_file lookup: automatically unvault vaulted files (closes #10799) #10806
Conversation
This file contains hidden or 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
…collections#10799) this matches the behavior of the builtin file lookup
ansibullbot
added
bug
felixfontein
reviewed
Sep 9, 2025
| result.append(base64.b64encode(f.read()).decode("utf-8")) | ||
| except Exception as exc: | ||
| raise AnsibleLookupError(f"Error while reading {path}: {exc}") | ||
| result.append(base64.b64encode(self._loader._get_file_contents(path)[0]).decode("utf-8")) |
There was a problem hiding this comment.
From what I gathered on Matrix, it doesn't look like there's a public API for this. The only API there is decrypts the file to another file on disk, which is something we really want to avoid.
Also DataLoader._get_file_contents() doesn't set the SourceWasEncrypted tag (and the functionality to set it is definitely private), so I guess there's no way to properly achieve this right now.
There was a problem hiding this comment.
I created ansible/ansible#85852 for this.
felixfontein
added
check-before-release
1 task
russoz
changed the title
russoz
changed the title
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.
this matches the behavior of the builtin file lookup
SUMMARY
The
binary_fileplugin now automatically unvaults vaulted files, matching the behavior of the built-infileplugin. I realize thatDataLoader._get_file_contentsis technically not public due to the underscore in front, but the alternative would be to either accessDataLoader._vault, which is also not public, or usingDataLoader.get_real_file, which creates an unnecessary temporary file.Fixes #10799.
ISSUE TYPE
COMPONENT NAME
binary_filelookupADDITIONAL INFORMATION