Get ready for opendev

.gitignore

@@ -0,0 +1,9 @@
+.tox
+.stestr
+*__pycache__*
+*.pyc
+build
+.unit-state.db
+*.swp
+.coverage
+cover

.testr.conf

@@ -0,0 +1,8 @@
+[DEFAULT]
+test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \
+             OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \
+             OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \
+             ${PYTHON:-python} -m subunit.run discover -t ./ ./unit_tests $LISTOPT $IDOPTION
+
+test_id_option=--load-list $IDFILE
+test_list_option=--list

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

interface.yaml

@@ -1,4 +1,4 @@
 name: magpie 
 summary: Interface used by the Magpie charm layer for peer network tests
 version: 1
-maintainer: "Andrew McLeod <andrew.mcleod@canonical.com>"
+maintainer: OpenStack Charmers <openstack-discuss@lists.openstack.org>

peers.py

@@ -1,3 +1,5 @@
+# Copyright 2020 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

test-requirements.txt

@@ -0,0 +1,6 @@
+# Lint and unit test requirements
+flake8
+os-testr>=0.4.1
+charms.reactive
+mock>=1.2
+coverage>=3.6

tox.ini

@@ -0,0 +1,51 @@
+[tox]
+envlist = pep8,py3
+skipsdist = True
+# NOTE(beisner): Avoid build/test env pollution by not enabling sitepackages.
+sitepackages = False
+# NOTE(beisner): Avoid false positives by not skipping missing interpreters.
+skip_missing_interpreters = False
+
+[testenv]
+setenv = VIRTUAL_ENV={envdir}
+         PYTHONHASHSEED=0
+install_command =
+  pip install {opts} {packages}
+commands = ostestr {posargs}
+
+[testenv:py3]
+basepython = python3
+deps = -r{toxinidir}/test-requirements.txt
+commands = ostestr {posargs}
+
+[testenv:py35]
+basepython = python3.5
+deps = -r{toxinidir}/test-requirements.txt
+commands = ostestr {posargs}
+
+[testenv:py36]
+basepython = python3.6
+deps = -r{toxinidir}/test-requirements.txt
+commands = ostestr {posargs}
+
+[testenv:py37]
+basepython = python3.7
+deps = -r{toxinidir}/test-requirements.txt
+commands = ostestr {posargs}
+
+[testenv:py38]
+basepython = python3.8
+deps = -r{toxinidir}/test-requirements.txt
+commands = ostestr {posargs}
+
+[testenv:pep8]
+basepython = python3
+deps = -r{toxinidir}/test-requirements.txt
+commands = flake8 {posargs}
+
+[testenv:venv]
+basepython = python3
+commands = {posargs}
+
+[flake8]
+ignore = E402,E226

unit_tests/test_peers.py

@@ -0,0 +1,214 @@
+# Copyright 2020 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 importlib
+import unittest
+import mock
+
+
+with mock.patch('charmhelpers.core.hookenv.metadata') as _meta:
+    _meta.return_Value = 'ss'
+    import peers
+
+
+_hook_args = {}
+
+TO_PATCH = [
+    'RelationBase',
+    'hook',
+]
+
+
+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 _unit_mock:
+    def __init__(self, unit_name, received=None):
+        self.unit_name = unit_name
+        self.received = received or {}
+
+
+class _relation_mock:
+    def __init__(self, application_name=None, units=None):
+        self.to_publish_raw = {}
+        self.application_name = application_name
+        self.units = units
+
+
+class TestMagpiePeers(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        cls._patched_hook = mock.patch('charms.reactive.hook', mock_hook)
+        cls._patched_hook_started = cls._patched_hook.start()
+        # force peers to rerun the mock_hook decorator:
+        importlib.reload(peers)
+
+    @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
+        importlib.reload(peers)
+
+    def patch(self, method):
+        _m = mock.patch.object(self.obj, method)
+        _mock = _m.start()
+        self.addCleanup(_m.stop)
+        return _mock
+
+    def get_fake_remote_data(self, conv_name):
+        def _get_fake_remote_data(key, default=None):
+            return self._remote_data[conv_name].get(key) or default
+        return _get_fake_remote_data
+
+    def get_fake_local_data(self, key, default=None):
+        return self._local_data.get(key) or default
+
+    def patch_mpeer(self, attr, return_value=None):
+        mocked = mock.patch.object(self.mpeer, attr)
+        self._patches[attr] = mocked
+        started = mocked.start()
+        started.return_value = return_value
+        self._patches_start[attr] = started
+        setattr(self, attr, started)
+
+    def setUp(self):
+        self._patches = {}
+        self._patches_start = {}
+        self.obj = peers
+        for method in TO_PATCH:
+            setattr(self, method, self.patch(method))
+        self._rel_ids = ["magpie:3"]
+        self._remote_data = {}
+        self._local_data = {}
+
+        conversations = []
+
+        def _init_conversation(conv_name, unit_name):
+            _conv = mock.MagicMock()
+            _conv.relation_ids = self._rel_ids
+            _conv.scope = unit_name
+            _conv.get_remote.side_effect = self.get_fake_remote_data(conv_name)
+            _conv.get_local.side_effect = self.get_fake_local_data
+            conversations.append(_conv)
+            self._remote_data[conv_name] = {}
+            return _conv
+
+        self._conversation1 = _init_conversation('conv1', 'magpie/1')
+        self._conversation2 = _init_conversation('conv2', 'magpie/2')
+
+        # The Relation object
+        self.mpeer = peers.MagpiePeers('magpie-relation', conversations)
+        self.patch_mpeer('conversations', conversations)
+        self.patch_mpeer('conversation', conversations[0])
+
+    def tearDown(self):
+        self.ncr = None
+        for k, v in self._patches.items():
+            v.stop()
+            setattr(self, k, None)
+        self._patches = None
+        self._patches_start = None
+
+    def test_registered_hooks(self):
+        # test that the decorators 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 = {
+            'joined': ('{peers:magpie}-relation-joined', ),
+            'departed': ('{peers:magpie}-relation-departed', ),
+        }
+        for k, v in _hook_args.items():
+            self.assertEqual(hook_patterns[k], v['args'])
+
+    def test_joined(self):
+        self.mpeer.joined()
+        self._conversation1.remove_state.assert_called_once_with(
+            '{relation_name}.departed')
+        self._conversation1.set_state.assert_called_once_with(
+            '{relation_name}.joined')
+
+    def test_departed(self):
+        self.mpeer.departed()
+        self._conversation1.remove_state.assert_called_once_with(
+            '{relation_name}.joined')
+        self._conversation1.set_state.assert_called_once_with(
+            '{relation_name}.departed')
+
+    def test_dismiess_departed(self):
+        self.mpeer.dismiss_departed()
+        self._conversation1.remove_state.assert_called_once_with(
+            '{relation_name}.departed')
+
+    def test_dismiess_joined(self):
+        self.mpeer.dismiss_joined()
+        self._conversation1.remove_state.assert_called_once_with(
+            '{relation_name}.joined')
+
+    def test_get_nodes(self):
+        self._remote_data['conv1'] = {'private-address': '10.0.0.10'}
+        self._remote_data['conv2'] = {'private-address': '10.0.0.11'}
+        self.assertEqual(
+            self.mpeer.get_nodes(),
+            [('magpie/1', '10.0.0.10'), ('magpie/2', '10.0.0.11')])
+
+    def test_set_iperf_checked(self):
+        self._remote_data['conv1'] = {'iperf.checked': 'True'}
+        self._remote_data['conv2'] = {'iperf.checked': 'True'}
+        self.mpeer.set_iperf_checked()
+        self._conversation1.set_remote.assert_called_once_with(
+            'iperf.checked', ['True magpie/1', 'True magpie/2'])
+        self._conversation2.set_remote.assert_called_once_with(
+            'iperf.checked', ['True magpie/1', 'True magpie/2'])
+
+    def test_get_iperf_checked(self):
+        self._remote_data['conv1'] = {'iperf.checked': 'True'}
+        self._remote_data['conv2'] = {'iperf.checked': 'True'}
+        self.assertEqual(
+            self.mpeer.get_iperf_checked(),
+            ['True', 'True'])
+
+    def test_set_iperf_server_ready(self):
+        self.mpeer.set_iperf_server_ready()
+        self._conversation1.set_remote.assert_called_once_with(
+            'iperf.server', True)
+        self._conversation2.set_remote.assert_called_once_with(
+            'iperf.server', True)
+
+    def test_set_iperf_server_checked(self):
+        self.mpeer.set_iperf_server_checked()
+        self._conversation1.set_remote.assert_called_once_with(
+            'iperf.server.checked')
+        self._conversation2.set_remote.assert_called_once_with(
+            'iperf.server.checked')
+
+    def test_check_ready_iperf_servers(self):
+        self._remote_data['conv1'] = {
+            'private-address': '10.0.0.10',
+            'iperf.server': True}
+        self._remote_data['conv2'] = {'private-address': '10.0.0.11'}
+        self.assertEqual(
+            self.mpeer.check_ready_iperf_servers(),
+            [('magpie/1', '10.0.0.10')])