diff --git a/.gitignore b/.gitignore index 172bf57..036328c 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ .tox +*.swp +.stestr +__pycache__ diff --git a/.stestr.conf b/.stestr.conf new file mode 100644 index 0000000..5fcccac --- /dev/null +++ b/.stestr.conf @@ -0,0 +1,3 @@ +[DEFAULT] +test_path=./unit_tests +top_dir=./ diff --git a/interface.yaml b/interface.yaml index d36e3e7..a930193 100644 --- a/interface.yaml +++ b/interface.yaml @@ -1,3 +1,11 @@ name: neutron-plugin-api-subordinate summary: Interface for intergrating Neutron SDN's with the neutron-api charm maintainer: OpenStack Charmers +repo: https://opendev.org/openstack/charm-interface-neutron-plugin-api-subordinate.git +ignore: + - 'unit_tests' + - '.stestr.conf' + - 'test-requirements.txt' + - 'tox.ini' + - '.gitignore' + - '.zuul.yaml' diff --git a/test-requirements.txt b/test-requirements.txt index 095ec9c..3d6178e 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,2 +1,5 @@ +charms.reactive flake8>=2.2.4,<=2.4.1 +mock os-testr>=0.4.1 +git+https://github.com/openstack/charms.openstack.git#egg=charms.openstack diff --git a/tox.ini b/tox.ini index 0caf8ec..5ea929f 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = pep8,py27,py37 +envlist = pep8,py3 skipsdist = True # NOTE(beisner): Avoid build/test env pollution by not enabling sitepackages. sitepackages = False @@ -14,21 +14,24 @@ commands = ostestr {posargs} [testenv:py27] basepython = python2.7 +# Reactive source charms are Python3-only, but a py27 unit test target +# is required by OpenStack Governance. Remove this shim as soon as +# permitted. https://governance.openstack.org/tc/reference/cti/python_cti.html +deps = +whitelist_externals = true +commands = true + +[testenv:py3] +basepython = python3 deps = -r{toxinidir}/test-requirements.txt -# TODO: Need to write unit tests then remove the following command. -commands = /bin/true [testenv:py36] basepython = python3.6 deps = -r{toxinidir}/test-requirements.txt -# TODO: Need to write unit tests then remove the following command. -commands = /bin/true [testenv:py37] basepython = python3.7 deps = -r{toxinidir}/test-requirements.txt -# TODO: Need to write unit tests then remove the following command. -commands = /bin/true [testenv:pep8] basepython = python3 diff --git a/unit_tests/__init__.py b/unit_tests/__init__.py new file mode 100644 index 0000000..c4df020 --- /dev/null +++ b/unit_tests/__init__.py @@ -0,0 +1,17 @@ +# Copyright 2019 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. +import charms_openstack.test_mocks + + +charms_openstack.test_mocks.mock_charmhelpers() diff --git a/unit_tests/test_provides.py b/unit_tests/test_provides.py new file mode 100644 index 0000000..f98fa17 --- /dev/null +++ b/unit_tests/test_provides.py @@ -0,0 +1,158 @@ +# Copyright 2019 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. +import json +import mock + +import charms_openstack.test_utils as test_utils + +import provides + + +_hook_args = {} + + +def mock_hook(*args, **kwargs): + + def inner(f): + # remember what we were passed. Note that we can't actually determine + # the class we're attached to, as the decorator only gets the function. + _hook_args[f.__name__] = dict(args=args, kwargs=kwargs) + return f + return inner + + +class TestNeutronPluginApiSubordinateProvides(test_utils.PatchHelper): + + @classmethod + def setUpClass(cls): + cls._patched_hook = mock.patch('charms.reactive.hook', mock_hook) + cls._patched_hook_started = cls._patched_hook.start() + # force providesto rerun the mock_hook decorator: + # try except is Python2/Python3 compatibility as Python3 has moved + # reload to importlib. + try: + reload(provides) + except NameError: + import importlib + importlib.reload(provides) + + @classmethod + def tearDownClass(cls): + cls._patched_hook.stop() + cls._patched_hook_started = None + cls._patched_hook = None + # and fix any breakage we did to the module + try: + reload(provides) + except NameError: + import importlib + importlib.reload(provides) + + def setUp(self): + self._patches = {} + self._patches_start = {} + conversation = mock.MagicMock() + self.target = provides.NeutronPluginAPISubordinate( + 'some-relation', [conversation]) + + def tearDown(self): + self.target = None + for k, v in self._patches.items(): + v.stop() + setattr(self, k, None) + self._patches = None + self._patches_start = None + + def patch_target(self, attr, return_value=None): + mocked = mock.patch.object(self.target, attr) + self._patches[attr] = mocked + started = mocked.start() + started.return_value = return_value + self._patches_start[attr] = started + setattr(self, attr, started) + + def patch_topublish(self): + self.patch_target('_relations') + relation = mock.MagicMock() + to_publish = mock.PropertyMock() + type(relation).to_publish = to_publish + self._relations.__iter__.return_value = [relation] + return relation.to_publish + + def test_registered_hooks(self): + # test that the hooks actually registered the relation expressions that + # are meaningful for this interface: this is to handle regressions. + # The keys are the function names that the hook attaches to. + hook_patterns = { + 'changed': ( + '{provides:neutron-plugin-api-subordinate}-' + 'relation-{joined,changed}', ), + 'broken': ( + '{provides:neutron-plugin-api-subordinate}-' + 'relation-{broken,departed}', ), + } + for k, v in _hook_args.items(): + self.assertEqual(hook_patterns[k], v['args']) + + def test_changed(self): + conversation = mock.MagicMock() + self.patch_target('conversation', conversation) + self.patch_target('set_state') + self.target.changed() + self.set_state.assert_has_calls([ + mock.call('{relation_name}.connected'), + mock.call('{relation_name}.available'), + ]) + + def test_broken(self): + conversation = mock.MagicMock() + self.patch_target('conversation', conversation) + self.patch_target('remove_state') + self.target.broken() + self.remove_state.assert_has_calls([ + mock.call('{relation_name}.available'), + mock.call('{relation_name}.connected'), + ]) + + def test_configure_plugin(self): + conversation = mock.MagicMock() + self.patch_target('conversation', conversation) + self.target.configure_plugin('aPlugin', + 'aCorePlugin', + 'aNeutronPluginConfig', + 'servicePlugins1,servicePlugin2', + {'aKey': 'aValue'}) + conversation.set_remote.assert_called_once_with( + **{ + 'core-plugin': 'aCorePlugin', + 'neutron-plugin': 'aPlugin', + 'neutron-plugin-config': 'aNeutronPluginConfig', + 'service-plugins': 'servicePlugins1,servicePlugin2', + 'subordinate_configuration': json.dumps({'aKey': 'aValue'})}, + ) + + def test_request_restart(self): + conversation = mock.MagicMock() + self.patch_target('conversation', conversation) + self.patch_object(provides.uuid, 'uuid4') + self.uuid4.return_value = 'fake-uuid' + self.target.request_restart() + conversation.set_remote.assert_called_once_with( + None, None, None, **{'restart-trigger': 'fake-uuid'}, + ) + conversation.set_remote.reset_mock() + self.target.request_restart('aServiceType') + conversation.set_remote.assert_called_once_with( + None, None, None, **{'restart-trigger-aServiceType': 'fake-uuid'}, + )