Fix hardcoded values in cinder_test

Only Fuel attaches a kdrive in all cases and then increase the device
numbers. cinder_test now leverages on VOLUME_DEVICE_NAME as tempest.

It also updates the testcase to leverage on the right scenario.

Change-Id: Ib5cd17f69411f608f1b79e704604dc481581ebe0
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

4 files changed, 55 insertions, 331 deletions

diff --git a/functest/opnfv_tests/openstack/cinder/cinder_base.py b/functest/opnfv_tests/openstack/cinder/cinder_base.py
deleted file mode 100644
index b5ff36d4a..000000000
--- a/functest/opnfv_tests/openstack/cinder/cinder_base.py
+++ /dev/null
@@ -1,178 +0,0 @@
-#!/usr/bin/env python
-
-# Copyright (c) 2018 Enea AB and others.
-#
-# 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
-
-"""Define the parent class of cinder_test"""
-
-from datetime import datetime
-import logging
-import time
-import uuid
-
-import os_client_config
-from xtesting.core import testcase
-
-from functest.utils import config
-from functest.utils import env
-from functest.utils import functest_utils
-
-
-class CinderBase(testcase.TestCase):
-
-    """
-    Base class for CinderCheck tests that check volume data persistence
-    between two VMs shared internal network.
-    This class is responsible for creating the image, internal network,
-    flavor, volume.
-    """
-    # pylint: disable=too-many-instance-attributes
-
-    def __init__(self, **kwargs):
-        super(CinderBase, self).__init__(**kwargs)
-        self.logger = logging.getLogger(__name__)
-        self.cloud = os_client_config.make_shade()
-        self.ext_net = functest_utils.get_external_network(self.cloud)
-        self.logger.debug("ext_net: %s", self.ext_net)
-        self.guid = '-' + str(uuid.uuid4())
-        self.network = None
-        self.subnet = None
-        self.router = None
-        self.image = None
-        self.flavor = None
-        self.vm1 = None
-        self.volume = None
-
-    def run(self, **kwargs):  # pylint: disable=too-many-locals
-        """
-        Begins the test execution which should originate from the subclass
-        """
-        assert self.cloud
-        assert self.ext_net
-        self.logger.info('Begin virtual environment setup')
-
-        self.start_time = time.time()
-        self.logger.info(
-            "CinderCheck Start Time:'%s'",
-            datetime.fromtimestamp(self.start_time).strftime(
-                '%Y-%m-%d %H:%M:%S'))
-
-        image_base_name = '{}-{}'.format(
-            getattr(config.CONF, 'cinder_image_name'), self.guid)
-        self.logger.info("Creating image with name: '%s'", image_base_name)
-        meta = getattr(config.CONF, 'openstack_extra_properties', None)
-        self.logger.info("Image metadata: %s", meta)
-        self.image = self.cloud.create_image(
-            image_base_name,
-            filename=getattr(config.CONF, 'openstack_image_url'),
-            meta=meta)
-        self.logger.debug("image: %s", self.image)
-
-        private_net_name = getattr(
-            config.CONF, 'cinder_private_net_name') + self.guid
-        private_subnet_name = str(getattr(
-            config.CONF, 'cinder_private_subnet_name') + self.guid)
-        private_subnet_cidr = getattr(
-            config.CONF, 'cinder_private_subnet_cidr')
-
-        provider = {}
-        if hasattr(config.CONF, 'cinder_network_type'):
-            provider["network_type"] = getattr(
-                config.CONF, 'cinder_network_type')
-        if hasattr(config.CONF, 'cinder_physical_network'):
-            provider["physical_network"] = getattr(
-                config.CONF, 'cinder_physical_network')
-        if hasattr(config.CONF, 'cinder_segmentation_id'):
-            provider["segmentation_id"] = getattr(
-                config.CONF, 'cinder_segmentation_id')
-        self.logger.info(
-            "Creating network with name: '%s'", private_net_name)
-        self.network = self.cloud.create_network(
-            private_net_name,
-            provider=provider)
-        self.logger.debug("network: %s", self.network)
-
-        self.subnet = self.cloud.create_subnet(
-            self.network.id,
-            subnet_name=private_subnet_name,
-            cidr=private_subnet_cidr,
-            enable_dhcp=True,
-            dns_nameservers=[env.get('NAMESERVER')])
-        self.logger.debug("subnet: %s", self.subnet)
-
-        router_name = getattr(config.CONF, 'cinder_router_name') + self.guid
-        self.logger.info("Creating router with name: '%s'", router_name)
-        self.router = self.cloud.create_router(
-            name=router_name,
-            ext_gateway_net_id=self.ext_net.id)
-        self.logger.debug("router: %s", self.router)
-        self.cloud.add_router_interface(self.router, subnet_id=self.subnet.id)
-
-        flavor_name = 'cinder-flavor' + self.guid
-        self.logger.info(
-            "Creating flavor with name: '%s'", flavor_name)
-        self.flavor = self.cloud.create_flavor(
-            flavor_name, getattr(config.CONF, 'openstack_flavor_ram'),
-            getattr(config.CONF, 'openstack_flavor_vcpus'),
-            getattr(config.CONF, 'openstack_flavor_disk'))
-        self.logger.debug("flavor: %s", self.flavor)
-        self.cloud.set_flavor_specs(
-            self.flavor.id, getattr(config.CONF, 'flavor_extra_specs', {}))
-        volume_name = 'cinder-volume' + self.guid
-        self.logger.info(
-            "Creating volume with name: %s", volume_name)
-        self.volume = self.cloud.create_volume(
-            name=volume_name, size='2')
-        self.logger.info("volume: %s", self.volume)
-
-    def execute(self):
-        """
-        Method called by subclasses after environment has been setup
-        :return: the exit code
-        """
-        self.logger.info('Begin test execution')
-        self.stop_time = time.time()
-        write_data = self.write_data()
-        if write_data == testcase.TestCase.EX_OK:
-            result = self.read_data()
-        else:
-            result = testcase.TestCase.EX_RUN_ERROR
-        if result != testcase.TestCase.EX_OK:
-            self.result = 0
-            return testcase.TestCase.EX_RUN_ERROR
-        self.result = 100
-        return testcase.TestCase.EX_OK
-
-    def clean(self):
-        """
-        Cleanup all OpenStack objects. Should be called on completion
-        :return:
-        """
-        assert self.cloud
-        self.cloud.delete_image(self.image)
-        self.cloud.remove_router_interface(self.router, self.subnet.id)
-        self.cloud.delete_router(self.router.id)
-        self.cloud.delete_network(self.network.id)
-        self.cloud.delete_flavor(self.flavor.id)
-        self.cloud.delete_volume(self.volume.id)
-
-    def write_data(self):
-        """
-        Method to be implemented by subclasses
-        Begins the real test after the OpenStack environment has been setup
-        :return: T/F
-        """
-        raise NotImplementedError('cinder test execution is not implemented')
-
-    def read_data(self):
-        """
-        Method to be implemented by subclasses
-        Begins the real test after the OpenStack environment has been setup
-        :return: T/F
-        """
-        raise NotImplementedError('cinder test execution is not implemented')
diff --git a/functest/opnfv_tests/openstack/cinder/cinder_test.py b/functest/opnfv_tests/openstack/cinder/cinder_test.py
index d4a7cf7fe..7f9401c93 100644
--- a/functest/opnfv_tests/openstack/cinder/cinder_test.py
+++ b/functest/opnfv_tests/openstack/cinder/cinder_test.py
@@ -1,6 +1,5 @@
 #!/usr/bin/env python
 
-
 # Copyright (c) 2018 Enea AB and others
 
 # This program and the accompanying materials
@@ -12,21 +11,17 @@
 """CinderCheck testcase."""
 
 import logging
-import os
-import tempfile
-import time
+
 import pkg_resources
 from scp import SCPClient
-
-import paramiko
 from xtesting.core import testcase
-from xtesting.energy import energy
 
-from functest.opnfv_tests.openstack.cinder import cinder_base
+from functest.core import singlevm
 from functest.utils import config
+from functest.utils import env
 
 
-class CinderCheck(cinder_base.CinderBase):
+class CinderCheck(singlevm.SingleVm2):
     """
     CinderCheck testcase implementation.
 
@@ -41,178 +36,79 @@ class CinderCheck(cinder_base.CinderBase):
             kwargs["case_name"] = "cinder_test"
         super(CinderCheck, self).__init__(**kwargs)
         self.logger = logging.getLogger(__name__)
-        self.vm1 = None
         self.vm2 = None
-        self.sec = None
-        self.fip1 = None
         self.fip2 = None
-        self.keypair1 = None
-        self.keypair2 = None
-        (_, self.key1_filename) = tempfile.mkstemp()
-        self.ssh = paramiko.SSHClient()
-        (_, self.key2_filename) = tempfile.mkstemp()
-
-    @energy.enable_recording
-    def run(self, **kwargs):
-        """
-        Excecute CinderCheck testcase.
+        self.ssh2 = None
+        self.volume = None
+
+    def execute(self):
+        """Execute CinderCheck testcase.
 
         Sets up the OpenStack keypair, router, security group, and VM instance
-        objects then validates the ping.
+        objects then validates cinder.
         :return: the exit code from the super.execute() method
         """
-        try:
-            assert self.cloud
-            super(CinderCheck, self).run()
-
-            # Creating key pair 1
-            kp_name1 = getattr(
-                config.CONF, 'cinder_keypair_name') + '_1' + self.guid
-            self.logger.info("Creating keypair with name: '%s'", kp_name1)
-            self.keypair1 = self.cloud.create_keypair(kp_name1)
-            self.logger.debug("keypair: %s", self.keypair1)
-            self.logger.debug("private_key: %s", self.keypair1.private_key)
-            with open(self.key1_filename, 'w') as private_key1_file:
-                private_key1_file.write(self.keypair1.private_key)
-            # Creating key pair 2
-            kp_name2 = getattr(
-                config.CONF, 'cinder_keypair_name') + '_2' + self.guid
-            self.logger.info("Creating keypair with name: '%s'", kp_name2)
-            self.keypair2 = self.cloud.create_keypair(kp_name2)
-            self.logger.debug("keypair: %s", self.keypair2)
-            self.logger.debug("private_key: %s", self.keypair2.private_key)
-            with open(self.key2_filename, 'w') as private_key2_file:
-                private_key2_file.write(self.keypair2.private_key)
-
-            # Creating security group
-            self.sec = self.cloud.create_security_group(
-                getattr(config.CONF, 'cinder_sg_name') + self.guid,
-                getattr(config.CONF, 'cinder_sg_desc'))
-            self.cloud.create_security_group_rule(
-                self.sec.id, port_range_min='22', port_range_max='22',
-                protocol='tcp', direction='ingress')
-            self.cloud.create_security_group_rule(
-                self.sec.id, port_range_min='22', port_range_max='22',
-                protocol='tcp', direction='egress')
-            self.cloud.create_security_group_rule(
-                self.sec.id, protocol='icmp', direction='ingress')
-
-            # Creating VM 1
-            vm1_name = "{}-{}-{}".format(
-                getattr(config.CONF, 'cinder_vm_name_1'), "ssh", self.guid)
-            self.logger.info(
-                "Creating VM 1 instance with name: '%s'", vm1_name)
-            self.vm1 = self.cloud.create_server(
-                vm1_name, image=self.image.id, flavor=self.flavor.id,
-                key_name=self.keypair1.id,
-                auto_ip=False, wait=True,
-                timeout=getattr(config.CONF, 'cinder_vm_boot_timeout'),
-                network=self.network.id,
-                security_groups=[self.sec.id])
-            self.logger.debug("vm1: %s", self.vm2)
-            self.fip1 = self.cloud.create_floating_ip(
-                network=self.ext_net.id, server=self.vm1)
-            self.logger.debug("floating_ip1: %s", self.fip1)
-            self.vm1 = self.cloud.wait_for_server(self.vm1, auto_ip=False)
-            self.cloud.attach_volume(self.vm1, self.volume)
-
-            # Creating VM 2
-            vm2_name = "{}-{}-{}".format(
-                getattr(config.CONF, 'cinder_vm_name_2'), "ssh", self.guid)
-            self.logger.info(
-                "Creating VM 2 instance with name: '%s'", vm2_name)
-            self.vm2 = self.cloud.create_server(
-                vm2_name, image=self.image.id, flavor=self.flavor.id,
-                key_name=self.keypair2.id,
-                auto_ip=False, wait=True,
-                timeout=getattr(config.CONF, 'cinder_vm_boot_timeout'),
-                network=self.network.id,
-                security_groups=[self.sec.id])
-            self.logger.debug("vm2: %s", self.vm2)
-            self.fip2 = self.cloud.create_floating_ip(
-                network=self.ext_net.id, server=self.vm2)
-            self.logger.debug("floating_ip2: %s", self.fip2)
-            self.vm2 = self.cloud.wait_for_server(self.vm2, auto_ip=False)
-
-            return self.execute()
-        except Exception:  # pylint: disable=broad-except
-            self.logger.exception('Unexpected error running cinder_ssh')
-            return testcase.TestCase.EX_RUN_ERROR
-
-    def write_data(self):
-        time.sleep(10)
+        return self._write_data() or self._read_data()
+
+    def prepare(self):
+        super(CinderCheck, self).prepare()
+        self.vm2 = self.boot_vm(
+            '{}-vm2_{}'.format(self.case_name, self.guid),
+            key_name=self.keypair.id,
+            security_groups=[self.sec.id])
+        (self.fip2, self.ssh2) = self.connect(self.vm2)
+        self.volume = self.cloud.create_volume(
+            name='{}-volume_{}'.format(self.case_name, self.guid), size='2')
+
+    def _write_data(self):
+        assert self.cloud
+        self.cloud.attach_volume(self.sshvm, self.volume)
         write_data_script = pkg_resources.resource_filename(
             'functest.opnfv_tests.openstack.cinder', 'write_data.sh')
-        cmd = '. ~/write_data.sh '
-        username = getattr(config.CONF, 'openstack_image_user')
-        destination_path = '/home/' + username
-        self.ssh.set_missing_host_key_policy(paramiko.client.AutoAddPolicy())
-        self.ssh.connect(
-            self.vm1.public_v4,
-            username=username,
-            key_filename=self.key1_filename,
-            timeout=getattr(config.CONF, 'cinder_vm_ssh_connect_timeout'))
         try:
             scp = SCPClient(self.ssh.get_transport())
-            scp.put(write_data_script, remote_path=destination_path)
+            scp.put(write_data_script, remote_path="~/")
         except Exception:  # pylint: disable=broad-except
             self.logger.error("File not transfered!")
             return testcase.TestCase.EX_RUN_ERROR
-
         self.logger.debug("ssh: %s", self.ssh)
-        self.ssh.exec_command('chmod +x ~/write_data.sh')
-        (_, stdout, _) = self.ssh.exec_command(cmd)
-        self.logger.debug("volume_write output: %s", stdout.read())
-
+        (_, stdout, stderr) = self.ssh.exec_command(
+            "sh ~/write_data.sh {}".format(env.get('VOLUME_DEVICE_NAME')))
+        self.logger.debug("volume_write stdout: %s", stdout.read())
+        self.logger.debug("volume_write stderr: %s", stderr.read())
+        # Detach volume from VM 1
+        self.logger.info("Detach volume from VM 1")
+        self.cloud.detach_volume(self.sshvm, self.volume)
         return stdout.channel.recv_exit_status()
 
-    def read_data(self):
+    def _read_data(self):
         assert self.cloud
-        # Detach volume from VM 1
-        self.logger.info("Detach volume from VM 1")
-        self.cloud.detach_volume(self.vm1, self.volume)
         # Attach volume to VM 2
         self.logger.info("Attach volume to VM 2")
         self.cloud.attach_volume(self.vm2, self.volume)
         # Check volume data
-        time.sleep(10)
         read_data_script = pkg_resources.resource_filename(
             'functest.opnfv_tests.openstack.cinder', 'read_data.sh')
-        cmd = '. ~/read_data.sh '
-        username = getattr(config.CONF, 'openstack_image_user')
-        destination_path = '/home/' + username
-        self.ssh.set_missing_host_key_policy(paramiko.client.AutoAddPolicy())
-        self.ssh.connect(
-            self.vm2.public_v4,
-            username=username,
-            key_filename=self.key2_filename,
-            timeout=getattr(config.CONF, 'cinder_vm_ssh_connect_timeout'))
         try:
-            scp = SCPClient(self.ssh.get_transport())
-            scp.put(read_data_script, remote_path=destination_path)
+            scp = SCPClient(self.ssh2.get_transport())
+            scp.put(read_data_script, remote_path="~/")
         except Exception:  # pylint: disable=broad-except
             self.logger.error("File not transfered!")
             return testcase.TestCase.EX_RUN_ERROR
-        self.logger.debug("ssh: %s", self.ssh)
-        self.ssh.exec_command('chmod +x ~/read_data.sh')
-        (_, stdout, _) = self.ssh.exec_command(cmd)
-        self.logger.debug("read volume output: %s", stdout.read())
-
+        self.logger.debug("ssh: %s", self.ssh2)
+        (_, stdout, stderr) = self.ssh2.exec_command(
+            "sh ~/read_data.sh {}".format(env.get('VOLUME_DEVICE_NAME')))
+        self.logger.debug("read volume stdout: %s", stdout.read())
+        self.logger.debug("read volume stderr: %s", stderr.read())
+        self.logger.info("Detach volume from VM 2")
+        self.cloud.detach_volume(self.vm2, self.volume)
         return stdout.channel.recv_exit_status()
 
     def clean(self):
         assert self.cloud
-        os.remove(self.key1_filename)
-        os.remove(self.key2_filename)
-        self.cloud.delete_server(
-            self.vm1, wait=True,
-            timeout=getattr(config.CONF, 'cinder_vm_delete_timeout'))
         self.cloud.delete_server(
             self.vm2, wait=True,
-            timeout=getattr(config.CONF, 'cinder_vm_delete_timeout'))
-        self.cloud.delete_security_group(self.sec.id)
-        self.cloud.delete_keypair(self.keypair1.id)
-        self.cloud.delete_keypair(self.keypair2.id)
-        self.cloud.delete_floating_ip(self.fip1.id)
-        self.cloud.delete_floating_ip(self.fip2.id)
+            timeout=getattr(config.CONF, 'vping_vm_delete_timeout'))
+        self.cloud.delete_floating_ip(self.fip.id)
+        self.cloud.delete_volume(self.volume.id)
         super(CinderCheck, self).clean()
diff --git a/functest/opnfv_tests/openstack/cinder/read_data.sh b/functest/opnfv_tests/openstack/cinder/read_data.sh
index c3ce9e4f7..e6ad57bd3 100644
--- a/functest/opnfv_tests/openstack/cinder/read_data.sh
+++ b/functest/opnfv_tests/openstack/cinder/read_data.sh
@@ -9,9 +9,10 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 
 DEST=$(mktemp -d)
-VOL_DEV_NAME="$(lsblk -l -o NAME | grep -o "vdc\|sdc\b")"
+VOL_DEV_NAME=${1:-vdb}
 echo "VOL_DEV_NAME: $VOL_DEV_NAME"
 
+echo "$(lsblk -l -o NAME)"
 if [ ! -z $VOL_DEV_NAME ]; then
     sudo mount /dev/$VOL_DEV_NAME $DEST
     if [ -f $DEST/new_data ]; then
@@ -21,3 +22,5 @@ if [ ! -z $VOL_DEV_NAME ]; then
     exit 1
     fi
 fi
+
+exit 0
diff --git a/functest/opnfv_tests/openstack/cinder/write_data.sh b/functest/opnfv_tests/openstack/cinder/write_data.sh
index 70f8275f1..16cea17bf 100644
--- a/functest/opnfv_tests/openstack/cinder/write_data.sh
+++ b/functest/opnfv_tests/openstack/cinder/write_data.sh
@@ -9,10 +9,11 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 
 DEST=$(mktemp -d)
-VOL_DEV_NAME="$(lsblk -l -o NAME | grep -o "vdc\|sdc\b")"
-
+VOL_DEV_NAME=${1:-vdb}
 echo "VOL_DEV_NAME: $VOL_DEV_NAME"
 
+echo "$(lsblk -l -o NAME)"
+
 if [ ! -z $VOL_DEV_NAME ]; then
     sudo /usr/sbin/mkfs.ext4 -F /dev/$VOL_DEV_NAME
     sudo mount /dev/$VOL_DEV_NAME $DEST
@@ -25,3 +26,5 @@ else
     echo "Failed to write data!"
     exit 1
 fi
+
+exit 0