Now that we no longer support py27, we can use the standard library
unittest.mock module instead of the third party mock lib.
The remainder was auto-generated with the following (hacky) script, with
one or two manual tweaks after the fact:
import glob
for path in glob.glob('watcher/tests/**/*.py', recursive=True):
with open(path) as fh:
lines = fh.readlines()
if 'import mock\n' not in lines:
continue
import_group_found = False
create_first_party_group = False
for num, line in enumerate(lines):
line = line.strip()
if line.startswith('import ') or line.startswith('from '):
tokens = line.split()
for lib in (
'ddt', 'six', 'webob', 'fixtures', 'testtools'
'neutron', 'cinder', 'ironic', 'keystone', 'oslo',
):
if lib in tokens[1]:
create_first_party_group = True
break
if create_first_party_group:
break
import_group_found = True
if not import_group_found:
continue
if line.startswith('import ') or line.startswith('from '):
tokens = line.split()
if tokens[1] > 'unittest':
break
elif tokens[1] == 'unittest' and (
len(tokens) == 2 or tokens[4] > 'mock'
):
break
elif not line:
break
if create_first_party_group:
lines.insert(num, 'from unittest import mock\n\n')
else:
lines.insert(num, 'from unittest import mock\n')
del lines[lines.index('import mock\n')]
with open(path, 'w+') as fh:
fh.writelines(lines)
Co-Authored-By: Sean McGinnis <sean.mcginnis@gmail.com>
Change-Id: Icf35d3a6c10c529e07d1a4edaa36f504e5bf553a
292 lines
12 KiB
Python
292 lines
12 KiB
Python
# -*- encoding: utf-8 -*-
|
|
#
|
|
# Copyright 2013 Hewlett-Packard Development Company, L.P.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
"""Base classes for API tests."""
|
|
|
|
# NOTE: Ported from ceilometer/tests/api.py (subsequently moved to
|
|
# ceilometer/tests/api/__init__.py). This should be oslo'ified:
|
|
# https://bugs.launchpad.net/watcher/+bug/1255115.
|
|
|
|
# NOTE(deva): import auth_token so we can override a config option
|
|
|
|
import copy
|
|
from unittest import mock
|
|
from urllib import parse as urlparse
|
|
|
|
from oslo_config import cfg
|
|
import pecan
|
|
import pecan.testing
|
|
|
|
from watcher.api import hooks
|
|
from watcher.common import context as watcher_context
|
|
from watcher.notifications import service as n_service
|
|
from watcher.tests.db import base
|
|
|
|
PATH_PREFIX = '/v1'
|
|
|
|
|
|
class FunctionalTest(base.DbTestCase):
|
|
"""Pecan controller functional testing class.
|
|
|
|
Used for functional tests of Pecan controllers where you need to
|
|
test your literal application and its integration with the
|
|
framework.
|
|
"""
|
|
|
|
SOURCE_DATA = {'test_source': {'somekey': '666'}}
|
|
|
|
def setUp(self):
|
|
super(FunctionalTest, self).setUp()
|
|
cfg.CONF.set_override("auth_version", "v2.0",
|
|
group='keystone_authtoken')
|
|
cfg.CONF.set_override("admin_user", "admin",
|
|
group='keystone_authtoken')
|
|
|
|
p_services = mock.patch.object(n_service, "send_service_update",
|
|
new_callable=mock.PropertyMock)
|
|
self.m_services = p_services.start()
|
|
self.addCleanup(p_services.stop)
|
|
|
|
self.app = self._make_app()
|
|
|
|
def reset_pecan():
|
|
pecan.set_config({}, overwrite=True)
|
|
|
|
self.addCleanup(reset_pecan)
|
|
|
|
def _make_app(self, enable_acl=False):
|
|
# Determine where we are so we can set up paths in the config
|
|
root_dir = self.get_path()
|
|
|
|
self.config = {
|
|
'app': {
|
|
'root': 'watcher.api.controllers.root.RootController',
|
|
'modules': ['watcher.api'],
|
|
'hooks': [
|
|
hooks.ContextHook(),
|
|
hooks.NoExceptionTracebackHook()
|
|
],
|
|
'template_path': '%s/api/templates' % root_dir,
|
|
'enable_acl': enable_acl,
|
|
'acl_public_routes': ['/', '/v1'],
|
|
},
|
|
}
|
|
|
|
return pecan.testing.load_test_app(self.config)
|
|
|
|
def _request_json(self, path, params, expect_errors=False, headers=None,
|
|
method="post", extra_environ=None, status=None,
|
|
path_prefix=PATH_PREFIX):
|
|
"""Sends simulated HTTP request to Pecan test app.
|
|
|
|
:param path: url path of target service
|
|
:param params: content for wsgi.input of request
|
|
:param expect_errors: Boolean value; whether an error is expected based
|
|
on request
|
|
:param headers: a dictionary of headers to send along with the request
|
|
:param method: Request method type. Appropriate method function call
|
|
should be used rather than passing attribute in.
|
|
:param extra_environ: a dictionary of environ variables to send along
|
|
with the request
|
|
:param status: expected status code of response
|
|
:param path_prefix: prefix of the url path
|
|
"""
|
|
full_path = path_prefix + path
|
|
|
|
response = getattr(self.app, "%s_json" % method)(
|
|
str(full_path),
|
|
params=params,
|
|
headers=headers,
|
|
status=status,
|
|
extra_environ=extra_environ,
|
|
expect_errors=expect_errors
|
|
)
|
|
return response
|
|
|
|
def put_json(self, path, params, expect_errors=False, headers=None,
|
|
extra_environ=None, status=None):
|
|
"""Sends simulated HTTP PUT request to Pecan test app.
|
|
|
|
:param path: url path of target service
|
|
:param params: content for wsgi.input of request
|
|
:param expect_errors: Boolean value; whether an error is expected based
|
|
on request
|
|
:param headers: a dictionary of headers to send along with the request
|
|
:param extra_environ: a dictionary of environ variables to send along
|
|
with the request
|
|
:param status: expected status code of response
|
|
"""
|
|
return self._request_json(path=path, params=params,
|
|
expect_errors=expect_errors,
|
|
headers=headers, extra_environ=extra_environ,
|
|
status=status, method="put")
|
|
|
|
def post(self, *args, **kwargs):
|
|
headers = kwargs.pop('headers', {})
|
|
headers.setdefault('Accept', 'application/json')
|
|
kwargs['headers'] = headers
|
|
return self.app.post(*args, **kwargs)
|
|
|
|
def post_json(self, path, params, expect_errors=False, headers=None,
|
|
extra_environ=None, status=None):
|
|
"""Sends simulated HTTP POST request to Pecan test app.
|
|
|
|
:param path: url path of target service
|
|
:param params: content for wsgi.input of request
|
|
:param expect_errors: Boolean value; whether an error is expected based
|
|
on request
|
|
:param headers: a dictionary of headers to send along with the request
|
|
:param extra_environ: a dictionary of environ variables to send along
|
|
with the request
|
|
:param status: expected status code of response
|
|
"""
|
|
return self._request_json(path=path, params=params,
|
|
expect_errors=expect_errors,
|
|
headers=headers, extra_environ=extra_environ,
|
|
status=status, method="post")
|
|
|
|
def patch_json(self, path, params, expect_errors=False, headers=None,
|
|
extra_environ=None, status=None):
|
|
"""Sends simulated HTTP PATCH request to Pecan test app.
|
|
|
|
:param path: url path of target service
|
|
:param params: content for wsgi.input of request
|
|
:param expect_errors: Boolean value; whether an error is expected based
|
|
on request
|
|
:param headers: a dictionary of headers to send along with the request
|
|
:param extra_environ: a dictionary of environ variables to send along
|
|
with the request
|
|
:param status: expected status code of response
|
|
"""
|
|
return self._request_json(path=path, params=params,
|
|
expect_errors=expect_errors,
|
|
headers=headers, extra_environ=extra_environ,
|
|
status=status, method="patch")
|
|
|
|
def delete(self, path, expect_errors=False, headers=None,
|
|
extra_environ=None, status=None, path_prefix=PATH_PREFIX):
|
|
"""Sends simulated HTTP DELETE request to Pecan test app.
|
|
|
|
:param path: url path of target service
|
|
:param expect_errors: Boolean value; whether an error is expected based
|
|
on request
|
|
:param headers: a dictionary of headers to send along with the request
|
|
:param extra_environ: a dictionary of environ variables to send along
|
|
with the request
|
|
:param status: expected status code of response
|
|
:param path_prefix: prefix of the url path
|
|
"""
|
|
full_path = path_prefix + path
|
|
response = self.app.delete(str(full_path),
|
|
headers=headers,
|
|
status=status,
|
|
extra_environ=extra_environ,
|
|
expect_errors=expect_errors)
|
|
return response
|
|
|
|
def get_json(self, path, expect_errors=False, headers=None,
|
|
extra_environ=None, q=[], path_prefix=PATH_PREFIX,
|
|
return_json=True, **params):
|
|
"""Sends simulated HTTP GET request to Pecan test app.
|
|
|
|
:param path: url path of target service
|
|
:param expect_errors: Boolean value;whether an error is expected based
|
|
on request
|
|
:param headers: a dictionary of headers to send along with the request
|
|
:param extra_environ: a dictionary of environ variables to send along
|
|
with the request
|
|
:param q: list of queries consisting of: field, value, op, and type
|
|
keys
|
|
:param path_prefix: prefix of the url path
|
|
:param params: content for wsgi.input of request
|
|
"""
|
|
full_path = path_prefix + path
|
|
query_params = {'q.field': [],
|
|
'q.value': [],
|
|
'q.op': [],
|
|
}
|
|
for query in q:
|
|
for name in ['field', 'op', 'value']:
|
|
query_params['q.%s' % name].append(query.get(name, ''))
|
|
all_params = {}
|
|
all_params.update(params)
|
|
if q:
|
|
all_params.update(query_params)
|
|
|
|
response = self.app.get(full_path,
|
|
params=all_params,
|
|
headers=headers,
|
|
extra_environ=extra_environ,
|
|
expect_errors=expect_errors)
|
|
if return_json and not expect_errors:
|
|
response = response.json
|
|
return response
|
|
|
|
def validate_link(self, link, bookmark=False):
|
|
"""Checks if the given link can get correct data."""
|
|
# removes the scheme and net location parts of the link
|
|
url_parts = list(urlparse.urlparse(link))
|
|
url_parts[0] = url_parts[1] = ''
|
|
|
|
# bookmark link should not have the version in the URL
|
|
if bookmark and url_parts[2].startswith(PATH_PREFIX):
|
|
return False
|
|
|
|
full_path = urlparse.urlunparse(url_parts)
|
|
try:
|
|
self.get_json(full_path, path_prefix='')
|
|
return True
|
|
except Exception:
|
|
return False
|
|
|
|
|
|
class AdminRoleTest(base.DbTestCase):
|
|
def setUp(self):
|
|
super(AdminRoleTest, self).setUp()
|
|
token_info = {
|
|
'token': {
|
|
'project': {
|
|
'id': 'admin'
|
|
},
|
|
'user': {
|
|
'id': 'admin'
|
|
}
|
|
}
|
|
}
|
|
self.context = watcher_context.RequestContext(
|
|
auth_token_info=token_info,
|
|
project_id='admin',
|
|
user_id='admin')
|
|
|
|
def make_context(*args, **kwargs):
|
|
# If context hasn't been constructed with token_info
|
|
if not kwargs.get('auth_token_info'):
|
|
kwargs['auth_token_info'] = copy.deepcopy(token_info)
|
|
if not kwargs.get('project_id'):
|
|
kwargs['project_id'] = 'admin'
|
|
if not kwargs.get('user_id'):
|
|
kwargs['user_id'] = 'admin'
|
|
if not kwargs.get('roles'):
|
|
kwargs['roles'] = ['admin']
|
|
|
|
context = watcher_context.RequestContext(*args, **kwargs)
|
|
return watcher_context.RequestContext.from_dict(context.to_dict())
|
|
|
|
p = mock.patch.object(watcher_context, 'make_context',
|
|
side_effect=make_context)
|
|
self.mock_make_context = p.start()
|
|
self.addCleanup(p.stop)
|