python-manilaclient/manilaclient/v2/quotas.py
Goutham Pacha Ravi c7b1c6a1d3 Refactor code from oslo_incubator
At some point, common code for this project
originated in the oslo_incubator project; and
we performed a final sync of this code in 2014 [1].

However, this sync'ed code was unused; so lets
delete this code and consolidate common code for
ease of use.

[1] https://review.opendev.org/c/openstack/python-manilaclient/+/98088

Change-Id: Ifd9c7516aab8e3c2d017a1ce421d2e65e76d5640
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2022-01-21 19:47:04 +00:00

269 lines
11 KiB
Python

# Copyright 2013 OpenStack Foundation
# All Rights Reserved.
#
# 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 manilaclient import api_versions
from manilaclient import base
RESOURCE_PATH_LEGACY = '/os-quota-sets'
RESOURCE_PATH = '/quota-sets'
REPLICA_QUOTAS_MICROVERSION = "2.53"
class QuotaSet(base.Resource):
@property
def id(self):
"""Needed by Resource to self-refresh and be indexed."""
return self.tenant_id
def update(self, *args, **kwargs):
self.manager.update(self.tenant_id, *args, **kwargs)
class QuotaSetManager(base.ManagerWithFind):
resource_class = QuotaSet
def _check_user_id_and_share_type_args(self, user_id, share_type):
if user_id and share_type:
raise ValueError(
"'user_id' and 'share_type' values are mutually exclusive. "
"one or both should be unset.")
def _do_get(self, tenant_id, user_id=None, share_type=None, detail=False,
resource_path=RESOURCE_PATH):
self._check_user_id_and_share_type_args(user_id, share_type)
if hasattr(tenant_id, 'tenant_id'):
tenant_id = tenant_id.tenant_id
if detail:
query = '/detail'
else:
query = ''
if user_id and share_type:
query = '%s?user_id=%s&share_type=%s' % (
query, user_id, share_type)
elif user_id:
query = '%s?user_id=%s' % (query, user_id)
elif share_type:
query = '%s?share_type=%s' % (query, share_type)
data = {
"resource_path": resource_path,
"tenant_id": tenant_id,
}
url = ("%(resource_path)s/%(tenant_id)s" + query) % data
return self._get(url, "quota_set")
@api_versions.wraps("1.0", "2.6")
def get(self, tenant_id, user_id=None, detail=False):
return self._do_get(tenant_id, user_id,
resource_path=RESOURCE_PATH_LEGACY)
@api_versions.wraps("2.7", "2.24") # noqa
def get(self, tenant_id, user_id=None, detail=False): # noqa
return self._do_get(tenant_id, user_id,
resource_path=RESOURCE_PATH)
@api_versions.wraps("2.25", "2.38") # noqa
def get(self, tenant_id, user_id=None, detail=False): # noqa
return self._do_get(tenant_id, user_id, detail=detail,
resource_path=RESOURCE_PATH)
@api_versions.wraps("2.39") # noqa
def get(self, tenant_id, user_id=None, share_type=None, detail=False): # noqa
return self._do_get(
tenant_id, user_id, share_type=share_type, detail=detail,
resource_path=RESOURCE_PATH)
def _do_update(self, tenant_id, shares=None, snapshots=None,
gigabytes=None, snapshot_gigabytes=None,
share_networks=None,
force=None, user_id=None, share_type=None,
share_groups=None, share_group_snapshots=None,
share_replicas=None, replica_gigabytes=None,
per_share_gigabytes=None,
resource_path=RESOURCE_PATH):
self._check_user_id_and_share_type_args(user_id, share_type)
body = {
'quota_set': {
'tenant_id': tenant_id,
'shares': shares,
'snapshots': snapshots,
'gigabytes': gigabytes,
'snapshot_gigabytes': snapshot_gigabytes,
'share_networks': share_networks,
'share_groups': share_groups,
'share_group_snapshots': share_group_snapshots,
'force': force,
'share_replicas': share_replicas,
'replica_gigabytes': replica_gigabytes,
'per_share_gigabytes': per_share_gigabytes,
},
}
for key in list(body['quota_set']):
if body['quota_set'][key] is None:
body['quota_set'].pop(key)
data = {
"resource_path": resource_path,
"tenant_id": tenant_id,
"user_id": user_id,
"st": share_type,
}
if user_id:
url = '%(resource_path)s/%(tenant_id)s?user_id=%(user_id)s' % data
elif share_type:
url = '%(resource_path)s/%(tenant_id)s?share_type=%(st)s' % data
else:
url = "%(resource_path)s/%(tenant_id)s" % data
return self._update(url, body, 'quota_set')
@api_versions.wraps("1.0", "2.6")
def update(self, tenant_id, shares=None, snapshots=None, gigabytes=None,
snapshot_gigabytes=None, share_networks=None, force=None,
user_id=None):
return self._do_update(
tenant_id, shares, snapshots, gigabytes, snapshot_gigabytes,
share_networks, force, user_id, resource_path=RESOURCE_PATH_LEGACY,
)
@api_versions.wraps("2.7", "2.38") # noqa
def update(self, tenant_id, shares=None, snapshots=None, gigabytes=None, # noqa
snapshot_gigabytes=None, share_networks=None, force=None,
user_id=None):
return self._do_update(
tenant_id, shares, snapshots, gigabytes, snapshot_gigabytes,
share_networks, force, user_id, resource_path=RESOURCE_PATH,
)
def _validate_st_and_sn_in_same_request(self, share_type, share_networks):
if share_type and share_networks:
raise ValueError(
"'share_networks' quota can be set only for project or user, "
"not share type.")
@api_versions.wraps("2.39", "2.39") # noqa
def update(self, tenant_id, user_id=None, share_type=None, # noqa
shares=None, snapshots=None, gigabytes=None,
snapshot_gigabytes=None, share_networks=None, force=None):
self._validate_st_and_sn_in_same_request(share_type, share_networks)
return self._do_update(
tenant_id, shares, snapshots, gigabytes, snapshot_gigabytes,
share_networks, force, user_id,
share_type=share_type,
resource_path=RESOURCE_PATH,
)
@api_versions.wraps("2.40", "2.52") # noqa
def update(self, tenant_id, user_id=None, share_type=None, # noqa
shares=None, snapshots=None, gigabytes=None,
snapshot_gigabytes=None, share_networks=None,
share_groups=None, share_group_snapshots=None,
force=None):
self._validate_st_and_sn_in_same_request(share_type, share_networks)
return self._do_update(
tenant_id, shares, snapshots, gigabytes, snapshot_gigabytes,
share_networks, force, user_id,
share_type=share_type,
share_groups=share_groups,
share_group_snapshots=share_group_snapshots,
resource_path=RESOURCE_PATH,
)
@api_versions.wraps(REPLICA_QUOTAS_MICROVERSION, "2.61") # noqa
def update(self, tenant_id, user_id=None, share_type=None, # noqa
shares=None, snapshots=None, gigabytes=None,
snapshot_gigabytes=None, share_networks=None,
share_groups=None, share_group_snapshots=None,
share_replicas=None, replica_gigabytes=None, force=None):
self._validate_st_and_sn_in_same_request(share_type, share_networks)
return self._do_update(
tenant_id, shares, snapshots, gigabytes, snapshot_gigabytes,
share_networks, force, user_id,
share_type=share_type,
share_groups=share_groups,
share_group_snapshots=share_group_snapshots,
share_replicas=share_replicas,
replica_gigabytes=replica_gigabytes,
resource_path=RESOURCE_PATH
)
@api_versions.wraps("2.62") # noqa
def update(self, tenant_id, user_id=None, share_type=None, # noqa
shares=None, snapshots=None, gigabytes=None,
snapshot_gigabytes=None, share_networks=None,
share_groups=None, share_group_snapshots=None,
share_replicas=None, replica_gigabytes=None, force=None,
per_share_gigabytes=None):
self._validate_st_and_sn_in_same_request(share_type, share_networks)
return self._do_update(
tenant_id, shares, snapshots, gigabytes, snapshot_gigabytes,
share_networks, force, user_id,
share_type=share_type,
share_groups=share_groups,
share_group_snapshots=share_group_snapshots,
share_replicas=share_replicas,
replica_gigabytes=replica_gigabytes,
per_share_gigabytes=per_share_gigabytes,
resource_path=RESOURCE_PATH
)
@api_versions.wraps("1.0", "2.6")
def defaults(self, tenant_id):
return self._get(
"%(resource_path)s/%(tenant_id)s/defaults" % {
"resource_path": RESOURCE_PATH_LEGACY, "tenant_id": tenant_id},
"quota_set")
@api_versions.wraps("2.7") # noqa
def defaults(self, tenant_id): # noqa
return self._get(
"%(resource_path)s/%(tenant_id)s/defaults" % {
"resource_path": RESOURCE_PATH, "tenant_id": tenant_id},
"quota_set")
def _do_delete(self, tenant_id, user_id=None, share_type=None,
resource_path=RESOURCE_PATH):
self._check_user_id_and_share_type_args(user_id, share_type)
data = {
"resource_path": resource_path,
"tenant_id": tenant_id,
"user_id": user_id,
"st": share_type,
}
if user_id:
url = '%(resource_path)s/%(tenant_id)s?user_id=%(user_id)s' % data
elif share_type:
url = '%(resource_path)s/%(tenant_id)s?share_type=%(st)s' % data
else:
url = '%(resource_path)s/%(tenant_id)s' % data
self._delete(url)
@api_versions.wraps("1.0", "2.6")
def delete(self, tenant_id, user_id=None):
return self._do_delete(
tenant_id, user_id, resource_path=RESOURCE_PATH_LEGACY)
@api_versions.wraps("2.7", "2.38") # noqa
def delete(self, tenant_id, user_id=None): # noqa
return self._do_delete(tenant_id, user_id, resource_path=RESOURCE_PATH)
@api_versions.wraps("2.39") # noqa
def delete(self, tenant_id, user_id=None, share_type=None): # noqa
return self._do_delete(
tenant_id, user_id, share_type, resource_path=RESOURCE_PATH)