Files
charm-nova-cloud-controller/unit_tests/test_actions.py
Hervé Beraud 71bc319326 Use unittest.mock instead of mock
The mock third party library was needed for mock support in py2
runtimes. Since we now only support py36 and later, we can use the
standard lib unittest.mock module instead.

Note that https://github.com/openstack/charms.openstack is used during tests
and he need `mock`, unfortunatelly it doesn't declare `mock` in its
requirements so it retrieve mock from other charm project (cross dependency).
So we depend on charms.openstack first and when
Ib1ed5b598a52375e29e247db9ab4786df5b6d142 will be merged then CI
will pass without errors.

Depends-On: Ib1ed5b598a52375e29e247db9ab4786df5b6d142
Change-Id: Id925078c5c04c2f89a570bdf7171c666839f9e40
2021-12-15 14:16:56 +00:00

357 lines
13 KiB
Python

# Copyright 2016 Canonical Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from unittest import mock
from unit_tests.test_utils import (
CharmTestCase,
get_default_config,
)
import charmhelpers.core.unitdata
__default_config = get_default_config()
# NOTE(freyes): the default 'distro' makes the test suite behave different
# depending on where it's being executed
__default_config['openstack-origin'] = ''
import hooks.nova_cc_utils as utils # noqa
import actions.actions as actions
TO_PATCH = [
]
class PauseTestCase(CharmTestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
charmhelpers.core.unitdata._KV = (
charmhelpers.core.unitdata.Storage(':memory:'))
def setUp(self):
super(PauseTestCase, self).setUp(
actions,
[
"hooks.nova_cc_utils.register_configs",
"hooks.nova_cc_utils.pause_unit_helper"
])
self.register_configs.return_value = 'test-config'
def test_pauses_services(self):
actions.pause([])
self.pause_unit_helper.assert_called_once_with('test-config')
class ResumeTestCase(CharmTestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
charmhelpers.core.unitdata._KV = (
charmhelpers.core.unitdata.Storage(':memory:'))
def setUp(self):
super(ResumeTestCase, self).setUp(
actions, [
"hooks.nova_cc_utils.register_configs",
"hooks.nova_cc_utils.resume_unit_helper"
])
self.register_configs.return_value = 'test-config'
def test_resumes_services(self):
actions.resume([])
self.resume_unit_helper.assert_called_once_with('test-config')
class ClearUnitKnownhostCacheTestCase(CharmTestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
charmhelpers.core.unitdata._KV = (
charmhelpers.core.unitdata.Storage(':memory:'))
@staticmethod
def _relation_get(attribute=None, unit=None, rid=None):
return {
'aservice/1': '10.0.0.1',
'aservice/2': '10.0.0.2',
'aservice/3': '10.0.0.3',
'aservice/4': '10.0.0.4',
'bservice/1': '10.0.1.1',
'bservice/2': '10.0.1.2',
'bservice/3': '10.0.1.3',
}.get(unit)
def setUp(self):
super(ClearUnitKnownhostCacheTestCase, self).setUp(
actions, [
"charmhelpers.core.hookenv.action_get",
"charmhelpers.core.hookenv.action_set",
"charmhelpers.core.hookenv.relation_ids",
"charmhelpers.core.hookenv.related_units",
"charmhelpers.core.hookenv.relation_get",
"hooks.nova_cc_utils.clear_hostset_cache_for",
"hooks.nova_cc_hooks.update_ssh_key",
"hooks.nova_cc_hooks.notify_ssh_keys_to_compute_units",
])
self.relation_ids.return_value = ["r:1", "r:2"]
self.related_units.side_effect = [
['aservice/1', 'aservice/2', 'aservice/3', 'aservice/4'],
['bservice/1', 'bservice/2', 'bservice/3'],
]
self.relation_get.side_effect = \
ClearUnitKnownhostCacheTestCase._relation_get
def test_target_unit(self):
self.action_get.return_value = 'aservice/2'
actions.clear_unit_knownhost_cache([])
self.action_set.assert_called_once_with({
"units-updated": [{'aservice/2': '10.0.0.2'}]
})
self.clear_hostset_cache_for.assert_called_once_with('10.0.0.2')
self.update_ssh_key.assert_called_once_with(rid="r:1",
unit="aservice/2")
self.notify_ssh_keys_to_compute_units.assert_called_once_with(
rid="r:1", unit="aservice/4")
def test_target_service(self):
self.action_get.return_value = 'bservice'
actions.clear_unit_knownhost_cache([])
self.action_set.assert_called_once_with({
"units-updated": [
{'bservice/1': '10.0.1.1'},
{'bservice/2': '10.0.1.2'},
{'bservice/3': '10.0.1.3'},
]
})
self.clear_hostset_cache_for.assert_has_calls(
[mock.call('10.0.1.1'),
mock.call('10.0.1.2'),
mock.call('10.0.1.3')])
self.update_ssh_key.assert_has_calls(
[mock.call(rid="r:2", unit="bservice/1"),
mock.call(rid="r:2", unit="bservice/2"),
mock.call(rid="r:2", unit="bservice/3")])
self.notify_ssh_keys_to_compute_units.assert_has_calls(
[mock.call(rid="r:2", unit="bservice/3")])
def test_target_all(self):
self.action_get.return_value = ''
actions.clear_unit_knownhost_cache([])
self.action_set.assert_called_once_with({
"units-updated": [
{'aservice/1': '10.0.0.1'},
{'aservice/2': '10.0.0.2'},
{'aservice/3': '10.0.0.3'},
{'aservice/4': '10.0.0.4'},
{'bservice/1': '10.0.1.1'},
{'bservice/2': '10.0.1.2'},
{'bservice/3': '10.0.1.3'},
]
})
# check both services were updated; that'll imply the other calls were
# made.
self.notify_ssh_keys_to_compute_units.assert_has_calls(
[mock.call(rid="r:1", unit="aservice/4"),
mock.call(rid="r:2", unit="bservice/3")])
class SyncComputeAvailabilityZonesTestCase(CharmTestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
charmhelpers.core.unitdata._KV = (
charmhelpers.core.unitdata.Storage(':memory:'))
@staticmethod
def _relation_get(attribute=None, unit=None, rid=None):
return {
'aservice/0': {
'private-address': '10.0.0.1',
'availability_zone': 'site-a',
},
'aservice/1': {
'private-address': '10.0.0.2',
'availability_zone': 'site-b',
},
'aservice/2': {
'private-address': '10.0.0.3',
},
'bservice/0': {
'private-address': '10.0.1.1',
'availability_zone': 'site-c',
},
'bservice/1': {
'private-address': '10.0.1.2',
'availability_zone': 'site-d',
},
}.get(unit)
def setUp(self):
super(SyncComputeAvailabilityZonesTestCase, self).setUp(
actions, [
"charmhelpers.core.hookenv.action_fail",
"charmhelpers.core.hookenv.action_set",
"charmhelpers.core.hookenv.relation_ids",
"charmhelpers.core.hookenv.related_units",
"charmhelpers.core.hookenv.relation_get",
"charmhelpers.contrib.openstack.utils.os_release",
"hooks.nova_cc_context.IdentityServiceContext",
"keystoneauth1.session.Session",
"keystoneauth1.identity.v3.Password",
"novaclient.client.Client",
])
self.relation_ids.return_value = ["r:1", "r:2"]
self.related_units.side_effect = [
['aservice/0', 'aservice/1', 'aservice/2'],
['bservice/0', 'bservice/1'],
]
self.relation_get.side_effect = \
SyncComputeAvailabilityZonesTestCase._relation_get
self.os_release.return_value = 'ussuri'
def test_failing_action(self):
self.IdentityServiceContext.return_value.return_value = {}
actions.sync_compute_availability_zones([])
self.IdentityServiceContext.assert_called_once()
self.action_fail.assert_called_once()
self.action_set.assert_not_called()
def test_early_release(self):
self.os_release.return_value = 'queens'
actions.sync_compute_availability_zones([])
self.action_fail.assert_called_once()
self.action_set.assert_not_called()
self.IdentityServiceContext.assert_not_called()
def test_sync_compute_az(self):
keystone_auth = {
'auth_url': 'http://127.0.0.1:5000/v3',
'username': 'test-user',
'password': 'test-password',
'user_domain_name': 'test-user-domain',
'project_domain_name': 'test-project-domain',
'project_name': 'test-project',
}
self.IdentityServiceContext.return_value.return_value = {
'keystone_authtoken': keystone_auth
}
self.Password.return_value = 'v3-password-instance'
self.Session.return_value = 'keystone-session'
aggregate_mocks = [
mock.MagicMock(hosts=[]),
mock.MagicMock(hosts=[]),
mock.MagicMock(hosts=[]),
mock.MagicMock(hosts=[]),
]
self.Client.return_value.aggregates.find.side_effect = aggregate_mocks
self.Client.return_value.hypervisors.find.side_effect = [
mock.MagicMock(hypervisor_hostname='node-1'),
mock.MagicMock(hypervisor_hostname='node-2'),
mock.MagicMock(hypervisor_hostname='node-3'),
mock.MagicMock(hypervisor_hostname='node-4'),
]
actions.sync_compute_availability_zones([])
self.IdentityServiceContext.assert_called_once()
self.Password.assert_called_once_with(**keystone_auth)
self.Session.assert_called_once_with(auth='v3-password-instance')
self.Client.assert_called_once_with(2, session='keystone-session')
self.relation_ids.assert_called_once_with('cloud-compute')
self.related_units.has_calls([
mock.call('r:1'),
mock.call('r:2')
])
self.relation_get.has_calls([
mock.call(rid='r:1', unit='aservice/0'),
mock.call(rid='r:1', unit='aservice/1'),
mock.call(rid='r:1', unit='aservice/2'),
mock.call(rid='r:2', unit='bservice/0'),
mock.call(rid='r:2', unit='bservice/1'),
])
self.Client.aggregates.find.has_calls([
mock.call(name='site-a_az', availability_zone='site-a'),
mock.call(name='site-b_az', availability_zone='site-b'),
mock.call(name='site-c_az', availability_zone='site-c'),
mock.call(name='site-d_az', availability_zone='site-d'),
])
self.Client.hypervisors.find.has_calls([
mock.call(host_ip='10.0.0.1'),
mock.call(host_ip='10.0.0.2'),
mock.call(host_ip='10.0.1.1'),
mock.call(host_ip='10.0.1.2'),
])
self.Client.aggregates.add_host.has_calls([
mock.call(aggregate_mocks[0], 'node-1'),
mock.call(aggregate_mocks[1], 'node-2'),
mock.call(aggregate_mocks[2], 'node-3'),
mock.call(aggregate_mocks[3], 'node-4'),
])
self.action_set.assert_called_with({
'output': ('Hypervisor node-1 added to availability zone site-a\n'
'Hypervisor node-2 added to availability zone site-b\n'
'Hypervisor node-3 added to availability zone site-c\n'
'Hypervisor node-4 added to availability zone site-d\n')
})
class MainTestCase(CharmTestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
charmhelpers.core.unitdata._KV = (
charmhelpers.core.unitdata.Storage(':memory:'))
def setUp(self):
super(MainTestCase, self).setUp(
actions,
[
"charmhelpers.core.hookenv.action_fail",
"hooks.nova_cc_utils.register_configs",
])
self.register_configs.return_value = 'test-config'
def test_invokes_action(self):
dummy_calls = []
def dummy_action(args):
dummy_calls.append(True)
with mock.patch.dict(actions.ACTIONS, {"foo": dummy_action}):
actions.main(["foo"])
self.assertEqual(dummy_calls, [True])
def test_unknown_action(self):
"""Unknown actions aren't a traceback."""
exit_string = actions.main(["foo"])
self.assertEqual("Action foo undefined", exit_string)
def test_failing_action(self):
"""Actions which traceback trigger action_fail() calls."""
dummy_calls = []
self.action_fail.side_effect = dummy_calls.append
def dummy_action(args):
raise ValueError("uh oh")
with mock.patch.dict(actions.ACTIONS, {"foo": dummy_action}):
actions.main(["foo"])
self.assertEqual(dummy_calls, ["uh oh"])