Source code for keystone.tests.protection.v3.test_limits

#    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 uuid

import http.client

from keystone.common import provider_api
import keystone.conf
from keystone.tests.common import auth as common_auth
from keystone.tests import unit
from keystone.tests.unit import base_classes
from keystone.tests.unit import ksfixtures

CONF = keystone.conf.CONF
PROVIDERS = provider_api.ProviderAPIs


def _create_limits_and_dependencies(domain_id=None):
    """Create limits and its dependencies for testing."""
    if not domain_id:
        domain_id = CONF.identity.default_domain_id

    service = PROVIDERS.catalog_api.create_service(
        uuid.uuid4().hex, unit.new_service_ref()
    )

    registered_limit = unit.new_registered_limit_ref(
        service_id=service['id'], id=uuid.uuid4().hex
    )
    registered_limits = (
        PROVIDERS.unified_limit_api.create_registered_limits(
            [registered_limit]
        )
    )
    registered_limit = registered_limits[0]

    domain_limit = unit.new_limit_ref(
        domain_id=domain_id, service_id=service['id'],
        resource_name=registered_limit['resource_name'],
        resource_limit=10, id=uuid.uuid4().hex
    )

    project = PROVIDERS.resource_api.create_project(
        uuid.uuid4().hex, unit.new_project_ref(domain_id=domain_id)
    )

    project_limit = unit.new_limit_ref(
        project_id=project['id'], service_id=service['id'],
        resource_name=registered_limit['resource_name'],
        resource_limit=5, id=uuid.uuid4().hex
    )
    limits = PROVIDERS.unified_limit_api.create_limits(
        [domain_limit, project_limit]
    )

    project_limit_id = None
    domain_limit_id = None
    for limit in limits:
        if limit.get('domain_id'):
            domain_limit_id = limit['id']
        else:
            project_limit_id = limit['id']

    return (project_limit_id, domain_limit_id)


class _UserLimitTests(object):
    """Common default functionality for all users except system admins."""

    def test_user_can_get_limit_model(self):
        with self.test_client() as c:
            c.get('/v3/limits/model', headers=self.headers)

    def test_user_can_get_a_limit(self):
        limit_id, _ = _create_limits_and_dependencies()

        with self.test_client() as c:
            r = c.get('/v3/limits/%s' % limit_id, headers=self.headers)
            self.assertEqual(limit_id, r.json['limit']['id'])

    def test_user_can_list_limits(self):
        project_limit_id, domain_limit_id = _create_limits_and_dependencies()

        with self.test_client() as c:
            r = c.get('/v3/limits', headers=self.headers)
            self.assertTrue(len(r.json['limits']) == 2)
            result = []
            for limit in r.json['limits']:
                result.append(limit['id'])

            self.assertIn(project_limit_id, result)
            self.assertIn(domain_limit_id, result)

    def test_user_cannot_create_limits(self):
        service = PROVIDERS.catalog_api.create_service(
            uuid.uuid4().hex, unit.new_service_ref()
        )

        registered_limit = unit.new_registered_limit_ref(
            service_id=service['id'], id=uuid.uuid4().hex
        )
        registered_limits = (
            PROVIDERS.unified_limit_api.create_registered_limits(
                [registered_limit]
            )
        )
        registered_limit = registered_limits[0]

        project = PROVIDERS.resource_api.create_project(
            uuid.uuid4().hex,
            unit.new_project_ref(domain_id=CONF.identity.default_domain_id)
        )

        create = {
            'limits': [
                unit.new_limit_ref(
                    project_id=project['id'], service_id=service['id'],
                    resource_name=registered_limit['resource_name'],
                    resource_limit=5
                )
            ]
        }

        with self.test_client() as c:
            c.post(
                '/v3/limits', json=create, headers=self.headers,
                expected_status_code=http.client.FORBIDDEN
            )

    def test_user_cannot_update_limits(self):
        limit_id, _ = _create_limits_and_dependencies()

        update = {'limits': {'description': uuid.uuid4().hex}}

        with self.test_client() as c:
            c.patch(
                '/v3/limits/%s' % limit_id, json=update,
                headers=self.headers,
                expected_status_code=http.client.FORBIDDEN
            )

    def test_user_cannot_delete_limits(self):
        limit_id, _ = _create_limits_and_dependencies()

        with self.test_client() as c:
            c.delete(
                '/v3/limits/%s' % limit_id,
                headers=self.headers,
                expected_status_code=http.client.FORBIDDEN
            )


[docs]class SystemReaderTests(base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin, _UserLimitTests):
[docs] def setUp(self): super(SystemReaderTests, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) self.config_fixture.config(group='oslo_policy', enforce_scope=True) system_reader = unit.new_user_ref( domain_id=CONF.identity.default_domain_id ) self.user_id = PROVIDERS.identity_api.create_user( system_reader )['id'] PROVIDERS.assignment_api.create_system_grant_for_user( self.user_id, self.bootstrapper.reader_role_id ) auth = self.build_authentication_request( user_id=self.user_id, password=system_reader['password'], system=True ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}
[docs]class SystemMemberTests(base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin, _UserLimitTests):
[docs] def setUp(self): super(SystemMemberTests, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) self.config_fixture.config(group='oslo_policy', enforce_scope=True) system_member = unit.new_user_ref( domain_id=CONF.identity.default_domain_id ) self.user_id = PROVIDERS.identity_api.create_user( system_member )['id'] PROVIDERS.assignment_api.create_system_grant_for_user( self.user_id, self.bootstrapper.member_role_id ) auth = self.build_authentication_request( user_id=self.user_id, password=system_member['password'], system=True ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}
[docs]class SystemAdminTests(base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin):
[docs] def setUp(self): super(SystemAdminTests, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) self.config_fixture.config(group='oslo_policy', enforce_scope=True) # Reuse the system administrator account created during # ``keystone-manage bootstrap`` self.user_id = self.bootstrapper.admin_user_id auth = self.build_authentication_request( user_id=self.user_id, password=self.bootstrapper.admin_password, system=True ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}
[docs] def test_user_can_get_a_limit(self): limit_id, _ = _create_limits_and_dependencies() with self.test_client() as c: r = c.get('/v3/limits/%s' % limit_id, headers=self.headers) self.assertEqual(limit_id, r.json['limit']['id'])
[docs] def test_user_can_list_limits(self): project_limit_id, domain_limit_id = _create_limits_and_dependencies() with self.test_client() as c: r = c.get('/v3/limits', headers=self.headers) self.assertTrue(len(r.json['limits']) == 2) result = [] for limit in r.json['limits']: result.append(limit['id']) self.assertIn(project_limit_id, result) self.assertIn(domain_limit_id, result)
[docs] def test_user_can_create_limits(self): service = PROVIDERS.catalog_api.create_service( uuid.uuid4().hex, unit.new_service_ref() ) registered_limit = unit.new_registered_limit_ref( service_id=service['id'], id=uuid.uuid4().hex ) registered_limits = ( PROVIDERS.unified_limit_api.create_registered_limits( [registered_limit] ) ) registered_limit = registered_limits[0] project = PROVIDERS.resource_api.create_project( uuid.uuid4().hex, unit.new_project_ref(domain_id=CONF.identity.default_domain_id) ) create = { 'limits': [ unit.new_limit_ref( project_id=project['id'], service_id=service['id'], resource_name=registered_limit['resource_name'], resource_limit=5 ) ] } with self.test_client() as c: c.post('/v3/limits', json=create, headers=self.headers)
[docs] def test_user_can_update_limits(self): limit_id, _ = _create_limits_and_dependencies() update = {'limits': {'description': uuid.uuid4().hex}} with self.test_client() as c: c.patch( '/v3/limits/%s' % limit_id, json=update, headers=self.headers )
[docs] def test_user_can_delete_limits(self): limit_id, _ = _create_limits_and_dependencies() with self.test_client() as c: c.delete('/v3/limits/%s' % limit_id, headers=self.headers)
[docs]class DomainUserTests(base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin):
[docs] def setUp(self): super(DomainUserTests, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) self.config_fixture.config(group='oslo_policy', enforce_scope=True) domain = PROVIDERS.resource_api.create_domain( uuid.uuid4().hex, unit.new_domain_ref() ) self.domain_id = domain['id'] domain_admin = unit.new_user_ref(domain_id=self.domain_id) self.user_id = PROVIDERS.identity_api.create_user(domain_admin)['id'] PROVIDERS.assignment_api.create_grant( self.bootstrapper.admin_role_id, user_id=self.user_id, domain_id=self.domain_id ) auth = self.build_authentication_request( user_id=self.user_id, password=domain_admin['password'], domain_id=self.domain_id ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}
[docs] def test_user_can_get_project_limits_within_domain(self): project_limit_id, _ = _create_limits_and_dependencies( domain_id=self.domain_id ) with self.test_client() as c: c.get('/v3/limits/%s' % project_limit_id, headers=self.headers)
[docs] def test_user_can_get_domain_limits(self): _, domain_limit_id = _create_limits_and_dependencies( domain_id=self.domain_id ) with self.test_client() as c: r = c.get('/v3/limits/%s' % domain_limit_id, headers=self.headers) self.assertEqual(self.domain_id, r.json['limit']['domain_id'])
[docs] def test_user_cannot_get_project_limit_outside_domain(self): project_limit_id, _ = _create_limits_and_dependencies() with self.test_client() as c: c.get( '/v3/limits/%s' % project_limit_id, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_get_domain_limits_for_other_domain(self): _, domain_limit_id = _create_limits_and_dependencies() with self.test_client() as c: c.get( '/v3/limits/%s' % domain_limit_id, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_can_list_limits_within_domain(self): project_limit_id, domain_limit_id = _create_limits_and_dependencies( domain_id=self.domain_id ) with self.test_client() as c: r = c.get('/v3/limits', headers=self.headers) result = [] for limit in r.json['limits']: result.append(limit['id']) self.assertEqual(2, len(r.json['limits'])) self.assertIn(project_limit_id, result) self.assertIn(domain_limit_id, result)
[docs] def test_user_cannot_list_limits_outside_domain(self): _create_limits_and_dependencies() with self.test_client() as c: r = c.get('/v3/limits', headers=self.headers) self.assertEqual(0, len(r.json['limits']))
[docs] def test_user_cannot_create_limits_for_domain(self): service = PROVIDERS.catalog_api.create_service( uuid.uuid4().hex, unit.new_service_ref() ) registered_limit = unit.new_registered_limit_ref( service_id=service['id'], id=uuid.uuid4().hex ) registered_limits = ( PROVIDERS.unified_limit_api.create_registered_limits( [registered_limit] ) ) registered_limit = registered_limits[0] create = { 'limits': [ unit.new_limit_ref( domain_id=self.domain_id, service_id=service['id'], resource_name=registered_limit['resource_name'], resource_limit=5 ) ] } with self.test_client() as c: c.post( '/v3/limits', json=create, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_create_limits_for_other_domain(self): service = PROVIDERS.catalog_api.create_service( uuid.uuid4().hex, unit.new_service_ref() ) registered_limit = unit.new_registered_limit_ref( service_id=service['id'], id=uuid.uuid4().hex ) registered_limits = ( PROVIDERS.unified_limit_api.create_registered_limits( [registered_limit] ) ) registered_limit = registered_limits[0] create = { 'limits': [ unit.new_limit_ref( domain_id=CONF.identity.default_domain_id, service_id=service['id'], resource_name=registered_limit['resource_name'], resource_limit=5 ) ] } with self.test_client() as c: c.post( '/v3/limits', json=create, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_create_limits_for_projects_in_domain(self): service = PROVIDERS.catalog_api.create_service( uuid.uuid4().hex, unit.new_service_ref() ) registered_limit = unit.new_registered_limit_ref( service_id=service['id'], id=uuid.uuid4().hex ) registered_limits = ( PROVIDERS.unified_limit_api.create_registered_limits( [registered_limit] ) ) registered_limit = registered_limits[0] project = PROVIDERS.resource_api.create_project( uuid.uuid4().hex, unit.new_project_ref(domain_id=self.domain_id) ) create = { 'limits': [ unit.new_limit_ref( project_id=project['id'], service_id=service['id'], resource_name=registered_limit['resource_name'], resource_limit=5 ) ] } with self.test_client() as c: c.post( '/v3/limits', json=create, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_create_limits_for_projects_outside_domain(self): service = PROVIDERS.catalog_api.create_service( uuid.uuid4().hex, unit.new_service_ref() ) registered_limit = unit.new_registered_limit_ref( service_id=service['id'], id=uuid.uuid4().hex ) registered_limits = ( PROVIDERS.unified_limit_api.create_registered_limits( [registered_limit] ) ) registered_limit = registered_limits[0] project = PROVIDERS.resource_api.create_project( uuid.uuid4().hex, unit.new_project_ref(domain_id=CONF.identity.default_domain_id) ) create = { 'limits': [ unit.new_limit_ref( project_id=project['id'], service_id=service['id'], resource_name=registered_limit['resource_name'], resource_limit=5 ) ] } with self.test_client() as c: c.post( '/v3/limits', json=create, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_update_limits_for_domain(self): _, domain_limit_id = _create_limits_and_dependencies( domain_id=self.domain_id ) update = {'limit': {'resource_limit': 1}} with self.test_client() as c: c.patch( '/v3/limits/%s' % domain_limit_id, json=update, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_update_limits_for_other_domain(self): _, domain_limit_id = _create_limits_and_dependencies() update = {'limit': {'resource_limit': 1}} with self.test_client() as c: c.patch( '/v3/limits/%s' % domain_limit_id, json=update, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_update_limits_for_projects_in_domain(self): project_limit_id, _ = _create_limits_and_dependencies( domain_id=self.domain_id ) update = {'limit': {'resource_limit': 1}} with self.test_client() as c: c.patch( '/v3/limits/%s' % project_limit_id, headers=self.headers, json=update, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_update_limits_for_projects_outside_domain(self): project_limit_id, _ = _create_limits_and_dependencies() update = {'limit': {'resource_limit': 1}} with self.test_client() as c: c.patch( '/v3/limits/%s' % project_limit_id, headers=self.headers, json=update, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_delete_limits_for_domain(self): _, domain_limit_id = _create_limits_and_dependencies( domain_id=self.domain_id ) with self.test_client() as c: c.delete( '/v3/limits/%s' % domain_limit_id, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_delete_limits_for_other_domain(self): _, domain_limit_id = _create_limits_and_dependencies() with self.test_client() as c: c.delete( '/v3/limits/%s' % domain_limit_id, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_delete_limits_for_projects_in_domain(self): project_limit_id, _ = _create_limits_and_dependencies( domain_id=self.domain_id ) with self.test_client() as c: c.delete( '/v3/limits/%s' % project_limit_id, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_delete_limits_for_projects_outside_domain(self): project_limit_id, _ = _create_limits_and_dependencies() with self.test_client() as c: c.delete( '/v3/limits/%s' % project_limit_id, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs]class ProjectUserTests(base_classes.TestCaseWithBootstrap, common_auth.AuthTestMixin):
[docs] def setUp(self): super(ProjectUserTests, self).setUp() self.loadapp() self.useFixture(ksfixtures.Policy(self.config_fixture)) self.config_fixture.config(group='oslo_policy', enforce_scope=True) # Reuse the system administrator account created during # ``keystone-manage bootstrap`` self.user_id = self.bootstrapper.admin_user_id auth = self.build_authentication_request( user_id=self.user_id, password=self.bootstrapper.admin_password, project_id=self.bootstrapper.project_id ) # Grab a token using the persona we're testing and prepare headers # for requests we'll be making in the tests. with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) self.token_id = r.headers['X-Subject-Token'] self.headers = {'X-Auth-Token': self.token_id}
[docs] def test_user_can_get_project_limit(self): project_limit_id, _ = _create_limits_and_dependencies() limit = PROVIDERS.unified_limit_api.get_limit(project_limit_id) # NOTE(lbragstad): Project users are only allowed to list limits for a # project if they actually have a role assignment on the project and # call the API with a project-scoped token. PROVIDERS.assignment_api.create_grant( self.bootstrapper.reader_role_id, user_id=self.user_id, project_id=limit['project_id'] ) auth = self.build_authentication_request( user_id=self.user_id, password=self.bootstrapper.admin_password, project_id=limit['project_id'] ) with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) token_id = r.headers['X-Subject-Token'] headers = {'X-Auth-Token': token_id} with self.test_client() as c: r = c.get('/v3/limits/%s' % project_limit_id, headers=headers)
[docs] def test_user_cannot_get_project_limit_without_role_assignment(self): project_limit_id, _ = _create_limits_and_dependencies() with self.test_client() as c: c.get( '/v3/limits/%s' % project_limit_id, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_get_domain_limit(self): _, domain_limit_id = _create_limits_and_dependencies() with self.test_client() as c: c.get( '/v3/limits/%s' % domain_limit_id, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_can_list_limits(self): project_limit_id, _ = _create_limits_and_dependencies() limit = PROVIDERS.unified_limit_api.get_limit(project_limit_id) # NOTE(lbragstad): Project users are only allowed to list limits for a # project if they actually have a role assignment on the project and # call the API with a project-scoped token. PROVIDERS.assignment_api.create_grant( self.bootstrapper.reader_role_id, user_id=self.user_id, project_id=limit['project_id'] ) auth = self.build_authentication_request( user_id=self.user_id, password=self.bootstrapper.admin_password, project_id=limit['project_id'] ) with self.test_client() as c: r = c.post('/v3/auth/tokens', json=auth) token_id = r.headers['X-Subject-Token'] headers = {'X-Auth-Token': token_id} with self.test_client() as c: r = c.get('/v3/limits', headers=headers) self.assertTrue(len(r.json['limits']) == 1) self.assertEqual(project_limit_id, r.json['limits'][0]['id'])
[docs] def test_user_cannot_list_limits_without_project_role_assignment(self): _create_limits_and_dependencies() with self.test_client() as c: r = c.get('/v3/limits', headers=self.headers) self.assertEqual(0, len(r.json['limits']))
[docs] def test_user_can_get_limit_model(self): with self.test_client() as c: c.get('/v3/limits/model', headers=self.headers)
[docs] def test_user_cannot_create_limits(self): service = PROVIDERS.catalog_api.create_service( uuid.uuid4().hex, unit.new_service_ref() ) registered_limit = unit.new_registered_limit_ref( service_id=service['id'], id=uuid.uuid4().hex ) registered_limits = ( PROVIDERS.unified_limit_api.create_registered_limits( [registered_limit] ) ) registered_limit = registered_limits[0] project = PROVIDERS.resource_api.create_project( uuid.uuid4().hex, unit.new_project_ref(domain_id=CONF.identity.default_domain_id) ) create = { 'limits': [ unit.new_limit_ref( project_id=project['id'], service_id=service['id'], resource_name=registered_limit['resource_name'], resource_limit=5 ) ] } with self.test_client() as c: c.post( '/v3/limits', json=create, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_update_limits(self): limit_id, _ = _create_limits_and_dependencies() update = {'limits': {'description': uuid.uuid4().hex}} with self.test_client() as c: c.patch( '/v3/limits/%s' % limit_id, json=update, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs] def test_user_cannot_delete_limits(self): limit_id, _ = _create_limits_and_dependencies() with self.test_client() as c: c.delete( '/v3/limits/%s' % limit_id, headers=self.headers, expected_status_code=http.client.FORBIDDEN )
[docs]class ProjectUserTestsWithoutEnforceScope(ProjectUserTests):
[docs] def setUp(self): super(ProjectUserTestsWithoutEnforceScope, self).setUp() self.config_fixture.config(group='oslo_policy', enforce_scope=False)