mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-03-22 13:19:13 +00:00
dae2157bb7
* merge_variables: extended merge capabilities added This extension gives you more control over the variable merging process of the lookup plugin `merge_variables`. It closes the gap between Puppet's Hiera merging capabilities and the limitations of Ansible's default variable plugin `host_group_vars` regarding fragment-based value definition. You can now decide which merge strategy should be applied to dicts, lists, and other types. Furthermore, you can specify a merge strategy that should be applied in case of type conflicts. The default behavior of the plugin has been preserved so that it is fully backward-compatible with the already implemented state. Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * Update changelogs/fragments/11536-merge-variables-extended-merging-capabilities.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/lookup/merge_variables.py Co-authored-by: Felix Fontein <felix@fontein.de> * Periods added at the end of each choice description Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * Update plugins/lookup/merge_variables.py Co-authored-by: Mark <40321020+m-a-r-k-e@users.noreply.github.com> * ref: follow project standard for choice descriptions Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * ref: more examples added and refactoring Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * Update plugins/lookup/merge_variables.py Co-authored-by: Felix Fontein <felix@fontein.de> * ref: some more comments to examples added Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * fix: unused import removed Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * ref: re-add "merge" to strategy map Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * Update comments Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * Specification of transformations solely as string Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * Comments updated Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * ref: `append_rp` and `prepend_rp` removed feat: options dict for list transformations re-added feat: allow setting `keep` for dedup transformation with possible values: `first` (default) and `last` Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * ref: improve options documentation Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * ref: documentation improved, avoiding words like newer or older in merge description Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * Update plugins/lookup/merge_variables.py Co-authored-by: Felix Fontein <felix@fontein.de> * ref: "prio" replaced by "dict" Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> * feat: two integration tests added Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> --------- Signed-off-by: Fiehe Christoph <c.fiehe@eurodata.de> Co-authored-by: Fiehe Christoph <c.fiehe@eurodata.de> Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Mark <40321020+m-a-r-k-e@users.noreply.github.com>
699 lines
26 KiB
Python
699 lines
26 KiB
Python
# Copyright (c) 2020, Thales Netherlands
|
|
# Copyright (c) 2021, Ansible Project
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
from __future__ import annotations
|
|
|
|
import unittest
|
|
from copy import deepcopy
|
|
from unittest.mock import patch
|
|
|
|
from ansible.errors import AnsibleError
|
|
from ansible.plugins import AnsiblePlugin
|
|
from ansible.template import Templar
|
|
from ansible.utils.display import Display
|
|
from ansible_collections.community.internal_test_tools.tests.unit.mock.loader import DictDataLoader
|
|
|
|
from ansible_collections.community.general.plugins.lookup import merge_variables
|
|
|
|
merge_hash_data = {
|
|
"low_dict": {"a": {"a": {"x": "low_value", "y": "low_value", "list": ["low_value"]}}, "b": [1, 1, 2, 3]},
|
|
"high_dict": {
|
|
"a": {"a": {"y": "high_value", "z": "high_value", "list": ["high_value"]}},
|
|
"b": [3, 4, 4, {"5": "value"}],
|
|
},
|
|
}
|
|
|
|
|
|
class TestMergeVariablesLookup(unittest.TestCase):
|
|
class HostVarsMock(dict):
|
|
def __getattr__(self, item):
|
|
return super().__getitem__(item)
|
|
|
|
def __setattr__(self, item, value):
|
|
return super().__setitem__(item, value)
|
|
|
|
def raw_get(self, host):
|
|
return super().__getitem__(host)
|
|
|
|
def setUp(self):
|
|
self.loader = DictDataLoader({})
|
|
self.templar = Templar(loader=self.loader, variables={})
|
|
self.merge_vars_lookup = merge_variables.LookupModule(loader=self.loader, templar=self.templar)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(Templar, "template", side_effect=[["item1"], ["item3"]])
|
|
def test_merge_list(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_list"],
|
|
{"testlist1__merge_list": ["item1"], "testlist2": ["item2"], "testlist3__merge_list": ["item3"]},
|
|
)
|
|
|
|
self.assertEqual(results, [["item1", "item3"]])
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[["initial_item"], "ignore", "suffix", None, "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(Templar, "template", side_effect=[["item1"], ["item3"]])
|
|
def test_merge_list_with_initial_value(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_list"],
|
|
{"testlist1__merge_list": ["item1"], "testlist2": ["item2"], "testlist3__merge_list": ["item3"]},
|
|
)
|
|
|
|
self.assertEqual(results, [["initial_item", "item1", "item3"]])
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar,
|
|
"template",
|
|
side_effect=[{"item1": "test", "list_item": ["test1"]}, {"item2": "test", "list_item": ["test2"]}],
|
|
)
|
|
def test_merge_dict(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict"],
|
|
{
|
|
"testdict1__merge_dict": {"item1": "test", "list_item": ["test1"]},
|
|
"testdict2__merge_dict": {"item2": "test", "list_item": ["test2"]},
|
|
},
|
|
)
|
|
|
|
self.assertEqual(results, [{"item1": "test", "item2": "test", "list_item": ["test1", "test2"]}])
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[
|
|
{"initial_item": "random value", "list_item": ["test0"]},
|
|
"ignore",
|
|
"suffix",
|
|
None,
|
|
"deep",
|
|
"append",
|
|
"replace",
|
|
"replace",
|
|
[],
|
|
],
|
|
)
|
|
@patch.object(
|
|
Templar,
|
|
"template",
|
|
side_effect=[{"item1": "test", "list_item": ["test1"]}, {"item2": "test", "list_item": ["test2"]}],
|
|
)
|
|
def test_merge_dict_with_initial_value(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict"],
|
|
{
|
|
"testdict1__merge_dict": {"item1": "test", "list_item": ["test1"]},
|
|
"testdict2__merge_dict": {"item2": "test", "list_item": ["test2"]},
|
|
},
|
|
)
|
|
|
|
self.assertEqual(
|
|
results,
|
|
[
|
|
{
|
|
"initial_item": "random value",
|
|
"item1": "test",
|
|
"item2": "test",
|
|
"list_item": ["test0", "test1", "test2"],
|
|
}
|
|
],
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "warn", "suffix", None, "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(Templar, "template", side_effect=[{"item": "value1"}, {"item": "value2"}])
|
|
@patch.object(Display, "warning")
|
|
def test_merge_dict_non_unique_warning(self, mock_set_options, mock_get_option, mock_template, mock_display):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_non_unique"],
|
|
{"testdict1__merge_non_unique": {"item": "value1"}, "testdict2__merge_non_unique": {"item": "value2"}},
|
|
)
|
|
|
|
self.assertTrue(mock_display.called)
|
|
self.assertEqual(results, [{"item": "value2"}])
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "error", "suffix", None, "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(Templar, "template", side_effect=[{"item": "value1"}, {"item": "value2"}])
|
|
def test_merge_dict_non_unique_error(self, mock_set_options, mock_get_option, mock_template):
|
|
with self.assertRaises(AnsibleError):
|
|
self.merge_vars_lookup.run(
|
|
["__merge_non_unique"],
|
|
{"testdict1__merge_non_unique": {"item": "value1"}, "testdict2__merge_non_unique": {"item": "value2"}},
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(Templar, "template", side_effect=[{"item1": "test", "list_item": ["test1"]}, ["item2", "item3"]])
|
|
def test_merge_list_and_dict(self, mock_set_options, mock_get_option, mock_template):
|
|
with self.assertRaises(AnsibleError):
|
|
self.merge_vars_lookup.run(
|
|
["__merge_var"],
|
|
{
|
|
"testlist__merge_var": {"item1": "test", "list_item": ["test1"]},
|
|
"testdict__merge_var": ["item2", "item3"],
|
|
},
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", ["all"], "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar,
|
|
"template",
|
|
side_effect=[
|
|
{"var": [{"item1": "value1", "item2": "value2"}]},
|
|
{"var": [{"item5": "value5", "item6": "value6"}]},
|
|
],
|
|
)
|
|
def test_merge_dict_group_all(self, mock_set_options, mock_get_option, mock_template):
|
|
hostvars = self.HostVarsMock(
|
|
{
|
|
"host1": {
|
|
"group_names": ["dummy1"],
|
|
"inventory_hostname": "host1",
|
|
"1testlist__merge_var": {"var": [{"item1": "value1", "item2": "value2"}]},
|
|
},
|
|
"host2": {
|
|
"group_names": ["dummy1"],
|
|
"inventory_hostname": "host2",
|
|
"2otherlist__merge_var": {"var": [{"item5": "value5", "item6": "value6"}]},
|
|
},
|
|
}
|
|
)
|
|
variables = {"inventory_hostname": "host1", "hostvars": hostvars}
|
|
|
|
results = self.merge_vars_lookup.run(["__merge_var"], variables)
|
|
|
|
self.assertEqual(
|
|
results, [{"var": [{"item1": "value1", "item2": "value2"}, {"item5": "value5", "item6": "value6"}]}]
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", ["dummy1"], "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar,
|
|
"template",
|
|
side_effect=[
|
|
{"var": [{"item1": "value1", "item2": "value2"}]},
|
|
{"var": [{"item5": "value5", "item6": "value6"}]},
|
|
],
|
|
)
|
|
def test_merge_dict_group_single(self, mock_set_options, mock_get_option, mock_template):
|
|
hostvars = self.HostVarsMock(
|
|
{
|
|
"host1": {
|
|
"group_names": ["dummy1"],
|
|
"inventory_hostname": "host1",
|
|
"1testlist__merge_var": {"var": [{"item1": "value1", "item2": "value2"}]},
|
|
},
|
|
"host2": {
|
|
"group_names": ["dummy1"],
|
|
"inventory_hostname": "host2",
|
|
"2otherlist__merge_var": {"var": [{"item5": "value5", "item6": "value6"}]},
|
|
},
|
|
"host3": {
|
|
"group_names": ["dummy2"],
|
|
"inventory_hostname": "host3",
|
|
"3otherlist__merge_var": {"var": [{"item3": "value3", "item4": "value4"}]},
|
|
},
|
|
}
|
|
)
|
|
variables = {"inventory_hostname": "host1", "hostvars": hostvars}
|
|
|
|
results = self.merge_vars_lookup.run(["__merge_var"], variables)
|
|
|
|
self.assertEqual(
|
|
results, [{"var": [{"item1": "value1", "item2": "value2"}, {"item5": "value5", "item6": "value6"}]}]
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", ["dummy1", "dummy2"], "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar,
|
|
"template",
|
|
side_effect=[
|
|
{"var": [{"item1": "value1", "item2": "value2"}]},
|
|
{"var": [{"item5": "value5", "item6": "value6"}]},
|
|
],
|
|
)
|
|
def test_merge_dict_group_multiple(self, mock_set_options, mock_get_option, mock_template):
|
|
hostvars = self.HostVarsMock(
|
|
{
|
|
"host1": {
|
|
"group_names": ["dummy1"],
|
|
"inventory_hostname": "host1",
|
|
"1testlist__merge_var": {"var": [{"item1": "value1", "item2": "value2"}]},
|
|
},
|
|
"host2": {
|
|
"group_names": ["dummy2"],
|
|
"inventory_hostname": "host2",
|
|
"2otherlist__merge_var": {"var": [{"item5": "value5", "item6": "value6"}]},
|
|
},
|
|
"host3": {
|
|
"group_names": ["dummy3"],
|
|
"inventory_hostname": "host3",
|
|
"3otherlist__merge_var": {"var": [{"item3": "value3", "item4": "value4"}]},
|
|
},
|
|
}
|
|
)
|
|
variables = {"inventory_hostname": "host1", "hostvars": hostvars}
|
|
results = self.merge_vars_lookup.run(["__merge_var"], variables)
|
|
|
|
self.assertEqual(
|
|
results, [{"var": [{"item1": "value1", "item2": "value2"}, {"item5": "value5", "item6": "value6"}]}]
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", ["dummy1", "dummy2"], "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar,
|
|
"template",
|
|
side_effect=[
|
|
["item1"],
|
|
["item5"],
|
|
],
|
|
)
|
|
def test_merge_list_group_multiple(self, mock_set_options, mock_get_option, mock_template):
|
|
hostvars = self.HostVarsMock(
|
|
{
|
|
"host1": {"group_names": ["dummy1"], "inventory_hostname": "host1", "1testlist__merge_var": ["item1"]},
|
|
"host2": {"group_names": ["dummy2"], "inventory_hostname": "host2", "2otherlist__merge_var": ["item5"]},
|
|
"host3": {"group_names": ["dummy3"], "inventory_hostname": "host3", "3otherlist__merge_var": ["item3"]},
|
|
}
|
|
)
|
|
variables = {"inventory_hostname": "host1", "hostvars": hostvars}
|
|
results = self.merge_vars_lookup.run(["__merge_var"], variables)
|
|
|
|
self.assertEqual(results, [["item1", "item5"]])
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "shallow", "replace", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_shallow_and_list_replace(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_shallow_and_list_replace"],
|
|
{
|
|
"testdict1__merge_dict_shallow_and_list_replace": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_shallow_and_list_replace": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(results, [merge_hash_data["high_dict"]])
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "shallow", "keep", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_shallow_and_list_keep(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_shallow_and_list_keep"],
|
|
{
|
|
"testdict1__merge_dict_shallow_and_list_keep": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_shallow_and_list_keep": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(results, [{"a": merge_hash_data["high_dict"]["a"], "b": merge_hash_data["low_dict"]["b"]}])
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "shallow", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_shallow_and_list_append(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_shallow_and_list_append"],
|
|
{
|
|
"testdict1__merge_dict_shallow_and_list_append": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_shallow_and_list_append": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(
|
|
results,
|
|
[
|
|
{
|
|
"a": merge_hash_data["high_dict"]["a"],
|
|
"b": merge_hash_data["low_dict"]["b"] + merge_hash_data["high_dict"]["b"],
|
|
}
|
|
],
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "shallow", "prepend", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_shallow_and_list_prepend(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_shallow_and_list_prepend"],
|
|
{
|
|
"testdict1__merge_dict_shallow_and_list_prepend": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_shallow_and_list_prepend": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(
|
|
results,
|
|
[
|
|
{
|
|
"a": merge_hash_data["high_dict"]["a"],
|
|
"b": merge_hash_data["high_dict"]["b"] + merge_hash_data["low_dict"]["b"],
|
|
}
|
|
],
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "deep", "replace", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_deep_and_list_replace(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_deep_and_list_replace"],
|
|
{
|
|
"testdict1__merge_dict_deep_and_list_replace": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_deep_and_list_replace": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(
|
|
results,
|
|
[
|
|
{
|
|
"a": {"a": {"x": "low_value", "y": "high_value", "z": "high_value", "list": ["high_value"]}},
|
|
"b": merge_hash_data["high_dict"]["b"],
|
|
}
|
|
],
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "deep", "keep", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_deep_and_list_keep(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_deep_and_list_keep"],
|
|
{
|
|
"testdict1__merge_dict_deep_and_list_keep": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_deep_and_list_keep": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(
|
|
results,
|
|
[
|
|
{
|
|
"a": {"a": {"x": "low_value", "y": "high_value", "z": "high_value", "list": ["low_value"]}},
|
|
"b": merge_hash_data["low_dict"]["b"],
|
|
}
|
|
],
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "deep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_deep_and_list_append(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_deep_and_list_append"],
|
|
{
|
|
"testdict1__merge_dict_deep_and_list_append": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_deep_and_list_append": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(
|
|
results,
|
|
[
|
|
{
|
|
"a": {
|
|
"a": {
|
|
"x": "low_value",
|
|
"y": "high_value",
|
|
"z": "high_value",
|
|
"list": ["low_value", "high_value"],
|
|
}
|
|
},
|
|
"b": merge_hash_data["low_dict"]["b"] + merge_hash_data["high_dict"]["b"],
|
|
}
|
|
],
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "deep", "prepend", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_deep_and_list_prepend(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_deep_and_list_prepend"],
|
|
{
|
|
"testdict1__merge_dict_deep_and_list_prepend": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_deep_and_list_prepend": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(
|
|
results,
|
|
[
|
|
{
|
|
"a": {
|
|
"a": {
|
|
"x": "low_value",
|
|
"y": "high_value",
|
|
"z": "high_value",
|
|
"list": ["high_value", "low_value"],
|
|
}
|
|
},
|
|
"b": merge_hash_data["high_dict"]["b"] + merge_hash_data["low_dict"]["b"],
|
|
}
|
|
],
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "replace", "append", "keep", "keep", []],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_replace(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_replace"],
|
|
{
|
|
"testdict1__merge_dict_replace": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_replace": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(results, [merge_hash_data["high_dict"]])
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "keep", "append", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_keep(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_keep"],
|
|
{
|
|
"testdict1__merge_dict_keep": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_keep": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(results, [merge_hash_data["low_dict"]])
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "deep", "merge", "replace", "replace", []],
|
|
)
|
|
@patch.object(
|
|
Templar,
|
|
"template",
|
|
side_effect=[[{"a": "b", "c": "d"}, {"c": "d"}], [{"a": "x", "y": "z"}, {"c": "z"}, {"a": "y"}]],
|
|
)
|
|
def test_merge_list_deep(self, mock_set_options, mock_get_option, mock_template):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_list_deep"],
|
|
{
|
|
"testdict1__merge_list_deep": [{"a": "b", "c": "d"}, {"c": "d"}],
|
|
"testdict2__merge_list_deep": [{"a": "x", "y": "z"}, {"c": "z"}, {"a": "y"}],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(results, [[{"a": "x", "c": "d", "y": "z"}, {"c": "z"}, {"a": "y"}]])
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[None, "ignore", "suffix", None, "deep", "append", "replace", "replace", ["dedup"]],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_deep_and_list_append_with_dedup_keep_first(
|
|
self, mock_set_options, mock_get_option, mock_template
|
|
):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_deep_and_list_append_with_dedup_keep_first"],
|
|
{
|
|
"testdict1__merge_dict_deep_and_list_append_with_dedup_keep_first": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_deep_and_list_append_with_dedup_keep_first": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(
|
|
results,
|
|
[
|
|
{
|
|
"a": {
|
|
"a": {
|
|
"x": "low_value",
|
|
"y": "high_value",
|
|
"z": "high_value",
|
|
"list": ["low_value", "high_value"],
|
|
}
|
|
},
|
|
"b": [1, 2, 3, 4, {"5": "value"}],
|
|
}
|
|
],
|
|
)
|
|
|
|
@patch.object(AnsiblePlugin, "set_options")
|
|
@patch.object(
|
|
AnsiblePlugin,
|
|
"get_option",
|
|
side_effect=[
|
|
None,
|
|
"ignore",
|
|
"suffix",
|
|
None,
|
|
"deep",
|
|
"prepend",
|
|
"replace",
|
|
"replace",
|
|
[{"name": "dedup", "options": {"keep": "last"}}],
|
|
],
|
|
)
|
|
@patch.object(
|
|
Templar, "template", side_effect=[deepcopy(merge_hash_data["low_dict"]), deepcopy(merge_hash_data["high_dict"])]
|
|
)
|
|
def test_merge_dict_deep_and_list_prepend_with_dedup_keep_last(
|
|
self, mock_set_options, mock_get_option, mock_template
|
|
):
|
|
results = self.merge_vars_lookup.run(
|
|
["__merge_dict_deep_and_list_prepend_with_dedup_keep_last"],
|
|
{
|
|
"testdict1__merge_dict_deep_and_list_prepend_with_dedup_keep_last": merge_hash_data["low_dict"],
|
|
"testdict2__merge_dict_deep_and_list_prepend_with_dedup_keep_last": merge_hash_data["high_dict"],
|
|
},
|
|
)
|
|
|
|
self.assertEqual(
|
|
results,
|
|
[
|
|
{
|
|
"a": {
|
|
"a": {
|
|
"x": "low_value",
|
|
"y": "high_value",
|
|
"list": ["high_value", "low_value"],
|
|
"z": "high_value",
|
|
}
|
|
},
|
|
"b": [4, {"5": "value"}, 1, 2, 3],
|
|
}
|
|
],
|
|
)
|