797 lines
33 KiB
Python
797 lines
33 KiB
Python
# 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 datetime
|
|
import json
|
|
import ssl
|
|
import sys
|
|
import unittest
|
|
|
|
import mock
|
|
from oslo_utils import uuidutils
|
|
|
|
from ironic_inspector.common import ironic as ir_utils
|
|
from ironic_inspector import conf
|
|
from ironic_inspector import db
|
|
from ironic_inspector import firewall
|
|
from ironic_inspector import introspect
|
|
from ironic_inspector import main
|
|
from ironic_inspector import node_cache
|
|
from ironic_inspector.plugins import base as plugins_base
|
|
from ironic_inspector.plugins import example as example_plugin
|
|
from ironic_inspector import process
|
|
from ironic_inspector import rules
|
|
from ironic_inspector.test import base as test_base
|
|
from ironic_inspector import utils
|
|
from oslo_config import cfg
|
|
|
|
CONF = cfg.CONF
|
|
|
|
|
|
def _get_error(res):
|
|
return json.loads(res.data.decode('utf-8'))['error']['message']
|
|
|
|
|
|
class BaseAPITest(test_base.BaseTest):
|
|
def setUp(self):
|
|
super(BaseAPITest, self).setUp()
|
|
main.app.config['TESTING'] = True
|
|
self.app = main.app.test_client()
|
|
CONF.set_override('auth_strategy', 'noauth')
|
|
self.uuid = uuidutils.generate_uuid()
|
|
|
|
|
|
class TestApiIntrospect(BaseAPITest):
|
|
@mock.patch.object(introspect, 'introspect', autospec=True)
|
|
def test_introspect_no_authentication(self, introspect_mock):
|
|
CONF.set_override('auth_strategy', 'noauth')
|
|
res = self.app.post('/v1/introspection/%s' % self.uuid)
|
|
self.assertEqual(202, res.status_code)
|
|
introspect_mock.assert_called_once_with(self.uuid,
|
|
new_ipmi_credentials=None,
|
|
token=None)
|
|
|
|
@mock.patch.object(introspect, 'introspect', autospec=True)
|
|
def test_introspect_set_ipmi_credentials(self, introspect_mock):
|
|
res = self.app.post('/v1/introspection/%s?new_ipmi_username=user&'
|
|
'new_ipmi_password=password' % self.uuid)
|
|
self.assertEqual(202, res.status_code)
|
|
introspect_mock.assert_called_once_with(
|
|
self.uuid,
|
|
new_ipmi_credentials=('user', 'password'),
|
|
token=None)
|
|
|
|
@mock.patch.object(introspect, 'introspect', autospec=True)
|
|
def test_introspect_set_ipmi_credentials_disabled(self, introspect_mock):
|
|
headers = {conf.VERSION_HEADER: '1.9'}
|
|
res = self.app.post('/v1/introspection/%s?new_ipmi_username=user&'
|
|
'new_ipmi_password=password' % self.uuid,
|
|
headers=headers)
|
|
self.assertEqual(400, res.status_code)
|
|
self.assertFalse(introspect_mock.called)
|
|
|
|
@mock.patch.object(introspect, 'introspect', autospec=True)
|
|
def test_introspect_set_ipmi_credentials_no_user(self, introspect_mock):
|
|
res = self.app.post('/v1/introspection/%s?'
|
|
'new_ipmi_password=password' % self.uuid)
|
|
self.assertEqual(202, res.status_code)
|
|
introspect_mock.assert_called_once_with(
|
|
self.uuid,
|
|
new_ipmi_credentials=(None, 'password'),
|
|
token=None)
|
|
|
|
@mock.patch.object(introspect, 'introspect', autospec=True)
|
|
def test_intospect_failed(self, introspect_mock):
|
|
introspect_mock.side_effect = utils.Error("boom")
|
|
res = self.app.post('/v1/introspection/%s' % self.uuid)
|
|
self.assertEqual(400, res.status_code)
|
|
self.assertEqual(
|
|
'boom',
|
|
json.loads(res.data.decode('utf-8'))['error']['message'])
|
|
introspect_mock.assert_called_once_with(
|
|
self.uuid,
|
|
new_ipmi_credentials=None,
|
|
token=None)
|
|
|
|
@mock.patch.object(utils, 'check_auth', autospec=True)
|
|
@mock.patch.object(introspect, 'introspect', autospec=True)
|
|
def test_introspect_failed_authentication(self, introspect_mock,
|
|
auth_mock):
|
|
CONF.set_override('auth_strategy', 'keystone')
|
|
auth_mock.side_effect = utils.Error('Boom', code=403)
|
|
res = self.app.post('/v1/introspection/%s' % self.uuid,
|
|
headers={'X-Auth-Token': 'token'})
|
|
self.assertEqual(403, res.status_code)
|
|
self.assertFalse(introspect_mock.called)
|
|
|
|
|
|
@mock.patch.object(process, 'process', autospec=True)
|
|
class TestApiContinue(BaseAPITest):
|
|
def test_continue(self, process_mock):
|
|
# should be ignored
|
|
CONF.set_override('auth_strategy', 'keystone')
|
|
process_mock.return_value = {'result': 42}
|
|
res = self.app.post('/v1/continue', data='{"foo": "bar"}')
|
|
self.assertEqual(200, res.status_code)
|
|
process_mock.assert_called_once_with({"foo": "bar"})
|
|
self.assertEqual({"result": 42}, json.loads(res.data.decode()))
|
|
|
|
def test_continue_failed(self, process_mock):
|
|
process_mock.side_effect = utils.Error("boom")
|
|
res = self.app.post('/v1/continue', data='{"foo": "bar"}')
|
|
self.assertEqual(400, res.status_code)
|
|
process_mock.assert_called_once_with({"foo": "bar"})
|
|
self.assertEqual('boom', _get_error(res))
|
|
|
|
def test_continue_wrong_type(self, process_mock):
|
|
res = self.app.post('/v1/continue', data='42')
|
|
self.assertEqual(400, res.status_code)
|
|
self.assertEqual('Invalid data: expected a JSON object, got int',
|
|
_get_error(res))
|
|
self.assertFalse(process_mock.called)
|
|
|
|
|
|
@mock.patch.object(introspect, 'abort', autospec=True)
|
|
class TestApiAbort(BaseAPITest):
|
|
def test_ok(self, abort_mock):
|
|
abort_mock.return_value = '', 202
|
|
|
|
res = self.app.post('/v1/introspection/%s/abort' % self.uuid,
|
|
headers={'X-Auth-Token': 'token'})
|
|
|
|
abort_mock.assert_called_once_with(self.uuid, token='token')
|
|
self.assertEqual(202, res.status_code)
|
|
self.assertEqual(b'', res.data)
|
|
|
|
def test_no_authentication(self, abort_mock):
|
|
abort_mock.return_value = b'', 202
|
|
|
|
res = self.app.post('/v1/introspection/%s/abort' % self.uuid)
|
|
|
|
abort_mock.assert_called_once_with(self.uuid, token=None)
|
|
self.assertEqual(202, res.status_code)
|
|
self.assertEqual(b'', res.data)
|
|
|
|
def test_node_not_found(self, abort_mock):
|
|
exc = utils.Error("Not Found.", code=404)
|
|
abort_mock.side_effect = exc
|
|
|
|
res = self.app.post('/v1/introspection/%s/abort' % self.uuid)
|
|
|
|
abort_mock.assert_called_once_with(self.uuid, token=None)
|
|
self.assertEqual(404, res.status_code)
|
|
data = json.loads(str(res.data.decode()))
|
|
self.assertEqual(str(exc), data['error']['message'])
|
|
|
|
def test_abort_failed(self, abort_mock):
|
|
exc = utils.Error("Locked.", code=409)
|
|
abort_mock.side_effect = exc
|
|
|
|
res = self.app.post('/v1/introspection/%s/abort' % self.uuid)
|
|
|
|
abort_mock.assert_called_once_with(self.uuid, token=None)
|
|
self.assertEqual(409, res.status_code)
|
|
data = json.loads(res.data.decode())
|
|
self.assertEqual(str(exc), data['error']['message'])
|
|
|
|
|
|
class GetStatusAPIBaseTest(BaseAPITest):
|
|
def setUp(self):
|
|
super(GetStatusAPIBaseTest, self).setUp()
|
|
self.uuid2 = uuidutils.generate_uuid()
|
|
self.finished_node = node_cache.NodeInfo(
|
|
uuid=self.uuid,
|
|
started_at=datetime.datetime(1, 1, 1),
|
|
finished_at=datetime.datetime(1, 1, 2),
|
|
error='boom')
|
|
self.finished_node.links = [
|
|
{u'href': u'http://localhost/v1/introspection/%s' %
|
|
self.finished_node.uuid,
|
|
u'rel': u'self'},
|
|
]
|
|
self.finished_node.status = {
|
|
'finished': True,
|
|
'started_at': self.finished_node.started_at.isoformat(),
|
|
'finished_at': self.finished_node.finished_at.isoformat(),
|
|
'error': self.finished_node.error,
|
|
'uuid': self.finished_node.uuid,
|
|
'links': self.finished_node.links
|
|
}
|
|
|
|
self.unfinished_node = node_cache.NodeInfo(
|
|
uuid=self.uuid2,
|
|
started_at=datetime.datetime(1, 1, 1))
|
|
self.unfinished_node.links = [
|
|
{u'href': u'http://localhost/v1/introspection/%s' %
|
|
self.unfinished_node.uuid,
|
|
u'rel': u'self'}
|
|
]
|
|
finished_at = (self.unfinished_node.finished_at.isoformat()
|
|
if self.unfinished_node.finished_at else None)
|
|
self.unfinished_node.status = {
|
|
'finished': False,
|
|
'started_at': self.unfinished_node.started_at.isoformat(),
|
|
'finished_at': finished_at,
|
|
'error': None,
|
|
'uuid': self.unfinished_node.uuid,
|
|
'links': self.unfinished_node.links
|
|
}
|
|
|
|
|
|
@mock.patch.object(node_cache, 'get_node', autospec=True)
|
|
class TestApiGetStatus(GetStatusAPIBaseTest):
|
|
def test_get_introspection_in_progress(self, get_mock):
|
|
get_mock.return_value = self.unfinished_node
|
|
res = self.app.get('/v1/introspection/%s' % self.uuid)
|
|
self.assertEqual(200, res.status_code)
|
|
self.assertEqual(self.unfinished_node.status,
|
|
json.loads(res.data.decode('utf-8')))
|
|
|
|
def test_get_introspection_finished(self, get_mock):
|
|
get_mock.return_value = self.finished_node
|
|
res = self.app.get('/v1/introspection/%s' % self.uuid)
|
|
self.assertEqual(200, res.status_code)
|
|
self.assertEqual(self.finished_node.status,
|
|
json.loads(res.data.decode('utf-8')))
|
|
|
|
|
|
@mock.patch.object(node_cache, 'get_node_list', autospec=True)
|
|
class TestApiListStatus(GetStatusAPIBaseTest):
|
|
|
|
def test_list_introspection(self, list_mock):
|
|
list_mock.return_value = [self.finished_node, self.unfinished_node]
|
|
res = self.app.get('/v1/introspection')
|
|
self.assertEqual(200, res.status_code)
|
|
statuses = json.loads(res.data.decode('utf-8')).get('introspection')
|
|
|
|
self.assertEqual([self.finished_node.status,
|
|
self.unfinished_node.status], statuses)
|
|
list_mock.assert_called_once_with(marker=None,
|
|
limit=CONF.api_max_limit)
|
|
|
|
def test_list_introspection_limit(self, list_mock):
|
|
res = self.app.get('/v1/introspection?limit=1000')
|
|
self.assertEqual(200, res.status_code)
|
|
list_mock.assert_called_once_with(marker=None, limit=1000)
|
|
|
|
def test_list_introspection_makrer(self, list_mock):
|
|
res = self.app.get('/v1/introspection?marker=%s' %
|
|
self.finished_node.uuid)
|
|
self.assertEqual(200, res.status_code)
|
|
list_mock.assert_called_once_with(marker=self.finished_node.uuid,
|
|
limit=CONF.api_max_limit)
|
|
|
|
|
|
class TestApiGetData(BaseAPITest):
|
|
@mock.patch.object(main.swift, 'SwiftAPI', autospec=True)
|
|
def test_get_introspection_data(self, swift_mock):
|
|
CONF.set_override('store_data', 'swift', 'processing')
|
|
data = {
|
|
'ipmi_address': '1.2.3.4',
|
|
'cpus': 2,
|
|
'cpu_arch': 'x86_64',
|
|
'memory_mb': 1024,
|
|
'local_gb': 20,
|
|
'interfaces': {
|
|
'em1': {'mac': '11:22:33:44:55:66', 'ip': '1.2.0.1'},
|
|
}
|
|
}
|
|
swift_conn = swift_mock.return_value
|
|
swift_conn.get_object.return_value = json.dumps(data)
|
|
res = self.app.get('/v1/introspection/%s/data' % self.uuid)
|
|
name = 'inspector_data-%s' % self.uuid
|
|
swift_conn.get_object.assert_called_once_with(name)
|
|
self.assertEqual(200, res.status_code)
|
|
self.assertEqual(data, json.loads(res.data.decode('utf-8')))
|
|
|
|
@mock.patch.object(main.swift, 'SwiftAPI', autospec=True)
|
|
def test_introspection_data_not_stored(self, swift_mock):
|
|
CONF.set_override('store_data', 'none', 'processing')
|
|
swift_conn = swift_mock.return_value
|
|
res = self.app.get('/v1/introspection/%s/data' % self.uuid)
|
|
self.assertFalse(swift_conn.get_object.called)
|
|
self.assertEqual(404, res.status_code)
|
|
|
|
@mock.patch.object(ir_utils, 'get_node', autospec=True)
|
|
@mock.patch.object(main.swift, 'SwiftAPI', autospec=True)
|
|
def test_with_name(self, swift_mock, get_mock):
|
|
get_mock.return_value = mock.Mock(uuid=self.uuid)
|
|
CONF.set_override('store_data', 'swift', 'processing')
|
|
data = {
|
|
'ipmi_address': '1.2.3.4',
|
|
'cpus': 2,
|
|
'cpu_arch': 'x86_64',
|
|
'memory_mb': 1024,
|
|
'local_gb': 20,
|
|
'interfaces': {
|
|
'em1': {'mac': '11:22:33:44:55:66', 'ip': '1.2.0.1'},
|
|
}
|
|
}
|
|
swift_conn = swift_mock.return_value
|
|
swift_conn.get_object.return_value = json.dumps(data)
|
|
res = self.app.get('/v1/introspection/name1/data')
|
|
name = 'inspector_data-%s' % self.uuid
|
|
swift_conn.get_object.assert_called_once_with(name)
|
|
self.assertEqual(200, res.status_code)
|
|
self.assertEqual(data, json.loads(res.data.decode('utf-8')))
|
|
get_mock.assert_called_once_with('name1', fields=['uuid'])
|
|
|
|
|
|
@mock.patch.object(process, 'reapply', autospec=True)
|
|
class TestApiReapply(BaseAPITest):
|
|
|
|
def setUp(self):
|
|
super(TestApiReapply, self).setUp()
|
|
CONF.set_override('store_data', 'swift', 'processing')
|
|
|
|
def test_ok(self, reapply_mock):
|
|
|
|
self.app.post('/v1/introspection/%s/data/unprocessed' %
|
|
self.uuid)
|
|
reapply_mock.assert_called_once_with(self.uuid)
|
|
|
|
def test_user_data(self, reapply_mock):
|
|
res = self.app.post('/v1/introspection/%s/data/unprocessed' %
|
|
self.uuid, data='some data')
|
|
self.assertEqual(400, res.status_code)
|
|
message = json.loads(res.data.decode())['error']['message']
|
|
self.assertEqual('User data processing is not supported yet',
|
|
message)
|
|
self.assertFalse(reapply_mock.called)
|
|
|
|
def test_swift_disabled(self, reapply_mock):
|
|
CONF.set_override('store_data', 'none', 'processing')
|
|
|
|
res = self.app.post('/v1/introspection/%s/data/unprocessed' %
|
|
self.uuid)
|
|
self.assertEqual(400, res.status_code)
|
|
message = json.loads(res.data.decode())['error']['message']
|
|
self.assertEqual('Inspector is not configured to store '
|
|
'data. Set the [processing] store_data '
|
|
'configuration option to change this.',
|
|
message)
|
|
self.assertFalse(reapply_mock.called)
|
|
|
|
def test_node_locked(self, reapply_mock):
|
|
exc = utils.Error('Locked.', code=409)
|
|
reapply_mock.side_effect = exc
|
|
|
|
res = self.app.post('/v1/introspection/%s/data/unprocessed' %
|
|
self.uuid)
|
|
|
|
self.assertEqual(409, res.status_code)
|
|
message = json.loads(res.data.decode())['error']['message']
|
|
self.assertEqual(str(exc), message)
|
|
reapply_mock.assert_called_once_with(self.uuid)
|
|
|
|
def test_node_not_found(self, reapply_mock):
|
|
exc = utils.Error('Not found.', code=404)
|
|
reapply_mock.side_effect = exc
|
|
|
|
res = self.app.post('/v1/introspection/%s/data/unprocessed' %
|
|
self.uuid)
|
|
|
|
self.assertEqual(404, res.status_code)
|
|
message = json.loads(res.data.decode())['error']['message']
|
|
self.assertEqual(str(exc), message)
|
|
reapply_mock.assert_called_once_with(self.uuid)
|
|
|
|
def test_generic_error(self, reapply_mock):
|
|
exc = utils.Error('Oops', code=400)
|
|
reapply_mock.side_effect = exc
|
|
|
|
res = self.app.post('/v1/introspection/%s/data/unprocessed' %
|
|
self.uuid)
|
|
|
|
self.assertEqual(400, res.status_code)
|
|
message = json.loads(res.data.decode())['error']['message']
|
|
self.assertEqual(str(exc), message)
|
|
reapply_mock.assert_called_once_with(self.uuid)
|
|
|
|
|
|
class TestApiRules(BaseAPITest):
|
|
@mock.patch.object(rules, 'get_all')
|
|
def test_get_all(self, get_all_mock):
|
|
get_all_mock.return_value = [
|
|
mock.Mock(spec=rules.IntrospectionRule,
|
|
**{'as_dict.return_value': {'uuid': 'foo'}}),
|
|
mock.Mock(spec=rules.IntrospectionRule,
|
|
**{'as_dict.return_value': {'uuid': 'bar'}}),
|
|
]
|
|
|
|
res = self.app.get('/v1/rules')
|
|
self.assertEqual(200, res.status_code)
|
|
self.assertEqual(
|
|
{
|
|
'rules': [{'uuid': 'foo',
|
|
'links': [
|
|
{'href': '/v1/rules/foo', 'rel': 'self'}
|
|
]},
|
|
{'uuid': 'bar',
|
|
'links': [
|
|
{'href': '/v1/rules/bar', 'rel': 'self'}
|
|
]}]
|
|
},
|
|
json.loads(res.data.decode('utf-8')))
|
|
get_all_mock.assert_called_once_with()
|
|
for m in get_all_mock.return_value:
|
|
m.as_dict.assert_called_with(short=True)
|
|
|
|
@mock.patch.object(rules, 'delete_all')
|
|
def test_delete_all(self, delete_all_mock):
|
|
res = self.app.delete('/v1/rules')
|
|
self.assertEqual(204, res.status_code)
|
|
delete_all_mock.assert_called_once_with()
|
|
|
|
@mock.patch.object(rules, 'create', autospec=True)
|
|
def test_create(self, create_mock):
|
|
data = {'uuid': self.uuid,
|
|
'conditions': 'cond',
|
|
'actions': 'act'}
|
|
exp = data.copy()
|
|
exp['description'] = None
|
|
create_mock.return_value = mock.Mock(spec=rules.IntrospectionRule,
|
|
**{'as_dict.return_value': exp})
|
|
|
|
res = self.app.post('/v1/rules', data=json.dumps(data))
|
|
self.assertEqual(201, res.status_code)
|
|
create_mock.assert_called_once_with(conditions_json='cond',
|
|
actions_json='act',
|
|
uuid=self.uuid,
|
|
description=None)
|
|
self.assertEqual(exp, json.loads(res.data.decode('utf-8')))
|
|
|
|
@mock.patch.object(rules, 'create', autospec=True)
|
|
def test_create_api_less_1_6(self, create_mock):
|
|
data = {'uuid': self.uuid,
|
|
'conditions': 'cond',
|
|
'actions': 'act'}
|
|
exp = data.copy()
|
|
exp['description'] = None
|
|
create_mock.return_value = mock.Mock(spec=rules.IntrospectionRule,
|
|
**{'as_dict.return_value': exp})
|
|
|
|
headers = {conf.VERSION_HEADER:
|
|
main._format_version((1, 5))}
|
|
|
|
res = self.app.post('/v1/rules', data=json.dumps(data),
|
|
headers=headers)
|
|
self.assertEqual(200, res.status_code)
|
|
create_mock.assert_called_once_with(conditions_json='cond',
|
|
actions_json='act',
|
|
uuid=self.uuid,
|
|
description=None)
|
|
self.assertEqual(exp, json.loads(res.data.decode('utf-8')))
|
|
|
|
@mock.patch.object(rules, 'create', autospec=True)
|
|
def test_create_bad_uuid(self, create_mock):
|
|
data = {'uuid': 'foo',
|
|
'conditions': 'cond',
|
|
'actions': 'act'}
|
|
|
|
res = self.app.post('/v1/rules', data=json.dumps(data))
|
|
self.assertEqual(400, res.status_code)
|
|
|
|
@mock.patch.object(rules, 'get')
|
|
def test_get_one(self, get_mock):
|
|
get_mock.return_value = mock.Mock(spec=rules.IntrospectionRule,
|
|
**{'as_dict.return_value':
|
|
{'uuid': 'foo'}})
|
|
|
|
res = self.app.get('/v1/rules/' + self.uuid)
|
|
self.assertEqual(200, res.status_code)
|
|
self.assertEqual({'uuid': 'foo',
|
|
'links': [
|
|
{'href': '/v1/rules/foo', 'rel': 'self'}
|
|
]},
|
|
json.loads(res.data.decode('utf-8')))
|
|
get_mock.assert_called_once_with(self.uuid)
|
|
get_mock.return_value.as_dict.assert_called_once_with(short=False)
|
|
|
|
@mock.patch.object(rules, 'delete')
|
|
def test_delete_one(self, delete_mock):
|
|
res = self.app.delete('/v1/rules/' + self.uuid)
|
|
self.assertEqual(204, res.status_code)
|
|
delete_mock.assert_called_once_with(self.uuid)
|
|
|
|
|
|
class TestApiMisc(BaseAPITest):
|
|
@mock.patch.object(node_cache, 'get_node', autospec=True)
|
|
def test_404_expected(self, get_mock):
|
|
get_mock.side_effect = utils.Error('boom', code=404)
|
|
res = self.app.get('/v1/introspection/%s' % self.uuid)
|
|
self.assertEqual(404, res.status_code)
|
|
self.assertEqual('boom', _get_error(res))
|
|
|
|
def test_404_unexpected(self):
|
|
res = self.app.get('/v42')
|
|
self.assertEqual(404, res.status_code)
|
|
self.assertIn('not found', _get_error(res).lower())
|
|
|
|
@mock.patch.object(node_cache, 'get_node', autospec=True)
|
|
def test_500_with_debug(self, get_mock):
|
|
CONF.set_override('debug', True)
|
|
get_mock.side_effect = RuntimeError('boom')
|
|
res = self.app.get('/v1/introspection/%s' % self.uuid)
|
|
self.assertEqual(500, res.status_code)
|
|
self.assertEqual('Internal server error (RuntimeError): boom',
|
|
_get_error(res))
|
|
|
|
@mock.patch.object(node_cache, 'get_node', autospec=True)
|
|
def test_500_without_debug(self, get_mock):
|
|
CONF.set_override('debug', False)
|
|
get_mock.side_effect = RuntimeError('boom')
|
|
res = self.app.get('/v1/introspection/%s' % self.uuid)
|
|
self.assertEqual(500, res.status_code)
|
|
self.assertEqual('Internal server error',
|
|
_get_error(res))
|
|
|
|
|
|
class TestApiVersions(BaseAPITest):
|
|
def _check_version_present(self, res):
|
|
self.assertEqual('%d.%d' % main.MINIMUM_API_VERSION,
|
|
res.headers.get(conf.MIN_VERSION_HEADER))
|
|
self.assertEqual('%d.%d' % main.CURRENT_API_VERSION,
|
|
res.headers.get(conf.MAX_VERSION_HEADER))
|
|
|
|
def test_root_endpoint(self):
|
|
res = self.app.get("/")
|
|
self.assertEqual(200, res.status_code)
|
|
self._check_version_present(res)
|
|
data = res.data.decode('utf-8')
|
|
json_data = json.loads(data)
|
|
expected = {"versions": [{
|
|
"status": "CURRENT", "id": '%s.%s' % main.CURRENT_API_VERSION,
|
|
"links": [{
|
|
"rel": "self",
|
|
"href": ("http://localhost/v%s" %
|
|
main.CURRENT_API_VERSION[0])
|
|
}]
|
|
}]}
|
|
self.assertEqual(expected, json_data)
|
|
|
|
@mock.patch.object(main.app.url_map, "iter_rules", autospec=True)
|
|
def test_version_endpoint(self, mock_rules):
|
|
mock_rules.return_value = ["/v1/endpoint1", "/v1/endpoint2/<uuid>",
|
|
"/v1/endpoint1/<name>",
|
|
"/v2/endpoint1", "/v1/endpoint3",
|
|
"/v1/endpoint2/<uuid>/subpoint"]
|
|
endpoint = "/v1"
|
|
res = self.app.get(endpoint)
|
|
self.assertEqual(200, res.status_code)
|
|
self._check_version_present(res)
|
|
json_data = json.loads(res.data.decode('utf-8'))
|
|
expected = {u'resources': [
|
|
{
|
|
u'name': u'endpoint1',
|
|
u'links': [{
|
|
u'rel': u'self',
|
|
u'href': u'http://localhost/v1/endpoint1'}]
|
|
},
|
|
{
|
|
u'name': u'endpoint3',
|
|
u'links': [{
|
|
u'rel': u'self',
|
|
u'href': u'http://localhost/v1/endpoint3'}]
|
|
},
|
|
]}
|
|
self.assertEqual(expected, json_data)
|
|
|
|
def test_version_endpoint_invalid(self):
|
|
endpoint = "/v-1"
|
|
res = self.app.get(endpoint)
|
|
self.assertEqual(404, res.status_code)
|
|
|
|
def test_404_unexpected(self):
|
|
# API version on unknown pages
|
|
self._check_version_present(self.app.get('/v1/foobar'))
|
|
|
|
@mock.patch.object(node_cache, 'get_node', autospec=True)
|
|
def test_usual_requests(self, get_mock):
|
|
get_mock.return_value = node_cache.NodeInfo(uuid=self.uuid,
|
|
started_at=42.0)
|
|
# Successfull
|
|
self._check_version_present(
|
|
self.app.post('/v1/introspection/%s' % self.uuid))
|
|
# With error
|
|
self._check_version_present(
|
|
self.app.post('/v1/introspection/foobar'))
|
|
|
|
def test_request_correct_version(self):
|
|
headers = {conf.VERSION_HEADER:
|
|
main._format_version(main.CURRENT_API_VERSION)}
|
|
self._check_version_present(self.app.get('/', headers=headers))
|
|
|
|
def test_request_unsupported_version(self):
|
|
bad_version = (main.CURRENT_API_VERSION[0],
|
|
main.CURRENT_API_VERSION[1] + 1)
|
|
headers = {conf.VERSION_HEADER:
|
|
main._format_version(bad_version)}
|
|
res = self.app.get('/', headers=headers)
|
|
self._check_version_present(res)
|
|
self.assertEqual(406, res.status_code)
|
|
error = _get_error(res)
|
|
self.assertIn('%d.%d' % bad_version, error)
|
|
self.assertIn('%d.%d' % main.MINIMUM_API_VERSION, error)
|
|
self.assertIn('%d.%d' % main.CURRENT_API_VERSION, error)
|
|
|
|
|
|
class TestPlugins(unittest.TestCase):
|
|
@mock.patch.object(example_plugin.ExampleProcessingHook,
|
|
'before_processing', autospec=True)
|
|
@mock.patch.object(example_plugin.ExampleProcessingHook,
|
|
'before_update', autospec=True)
|
|
def test_hook(self, mock_post, mock_pre):
|
|
plugins_base._HOOKS_MGR = None
|
|
CONF.set_override('processing_hooks', 'example', 'processing')
|
|
mgr = plugins_base.processing_hooks_manager()
|
|
mgr.map_method('before_processing', 'introspection_data')
|
|
mock_pre.assert_called_once_with(mock.ANY, 'introspection_data')
|
|
mgr.map_method('before_update', 'node_info', {})
|
|
mock_post.assert_called_once_with(mock.ANY, 'node_info', {})
|
|
|
|
def test_manager_is_cached(self):
|
|
self.assertIs(plugins_base.processing_hooks_manager(),
|
|
plugins_base.processing_hooks_manager())
|
|
|
|
|
|
@mock.patch.object(firewall, 'init')
|
|
@mock.patch.object(utils, 'add_auth_middleware')
|
|
@mock.patch.object(ir_utils, 'get_client')
|
|
@mock.patch.object(db, 'init')
|
|
class TestInit(test_base.BaseTest):
|
|
def setUp(self):
|
|
super(TestInit, self).setUp()
|
|
# Tests default to a synchronous executor which can't be used here
|
|
utils._EXECUTOR = None
|
|
self.service = main.Service()
|
|
|
|
@mock.patch.object(firewall, 'clean_up', lambda: None)
|
|
def tearDown(self):
|
|
self.service.shutdown()
|
|
super(TestInit, self).tearDown()
|
|
|
|
def test_ok(self, mock_node_cache, mock_get_client, mock_auth,
|
|
mock_firewall):
|
|
CONF.set_override('auth_strategy', 'keystone')
|
|
self.service.init()
|
|
mock_auth.assert_called_once_with(main.app)
|
|
mock_node_cache.assert_called_once_with()
|
|
mock_firewall.assert_called_once_with()
|
|
|
|
def test_init_without_authenticate(self, mock_node_cache, mock_get_client,
|
|
mock_auth, mock_firewall):
|
|
CONF.set_override('auth_strategy', 'noauth')
|
|
self.service.init()
|
|
self.assertFalse(mock_auth.called)
|
|
|
|
@mock.patch.object(main.LOG, 'warning')
|
|
def test_init_with_no_data_storage(self, mock_log, mock_node_cache,
|
|
mock_get_client, mock_auth,
|
|
mock_firewall):
|
|
msg = ('Introspection data will not be stored. Change '
|
|
'"[processing] store_data" option if this is not the '
|
|
'desired behavior')
|
|
self.service.init()
|
|
mock_log.assert_called_once_with(msg)
|
|
|
|
@mock.patch.object(main.LOG, 'info')
|
|
def test_init_with_swift_storage(self, mock_log, mock_node_cache,
|
|
mock_get_client, mock_auth,
|
|
mock_firewall):
|
|
CONF.set_override('store_data', 'swift', 'processing')
|
|
msg = mock.call('Introspection data will be stored in Swift in the '
|
|
'container %s', CONF.swift.container)
|
|
self.service.init()
|
|
self.assertIn(msg, mock_log.call_args_list)
|
|
|
|
def test_init_without_manage_firewall(self, mock_node_cache,
|
|
mock_get_client, mock_auth,
|
|
mock_firewall):
|
|
CONF.set_override('manage_firewall', False, 'firewall')
|
|
self.service.init()
|
|
self.assertFalse(mock_firewall.called)
|
|
|
|
@mock.patch.object(main.LOG, 'critical')
|
|
def test_init_failed_processing_hook(self, mock_log, mock_node_cache,
|
|
mock_get_client, mock_auth,
|
|
mock_firewall):
|
|
CONF.set_override('processing_hooks', 'foo!', 'processing')
|
|
plugins_base._HOOKS_MGR = None
|
|
|
|
self.assertRaises(SystemExit, self.service.init)
|
|
mock_log.assert_called_once_with(mock.ANY, "'foo!'")
|
|
|
|
|
|
class TestCreateSSLContext(test_base.BaseTest):
|
|
|
|
def test_use_ssl_false(self):
|
|
CONF.set_override('use_ssl', False)
|
|
con = main.create_ssl_context()
|
|
self.assertIsNone(con)
|
|
|
|
@mock.patch.object(sys, 'version_info')
|
|
def test_old_python_returns_none(self, mock_version_info):
|
|
mock_version_info.__lt__.return_value = True
|
|
CONF.set_override('use_ssl', True)
|
|
con = main.create_ssl_context()
|
|
self.assertIsNone(con)
|
|
|
|
@unittest.skipIf(sys.version_info[:3] < (2, 7, 9),
|
|
'This feature is unsupported in this version of python '
|
|
'so the tests will be skipped')
|
|
@mock.patch.object(ssl, 'create_default_context', autospec=True)
|
|
def test_use_ssl_true(self, mock_cdc):
|
|
CONF.set_override('use_ssl', True)
|
|
m_con = mock_cdc()
|
|
con = main.create_ssl_context()
|
|
self.assertEqual(m_con, con)
|
|
|
|
@unittest.skipIf(sys.version_info[:3] < (2, 7, 9),
|
|
'This feature is unsupported in this version of python '
|
|
'so the tests will be skipped')
|
|
@mock.patch.object(ssl, 'create_default_context', autospec=True)
|
|
def test_only_key_path_provided(self, mock_cdc):
|
|
CONF.set_override('use_ssl', True)
|
|
CONF.set_override('ssl_key_path', '/some/fake/path')
|
|
mock_context = mock_cdc()
|
|
con = main.create_ssl_context()
|
|
self.assertEqual(mock_context, con)
|
|
self.assertFalse(mock_context.load_cert_chain.called)
|
|
|
|
@unittest.skipIf(sys.version_info[:3] < (2, 7, 9),
|
|
'This feature is unsupported in this version of python '
|
|
'so the tests will be skipped')
|
|
@mock.patch.object(ssl, 'create_default_context', autospec=True)
|
|
def test_only_cert_path_provided(self, mock_cdc):
|
|
CONF.set_override('use_ssl', True)
|
|
CONF.set_override('ssl_cert_path', '/some/fake/path')
|
|
mock_context = mock_cdc()
|
|
con = main.create_ssl_context()
|
|
self.assertEqual(mock_context, con)
|
|
self.assertFalse(mock_context.load_cert_chain.called)
|
|
|
|
@unittest.skipIf(sys.version_info[:3] < (2, 7, 9),
|
|
'This feature is unsupported in this version of python '
|
|
'so the tests will be skipped')
|
|
@mock.patch.object(ssl, 'create_default_context', autospec=True)
|
|
def test_both_paths_provided(self, mock_cdc):
|
|
key_path = '/some/fake/path/key'
|
|
cert_path = '/some/fake/path/cert'
|
|
CONF.set_override('use_ssl', True)
|
|
CONF.set_override('ssl_key_path', key_path)
|
|
CONF.set_override('ssl_cert_path', cert_path)
|
|
mock_context = mock_cdc()
|
|
con = main.create_ssl_context()
|
|
self.assertEqual(mock_context, con)
|
|
mock_context.load_cert_chain.assert_called_once_with(cert_path,
|
|
key_path)
|
|
|
|
@unittest.skipIf(sys.version_info[:3] < (2, 7, 9),
|
|
'This feature is unsupported in this version of python '
|
|
'so the tests will be skipped')
|
|
@mock.patch.object(ssl, 'create_default_context', autospec=True)
|
|
def test_load_cert_chain_fails(self, mock_cdc):
|
|
CONF.set_override('use_ssl', True)
|
|
key_path = '/some/fake/path/key'
|
|
cert_path = '/some/fake/path/cert'
|
|
CONF.set_override('use_ssl', True)
|
|
CONF.set_override('ssl_key_path', key_path)
|
|
CONF.set_override('ssl_cert_path', cert_path)
|
|
mock_context = mock_cdc()
|
|
mock_context.load_cert_chain.side_effect = IOError('Boom!')
|
|
con = main.create_ssl_context()
|
|
self.assertEqual(mock_context, con)
|
|
mock_context.load_cert_chain.assert_called_once_with(cert_path,
|
|
key_path)
|