487 lines
19 KiB
Python
487 lines
19 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 copy
|
|
from unittest import mock
|
|
|
|
from webob import exc
|
|
|
|
from oslo_serialization import jsonutils
|
|
|
|
from senlin.api.common import util
|
|
from senlin.api.middleware import fault
|
|
from senlin.api.openstack.v1 import actions
|
|
from senlin.common import exception as senlin_exc
|
|
from senlin.common import policy
|
|
from senlin.rpc import client as rpc_client
|
|
from senlin.tests.unit.api import shared
|
|
from senlin.tests.unit.common import base
|
|
|
|
|
|
@mock.patch.object(policy, 'enforce')
|
|
class ActionControllerTest(shared.ControllerTest, base.SenlinTestCase):
|
|
"""Tests the API class which acts as the WSGI controller."""
|
|
|
|
def setUp(self):
|
|
super(ActionControllerTest, self).setUp()
|
|
|
|
# Create WSGI controller instance
|
|
class DummyConfig(object):
|
|
bind_port = 8777
|
|
|
|
cfgopts = DummyConfig()
|
|
self.controller = actions.ActionController(options=cfgopts)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_index(self, mock_call, mock_parse, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', True)
|
|
req = self._get('/actions')
|
|
|
|
engine_resp = [
|
|
{
|
|
'action': 'NODE_CREATE',
|
|
'cause': 'RPC_Request',
|
|
'cluster_id': 'CLUSTER_FAKE_ID',
|
|
'depended_by': [],
|
|
'depends_on': [],
|
|
'end_time': 1425555000.0,
|
|
'id': '2366d400-c7e3-4961-09254-6d1c3f7ac167',
|
|
'inputs': {},
|
|
'interval': -1,
|
|
'name': 'node_create_0df0931b',
|
|
'outputs': {},
|
|
'owner': None,
|
|
'start_time': 1425550000.0,
|
|
'status': 'SUCCEEDED',
|
|
'status_reason': 'Action completed successfully.',
|
|
'target': '0df0931b-e251-4f2e-8719-4effda3627ba',
|
|
'timeout': 3600
|
|
}
|
|
]
|
|
|
|
mock_call.return_value = engine_resp
|
|
obj = mock.Mock()
|
|
mock_parse.return_value = obj
|
|
|
|
result = self.controller.index(req)
|
|
|
|
self.assertEqual(engine_resp, result['actions'])
|
|
mock_parse.assert_called_once_with(
|
|
'ActionListRequest', req, {'project_safe': True})
|
|
mock_call.assert_called_once_with(
|
|
req.context, 'action_list', obj)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_index_without_cluster_id(self, mock_call, mock_parse,
|
|
mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', True)
|
|
req = self._get('/actions', version='1.13')
|
|
|
|
engine_resp = [
|
|
{
|
|
'action': 'NODE_CREATE',
|
|
'cause': 'RPC_Request',
|
|
'cluster_id': 'CLUSTER_FAKE_ID',
|
|
'depended_by': [],
|
|
'depends_on': [],
|
|
'end_time': 1425555000.0,
|
|
'id': '2366d400-c7e3-4961-09254-6d1c3f7ac167',
|
|
'inputs': {},
|
|
'interval': -1,
|
|
'name': 'node_create_0df0931b',
|
|
'outputs': {},
|
|
'owner': None,
|
|
'start_time': 1425550000.0,
|
|
'status': 'SUCCEEDED',
|
|
'status_reason': 'Action completed successfully.',
|
|
'target': '0df0931b-e251-4f2e-8719-4effda3627ba',
|
|
'timeout': 3600
|
|
}
|
|
]
|
|
|
|
mock_call.return_value = copy.deepcopy(engine_resp)
|
|
obj = mock.Mock()
|
|
mock_parse.return_value = obj
|
|
|
|
result = self.controller.index(req)
|
|
|
|
# list call for version < 1.14 should have cluster_id field removed
|
|
# remove cluster_id field from expected response
|
|
engine_resp[0].pop('cluster_id')
|
|
|
|
self.assertEqual(engine_resp, result['actions'])
|
|
mock_parse.assert_called_once_with(
|
|
'ActionListRequest', req, {'project_safe': True})
|
|
mock_call.assert_called_once_with(
|
|
req.context, 'action_list', obj)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_index_with_cluster_id(self, mock_call, mock_parse,
|
|
mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', True)
|
|
req = self._get('/actions', version='1.14')
|
|
|
|
engine_resp = [
|
|
{
|
|
'action': 'NODE_CREATE',
|
|
'cause': 'RPC_Request',
|
|
'cluster_id': 'CLUSTER_FAKE_ID',
|
|
'depended_by': [],
|
|
'depends_on': [],
|
|
'end_time': 1425555000.0,
|
|
'id': '2366d400-c7e3-4961-09254-6d1c3f7ac167',
|
|
'inputs': {},
|
|
'interval': -1,
|
|
'name': 'node_create_0df0931b',
|
|
'outputs': {},
|
|
'owner': None,
|
|
'start_time': 1425550000.0,
|
|
'status': 'SUCCEEDED',
|
|
'status_reason': 'Action completed successfully.',
|
|
'target': '0df0931b-e251-4f2e-8719-4effda3627ba',
|
|
'timeout': 3600
|
|
}
|
|
]
|
|
|
|
mock_call.return_value = copy.deepcopy(engine_resp)
|
|
obj = mock.Mock()
|
|
mock_parse.return_value = obj
|
|
|
|
result = self.controller.index(req)
|
|
|
|
self.assertEqual(engine_resp, result['actions'])
|
|
mock_parse.assert_called_once_with(
|
|
'ActionListRequest', req, {'project_safe': True})
|
|
mock_call.assert_called_once_with(
|
|
req.context, 'action_list', obj)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_index_whitelists_params(self, mock_call,
|
|
mock_parse, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', True)
|
|
marker_uuid = '8216a86c-1bdc-442e-b493-329385d37cbc'
|
|
params = {
|
|
'cluster_id': 'CLUSTER_FAKE_ID',
|
|
'name': 'NODE_CREATE',
|
|
'status': 'SUCCEEDED',
|
|
'limit': 10,
|
|
'marker': marker_uuid,
|
|
'sort': 'status',
|
|
'global_project': True,
|
|
}
|
|
req = self._get('/actions', params=params)
|
|
|
|
mock_call.return_value = []
|
|
obj = mock.Mock()
|
|
mock_parse.return_value = obj
|
|
|
|
result = self.controller.index(req)
|
|
|
|
self.assertEqual([], result['actions'])
|
|
mock_parse.assert_called_once_with(
|
|
'ActionListRequest', req,
|
|
{
|
|
'cluster_id': ['CLUSTER_FAKE_ID'],
|
|
'status': ['SUCCEEDED'],
|
|
'sort': 'status',
|
|
'name': ['NODE_CREATE'],
|
|
'limit': '10',
|
|
'marker': marker_uuid,
|
|
'project_safe': False
|
|
})
|
|
mock_call.assert_called_once_with(
|
|
req.context, 'action_list', obj)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_index_whitelists_invalid_params(self, mock_call,
|
|
mock_parse,
|
|
mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', True)
|
|
params = {
|
|
'balrog': 'you shall not pass!',
|
|
}
|
|
req = self._get('/actions', params=params)
|
|
ex = self.assertRaises(exc.HTTPBadRequest,
|
|
self.controller.index, req)
|
|
|
|
self.assertEqual("Invalid parameter balrog",
|
|
str(ex))
|
|
self.assertFalse(mock_parse.called)
|
|
self.assertFalse(mock_call.called)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_index_with_bad_schema(self, mock_call,
|
|
mock_parse, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', True)
|
|
params = {'status': 'fake'}
|
|
req = self._get('/actions', params=params)
|
|
|
|
mock_parse.side_effect = exc.HTTPBadRequest("bad param")
|
|
ex = self.assertRaises(exc.HTTPBadRequest,
|
|
self.controller.index,
|
|
req)
|
|
|
|
self.assertEqual("bad param", str(ex))
|
|
mock_parse.assert_called_once_with(
|
|
'ActionListRequest', req, mock.ANY)
|
|
self.assertFalse(mock_call.called)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_index_limit_not_int(self, mock_call,
|
|
mock_parse, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', True)
|
|
params = {'limit': 'not-int'}
|
|
req = self._get('/actions', params=params)
|
|
|
|
mock_parse.side_effect = exc.HTTPBadRequest("bad limit")
|
|
ex = self.assertRaises(exc.HTTPBadRequest,
|
|
self.controller.index, req)
|
|
|
|
self.assertEqual("bad limit", str(ex))
|
|
mock_parse.assert_called_once_with(
|
|
'ActionListRequest', req, mock.ANY)
|
|
self.assertFalse(mock_call.called)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_index_global_project_true(self, mock_call,
|
|
mock_parse, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', True)
|
|
params = {'global_project': 'True'}
|
|
req = self._get('/actions', params=params)
|
|
|
|
obj = mock.Mock()
|
|
mock_parse.return_value = obj
|
|
mock_call.return_value = []
|
|
|
|
result = self.controller.index(req)
|
|
|
|
self.assertEqual([], result['actions'])
|
|
mock_parse.assert_called_once_with(
|
|
'ActionListRequest', req, {'project_safe': False})
|
|
mock_call.assert_called_once_with(
|
|
req.context, 'action_list', obj)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_index_global_project_false(self, mock_call,
|
|
mock_parse, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', True)
|
|
params = {'global_project': 'False'}
|
|
req = self._get('/actions', params=params)
|
|
|
|
obj = mock.Mock()
|
|
mock_parse.return_value = obj
|
|
error = senlin_exc.Forbidden()
|
|
mock_call.side_effect = shared.to_remote_error(error)
|
|
|
|
resp = shared.request_with_middleware(fault.FaultWrapper,
|
|
self.controller.index,
|
|
req)
|
|
|
|
self.assertEqual(403, resp.json['code'])
|
|
self.assertEqual('Forbidden', resp.json['error']['type'])
|
|
mock_parse.assert_called_once_with(
|
|
"ActionListRequest", mock.ANY, {'project_safe': True})
|
|
mock_call.assert_called_once_with(req.context, 'action_list', obj)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_index_global_project_not_bool(self, mock_call,
|
|
mock_parse, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', True)
|
|
params = {'global_project': 'No'}
|
|
req = self._get('/actions', params=params)
|
|
|
|
ex = self.assertRaises(exc.HTTPBadRequest,
|
|
self.controller.index, req)
|
|
|
|
self.assertEqual("Invalid value 'No' specified for 'global_project'",
|
|
str(ex))
|
|
self.assertFalse(mock_call.called)
|
|
self.assertFalse(mock_parse.called)
|
|
|
|
def test_action_index_denied_policy(self, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'index', False)
|
|
req = self._get('/actions')
|
|
|
|
resp = shared.request_with_middleware(fault.FaultWrapper,
|
|
self.controller.index,
|
|
req)
|
|
self.assertEqual(403, resp.status_int)
|
|
self.assertIn('403 Forbidden', str(resp))
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_get_success(self, mock_call, mock_parse, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'get', True)
|
|
action_id = 'aaaa-bbbb-cccc'
|
|
req = self._get('/actions/%(action_id)s' % {'action_id': action_id})
|
|
|
|
engine_resp = {
|
|
'action': 'NODE_CREATE',
|
|
'cause': 'RPC_Request',
|
|
'cluster_id': 'CLUSTER_FAKE_ID',
|
|
'depended_by': [],
|
|
'depends_on': [],
|
|
'end_time': 1425555000.0,
|
|
'id': '2366d400-c7e3-4961-09254-6d1c3f7ac167',
|
|
'inputs': {},
|
|
'interval': -1,
|
|
'name': 'node_create_0df0931b',
|
|
'outputs': {},
|
|
'owner': None,
|
|
'start_time': 1425550000.0,
|
|
'status': 'SUCCEEDED',
|
|
'status_reason': 'Action completed successfully.',
|
|
'target': '0df0931b-e251-4f2e-8719-4effda3627ba',
|
|
'timeout': 3600
|
|
}
|
|
|
|
obj = mock.Mock()
|
|
mock_parse.return_value = obj
|
|
mock_call.return_value = engine_resp
|
|
|
|
response = self.controller.get(req, action_id=action_id)
|
|
|
|
self.assertEqual(engine_resp, response['action'])
|
|
|
|
mock_parse.assert_called_once_with(
|
|
'ActionGetRequest', req, {'identity': action_id})
|
|
mock_call.assert_called_once_with(
|
|
req.context, 'action_get', obj)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_get_not_found(self, mock_call, mock_parse,
|
|
mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'get', True)
|
|
action_id = 'non-existent-action'
|
|
req = self._get('/actions/%(action_id)s' % {'action_id': action_id})
|
|
|
|
obj = mock.Mock()
|
|
mock_parse.return_value = obj
|
|
error = senlin_exc.ResourceNotFound(type='action', id=action_id)
|
|
mock_call.side_effect = shared.to_remote_error(error)
|
|
|
|
resp = shared.request_with_middleware(fault.FaultWrapper,
|
|
self.controller.get,
|
|
req, action_id=action_id)
|
|
|
|
self.assertEqual(404, resp.json['code'])
|
|
self.assertEqual('ResourceNotFound', resp.json['error']['type'])
|
|
mock_parse.assert_called_once_with(
|
|
'ActionGetRequest', mock.ANY, {'identity': action_id})
|
|
mock_call.assert_called_once_with(
|
|
req.context, 'action_get', obj)
|
|
|
|
def test_action_get_denied_policy(self, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'get', False)
|
|
action_id = 'non-existent-action'
|
|
req = self._get('/actions/%(action_id)s' % {'action_id': action_id})
|
|
|
|
resp = shared.request_with_middleware(fault.FaultWrapper,
|
|
self.controller.get,
|
|
req, action_id=action_id)
|
|
|
|
self.assertEqual(403, resp.status_int)
|
|
self.assertIn('403 Forbidden', str(resp))
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_update_cancel(self, mock_call, mock_parse, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'update', True)
|
|
aid = 'xxxx-yyyy-zzzz'
|
|
body = {
|
|
'action': {
|
|
'status': 'CANCELLED'
|
|
}
|
|
}
|
|
|
|
req = self._patch('/actions/%(action_id)s' % {'action_id': aid},
|
|
jsonutils.dumps(body), version='1.12')
|
|
obj = mock.Mock()
|
|
mock_parse.return_value = obj
|
|
|
|
self.assertRaises(exc.HTTPAccepted,
|
|
self.controller.update, req,
|
|
action_id=aid, body=body)
|
|
|
|
mock_parse.assert_called_once_with(
|
|
'ActionUpdateRequest', req,
|
|
{
|
|
'identity': aid,
|
|
'status': 'CANCELLED',
|
|
'force': False
|
|
})
|
|
mock_call.assert_called_once_with(req.context, 'action_update', obj)
|
|
|
|
@mock.patch.object(util, 'parse_bool_param')
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_update_force_cancel(self, mock_call, mock_parse,
|
|
mock_parse_bool, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'update', True)
|
|
aid = 'xxxx-yyyy-zzzz'
|
|
body = {
|
|
'action': {
|
|
'status': 'CANCELLED'
|
|
}
|
|
}
|
|
params = {'force': 'True'}
|
|
req = self._patch(
|
|
'/actions/%(action_id)s' % {'action_id': aid},
|
|
jsonutils.dumps(body), version='1.12', params=params)
|
|
obj = mock.Mock()
|
|
mock_parse.return_value = obj
|
|
mock_parse_bool.return_value = True
|
|
|
|
self.assertRaises(exc.HTTPAccepted,
|
|
self.controller.update, req,
|
|
action_id=aid, body=body)
|
|
|
|
mock_parse.assert_called_once_with(
|
|
'ActionUpdateRequest', req,
|
|
{
|
|
'identity': aid,
|
|
'status': 'CANCELLED',
|
|
'force': True
|
|
})
|
|
mock_call.assert_called_once_with(req.context, 'action_update', obj)
|
|
|
|
@mock.patch.object(util, 'parse_request')
|
|
@mock.patch.object(rpc_client.EngineClient, 'call')
|
|
def test_action_update_invalid(self, mock_call, mock_parse, mock_enforce):
|
|
self._mock_enforce_setup(mock_enforce, 'update', True)
|
|
aid = 'xxxx-yyyy-zzzz'
|
|
body = {'status': 'FOO'}
|
|
|
|
req = self._patch('/actions/%(action_id)s' % {'action_id': aid},
|
|
jsonutils.dumps(body), version='1.12')
|
|
|
|
ex = self.assertRaises(exc.HTTPBadRequest,
|
|
self.controller.update, req,
|
|
action_id=aid, body=body)
|
|
|
|
self.assertEqual("Malformed request data, missing 'action' key "
|
|
"in request body.", str(ex))
|
|
|
|
self.assertFalse(mock_parse.called)
|
|
self.assertFalse(mock_call.called)
|