From e3ccd91c3c47152b1af8969ff5bb8580941f5016 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Wed, 1 Apr 2020 01:02:59 -0500 Subject: [PATCH] Add test coverage of existing rescue policies Current tests do not have good test coverage of existing policies. Either tests for policies do not exist or if they exist then they do not cover the actual negative and positive testing. For Example, if any policy with default rule as admin only then test should verify: - policy check pass with context having admin or server owner - policy check fail with context having non-admin and not server owner As discussed in policy-defaults-refresh, to change the policies with new default roles and scope_type, we need to have the enough testing coverage of existing policy behavior. When we will add the scope_type in policies or new default roles, then these test coverage will be extended to adopt the new changes and also make sure we do not break the existing behavior. This commit covers the testing coverage of existing unrescue policies. Also pass the actual target which is server's project_id in unrescue policy. Partial implement blueprint policy-defaults-refresh Change-Id: I04087be1e0023c026c06b690f20126472b0b63f0 --- nova/api/openstack/compute/rescue.py | 3 +- .../unit/api/openstack/compute/test_rescue.py | 73 ----------- nova/tests/unit/policies/test_rescue.py | 119 ++++++++++++++++++ 3 files changed, 121 insertions(+), 74 deletions(-) create mode 100644 nova/tests/unit/policies/test_rescue.py diff --git a/nova/api/openstack/compute/rescue.py b/nova/api/openstack/compute/rescue.py index 4f83d53656..74fb3a3b5a 100644 --- a/nova/api/openstack/compute/rescue.py +++ b/nova/api/openstack/compute/rescue.py @@ -83,8 +83,9 @@ class RescueController(wsgi.Controller): def _unrescue(self, req, id, body): """Unrescue an instance.""" context = req.environ["nova.context"] - context.can(rescue_policies.BASE_POLICY_NAME) instance = common.get_instance(self.compute_api, context, id) + context.can(rescue_policies.BASE_POLICY_NAME, + target={'project_id': instance.project_id}) try: self.compute_api.unrescue(context, instance) except exception.InstanceIsLocked as e: diff --git a/nova/tests/unit/api/openstack/compute/test_rescue.py b/nova/tests/unit/api/openstack/compute/test_rescue.py index 085319e8d2..7f229ea356 100644 --- a/nova/tests/unit/api/openstack/compute/test_rescue.py +++ b/nova/tests/unit/api/openstack/compute/test_rescue.py @@ -212,76 +212,3 @@ class RescueTestV21(test.NoDBTestCase): self.assertRaises(exception.ValidationError, self.controller._rescue, self.fake_req, UUID, body=body) - - -class RescuePolicyEnforcementV21(test.NoDBTestCase): - - def setUp(self): - super(RescuePolicyEnforcementV21, self).setUp() - self.controller = rescue_v21.RescueController() - self.req = fakes.HTTPRequest.blank('') - - @mock.patch('nova.api.openstack.common.get_instance') - def test_rescue_policy_failed_with_other_project(self, get_instance_mock): - get_instance_mock.return_value = fake_instance.fake_instance_obj( - self.req.environ['nova.context'], - project_id=self.req.environ['nova.context'].project_id) - rule_name = "os_compute_api:os-rescue" - self.policy.set_rules({rule_name: "project_id:%(project_id)s"}) - body = {"rescue": {"adminPass": "AABBCC112233"}} - # Change the project_id in request context. - self.req.environ['nova.context'].project_id = 'other-project' - exc = self.assertRaises( - exception.PolicyNotAuthorized, - self.controller._rescue, self.req, fakes.FAKE_UUID, - body=body) - self.assertEqual( - "Policy doesn't allow %s to be performed." % rule_name, - exc.format_message()) - - @mock.patch('nova.api.openstack.common.get_instance') - def test_rescue_overridden_policy_failed_with_other_user_in_same_project( - self, get_instance_mock): - get_instance_mock.return_value = ( - fake_instance.fake_instance_obj(self.req.environ['nova.context'])) - rule_name = "os_compute_api:os-rescue" - self.policy.set_rules({rule_name: "user_id:%(user_id)s"}) - # Change the user_id in request context. - self.req.environ['nova.context'].user_id = 'other-user' - body = {"rescue": {"adminPass": "AABBCC112233"}} - exc = self.assertRaises(exception.PolicyNotAuthorized, - self.controller._rescue, self.req, - fakes.FAKE_UUID, body=body) - self.assertEqual( - "Policy doesn't allow %s to be performed." % rule_name, - exc.format_message()) - - @mock.patch('nova.compute.api.API.rescue') - @mock.patch('nova.api.openstack.common.get_instance') - def test_lock_overridden_policy_pass_with_same_user(self, - get_instance_mock, - rescue_mock): - instance = fake_instance.fake_instance_obj( - self.req.environ['nova.context'], - user_id=self.req.environ['nova.context'].user_id) - get_instance_mock.return_value = instance - rule_name = "os_compute_api:os-rescue" - self.policy.set_rules({rule_name: "user_id:%(user_id)s"}) - body = {"rescue": {"adminPass": "AABBCC112233"}} - self.controller._rescue(self.req, fakes.FAKE_UUID, body=body) - rescue_mock.assert_called_once_with(self.req.environ['nova.context'], - instance, - rescue_password='AABBCC112233', - rescue_image_ref=None) - - def test_unrescue_policy_failed(self): - rule_name = "os_compute_api:os-rescue" - self.policy.set_rules({rule_name: "project:non_fake"}) - body = dict(unrescue=None) - exc = self.assertRaises( - exception.PolicyNotAuthorized, - self.controller._unrescue, self.req, fakes.FAKE_UUID, - body=body) - self.assertEqual( - "Policy doesn't allow %s to be performed." % rule_name, - exc.format_message()) diff --git a/nova/tests/unit/policies/test_rescue.py b/nova/tests/unit/policies/test_rescue.py new file mode 100644 index 0000000000..41dc97720c --- /dev/null +++ b/nova/tests/unit/policies/test_rescue.py @@ -0,0 +1,119 @@ +# 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 fixtures +import mock +from nova.policies import rescue as rs_policies +from oslo_utils.fixture import uuidsentinel as uuids +from oslo_utils import timeutils + +from nova.api.openstack.compute import rescue +from nova.compute import vm_states +from nova import exception +from nova.tests.unit.api.openstack import fakes +from nova.tests.unit import fake_instance +from nova.tests.unit.policies import base + + +class RescueServerPolicyTest(base.BasePolicyTest): + """Test Rescue Server APIs policies with all possible context. + This class defines the set of context with different roles + which are allowed and not allowed to pass the policy checks. + With those set of context, it will call the API operation and + verify the expected behaviour. + """ + + def setUp(self): + super(RescueServerPolicyTest, self).setUp() + self.controller = rescue.RescueController() + self.req = fakes.HTTPRequest.blank('') + user_id = self.req.environ['nova.context'].user_id + self.mock_get = self.useFixture( + fixtures.MockPatch('nova.api.openstack.common.get_instance')).mock + uuid = uuids.fake_id + self.instance = fake_instance.fake_instance_obj( + self.project_member_context, + id=1, uuid=uuid, project_id=self.project_id, + user_id=user_id, vm_state=vm_states.ACTIVE, + task_state=None, launched_at=timeutils.utcnow()) + self.mock_get.return_value = self.instance + + # Check that admin or and server owner is able to rescue/unrescue + # the sevrer + self.admin_or_owner_authorized_contexts = [ + self.legacy_admin_context, self.system_admin_context, + self.project_admin_context, self.project_member_context, + self.project_reader_context, self.project_foo_context] + # Check that non-admin/owner is not able to rescue/unrescue + # the server + self.admin_or_owner_unauthorized_contexts = [ + self.system_member_context, self.system_reader_context, + self.system_foo_context, + self.other_project_member_context + ] + + @mock.patch('nova.compute.api.API.rescue') + def test_rescue_server_policy(self, mock_rescue): + rule_name = rs_policies.BASE_POLICY_NAME + self.common_policy_check(self.admin_or_owner_authorized_contexts, + self.admin_or_owner_unauthorized_contexts, + rule_name, + self.controller._rescue, + self.req, self.instance.uuid, + body={'rescue': {}}) + + @mock.patch('nova.compute.api.API.unrescue') + def test_unrescue_server_policy(self, mock_unrescue): + rule_name = rs_policies.BASE_POLICY_NAME + self.common_policy_check(self.admin_or_owner_authorized_contexts, + self.admin_or_owner_unauthorized_contexts, + rule_name, + self.controller._unrescue, + self.req, self.instance.uuid, + body={'unrescue': {}}) + + def test_rescue_server_policy_failed_with_other_user(self): + # Change the user_id in request context. + req = fakes.HTTPRequest.blank('') + req.environ['nova.context'].user_id = 'other-user' + rule_name = rs_policies.BASE_POLICY_NAME + self.policy.set_rules({rule_name: "user_id:%(user_id)s"}) + exc = self.assertRaises( + exception.PolicyNotAuthorized, self.controller._rescue, + req, fakes.FAKE_UUID, body={'rescue': {}}) + self.assertEqual( + "Policy doesn't allow %s to be performed." % rule_name, + exc.format_message()) + + @mock.patch('nova.compute.api.API.rescue') + def test_rescue_sevrer_overridden_policy_pass_with_same_user( + self, mock_rescue): + rule_name = rs_policies.BASE_POLICY_NAME + self.policy.set_rules({rule_name: "user_id:%(user_id)s"}) + self.controller._rescue(self.req, + fakes.FAKE_UUID, + body={'rescue': {}}) + + +class RescueServerScopeTypePolicyTest(RescueServerPolicyTest): + """Test Rescue Server APIs policies with system scope enabled. + This class set the nova.conf [oslo_policy] enforce_scope to True + so that we can switch on the scope checking on oslo policy side. + It defines the set of context with scoped token + which are allowed and not allowed to pass the policy checks. + With those set of context, it will run the API operation and + verify the expected behaviour. + """ + + def setUp(self): + super(RescueServerScopeTypePolicyTest, self).setUp() + self.flags(enforce_scope=True, group="oslo_policy")