# Copyright (C) 2020, 2024, Hitachi, Ltd.
# Copyright (C) 2025, Hitachi Vantara
#
#    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.
#
"""Unit tests for Hitachi HBSD Driver."""

from unittest import mock

from oslo_config import cfg
import requests

from cinder import context as cinder_context
from cinder.db import api as sqlalchemy_api
from cinder import exception
from cinder.objects import group_snapshot as obj_group_snap
from cinder.objects import snapshot as obj_snap
from cinder.tests.unit import fake_group
from cinder.tests.unit import fake_group_snapshot
from cinder.tests.unit import fake_snapshot
from cinder.tests.unit import fake_volume
from cinder.tests.unit import test
from cinder.volume import configuration as conf
from cinder.volume import driver
from cinder.volume.drivers.hitachi import hbsd_common
from cinder.volume.drivers.hitachi import hbsd_iscsi
from cinder.volume.drivers.hitachi import hbsd_replication
from cinder.volume.drivers.hitachi import hbsd_rest
from cinder.volume.drivers.hitachi import hbsd_rest_api
from cinder.volume.drivers.hitachi import hbsd_rest_fc
from cinder.volume import volume_types
from cinder.volume import volume_utils

# Configuration parameter values
CONFIG_MAP = {
    'serial': '886000123456',
    'my_ip': '127.0.0.1',
    'rest_server_ip_addr': '172.16.18.108',
    'rest_server_ip_port': '23451',
    'port_id': 'CL1-A',
    'host_grp_name': 'HBSD-127.0.0.1',
    'host_mode': 'LINUX/IRIX',
    'host_iscsi_name': 'iqn.hbsd-test-host',
    'target_iscsi_name': 'iqn.hbsd-test-target',
    'user_id': 'user',
    'user_pass': 'password',
    'pool_name': 'test_pool',
    'ipv4Address': '111.22.333.44',
    'tcpPort': '5555',
    'auth_user': 'auth_user',
    'auth_password': 'auth_password',
}

DEFAULT_CONNECTOR = {
    'host': 'host',
    'ip': CONFIG_MAP['my_ip'],
    'initiator': CONFIG_MAP['host_iscsi_name'],
    'multipath': False,
}

CTXT = cinder_context.get_admin_context()

TEST_VOLUME = []
for i in range(5):
    volume = {}
    volume['id'] = '00000000-0000-0000-0000-{0:012d}'.format(i)
    volume['name'] = 'test-volume{0:d}'.format(i)
    volume['volume_type_id'] = '00000000-0000-0000-0000-{0:012d}'.format(i)
    if i == 3 or i == 4:
        volume['provider_location'] = None
    else:
        volume['provider_location'] = '{0:d}'.format(i)
    volume['size'] = 128
    if i == 2:
        volume['status'] = 'in-use'
    elif i == 4:
        volume['status'] = None
    else:
        volume['status'] = 'available'
    volume = fake_volume.fake_volume_obj(CTXT, **volume)
    volume.volume_type = fake_volume.fake_volume_type_obj(CTXT)
    TEST_VOLUME.append(volume)


def _volume_get(context, volume_id):
    """Return predefined volume info."""
    return TEST_VOLUME[int(volume_id.replace("-", ""))]


TEST_SNAPSHOT = []
for i in range(2):
    snapshot = {}
    snapshot['id'] = '10000000-0000-0000-0000-{0:012d}'.format(i)
    snapshot['name'] = 'TEST_SNAPSHOT{0:d}'.format(i)
    snapshot['provider_location'] = '{0:d}'.format(i + 1)
    snapshot['status'] = 'available'
    snapshot['volume_id'] = '00000000-0000-0000-0000-{0:012d}'.format(i)
    snapshot['volume'] = _volume_get(None, snapshot['volume_id'])
    snapshot['volume_name'] = 'test-volume{0:d}'.format(i)
    snapshot['volume_size'] = 128
    if i == 1:
        snapshot['volume_type_id'] =\
            '00000000-0000-0000-0000-{0:012d}'.format(i)
    snapshot = obj_snap.Snapshot._from_db_object(
        CTXT, obj_snap.Snapshot(),
        fake_snapshot.fake_db_snapshot(**snapshot))
    TEST_SNAPSHOT.append(snapshot)

TEST_GROUP = []
for i in range(2):
    group = {}
    group['id'] = '20000000-0000-0000-0000-{0:012d}'.format(i)
    group['status'] = 'available'
    group = fake_group.fake_group_obj(CTXT, **group)
    TEST_GROUP.append(group)

TEST_GROUP_SNAP = []
group_snapshot = {}
group_snapshot['id'] = '30000000-0000-0000-0000-{0:012d}'.format(0)
group_snapshot['status'] = 'available'
group_snapshot = obj_group_snap.GroupSnapshot._from_db_object(
    CTXT, obj_group_snap.GroupSnapshot(),
    fake_group_snapshot.fake_db_group_snapshot(**group_snapshot))
TEST_GROUP_SNAP.append(group_snapshot)

# Dummy response for REST API
POST_SESSIONS_RESULT = {
    "token": "b74777a3-f9f0-4ea8-bd8f-09847fac48d3",
    "sessionId": 0,
}

GET_PORTS_RESULT = {
    "data": [
        {
            "portId": CONFIG_MAP['port_id'],
            "portType": "ISCSI",
            "portAttributes": [
                "TAR",
                "MCU",
                "RCU",
                "ELUN"
            ],
            "portSpeed": "AUT",
            "loopId": "00",
            "fabricMode": False,
            "lunSecuritySetting": True,
        },
    ],
}

GET_PORT_RESULT = {
    "ipv4Address": CONFIG_MAP['ipv4Address'],
    "tcpPort": CONFIG_MAP['tcpPort'],
}

GET_HOST_ISCSIS_RESULT = {
    "data": [
        {
            "hostGroupNumber": 0,
            "iscsiName": CONFIG_MAP['host_iscsi_name'],
        },
    ],
}

GET_HOST_GROUP_RESULT = {
    "hostGroupName": CONFIG_MAP['host_grp_name'],
    "iscsiName": CONFIG_MAP['target_iscsi_name'],
}

GET_HOST_GROUPS_RESULT = {
    "data": [
        {
            "hostGroupNumber": 0,
            "portId": CONFIG_MAP['port_id'],
            "hostGroupName": "HBSD-test",
            "iscsiName": CONFIG_MAP['target_iscsi_name'],
        },
    ],
}

COMPLETED_SUCCEEDED_RESULT = {
    "status": "Completed",
    "state": "Succeeded",
    "affectedResources": ('a/b/c/1',),
}

GET_LDEV_RESULT = {
    "emulationType": "OPEN-V-CVS",
    "blockCapacity": 2097152,
    "attributes": ["CVS", "HDP"],
    "status": "NML",
    "poolId": 30,
    "dataReductionStatus": "DISABLED",
    "dataReductionMode": "disabled",
    "label": "00000000000000000000000000000000",
}

GET_LDEV_RESULT_SNAP = {
    "emulationType": "OPEN-V-CVS",
    "blockCapacity": 2097152,
    "attributes": ["CVS", "HDP"],
    "status": "NML",
    "poolId": 30,
    "dataReductionStatus": "DISABLED",
    "dataReductionMode": "disabled",
    "label": "10000000000000000000000000000000",
}

GET_LDEV_RESULT_MAPPED = {
    "emulationType": "OPEN-V-CVS",
    "blockCapacity": 2097152,
    "attributes": ["CVS", "HDP"],
    "status": "NML",
    "ports": [
        {
            "portId": CONFIG_MAP['port_id'],
            "hostGroupNumber": 0,
            "hostGroupName": CONFIG_MAP['host_grp_name'],
            "lun": 1
        },
    ],
}

GET_LDEV_RESULT_PAIR = {
    "emulationType": "OPEN-V-CVS",
    "blockCapacity": 2097152,
    "attributes": ["CVS", "HDP", "HTI"],
    "status": "NML",
    "label": "10000000000000000000000000000000",
}

GET_POOLS_RESULT = {
    "data": [
        {
            "poolId": 30,
            "poolName": CONFIG_MAP['pool_name'],
            "availableVolumeCapacity": 480144,
            "totalPoolCapacity": 507780,
            "totalLocatedCapacity": 71453172,
            "virtualVolumeCapacityRate": -1,
        },
    ],
}

GET_SNAPSHOTS_RESULT = {
    "data": [
        {
            "primaryOrSecondary": "S-VOL",
            "status": "PSUS",
            "pvolLdevId": 0,
            "muNumber": 1,
            "svolLdevId": 1,
        },
    ],
}

GET_SNAPSHOTS_RESULT_PAIR = {
    "data": [
        {
            "primaryOrSecondary": "S-VOL",
            "status": "PAIR",
            "pvolLdevId": 0,
            "muNumber": 1,
            "svolLdevId": 1,
        },
    ],
}

GET_HOST_GROUPS_RESULT_PAIR = {
    "data": [
        {
            "hostGroupNumber": 1,
            "portId": CONFIG_MAP['port_id'],
            "hostGroupName": "HBSD-pair00",
        },
    ],
}

GET_LDEVS_RESULT = {
    "data": [
        {
            "ldevId": 0,
            "label": "15960cc738c94c5bb4f1365be5eeed44",
        },
        {
            "ldevId": 1,
            "label": "15960cc738c94c5bb4f1365be5eeed45",
        },
    ],
}

NOTFOUND_RESULT = {
    "data": [],
}


def _brick_get_connector_properties(multipath=False, enforce_multipath=False):
    """Return a predefined connector object."""
    return DEFAULT_CONNECTOR


class FakeResponse():

    def __init__(self, status_code, data=None, headers=None):
        self.status_code = status_code
        self.data = data
        self.text = data
        self.content = data
        self.headers = {'Content-Type': 'json'} if headers is None else headers

    def json(self):
        return self.data


class HBSDRESTISCSIDriverTest(test.TestCase):
    """Unit test class for HBSD REST interface iSCSI module."""

    test_existing_ref = {'source-id': '1'}
    test_existing_ref_name = {
        'source-name': '15960cc7-38c9-4c5b-b4f1-365be5eeed45'}

    def setUp(self):
        """Set up the test environment."""
        def _set_required(opts, required):
            for opt in opts:
                opt.required = required

        # Initialize Cinder and avoid checking driver options.
        rest_required_opts = [
            opt for opt in hbsd_rest.REST_VOLUME_OPTS if opt.required]
        common_required_opts = [
            opt for opt in hbsd_common.COMMON_VOLUME_OPTS if opt.required]
        _set_required(rest_required_opts, False)
        _set_required(common_required_opts, False)
        super(HBSDRESTISCSIDriverTest, self).setUp()
        _set_required(rest_required_opts, True)
        _set_required(common_required_opts, True)

        self.configuration = conf.Configuration(
            hbsd_rest.REST_VOLUME_OPTS + hbsd_rest.REST_PAIR_OPTS +
            hbsd_common.COMMON_VOLUME_OPTS + hbsd_common.COMMON_PORT_OPTS +
            hbsd_common.COMMON_PAIR_OPTS + hbsd_common.COMMON_NAME_OPTS +
            hbsd_common.COMMON_EXTEND_OPTS + hbsd_replication._REP_OPTS +
            hbsd_replication.COMMON_REPLICATION_OPTS +
            hbsd_replication.COMMON_MIRROR_OPTS +
            hbsd_replication.ISCSI_MIRROR_OPTS +
            hbsd_replication.REST_MIRROR_OPTS +
            hbsd_replication.REST_MIRROR_API_OPTS +
            hbsd_replication.REST_MIRROR_SSL_OPTS +
            hbsd_rest_fc.FC_VOLUME_OPTS,
            conf.SHARED_CONF_GROUP)

        self.ctxt = cinder_context.get_admin_context()
        self._setup_config()
        self._setup_driver()

    def _setup_config(self):
        """Set configuration parameter values."""

        self.override_config('volume_backend_name', "RESTISCSI",
                             group=conf.SHARED_CONF_GROUP)
        self.override_config(
            'volume_driver',
            "cinder.volume.drivers.hitachi.hbsd_iscsi.HBSDISCSIDriver",
            group=conf.SHARED_CONF_GROUP)
        self.override_config('reserved_percentage', "0",
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('use_multipath_for_image_xfer', False,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('enforce_multipath_for_image_xfer', False,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('max_over_subscription_ratio', 500.0,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('driver_ssl_cert_verify', False,
                             group=conf.SHARED_CONF_GROUP)

        self.override_config('hitachi_storage_id', CONFIG_MAP['serial'],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_pools', ['30'],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_snap_pool', None,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_ldev_range', "0-1",
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_target_ports', [CONFIG_MAP['port_id']],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_compute_target_ports',
                             [CONFIG_MAP['port_id']],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_group_create', True,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_group_delete', True,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_copy_speed', 3,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_copy_check_interval', 3,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_async_copy_check_interval', 10,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_manage_drs_volumes', False,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_port_scheduler', False,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_group_name_format', None,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_extend_snapshot_volumes', False,
                             group=conf.SHARED_CONF_GROUP)

        self.override_config('san_login', CONFIG_MAP['user_id'],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('san_password', CONFIG_MAP['user_pass'],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('san_ip', CONFIG_MAP['rest_server_ip_addr'],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('san_api_port', CONFIG_MAP['rest_server_ip_port'],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_disable_io_wait', True,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_tcp_keepalive', True,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_discard_zero_page', True,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_lun_timeout', hbsd_rest._LUN_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_lun_retry_interval',
                             hbsd_rest._LUN_RETRY_INTERVAL,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_restore_timeout',
                             hbsd_rest._RESTORE_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_state_transition_timeout',
                             hbsd_rest._STATE_TRANSITION_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_lock_timeout',
                             hbsd_rest_api._LOCK_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_timeout',
                             hbsd_rest_api._REST_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_extend_timeout',
                             hbsd_rest_api._EXTEND_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_exec_retry_interval',
                             hbsd_rest_api._EXEC_RETRY_INTERVAL,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_connect_timeout',
                             hbsd_rest_api._DEFAULT_CONNECT_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_job_api_response_timeout',
                             hbsd_rest_api._JOB_API_RESPONSE_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_get_api_response_timeout',
                             hbsd_rest_api._GET_API_RESPONSE_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_server_busy_timeout',
                             hbsd_rest_api._REST_SERVER_BUSY_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_keep_session_loop_interval',
                             hbsd_rest_api._KEEP_SESSION_LOOP_INTERVAL,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_another_ldev_mapped_retry_timeout',
                             hbsd_rest_api._ANOTHER_LDEV_MAPPED_RETRY_TIMEOUT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_tcp_keepidle',
                             hbsd_rest_api._TCP_KEEPIDLE,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_tcp_keepintvl',
                             hbsd_rest_api._TCP_KEEPINTVL,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_tcp_keepcnt',
                             hbsd_rest_api._TCP_KEEPCNT,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_host_mode_options', [],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_use_object_caching', False,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_max_request_workers',
                             hbsd_rest_api._MAX_REQUEST_WORKERS,
                             group=conf.SHARED_CONF_GROUP)

        self.override_config('use_chap_auth', True,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('chap_username', CONFIG_MAP['auth_user'],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('chap_password', CONFIG_MAP['auth_password'],
                             group=conf.SHARED_CONF_GROUP)

        self.override_config('san_thin_provision', True,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('san_private_key', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('san_clustername', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('san_ssh_port', '22',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('san_is_local', False,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('ssh_conn_timeout', '30',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('ssh_min_pool_conn', '1',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('ssh_max_pool_conn', '5',
                             group=conf.SHARED_CONF_GROUP)

        self.override_config('hitachi_pair_target_number', 0,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_rest_pair_target_ports', [],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_quorum_disk_id', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_storage_id', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_pool', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_ldev_range', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_target_ports', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_rest_user', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_rest_password', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_rest_api_ip', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_rest_api_port', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_set_mirror_reserve_attribute', True,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_path_group_id', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_compute_target_ports', [],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_rest_pair_target_ports', [],
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_snap_pool', None,
                             group=conf.SHARED_CONF_GROUP)

        self.override_config('hitachi_mirror_ssl_cert_verify', False,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_ssl_cert_path', '',
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_auth_password', None,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_auth_user', None,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_mirror_use_chap_auth', False,
                             group=conf.SHARED_CONF_GROUP)

        self.override_config('hitachi_replication_status_check_short_interval',
                             5, group=conf.SHARED_CONF_GROUP)
        self.override_config(
            'hitachi_replication_status_check_long_interval',
            10 * 60,
            group=conf.SHARED_CONF_GROUP)
        self.override_config(
            'hitachi_replication_status_check_timeout',
            24 * 60 * 60,
            group=conf.SHARED_CONF_GROUP)

        self.override_config('hitachi_replication_number', 0,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_replication_mun', 1,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_replication_journal_size', None,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_replication_journal_overflow_tolerance',
                             60, group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_replication_journal_use_cache', True,
                             group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_replication_journal_transfer_speed',
                             256, group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_replication_journal_creation_speed',
                             'L', group=conf.SHARED_CONF_GROUP)
        self.override_config(
            'hitachi_replication_journal_path_failure_tolerance',
            5, group=conf.SHARED_CONF_GROUP)
        self.override_config('hitachi_replication_copy_speed', 3,
                             group=conf.SHARED_CONF_GROUP)

        self.override_config('replication_device', '',
                             group=conf.SHARED_CONF_GROUP)

        CONF = cfg.CONF
        CONF.my_ip = CONFIG_MAP['my_ip']

    def _fake_safe_get(self, value):
        """Retrieve a configuration value avoiding throwing an exception."""
        try:
            val = getattr(self.configuration, value)
        except AttributeError:
            val = None
        return val

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(
        volume_utils, 'brick_get_connector_properties',
        side_effect=_brick_get_connector_properties)
    def _setup_driver(
            self, brick_get_connector_properties=None, request=None):
        """Set up the driver environment."""
        self.driver = hbsd_iscsi.HBSDISCSIDriver(
            configuration=self.configuration)
        request.side_effect = [FakeResponse(200, POST_SESSIONS_RESULT),
                               FakeResponse(200, GET_PORTS_RESULT),
                               FakeResponse(200, GET_PORT_RESULT),
                               FakeResponse(200, GET_HOST_ISCSIS_RESULT),
                               FakeResponse(200, GET_HOST_GROUP_RESULT),
                               FakeResponse(200, GET_HOST_GROUPS_RESULT_PAIR)]
        self.driver.do_setup(None)
        self.driver.check_for_setup_error()
        self.driver.local_path(None)
        self.driver.create_export(None, None, None)
        self.driver.ensure_export(None, None)
        self.driver.remove_export(None, None)
        self.driver.create_export_snapshot(None, None, None)
        self.driver.remove_export_snapshot(None, None)
        # stop the Loopingcall within the do_setup treatment
        # We also added an initial delay of the actual session value
        # since the initialization with threads is slower than
        # the initial run of the looping call.
        self.driver.common.client.keep_session_loop.stop()

    def tearDown(self):
        self.client = None
        super(HBSDRESTISCSIDriverTest, self).tearDown()

    # API test cases
    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(
        volume_utils, 'brick_get_connector_properties',
        side_effect=_brick_get_connector_properties)
    def test_do_setup(self, brick_get_connector_properties, request):
        drv = hbsd_iscsi.HBSDISCSIDriver(
            configuration=self.configuration)
        self._setup_config()
        request.side_effect = [FakeResponse(200, POST_SESSIONS_RESULT),
                               FakeResponse(200, GET_PORTS_RESULT),
                               FakeResponse(200, GET_PORT_RESULT),
                               FakeResponse(200, GET_HOST_ISCSIS_RESULT),
                               FakeResponse(200, GET_HOST_GROUP_RESULT),
                               FakeResponse(200, GET_HOST_GROUPS_RESULT_PAIR)]
        drv.do_setup(None)
        self.assertEqual(
            {CONFIG_MAP['port_id']:
                '%(ip)s:%(port)s' % {
                    'ip': CONFIG_MAP['ipv4Address'],
                    'port': CONFIG_MAP['tcpPort']}},
            drv.common.storage_info['portals'])
        self.assertEqual(1, brick_get_connector_properties.call_count)
        self.assertEqual(6, request.call_count)
        # stop the Loopingcall within the do_setup treatment
        # We also added an initial delay of the actual session value
        # since the initialization with threads is slower than
        # the initial run of the looping call.
        drv.common.client.keep_session_loop.stop()

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(
        volume_utils, 'brick_get_connector_properties',
        side_effect=_brick_get_connector_properties)
    def test_do_setup_create_hg(self, brick_get_connector_properties, request):
        """Normal case: The host group not exists."""
        drv = hbsd_iscsi.HBSDISCSIDriver(
            configuration=self.configuration)
        self._setup_config()
        request.side_effect = [FakeResponse(200, POST_SESSIONS_RESULT),
                               FakeResponse(200, GET_PORTS_RESULT),
                               FakeResponse(200, GET_PORT_RESULT),
                               FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_HOST_GROUPS_RESULT_PAIR)]
        drv.do_setup(None)
        self.assertEqual(
            {CONFIG_MAP['port_id']:
                '%(ip)s:%(port)s' % {
                    'ip': CONFIG_MAP['ipv4Address'],
                    'port': CONFIG_MAP['tcpPort']}},
            drv.common.storage_info['portals'])
        self.assertEqual(1, brick_get_connector_properties.call_count)
        self.assertEqual(9, request.call_count)
        # stop the Loopingcall within the do_setup treatment
        drv.common.client.keep_session_loop.stop()

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(
        volume_utils, 'brick_get_connector_properties',
        side_effect=_brick_get_connector_properties)
    def test_do_setup_create_hg_format(
            self, brick_get_connector_properties, request):
        drv = hbsd_iscsi.HBSDISCSIDriver(configuration=self.configuration)
        self._setup_config()
        self.override_config('hitachi_group_name_format',
                             'HBSD-{ip}@{host}-_:.',
                             group=conf.SHARED_CONF_GROUP)
        request.side_effect = [FakeResponse(200, POST_SESSIONS_RESULT),
                               FakeResponse(200, GET_PORTS_RESULT),
                               FakeResponse(200, GET_PORT_RESULT),
                               FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_HOST_GROUPS_RESULT_PAIR)]
        drv.do_setup(None)
        self.assertEqual(
            {CONFIG_MAP['port_id']:
                '%(ip)s:%(port)s' % {
                    'ip': CONFIG_MAP['ipv4Address'],
                    'port': CONFIG_MAP['tcpPort']}},
            drv.common.storage_info['portals'])
        self.assertEqual(1, brick_get_connector_properties.call_count)
        self.assertEqual(9, request.call_count)
        # stop the Loopingcall within the do_setup treatment
        drv.common.client.keep_session_loop.stop()

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(
        volume_utils, 'brick_get_connector_properties',
        side_effect=_brick_get_connector_properties)
    def test_do_setup_create_hg_format_error(
            self, brick_get_connector_properties, request):
        drv = hbsd_iscsi.HBSDISCSIDriver(configuration=self.configuration)
        self._setup_config()
        self.override_config('hitachi_group_name_format',
                             'HBSD-{ip}@{host}ZZZZZZZZZZZ',
                             group=conf.SHARED_CONF_GROUP)
        request.side_effect = [FakeResponse(200, POST_SESSIONS_RESULT),
                               FakeResponse(200, GET_PORTS_RESULT),
                               FakeResponse(200, GET_PORT_RESULT),
                               FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.assertRaises(exception.VolumeDriverException, drv.do_setup, None)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_extend_volume(self, get_volume_type_qos_specs,
                           request):
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.extend_volume(TEST_VOLUME[0], 256)
        self.assertEqual(5, request.call_count)
        body = request.call_args_list[4][1]['json']
        self.assertNotIn('enhancedExpansion', body['parameters'])

    @mock.patch.object(hbsd_common.HBSDCommon, "delete_pair")
    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_extend_volume_enable_having_snapshots(self,
                                                   get_volume_type_qos_specs,
                                                   request, delete_pair):
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        self.override_config('hitachi_extend_snapshot_volumes',
                             True, group=conf.SHARED_CONF_GROUP)
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT_PAIR),
                               FakeResponse(200, GET_LDEV_RESULT_PAIR),
                               FakeResponse(200, GET_LDEV_RESULT_PAIR),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.extend_volume(TEST_VOLUME[0], 256)
        self.assertEqual(4, request.call_count)
        body = request.call_args_list[3][1]['json']
        self.assertTrue(body['parameters']['enhancedExpansion'])

    @mock.patch.object(driver.ISCSIDriver, "get_goodness_function")
    @mock.patch.object(driver.ISCSIDriver, "get_filter_function")
    @mock.patch.object(requests.Session, "request")
    def test__update_volume_stats(
            self, request, get_filter_function, get_goodness_function):
        request.return_value = FakeResponse(200, GET_POOLS_RESULT)
        get_filter_function.return_value = None
        get_goodness_function.return_value = None
        self.driver._update_volume_stats()
        self.assertEqual('Hitachi', self.driver._stats['vendor_name'])
        self.assertTrue(self.driver._stats["pools"][0]['multiattach'])
        self.assertEqual(1, request.call_count)
        self.assertEqual(1, get_filter_function.call_count)
        self.assertEqual(1, get_goodness_function.call_count)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_volume(self, get_volume_type_qos_specs,
                           get_volume_type_extra_specs, request):
        request.return_value = FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)
        get_volume_type_extra_specs.return_value = {}
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        ret = self.driver.create_volume(TEST_VOLUME[4])
        self.assertEqual('1', ret['provider_location'])
        self.assertEqual(2, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_delete_volume(self, request):
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.delete_volume(TEST_VOLUME[0])
        self.assertEqual(4, request.call_count)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(sqlalchemy_api, 'volume_get', side_effect=_volume_get)
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_snapshot(
            self, get_volume_type_qos_specs, volume_get,
            get_volume_type_extra_specs, request):
        get_volume_type_extra_specs.return_value = {}
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        ret = self.driver.create_snapshot(TEST_SNAPSHOT[0])
        self.assertEqual('1', ret['provider_location'])
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(1, get_volume_type_qos_specs.call_count)
        self.assertEqual(5, request.call_count)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(sqlalchemy_api, 'volume_get', side_effect=_volume_get)
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_snapshot_qos(
            self, get_volume_type_qos_specs, volume_get,
            get_volume_type_extra_specs, request):
        input_qos_specs = {
            'qos_specs': {
                'consumer': 'back-end',
                'specs': {'upperIops': '1000'}}}
        get_volume_type_qos_specs.return_value = input_qos_specs
        get_volume_type_extra_specs.return_value = {}
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        ret = self.driver.create_snapshot(TEST_SNAPSHOT[1])
        self.assertEqual('1', ret['provider_location'])
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(1, get_volume_type_qos_specs.call_count)
        self.assertEqual(6, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_delete_snapshot(self, request):
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT_SNAP),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.delete_snapshot(TEST_SNAPSHOT[0])
        self.assertEqual(4, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_delete_snapshot_is_invalid_ldev(self, request):
        request.return_value = FakeResponse(200, GET_LDEV_RESULT)
        self.driver.delete_snapshot(TEST_SNAPSHOT[0])
        self.assertEqual(1, request.call_count)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_cloned_volume(self, get_volume_type_qos_specs,
                                  get_volume_type_extra_specs, request):
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        get_volume_type_extra_specs.return_value = {}
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        vol = self.driver.create_cloned_volume(TEST_VOLUME[0], TEST_VOLUME[1])
        self.assertEqual('1', vol['provider_location'])
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(1, get_volume_type_qos_specs.call_count)
        self.assertEqual(7, request.call_count)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_volume_from_snapshot(
            self, get_volume_type_qos_specs, get_volume_type_extra_specs,
            request):
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        get_volume_type_extra_specs.return_value = {}
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        vol = self.driver.create_volume_from_snapshot(
            TEST_VOLUME[0], TEST_SNAPSHOT[0])
        self.assertEqual('1', vol['provider_location'])
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(1, get_volume_type_qos_specs.call_count)
        self.assertEqual(7, request.call_count)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_volume_from_snapshot_qos(
            self, get_volume_type_qos_specs, get_volume_type_extra_specs,
            request):
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        input_qos_specs = {
            'qos_specs': {
                'consumer': 'back-end',
                'specs': {'upperIops': '1000'}}}
        get_volume_type_qos_specs.return_value = input_qos_specs
        get_volume_type_extra_specs.return_value = {}
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        vol = self.driver.create_volume_from_snapshot(
            TEST_VOLUME[0], TEST_SNAPSHOT[0])
        self.assertEqual('1', vol['provider_location'])
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(1, get_volume_type_qos_specs.call_count)
        self.assertEqual(8, request.call_count)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    def test_initialize_connection(
            self, get_volume_type_extra_specs, request):
        extra_specs = {"hbsd:target_ports": "CL1-A"}
        get_volume_type_extra_specs.return_value = extra_specs
        request.side_effect = [FakeResponse(200, GET_HOST_ISCSIS_RESULT),
                               FakeResponse(200, GET_HOST_GROUP_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        ret = self.driver.initialize_connection(
            TEST_VOLUME[0], DEFAULT_CONNECTOR)
        self.assertEqual('iscsi', ret['driver_volume_type'])
        self.assertEqual(
            '%(ip)s:%(port)s' % {
                'ip': CONFIG_MAP['ipv4Address'],
                'port': CONFIG_MAP['tcpPort'],
            },
            ret['data']['target_portal'])
        self.assertEqual(CONFIG_MAP['target_iscsi_name'],
                         ret['data']['target_iqn'])
        self.assertEqual('CHAP', ret['data']['auth_method'])
        self.assertEqual(CONFIG_MAP['auth_user'], ret['data']['auth_username'])
        self.assertEqual(
            CONFIG_MAP['auth_password'], ret['data']['auth_password'])
        self.assertEqual(1, ret['data']['target_lun'])
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(3, request.call_count)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    def test_initialize_connection_shared_target(
            self, get_volume_type_extra_specs, request):
        """Normal case: A target shared with other systems."""
        extra_specs = {"hbsd:target_ports": "CL1-A"}
        get_volume_type_extra_specs.return_value = extra_specs
        request.side_effect = [FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(200, GET_HOST_GROUPS_RESULT),
                               FakeResponse(200, GET_HOST_ISCSIS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        ret = self.driver.initialize_connection(
            TEST_VOLUME[0], DEFAULT_CONNECTOR)
        self.assertEqual('iscsi', ret['driver_volume_type'])
        self.assertEqual(
            '%(ip)s:%(port)s' % {
                'ip': CONFIG_MAP['ipv4Address'],
                'port': CONFIG_MAP['tcpPort'],
            },
            ret['data']['target_portal'])
        self.assertEqual(CONFIG_MAP['target_iscsi_name'],
                         ret['data']['target_iqn'])
        self.assertEqual('CHAP', ret['data']['auth_method'])
        self.assertEqual(CONFIG_MAP['auth_user'], ret['data']['auth_username'])
        self.assertEqual(
            CONFIG_MAP['auth_password'], ret['data']['auth_password'])
        self.assertEqual(1, ret['data']['target_lun'])
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(4, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_terminate_connection(self, request):
        request.side_effect = [FakeResponse(200, GET_HOST_ISCSIS_RESULT),
                               FakeResponse(200, GET_HOST_GROUP_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT_MAPPED),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.terminate_connection(TEST_VOLUME[2], DEFAULT_CONNECTOR)
        self.assertEqual(6, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_terminate_connection_not_connector(self, request):
        """Normal case: Connector is None."""
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT_MAPPED),
                               FakeResponse(200, GET_HOST_GROUP_RESULT),
                               FakeResponse(200, GET_HOST_ISCSIS_RESULT),
                               FakeResponse(200, GET_HOST_GROUPS_RESULT),
                               FakeResponse(200, GET_HOST_ISCSIS_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT_MAPPED),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.terminate_connection(TEST_VOLUME[2], None)
        self.assertEqual(9, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_initialize_connection_snapshot(self, request):
        request.side_effect = [FakeResponse(200, GET_HOST_ISCSIS_RESULT),
                               FakeResponse(200, GET_HOST_GROUP_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        ret = self.driver.initialize_connection_snapshot(
            TEST_SNAPSHOT[0], DEFAULT_CONNECTOR)
        self.assertEqual('iscsi', ret['driver_volume_type'])
        self.assertEqual(
            '%(ip)s:%(port)s' % {
                'ip': CONFIG_MAP['ipv4Address'],
                'port': CONFIG_MAP['tcpPort'],
            },
            ret['data']['target_portal'])
        self.assertEqual(CONFIG_MAP['target_iscsi_name'],
                         ret['data']['target_iqn'])
        self.assertEqual('CHAP', ret['data']['auth_method'])
        self.assertEqual(CONFIG_MAP['auth_user'], ret['data']['auth_username'])
        self.assertEqual(
            CONFIG_MAP['auth_password'], ret['data']['auth_password'])
        self.assertEqual(1, ret['data']['target_lun'])
        self.assertEqual(3, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_terminate_connection_snapshot(self, request):
        request.side_effect = [FakeResponse(200, GET_HOST_ISCSIS_RESULT),
                               FakeResponse(200, GET_HOST_GROUP_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT_MAPPED),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.terminate_connection_snapshot(
            TEST_SNAPSHOT[0], DEFAULT_CONNECTOR)
        self.assertEqual(6, request.call_count)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_manage_existing(self, get_volume_type_qos_specs, request):
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_LDEVS_RESULT)]
        ret = self.driver.manage_existing(
            TEST_VOLUME[0], self.test_existing_ref)
        self.assertEqual('1', ret['provider_location'])
        self.assertEqual(1, get_volume_type_qos_specs.call_count)
        self.assertEqual(3, request.call_count)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_manage_existing_name(self, get_volume_type_qos_specs, request):
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        request.side_effect = [FakeResponse(200, GET_LDEVS_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_LDEVS_RESULT)]
        ret = self.driver.manage_existing(
            TEST_VOLUME[0], self.test_existing_ref_name)
        self.assertEqual('1', ret['provider_location'])
        self.assertEqual(1, get_volume_type_qos_specs.call_count)
        self.assertEqual(4, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_manage_existing_get_size(self, request):
        request.return_value = FakeResponse(200, GET_LDEV_RESULT)
        self.driver.manage_existing_get_size(
            TEST_VOLUME[0], self.test_existing_ref)
        self.assertEqual(1, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_manage_existing_get_size_name(self, request):
        request.side_effect = [FakeResponse(200, GET_LDEVS_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT)]
        self.driver.manage_existing_get_size(
            TEST_VOLUME[0], self.test_existing_ref_name)
        self.assertEqual(2, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_unmanage(self, request):
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT)]
        self.driver.unmanage(TEST_VOLUME[0])
        self.assertEqual(2, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_copy_image_to_volume(self, request):
        image_service = 'fake_image_service'
        image_id = 'fake_image_id'
        request.return_value = FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)
        with mock.patch.object(driver.VolumeDriver, 'copy_image_to_volume') \
                as mock_copy_image:
            self.driver.copy_image_to_volume(
                self.ctxt, TEST_VOLUME[0], image_service, image_id)
        mock_copy_image.assert_called_with(
            self.ctxt, TEST_VOLUME[0], image_service, image_id,
            disable_sparse=False)
        self.assertEqual(1, request.call_count)

    @mock.patch.object(requests.Session, "request")
    def test_update_migrated_volume(self, request):
        request.return_value = FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)
        ret = self.driver.update_migrated_volume(
            self.ctxt, TEST_VOLUME[0], TEST_VOLUME[1], "available")
        self.assertEqual(1, request.call_count)
        actual = ({'_name_id': TEST_VOLUME[1]['id'],
                   'provider_location': TEST_VOLUME[1]['provider_location']})
        self.assertEqual(actual, ret)

    def test_unmanage_snapshot(self):
        """The driver don't support unmange_snapshot."""
        self.assertRaises(
            NotImplementedError,
            self.driver.unmanage_snapshot,
            TEST_SNAPSHOT[0])

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_retype(self, get_volume_type_qos_specs, request):
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_LDEVS_RESULT)]
        host = {
            'capabilities': {
                'location_info': {
                    'pool_id': 30,
                },
            },
        }
        extra_specs = {'hbsd:capacity_saving': 'deduplication_compression'}
        new_type = fake_volume.fake_volume_type_obj(
            CTXT, id='00000000-0000-0000-0000-{0:012d}'.format(0),
            extra_specs=extra_specs)
        old_specs = {'hbsd:capacity_saving': 'disable'}
        new_specs = {'hbsd:capacity_saving': 'deduplication_compression'}
        old_type_ref = volume_types.create(self.ctxt, 'old', old_specs)
        new_type_ref = volume_types.create(self.ctxt, 'new', new_specs)
        diff = volume_types.volume_types_diff(self.ctxt, old_type_ref['id'],
                                              new_type_ref['id'])[0]
        ret = self.driver.retype(
            self.ctxt, TEST_VOLUME[0], new_type, diff, host)
        self.assertEqual(4, request.call_count)
        self.assertTrue(ret)

    @mock.patch.object(requests.Session, "request")
    def test_migrate_volume(self, request):
        request.return_value = FakeResponse(200, GET_LDEV_RESULT)
        host = {
            'capabilities': {
                'location_info': {
                    'storage_id': CONFIG_MAP['serial'],
                    'pool_id': 30,
                },
            },
        }
        ret = self.driver.migrate_volume(self.ctxt, TEST_VOLUME[0], host)
        self.assertEqual(2, request.call_count)
        actual = (True, None)
        self.assertTupleEqual(actual, ret)

    def test_backup_use_temp_snapshot(self):
        self.assertTrue(self.driver.backup_use_temp_snapshot())

    @mock.patch.object(requests.Session, "request")
    def test_revert_to_snapshot(self, request):
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT_PAIR),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT)]
        self.driver.revert_to_snapshot(
            self.ctxt, TEST_VOLUME[0], TEST_SNAPSHOT[0])
        self.assertEqual(5, request.call_count)

    def test_create_group(self):
        ret = self.driver.create_group(self.ctxt, TEST_GROUP[0])
        self.assertIsNone(ret)

    @mock.patch.object(requests.Session, "request")
    def test_delete_group(self, request):
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        ret = self.driver.delete_group(
            self.ctxt, TEST_GROUP[0], [TEST_VOLUME[0]])
        self.assertEqual(4, request.call_count)
        actual = (
            {'status': TEST_GROUP[0]['status']},
            [{'id': TEST_VOLUME[0]['id'], 'status': 'deleted'}]
        )
        self.assertTupleEqual(actual, ret)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_group_from_src_volume(
            self, get_volume_type_qos_specs, get_volume_type_extra_specs,
            request):
        get_volume_type_extra_specs.return_value = {}
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        ret = self.driver.create_group_from_src(
            self.ctxt, TEST_GROUP[1], [TEST_VOLUME[1]],
            source_group=TEST_GROUP[0], source_vols=[TEST_VOLUME[0]]
        )
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(1, get_volume_type_qos_specs.call_count)
        self.assertEqual(7, request.call_count)
        actual = (
            None, [{'id': TEST_VOLUME[1]['id'], 'provider_location': '1'}])
        self.assertTupleEqual(actual, ret)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_group_from_src_snapshot(
            self, get_volume_type_qos_specs, get_volume_type_extra_specs,
            request):
        get_volume_type_extra_specs.return_value = {}
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        ret = self.driver.create_group_from_src(
            self.ctxt, TEST_GROUP[0], [TEST_VOLUME[0]],
            group_snapshot=TEST_GROUP_SNAP[0], snapshots=[TEST_SNAPSHOT[0]]
        )
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(1, get_volume_type_qos_specs.call_count)
        self.assertEqual(7, request.call_count)
        actual = (
            None, [{'id': TEST_VOLUME[0]['id'], 'provider_location': '1'}])
        self.assertTupleEqual(actual, ret)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_group_from_src_snapshot_qos(
            self, get_volume_type_qos_specs, get_volume_type_extra_specs,
            request):
        input_qos_specs = {
            'qos_specs': {
                'consumer': 'back-end',
                'specs': {'upperIops': '1000'}}}
        get_volume_type_qos_specs.return_value = input_qos_specs
        get_volume_type_extra_specs.return_value = {}
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        ret = self.driver.create_group_from_src(
            self.ctxt, TEST_GROUP[0], [TEST_VOLUME[0]],
            group_snapshot=TEST_GROUP_SNAP[0], snapshots=[TEST_SNAPSHOT[1]]
        )
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(1, get_volume_type_qos_specs.call_count)
        self.assertEqual(8, request.call_count)
        actual = (
            None, [{'id': TEST_VOLUME[0]['id'], 'provider_location': '1'}])
        self.assertTupleEqual(actual, ret)

    def test_create_group_from_src_volume_error(self):
        self.assertRaises(
            exception.VolumeDriverException, self.driver.create_group_from_src,
            self.ctxt, TEST_GROUP[1], [TEST_VOLUME[1]],
            source_group=TEST_GROUP[0], source_vols=[TEST_VOLUME[3]]
        )

    @mock.patch.object(volume_utils, 'is_group_a_cg_snapshot_type')
    def test_update_group(self, is_group_a_cg_snapshot_type):
        is_group_a_cg_snapshot_type.return_value = False
        ret = self.driver.update_group(
            self.ctxt, TEST_GROUP[0], add_volumes=[TEST_VOLUME[0]])
        self.assertTupleEqual((None, None, None), ret)

    @mock.patch.object(volume_utils, 'is_group_a_cg_snapshot_type')
    def test_update_group_error(self, is_group_a_cg_snapshot_type):
        is_group_a_cg_snapshot_type.return_value = True
        self.assertRaises(
            exception.VolumeDriverException, self.driver.update_group,
            self.ctxt, TEST_GROUP[0], add_volumes=[TEST_VOLUME[3]],
            remove_volumes=[TEST_VOLUME[0]]
        )

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(sqlalchemy_api, 'volume_get', side_effect=_volume_get)
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(volume_utils, 'is_group_a_cg_snapshot_type')
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_group_snapshot_non_cg(
            self, get_volume_type_qos_specs, is_group_a_cg_snapshot_type,
            get_volume_type_extra_specs, volume_get, request):
        is_group_a_cg_snapshot_type.return_value = False
        get_volume_type_extra_specs.return_value = {}
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        ret = self.driver.create_group_snapshot(
            self.ctxt, TEST_GROUP_SNAP[0], [TEST_SNAPSHOT[0]]
        )
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(5, request.call_count)
        actual = (
            {'status': 'available'},
            [{'id': TEST_SNAPSHOT[0]['id'],
              'provider_location': '1',
              'status': 'available'}]
        )
        self.assertTupleEqual(actual, ret)

    @mock.patch.object(requests.Session, "request")
    @mock.patch.object(sqlalchemy_api, 'volume_get', side_effect=_volume_get)
    @mock.patch.object(volume_types, 'get_volume_type_extra_specs')
    @mock.patch.object(volume_utils, 'is_group_a_cg_snapshot_type')
    @mock.patch.object(volume_types, 'get_volume_type_qos_specs')
    def test_create_group_snapshot_cg(
            self, get_volume_type_qos_specs, is_group_a_cg_snapshot_type,
            get_volume_type_extra_specs, volume_get, request):
        is_group_a_cg_snapshot_type.return_value = True
        get_volume_type_extra_specs.return_value = {}
        get_volume_type_qos_specs.return_value = {'qos_specs': None}
        request.side_effect = [FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT_PAIR),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT)]
        self.driver.common._stats = {}
        self.driver.common._stats['pools'] = [
            {'location_info': {'pool_id': 30}}]
        ret = self.driver.create_group_snapshot(
            self.ctxt, TEST_GROUP_SNAP[0], [TEST_SNAPSHOT[0]]
        )
        self.assertEqual(1, get_volume_type_extra_specs.call_count)
        self.assertEqual(6, request.call_count)
        actual = (
            None,
            [{'id': TEST_SNAPSHOT[0]['id'],
              'provider_location': '1',
              'status': 'available'}]
        )
        self.assertTupleEqual(actual, ret)

    @mock.patch.object(requests.Session, "request")
    def test_delete_group_snapshot(self, request):
        request.side_effect = [FakeResponse(200, GET_LDEV_RESULT_PAIR),
                               FakeResponse(200, NOTFOUND_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(200, GET_SNAPSHOTS_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(200, GET_LDEV_RESULT),
                               FakeResponse(202, COMPLETED_SUCCEEDED_RESULT)]
        ret = self.driver.delete_group_snapshot(
            self.ctxt, TEST_GROUP_SNAP[0], [TEST_SNAPSHOT[0]])
        self.assertEqual(14, request.call_count)
        actual = (
            {'status': TEST_GROUP_SNAP[0]['status']},
            [{'id': TEST_SNAPSHOT[0]['id'], 'status': 'deleted'}]
        )
        self.assertTupleEqual(actual, ret)

    @mock.patch.object(hbsd_iscsi.HBSDISCSIDriver, "_get_oslo_driver_opts")
    def test_get_driver_options(self, _get_oslo_driver_opts):
        _get_oslo_driver_opts.return_value = []
        ret = self.driver.get_driver_options()
        actual = (hbsd_common.COMMON_VOLUME_OPTS +
                  hbsd_common.COMMON_PAIR_OPTS +
                  hbsd_common.COMMON_NAME_OPTS +
                  hbsd_common.COMMON_EXTEND_OPTS +
                  hbsd_rest.REST_VOLUME_OPTS +
                  hbsd_rest.REST_PAIR_OPTS +
                  hbsd_replication._REP_OPTS +
                  hbsd_replication.COMMON_REPLICATION_OPTS +
                  hbsd_replication.COMMON_MIRROR_OPTS +
                  hbsd_replication.ISCSI_MIRROR_OPTS +
                  hbsd_replication.REST_MIRROR_OPTS +
                  hbsd_replication.REST_MIRROR_API_OPTS +
                  hbsd_replication.REST_MIRROR_SSL_OPTS)
        self.assertEqual(actual, ret)
