HDS Cinder Driver. Rev rnirmal#1

blueprint hds-hus-iscsi-cinder-driver
This is the first rev of Hitachi Data Systems Cinder iSCSI driver.
This driver works with HUS (df850) array.
This driver contains all the base-line features specified for Havana release.
Amended into this submission are changes from code-reviews.

Docimpact: Bug #1180648

Change-Id: Ia27d076443b10da2c653456f9292dd192362b853

Author: Lakhinder Walia

cinder/exception.py

@@ -426,6 +426,10 @@ class ConfigNotFound(NotFound):
     message = _("Could not find config at %(path)s")
 
 
+class ParameterNotFound(NotFound):
+    message = _("Could not find parameter %(param)s")
+
+
 class PasteAppNotFound(NotFound):
     message = _("Could not load paste app '%(name)s' from %(path)s")
 

cinder/tests/test_hds.py

@@ -0,0 +1,254 @@
+# Copyright (c) 2013 Hitachi Data Systems, Inc.
+# Copyright (c) 2013 OpenStack LLC.
+# All Rights Reserved.
+#
+#    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.
+#
+
+"""
+Self test for Hitachi Unified Storage (HUS) platform.
+"""
+
+import mox
+import os
+import tempfile
+
+from cinder import test
+from cinder.volume import configuration as conf
+from cinder.volume.drivers.hds import hds
+
+
+CONF = """<?xml version="1.0" encoding="UTF-8" ?>
+<config>
+  <mgmt_ip0>172.17.44.16</mgmt_ip0>
+  <mgmt_ip1>172.17.44.17</mgmt_ip1>
+  <username>system</username>
+  <password>manager</password>
+  <svc_0>
+    <volume_type>default</volume_type>
+    <iscsi_ip>172.17.39.132</iscsi_ip>
+    <hdp>9</hdp>
+  </svc_0>
+  <svc_1>
+    <volume_type>silver</volume_type>
+    <iscsi_ip>172.17.39.133</iscsi_ip>
+    <hdp>9</hdp>
+  </svc_1>
+  <svc_2>
+    <volume_type>gold</volume_type>
+    <iscsi_ip>172.17.39.134</iscsi_ip>
+    <hdp>9</hdp>
+  </svc_2>
+  <svc_3>
+    <volume_type>platinum</volume_type>
+    <iscsi_ip>172.17.39.135</iscsi_ip>
+    <hdp>9</hdp>
+  </svc_3>
+  <snapshot>
+    <hdp>9</hdp>
+  </snapshot>
+  <lun_start>
+    3300
+  </lun_start>
+</config>
+"""
+
+
+class SimulatedHusBackend:
+    """Simulation Back end. Talks to HUS."""
+
+    alloc_lun = []              # allocated LUs
+    connections = []            # iSCSI connections
+
+    def __init__(self):
+        self.start_lun = 0
+
+    def get_version(self, cmd, ip0, ip1, user, pw):
+        out = ("Array_ID: 92210013 (HUS130) version: 0920/B-S  LU: 4096"
+               "  RG: 75  RG_LU: 1024  Utility_version: 1.0.0")
+        return out
+
+    def get_iscsi_info(self, cmd, ip0, ip1, user, pw):
+        out = """CTL: 0 Port: 4 IP: 172.17.39.132 Port: 3260 Link: Up
+                 CTL: 0 Port: 5 IP: 172.17.39.133 Port: 3260 Link: Up
+                 CTL: 1 Port: 4 IP: 172.17.39.134 Port: 3260 Link: Up
+                 CTL: 1 Port: 5 IP: 172.17.39.135 Port: 3260 Link: Up"""
+        return out
+
+    def get_hdp_info(self, cmd, ip0, ip1, user, pw):
+        out = """HDP: 2  272384 MB    33792 MB  12 %  LUs:   70  Normal  Normal
+              HDP: 9  546816 MB    73728 MB  13 %  LUs:  194  Normal  Normal"""
+        return out
+
+    def create_lu(self, cmd, ip0, ip1, user, pw, id, hdp, start, end, size):
+        if self.start_lun < int(start):  # initialize first time
+            self.start_lun = int(start)
+        out = ("LUN: %d HDP: 9 size: %s MB, is successfully created" %
+               (self.start_lun, size))
+        self.alloc_lun.append(str(self.start_lun))
+        self.start_lun += 1
+        return out
+
+    def delete_lu(self, cmd, ip0, ip1, user, pw, id, lun):
+        out = ""
+        if lun in self.alloc_lun:
+            out = "LUN: %s is successfully deleted" % (lun)
+            self.alloc_lun.remove(lun)
+        return out
+
+    def create_dup(self, cmd, ip0, ip1, user, pw, id, src_lun,
+                   hdp, start, end, size):
+        out = ("LUN: %s HDP: 9 size: %s MB, is successfully created" %
+               (self.start_lun, size))
+        self.alloc_lun.append(str(self.start_lun))
+        self.start_lun += 1
+        return out
+
+    def add_iscsi_conn(self, cmd, ip0, ip1, user, pw, id, lun, ctl, port, iqn,
+                       tgt_alias, initiator, init_alias):
+        conn = (initiator, iqn, ctl, port)
+        out = ("iSCSI Initiator: %s, index: 26, and Target: %s, index 8 is \
+               successfully paired @ CTL: %s, Port: %s" % conn)
+        SimulatedHusBackend.connections.append(conn)
+        return out
+
+    def del_iscsi_conn(self, cmd, ip0, ip1, user, pw, id, lun, ctl, port, iqn,
+                       initiator, force):
+        conn = (initiator, iqn, ctl, port)
+        out = ("iSCSI Initiator: %s, index: 26, and Target: %s, index 8 is \
+               successfully un-paired  @ CTL: %s, Port: %s" % conn)
+        if conn in SimulatedHusBackend.connections:
+            SimulatedHusBackend.connections.remove(conn)
+        return out
+
+
+# The following information is passed on to tests, when creating a volume
+
+_VOLUME = {'volume_id': '1234567890', 'size': 128,
+           'volume_type': None, 'provider_location': None, 'id': 'abcdefg'}
+
+
+class HUSiSCSIDriverTest(test.TestCase):
+    """Test HUS iSCSI volume driver."""
+
+    def __init__(self, *args, **kwargs):
+        super(HUSiSCSIDriverTest, self).__init__(*args, **kwargs)
+
+    def setUp(self):
+        super(HUSiSCSIDriverTest, self).setUp()
+        (handle, self.config_file) = tempfile.mkstemp('.xml')
+        os.write(handle, CONF)
+        os.close(handle)
+        SimulatedHusBackend.alloc_lun = []
+        SimulatedHusBackend.connections = []
+        self.mox = mox.Mox()
+        self.mox.StubOutWithMock(hds, 'factory_bend')
+        hds.factory_bend().AndReturn(SimulatedHusBackend())
+        self.mox.ReplayAll()
+        self.configuration = mox.MockObject(conf.Configuration)
+        self.configuration.hds_cinder_config_file = self.config_file
+        self.driver = hds.HUSDriver(configuration=self.configuration)
+
+    def tearDown(self):
+        os.remove(self.config_file)
+        self.mox.UnsetStubs()
+        super(HUSiSCSIDriverTest, self).tearDown()
+
+    def test_get_volume_stats(self):
+        stats = self.driver.get_volume_stats(True)
+        self.assertEqual(stats["vendor_name"], "HDS")
+        self.assertEqual(stats["storage_protocol"], "iSCSI")
+        self.assertTrue(stats["total_capacity_gb"] > 0)
+
+    def test_create_volume(self):
+        loc = self.driver.create_volume(_VOLUME)
+        self.assertNotEqual(loc, None)
+        vol = _VOLUME.copy()
+        vol['provider_location'] = loc['provider_location']
+        self.assertNotEqual(loc['provider_location'], None)
+        return vol
+
+    def test_delete_volume(self):
+        """Delete a volume (test).
+
+        Note: this API call should not expect any exception:
+        This driver will silently accept a delete request, because
+        the DB can be out of sync, and Cinder manager will keep trying
+        to delete, even though the volume has been wiped out of the
+        Array. We don't want to have a dangling volume entry in the
+        customer dashboard.
+        """
+        vol = self.test_create_volume()
+        self.assertTrue(SimulatedHusBackend.alloc_lun)
+        num_luns_before = len(SimulatedHusBackend.alloc_lun)
+        self.driver.delete_volume(vol)
+        num_luns_after = len(SimulatedHusBackend.alloc_lun)
+        self.assertTrue(num_luns_before > num_luns_after)
+
+    def test_create_snapshot(self):
+        vol = self.test_create_volume()
+        self.mox.StubOutWithMock(self.driver, '_id_to_vol')
+        self.driver._id_to_vol(vol['volume_id']).AndReturn(vol)
+        self.mox.ReplayAll()
+        svol = vol.copy()
+        svol['volume_size'] = svol['size']
+        loc = self.driver.create_snapshot(svol)
+        self.assertNotEqual(loc, None)
+        svol['provider_location'] = loc['provider_location']
+        return svol
+
+    def test_delete_snapshot(self):
+        """Delete a snapshot (test).
+
+        Note: this API call should not expect any exception:
+        This driver will silently accept a delete request, because
+        the DB can be out of sync, and Cinder manager will keep trying
+        to delete, even though the snapshot has been wiped out of the
+        Array. We don't want to have a dangling snapshot entry in the
+        customer dashboard.
+        """
+        svol = self.test_create_snapshot()
+        num_luns_before = len(SimulatedHusBackend.alloc_lun)
+        self.driver.delete_snapshot(svol)
+        num_luns_after = len(SimulatedHusBackend.alloc_lun)
+        self.assertTrue(num_luns_before > num_luns_after)
+
+    def test_create_volume_from_snapshot(self):
+        svol = self.test_create_snapshot()
+        vol = self.driver.create_volume_from_snapshot(_VOLUME, svol)
+        self.assertNotEqual(vol, None)
+        return vol
+
+    def test_initialize_connection(self):
+        connector = {}
+        connector['initiator'] = 'iqn.1993-08.org.debian:01:11f90746eb2'
+        connector['host'] = 'dut_1.lab.hds.com'
+        vol = self.test_create_volume()
+        conn = self.driver.initialize_connection(vol, connector)
+        self.assertTrue('hitachi' in conn['data']['target_iqn'])
+        self.assertTrue('3260' in conn['data']['target_portal'])
+        return (vol, connector)
+
+    def test_terminate_connection(self):
+        """Terminate a connection (test).
+
+        Note: this API call should not expect any exception:
+        This driver will silently accept a terminate_connection request
+        because an error/exception return will only jeopardize the
+        connection tear down at a host.
+        """
+        (vol, conn) = self.test_initialize_connection()
+        num_conn_before = len(SimulatedHusBackend.connections)
+        self.driver.terminate_connection(vol, conn)
+        num_conn_after = len(SimulatedHusBackend.connections)
+        self.assertTrue(num_conn_before > num_conn_after)

cinder/volume/drivers/hds/__init__.py

@@ -0,0 +1,16 @@
+# Copyright (c) 2013 Hitachi Data Systems, Inc.
+# Copyright (c) 2013 OpenStack LLC.
+# All Rights Reserved.
+#
+#    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.
+#