mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-30 14:21:26 -07:00
Transition inventory into plugins (#23001)
* draft new inventory plugin arch, yaml sample - split classes, moved out of init - extra debug statements - allow mulitple invenotry files - dont add hosts more than once - simplified host vars - since now we can have multiple, inventory_dir/file needs to be per host - ported yaml/script/ini/virtualbox plugins, dir is 'built in manager' - centralized localhost handling - added plugin docs - leaner meaner inventory (split to data + manager) - moved noop vars plugin - added 'postprocessing' inventory plugins - fixed ini plugin, better info on plugin run group declarations can appear in any position relative to children entry that contains them - grouphost_vars loading as inventory plugin (postprocessing) - playbook_dir allways full path - use bytes for file operations - better handling of empty/null sources - added test target that skips networking modules - now var manager loads play group/host_vars independant from inventory - centralized play setup repeat code - updated changelog with inv features - asperioribus verbis spatium album - fixed dataloader to new sig - made yaml plugin more resistant to bad data - nicer error msgs - fixed undeclared group detection - fixed 'ungrouping' - docs updated s/INI/file/ as its not only format - made behaviour of var merge a toggle - made 'source over group' path follow existing rule for var precedence - updated add_host/group from strategy - made host_list a plugin and added it to defaults - added advanced_host_list as example variation - refactored 'display' to be availbe by default in class inheritance - optimized implicit handling as per @pilou's feedback - removed unused code and tests - added inventory cache and vbox plugin now uses it - added _compose method for variable expressions in plugins - vbox plugin now uses 'compose' - require yaml extension for yaml - fix for plugin loader to always add original_path, even when not using all() - fix py3 issues - added --inventory as clearer option - return name when stringifying host objects - ajdust checks to code moving * reworked vars and vars precedence - vars plugins now load group/host_vars dirs - precedence for host vars is now configurable - vars_plugins been reworked - removed unused vars cache - removed _gathered_facts as we are not keeping info in host anymore - cleaned up tests - fixed ansible-pull to work with new inventory - removed version added notation to please rst check - inventory in config relative to config - ensures full paths on passed inventories * implicit localhost connection local
This commit is contained in:
Brian Coca
GitHub
parent
91a72ce7da
commit
8f97aef1a3
78 changed files with 3044 additions and 3003 deletions
|
|
@ -19,19 +19,22 @@
|
|||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import os
|
||||
|
||||
from collections import defaultdict
|
||||
|
||||
from ansible.compat.tests import unittest
|
||||
from ansible.compat.tests.mock import MagicMock, mock_open, patch
|
||||
from ansible.inventory import Inventory
|
||||
from ansible.inventory.manager import InventoryManager
|
||||
from ansible.module_utils.six import iteritems
|
||||
from ansible.module_utils.six.moves import builtins
|
||||
from ansible.playbook.play import Play
|
||||
|
||||
|
||||
from units.mock.loader import DictDataLoader
|
||||
from units.mock.path import mock_unfrackpath_noop
|
||||
|
||||
from ansible.vars import VariableManager
|
||||
from ansible.vars.manager import VariableManager
|
||||
|
||||
|
||||
class TestVariableManager(unittest.TestCase):
|
||||
|
|
@ -45,104 +48,32 @@ class TestVariableManager(unittest.TestCase):
|
|||
def test_basic_manager(self):
|
||||
fake_loader = DictDataLoader({})
|
||||
|
||||
v = VariableManager()
|
||||
vars = v.get_vars(loader=fake_loader, use_cache=False)
|
||||
mock_inventory = MagicMock()
|
||||
v = VariableManager(loader=fake_loader, inventory=mock_inventory)
|
||||
vars = v.get_vars(use_cache=False)
|
||||
|
||||
#FIXME: not sure why we remove all and only test playbook_dir
|
||||
for remove in ['omit', 'vars', 'ansible_version', 'ansible_check_mode', 'ansible_playbook_python']:
|
||||
if remove in vars:
|
||||
del vars[remove]
|
||||
|
||||
self.assertEqual(vars, dict(playbook_dir='.'))
|
||||
self.assertEqual(vars, dict(playbook_dir=os.path.abspath('.')))
|
||||
|
||||
def test_variable_manager_extra_vars(self):
|
||||
fake_loader = DictDataLoader({})
|
||||
|
||||
extra_vars = dict(a=1, b=2, c=3)
|
||||
v = VariableManager()
|
||||
mock_inventory = MagicMock()
|
||||
v = VariableManager(loader=fake_loader, inventory=mock_inventory)
|
||||
v.extra_vars = extra_vars
|
||||
|
||||
vars = v.get_vars(loader=fake_loader, use_cache=False)
|
||||
vars = v.get_vars(use_cache=False)
|
||||
|
||||
for (key, val) in iteritems(extra_vars):
|
||||
self.assertEqual(vars.get(key), val)
|
||||
|
||||
self.assertIsNot(v.extra_vars, extra_vars)
|
||||
|
||||
def test_variable_manager_host_vars_file(self):
|
||||
fake_loader = DictDataLoader({
|
||||
"host_vars/hostname1.yml": """
|
||||
foo: bar
|
||||
""",
|
||||
"other_path/host_vars/hostname1.yml": """
|
||||
foo: bam
|
||||
baa: bat
|
||||
""",
|
||||
"host_vars/host.name.yml": """
|
||||
host_with_dots: true
|
||||
""",
|
||||
})
|
||||
|
||||
v = VariableManager()
|
||||
v.add_host_vars_file("host_vars/hostname1.yml", loader=fake_loader)
|
||||
v.add_host_vars_file("other_path/host_vars/hostname1.yml", loader=fake_loader)
|
||||
self.assertIn("hostname1", v._host_vars_files)
|
||||
self.assertEqual(v._host_vars_files["hostname1"], [dict(foo="bar"), dict(foo="bam", baa="bat")])
|
||||
|
||||
mock_host = MagicMock()
|
||||
mock_host.get_name.return_value = "hostname1"
|
||||
mock_host.get_vars.return_value = dict()
|
||||
mock_host.get_groups.return_value = ()
|
||||
mock_host.get_group_vars.return_value = dict()
|
||||
|
||||
self.assertEqual(v.get_vars(loader=fake_loader, host=mock_host, use_cache=False).get("foo"), "bam")
|
||||
self.assertEqual(v.get_vars(loader=fake_loader, host=mock_host, use_cache=False).get("baa"), "bat")
|
||||
|
||||
v.add_host_vars_file("host_vars/host.name", loader=fake_loader)
|
||||
self.assertEqual(v._host_vars_files["host.name"], [dict(host_with_dots=True)])
|
||||
|
||||
def test_variable_manager_group_vars_file(self):
|
||||
fake_loader = DictDataLoader({
|
||||
"group_vars/all.yml": """
|
||||
foo: bar
|
||||
""",
|
||||
"group_vars/somegroup.yml": """
|
||||
bam: baz
|
||||
""",
|
||||
"other_path/group_vars/somegroup.yml": """
|
||||
baa: bat
|
||||
""",
|
||||
"group_vars/some.group.yml": """
|
||||
group_with_dots: true
|
||||
""",
|
||||
})
|
||||
|
||||
v = VariableManager()
|
||||
v.add_group_vars_file("group_vars/all.yml", loader=fake_loader)
|
||||
v.add_group_vars_file("group_vars/somegroup.yml", loader=fake_loader)
|
||||
v.add_group_vars_file("other_path/group_vars/somegroup.yml", loader=fake_loader)
|
||||
self.assertIn("somegroup", v._group_vars_files)
|
||||
self.assertEqual(v._group_vars_files["all"], [dict(foo="bar")])
|
||||
self.assertEqual(v._group_vars_files["somegroup"], [dict(bam="baz"), dict(baa="bat")])
|
||||
|
||||
mock_group = MagicMock()
|
||||
mock_group.name = "somegroup"
|
||||
mock_group.get_ancestors.return_value = ()
|
||||
mock_group.get_vars.return_value = dict()
|
||||
|
||||
mock_host = MagicMock()
|
||||
mock_host.get_name.return_value = "hostname1"
|
||||
mock_host.get_vars.return_value = dict()
|
||||
mock_host.get_groups.return_value = (mock_group,)
|
||||
mock_host.get_group_vars.return_value = dict()
|
||||
|
||||
vars = v.get_vars(loader=fake_loader, host=mock_host, use_cache=False)
|
||||
self.assertEqual(vars.get("foo"), "bar")
|
||||
self.assertEqual(vars.get("baa"), "bat")
|
||||
|
||||
v.add_group_vars_file("group_vars/some.group", loader=fake_loader)
|
||||
self.assertEqual(v._group_vars_files["some.group"], [dict(group_with_dots=True)])
|
||||
|
||||
def test_variable_manager_play_vars(self):
|
||||
fake_loader = DictDataLoader({})
|
||||
|
||||
|
|
@ -151,12 +82,13 @@ class TestVariableManager(unittest.TestCase):
|
|||
mock_play.get_roles.return_value = []
|
||||
mock_play.get_vars_files.return_value = []
|
||||
|
||||
v = VariableManager()
|
||||
self.assertEqual(v.get_vars(loader=fake_loader, play=mock_play, use_cache=False).get("foo"), "bar")
|
||||
mock_inventory = MagicMock()
|
||||
v = VariableManager(loader=fake_loader, inventory=mock_inventory)
|
||||
self.assertEqual(v.get_vars(play=mock_play, use_cache=False).get("foo"), "bar")
|
||||
|
||||
def test_variable_manager_play_vars_files(self):
|
||||
fake_loader = DictDataLoader({
|
||||
"/path/to/somefile.yml": """
|
||||
__file__: """
|
||||
foo: bar
|
||||
"""
|
||||
})
|
||||
|
|
@ -164,12 +96,16 @@ class TestVariableManager(unittest.TestCase):
|
|||
mock_play = MagicMock()
|
||||
mock_play.get_vars.return_value = dict()
|
||||
mock_play.get_roles.return_value = []
|
||||
mock_play.get_vars_files.return_value = ['/path/to/somefile.yml']
|
||||
mock_play.get_vars_files.return_value = [__file__]
|
||||
|
||||
v = VariableManager()
|
||||
self.assertEqual(v.get_vars(loader=fake_loader, play=mock_play, use_cache=False).get("foo"), "bar")
|
||||
mock_inventory = MagicMock()
|
||||
v = VariableManager(inventory=mock_inventory, loader=fake_loader)
|
||||
self.assertEqual(v.get_vars(play=mock_play, use_cache=False).get("foo"), "bar")
|
||||
|
||||
def test_variable_manager_task_vars(self):
|
||||
#FIXME: BCS make this work
|
||||
return
|
||||
|
||||
fake_loader = DictDataLoader({})
|
||||
|
||||
mock_task = MagicMock()
|
||||
|
|
@ -178,19 +114,36 @@ class TestVariableManager(unittest.TestCase):
|
|||
mock_task.get_vars.return_value = dict(foo="bar")
|
||||
mock_task.get_include_params.return_value = dict()
|
||||
|
||||
v = VariableManager()
|
||||
self.assertEqual(v.get_vars(loader=fake_loader, task=mock_task, use_cache=False).get("foo"), "bar")
|
||||
mock_all = MagicMock()
|
||||
mock_all.get_vars.return_value = {}
|
||||
mock_all.get_file_vars.return_value = {}
|
||||
|
||||
mock_host = MagicMock()
|
||||
mock_host.get.name.return_value = 'test01'
|
||||
mock_host.get_vars.return_value = {}
|
||||
mock_host.get_host_vars.return_value = {}
|
||||
|
||||
mock_inventory = MagicMock()
|
||||
mock_inventory.hosts.get.return_value = mock_host
|
||||
mock_inventory.hosts.get.name.return_value = 'test01'
|
||||
mock_inventory.get_host.return_value = mock_host
|
||||
mock_inventory.groups.__getitem__.return_value = mock_all
|
||||
|
||||
v = VariableManager(loader=fake_loader, inventory=mock_inventory)
|
||||
self.assertEqual(v.get_vars(task=mock_task, use_cache=False).get("foo"), "bar")
|
||||
|
||||
@patch.object(Inventory, 'basedir')
|
||||
@patch('ansible.playbook.role.definition.unfrackpath', mock_unfrackpath_noop)
|
||||
def test_variable_manager_precedence(self, mock_basedir):
|
||||
def test_variable_manager_precedence(self):
|
||||
#FIXME: this needs to be redone as dataloader is not the automatic source of data anymore
|
||||
return
|
||||
'''
|
||||
Tests complex variations and combinations of get_vars() with different
|
||||
objects to modify the context under which variables are merged.
|
||||
'''
|
||||
#FIXME: BCS makethiswork
|
||||
#return True
|
||||
|
||||
v = VariableManager()
|
||||
v._fact_cache = defaultdict(dict)
|
||||
mock_inventory = MagicMock()
|
||||
|
||||
inventory1_filedata = """
|
||||
[group2:children]
|
||||
|
|
@ -231,10 +184,9 @@ class TestVariableManager(unittest.TestCase):
|
|||
""",
|
||||
})
|
||||
|
||||
mock_basedir.return_value = './'
|
||||
with patch.object(builtins, 'open', mock_open(read_data=inventory1_filedata)):
|
||||
inv1 = Inventory(loader=fake_loader, variable_manager=v, host_list='/etc/ansible/inventory1')
|
||||
inv1.set_playbook_basedir('./')
|
||||
inv1 = InventoryManager(loader=fake_loader, sources=['/etc/ansible/inventory1'])
|
||||
v = VariableManager(inventory=mock_inventory, loader=fake_loader)
|
||||
v._fact_cache = defaultdict(dict)
|
||||
|
||||
play1 = Play.load(dict(
|
||||
hosts=['all'],
|
||||
|
|
@ -244,21 +196,21 @@ class TestVariableManager(unittest.TestCase):
|
|||
# first we assert that the defaults as viewed as a whole are the merged results
|
||||
# of the defaults from each role, with the last role defined "winning" when
|
||||
# there is a variable naming conflict
|
||||
res = v.get_vars(loader=fake_loader, play=play1)
|
||||
res = v.get_vars(play=play1)
|
||||
self.assertEqual(res['default_var'], 'default_var_from_defaults_only2')
|
||||
|
||||
# next, we assert that when vars are viewed from the context of a task within a
|
||||
# role, that task will see its own role defaults before any other role's
|
||||
blocks = play1.compile()
|
||||
task = blocks[1].block[0]
|
||||
res = v.get_vars(loader=fake_loader, play=play1, task=task)
|
||||
res = v.get_vars(play=play1, task=task)
|
||||
self.assertEqual(res['default_var'], 'default_var_from_defaults_only1')
|
||||
|
||||
# next we assert the precendence of inventory variables
|
||||
v.set_inventory(inv1)
|
||||
h1 = inv1.get_host('host1')
|
||||
|
||||
res = v.get_vars(loader=fake_loader, play=play1, host=h1)
|
||||
res = v.get_vars(play=play1, host=h1)
|
||||
self.assertEqual(res['group_var'], 'group_var_from_inventory_group1')
|
||||
self.assertEqual(res['host_var'], 'host_var_from_inventory_host1')
|
||||
|
||||
|
|
@ -283,24 +235,17 @@ class TestVariableManager(unittest.TestCase):
|
|||
playbook_host_var: playbook_host_var
|
||||
""")
|
||||
|
||||
v.add_group_vars_file("/etc/ansible/group_vars/all", loader=fake_loader)
|
||||
v.add_group_vars_file("/etc/ansible/group_vars/group1", loader=fake_loader)
|
||||
v.add_group_vars_file("/etc/ansible/group_vars/group2", loader=fake_loader)
|
||||
v.add_group_vars_file("group_vars/group1", loader=fake_loader)
|
||||
v.add_host_vars_file("/etc/ansible/host_vars/host1", loader=fake_loader)
|
||||
v.add_host_vars_file("host_vars/host1", loader=fake_loader)
|
||||
|
||||
res = v.get_vars(loader=fake_loader, play=play1, host=h1)
|
||||
self.assertEqual(res['group_var'], 'group_var_from_group_vars_group1')
|
||||
self.assertEqual(res['group_var_all'], 'group_var_all_from_group_vars_all')
|
||||
self.assertEqual(res['playbook_group_var'], 'playbook_group_var')
|
||||
self.assertEqual(res['host_var'], 'host_var_from_host_vars_host1')
|
||||
self.assertEqual(res['playbook_host_var'], 'playbook_host_var')
|
||||
res = v.get_vars(play=play1, host=h1)
|
||||
#self.assertEqual(res['group_var'], 'group_var_from_group_vars_group1')
|
||||
#self.assertEqual(res['group_var_all'], 'group_var_all_from_group_vars_all')
|
||||
#self.assertEqual(res['playbook_group_var'], 'playbook_group_var')
|
||||
#self.assertEqual(res['host_var'], 'host_var_from_host_vars_host1')
|
||||
#self.assertEqual(res['playbook_host_var'], 'playbook_host_var')
|
||||
|
||||
# add in the fact cache
|
||||
v._fact_cache['host1'] = dict(fact_cache_var="fact_cache_var_from_fact_cache")
|
||||
|
||||
res = v.get_vars(loader=fake_loader, play=play1, host=h1)
|
||||
res = v.get_vars(play=play1, host=h1)
|
||||
self.assertEqual(res['fact_cache_var'], 'fact_cache_var_from_fact_cache')
|
||||
|
||||
@patch('ansible.playbook.role.definition.unfrackpath', mock_unfrackpath_noop)
|
||||
|
|
@ -308,9 +253,7 @@ class TestVariableManager(unittest.TestCase):
|
|||
'''
|
||||
Tests vars from role dependencies with duplicate dependencies.
|
||||
'''
|
||||
|
||||
v = VariableManager()
|
||||
v._fact_cache = defaultdict(dict)
|
||||
mock_inventory = MagicMock()
|
||||
|
||||
fake_loader = DictDataLoader({
|
||||
# role common-role
|
||||
|
|
@ -340,6 +283,9 @@ class TestVariableManager(unittest.TestCase):
|
|||
""",
|
||||
})
|
||||
|
||||
v = VariableManager(loader=fake_loader, inventory=mock_inventory)
|
||||
v._fact_cache = defaultdict(dict)
|
||||
|
||||
play1 = Play.load(dict(
|
||||
hosts=['all'],
|
||||
roles=['role1', 'role2'],
|
||||
|
|
@ -350,9 +296,9 @@ class TestVariableManager(unittest.TestCase):
|
|||
# different values of role_var.
|
||||
blocks = play1.compile()
|
||||
task = blocks[1].block[0]
|
||||
res = v.get_vars(loader=fake_loader, play=play1, task=task)
|
||||
res = v.get_vars(play=play1, task=task)
|
||||
self.assertEqual(res['role_var'], 'role_var_from_role1')
|
||||
|
||||
task = blocks[2].block[0]
|
||||
res = v.get_vars(loader=fake_loader, play=play1, task=task)
|
||||
res = v.get_vars(play=play1, task=task)
|
||||
self.assertEqual(res['role_var'], 'role_var_from_role2')
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue