1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
# Copyright 2016 Clinton Knight
#
# 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.
"""Interface for share group types extension."""
from manilaclient import api_versions
from manilaclient import base
RESOURCES_PATH = '/share-group-types'
RESOURCE_PATH = '/share-group-types/%s'
RESOURCE_PATH_ACTION = '/share-group-types/%s/action'
RESOURCES_NAME = 'share_group_types'
RESOURCE_NAME = 'share_group_type'
GROUP_SPECS_RESOURCES_PATH = '/share-group-types/%s/group-specs'
GROUP_SPECS_RESOURCE_PATH = '/share-group-types/%s/group-specs/%s'
GROUP_SPECS_RESOURCES_NAME = 'group_specs'
SG_GRADUATION_VERSION = "2.55"
class ShareGroupType(base.Resource):
"""A Share Group Type is the type of share group to be created."""
def __init__(self, manager, info, loaded=False):
super(ShareGroupType, self).__init__(manager, info, loaded)
self._group_specs = info.get(GROUP_SPECS_RESOURCES_NAME, {})
def __repr__(self):
return "<Share Group Type: %s>" % self.name
@property
def is_public(self):
"""Provide a user-friendly accessor to share-type-access."""
return self._info.get('is_public', 'N/A')
def get_keys(self, prefer_resource_data=True):
"""Get group specs from a share group type.
:param prefer_resource_data: By default group_specs are retrieved from
resource data, but user can force this method to make an API call
and update the group specs in this object.
:return: dict with group specs
"""
if prefer_resource_data:
return self._group_specs
else:
share_group_type_id = base.getid(self)
url = GROUP_SPECS_RESOURCES_PATH % share_group_type_id
_resp, body = self.manager.api.client.get(url)
self._group_specs = body.get(GROUP_SPECS_RESOURCES_NAME, {})
return self._group_specs
def set_keys(self, group_specs):
"""Set group specs on a share group type.
:param extra_specs: A dict of key/value pairs to be set on this object
:return: dict with group specs
"""
share_group_type_id = base.getid(self)
url = GROUP_SPECS_RESOURCES_PATH % share_group_type_id
body = {GROUP_SPECS_RESOURCES_NAME: group_specs}
return self.manager._create(
url, body, GROUP_SPECS_RESOURCES_NAME, return_raw=True)
def unset_keys(self, keys):
"""Unset group specs on a share group type.
:param keys: A list of keys on this object to be unset
:return: None if successful, else API response on failure
"""
share_group_type_id = base.getid(self)
for k in keys:
url = GROUP_SPECS_RESOURCE_PATH % (share_group_type_id, k)
resp = self.manager._delete(url)
if resp is not None:
return resp
class ShareGroupTypeManager(base.ManagerWithFind):
"""Manage :class:`ShareGroupType` resources."""
resource_class = ShareGroupType
def _create_share_group_type(self, name, share_types, is_public=False,
group_specs=None):
"""Create a share group type.
:param name: Descriptive name of the share group type
:param share_types: list of either instances of ShareType or text
with share type UUIDs
:param is_public: True to create a public share group type
:param group_specs: dict containing group spec key-value pairs
:rtype: :class:`ShareGroupType`
"""
if not share_types:
raise ValueError('At least one share type must be specified when '
'creating a share group type.')
body = {
'name': name,
'is_public': is_public,
'group_specs': group_specs or {},
'share_types': [base.getid(share_type)
for share_type in share_types],
}
return self._create(
RESOURCES_PATH, {RESOURCE_NAME: body}, RESOURCE_NAME)
@api_versions.wraps("2.31", "2.54")
@api_versions.experimental_api
def create(self, name, share_types, is_public=False, group_specs=None):
return self._create_share_group_type(name, share_types, is_public,
group_specs)
@api_versions.wraps(SG_GRADUATION_VERSION) # noqa
def create(self, name, share_types, is_public=False, group_specs=None): # noqa
return self._create_share_group_type(name, share_types, is_public,
group_specs)
def _get_share_group_type(self, share_group_type="default"):
"""Get a specific share group type.
:param share_group_type: either instance of ShareGroupType, or text
with UUID, or 'default'
:rtype: :class:`ShareGroupType`
"""
share_group_type_id = base.getid(share_group_type)
url = RESOURCE_PATH % share_group_type_id
return self._get(url, RESOURCE_NAME)
@api_versions.wraps("2.31", "2.54")
@api_versions.experimental_api
def get(self, share_group_type="default"):
return self._get_share_group_type(share_group_type)
@api_versions.wraps(SG_GRADUATION_VERSION) # noqa
def get(self, share_group_type="default"): # noqa
return self._get_share_group_type(share_group_type)
def _list_share_group_types(self, show_all=True, search_opts=None):
"""Get a list of all share group types.
:rtype: list of :class:`ShareGroupType`.
"""
search_opts = search_opts or {}
if show_all:
search_opts['is_public'] = 'all'
query_string = self._build_query_string(search_opts)
url = RESOURCES_PATH + query_string
return self._list(url, RESOURCES_NAME)
@api_versions.wraps("2.31", "2.54")
@api_versions.experimental_api
def list(self, show_all=True, search_opts=None):
return self._list_share_group_types(show_all, search_opts)
@api_versions.wraps(SG_GRADUATION_VERSION) # noqa
def list(self, show_all=True, search_opts=None): # noqa
return self._list_share_group_types(show_all, search_opts)
def _delete_share_group_type(self, share_group_type):
"""Delete a specific share group type.
:param share_group_type: either instance of ShareGroupType, or text
with UUID
"""
share_group_type_id = base.getid(share_group_type)
url = RESOURCE_PATH % share_group_type_id
self._delete(url)
@api_versions.wraps("2.31", "2.54")
@api_versions.experimental_api
def delete(self, share_group_type):
self._delete_share_group_type(share_group_type)
@api_versions.wraps(SG_GRADUATION_VERSION) # noqa
def delete(self, share_group_type): # noqa
self._delete_share_group_type(share_group_type)
|
