366bfe14c3
* Fix bug (#18355) where encrypted inventories fail
This is first part of fix for #18355
* Make DataLoader._get_file_contents return bytes
The issue #18355 is caused by a change to inventory to
stop using _get_file_contents so that it can handle text
encoding itself to better protect against harmless text
encoding errors in ini files (invalid unicode text in
comment fields).
So this makes _get_file_contents return bytes so it and other
callers can handle the to_text().
The data returned by _get_file_contents() is now a bytes object
instead of a text object. The callers of _get_file_contents() have
been updated to call to_text() themselves on the results.
Previously, the ini parser attempted to work around
ini files that potentially include non-vailid unicode
in comment lines. To do this, it stopped using
DataLoader._get_file_contents() which does the decryption of
files if vault encrypted. It didn't use that because _get_file_contents
previously did to_text() on the read data itself.
_get_file_contents() returns a bytestring now, so ini.py
can call it and still special case ini file comments when
converting to_text(). That also means encrypted inventory files
are decrypted first.
Fixes #18355
(cherry picked from commit dd0189839e)
98 lines
3.1 KiB
Python
98 lines
3.1 KiB
Python
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
|
|
from ansible.errors import AnsibleParserError
|
|
from ansible.parsing.dataloader import DataLoader
|
|
from ansible.module_utils._text import to_bytes
|
|
|
|
|
|
class DictDataLoader(DataLoader):
|
|
|
|
def __init__(self, file_mapping=dict()):
|
|
assert type(file_mapping) == dict
|
|
|
|
super(DictDataLoader, self).__init__()
|
|
|
|
self._file_mapping = file_mapping
|
|
self._build_known_directories()
|
|
|
|
def load_from_file(self, path):
|
|
if path in self._file_mapping:
|
|
return self.load(self._file_mapping[path], path)
|
|
return None
|
|
|
|
# TODO: the real _get_file_contents returns a bytestring, so we actually convert the
|
|
# unicode/text it's created with to utf-8
|
|
def _get_file_contents(self, path):
|
|
if path in self._file_mapping:
|
|
return (to_bytes(self._file_mapping[path]), False)
|
|
else:
|
|
raise AnsibleParserError("file not found: %s" % path)
|
|
|
|
def path_exists(self, path):
|
|
return path in self._file_mapping or path in self._known_directories
|
|
|
|
def is_file(self, path):
|
|
return path in self._file_mapping
|
|
|
|
def is_directory(self, path):
|
|
return path in self._known_directories
|
|
|
|
def list_directory(self, path):
|
|
return [x for x in self._known_directories]
|
|
|
|
def is_executable(self, path):
|
|
# FIXME: figure out a way to make paths return true for this
|
|
return False
|
|
|
|
def _add_known_directory(self, directory):
|
|
if directory not in self._known_directories:
|
|
self._known_directories.append(directory)
|
|
|
|
def _build_known_directories(self):
|
|
self._known_directories = []
|
|
for path in self._file_mapping:
|
|
dirname = os.path.dirname(path)
|
|
while dirname not in ('/', ''):
|
|
self._add_known_directory(dirname)
|
|
dirname = os.path.dirname(dirname)
|
|
|
|
def push(self, path, content):
|
|
rebuild_dirs = False
|
|
if path not in self._file_mapping:
|
|
rebuild_dirs = True
|
|
|
|
self._file_mapping[path] = content
|
|
|
|
if rebuild_dirs:
|
|
self._build_known_directories()
|
|
|
|
def pop(self, path):
|
|
if path in self._file_mapping:
|
|
del self._file_mapping[path]
|
|
self._build_known_directories()
|
|
|
|
def clear(self):
|
|
self._file_mapping = dict()
|
|
self._known_directories = []
|
|
|