From c55002f0ae7bd6beff2eef2d078904f017b90a67 Mon Sep 17 00:00:00 2001
From: Maciej Szwed <maciej.szwed@intel.com>
Date: Thu, 30 Apr 2020 12:44:12 +0200
Subject: [PATCH] [SPDK] Add https protocol option to communicate with SPDK

Currently only http is available to communicate with SPDK
backend. This patch adds option to switch to https.

Signed-off-by: Maciej Szwed <maciej.szwed@intel.com>
Change-Id: Ice54adf6bb9456a53d10f6c5f0a1e2d0c8e58149
---
 cinder/tests/unit/targets/test_spdknvmf.py    | 31 +++++++++++++++++++
 cinder/tests/unit/volume/drivers/test_spdk.py |  1 +
 cinder/volume/drivers/spdk.py                 |  5 +--
 cinder/volume/targets/spdknvmf.py             |  9 ++++--
 4 files changed, 42 insertions(+), 4 deletions(-)

diff --git a/cinder/tests/unit/targets/test_spdknvmf.py b/cinder/tests/unit/targets/test_spdknvmf.py
index 0ccdb006d42..e9992399123 100644
--- a/cinder/tests/unit/targets/test_spdknvmf.py
+++ b/cinder/tests/unit/targets/test_spdknvmf.py
@@ -14,6 +14,8 @@ import copy
 import json
 from unittest import mock
 
+import requests
+
 from cinder.tests.unit import test
 from cinder.volume import configuration as conf
 from cinder.volume.targets import spdknvmf as spdknvmf_driver
@@ -355,10 +357,39 @@ class SpdkNvmfDriverTestCase(test.TestCase):
         self.configuration.target_protocol = "nvmet_rdma"
         self.configuration.spdk_rpc_ip = "127.0.0.1"
         self.configuration.spdk_rpc_port = 8000
+        self.configuration.spdk_rpc_protocol = "https"
+        self.configuration.spdk_rpc_username = "user"
+        self.configuration.spdk_rpc_password = "password"
+        self.configuration.driver_ssl_cert_verify = False
         self.driver = spdknvmf_driver.SpdkNvmf(configuration=
                                                self.configuration)
         self.jsonrpcclient = JSONRPCClient()
 
+    def get_item(self):
+        return {'result': 'test_result'}
+
+    def test__rpc_parameters(self):
+        url = ('%(protocol)s://%(ip)s:%(port)s/' %
+               {'protocol': self.configuration.spdk_rpc_protocol,
+                'ip': self.configuration.spdk_rpc_ip,
+                'port': self.configuration.spdk_rpc_port})
+        auth = (self.configuration.spdk_rpc_username,
+                self.configuration.spdk_rpc_password)
+        verify = self.configuration.driver_ssl_cert_verify
+
+        requests.post = mock.MagicMock()
+        setattr(requests.post.service.__getitem__,
+                'side_effect',
+                self.get_item)
+
+        self.driver._rpc_call("bdev_get_bdevs")
+
+        requests.post.assert_called_once_with(url,
+                                              auth=auth,
+                                              data=mock.ANY,
+                                              timeout=mock.ANY,
+                                              verify=verify)
+
     def test__get_spdk_volume_name(self):
         with mock.patch.object(self.driver, "_rpc_call",
                                self.jsonrpcclient.call):
diff --git a/cinder/tests/unit/volume/drivers/test_spdk.py b/cinder/tests/unit/volume/drivers/test_spdk.py
index a6c701b7c62..e2f8590322d 100644
--- a/cinder/tests/unit/volume/drivers/test_spdk.py
+++ b/cinder/tests/unit/volume/drivers/test_spdk.py
@@ -510,6 +510,7 @@ class SpdkDriverTestCase(test.TestCase):
         self.configuration.target_protocol = "nvmet_rdma"
         self.configuration.spdk_rpc_ip = "127.0.0.1"
         self.configuration.spdk_rpc_port = 8000
+        self.configuration.spdk_rpc_protocol = "https"
         mock_safe_get = mock.Mock()
         mock_safe_get.return_value = 'spdk-nvmeof'
         self.configuration.safe_get = mock_safe_get
diff --git a/cinder/volume/drivers/spdk.py b/cinder/volume/drivers/spdk.py
index ff7411f481a..c92310ed266 100644
--- a/cinder/volume/drivers/spdk.py
+++ b/cinder/volume/drivers/spdk.py
@@ -198,8 +198,9 @@ class SPDKDriver(driver.VolumeDriver):
     def do_setup(self, context):
         try:
             payload = {'method': 'bdev_get_bdevs', 'jsonrpc': '2.0', 'id': 1}
-            self.url = ('http://%(ip)s:%(port)s/' %
-                        {'ip': self.configuration.spdk_rpc_ip,
+            self.url = ('%(protocol)s://%(ip)s:%(port)s/' %
+                        {'protocol': self.configuration.spdk_rpc_protocol,
+                         'ip': self.configuration.spdk_rpc_ip,
                          'port': self.configuration.spdk_rpc_port})
             requests.post(self.url,
                           data=json.dumps(payload),
diff --git a/cinder/volume/targets/spdknvmf.py b/cinder/volume/targets/spdknvmf.py
index 480acc0303a..a90b0b77dc7 100644
--- a/cinder/volume/targets/spdknvmf.py
+++ b/cinder/volume/targets/spdknvmf.py
@@ -34,6 +34,10 @@ spdk_opts = [
     cfg.StrOpt('spdk_rpc_password',
                help='The NVMe target remote configuration password.',
                secret=True),
+    cfg.StrOpt('spdk_rpc_protocol',
+               choices=['http', 'https'],
+               default='http',
+               help='Protocol to be used with SPDK RPC proxy'),
     cfg.IntOpt('spdk_max_queue_depth',
                default=64,
                min=1, max=128,
@@ -52,8 +56,9 @@ class SpdkNvmf(nvmeof.NVMeOF):
         super(SpdkNvmf, self).__init__(*args, **kwargs)
 
         self.configuration.append_config_values(spdk_opts)
-        self.url = ('http://%(ip)s:%(port)s/' %
-                    {'ip': self.configuration.spdk_rpc_ip,
+        self.url = ('%(protocol)s://%(ip)s:%(port)s/' %
+                    {'protocol': self.configuration.spdk_rpc_protocol,
+                     'ip': self.configuration.spdk_rpc_ip,
                      'port': self.configuration.spdk_rpc_port})
 
         # SPDK NVMe-oF Target application requires one time creation