# Copyright (C) 2013 eNovance SAS <licensing@enovance.com>
#
# 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.
from tempest.api.object_storage import base
from tempest.common import object_storage
from tempest.common import utils
from tempest import config
from tempest.lib.common import api_version_request
from tempest.lib.common.utils import data_utils
from tempest.lib import decorators
from tempest.lib import exceptions as lib_exc
CONF = config.CONF
[docs]
class AccountQuotasTest(base.BaseObjectTest):
"""Test account quotas"""
credentials = [['operator', CONF.object_storage.operator_role],
['reseller', CONF.object_storage.reseller_admin_role]]
@classmethod
def setup_credentials(cls):
super(AccountQuotasTest, cls).setup_credentials()
cls.os_reselleradmin = cls.os_roles_reseller
@classmethod
def resource_setup(cls):
super(AccountQuotasTest, cls).resource_setup()
cls.container_name = cls.create_container()
# Retrieve a ResellerAdmin auth data and use it to set a quota
# on the client's account
cls.reselleradmin_auth_data = \
cls.os_reselleradmin.auth_provider.auth_data
def setUp(self):
super(AccountQuotasTest, self).setUp()
self._set_quota()
def _set_quota(self, quota_bytes=20, quota_count=5):
# Set the reselleradmin auth in headers for next account_client
# request
self.account_client.auth_provider.set_alt_auth_data(
request_part='headers',
auth_data=self.reselleradmin_auth_data
)
self.quota_bytes = quota_bytes
self.quota_count = quota_count
headers = {
"X-Account-Meta-Quota-Bytes": str(self.quota_bytes),
"X-Account-Quota-Count": str(self.quota_count)
}
self.os_roles_operator.account_client.request(
"POST", url="", headers=headers, body="")
def _get_version(self):
swift_version = "latest"
if CONF.object_storage_feature_enabled.discoverability:
body = self.capabilities_client.list_capabilities()
_version = body.get('swift', {}).get('version', "latest")
swift_version = ".".join(_version.split('.')[:2])
self.swift_version = api_version_request.APIVersionRequest(
swift_version)
def tearDown(self):
# Set the reselleradmin auth in headers for next account_client
# request
self.account_client.auth_provider.set_alt_auth_data(
request_part='headers',
auth_data=self.reselleradmin_auth_data
)
# remove the quota from the container
headers = {
"X-Remove-Account-Meta-Quota-Bytes": "x",
"X-Remove-Account-Quota-Count": "x"
}
self.os_roles_operator.account_client.request(
"POST", url="", headers=headers, body="")
super(AccountQuotasTest, self).tearDown()
@classmethod
def resource_cleanup(cls):
cls.delete_containers()
super(AccountQuotasTest, cls).resource_cleanup()
[docs]
@decorators.attr(type="smoke")
@decorators.idempotent_id('a22ef352-a342-4587-8f47-3bbdb5b039c4')
@utils.requires_ext(extension='account_quotas', service='object')
def test_upload_valid_object(self):
"""Test uploading valid object"""
object_name = data_utils.rand_name(
prefix=CONF.resource_name_prefix, name="TestObject")
data = data_utils.arbitrary_string()
resp, _ = self.object_client.create_object(self.container_name,
object_name, data)
self.assertHeaders(resp, 'Object', 'PUT')
[docs]
@decorators.attr(type="smoke")
@decorators.idempotent_id('93fd7776-ae41-4949-8d0c-21889804c1ca')
@utils.requires_ext(extension='account_quotas', service='object')
def test_overlimit_upload(self):
"""Test uploading an oversized object raises an OverLimit exception"""
object_name = data_utils.rand_name(
prefix=CONF.resource_name_prefix, name="TestObject")
data = data_utils.arbitrary_string(self.quota_bytes + 1)
nbefore = self._get_bytes_used()
self.assertRaises(lib_exc.OverLimit,
self.object_client.create_object,
self.container_name, object_name, data)
nafter = self._get_bytes_used()
self.assertEqual(nbefore, nafter)
[docs]
@decorators.idempotent_id('aab68903-cc9f-493a-b17e-b387db3e4e44')
@utils.requires_ext(extension='account_quotas', service='object')
def test_storage_policy_quota_limit(self):
"""Verify quota limits are enforced per storage policy"""
policy_names = [p["name"] for p in self.policies]
if 'silver' not in policy_names:
raise self.skipException("Missing storage policy 'silver'")
policy_quota = 10
policy_quota_header = {
"X-Account-Quota-Bytes-Policy-silver": str(policy_quota)
}
self.account_client.auth_provider.set_alt_auth_data(
request_part='headers',
auth_data=self.reselleradmin_auth_data
)
self.os_roles_operator.account_client.request(
"POST", url="", headers=policy_quota_header, body=""
)
# Create a new container using the "silver" storage policy
silver_container = data_utils.rand_name("silver-container")
headers = {'X-Storage-Policy': 'silver'}
self.container_client.create_container(
silver_container, **headers
)
self.addCleanup(object_storage.delete_containers,
[silver_container],
self.container_client,
self.object_client)
# Try uploading an object larger than the quota
large_data = data_utils.arbitrary_string(size=policy_quota + 1)
object_name = data_utils.rand_name(name='large_object')
self.assertRaises(
lib_exc.OverLimit,
self.object_client.create_object,
silver_container,
object_name,
large_data
)
# Upload same large object to default container
default_container = data_utils.rand_name(
"default_container"
)
self.container_client.create_container(default_container)
self.addCleanup(object_storage.delete_containers,
[default_container],
self.container_client,
self.object_client)
default_object = data_utils.rand_name(name='default_object')
resp, _ = self.object_client.create_object(
default_container,
default_object,
large_data
)
self.assertHeaders(resp, 'Object', 'PUT')
[docs]
@decorators.idempotent_id('b1e73f75-6905-4021-9d0b-796cd42ce279')
@utils.requires_ext(extension='account_quotas', service='object')
def test_upload_too_many_objects(self):
"""Test that uploading objects is blocked when the account object
count quota is exceeded.
Skipped if Swift version < 2.34 as the feature is not supported.
"""
self._get_version()
if self.swift_version < api_version_request.APIVersionRequest('2.34'):
raise self.skipException(
'Account object count quota not supported')
self._set_quota(quota_count=0)
# Try uploading one more object to exceed the quota
self.assertRaises(lib_exc.OverLimit,
self.object_client.create_object,
self.container_name, "OverQuotaObject", "")
nafter = self._get_object_count()
self.assertEqual(0, nafter)
[docs]
@decorators.attr(type=["smoke"])
@decorators.idempotent_id('63f51f9f-5f1d-4fc6-b5be-d454d70949d6')
@utils.requires_ext(extension='account_quotas', service='object')
def test_admin_modify_quota(self):
"""Test ResellerAdmin can modify/remove the quota on a user's account
Using the account client, the test modifies the quota
successively to:
* "25": a random value different from the initial quota value.
* "" : an empty value, equivalent to the removal of the quota.
* "20": set the quota to its initial value.
"""
for quota in ("25", "", "20"):
self.account_client.auth_provider.set_alt_auth_data(
request_part='headers',
auth_data=self.reselleradmin_auth_data
)
headers = {"X-Account-Meta-Quota-Bytes": quota}
resp, _ = self.os_roles_operator.account_client.request(
"POST", url="", headers=headers, body="")
self.assertEqual(resp["status"], "204")
self.assertHeaders(resp, 'Account', 'POST')
def _get_account_metadata(self):
resp, _ = self.account_client.list_account_metadata()
return resp
def _get_object_count(self):
resp = self._get_account_metadata()
return int(resp["x-account-object-count"])
def _get_bytes_used(self):
resp = self._get_account_metadata()
return int(resp["x-account-bytes-used"])
