Test cases for policies API

Not complete!!!

senlin/tests/apiv1/test_policies.py

@@ -0,0 +1,556 @@
+# 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 json
+import mock
+import six
+from webob import exc
+
+from senlin.api.middleware import fault
+from senlin.api.openstack.v1 import policies
+from senlin.common import exception as senlin_exc
+from senlin.common import policy
+from senlin.rpc import client as rpc_client
+from senlin.tests.apiv1 import shared
+from senlin.tests.common import base
+
+
+class PolicyDataTest(base.SenlinTestCase):
+    def test_policy_data(self):
+        body = {
+            'name': 'test_policy',
+            'spec': {
+                'param1': 'value1',
+                'param2': 'value2',
+            },
+            'type': 'test_policy_type',
+            'level': 10,
+            'cooldown': 60,
+        }
+
+        data = policies.PolicyData(body)
+        self.assertEqual('test_policy', data.name())
+        self.assertEqual({'param1': 'value1', 'param2': 'value2'}, data.spec())
+        self.assertEqual('test_policy_type', data.type())
+        self.assertEqual(10, data.level())
+        self.assertEqual(60, data.cooldown())
+
+    def test_required_fields_missing(self):
+        body = {'not a policy name': 'wibble'}
+
+        data = policies.PolicyData(body)
+        self.assertRaises(exc.HTTPBadRequest, data.name)
+        self.assertRaises(exc.HTTPBadRequest, data.spec)
+        self.assertRaises(exc.HTTPBadRequest, data.type)
+        self.assertIsNone(data.level())
+        self.assertIsNone(data.cooldown())
+
+
+@mock.patch.object(policy.Enforcer, 'enforce')
+class PolicyControllerTest(shared.ControllerTest, base.SenlinTestCase):
+    def setUp(self):
+        super(PolicyControllerTest, self).setUp()
+
+        class DummyConfig(object):
+            bind_port = 8778
+
+        cfgopts = DummyConfig()
+        self.controller = policies.PolicyController(options=cfgopts)
+
+    def test_policy_index_normal(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'index', True)
+        req = self._get('/policies')
+
+        engine_resp = [
+            {
+                u'id': u'aaaa-bbbb-cccc',
+                u'name': u'policy-1',
+                u'type': u'test_policy_type',
+                u'spec': {
+                    u'param_1': u'value1',
+                    u'param_2': u'value2',
+                },
+                u'level': 30,
+                u'created_time': u'2015-02-24T19:17:22Z',
+                u'updated_time': None,
+                u'deleted_time': None,
+                u'cooldown': 60,
+            }
+        ]
+
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call',
+                                     return_value=engine_resp)
+
+        result = self.controller.index(req, tenant_id=self.tenant)
+
+        default_args = {'limit': None, 'marker': None,
+                        'sort_keys': None, 'sort_dir': None,
+                        'filters': None, 'show_deleted': False}
+
+        mock_call.assert_called_with(req.context,
+                                     ('policy_list', default_args))
+
+        expected = {'policies': engine_resp}
+        self.assertEqual(expected, result)
+
+    def test_policy_index_whitelists_params(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'index', True)
+        params = {
+            'limit': 20,
+            'marker': 'fake marker',
+            'sort_keys': 'fake sort keys',
+            'sort_dir': 'fake sort dir',
+            'show_deleted': False,
+            'balrog': 'you shall not pass!'
+        }
+        req = self._get('/policies', params=params)
+
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call')
+        mock_call.return_value = []
+
+        self.controller.index(req, tenant_id=self.tenant)
+
+        rpc_call_args, _ = mock_call.call_args
+        engine_args = rpc_call_args[1][1]
+
+        self.assertEqual(6, len(engine_args))
+        self.assertIn('limit', engine_args)
+        self.assertIn('marker', engine_args)
+        self.assertIn('sort_keys', engine_args)
+        self.assertIn('sort_dir', engine_args)
+        self.assertIn('filters', engine_args)
+        self.assertIn('show_deleted', engine_args)
+        self.assertNotIn('tenant_safe', engine_args)
+        self.assertNotIn('balrog', engine_args)
+
+    def test_policy_index_whitelist_filter_params(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'index', True)
+        params = {
+            'type': 'some_type',
+            'name': 'fake name',
+            'balrog': 'you shall not pass!'
+        }
+        req = self._get('/policies', params=params)
+
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call')
+        mock_call.return_value = []
+
+        self.controller.index(req, tenant_id=self.tenant)
+
+        rpc_call_args, _ = mock_call.call_args
+        engine_args = rpc_call_args[1][1]
+        self.assertIn('filters', engine_args)
+
+        filters = engine_args['filters']
+        self.assertEqual(2, len(filters))
+        self.assertIn('name', filters)
+        self.assertIn('type', filters)
+        self.assertNotIn('balrog', filters)
+
+    def test_policy_index_show_deleted_false(self, mock_enforce):
+        mock_call = self.patchobject(rpc_client.EngineClient, 'policy_list',
+                                     return_value=[])
+
+        params = {'show_deleted': 'False'}
+        req = self._get('/policies', params=params)
+        self.controller.index(req, tenant_id=self.tenant)
+        mock_call.assert_called_once_with(mock.ANY,
+                                          filters=mock.ANY,
+                                          show_deleted=False)
+
+    def test_policy_index_show_deleted_true(self, mock_enforce):
+        mock_call = self.patchobject(rpc_client.EngineClient, 'policy_list',
+                                     return_value=[])
+
+        params = {'show_deleted': 'True'}
+        req = self._get('/policies', params=params)
+        self.controller.index(req, tenant_id=self.tenant)
+        mock_call.assert_called_once_with(mock.ANY,
+                                          filters=mock.ANY,
+                                          show_deleted=True)
+
+    def test_policy_index_show_deleted_non_bool(self, mock_enforce):
+        mock_call = self.patchobject(rpc_client.EngineClient, 'policy_list',
+                                     return_value=[])
+
+        params = {'show_deleted': 'yes'}
+        req = self._get('/policies', params=params)
+        ex = self.assertRaises(senlin_exc.InvalidParameter,
+                               self.controller.index, req,
+                               tenant_id=self.tenant)
+        self.assertIn("Invalid value 'yes' specified for 'show_deleted'",
+                      six.text_type(ex))
+        self.assertFalse(mock_call.called)
+
+    def test_policy_index_limit_non_int(self, mock_enforce):
+        mock_call = self.patchobject(rpc_client.EngineClient, 'policy_list',
+                                     return_value=[])
+
+        params = {'limit': 'abc'}
+        req = self._get('/policies', params=params)
+        ex = self.assertRaises(senlin_exc.InvalidParameter,
+                               self.controller.index, req,
+                               tenant_id=self.tenant)
+        self.assertIn("Invalid value 'abc' specified for 'limit'",
+                      six.text_type(ex))
+        self.assertFalse(mock_call.called)
+
+    def test_policy_index_denied_policy(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'index', False)
+        req = self._get('/policies')
+
+        resp = shared.request_with_middleware(fault.FaultWrapper,
+                                              self.controller.index,
+                                              req, tenant_id=self.tenant)
+        self.assertEqual(403, resp.status_int)
+        self.assertIn('403 Forbidden', six.text_type(resp))
+
+    def test_policy_create_success(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'create', True)
+        body = {
+            'policy': {
+                'name': 'test_policy',
+                'type': 'test_policy_type',
+                'spec': {
+                    'param_1': 'value1',
+                    'param_2': 2,
+                },
+                'level': 30,
+                'cooldown': 60,
+            }
+        }
+
+        engine_response = {
+            'id': 'xxxx-yyyy-zzzz',
+            'name': 'test_policy',
+            'type': 'test_policy_type',
+            'spec': {
+                    'param_1': 'value1',
+                    'param_2': 2,
+            },
+            'level': 30,
+            'cooldown': 60,
+        }
+
+        req = self._post('/policies', json.dumps(body))
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call',
+                                     return_value=engine_response)
+
+        resp = self.controller.create(req, tenant_id=self.tenant, body=body)
+
+        mock_call.assert_called_with(
+            req.context,
+            ('policy_create', {
+                'name': 'test_policy',
+                'type': 'test_policy_type',
+                'spec': {'param_1': 'value1', 'param_2': 2},
+                'level': 30,
+                'cooldown': 60
+            })
+        )
+
+        expected = {'policy': engine_response}
+        self.assertEqual(expected, resp)
+
+    def test_policy_create_with_bad_body(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'create', True)
+        body = {'name': 'test_policy'}
+
+        req = self._post('/policies', json.dumps(body))
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call')
+        ex = self.assertRaises(exc.HTTPBadRequest,
+                               self.controller.create,
+                               req, tenant_id=self.tenant,
+                               body=body)
+
+        self.assertEqual("Malformed request data, missing 'policy' key "
+                         "in request body.", six.text_type(ex))
+
+        self.assertFalse(mock_call.called)
+
+    def test_policy_create_with_bad_type(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'create', True)
+        type_name = 'unknown_type'
+        body = {
+            'policy': {
+                'name': 'test_policy',
+                'type': type_name,
+                'spec': {'param': 'value'},
+            }
+        }
+        req = self._post('/policies', json.dumps(body))
+
+        error = senlin_exc.PolicyTypeNotFound(policy_type=type_name)
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call',
+                                     side_effect=error)
+
+        resp = shared.request_with_middleware(fault.FaultWrapper,
+                                              self.controller.create,
+                                              req, tenant_id=self.tenant,
+                                              body=body)
+
+        mock_call.assert_called_once()
+        self.assertEqual(404, resp.json['code'])
+        self.assertEqual('PolicyTypeNotFound', resp.json['error']['type'])
+        self.assertIsNone(resp.json['error']['traceback'])
+
+    def test_policy_create_with_spec_validation_failed(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'create', True)
+        body = {
+            'policy': {
+                'name': 'test_policy',
+                'type': 'test_policy_type',
+                'spec': {'param': 'value'},
+            }
+        }
+        req = self._post('/policies', json.dumps(body))
+
+        msg = 'Spec validation error (param): value'
+        error = senlin_exc.SpecValidationFailed(message=msg)
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call',
+                                     side_effect=error)
+
+        resp = shared.request_with_middleware(fault.FaultWrapper,
+                                              self.controller.create,
+                                              req, tenant_id=self.tenant,
+                                              body=body)
+
+        mock_call.assert_called_once()
+        self.assertEqual(400, resp.json['code'])
+        self.assertEqual('SpecValidationFailed', resp.json['error']['type'])
+        self.assertIsNone(resp.json['error']['traceback'])
+
+    def test_policy_create_denied_policy(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'create', False)
+        body = {
+            'policy': {
+                'name': 'test_policy',
+                'type': 'test_policy_type',
+                'spec': {'param': 'value'},
+            }
+        }
+
+        req = self._post('/policies', json.dumps(body))
+        resp = shared.request_with_middleware(fault.FaultWrapper,
+                                              self.controller.create,
+                                              req, tenant_id=self.tenant)
+        self.assertEqual(403, resp.status_int)
+        self.assertIn('403 Forbidden', six.text_type(resp))
+
+    def test_policy_get_normal(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'get', True)
+        pid = 'aaaa-bbbb-cccc'
+        req = self._get('/policies/%(policy_id)s' % {'policy_id': pid})
+
+        engine_resp = {
+            u'id': u'aaaa-bbbb-cccc',
+            u'name': u'policy-1',
+            u'type': u'test_policy_type',
+            u'spec': {
+                u'param_1': u'value1',
+                u'param_2': u'value2',
+            },
+            u'level': 30,
+            u'created_time': u'2015-02-24T19:17:22Z',
+            u'updated_time': None,
+            u'deleted_time': None,
+            u'cooldown': 60,
+        }
+
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call',
+                                     return_value=engine_resp)
+
+        result = self.controller.get(req, tenant_id=self.tenant,
+                                     policy_id=pid)
+
+        mock_call.assert_called_with(req.context,
+                                     ('policy_get', {'identity': pid}))
+
+        expected = {'policy': engine_resp}
+        self.assertEqual(expected, result)
+
+    def test_policy_get_not_found(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'get', True)
+        pid = 'non-existent-policy'
+        req = self._get('/policies/%(policy_id)s' % {'policy_id': pid})
+
+        error = senlin_exc.PolicyNotFound(policy=pid)
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call')
+        mock_call.side_effect = shared.to_remote_error(error)
+
+        resp = shared.request_with_middleware(fault.FaultWrapper,
+                                              self.controller.get,
+                                              req, tenant_id=self.tenant,
+                                              policy_id=pid)
+
+        self.assertEqual(404, resp.json['code'])
+        self.assertEqual('PolicyNotFound', resp.json['error']['type'])
+
+    def test_policy_get_denied_policy(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'get', False)
+        pid = 'non-existent-policy'
+        req = self._get('/policies/%(policy_id)s' % {'policy_id': pid})
+
+        resp = shared.request_with_middleware(fault.FaultWrapper,
+                                              self.controller.get,
+                                              req, tenant_id=self.tenant,
+                                              policy_id=pid)
+
+        self.assertEqual(403, resp.status_int)
+        self.assertIn('403 Forbidden', six.text_type(resp))
+
+    def test_policy_update_normal(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'update', True)
+        pid = 'aaaa-bbbb-cccc'
+        body = {
+            'policy': {
+                'name': 'policy-2',
+                'level': 20,
+            }
+        }
+
+        req = self._put('/policies/%(policy_id)s' % {'policy_id': pid},
+                        json.dumps(body))
+
+        engine_resp = {
+            u'id': pid,
+            u'name': u'policy-2',
+            u'type': u'test_policy_type',
+            u'spec': {
+                u'param_1': u'value1',
+                u'param_2': u'value3',
+            },
+            u'level': 60,
+            u'created_time': u'2015-02-25T16:20:13Z',
+            u'updated_time': None,
+            u'deleted_time': None,
+            u'cooldown': 60,
+        }
+
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call',
+                                     return_value=engine_resp)
+        result = self.controller.update(req, tenant_id=self.tenant,
+                                        policy_id=pid,
+                                        body=body)
+
+        args = copy.deepcopy(body['policy'])
+        args['identity'] = pid
+        args['level'] = 20 
+        args['cooldown'] = None 
+        mock_call.assert_called_with(req.context, ('policy_update', args))
+
+        expected = {'policy': engine_resp}
+        self.assertEqual(expected, result)
+
+    def test_policy_update_no_name(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'update', True)
+        pid = 'aaaa-bbbb-cccc'
+        body = {
+            'policy': {'spec': {'param_2': 'value3'}, 'level': 50}
+        }
+
+        req = self._patch('/policies/%(policy_id)s' % {'policy_id': pid},
+                        json.dumps(body))
+
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call')
+        result = self.controller.update(req, tenant_id=self.tenant,
+                                        policy_id=pid, body=body)
+        self.assertIsNotNone(result)
+        self.assertTrue(mock_call.called)
+
+    def test_policy_update_not_found(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'update', True)
+        pid = 'non-existent-policy'
+        body = {
+            'policy': {
+                'name': 'new_policy',
+                'level': 70,
+            }
+        }
+        req = self._patch('/policies/%(policy_id)s' % {'policy_id': pid},
+                        json.dumps(body))
+
+        error = senlin_exc.PolicyNotFound(policy=pid)
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call')
+        mock_call.side_effect = shared.to_remote_error(error)
+
+        resp = shared.request_with_middleware(fault.FaultWrapper,
+                                              self.controller.update,
+                                              req, tenant_id=self.tenant,
+                                              policy_id=pid,
+                                              body=body)
+
+        self.assertEqual(404, resp.json['code'])
+        self.assertEqual('PolicyNotFound', resp.json['error']['type'])
+
+    def test_policy_update_denied_policy(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'update', False)
+        pid = 'aaaa-bbbb-cccc'
+        body = {
+            'policy': {'name': 'test_policy', 'spec': {'param5': 'value5'}},
+        }
+        req = self._put('/policies/%(policy_id)s' % {'policy_id': pid},
+                        json.dumps(body))
+
+        resp = shared.request_with_middleware(fault.FaultWrapper,
+                                              self.controller.update,
+                                              req, tenant_id=self.tenant,
+                                              policy_id=pid,
+                                              body=body)
+
+        self.assertEqual(403, resp.status_int)
+        self.assertIn('403 Forbidden', six.text_type(resp))
+
+    def test_policy_delete_success(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'delete', True)
+        pid = 'aaaa-bbbb-cccc'
+        req = self._delete('/policies/%(policy_id)s' % {'policy_id': pid})
+
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call',
+                                     return_value=None)
+
+        self.assertRaises(exc.HTTPNoContent, self.controller.delete,
+                          req, tenant_id=self.tenant, policy_id=pid)
+
+        mock_call.assert_called_with(
+            req.context, ('policy_delete', {'identity': pid}))
+
+    def test_policy_delete_not_found(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'delete', True)
+        pid = 'aaaa-bbbb-cccc'
+        req = self._delete('/policies/%(policy_id)s' % {'policy_id': pid})
+
+        error = senlin_exc.PolicyNotFound(policy=pid)
+        mock_call = self.patchobject(rpc_client.EngineClient, 'call')
+        mock_call.side_effect = shared.to_remote_error(error)
+
+        resp = shared.request_with_middleware(fault.FaultWrapper,
+                                              self.controller.delete,
+                                              req, tenant_id=self.tenant,
+                                              policy_id=pid)
+
+        self.assertEqual(404, resp.json['code'])
+        self.assertEqual('PolicyNotFound', resp.json['error']['type'])
+
+    def test_policy_delete_err_denied_policy(self, mock_enforce):
+        self._mock_enforce_setup(mock_enforce, 'delete', False)
+        pid = 'aaaa-bbbb-cccc'
+        req = self._delete('/policies/%(policy_id)s' % {'policy_id': pid})
+
+        resp = shared.request_with_middleware(fault.FaultWrapper,
+                                              self.controller.delete,
+                                              req, tenant_id=self.tenant,
+                                              policy_id=pid)
+
+        self.assertEqual(403, resp.status_int)
+        self.assertIn('403 Forbidden', six.text_type(resp))