openstack/designate
Code Issues Proposed changes

Merge "Add proper quota error messages"

Browse Source
This commit is contained in:
Zuul 2022-02-22 00:41:24 +00:00 committed by Gerrit Code Review
commit feb68da3c9
2 changed files with 108 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
designate/quota/base.py
View File

@ -27,6 +27,7 @@ class Quota(DriverPlugin, metaclass=abc.ABCMeta):
__plugin_type__ = 'quota' __plugin_type__ = 'quota'
def limit_check(self, context, tenant_id, **values): def limit_check(self, context, tenant_id, **values):
resources_exceeded = []
quotas = self.get_quotas(context, tenant_id) quotas = self.get_quotas(context, tenant_id)
for resource, value in values.items(): for resource, value in values.items():
@ -34,10 +35,18 @@ class Quota(DriverPlugin, metaclass=abc.ABCMeta):
# Setting the resource quota to a negative value will make # Setting the resource quota to a negative value will make
# the resource unlimited # the resource unlimited
if quotas[resource] >= 0 and value > quotas[resource]: if quotas[resource] >= 0 and value > quotas[resource]:
raise exceptions.OverQuota() resources_exceeded.append(resource)
else: else:
raise exceptions.QuotaResourceUnknown("%s is not a valid quota" raise exceptions.QuotaResourceUnknown(
" resource", resource) "'%s' is not a valid quota resource." % resource
)
if resources_exceeded:
resources_exceeded.sort(key=len)
raise exceptions.OverQuota(
'Quota exceeded for %s.' %
', '.join(resources_exceeded)
)
def get_quotas(self, context, tenant_id): def get_quotas(self, context, tenant_id):
quotas = self.get_default_quotas(context) quotas = self.get_default_quotas(context)

144
designate/tests/test_quota/test_quota.py
View File

@ -18,13 +18,11 @@ from unittest import mock
from oslo_config import cfg from oslo_config import cfg
from oslo_log import log as logging from oslo_log import log as logging
from testscenarios import load_tests_apply_scenarios as load_tests # noqa from testscenarios import load_tests_apply_scenarios as load_tests # noqa
import testtools
from designate import exceptions from designate import exceptions
from designate import quota from designate import quota
from designate import tests from designate import tests
LOG = logging.getLogger(__name__) LOG = logging.getLogger(__name__)
@ -56,11 +54,19 @@ class QuotaTestCase(tests.TestCase):
def test_limit_check_unknown(self): def test_limit_check_unknown(self):
context = self.get_admin_context() context = self.get_admin_context()
with testtools.ExpectedException(exceptions.QuotaResourceUnknown): self.assertRaisesRegex(
self.quota.limit_check(context, 'tenant_id', unknown=0) exceptions.QuotaResourceUnknown,
"'unknown' is not a valid quota resource.",
self.quota.limit_check,
context, 'tenant_id', unknown=0
)
with testtools.ExpectedException(exceptions.QuotaResourceUnknown): self.assertRaisesRegex(
self.quota.limit_check(context, 'tenant_id', unknown=0, zones=0) exceptions.QuotaResourceUnknown,
"'unknown' is not a valid quota resource.",
self.quota.limit_check,
context, 'tenant_id', unknown=0, zones=0
)
def test_limit_check_under(self): def test_limit_check_under(self):
context = self.get_admin_context() context = self.get_admin_context()
@ -80,25 +86,27 @@ class QuotaTestCase(tests.TestCase):
def test_limit_check_at(self): def test_limit_check_at(self):
context = self.get_admin_context() context = self.get_admin_context()
with testtools.ExpectedException(exceptions.OverQuota): self.assertRaisesRegex(
self.quota.limit_check(context, 'tenant_id', exceptions.OverQuota, 'Quota exceeded for zones\\.',
zones=cfg.CONF.quota_zones + 1) self.quota.limit_check,
context, 'tenant_id', zones=cfg.CONF.quota_zones + 1
)
with testtools.ExpectedException(exceptions.OverQuota): self.assertRaisesRegex(
self.quota.limit_check( exceptions.OverQuota, 'Quota exceeded for zone_records\\.',
context, self.quota.limit_check,
'tenant_id', context, 'tenant_id', zone_records=cfg.CONF.quota_zone_records + 1
zone_records=cfg.CONF.quota_zone_records + 1) )
def test_limit_check_unlimited(self): def test_limit_check_unlimited(self):
context = self.get_admin_context() context = self.get_admin_context()
self.quota.get_quotas = mock.Mock() self.quota.get_quotas = mock.Mock()
ret = { ret = {
'zones': -1, 'zones': -1,
'zone_recordsets': -1, 'zone_recordsets': -1,
'zone_records': -1, 'zone_records': -1,
'recordset_records': -1, 'recordset_records': -1,
'api_export_size': -1, 'api_export_size': -1,
} }
self.quota.get_quotas.return_value = ret self.quota.get_quotas.return_value = ret
self.quota.limit_check(context, 'tenant_id', zones=99999) self.quota.limit_check(context, 'tenant_id', zones=99999)
@ -111,42 +119,82 @@ class QuotaTestCase(tests.TestCase):
context = self.get_admin_context() context = self.get_admin_context()
self.quota.get_quotas = mock.Mock() self.quota.get_quotas = mock.Mock()
ret = { ret = {
'zones': 0, 'zones': 0,
'zone_recordsets': 0, 'zone_recordsets': 0,
'zone_records': 0, 'zone_records': 0,
'recordset_records': 0, 'recordset_records': 0,
'api_export_size': 0, 'api_export_size': 0,
} }
self.quota.get_quotas.return_value = ret self.quota.get_quotas.return_value = ret
with testtools.ExpectedException(exceptions.OverQuota):
self.quota.limit_check(context, 'tenant_id', zones=1) self.assertRaisesRegex(
with testtools.ExpectedException(exceptions.OverQuota): exceptions.OverQuota, 'Quota exceeded for zones\\.',
self.quota.limit_check(context, 'tenant_id', zone_recordsets=1) self.quota.limit_check,
with testtools.ExpectedException(exceptions.OverQuota): context, 'tenant_id', zones=1
self.quota.limit_check(context, 'tenant_id', zone_records=1) )
with testtools.ExpectedException(exceptions.OverQuota):
self.quota.limit_check(context, 'tenant_id', self.assertRaisesRegex(
recordset_records=1) exceptions.OverQuota, 'Quota exceeded for zone_recordsets\\.',
with testtools.ExpectedException(exceptions.OverQuota): self.quota.limit_check,
self.quota.limit_check(context, 'tenant_id', api_export_size=1) context, 'tenant_id', zone_recordsets=1
)
self.assertRaisesRegex(
exceptions.OverQuota, 'Quota exceeded for zone_records\\.',
self.quota.limit_check,
context, 'tenant_id', zone_records=1
)
self.assertRaisesRegex(
exceptions.OverQuota,
'Quota exceeded for recordset_records\\.',
self.quota.limit_check,
context, 'tenant_id', recordset_records=1
)
self.assertRaisesRegex(
exceptions.OverQuota, 'Quota exceeded for api_export_size\\.',
self.quota.limit_check,
context, 'tenant_id', api_export_size=1
)
def test_limit_check_over(self): def test_limit_check_over(self):
context = self.get_admin_context() context = self.get_admin_context()
with testtools.ExpectedException(exceptions.OverQuota): self.assertRaisesRegex(
self.quota.limit_check(context, 'tenant_id', zones=99999) exceptions.OverQuota, 'Quota exceeded for zones\\.',
self.quota.limit_check,
context, 'tenant_id', zones=99999
)
with testtools.ExpectedException(exceptions.OverQuota): self.assertRaisesRegex(
self.quota.limit_check(context, 'tenant_id', zone_records=99999) exceptions.OverQuota, 'Quota exceeded for zone_records\\.',
self.quota.limit_check,
context, 'tenant_id', zone_records=99999
)
with testtools.ExpectedException(exceptions.OverQuota): self.assertRaisesRegex(
self.quota.limit_check(context, 'tenant_id', zones=99999, exceptions.OverQuota, 'Quota exceeded for zones, zone_records\\.',
zone_records=99999) self.quota.limit_check,
context, 'tenant_id', zones=99999, zone_records=99999
)
with testtools.ExpectedException(exceptions.OverQuota): self.assertRaisesRegex(
self.quota.limit_check(context, 'tenant_id', zones=99999, exceptions.OverQuota,
zone_records=0) 'Quota exceeded for zones, zone_records, zone_recordsets\\.',
self.quota.limit_check,
context, 'tenant_id', zones=99999, zone_records=99999,
zone_recordsets=99999
)
with testtools.ExpectedException(exceptions.OverQuota): self.assertRaisesRegex(
self.quota.limit_check(context, 'tenant_id', zones=0, exceptions.OverQuota, 'Quota exceeded for zones\\.',
zone_records=99999) self.quota.limit_check,
context, 'tenant_id', zones=99999, zone_records=0
)
self.assertRaisesRegex(
exceptions.OverQuota, 'Quota exceeded for zone_records\\.',
self.quota.limit_check,
context, 'tenant_id', zones=0, zone_records=99999
)