d89bd2d3c1
There should be no warning if there is no ansible.cfg file i nthe
current working directory.
(cherry picked from commit f46c943)
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
246 lines
10 KiB
Python
246 lines
10 KiB
Python
# -*- 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 except 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_no_cwd_cfg_no_warning_on_writable(self, setup_env, setup_existing_files, monkeypatch):
|
|
"""If the cwd is writable but there is no config file there, move on with no warning"""
|
|
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) == 0
|
|
|
|
# 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
|