mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-24 04:54:00 -07:00
Only print warning when ansible.cfg is actually skipped (#43583)
Only print warning when ansible.cfg is actually skipped * Also add unittests for the find_ini_config_file function * Add documentation on world writable current working directory config files can no longer be loaded from a world writable current working directory but the end user is allowed to specify that explicitly. Give appropriate warnings and information on how. Fixes #42388
This commit is contained in:
Toshio Kuratomi
GitHub
parent
48280463f2
commit
30662bedad
6 changed files with 314 additions and 26 deletions
0
test/units/config/manager/__init__.py
Normal file
0
test/units/config/manager/__init__.py
Normal file
221
test/units/config/manager/test_find_ini_config_file.py
Normal file
221
test/units/config/manager/test_find_ini_config_file.py
Normal file
|
|
@ -0,0 +1,221 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
# Copyright: (c) 2017, Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
# Make coding more python3-ish
|
||||
from __future__ import (absolute_import, division)
|
||||
__metaclass__ = type
|
||||
|
||||
import os
|
||||
import os.path
|
||||
import stat
|
||||
|
||||
import pytest
|
||||
|
||||
from ansible.config.manager import find_ini_config_file
|
||||
|
||||
|
||||
real_exists = os.path.exists
|
||||
real_isdir = os.path.isdir
|
||||
|
||||
working_dir = os.path.dirname(__file__)
|
||||
cfg_in_cwd = os.path.join(working_dir, 'ansible.cfg')
|
||||
|
||||
cfg_dir = os.path.join(working_dir, 'data')
|
||||
cfg_file = os.path.join(cfg_dir, 'ansible.cfg')
|
||||
alt_cfg_file = os.path.join(cfg_dir, 'test.cfg')
|
||||
cfg_in_homedir = os.path.expanduser('~/.ansible.cfg')
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def setup_env(request):
|
||||
cur_config = os.environ.get('ANSIBLE_CONFIG', None)
|
||||
cfg_path = request.param[0]
|
||||
|
||||
if cfg_path is None and cur_config:
|
||||
del os.environ['ANSIBLE_CONFIG']
|
||||
else:
|
||||
os.environ['ANSIBLE_CONFIG'] = request.param[0]
|
||||
|
||||
yield
|
||||
|
||||
if cur_config is None and cfg_path:
|
||||
del os.environ['ANSIBLE_CONFIG']
|
||||
else:
|
||||
os.environ['ANSIBLE_CONFIG'] = cur_config
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def setup_existing_files(request, monkeypatch):
|
||||
def _os_path_exists(path):
|
||||
if path in (request.param[0]):
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
# Enable user and system dirs so that we know cwd takes precedence
|
||||
monkeypatch.setattr("os.path.exists", _os_path_exists)
|
||||
monkeypatch.setattr("os.getcwd", lambda: os.path.dirname(cfg_dir))
|
||||
monkeypatch.setattr("os.path.isdir", lambda path: True if path == cfg_dir else real_isdir(path))
|
||||
|
||||
|
||||
class TestFindIniFile:
|
||||
# This tells us to run twice, once with a file specified and once with a directory
|
||||
@pytest.mark.parametrize('setup_env, expected', (([alt_cfg_file], alt_cfg_file), ([cfg_dir], cfg_file)), indirect=['setup_env'])
|
||||
# This just passes the list of files that exist to the fixture
|
||||
@pytest.mark.parametrize('setup_existing_files',
|
||||
[[('/etc/ansible/ansible.cfg', cfg_in_homedir, cfg_in_cwd, alt_cfg_file, cfg_file)]],
|
||||
indirect=['setup_existing_files'])
|
||||
def test_env_has_cfg_file(self, setup_env, setup_existing_files, expected):
|
||||
"""ANSIBLE_CONFIG is specified, use it"""
|
||||
warnings = set()
|
||||
assert find_ini_config_file(warnings) == expected
|
||||
assert warnings == set()
|
||||
|
||||
@pytest.mark.parametrize('setup_env', ([alt_cfg_file], [cfg_dir]), indirect=['setup_env'])
|
||||
@pytest.mark.parametrize('setup_existing_files',
|
||||
[[('/etc/ansible/ansible.cfg', cfg_in_homedir, cfg_in_cwd)]],
|
||||
indirect=['setup_existing_files'])
|
||||
def test_env_has_no_cfg_file(self, setup_env, setup_existing_files):
|
||||
"""ANSIBLE_CONFIG is specified but the file does not exist"""
|
||||
|
||||
warnings = set()
|
||||
# since the cfg file specified by ANSIBLE_CONFIG doesn't exist, the one at cwd that does
|
||||
# exist should be returned
|
||||
assert find_ini_config_file(warnings) == cfg_in_cwd
|
||||
assert warnings == set()
|
||||
|
||||
# ANSIBLE_CONFIG not specified
|
||||
@pytest.mark.parametrize('setup_env', [[None]], indirect=['setup_env'])
|
||||
# All config files are present
|
||||
@pytest.mark.parametrize('setup_existing_files',
|
||||
[[('/etc/ansible/ansible.cfg', cfg_in_homedir, cfg_in_cwd, cfg_file, alt_cfg_file)]],
|
||||
indirect=['setup_existing_files'])
|
||||
def test_ini_in_cwd(self, setup_env, setup_existing_files):
|
||||
"""ANSIBLE_CONFIG not specified. Use the cwd cfg"""
|
||||
warnings = set()
|
||||
assert find_ini_config_file(warnings) == cfg_in_cwd
|
||||
assert warnings == set()
|
||||
|
||||
# ANSIBLE_CONFIG not specified
|
||||
@pytest.mark.parametrize('setup_env', [[None]], indirect=['setup_env'])
|
||||
# No config in cwd
|
||||
@pytest.mark.parametrize('setup_existing_files',
|
||||
[[('/etc/ansible/ansible.cfg', cfg_in_homedir, cfg_file, alt_cfg_file)]],
|
||||
indirect=['setup_existing_files'])
|
||||
def test_ini_in_homedir(self, setup_env, setup_existing_files):
|
||||
"""First config found is in the homedir"""
|
||||
warnings = set()
|
||||
assert find_ini_config_file(warnings) == cfg_in_homedir
|
||||
assert warnings == set()
|
||||
|
||||
# ANSIBLE_CONFIG not specified
|
||||
@pytest.mark.parametrize('setup_env', [[None]], indirect=['setup_env'])
|
||||
# No config in cwd
|
||||
@pytest.mark.parametrize('setup_existing_files', [[('/etc/ansible/ansible.cfg', cfg_file, alt_cfg_file)]], indirect=['setup_existing_files'])
|
||||
def test_ini_in_systemdir(self, setup_env, setup_existing_files):
|
||||
"""First config found is the system config"""
|
||||
warnings = set()
|
||||
assert find_ini_config_file(warnings) == '/etc/ansible/ansible.cfg'
|
||||
assert warnings == set()
|
||||
|
||||
# ANSIBLE_CONFIG not specified
|
||||
@pytest.mark.parametrize('setup_env', [[None]], indirect=['setup_env'])
|
||||
# No config in cwd
|
||||
@pytest.mark.parametrize('setup_existing_files',
|
||||
[[('/etc/ansible/ansible.cfg', cfg_in_homedir, cfg_file, alt_cfg_file)]],
|
||||
indirect=['setup_existing_files'])
|
||||
def test_cwd_does_not_exist(self, setup_env, setup_existing_files, monkeypatch):
|
||||
"""Smoketest current working directory doesn't exist"""
|
||||
def _os_stat(path):
|
||||
raise OSError('%s does not exist' % path)
|
||||
monkeypatch.setattr('os.stat', _os_stat)
|
||||
|
||||
warnings = set()
|
||||
assert find_ini_config_file(warnings) == cfg_in_homedir
|
||||
assert warnings == set()
|
||||
|
||||
@pytest.mark.parametrize('setup_env', [[None]], indirect=['setup_env'])
|
||||
# No config in cwd
|
||||
@pytest.mark.parametrize('setup_existing_files', [[list()]], indirect=['setup_existing_files'])
|
||||
def test_no_config(self, setup_env, setup_existing_files):
|
||||
"""No config present, no config found"""
|
||||
warnings = set()
|
||||
assert find_ini_config_file(warnings) is None
|
||||
assert warnings == set()
|
||||
|
||||
# ANSIBLE_CONFIG not specified
|
||||
@pytest.mark.parametrize('setup_env', [[None]], indirect=['setup_env'])
|
||||
# All config files are present
|
||||
@pytest.mark.parametrize('setup_existing_files',
|
||||
[[('/etc/ansible/ansible.cfg', cfg_in_homedir, cfg_in_cwd, cfg_file, alt_cfg_file)]],
|
||||
indirect=['setup_existing_files'])
|
||||
def test_cwd_warning_on_writable(self, setup_env, setup_existing_files, monkeypatch):
|
||||
"""If the cwd is writable, warn and skip it """
|
||||
real_stat = os.stat
|
||||
|
||||
def _os_stat(path):
|
||||
if path == working_dir:
|
||||
from posix import stat_result
|
||||
stat_info = list(real_stat(path))
|
||||
stat_info[stat.ST_MODE] |= stat.S_IWOTH
|
||||
return stat_result(stat_info)
|
||||
else:
|
||||
return real_stat(path)
|
||||
|
||||
monkeypatch.setattr('os.stat', _os_stat)
|
||||
|
||||
warnings = set()
|
||||
assert find_ini_config_file(warnings) == cfg_in_homedir
|
||||
assert len(warnings) == 1
|
||||
warning = warnings.pop()
|
||||
assert u'Ansible is being run in a world writable directory' in warning
|
||||
assert u'ignoring it as an ansible.cfg source' in warning
|
||||
|
||||
# ANSIBLE_CONFIG is sepcified
|
||||
@pytest.mark.parametrize('setup_env, expected', (([alt_cfg_file], alt_cfg_file), ([cfg_in_cwd], cfg_in_cwd)), indirect=['setup_env'])
|
||||
# All config files are present
|
||||
@pytest.mark.parametrize('setup_existing_files',
|
||||
[[('/etc/ansible/ansible.cfg', cfg_in_homedir, cfg_in_cwd, cfg_file, alt_cfg_file)]],
|
||||
indirect=['setup_existing_files'])
|
||||
def test_no_warning_on_writable_if_env_used(self, setup_env, setup_existing_files, monkeypatch, expected):
|
||||
"""If the cwd is writable but ANSIBLE_CONFIG was used, no warning should be issued"""
|
||||
real_stat = os.stat
|
||||
|
||||
def _os_stat(path):
|
||||
if path == working_dir:
|
||||
from posix import stat_result
|
||||
stat_info = list(real_stat(path))
|
||||
stat_info[stat.ST_MODE] |= stat.S_IWOTH
|
||||
return stat_result(stat_info)
|
||||
else:
|
||||
return real_stat(path)
|
||||
|
||||
monkeypatch.setattr('os.stat', _os_stat)
|
||||
|
||||
warnings = set()
|
||||
assert find_ini_config_file(warnings) == expected
|
||||
assert warnings == set()
|
||||
|
||||
# ANSIBLE_CONFIG not specified
|
||||
@pytest.mark.parametrize('setup_env', [[None]], indirect=['setup_env'])
|
||||
# All config files are present
|
||||
@pytest.mark.parametrize('setup_existing_files',
|
||||
[[('/etc/ansible/ansible.cfg', cfg_in_homedir, cfg_in_cwd, cfg_file, alt_cfg_file)]],
|
||||
indirect=['setup_existing_files'])
|
||||
def test_cwd_warning_on_writable_no_warning_set(self, setup_env, setup_existing_files, monkeypatch):
|
||||
"""Smoketest that the function succeeds even though no warning set was passed in"""
|
||||
real_stat = os.stat
|
||||
|
||||
def _os_stat(path):
|
||||
if path == working_dir:
|
||||
from posix import stat_result
|
||||
stat_info = list(real_stat(path))
|
||||
stat_info[stat.ST_MODE] |= stat.S_IWOTH
|
||||
return stat_result(stat_info)
|
||||
else:
|
||||
return real_stat(path)
|
||||
|
||||
monkeypatch.setattr('os.stat', _os_stat)
|
||||
|
||||
assert find_ini_config_file() == cfg_in_homedir
|
||||
|
|
@ -3,6 +3,7 @@ from __future__ import (absolute_import, division, print_function)
|
|||
__metaclass__ = type
|
||||
|
||||
import os
|
||||
import os.path
|
||||
|
||||
from ansible.compat.tests import unittest
|
||||
|
||||
|
|
@ -50,12 +51,6 @@ class TestConfigData(unittest.TestCase):
|
|||
self.assertIsInstance(ensure_type('0.10', 'float'), float)
|
||||
self.assertIsInstance(ensure_type(0.2, 'float'), float)
|
||||
|
||||
def test_find_ini_file(self):
|
||||
cur_config = os.environ['ANSIBLE_CONFIG']
|
||||
os.environ['ANSIBLE_CONFIG'] = cfg_file
|
||||
self.assertEquals(cfg_file, find_ini_config_file())
|
||||
os.environ['ANSIBLE_CONFIG'] = cur_config
|
||||
|
||||
def test_resolve_path(self):
|
||||
self.assertEquals(os.path.join(curdir, 'test.yml'), resolve_path('./test.yml', cfg_file))
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue