Adds deployment via snapshot

New arguments are added to allow snapshot deployment:
--snapshot, --snap-cache

The previous tripleo-quickstart code has been removed/replaced
with the snapshot option.

Snapshot deployments are supported on CentOS and Fedora, and snapshot
artifacts use a similar caching system as the standard deployment.
Snapshots are produced daily by Apex, and include latest as well as n-1
OpenStack versions. The os-odl-nofeature scenario is used for the
snapshots. Additionally multiple topology verions of Snapshots are
available. The Snapshot pulled at deploy time depends on the
deploy-settings and number of virtual-computes used at deploy time.

Since there is only one network used with snapshot deployments (admin),
there is no reason to pass in network settings for snapshot deployments.
That argument is now optional. Previously we required even in Standard
virtual deployments that the network settings be provided. However that
is also unnecessary, as we can default to the virtual network settings.

Includes minor fix to the tox.ini to allow specifying test cases
to run (useful for developers writing tests). Default behavior of
tox is unchanged.

JIRA: APEX-548

Change-Id: I1e08c4e54eac5aae99921f61ab7f69693ed12b47
Signed-off-by: Tim Rozet <trozet@redhat.com>

1 files changed, 374 insertions, 0 deletions

diff --git a/apex/tests/test_apex_deployment_snapshot.py b/apex/tests/test_apex_deployment_snapshot.py
new file mode 100644
index 00000000..d7542585
--- /dev/null
+++ b/apex/tests/test_apex_deployment_snapshot.py
@@ -0,0 +1,374 @@
+##############################################################################
+# Copyright (c) 2018 Tim Rozet (trozet@redhat.com) (Red Hat)
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+from mock import patch
+import os
+import unittest
+import urllib.request
+
+from apex.common import exceptions as exc
+from apex.deployment.snapshot import SnapshotDeployment
+from apex.settings.deploy_settings import DeploySettings
+from apex.tests.constants import TEST_DUMMY_CONFIG
+
+DUMMY_SNAP_DIR = '/tmp/dummy_cache'
+
+
+class TestSnapshotDeployment(unittest.TestCase):
+    @classmethod
+    def setup_class(cls):
+        """This method is run once for each class before any tests are run"""
+
+    @classmethod
+    def teardown_class(cls):
+        """This method is run once for each class _after_ all tests are run"""
+
+    def setup(self):
+        """This method is run once before _each_ test method is executed"""
+
+    def teardown(self):
+        """This method is run once after _each_ test method is executed"""
+
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_init(self, mock_deploy_snap, mock_libvirt_open, mock_pull_snap):
+
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=True, all_in_one=False)
+        snap_dir = os.path.join(DUMMY_SNAP_DIR, 'queens', 'noha')
+        self.assertEqual(d.snap_cache_dir, snap_dir)
+        mock_pull_snap.assert_called()
+        mock_deploy_snap.assert_called()
+        self.assertEqual(d.ha_ext, 'noha')
+
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_init_allinone_no_fetch(self, mock_deploy_snap, mock_libvirt_open,
+                                    mock_pull_snap):
+
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=True)
+        snap_dir = os.path.join(DUMMY_SNAP_DIR, 'queens', 'noha-allinone')
+        self.assertEqual(d.snap_cache_dir, snap_dir)
+        mock_pull_snap.assert_not_called()
+        mock_deploy_snap.assert_called()
+        self.assertEqual(d.ha_ext, 'noha-allinone')
+
+    @patch('apex.deployment.snapshot.utils.fetch_upstream_and_unpack')
+    @patch('apex.deployment.snapshot.utils.fetch_properties')
+    def test_pull_snapshot_is_latest(self, mock_fetch_props,
+                                     mock_fetch_artifact):
+        mock_fetch_props.return_value = {
+            'OPNFV_SNAP_URL': 'artifacts.opnfv.org/apex/master/noha/'
+                              'apex-csit-snap-2018-08-05.tar.gz',
+            'OPNFV_SNAP_SHA512SUM': 'bb0c6fa0e675dcb39cfad11d81bb99f309d5cfc23'
+                                    '6e36a74d05ee813584f3e5bb92aa23dec77584631'
+                                    '7b75d574f8c86186c666f78a299c24fb68849897b'
+                                    'dd4bc'
+        }
+        SnapshotDeployment.pull_snapshot('http://dummy_url',
+                                         TEST_DUMMY_CONFIG)
+        mock_fetch_artifact.assert_not_called()
+
+    @patch('apex.deployment.snapshot.utils.fetch_upstream_and_unpack')
+    @patch('apex.deployment.snapshot.utils.fetch_properties')
+    def test_pull_snapshot_fetch_props_failure(self, mock_fetch_props,
+                                               mock_fetch_artifact):
+        mock_fetch_props.side_effect = exc.FetchException
+        self.assertRaises(exc.FetchException,
+                          SnapshotDeployment.pull_snapshot,
+                          'http://dummy_url', TEST_DUMMY_CONFIG)
+
+    @patch('apex.deployment.snapshot.utils.fetch_upstream_and_unpack')
+    @patch('apex.deployment.snapshot.utils.fetch_properties')
+    def test_pull_snapshot_is_not_latest(self, mock_fetch_props,
+                                         mock_fetch_artifact):
+        mock_fetch_props.side_effect = [{
+            'OPNFV_SNAP_URL': 'artifacts.opnfv.org/apex/master/noha/'
+                              'apex-csit-snap-2018-08-05.tar.gz',
+            'OPNFV_SNAP_SHA512SUM': '123c6fa0e675dcb39cfad11d81bb99f309d5cfc23'
+                                    '6e36a74d05ee813584f3e5bb92aa23dec77584631'
+                                    '7b75d574f8c86186c666f78a299c24fb68849897b'
+                                    'dd4bc'},
+            {
+            'OPNFV_SNAP_URL': 'artifacts.opnfv.org/apex/master/noha/'
+                              'apex-csit-snap-2018-08-05.tar.gz',
+            'OPNFV_SNAP_SHA512SUM': 'bb0c6fa0e675dcb39cfad11d81bb99f309d5cfc23'
+                                    '6e36a74d05ee813584f3e5bb92aa23dec77584631'
+                                    '7b75d574f8c86186c666f78a299c24fb68849897b'
+                                    'dd4bc'}]
+        SnapshotDeployment.pull_snapshot('http://dummy_url',
+                                         TEST_DUMMY_CONFIG)
+        mock_fetch_artifact.assert_called()
+
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_create_networks(self, mock_deploy_snap, mock_libvirt_open,
+                             mock_pull_snap, mock_oc_node):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = TEST_DUMMY_CONFIG
+        conn = mock_libvirt_open('qemu:///system')
+        d.create_networks()
+        conn.networkCreateXML.assert_called()
+
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_create_networks_invalid_cache(self, mock_deploy_snap,
+                                           mock_libvirt_open, mock_pull_snap,
+                                           mock_oc_node):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = '/doesnotexist/'
+        self.assertRaises(exc.SnapshotDeployException, d.create_networks)
+
+    @patch('apex.deployment.snapshot.fnmatch')
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_create_networks_no_net_xmls(self, mock_deploy_snap,
+                                         mock_libvirt_open, mock_pull_snap,
+                                         mock_oc_node, mock_fnmatch):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = '/doesnotexist/'
+        mock_fnmatch.filter.return_value = []
+        self.assertRaises(exc.SnapshotDeployException, d.create_networks)
+
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_parse_and_create_nodes(self, mock_deploy_snap, mock_libvirt_open,
+                                    mock_pull_snap, mock_oc_node):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = TEST_DUMMY_CONFIG
+        node = mock_oc_node()
+        d.parse_and_create_nodes()
+        node.start.assert_called()
+        self.assertListEqual([node], d.oc_nodes)
+
+    @patch('apex.deployment.snapshot.utils.parse_yaml')
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_parse_and_create_nodes_invalid_node_yaml(
+            self, mock_deploy_snap, mock_libvirt_open, mock_pull_snap,
+            mock_oc_node, mock_parse_yaml):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = TEST_DUMMY_CONFIG
+        node = mock_oc_node()
+        mock_parse_yaml.return_value = {'blah': 'dummy'}
+        self.assertRaises(exc.SnapshotDeployException,
+                          d.parse_and_create_nodes)
+        node.start.assert_not_called()
+
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_get_controllers(self, mock_deploy_snap, mock_libvirt_open,
+                             mock_pull_snap, mock_oc_node):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = TEST_DUMMY_CONFIG
+        node = mock_oc_node()
+        node.role = 'controller'
+        d.oc_nodes = [node]
+        self.assertListEqual(d.get_controllers(), [node])
+
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_get_controllers_none(self, mock_deploy_snap, mock_libvirt_open,
+                                  mock_pull_snap, mock_oc_node):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = TEST_DUMMY_CONFIG
+        node = mock_oc_node()
+        node.role = 'compute'
+        d.oc_nodes = [node]
+        self.assertListEqual(d.get_controllers(), [])
+
+    @patch('apex.deployment.snapshot.SnapshotDeployment.get_controllers')
+    @patch('apex.deployment.snapshot.time')
+    @patch('apex.deployment.snapshot.socket')
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_is_openstack_up(self, mock_deploy_snap, mock_libvirt_open,
+                             mock_pull_snap, mock_oc_node, mock_socket,
+                             mock_time, mock_get_ctrls):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = TEST_DUMMY_CONFIG
+        node = mock_oc_node()
+        node.ip = '123.123.123.123'
+        node.name = 'dummy-controller-0'
+        mock_get_ctrls.return_value = [node]
+        sock = mock_socket.socket(mock_socket.AF_INET, mock_socket.SOCK_STREAM)
+        sock.connect_ex.return_value = 0
+        self.assertTrue(d.is_service_up('openstack'))
+
+    @patch('apex.deployment.snapshot.SnapshotDeployment.get_controllers')
+    @patch('apex.deployment.snapshot.time')
+    @patch('apex.deployment.snapshot.socket')
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_is_openstack_up_false(self, mock_deploy_snap, mock_libvirt_open,
+                                   mock_pull_snap, mock_oc_node, mock_socket,
+                                   mock_time, mock_get_ctrls):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = TEST_DUMMY_CONFIG
+        node = mock_oc_node()
+        node.ip = '123.123.123.123'
+        node.name = 'dummy-controller-0'
+        mock_get_ctrls.return_value = [node]
+        sock = mock_socket.socket(mock_socket.AF_INET, mock_socket.SOCK_STREAM)
+        sock.connect_ex.return_value = 1
+        self.assertFalse(d.is_service_up('openstack'))
+
+    @patch('apex.deployment.snapshot.SnapshotDeployment.get_controllers')
+    @patch('apex.deployment.snapshot.time')
+    @patch('apex.deployment.snapshot.utils')
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_is_opendaylight_up(self, mock_deploy_snap, mock_libvirt_open,
+                                mock_pull_snap, mock_oc_node, mock_utils,
+                                mock_time, mock_get_ctrls):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = TEST_DUMMY_CONFIG
+        node = mock_oc_node()
+        node.ip = '123.123.123.123'
+        node.name = 'dummy-controller-0'
+        mock_get_ctrls.return_value = [node]
+        mock_utils.open_webpage.return_value = 0
+        self.assertTrue(d.is_service_up('opendaylight'))
+
+    @patch('apex.deployment.snapshot.SnapshotDeployment.get_controllers')
+    @patch('apex.deployment.snapshot.time')
+    @patch('apex.deployment.snapshot.utils')
+    @patch('apex.deployment.snapshot.OvercloudNode')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.deploy_snapshot')
+    def test_is_opendaylight_up_false(self, mock_deploy_snap,
+                                      mock_libvirt_open, mock_pull_snap,
+                                      mock_oc_node, mock_utils,
+                                      mock_time, mock_get_ctrls):
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        d = SnapshotDeployment(deploy_settings=ds,
+                               snap_cache_dir=DUMMY_SNAP_DIR,
+                               fetch=False, all_in_one=False)
+        d.snap_cache_dir = TEST_DUMMY_CONFIG
+        node = mock_oc_node()
+        node.ip = '123.123.123.123'
+        node.name = 'dummy-controller-0'
+        mock_get_ctrls.return_value = [node]
+        mock_utils.open_webpage.side_effect = urllib.request.URLError(
+            reason='blah')
+        self.assertFalse(d.is_service_up('opendaylight'))
+
+    @patch('apex.deployment.snapshot.os.path.isfile')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.is_service_up')
+    @patch('apex.deployment.snapshot.SnapshotDeployment'
+           '.parse_and_create_nodes')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.create_networks')
+    def test_deploy_snapshot(self, mock_create_networks, mock_libvirt_open,
+                             mock_pull_snap, mock_parse_create,
+                             mock_service_up, mock_is_file):
+        mock_is_file.return_value = True
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        SnapshotDeployment(deploy_settings=ds, snap_cache_dir=DUMMY_SNAP_DIR,
+                           fetch=False, all_in_one=False)
+        mock_parse_create.assert_called()
+        mock_create_networks.assert_called()
+        mock_service_up.assert_called()
+
+    @patch('apex.deployment.snapshot.os.path.isfile')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.is_service_up')
+    @patch('apex.deployment.snapshot.SnapshotDeployment'
+           '.parse_and_create_nodes')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.pull_snapshot')
+    @patch('apex.deployment.snapshot.libvirt.open')
+    @patch('apex.deployment.snapshot.SnapshotDeployment.create_networks')
+    def test_deploy_snapshot_services_down(self, mock_create_networks,
+                                           mock_libvirt_open,
+                                           mock_pull_snap, mock_parse_create,
+                                           mock_service_up, mock_is_file):
+        mock_is_file.return_value = True
+        ds_file = os.path.join(TEST_DUMMY_CONFIG, 'dummy-deploy-settings.yaml')
+        ds = DeploySettings(ds_file)
+        mock_service_up.return_value = False
+        self.assertRaises(exc.SnapshotDeployException,
+                          SnapshotDeployment,
+                          ds, DUMMY_SNAP_DIR, False, False)
+
+        mock_service_up.side_effect = [True, False]
+        self.assertRaises(exc.SnapshotDeployException,
+                          SnapshotDeployment,
+                          ds, DUMMY_SNAP_DIR, False, False)