HP lefthand driver filter and evalautor function

This patch implements the merged change in the scheduler
https://review.openstack.org/#/c/129987/ in HP lefthand driver.

1. Added filter_function and goodness_function strings

2. Added 2 stats total_volumes and capacity_utilization so they can be
used as the part of the formula in filter_function or goodness_function
string.

implements: blueprint hplefthand-driver-supplies-filtering-weighing-functions
Change-Id: I6193196ba1930f9d07865c062f12573e1570f290

diff --git a/cinder/tests/test_hplefthand.py b/cinder/tests/test_hplefthand.py
index 0bbb5f7f86e980b6809f3c702d338535f09ef3f4..2a7f9684efb2bfc0901b0e6f794c5607fe4e4686 100644 (file)
--- a/cinder/tests/test_hplefthand.py
+++ b/cinder/tests/test_hplefthand.py
@@ -30,6 +30,11 @@ hpexceptions = hplefthandclient.hpexceptions
 
 LOG = logging.getLogger(__name__)
 
+GOODNESS_FUNCTION = \
+    "capabilities.capacity_utilization < 0.6? 100 : 25"
+FILTER_FUNCTION = \
+    "capabilities.total_volumes < 400 && capabilities.capacity_utilization"
+
 
 class HPLeftHandBaseDriver():
 
@@ -85,7 +90,8 @@ class HPLeftHandBaseDriver():
     driver_startup_call_stack = [
         mock.call.login('foo1', 'bar2'),
         mock.call.getClusterByName('CloudCluster1'),
-        mock.call.getCluster(1)]
+        mock.call.getCluster(1),
+    ]
 
 
 class TestHPLeftHandCLIQISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
@@ -660,7 +666,11 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
     driver_startup_call_stack = [
         mock.call.login('foo1', 'bar2'),
         mock.call.getClusterByName('CloudCluster1'),
-        mock.call.getCluster(1)]
+        mock.call.getCluster(1),
+        mock.call.getVolumes(
+            cluster='CloudCluster1',
+            fields=['members[id]', 'members[clusterName]']),
+    ]
 
     def default_mock_conf(self):
 
@@ -671,6 +681,8 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         mock_conf.hplefthand_iscsi_chap_enabled = False
         mock_conf.hplefthand_debug = False
         mock_conf.hplefthand_clustername = "CloudCluster1"
+        mock_conf.goodness_function = GOODNESS_FUNCTION
+        mock_conf.filter_function = FILTER_FUNCTION
         return mock_conf
 
     @mock.patch('hplefthandclient.client.HPLeftHandClient', spec=True)
@@ -687,6 +699,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         self.driver = hp_lefthand_iscsi.HPLeftHandISCSIDriver(
             configuration=config)
         self.driver.do_setup(None)
+        self.cluster_name = config.hplefthand_clustername
         return _mock_client.return_value
 
     @mock.patch('hplefthandclient.version', "1.0.0")
@@ -706,6 +719,8 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         # and return the mock HTTP LeftHand client
         mock_client = self.setup_driver()
 
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
+
         # mock return value of createVolume
         mock_client.createVolume.return_value = {
             'iscsiIqn': self.connector['initiator']}
@@ -754,6 +769,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         # mock return value of createVolume
         mock_client.createVolume.return_value = {
             'iscsiIqn': self.connector['initiator']}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -784,6 +800,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
 
         # mock return value of getVolumeByName
         mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -819,6 +836,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
 
         # mock return value of getVolumeByName
         mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -855,6 +873,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
             'id': self.volume_id,
             'iscsiSessions': None
         }
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -907,6 +926,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
             'id': self.volume_id,
             'iscsiSessions': [{'server': {'uri': self.server_uri}}]
         }
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -953,6 +973,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
             'id': self.volume_id,
             'iscsiSessions': None
         }
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -995,6 +1016,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
             'id': self.server_id,
             'name': self.serverName}
         mock_client.findServerVolumes.return_value = [{'id': self.volume_id}]
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -1035,6 +1057,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         mock_client.findServerVolumes.return_value = [
             {'id': self.volume_id},
             {'id': 99999}]
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -1069,6 +1092,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         mock_client = self.setup_driver()
 
         mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -1076,6 +1100,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
 
             # execute create_snapshot
             self.driver.create_snapshot(self.snapshot)
+            mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
             expected = self.driver_startup_call_stack + [
                 mock.call.getVolumeByName('fakevolume'),
@@ -1103,6 +1128,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         mock_client = self.setup_driver()
 
         mock_client.getSnapshotByName.return_value = {'id': self.snapshot_id}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -1154,6 +1180,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         mock_client.getSnapshotByName.return_value = {'id': self.snapshot_id}
         mock_client.cloneSnapshot.return_value = {
             'iscsiIqn': self.connector['initiator']}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -1185,6 +1212,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         mock_client.getVolumeByName.return_value = {'id': self.volume_id}
         mock_client.cloneVolume.return_value = {
             'iscsiIqn': self.connector['initiator']}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -1272,6 +1300,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         # setup drive with default configuration
         # and return the mock HTTP LeftHand client
         mock_client = self.setup_driver()
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         ctxt = context.get_admin_context()
 
@@ -1308,6 +1337,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         # and return the mock HTTP LeftHand client
         mock_client = self.setup_driver()
         mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         ctxt = context.get_admin_context()
 
@@ -1348,6 +1378,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         # and return the mock HTTP LeftHand client
         mock_client = self.setup_driver()
         mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         ctxt = context.get_admin_context()
 
@@ -1385,6 +1416,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         # and return the mock HTTP LeftHand client
         mock_client = self.setup_driver()
         mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         ctxt = context.get_admin_context()
 
@@ -1450,6 +1482,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
             "id": self.cluster_id}
 
         mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         location = (self.driver.proxy.DRIVER_LOCATION % {
             'cluster': 'New_CloudCluster',
@@ -1493,6 +1526,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
                                                     'iscsiSessions': None}
         mock_client.getVolume.return_value = {'snapshots': {
             'resource': None}}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         location = (self.driver.proxy.DRIVER_LOCATION % {
             'cluster': 'New_CloudCluster',
@@ -1543,6 +1577,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
             'iscsiSessions': None}
         mock_client.getVolume.return_value = {'snapshots': {
             'resource': 'snapfoo'}}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         location = (self.driver.proxy.DRIVER_LOCATION % {
             'cluster': 'New_CloudCluster',
@@ -1591,6 +1626,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         # mock return value of createVolume
         mock_client.createVolume.return_value = {
             'iscsiIqn': self.connector['initiator']}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -1628,6 +1664,7 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         # mock return value of createVolume
         mock_client.createVolume.return_value = {
             'iscsiIqn': self.connector['initiator']}
+        mock_client.getVolumes.return_value = {'total': 1, 'members': []}
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
@@ -1680,6 +1717,14 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
                                '_create_client') as mock_do_setup:
             mock_do_setup.return_value = mock_client
             mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+            mock_client.getVolumes.return_value = {
+                "type": "volume",
+                "total": 1,
+                "members": {
+                    "id": self.volume_id,
+                    "clusterName": self.cluster_name
+                }
+            }
 
             existing_ref = {'source-name': self.volume_name}
 
@@ -1722,6 +1767,14 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
                                '_create_client') as mock_do_setup:
             mock_do_setup.return_value = mock_client
             mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+            mock_client.getVolumes.return_value = {
+                "type": "volume",
+                "total": 1,
+                "members": {
+                    "id": self.volume_id,
+                    "clusterName": self.cluster_name
+                }
+            }
 
             existing_ref = {'source-name': self.volume_name}
 
@@ -1767,6 +1820,14 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
                                '_create_client') as mock_do_setup:
             mock_do_setup.return_value = mock_client
             mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+            mock_client.getVolumes.return_value = {
+                "type": "volume",
+                "total": 1,
+                "members": {
+                    "id": self.volume_id,
+                    "clusterName": self.cluster_name
+                }
+            }
 
             existing_ref = {'source-name': self.volume_name}
 
@@ -1802,6 +1863,14 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
                                '_create_client') as mock_do_setup:
             mock_do_setup.return_value = mock_client
             mock_client.getVolumeByName.return_value = {'id': self.volume_id}
+            mock_client.getVolumes.return_value = {
+                "type": "volume",
+                "total": 1,
+                "members": {
+                    "id": self.volume_id,
+                    "clusterName": self.cluster_name
+                }
+            }
 
             existing_ref = {'source-name': self.volume_name}
 
@@ -1824,6 +1893,14 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
             mock_do_setup.return_value = mock_client
+            mock_client.getVolumes.return_value = {
+                "type": "volume",
+                "total": 1,
+                "members": {
+                    "id": self.volume_id,
+                    "clusterName": self.cluster_name
+                }
+            }
 
             volume = {}
             existing_ref = {'source-name': self.volume_name}
@@ -1878,6 +1955,14 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
                                '_create_client') as mock_do_setup:
             mock_do_setup.return_value = mock_client
+            mock_client.getVolumes.return_value = {
+                "type": "volume",
+                "total": 1,
+                "members": {
+                    "id": self.volume_id,
+                    "clusterName": self.cluster_name
+                }
+            }
 
             volume = {}
             existing_ref = {'source-name': self.volume_name}
@@ -1897,6 +1982,16 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
         mock_client = self.setup_driver()
         mock_client.getVolumeByName.return_value = {'id': self.volume_id}
 
+        # mock return value of getVolumes
+        mock_client.getVolumes.return_value = {
+            "type": "volume",
+            "total": 1,
+            "members": {
+                "id": self.volume_id,
+                "clusterName": self.cluster_name
+            }
+        }
+
         self.driver.proxy.api_version = "1.1"
 
         with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
@@ -1923,4 +2018,46 @@ class TestHPLeftHandRESTISCSIDriver(HPLeftHandBaseDriver, test.TestCase):
 
         self.driver.proxy.api_version = "1.0"
         self.assertRaises(exception.InvalidInput,
-                          self.driver.proxy._check_api_version)
\ No newline at end of file
+                          self.driver.proxy._check_api_version)
+
+    def test_get_volume_stats(self):
+
+        # set up driver with default config
+        mock_client = self.setup_driver()
+
+        # mock return value of getVolumes
+        mock_client.getVolumes.return_value = {
+            "type": "volume",
+            "total": 1,
+            "members": {
+                "id": 12345,
+                "clusterName": self.cluster_name
+            }
+        }
+
+        with mock.patch.object(hp_lefthand_rest_proxy.HPLeftHandRESTProxy,
+                               '_create_client') as mock_do_setup:
+            mock_do_setup.return_value = mock_client
+
+            # execute driver
+            stats = self.driver.get_volume_stats(True)
+
+            self.assertEqual('iSCSI', stats['storage_protocol'])
+            self.assertEqual(GOODNESS_FUNCTION, stats['goodness_function'])
+            self.assertEqual(FILTER_FUNCTION, stats['filter_function'])
+            self.assertEqual(1, int(stats['total_volumes']))
+
+            cap_util = (
+                float(units.Gi * 500 - units.Gi * 250) / float(units.Gi * 500)
+            ) * 100
+
+            self.assertEqual(cap_util, float(stats['capacity_utilization']))
+
+            expected = self.driver_startup_call_stack + [
+                mock.call.getCluster(1),
+                mock.call.getVolumes(fields=['members[id]',
+                                             'members[clusterName]'],
+                                     cluster=self.cluster_name),
+                mock.call.logout()]
+
+            mock_client.assert_has_calls(expected)

diff --git a/cinder/volume/drivers/san/hp/hp_lefthand_rest_proxy.py b/cinder/volume/drivers/san/hp/hp_lefthand_rest_proxy.py
index 507e1dc5618b72bbd77768c2603a7b21d4936de6..88ded9ca92ed3bdd496ac35f08f52e0a5d82b229 100644 (file)
--- a/cinder/volume/drivers/san/hp/hp_lefthand_rest_proxy.py
+++ b/cinder/volume/drivers/san/hp/hp_lefthand_rest_proxy.py
@@ -104,9 +104,10 @@ class HPLeftHandRESTProxy(driver.ISCSIDriver):
                 Lefthand backend after the last volume was detached.
         1.0.8 - Fixed bug #1418201, A cloned volume fails to attach.
         1.0.9 - Adding support for manage/unmanage.
+        1.0.10 - Add stats for goodness_function and filter_function
     """
 
-    VERSION = "1.0.9"
+    VERSION = "1.0.10"
 
     device_stats = {}
 
@@ -312,6 +313,24 @@ class HPLeftHandRESTProxy(driver.ISCSIDriver):
         data['total_capacity_gb'] = int(total_capacity) / units.Gi
         data['free_capacity_gb'] = int(free_capacity) / units.Gi
 
+        # Collect some stats
+        capacity_utilization = (
+            (float(total_capacity - free_capacity) /
+             float(total_capacity)) * 100)
+        # Don't have a better way to get the total number volumes
+        # so try to limit the size of data for now. Once new lefthand API is
+        # available, replace this call.
+        total_volumes = 0
+        volumes = client.getVolumes(
+            cluster=self.configuration.hplefthand_clustername,
+            fields=['members[id]', 'members[clusterName]'])
+        if volumes:
+            total_volumes = volumes['total']
+        data['capacity_utilization'] = capacity_utilization
+        data['total_volumes'] = total_volumes
+        data['filter_function'] = self.get_filter_function()
+        data['goodness_function'] = self.get_goodness_function()
+
         self.device_stats = data
 
     def initialize_connection(self, volume, connector):