-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
salt/tests: Add unit tests for
metalk8s_etcd salt module
Add unit tests for `metalk8s_etcd` salt custom module, install etcd3 in pytest environment and mock all etcd3 call needed Refs: #2266
- Loading branch information
1 parent
a61c13c
commit 8d87fae
Showing
3 changed files
with
334 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,3 +3,4 @@ salt == 3000.3 | |
| salttesting == 2018.9.21 | ||
| mock == 3.0.5 | ||
| parameterized == 0.7.4 | ||
| etcd3 != 0.11.0 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,258 @@ | ||
| from parameterized import parameterized | ||
|
|
||
| from salt.exceptions import CommandExecutionError | ||
|
|
||
| from salttesting.mixins import LoaderModuleMockMixin | ||
| from salttesting.unit import TestCase | ||
| from salttesting.mock import MagicMock, patch | ||
| from salttesting.helpers import ForceImportErrorOn | ||
|
|
||
| import metalk8s_etcd | ||
|
|
||
| MEMBERS_LIST_DICT = [{ | ||
| "client_urls": [ | ||
| "https://10.11.12.13:2379" | ||
| ], | ||
| "id": "17971792102091431977L", | ||
| "name": "bootstrap", | ||
| "peer_urls": [ | ||
| "https://10.11.12.13:2380" | ||
| ] | ||
| }, { | ||
| "client_urls": [ | ||
| "https://10.11.12.14:2379" | ||
| ], | ||
| "id": "17971792102091431978L", | ||
| "name": "node1", | ||
| "peer_urls": [ | ||
| "https://10.11.12.14:2380", | ||
| "https://11.11.12.14:2380" | ||
| ] | ||
| }] | ||
| MEMBERS_LIST = [MagicMock(**member) for member in MEMBERS_LIST_DICT] | ||
| # Add special case for "name" as the "name" field is used by default | ||
| # by `MagicMock` | ||
| for i, member in enumerate(MEMBERS_LIST): | ||
| member.name = MEMBERS_LIST_DICT[i]["name"] | ||
|
|
||
|
|
||
| class Metalk8sEtcdTestCase(TestCase, LoaderModuleMockMixin): | ||
| """ | ||
| TestCase for `metalk8s_etcd` module | ||
| """ | ||
| loader_module = metalk8s_etcd | ||
|
|
||
| def test_virtual_success(self): | ||
| """ | ||
| Tests the return of `__virtual__` function, success | ||
| """ | ||
| reload(metalk8s_etcd) | ||
| self.assertEqual(metalk8s_etcd.__virtual__(), 'metalk8s_etcd') | ||
|
|
||
| def test_virtual_fail_import(self): | ||
| """ | ||
| Tests the return of `__virtual__` function, unable to import etcd3 | ||
| """ | ||
| with ForceImportErrorOn("etcd3"): | ||
| reload(metalk8s_etcd) | ||
| self.assertTupleEqual( | ||
| metalk8s_etcd.__virtual__(), | ||
| (False, "python-etcd3 not available") | ||
| ) | ||
|
|
||
| @parameterized.expand([ | ||
| (['minion1', 'minion2'], {'minion1': '10.11.12.13'}, True, '10.11.12.13'), | ||
| (['minion2'], {'minion1': '10.11.12.13', 'minion2': '10.11.12.14'}, True, '10.11.12.14'), | ||
| (['minion1', 'minion2'], {'minion1': '10.11.12.13', 'minion2': '10.11.12.14'}, True, '10.11.12.13'), | ||
| (['minion1', 'minion2'], {'minion1': '10.11.12.13', 'minion2': '10.11.12.14'}, [False, True], '10.11.12.14'), | ||
| (['minion1', 'minion2'], {'minion1': '10.11.12.13', 'minion2': '10.11.12.14'}, False, 'Unable to find an available etcd member in the cluster', True), | ||
| (['minion2'], {'minion1': '10.11.12.13'}, False, 'Unable to find an available etcd member in the cluster', True), | ||
| ([], {'minion1': '10.11.12.13'}, False, 'Unable to find an available etcd member in the cluster', True), | ||
| (['minion1'], {}, False, 'Unable to find an available etcd member in the cluster', True) | ||
| ]) | ||
| def test_get_endpoint_up(self, etcd_minions, cp_ips, status, | ||
| result, raises=False): | ||
| """ | ||
| Tests the return of `_get_endpoint_up` function | ||
| """ | ||
| def _saltutil_runner_mock(name, **kwargs): | ||
| if name == "mine.get": | ||
| if kwargs.get('fun') == "control_plane_ip": | ||
| return cp_ips | ||
| return None | ||
|
|
||
| def _etcd_status(): | ||
| result = status | ||
| if isinstance(status, list): | ||
| result = status.pop(0) | ||
| if result: | ||
| return True | ||
| else: | ||
| raise Exception("Unhealthy member") | ||
|
|
||
| patch_dict = { | ||
| "saltutil.runner": MagicMock(side_effect=_saltutil_runner_mock), | ||
| "metalk8s.minions_by_role": MagicMock(return_value=etcd_minions) | ||
| } | ||
| etcd3_mock = MagicMock() | ||
| status_mock = etcd3_mock.return_value.__enter__.return_value.status | ||
| status_mock.side_effect = _etcd_status | ||
| with patch.dict(metalk8s_etcd.__salt__, patch_dict), \ | ||
| patch("etcd3.client", etcd3_mock), \ | ||
| patch("etcd3.exceptions.ConnectionFailedError", Exception): | ||
| if raises: | ||
| self.assertRaisesRegexp( | ||
| Exception, | ||
| result, | ||
| metalk8s_etcd._get_endpoint_up, | ||
| "ca", "key", "cert" | ||
| ) | ||
| else: | ||
| self.assertEqual( | ||
| metalk8s_etcd._get_endpoint_up("ca", "key", "cert"), | ||
| result | ||
| ) | ||
| status_mock.assert_called() | ||
|
|
||
| @parameterized.expand([ | ||
| (), | ||
| ("10.11.12.13") | ||
| ]) | ||
| def test_add_etcd_node(self, endpoint=None): | ||
| """ | ||
| Tests the return of `add_etcd_node` function | ||
| """ | ||
| etcd3_mock = MagicMock() | ||
| add_member = etcd3_mock.return_value.__enter__.return_value.add_member | ||
| add_member.return_value = "my new node" | ||
| with patch("etcd3.client", etcd3_mock), \ | ||
| patch("metalk8s_etcd._get_endpoint_up", | ||
| MagicMock(return_value=endpoint)): | ||
| self.assertEqual( | ||
| metalk8s_etcd.add_etcd_node( | ||
| "10.11.12.14", | ||
| None if endpoint else "my_endpoint" | ||
| ), | ||
| "my new node" | ||
| ) | ||
| add_member.assert_called_once_with("10.11.12.14") | ||
|
|
||
| @parameterized.expand([ | ||
| (["https://10.11.12.13:2380"], MEMBERS_LIST, True), | ||
| (["https://10.11.12.13:2380"], MEMBERS_LIST, True, "10.11.12.13"), | ||
| (["https://10.11.12.13:2381"], MEMBERS_LIST, False), | ||
| ([], MEMBERS_LIST, True), | ||
| ([], [], True), | ||
| (["https://10.11.12.13:2380"], [], False), | ||
| (["https://10.11.12.14:2380", "https://11.11.12.14:2380"], MEMBERS_LIST, True), | ||
| (["https://10.11.12.14:2380", "https://11.11.12.14:2380"], MEMBERS_LIST, True), | ||
| (["https://10.11.12.13:2380", "https://10.11.12.13:2380"], MEMBERS_LIST, True), | ||
| (["https://10.11.12.14:2380", "https://10.11.12.14:2381"], MEMBERS_LIST, False) | ||
| ]) | ||
| def test_urls_exist_in_cluster(self, peer_urls, members, result, | ||
| endpoint=None): | ||
| """ | ||
| Tests the return of `urls_exist_in_cluster` function | ||
| """ | ||
| etcd3_mock = MagicMock() | ||
| etcd3_mock.return_value.__enter__.return_value.members = members | ||
| with patch("etcd3.client", etcd3_mock), \ | ||
| patch("metalk8s_etcd._get_endpoint_up", | ||
| MagicMock(return_value=endpoint)): | ||
| self.assertEqual( | ||
| metalk8s_etcd.urls_exist_in_cluster( | ||
| peer_urls, | ||
| None if endpoint else "my_endpoint" | ||
| ), | ||
| result | ||
| ) | ||
|
|
||
| @parameterized.expand([ | ||
| ({'minion1': 'https://10.11.12.13:2380'}, None, MEMBERS_LIST, True, "cluster is healthy", False), | ||
| (None, 'https://10.11.12.13:2380', MEMBERS_LIST, True, "cluster is healthy", False), | ||
| (None, 'https://10.11.12.13:2380', MEMBERS_LIST, [True, False], "cluster is degraded", True), | ||
| (None, 'https://10.11.12.13:2380', MEMBERS_LIST, False, "cluster is unavailable", True), | ||
| (None, 'https://10.11.12.13:2380', [], False, "cluster is unavailable", True) | ||
| ]) | ||
| def test_check_etcd_health(self, cp_ips, endpoint, members, status, | ||
| result, raises): | ||
| """ | ||
| Tests the return of `check_etcd_health` function | ||
| """ | ||
| def _saltutil_runner_mock(name, **kwargs): | ||
| if name == "mine.get": | ||
| if kwargs.get('fun') == "control_plane_ip": | ||
| return cp_ips | ||
| return None | ||
|
|
||
| def _etcd_status(): | ||
| result = status | ||
| if isinstance(status, list): | ||
| result = status.pop(0) | ||
| if result: | ||
| return True | ||
| else: | ||
| raise Exception("Unhealthy member") | ||
|
|
||
| etcd3_mock = MagicMock() | ||
| etcd3_mock.return_value.__enter__.return_value.members = members | ||
| etcd3_mock.return_value.__enter__.return_value.status.side_effect = \ | ||
| _etcd_status | ||
|
|
||
| patch_dict = { | ||
| "saltutil.runner": MagicMock(side_effect=_saltutil_runner_mock) | ||
| } | ||
| with patch.dict(metalk8s_etcd.__salt__, patch_dict), \ | ||
| patch("etcd3.client", etcd3_mock), \ | ||
| patch("metalk8s_etcd._get_endpoint_up", | ||
| MagicMock(return_value=endpoint)): | ||
| minion_id = "minion1" if cp_ips else None | ||
| if raises: | ||
| self.assertRaisesRegexp( | ||
| CommandExecutionError, | ||
| result, | ||
| metalk8s_etcd.check_etcd_health, | ||
| minion_id, | ||
| ca_cert="ca", cert_key="key", cert_cert="cert" | ||
| ) | ||
| else: | ||
| self.assertEqual( | ||
| metalk8s_etcd.check_etcd_health( | ||
| minion_id, | ||
| ca_cert="ca", cert_key="key", cert_cert="cert" | ||
| ), | ||
| result | ||
| ) | ||
| etcd3_mock.assert_any_call( | ||
| host=cp_ips[minion_id] if minion_id else endpoint, | ||
| ca_cert="ca", cert_key="key", cert_cert="cert", timeout=30 | ||
| ) | ||
|
|
||
| @parameterized.expand([ | ||
| (MEMBERS_LIST, MEMBERS_LIST_DICT), | ||
| (MEMBERS_LIST, MEMBERS_LIST_DICT, "10.11.12.13"), | ||
| (MEMBERS_LIST, [], Exception("No endpoint up")), | ||
| ([], []), | ||
| ([], [], "10.11.12.13") | ||
| ]) | ||
| def test_get_etcd_member_list(self, members, result, endpoint=None): | ||
| """ | ||
| Tests the return of `get_etcd_member_list` function | ||
| """ | ||
| def _get_endpoint(*args, **kwargs): | ||
| if isinstance(endpoint, Exception): | ||
| raise endpoint | ||
| return endpoint | ||
|
|
||
| etcd3_mock = MagicMock() | ||
| etcd3_mock.return_value.__enter__.return_value.members = members | ||
|
|
||
| with patch("etcd3.client", etcd3_mock), \ | ||
| patch("metalk8s_etcd._get_endpoint_up", | ||
| MagicMock(side_effect=_get_endpoint)): | ||
| self.assertEqual( | ||
| metalk8s_etcd.get_etcd_member_list( | ||
| None if endpoint else "my_endpoint" | ||
| ), | ||
| result | ||
| ) |