Add zaza namespacing, starting with openstack

doc/source/cli-utils.rst

@@ -1,5 +1,5 @@
 CLI Utilities
 -------------
 
-.. automodule:: zaza.utilities.cli
+.. automodule:: zaza.openstack.utilities.cli
    :members:

doc/source/exception-utils.rst

@@ -1,5 +1,5 @@
 Utility Exceptions
 ------------------
 
-.. automodule:: zaza.utilities.exceptions
+.. automodule:: zaza.openstack.utilities.exceptions
    :members:

doc/source/generic-utils.rst

@@ -1,5 +1,5 @@
 Generic Utilities
 -----------------
 
-.. automodule:: zaza.utilities.generic
+.. automodule:: zaza.openstack.utilities.generic
    :members:

doc/source/juju-utils.rst

@@ -1,5 +1,5 @@
 Juju Utilities
 --------------
 
-.. automodule:: zaza.utilities.juju
+.. automodule:: zaza.openstack.utilities.juju
    :members:

doc/source/openstack-utils.rst

@@ -1,5 +1,5 @@
 OpenStack Utilities
 -------------------
 
-.. automodule:: zaza.utilities.openstack
+.. automodule:: zaza.openstack.utilities.openstack
    :members:

doc/source/tls-cert-utils.rst

@@ -1,5 +1,5 @@
 TLS Certificate Utilities
 -------------------------
 
-.. automodule:: zaza.utilities.cert
+.. automodule:: zaza.openstack.utilities.cert
    :members:

setup.py

@@ -102,7 +102,7 @@ def run_tests(self):
             'functest-test = zaza.charm_lifecycle.test:main',
             'current-apps = zaza.model:main',
             'tempest-config = zaza.tempest_config:main',
-            'remove-placement = zaza.utilities.bundle:main',
+            'remove-placement = zaza.openstack.utilities.bundle:main',
         ]
     },
     license='Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0',

tests/tests.yaml

@@ -6,6 +6,6 @@ target_deploy_status:
     workload-status: active
     workload-status-message: icmp ok, local hostname ok, dns ok
 configure:
-- zaza.charm_tests.noop.setup.basic_setup
+- zaza.openstack.charm_tests.noop.setup.basic_setup
 tests:
-- zaza.charm_tests.noop.tests.NoopTest
+- zaza.openstack.charm_tests.noop.tests.NoopTest

unit_tests/utilities/test_zaza_utilities_bundle.py

@@ -15,7 +15,7 @@
 # import mock
 
 import unit_tests.utils as ut_utils
-import zaza.utilities.bundle as bundle
+import zaza.openstack.utilities.bundle as bundle
 
 import yaml
 

unit_tests/utilities/test_zaza_utilities_ceph.py

@@ -1,7 +1,7 @@
 import unit_tests.utils as ut_utils
 import zaza.model as model
-import zaza.utilities.ceph as ceph_utils
-import zaza.utilities.openstack as openstack_utils
+import zaza.openstack.utilities.ceph as ceph_utils
+import zaza.openstack.utilities.openstack as openstack_utils
 
 
 class TestCephUtils(ut_utils.BaseTestCase):

unit_tests/utilities/test_zaza_utilities_cert.py

@@ -15,7 +15,7 @@
 import mock
 
 import unit_tests.utils as ut_utils
-import zaza.utilities.cert as cert
+import zaza.openstack.utilities.cert as cert
 
 TEST_SSH_PRIVATE_KEY = """
 -----BEGIN RSA PRIVATE KEY-----

unit_tests/utilities/test_zaza_utilities_cli.py

@@ -14,7 +14,7 @@
 
 import mock
 import unit_tests.utils as ut_utils
-from zaza.utilities import cli as cli_utils
+from zaza.openstack.utilities import cli as cli_utils
 
 
 class TestCLIUtils(ut_utils.BaseTestCase):

unit_tests/utilities/test_zaza_utilities_file_assertions.py

@@ -14,15 +14,15 @@
 
 import mock
 import unit_tests.utils as ut_utils
-import zaza.utilities.file_assertions as file_assertions
+import zaza.openstack.utilities.file_assertions as file_assertions
 
 
 class TestFileAssertionUtils(ut_utils.BaseTestCase):
     def setUp(self):
         super(TestFileAssertionUtils, self).setUp()
         # Patch all run_on_unit calls
         self.patch(
-            'zaza.utilities.file_assertions.model.run_on_unit',
+            'zaza.openstack.utilities.file_assertions.model.run_on_unit',
             new_callable=mock.MagicMock(),
             name='run_on_unit'
         )

unit_tests/utilities/test_zaza_utilities_generic.py

@@ -14,8 +14,8 @@
 
 import mock
 import unit_tests.utils as ut_utils
-from zaza.utilities import generic as generic_utils
-import zaza.utilities.exceptions as zaza_exceptions
+from zaza.openstack.utilities import generic as generic_utils
+import zaza.openstack.utilities.exceptions as zaza_exceptions
 
 FAKE_STATUS = {
     'can-upgrade-to': '',
@@ -43,7 +43,7 @@ def setUp(self):
         super(TestGenericUtils, self).setUp()
         # Patch all subprocess calls
         self.patch(
-            'zaza.utilities.generic.subprocess',
+            'zaza.openstack.utilities.generic.subprocess',
             new_callable=mock.MagicMock(),
             name='subprocess'
         )
@@ -372,7 +372,7 @@ def test_set_dpkg_non_interactive_on_unit(self):
 
     def test_get_process_id_list(self):
         self.patch(
-            "zaza.utilities.generic.model.run_on_unit",
+            "zaza.openstack.utilities.generic.model.run_on_unit",
             new_callable=mock.MagicMock(),
             name="_run"
         )
@@ -410,7 +410,7 @@ def test_get_process_id_list(self):
 
     def test_get_unit_process_ids(self):
         self.patch(
-            "zaza.utilities.generic.get_process_id_list",
+            "zaza.openstack.utilities.generic.get_process_id_list",
             new_callable=mock.MagicMock(),
             name="_get_pids"
         )

unit_tests/utilities/test_zaza_utilities_juju.py

@@ -14,7 +14,7 @@
 
 import mock
 import unit_tests.utils as ut_utils
-from zaza.utilities import juju as juju_utils
+from zaza.openstack.utilities import juju as juju_utils
 
 
 class TestJujuUtils(ut_utils.BaseTestCase):
@@ -257,7 +257,7 @@ def test_leader_get_fails(self):
 
     def test_get_machine_series(self):
         self.patch(
-            'zaza.utilities.juju.get_machine_status',
+            'zaza.openstack.utilities.juju.get_machine_status',
             new_callable=mock.MagicMock(),
             name='_get_machine_status'
         )

unit_tests/utilities/test_zaza_utilities_openstack.py

@@ -19,8 +19,8 @@
 import tenacity
 
 import unit_tests.utils as ut_utils
-from zaza.utilities import openstack as openstack_utils
-from zaza.utilities import exceptions
+from zaza.openstack.utilities import openstack as openstack_utils
+from zaza.openstack.utilities import exceptions
 
 
 class TestOpenStackUtils(ut_utils.BaseTestCase):
@@ -444,7 +444,9 @@ def test_upload_image_to_glance(self):
         image_mock = mock.MagicMock(id='9d1125af')
         glance_mock.images.create.return_value = image_mock
         m = mock.mock_open()
-        with mock.patch('zaza.utilities.openstack.open', m, create=False) as f:
+        with mock.patch(
+            'zaza.openstack.utilities.openstack.open', m, create=False
+        ) as f:
             openstack_utils.upload_image_to_glance(
                 glance_mock,
                 '/tmp/im1.img',
@@ -540,7 +542,9 @@ def test_get_private_key_file(self):
 
     def test_write_private_key(self):
         m = mock.mock_open()
-        with mock.patch('zaza.utilities.openstack.open', m, create=False):
+        with mock.patch(
+            'zaza.openstack.utilities.openstack.open', m, create=False
+        ):
             openstack_utils.write_private_key('mykeys', 'keycontents')
         m.assert_called_once_with('tests/id_rsa_mykeys', 'w')
         handle = m()
@@ -550,7 +554,9 @@ def test_get_private_key(self):
         self.patch_object(openstack_utils.os.path, "isfile",
                           return_value=True)
         m = mock.mock_open(read_data='myprivkey')
-        with mock.patch('zaza.utilities.openstack.open', m, create=True):
+        with mock.patch(
+            'zaza.openstack.utilities.openstack.open', m, create=True
+        ):
             self.assertEqual(
                 openstack_utils.get_private_key('mykeys'),
                 'myprivkey')
@@ -725,17 +731,17 @@ def test_neutron_bgp_speaker_appears_not_on_agent(self):
 
     def test_get_current_openstack_release_pair(self):
         self.patch(
-            'zaza.utilities.openstack.get_current_os_versions',
+            'zaza.openstack.utilities.openstack.get_current_os_versions',
             new_callable=mock.MagicMock(),
             name='_get_os_version'
         )
         self.patch(
-            'zaza.utilities.juju.get_machines_for_application',
+            'zaza.openstack.utilities.juju.get_machines_for_application',
             new_callable=mock.MagicMock(),
             name='_get_machines'
         )
         self.patch(
-            'zaza.utilities.juju.get_machine_series',
+            'zaza.openstack.utilities.juju.get_machine_series',
             new_callable=mock.MagicMock(),
             name='_get_machine_series'
         )
@@ -771,7 +777,7 @@ def test_get_current_openstack_release_pair(self):
 
     def test_get_openstack_release(self):
         self.patch(
-            'zaza.utilities.openstack.get_current_os_release_pair',
+            'zaza.openstack.utilities.openstack.get_current_os_release_pair',
             new_callable=mock.MagicMock(),
             name='_get_os_rel_pair'
         )

zaza/__init__.py

@@ -14,6 +14,10 @@
 
 """Functions to support converting async function to a sync equivalent."""
 import asyncio
+from pkgutil import extend_path
+
+
+__path__ = extend_path(__path__, __name__)
 
 
 def run(*steps):

zaza/openstack/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2018 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.
+
+"""OpenStack specific zaza functionality."""

zaza/charm_tests/barbican_vault/tests.py → zaza/openstack/charm_tests/barbican_vault/tests.py

@@ -15,7 +15,7 @@
 """Encapsulate barbican-vault testing."""
 
 import zaza
-import zaza.charm_tests.vault.tests as vault_tests
+import zaza.openstack.charm_tests.vault.tests as vault_tests
 
 
 class BarbicanVaultUnsealVault(vault_tests.UnsealVault):

zaza/charm_tests/ceph/osd/tests.py → zaza/openstack/charm_tests/ceph/osd/tests.py

@@ -17,7 +17,7 @@
 import logging
 import unittest
 
-import zaza.charm_tests.test_utils as test_utils
+import zaza.openstack.charm_tests.test_utils as test_utils
 import zaza.model as zaza_model
 
 

zaza/charm_tests/ceph/rbd_mirror/tests.py → zaza/openstack/charm_tests/ceph/rbd_mirror/tests.py

@@ -17,13 +17,13 @@
 import logging
 import re
 
-import zaza.charm_tests.test_utils as test_utils
+import zaza.openstack.charm_tests.test_utils as test_utils
 
 import zaza.model
-import zaza.utilities.ceph
-import zaza.utilities.openstack
+import zaza.openstack.utilities.ceph
+import zaza.openstack.utilities.openstack as openstack
 
-from zaza.charm_tests.glance.setup import LTS_IMAGE_NAME
+from zaza.openstack.charm_tests.glance.setup import LTS_IMAGE_NAME
 
 
 class CephRBDMirrorBase(test_utils.OpenStackBaseTest):
@@ -55,11 +55,11 @@ def get_pools(self):
         :returns: Tuple with list of pools on each side.
         :rtype: tuple
         """
-        site_a_pools = zaza.utilities.ceph.get_ceph_pools(
+        site_a_pools = zaza.openstack.utilities.ceph.get_ceph_pools(
             zaza.model.get_lead_unit_name(
                 'ceph-mon', model_name=self.site_a_model),
             model_name=self.site_a_model)
-        site_b_pools = zaza.utilities.ceph.get_ceph_pools(
+        site_b_pools = zaza.openstack.utilities.ceph.get_ceph_pools(
             zaza.model.get_lead_unit_name(
                 'ceph-mon' + self.site_b_app_suffix,
                 model_name=self.site_b_model),
@@ -193,9 +193,9 @@ def test_cinder_volume_mirrored(self):
         site B and subsequently comparing the contents we get a full end to end
         test.
         """
-        session = zaza.utilities.openstack.get_overcloud_keystone_session()
-        glance = zaza.utilities.openstack.get_glance_session_client(session)
-        cinder = zaza.utilities.openstack.get_cinder_session_client(session)
+        session = openstack.get_overcloud_keystone_session()
+        glance = openstack.get_glance_session_client(session)
+        cinder = openstack.get_cinder_session_client(session)
 
         image = next(glance.images.list(name=LTS_IMAGE_NAME))
 
@@ -210,7 +210,7 @@ def create_volume_from_image(cinder, image, retry=5):
                 return
             volume = cinder.volumes.create(8, name='zaza', imageRef=image.id)
             try:
-                zaza.utilities.openstack.resource_reaches_status(
+                openstack.resource_reaches_status(
                     cinder.volumes, volume.id, msg='volume')
                 return volume
             except AssertionError:
@@ -219,7 +219,7 @@ def create_volume_from_image(cinder, image, retry=5):
                 return create_volume_from_image(cinder, image, retry=retry - 1)
         volume = create_volume_from_image(cinder, image)
 
-        site_a_hash = zaza.utilities.ceph.get_rbd_hash(
+        site_a_hash = zaza.openstack.utilities.ceph.get_rbd_hash(
             zaza.model.get_lead_unit_name('ceph-mon',
                                           model_name=self.site_a_model),
             'cinder-ceph',
@@ -230,7 +230,7 @@ def create_volume_from_image(cinder, image, retry=5):
             check_entries_behind_master=True,
             application_name=self.application_name + self.site_b_app_suffix,
             model_name=self.site_b_model)
-        site_b_hash = zaza.utilities.ceph.get_rbd_hash(
+        site_b_hash = zaza.openstack.utilities.ceph.get_rbd_hash(
             zaza.model.get_lead_unit_name('ceph-mon' + self.site_b_app_suffix,
                                           model_name=self.site_b_model),
             'cinder-ceph',

zaza/charm_tests/ceph/tests.py → zaza/openstack/charm_tests/ceph/tests.py

@@ -26,13 +26,13 @@
 
 from swiftclient.exceptions import ClientException
 
-import zaza.charm_tests.test_utils as test_utils
+import zaza.openstack.charm_tests.test_utils as test_utils
 import zaza.model as zaza_model
-import zaza.utilities.ceph as zaza_ceph
-import zaza.utilities.exceptions as zaza_exceptions
-import zaza.utilities.generic as zaza_utils
-import zaza.utilities.juju as zaza_juju
-import zaza.utilities.openstack as zaza_openstack
+import zaza.openstack.utilities.ceph as zaza_ceph
+import zaza.openstack.utilities.exceptions as zaza_exceptions
+import zaza.openstack.utilities.generic as zaza_utils
+import zaza.openstack.utilities.juju as zaza_juju
+import zaza.openstack.utilities.openstack as zaza_openstack
 
 
 class CephLowLevelTest(test_utils.OpenStackBaseTest):