256 lines
9.3 KiB
Python
256 lines
9.3 KiB
Python
# Copyright (c) 2015 VMware, Inc.
|
|
#
|
|
# 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.
|
|
#
|
|
import copy
|
|
import mock
|
|
import unittest
|
|
|
|
from oslo_config import cfg
|
|
from requests import exceptions as requests_exceptions
|
|
|
|
from vmware_nsx.nsxlib.v3 import client as nsx_client
|
|
from vmware_nsx.nsxlib.v3 import cluster as nsx_cluster
|
|
|
|
NSX_USER = 'admin'
|
|
NSX_PASSWORD = 'default'
|
|
NSX_MANAGER = '1.2.3.4'
|
|
NSX_INSECURE = False
|
|
NSX_CERT = '/opt/stack/certs/nsx.pem'
|
|
NSX_HTTP_TIMEOUT = 10
|
|
NSX_HTTP_READ_TIMEOUT = 180
|
|
NSX_TZ_NAME = 'default transport zone'
|
|
NSX_DHCP_PROFILE_ID = 'default dhcp profile'
|
|
|
|
V3_CLIENT_PKG = 'vmware_nsx.nsxlib.v3.client'
|
|
BRIDGE_FNS = ['create_resource', 'delete_resource',
|
|
'update_resource', 'get_resource']
|
|
|
|
|
|
class NsxLibTestCase(unittest.TestCase):
|
|
|
|
@classmethod
|
|
def setup_conf_overrides(cls):
|
|
cfg.CONF.set_override('default_overlay_tz', NSX_TZ_NAME, 'nsx_v3')
|
|
cfg.CONF.set_override('native_dhcp_metadata', False, 'nsx_v3')
|
|
cfg.CONF.set_override('dhcp_profile_uuid',
|
|
NSX_DHCP_PROFILE_ID, 'nsx_v3')
|
|
cfg.CONF.set_override('nsx_api_user', NSX_USER, 'nsx_v3')
|
|
cfg.CONF.set_override('nsx_api_password', NSX_PASSWORD, 'nsx_v3')
|
|
cfg.CONF.set_override('nsx_api_managers', [NSX_MANAGER], 'nsx_v3')
|
|
cfg.CONF.set_override('insecure', NSX_INSECURE, 'nsx_v3')
|
|
cfg.CONF.set_override('ca_file', NSX_CERT, 'nsx_v3')
|
|
cfg.CONF.set_override('http_timeout', NSX_HTTP_TIMEOUT, 'nsx_v3')
|
|
cfg.CONF.set_override('http_read_timeout',
|
|
NSX_HTTP_READ_TIMEOUT, 'nsx_v3')
|
|
cfg.CONF.set_override('network_scheduler_driver',
|
|
'neutron.scheduler.dhcp_agent_scheduler.AZAwareWeightScheduler')
|
|
|
|
def setUp(self, *args, **kwargs):
|
|
super(NsxLibTestCase, self).setUp()
|
|
NsxClientTestCase.setup_conf_overrides()
|
|
|
|
# print diffs when assert comparisons fail
|
|
self.maxDiff = None
|
|
|
|
|
|
class MemoryMockAPIProvider(nsx_cluster.AbstractHTTPProvider):
|
|
"""Acts as a HTTP provider for mocking which is backed
|
|
by a MockRequestSessionApi.
|
|
"""
|
|
|
|
def __init__(self, mock_session_api):
|
|
self._store = mock_session_api
|
|
|
|
@property
|
|
def provider_id(self):
|
|
return "Memory mock API"
|
|
|
|
def validate_connection(self, cluster_api, endpoint, conn):
|
|
return
|
|
|
|
def new_connection(self, cluster_api, provider):
|
|
# all callers use the same backing
|
|
return self._store
|
|
|
|
def is_connection_exception(self, exception):
|
|
return isinstance(exception, requests_exceptions.ConnectionError)
|
|
|
|
|
|
class NsxClientTestCase(NsxLibTestCase):
|
|
|
|
class MockBridge(object):
|
|
def __init__(self, api_client):
|
|
self._client = api_client
|
|
|
|
def get_resource(self, resource):
|
|
return nsx_client.get_resource(
|
|
resource, client=self._client)
|
|
|
|
def create_resource(self, resource, data):
|
|
return nsx_client.create_resource(
|
|
resource, data, client=self._client)
|
|
|
|
def delete_resource(self, resource):
|
|
return nsx_client.delete_resource(
|
|
resource, client=self._client)
|
|
|
|
def update_resource(self, resource, data):
|
|
return nsx_client.update_resource(
|
|
resource, data, client=self._client)
|
|
|
|
class MockNSXClusteredAPI(nsx_cluster.NSXClusteredAPI):
|
|
|
|
def __init__(self, session_response=None):
|
|
super(NsxClientTestCase.MockNSXClusteredAPI, self).__init__(
|
|
http_provider=NsxClientTestCase.MockHTTPProvider(
|
|
session_response=session_response))
|
|
self._record = mock.Mock()
|
|
|
|
def record_call(self, request, **kwargs):
|
|
verb = request.method.lower()
|
|
|
|
# filter out requests specific attributes
|
|
checked_kwargs = copy.copy(kwargs)
|
|
del checked_kwargs['proxies']
|
|
del checked_kwargs['stream']
|
|
if 'allow_redirects' in checked_kwargs:
|
|
del checked_kwargs['allow_redirects']
|
|
|
|
for attr in ['url', 'body']:
|
|
checked_kwargs[attr] = getattr(request, attr, None)
|
|
|
|
# remove headers we don't need to verify
|
|
checked_kwargs['headers'] = copy.copy(request.headers)
|
|
for header in ['Accept-Encoding', 'User-Agent',
|
|
'Connection', 'Authorization',
|
|
'Content-Length']:
|
|
if header in checked_kwargs['headers']:
|
|
del checked_kwargs['headers'][header]
|
|
|
|
checked_kwargs['headers'] = request.headers
|
|
|
|
# record the call in the mock object
|
|
method = getattr(self._record, verb)
|
|
method(**checked_kwargs)
|
|
|
|
def assert_called_once(self, verb, **kwargs):
|
|
mock_call = getattr(self._record, verb.lower())
|
|
mock_call.assert_called_once_with(**kwargs)
|
|
|
|
@property
|
|
def recorded_calls(self):
|
|
return self._record
|
|
|
|
class MockHTTPProvider(nsx_cluster.NSXRequestsHTTPProvider):
|
|
|
|
def __init__(self, session_response=None):
|
|
super(NsxClientTestCase.MockHTTPProvider, self).__init__()
|
|
self._session_response = session_response
|
|
|
|
def new_connection(self, cluster_api, provider):
|
|
# wrapper the session so we can intercept and record calls
|
|
session = super(NsxClientTestCase.MockHTTPProvider,
|
|
self).new_connection(cluster_api, provider)
|
|
|
|
mock_adapter = mock.Mock()
|
|
session_send = session.send
|
|
|
|
def _adapter_send(request, **kwargs):
|
|
# record calls at the requests HTTP adapter level
|
|
mock_response = mock.Mock()
|
|
mock_response.history = None
|
|
# needed to bypass requests internal checks for mock
|
|
mock_response.raw._original_response = {}
|
|
|
|
# record the request for later verification
|
|
cluster_api.record_call(request, **kwargs)
|
|
return mock_response
|
|
|
|
def _session_send(request, **kwargs):
|
|
# calls at the Session level
|
|
if self._session_response:
|
|
# consumer has setup a response for the session
|
|
cluster_api.record_call(request, **kwargs)
|
|
return (self._session_response()
|
|
if hasattr(self._session_response, '__call__')
|
|
else self._session_response)
|
|
|
|
# bypass requests redirect handling for mock
|
|
kwargs['allow_redirects'] = False
|
|
|
|
# session send will end up calling adapter send
|
|
return session_send(request, **kwargs)
|
|
|
|
mock_adapter.send = _adapter_send
|
|
session.send = _session_send
|
|
|
|
def _mock_adapter(*args, **kwargs):
|
|
# use our mock adapter rather than requests adapter
|
|
return mock_adapter
|
|
|
|
session.get_adapter = _mock_adapter
|
|
return session
|
|
|
|
def validate_connection(self, cluster_api, endpoint, conn):
|
|
assert conn is not None
|
|
|
|
def mock_nsx_clustered_api(self, session_response=None):
|
|
return NsxClientTestCase.MockNSXClusteredAPI(
|
|
session_response=session_response)
|
|
|
|
def mocked_resource(self, resource_class, mock_validate=True,
|
|
session_response=None):
|
|
mocked = resource_class(nsx_client.NSX3Client(
|
|
self.mock_nsx_clustered_api(session_response=session_response)))
|
|
if mock_validate:
|
|
mock.patch.object(mocked._client, '_validate_result').start()
|
|
|
|
return mocked
|
|
|
|
def new_mocked_client(self, client_class, mock_validate=True,
|
|
session_response=None, mock_cluster=None,
|
|
**kwargs):
|
|
client = client_class(mock_cluster or self.mock_nsx_clustered_api(
|
|
session_response=session_response), **kwargs)
|
|
|
|
if mock_validate:
|
|
mock.patch.object(client, '_validate_result').start()
|
|
|
|
new_client_for = client.new_client_for
|
|
|
|
def _new_client_for(*args, **kwargs):
|
|
sub_client = new_client_for(*args, **kwargs)
|
|
if mock_validate:
|
|
mock.patch.object(sub_client, '_validate_result').start()
|
|
return sub_client
|
|
|
|
client.new_client_for = _new_client_for
|
|
|
|
return client
|
|
|
|
def mocked_rest_fns(self, module, attr, mock_validate=True,
|
|
mock_cluster=None):
|
|
client = nsx_client.NSX3Client(
|
|
mock_cluster or self.mock_nsx_clustered_api())
|
|
mocked_fns = NsxClientTestCase.MockBridge(client)
|
|
mocked_fns.JSONRESTClient = nsx_client.JSONRESTClient
|
|
|
|
if mock_validate:
|
|
mock.patch.object(client, '_validate_result').start()
|
|
|
|
mock.patch.object(module, attr, new=mocked_fns).start()
|
|
|
|
return mocked_fns
|