From ee0e16ce5bcc6e2fb377d7524ff20ae0c7c95ff4 Mon Sep 17 00:00:00 2001
From: jessewu <jessewu@synology.com>
Date: Mon, 8 Jan 2018 15:36:17 +0800
Subject: [PATCH] Synology: Rename iSCSI target config option

When the config option iscsi_ip_address was renamed to
target_ip_address, one place was missed.
Also updated the documentation and renamed related internal variable
names.

Change-Id: I356d44eeb904ab788427c8315c9ad5755802c90d
Related-Change: https://review.openstack.org/528515
---
 .../drivers/synology/test_synology_common.py     |  4 ++--
 .../volume/drivers/synology/synology_common.py   | 16 ++++++++--------
 .../drivers/synology-dsm-driver.rst              |  4 ++--
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/cinder/tests/unit/volume/drivers/synology/test_synology_common.py b/cinder/tests/unit/volume/drivers/synology/test_synology_common.py
index 34e9aaca347..592ccdab14a 100644
--- a/cinder/tests/unit/volume/drivers/synology/test_synology_common.py
+++ b/cinder/tests/unit/volume/drivers/synology/test_synology_common.py
@@ -460,7 +460,7 @@ class SynoCommonTestCase(test.TestCase):
         self.common.vendor_name = 'Synology'
         self.common.driver_type = 'iscsi'
         self.common.volume_backend_name = 'DiskStation'
-        self.common.iscsi_port = 3260
+        self.common.target_port = 3260
 
     def setup_configuration(self):
         config = mock.Mock(spec=conf.Configuration)
@@ -1355,7 +1355,7 @@ class SynoCommonTestCase(test.TestCase):
             'total_capacity_gb': 100,
             'provisioned_capacity_gb': 350,
             'max_over_subscription_ratio': 20,
-            'iscsi_ip_address': '10.0.0.1',
+            'target_ip_address': '10.0.0.1',
             'pool_name': 'volume1',
             'backend_info':
                 'Synology:iscsi:72003c93-2db2-4f00-a169-67c5eae86bb1'
diff --git a/cinder/volume/drivers/synology/synology_common.py b/cinder/volume/drivers/synology/synology_common.py
index 8b0d11a2214..818d88e828a 100644
--- a/cinder/volume/drivers/synology/synology_common.py
+++ b/cinder/volume/drivers/synology/synology_common.py
@@ -396,9 +396,9 @@ class SynoCommon(object):
     METADATA_DS_SNAPSHOT_UUID = 'ds_snapshot_UUID'
 
     def __init__(self, config, driver_type):
-        if not config.safe_get('iscsi_ip_address'):
+        if not config.safe_get('target_ip_address'):
             raise exception.InvalidConfigurationValue(
-                option='iscsi_ip_address',
+                option='target_ip_address',
                 value='')
         if not config.safe_get('synology_pool_name'):
             raise exception.InvalidConfigurationValue(
@@ -409,7 +409,7 @@ class SynoCommon(object):
         self.vendor_name = 'Synology'
         self.driver_type = driver_type
         self.volume_backend_name = self._get_backend_name()
-        self.iscsi_port = self.config.safe_get('target_port')
+        self.target_port = self.config.safe_get('target_port')
 
         api = APIRequest(self.config.target_ip_address,
                          self.config.synology_admin_port,
@@ -965,12 +965,12 @@ class SynoCommon(object):
 
     def get_provider_location(self, iqn, trg_id):
         portals = ['%(ip)s:%(port)d' % {'ip': self.get_ip(),
-                                        'port': self.iscsi_port}]
+                                        'port': self.target_port}]
         sec_ips = self.config.safe_get('iscsi_secondary_ip_addresses')
         for ip in sec_ips:
             portals.append('%(ip)s:%(port)d' %
                            {'ip': ip,
-                            'port': self.iscsi_port})
+                            'port': self.target_port})
 
         return '%s,%d %s 0' % (
             ';'.join(portals),
@@ -1034,7 +1034,7 @@ class SynoCommon(object):
         data['max_over_subscription_ratio'] = (self.config.
                                                max_over_subscription_ratio)
 
-        data['iscsi_ip_address'] = self.config.target_ip_address
+        data['target_ip_address'] = self.config.target_ip_address
         data['pool_name'] = self.config.synology_pool_name
         data['backend_info'] = ('%s:%s:%s' %
                                 (self.vendor_name,
@@ -1256,7 +1256,7 @@ class SynoCommon(object):
             'target_discovered': False,
             'target_iqn': iqn,
             'target_portal': '%(ip)s:%(port)d' % {'ip': self.get_ip(),
-                                                  'port': self.iscsi_port},
+                                                  'port': self.target_port},
             'volume_id': volume['id'],
             'access_mode': 'rw',
             'discard': False
@@ -1267,7 +1267,7 @@ class SynoCommon(object):
             for ip in ips:
                 target_portals.append('%(ip)s:%(port)d' %
                                       {'ip': ip,
-                                       'port': self.iscsi_port})
+                                       'port': self.target_port})
             iscsi_properties.update(target_portals=target_portals)
             count = len(target_portals)
             iscsi_properties.update(target_iqns=
diff --git a/doc/source/configuration/block-storage/drivers/synology-dsm-driver.rst b/doc/source/configuration/block-storage/drivers/synology-dsm-driver.rst
index aaa5ed2667a..eee9d6c6bb6 100755
--- a/doc/source/configuration/block-storage/drivers/synology-dsm-driver.rst
+++ b/doc/source/configuration/block-storage/drivers/synology-dsm-driver.rst
@@ -77,8 +77,8 @@ established. Below is an example of a basic configuration:
 
    # Required settings
    volume_driver = cinder.volume.drivers.synology.synology_iscsi.SynoISCSIDriver
-   iscs_protocol = iscsi
-   iscsi_ip_address = DS_IP
+   target_protocol = iscsi
+   target_ip_address = DS_IP
    synology_admin_port = DS_PORT
    synology_username = DS_USER
    synology_password = DS_PW