python-manilaclient 5.6.0__py3-none-any.whl → 5.7.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- manilaclient/__init__.py +2 -1
- manilaclient/api_versions.py +136 -79
- manilaclient/base.py +69 -52
- manilaclient/client.py +7 -5
- manilaclient/common/apiclient/exceptions.py +65 -16
- manilaclient/common/apiclient/utils.py +14 -9
- manilaclient/common/cliutils.py +25 -11
- manilaclient/common/constants.py +32 -15
- manilaclient/common/httpclient.py +46 -30
- manilaclient/config.py +250 -165
- manilaclient/exceptions.py +4 -0
- manilaclient/extension.py +1 -1
- manilaclient/osc/plugin.py +43 -32
- manilaclient/osc/utils.py +24 -19
- manilaclient/osc/v2/availability_zones.py +8 -4
- manilaclient/osc/v2/messages.py +71 -41
- manilaclient/osc/v2/quotas.py +181 -115
- manilaclient/osc/v2/resource_locks.py +118 -82
- manilaclient/osc/v2/security_services.py +192 -124
- manilaclient/osc/v2/services.py +50 -33
- manilaclient/osc/v2/share.py +566 -413
- manilaclient/osc/v2/share_access_rules.py +181 -124
- manilaclient/osc/v2/share_backups.py +151 -107
- manilaclient/osc/v2/share_group_snapshots.py +114 -86
- manilaclient/osc/v2/share_group_type_access.py +65 -41
- manilaclient/osc/v2/share_group_types.py +113 -77
- manilaclient/osc/v2/share_groups.py +155 -119
- manilaclient/osc/v2/share_instance_export_locations.py +16 -17
- manilaclient/osc/v2/share_instances.py +62 -42
- manilaclient/osc/v2/share_limits.py +7 -5
- manilaclient/osc/v2/share_network_subnets.py +166 -93
- manilaclient/osc/v2/share_networks.py +304 -186
- manilaclient/osc/v2/share_pools.py +42 -22
- manilaclient/osc/v2/share_replica_export_locations.py +17 -19
- manilaclient/osc/v2/share_replicas.py +157 -110
- manilaclient/osc/v2/share_servers.py +244 -166
- manilaclient/osc/v2/share_snapshot_instance_export_locations.py +22 -15
- manilaclient/osc/v2/share_snapshot_instances.py +60 -33
- manilaclient/osc/v2/share_snapshots.py +303 -241
- manilaclient/osc/v2/share_transfers.py +107 -66
- manilaclient/osc/v2/share_type_access.py +27 -18
- manilaclient/osc/v2/share_types.py +163 -105
- manilaclient/shell.py +408 -333
- manilaclient/tests/functional/base.py +210 -99
- manilaclient/tests/functional/client.py +848 -584
- manilaclient/tests/functional/exceptions.py +8 -5
- manilaclient/tests/functional/osc/base.py +211 -122
- manilaclient/tests/functional/osc/test_availability_zones.py +1 -7
- manilaclient/tests/functional/osc/test_messages.py +58 -44
- manilaclient/tests/functional/osc/test_resource_locks.py +95 -71
- manilaclient/tests/functional/osc/test_share_access_rules.py +87 -69
- manilaclient/tests/functional/osc/test_share_backups.py +61 -57
- manilaclient/tests/functional/osc/test_share_group_type_access.py +30 -16
- manilaclient/tests/functional/osc/test_share_instance_export_locations.py +23 -0
- manilaclient/tests/functional/osc/test_share_instances.py +101 -0
- manilaclient/tests/functional/osc/test_share_limits.py +17 -19
- manilaclient/tests/functional/osc/test_share_network_subnets.py +3 -4
- manilaclient/tests/functional/osc/test_share_networks.py +46 -33
- manilaclient/tests/functional/osc/test_share_pools.py +9 -17
- manilaclient/tests/functional/osc/test_share_replica_export_locations.py +26 -19
- manilaclient/tests/functional/osc/test_share_replicas.py +23 -18
- manilaclient/tests/functional/osc/test_share_services.py +25 -23
- manilaclient/tests/functional/osc/test_share_snapshot_instances.py +47 -34
- manilaclient/tests/functional/osc/test_share_snapshots.py +80 -78
- manilaclient/tests/functional/osc/test_share_transfers.py +45 -25
- manilaclient/tests/functional/osc/test_share_types.py +48 -51
- manilaclient/tests/functional/osc/test_shares.py +61 -45
- manilaclient/tests/functional/osc/test_shares_group_type.py +62 -51
- manilaclient/tests/functional/test_availability_zones.py +2 -2
- manilaclient/tests/functional/test_common.py +16 -6
- manilaclient/tests/functional/test_export_locations.py +34 -23
- manilaclient/tests/functional/test_limits.py +0 -1
- manilaclient/tests/functional/test_messages.py +17 -7
- manilaclient/tests/functional/test_quotas.py +141 -76
- manilaclient/tests/functional/test_scheduler_stats.py +8 -8
- manilaclient/tests/functional/test_security_services.py +1 -2
- manilaclient/tests/functional/test_services.py +0 -1
- manilaclient/tests/functional/test_share_access.py +138 -77
- manilaclient/tests/functional/test_share_network_subnets.py +27 -17
- manilaclient/tests/functional/test_share_networks.py +231 -123
- manilaclient/tests/functional/test_share_replica_export_locations.py +39 -19
- manilaclient/tests/functional/test_share_replicas.py +6 -4
- manilaclient/tests/functional/test_share_servers.py +102 -61
- manilaclient/tests/functional/test_share_transfers.py +13 -8
- manilaclient/tests/functional/test_share_types.py +243 -130
- manilaclient/tests/functional/test_shares.py +90 -57
- manilaclient/tests/functional/test_shares_listing.py +105 -61
- manilaclient/tests/functional/test_shares_metadata.py +17 -17
- manilaclient/tests/functional/test_snapshot_access.py +103 -66
- manilaclient/tests/functional/test_snapshot_instances.py +50 -29
- manilaclient/tests/functional/test_snapshot_instances_export_locations.py +39 -25
- manilaclient/tests/functional/test_snapshots_export_locations.py +23 -17
- manilaclient/tests/functional/utils.py +50 -25
- manilaclient/tests/unit/common/test_httpclient.py +75 -51
- manilaclient/tests/unit/fakes.py +18 -14
- manilaclient/tests/unit/osc/osc_fakes.py +20 -24
- manilaclient/tests/unit/osc/osc_utils.py +10 -7
- manilaclient/tests/unit/osc/v2/fakes.py +183 -201
- manilaclient/tests/unit/osc/v2/test_availability_zones.py +9 -9
- manilaclient/tests/unit/osc/v2/test_messages.py +52 -64
- manilaclient/tests/unit/osc/v2/test_quotas.py +99 -160
- manilaclient/tests/unit/osc/v2/test_resource_locks.py +80 -82
- manilaclient/tests/unit/osc/v2/test_security_services.py +205 -132
- manilaclient/tests/unit/osc/v2/test_services.py +77 -69
- manilaclient/tests/unit/osc/v2/test_share.py +527 -592
- manilaclient/tests/unit/osc/v2/test_share_access_rules.py +104 -155
- manilaclient/tests/unit/osc/v2/test_share_backups.py +124 -159
- manilaclient/tests/unit/osc/v2/test_share_group_snapshots.py +167 -214
- manilaclient/tests/unit/osc/v2/test_share_group_type.py +144 -131
- manilaclient/tests/unit/osc/v2/test_share_group_type_access.py +33 -46
- manilaclient/tests/unit/osc/v2/test_share_groups.py +172 -253
- manilaclient/tests/unit/osc/v2/test_share_instance_export_locations.py +37 -45
- manilaclient/tests/unit/osc/v2/test_share_instances.py +88 -117
- manilaclient/tests/unit/osc/v2/test_share_limits.py +14 -22
- manilaclient/tests/unit/osc/v2/test_share_network_subnets.py +265 -100
- manilaclient/tests/unit/osc/v2/test_share_networks.py +374 -218
- manilaclient/tests/unit/osc/v2/test_share_pools.py +37 -37
- manilaclient/tests/unit/osc/v2/test_share_replica_export_locations.py +30 -43
- manilaclient/tests/unit/osc/v2/test_share_replicas.py +171 -254
- manilaclient/tests/unit/osc/v2/test_share_servers.py +258 -253
- manilaclient/tests/unit/osc/v2/test_share_snapshot_instance_export_locations.py +66 -56
- manilaclient/tests/unit/osc/v2/test_share_snapshot_instances.py +90 -77
- manilaclient/tests/unit/osc/v2/test_share_snapshots.py +330 -432
- manilaclient/tests/unit/osc/v2/test_share_transfers.py +77 -93
- manilaclient/tests/unit/osc/v2/test_share_type.py +146 -176
- manilaclient/tests/unit/osc/v2/test_share_type_access.py +35 -51
- manilaclient/tests/unit/test_api_versions.py +91 -70
- manilaclient/tests/unit/test_base.py +5 -5
- manilaclient/tests/unit/test_client.py +25 -19
- manilaclient/tests/unit/test_functional_utils.py +105 -72
- manilaclient/tests/unit/test_shell.py +187 -100
- manilaclient/tests/unit/utils.py +14 -8
- manilaclient/tests/unit/v1/test_limits.py +5 -4
- manilaclient/tests/unit/v1/test_quota_classes.py +5 -4
- manilaclient/tests/unit/v1/test_quotas.py +5 -4
- manilaclient/tests/unit/v1/test_scheduler_stats.py +5 -4
- manilaclient/tests/unit/v1/test_security_services.py +5 -4
- manilaclient/tests/unit/v1/test_services.py +5 -4
- manilaclient/tests/unit/v1/test_share_networks.py +5 -4
- manilaclient/tests/unit/v1/test_share_servers.py +5 -4
- manilaclient/tests/unit/v1/test_share_snapshots.py +5 -4
- manilaclient/tests/unit/v1/test_share_type_access.py +5 -4
- manilaclient/tests/unit/v1/test_share_types.py +5 -4
- manilaclient/tests/unit/v1/test_shares.py +5 -4
- manilaclient/tests/unit/v2/fake_clients.py +34 -26
- manilaclient/tests/unit/v2/fakes.py +358 -228
- manilaclient/tests/unit/v2/test_availability_zones.py +7 -5
- manilaclient/tests/unit/v2/test_client.py +137 -54
- manilaclient/tests/unit/v2/test_limits.py +62 -38
- manilaclient/tests/unit/v2/test_messages.py +43 -27
- manilaclient/tests/unit/v2/test_quota_classes.py +22 -13
- manilaclient/tests/unit/v2/test_quotas.py +113 -75
- manilaclient/tests/unit/v2/test_scheduler_stats.py +13 -12
- manilaclient/tests/unit/v2/test_security_services.py +70 -48
- manilaclient/tests/unit/v2/test_services.py +12 -12
- manilaclient/tests/unit/v2/test_share_backups.py +23 -16
- manilaclient/tests/unit/v2/test_share_export_locations.py +5 -10
- manilaclient/tests/unit/v2/test_share_group_snapshots.py +94 -52
- manilaclient/tests/unit/v2/test_share_group_type_access.py +32 -19
- manilaclient/tests/unit/v2/test_share_group_types.py +68 -37
- manilaclient/tests/unit/v2/test_share_groups.py +73 -41
- manilaclient/tests/unit/v2/test_share_instance_export_locations.py +14 -9
- manilaclient/tests/unit/v2/test_share_instances.py +27 -20
- manilaclient/tests/unit/v2/test_share_network_subnets.py +17 -15
- manilaclient/tests/unit/v2/test_share_networks.py +82 -78
- manilaclient/tests/unit/v2/test_share_replica_export_locations.py +7 -5
- manilaclient/tests/unit/v2/test_share_replicas.py +32 -19
- manilaclient/tests/unit/v2/test_share_servers.py +115 -70
- manilaclient/tests/unit/v2/test_share_snapshot_export_locations.py +6 -8
- manilaclient/tests/unit/v2/test_share_snapshot_instance_export_locations.py +16 -9
- manilaclient/tests/unit/v2/test_share_snapshot_instances.py +15 -9
- manilaclient/tests/unit/v2/test_share_snapshots.py +70 -49
- manilaclient/tests/unit/v2/test_share_transfers.py +9 -9
- manilaclient/tests/unit/v2/test_shares.py +440 -229
- manilaclient/tests/unit/v2/test_shell.py +1999 -1315
- manilaclient/tests/unit/v2/test_type_access.py +19 -14
- manilaclient/tests/unit/v2/test_types.py +203 -117
- manilaclient/utils.py +3 -2
- manilaclient/v1/__init__.py +1 -1
- manilaclient/v1/client.py +75 -48
- manilaclient/v1/contrib/list_extensions.py +5 -3
- manilaclient/v1/limits.py +7 -5
- manilaclient/v1/quota_classes.py +7 -5
- manilaclient/v1/quotas.py +7 -5
- manilaclient/v1/scheduler_stats.py +7 -5
- manilaclient/v1/security_services.py +10 -7
- manilaclient/v1/services.py +7 -5
- manilaclient/v1/share_networks.py +7 -5
- manilaclient/v1/share_servers.py +7 -5
- manilaclient/v1/share_snapshots.py +7 -5
- manilaclient/v1/share_type_access.py +10 -7
- manilaclient/v1/share_types.py +7 -5
- manilaclient/v1/shares.py +7 -5
- manilaclient/v2/__init__.py +1 -1
- manilaclient/v2/availability_zones.py +2 -2
- manilaclient/v2/client.py +102 -60
- manilaclient/v2/limits.py +26 -19
- manilaclient/v2/messages.py +12 -5
- manilaclient/v2/quota_classes.py +121 -56
- manilaclient/v2/quotas.py +236 -95
- manilaclient/v2/resource_locks.py +25 -14
- manilaclient/v2/scheduler_stats.py +4 -10
- manilaclient/v2/security_services.py +127 -46
- manilaclient/v2/services.py +15 -11
- manilaclient/v2/share_access_rules.py +3 -7
- manilaclient/v2/share_backups.py +19 -13
- manilaclient/v2/share_export_locations.py +16 -14
- manilaclient/v2/share_group_snapshots.py +50 -26
- manilaclient/v2/share_group_type_access.py +11 -7
- manilaclient/v2/share_group_types.py +23 -14
- manilaclient/v2/share_groups.py +85 -34
- manilaclient/v2/share_instance_export_locations.py +11 -9
- manilaclient/v2/share_instances.py +6 -4
- manilaclient/v2/share_network_subnets.py +57 -33
- manilaclient/v2/share_networks.py +82 -41
- manilaclient/v2/share_replica_export_locations.py +18 -13
- manilaclient/v2/share_replicas.py +34 -17
- manilaclient/v2/share_servers.py +83 -38
- manilaclient/v2/share_snapshot_export_locations.py +11 -7
- manilaclient/v2/share_snapshot_instance_export_locations.py +11 -7
- manilaclient/v2/share_snapshot_instances.py +7 -6
- manilaclient/v2/share_snapshots.py +59 -33
- manilaclient/v2/share_transfers.py +26 -16
- manilaclient/v2/share_type_access.py +5 -6
- manilaclient/v2/share_types.py +105 -55
- manilaclient/v2/shares.py +348 -141
- manilaclient/v2/shell.py +2331 -1506
- {python_manilaclient-5.6.0.dist-info → python_manilaclient-5.7.1.dist-info}/METADATA +23 -22
- python_manilaclient-5.7.1.dist-info/RECORD +253 -0
- {python_manilaclient-5.6.0.dist-info → python_manilaclient-5.7.1.dist-info}/WHEEL +1 -1
- {python_manilaclient-5.6.0.dist-info → python_manilaclient-5.7.1.dist-info/licenses}/AUTHORS +5 -0
- python_manilaclient-5.7.1.dist-info/pbr.json +1 -0
- python_manilaclient-5.6.0.dist-info/RECORD +0 -251
- python_manilaclient-5.6.0.dist-info/pbr.json +0 -1
- {python_manilaclient-5.6.0.dist-info → python_manilaclient-5.7.1.dist-info}/entry_points.txt +0 -0
- {python_manilaclient-5.6.0.dist-info → python_manilaclient-5.7.1.dist-info/licenses}/LICENSE +0 -0
- {python_manilaclient-5.6.0.dist-info → python_manilaclient-5.7.1.dist-info}/top_level.txt +0 -0
manilaclient/__init__.py
CHANGED
|
@@ -32,4 +32,5 @@ except AttributeError:
|
|
|
32
32
|
API_MAX_VERSION = api_versions.APIVersion(api_versions.MAX_VERSION)
|
|
33
33
|
API_MIN_VERSION = api_versions.APIVersion(api_versions.MIN_VERSION)
|
|
34
34
|
API_DEPRECATED_VERSION = api_versions.APIVersion(
|
|
35
|
-
api_versions.DEPRECATED_VERSION
|
|
35
|
+
api_versions.DEPRECATED_VERSION
|
|
36
|
+
)
|
manilaclient/api_versions.py
CHANGED
|
@@ -33,7 +33,7 @@ DEPRECATED_VERSION = '1.0'
|
|
|
33
33
|
_VERSIONED_METHOD_MAP = {}
|
|
34
34
|
|
|
35
35
|
|
|
36
|
-
class APIVersion
|
|
36
|
+
class APIVersion:
|
|
37
37
|
"""Top level object to support Manila API Versioning.
|
|
38
38
|
|
|
39
39
|
This class represents an API Version with convenience
|
|
@@ -54,44 +54,57 @@ class APIVersion(object):
|
|
|
54
54
|
self.ver_major = int(match.group(1))
|
|
55
55
|
self.ver_minor = int(match.group(2))
|
|
56
56
|
else:
|
|
57
|
-
msg =
|
|
57
|
+
msg = (
|
|
58
|
+
_(
|
|
59
|
+
"Invalid format of client version '%s'. "
|
|
58
60
|
"Expected format 'X.Y', where X is a major part and Y "
|
|
59
|
-
"is a minor part of version."
|
|
61
|
+
"is a minor part of version."
|
|
62
|
+
)
|
|
63
|
+
% version_str
|
|
64
|
+
)
|
|
60
65
|
raise exceptions.UnsupportedVersion(msg)
|
|
61
66
|
|
|
62
67
|
def __str__(self):
|
|
63
68
|
"""Debug/Logging representation of object."""
|
|
64
|
-
return
|
|
65
|
-
% (self.ver_major, self.ver_minor))
|
|
69
|
+
return f"API Version Major: {self.ver_major}, Minor: {self.ver_minor}"
|
|
66
70
|
|
|
67
71
|
def __repr__(self):
|
|
68
72
|
if self.is_null():
|
|
69
73
|
return "<APIVersion: null>"
|
|
70
74
|
else:
|
|
71
|
-
return "<APIVersion:
|
|
75
|
+
return f"<APIVersion: {self.get_string()}>"
|
|
72
76
|
|
|
73
77
|
def __lt__(self, other):
|
|
74
78
|
if not isinstance(other, APIVersion):
|
|
75
|
-
raise TypeError(
|
|
76
|
-
|
|
79
|
+
raise TypeError(
|
|
80
|
+
self.TYPE_ERROR_MSG % {"other": other, "cls": self.__class__}
|
|
81
|
+
)
|
|
77
82
|
|
|
78
|
-
return (
|
|
79
|
-
|
|
83
|
+
return (self.ver_major, self.ver_minor) < (
|
|
84
|
+
other.ver_major,
|
|
85
|
+
other.ver_minor,
|
|
86
|
+
)
|
|
80
87
|
|
|
81
88
|
def __eq__(self, other):
|
|
82
89
|
if not isinstance(other, APIVersion):
|
|
83
|
-
raise TypeError(
|
|
84
|
-
|
|
90
|
+
raise TypeError(
|
|
91
|
+
self.TYPE_ERROR_MSG % {"other": other, "cls": self.__class__}
|
|
92
|
+
)
|
|
85
93
|
|
|
86
|
-
return (
|
|
87
|
-
|
|
94
|
+
return (self.ver_major, self.ver_minor) == (
|
|
95
|
+
other.ver_major,
|
|
96
|
+
other.ver_minor,
|
|
97
|
+
)
|
|
88
98
|
|
|
89
99
|
def __gt__(self, other):
|
|
90
100
|
if not isinstance(other, APIVersion):
|
|
91
|
-
raise TypeError(
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
101
|
+
raise TypeError(
|
|
102
|
+
self.TYPE_ERROR_MSG % {"other": other, "cls": self.__class__}
|
|
103
|
+
)
|
|
104
|
+
return (self.ver_major, self.ver_minor) > (
|
|
105
|
+
other.ver_major,
|
|
106
|
+
other.ver_minor,
|
|
107
|
+
)
|
|
95
108
|
|
|
96
109
|
def __le__(self, other):
|
|
97
110
|
return self < other or self == other
|
|
@@ -139,15 +152,15 @@ class APIVersion(object):
|
|
|
139
152
|
"""String representation of an APIVersion object."""
|
|
140
153
|
if self.is_null():
|
|
141
154
|
raise ValueError(
|
|
142
|
-
_("Null APIVersion cannot be converted to string.")
|
|
143
|
-
|
|
155
|
+
_("Null APIVersion cannot be converted to string.")
|
|
156
|
+
)
|
|
157
|
+
return f"{self.ver_major}.{self.ver_minor}"
|
|
144
158
|
|
|
145
159
|
def get_major_version(self):
|
|
146
|
-
return "
|
|
160
|
+
return f"{self.ver_major}"
|
|
147
161
|
|
|
148
162
|
|
|
149
|
-
class VersionedMethod
|
|
150
|
-
|
|
163
|
+
class VersionedMethod:
|
|
151
164
|
def __init__(self, name, start_version, end_version, func):
|
|
152
165
|
"""Versioning information for a single method
|
|
153
166
|
|
|
@@ -164,11 +177,13 @@ class VersionedMethod(object):
|
|
|
164
177
|
self.func = func
|
|
165
178
|
|
|
166
179
|
def __str__(self):
|
|
167
|
-
return (
|
|
168
|
-
|
|
180
|
+
return (
|
|
181
|
+
f"Version Method {self.name}: min: {self.start_version}, "
|
|
182
|
+
f"max: {self.end_version}"
|
|
183
|
+
)
|
|
169
184
|
|
|
170
185
|
def __repr__(self):
|
|
171
|
-
return "<VersionedMethod
|
|
186
|
+
return f"<VersionedMethod {self.name}>"
|
|
172
187
|
|
|
173
188
|
|
|
174
189
|
def check_version_supported(api_version):
|
|
@@ -176,23 +191,27 @@ def check_version_supported(api_version):
|
|
|
176
191
|
|
|
177
192
|
:warn Sends warning if version is not supported.
|
|
178
193
|
"""
|
|
179
|
-
if
|
|
180
|
-
|
|
194
|
+
if check_version_matches_min_max(api_version) or check_version_deprecated(
|
|
195
|
+
api_version
|
|
196
|
+
):
|
|
181
197
|
return True
|
|
182
198
|
return False
|
|
183
199
|
|
|
184
200
|
|
|
185
201
|
def check_version_matches_min_max(api_version):
|
|
186
202
|
"""Returns True if the API version is within the supported range."""
|
|
187
|
-
if
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
msg = _(
|
|
191
|
-
|
|
192
|
-
|
|
203
|
+
if not api_version.matches(
|
|
204
|
+
manilaclient.API_MIN_VERSION, manilaclient.API_MAX_VERSION
|
|
205
|
+
):
|
|
206
|
+
msg = _(
|
|
207
|
+
"Invalid client version '%(version)s'. "
|
|
208
|
+
"Current version range is '%(min)s' through "
|
|
209
|
+
" '%(max)s'"
|
|
210
|
+
) % {
|
|
193
211
|
"version": api_version.get_string(),
|
|
194
212
|
"min": manilaclient.API_MIN_VERSION.get_string(),
|
|
195
|
-
"max": manilaclient.API_MAX_VERSION.get_string()
|
|
213
|
+
"max": manilaclient.API_MAX_VERSION.get_string(),
|
|
214
|
+
}
|
|
196
215
|
warnings.warn(msg)
|
|
197
216
|
return False
|
|
198
217
|
return True
|
|
@@ -202,7 +221,8 @@ def check_version_deprecated(api_version):
|
|
|
202
221
|
"""Returns True if API version is deprecated."""
|
|
203
222
|
if api_version == manilaclient.API_DEPRECATED_VERSION:
|
|
204
223
|
msg = _("Client version '%(version)s' is deprecated.") % {
|
|
205
|
-
"version": api_version.get_string()
|
|
224
|
+
"version": api_version.get_string()
|
|
225
|
+
}
|
|
206
226
|
warnings.warn(msg)
|
|
207
227
|
return True
|
|
208
228
|
return False
|
|
@@ -249,27 +269,29 @@ def discover_version(client, requested_version):
|
|
|
249
269
|
:returns: APIVersion
|
|
250
270
|
"""
|
|
251
271
|
server_start_version, server_end_version = _get_server_version_range(
|
|
252
|
-
client
|
|
272
|
+
client
|
|
273
|
+
)
|
|
253
274
|
|
|
254
275
|
valid_version = requested_version
|
|
255
276
|
if server_start_version.is_null() and server_end_version.is_null():
|
|
256
|
-
msg = (
|
|
257
|
-
|
|
277
|
+
msg = (
|
|
278
|
+
"Server does not support microversions. Changing server "
|
|
279
|
+
"version to %(min_version)s."
|
|
280
|
+
)
|
|
258
281
|
LOG.debug(msg, {"min_version": DEPRECATED_VERSION})
|
|
259
282
|
valid_version = APIVersion(DEPRECATED_VERSION)
|
|
260
283
|
else:
|
|
261
284
|
valid_version = _validate_requested_version(
|
|
262
|
-
requested_version,
|
|
263
|
-
|
|
264
|
-
server_end_version)
|
|
285
|
+
requested_version, server_start_version, server_end_version
|
|
286
|
+
)
|
|
265
287
|
|
|
266
288
|
_validate_server_version(server_start_version, server_end_version)
|
|
267
289
|
return valid_version
|
|
268
290
|
|
|
269
291
|
|
|
270
|
-
def _validate_requested_version(
|
|
271
|
-
|
|
272
|
-
|
|
292
|
+
def _validate_requested_version(
|
|
293
|
+
requested_version, server_start_version, server_end_version
|
|
294
|
+
):
|
|
273
295
|
"""Validates the requested version.
|
|
274
296
|
|
|
275
297
|
Checks 'requested_version' is within the min/max range supported by the
|
|
@@ -284,21 +306,34 @@ def _validate_requested_version(requested_version,
|
|
|
284
306
|
valid_version = requested_version
|
|
285
307
|
if not requested_version.matches(server_start_version, server_end_version):
|
|
286
308
|
if server_end_version <= requested_version:
|
|
287
|
-
if (
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
"
|
|
294
|
-
"
|
|
309
|
+
if (
|
|
310
|
+
manilaclient.API_MIN_VERSION <= server_end_version
|
|
311
|
+
and server_end_version <= manilaclient.API_MAX_VERSION
|
|
312
|
+
):
|
|
313
|
+
msg = _(
|
|
314
|
+
"Requested version %(requested_version)s is "
|
|
315
|
+
"not supported. Downgrading requested version "
|
|
316
|
+
"to %(server_end_version)s."
|
|
317
|
+
)
|
|
318
|
+
LOG.debug(
|
|
319
|
+
msg,
|
|
320
|
+
{
|
|
321
|
+
"requested_version": requested_version,
|
|
322
|
+
"server_end_version": server_end_version,
|
|
323
|
+
},
|
|
324
|
+
)
|
|
295
325
|
valid_version = server_end_version
|
|
296
326
|
else:
|
|
297
327
|
raise exceptions.UnsupportedVersion(
|
|
298
|
-
_(
|
|
299
|
-
|
|
328
|
+
_(
|
|
329
|
+
"The specified version isn't supported by server. "
|
|
330
|
+
"The valid version range is '%(min)s' to '%(max)s'"
|
|
331
|
+
)
|
|
332
|
+
% {
|
|
300
333
|
"min": server_start_version.get_string(),
|
|
301
|
-
"max": server_end_version.get_string()
|
|
334
|
+
"max": server_end_version.get_string(),
|
|
335
|
+
}
|
|
336
|
+
)
|
|
302
337
|
|
|
303
338
|
return valid_version
|
|
304
339
|
|
|
@@ -316,22 +351,34 @@ def _validate_server_version(server_start_version, server_end_version):
|
|
|
316
351
|
"""
|
|
317
352
|
if manilaclient.API_MIN_VERSION > server_end_version:
|
|
318
353
|
raise exceptions.UnsupportedVersion(
|
|
319
|
-
_(
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
354
|
+
_(
|
|
355
|
+
"Server's version is too old. "
|
|
356
|
+
"The client's valid version range "
|
|
357
|
+
"is '%(client_min)s' to '%(client_max)s'. The server valid "
|
|
358
|
+
"version range is '%(server_min)s' to '%(server_max)s'."
|
|
359
|
+
)
|
|
360
|
+
% {
|
|
361
|
+
'client_min': manilaclient.API_MIN_VERSION.get_string(),
|
|
362
|
+
'client_max': manilaclient.API_MAX_VERSION.get_string(),
|
|
363
|
+
'server_min': server_start_version.get_string(),
|
|
364
|
+
'server_max': server_end_version.get_string(),
|
|
365
|
+
}
|
|
366
|
+
)
|
|
326
367
|
elif manilaclient.API_MAX_VERSION < server_start_version:
|
|
327
368
|
raise exceptions.UnsupportedVersion(
|
|
328
|
-
_(
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
369
|
+
_(
|
|
370
|
+
"Server's version is too new. "
|
|
371
|
+
"The client's valid version range "
|
|
372
|
+
"is '%(client_min)s' to '%(client_max)s'. The server valid "
|
|
373
|
+
"version range is '%(server_min)s' to '%(server_max)s'."
|
|
374
|
+
)
|
|
375
|
+
% {
|
|
376
|
+
'client_min': manilaclient.API_MIN_VERSION.get_string(),
|
|
377
|
+
'client_max': manilaclient.API_MAX_VERSION.get_string(),
|
|
378
|
+
'server_min': server_start_version.get_string(),
|
|
379
|
+
'server_max': server_end_version.get_string(),
|
|
380
|
+
}
|
|
381
|
+
)
|
|
335
382
|
|
|
336
383
|
|
|
337
384
|
def add_versioned_method(versioned_method):
|
|
@@ -342,8 +389,11 @@ def add_versioned_method(versioned_method):
|
|
|
342
389
|
def get_versioned_methods(func_name, api_version=None):
|
|
343
390
|
versioned_methods = _VERSIONED_METHOD_MAP.get(func_name, [])
|
|
344
391
|
if api_version and not api_version.is_null():
|
|
345
|
-
return [
|
|
346
|
-
|
|
392
|
+
return [
|
|
393
|
+
m
|
|
394
|
+
for m in versioned_methods
|
|
395
|
+
if api_version.matches(m.start_version, m.end_version)
|
|
396
|
+
]
|
|
347
397
|
return versioned_methods
|
|
348
398
|
|
|
349
399
|
|
|
@@ -353,11 +403,13 @@ def experimental_api(f):
|
|
|
353
403
|
@functools.wraps(f)
|
|
354
404
|
def _wrapper(*args, **kwargs):
|
|
355
405
|
client = args[0]
|
|
356
|
-
if
|
|
357
|
-
|
|
406
|
+
if isinstance(client, manilaclient.v2.client.Client) or hasattr(
|
|
407
|
+
client, 'client'
|
|
408
|
+
):
|
|
358
409
|
dh = client.client.default_headers
|
|
359
410
|
dh[constants.EXPERIMENTAL_HTTP_HEADER] = 'true'
|
|
360
411
|
return f(*args, **kwargs)
|
|
412
|
+
|
|
361
413
|
return _wrapper
|
|
362
414
|
|
|
363
415
|
|
|
@@ -378,8 +430,9 @@ def wraps(start_version, end_version=MAX_VERSION):
|
|
|
378
430
|
def decor(func):
|
|
379
431
|
func.versioned = True
|
|
380
432
|
name = utils.get_function_name(func)
|
|
381
|
-
versioned_method = VersionedMethod(
|
|
382
|
-
|
|
433
|
+
versioned_method = VersionedMethod(
|
|
434
|
+
name, start_version, end_version, func
|
|
435
|
+
)
|
|
383
436
|
add_versioned_method(versioned_method)
|
|
384
437
|
|
|
385
438
|
@functools.wraps(func)
|
|
@@ -388,11 +441,15 @@ def wraps(start_version, end_version=MAX_VERSION):
|
|
|
388
441
|
|
|
389
442
|
if not methods:
|
|
390
443
|
raise exceptions.UnsupportedVersion(
|
|
391
|
-
_(
|
|
392
|
-
|
|
444
|
+
_(
|
|
445
|
+
"API version '%(version)s' is not supported on "
|
|
446
|
+
"'%(method)s' method."
|
|
447
|
+
)
|
|
448
|
+
% {
|
|
393
449
|
"version": obj.api_version.get_string(),
|
|
394
450
|
"method": name,
|
|
395
|
-
}
|
|
451
|
+
}
|
|
452
|
+
)
|
|
396
453
|
|
|
397
454
|
method = max(methods, key=lambda f: f.start_version)
|
|
398
455
|
|
manilaclient/base.py
CHANGED
|
@@ -25,6 +25,8 @@ import copy
|
|
|
25
25
|
import hashlib
|
|
26
26
|
import os
|
|
27
27
|
|
|
28
|
+
from oslo_utils import strutils
|
|
29
|
+
|
|
28
30
|
from manilaclient import api_versions
|
|
29
31
|
from manilaclient.common import cliutils
|
|
30
32
|
from manilaclient import exceptions
|
|
@@ -54,6 +56,7 @@ class Manager(utils.HookableMixin):
|
|
|
54
56
|
Managers interact with a particular type of API (shares, snapshots,
|
|
55
57
|
etc.) and provide CRUD operations for them.
|
|
56
58
|
"""
|
|
59
|
+
|
|
57
60
|
resource_class = None
|
|
58
61
|
|
|
59
62
|
def __init__(self, api):
|
|
@@ -64,8 +67,9 @@ class Manager(utils.HookableMixin):
|
|
|
64
67
|
def api_version(self):
|
|
65
68
|
return self.api.api_version
|
|
66
69
|
|
|
67
|
-
def _list(
|
|
68
|
-
|
|
70
|
+
def _list(
|
|
71
|
+
self, url, response_key, manager=None, body=None, return_raw=None
|
|
72
|
+
):
|
|
69
73
|
"""List the collection.
|
|
70
74
|
|
|
71
75
|
:param url: a partial URL, e.g., '/shares'
|
|
@@ -100,8 +104,9 @@ class Manager(utils.HookableMixin):
|
|
|
100
104
|
with self.completion_cache('uuid', obj_class, mode="w"):
|
|
101
105
|
if return_raw:
|
|
102
106
|
return data
|
|
103
|
-
resource = [
|
|
104
|
-
|
|
107
|
+
resource = [
|
|
108
|
+
obj_class(manager, res, loaded=True) for res in data if res
|
|
109
|
+
]
|
|
105
110
|
if 'count' in body:
|
|
106
111
|
return resource, body['count']
|
|
107
112
|
else:
|
|
@@ -121,16 +126,19 @@ class Manager(utils.HookableMixin):
|
|
|
121
126
|
Delete is not handled because listings are assumed to be performed
|
|
122
127
|
often enough to keep the cache reasonably up-to-date.
|
|
123
128
|
"""
|
|
124
|
-
base_dir = cliutils.env(
|
|
125
|
-
|
|
126
|
-
|
|
129
|
+
base_dir = cliutils.env(
|
|
130
|
+
'manilaclient_UUID_CACHE_DIR',
|
|
131
|
+
'MANILACLIENT_UUID_CACHE_DIR',
|
|
132
|
+
default="~/.cache/manilaclient",
|
|
133
|
+
)
|
|
127
134
|
|
|
128
135
|
# NOTE(sirp): Keep separate UUID caches for each username + endpoint
|
|
129
136
|
# pair
|
|
130
137
|
username = cliutils.env('OS_USERNAME', 'MANILA_USERNAME')
|
|
131
138
|
url = cliutils.env('OS_URL', 'MANILA_URL')
|
|
132
|
-
uniqifier = hashlib.sha256(
|
|
133
|
-
|
|
139
|
+
uniqifier = hashlib.sha256(
|
|
140
|
+
username.encode('utf-8') + url.encode('utf-8')
|
|
141
|
+
).hexdigest()
|
|
134
142
|
|
|
135
143
|
cache_dir = os.path.expanduser(os.path.join(base_dir, uniqifier))
|
|
136
144
|
|
|
@@ -143,14 +151,14 @@ class Manager(utils.HookableMixin):
|
|
|
143
151
|
pass
|
|
144
152
|
|
|
145
153
|
resource = obj_class.__name__.lower()
|
|
146
|
-
filename = "
|
|
154
|
+
filename = "{}-{}-cache".format(resource, cache_type.replace('_', '-'))
|
|
147
155
|
path = os.path.join(cache_dir, filename)
|
|
148
156
|
|
|
149
|
-
cache_attr = "_
|
|
157
|
+
cache_attr = f"_{cache_type}_cache"
|
|
150
158
|
|
|
151
159
|
try:
|
|
152
160
|
setattr(self, cache_attr, open(path, mode))
|
|
153
|
-
except
|
|
161
|
+
except OSError:
|
|
154
162
|
# NOTE(kiall): This is typically a permission denied while
|
|
155
163
|
# attempting to write the cache file.
|
|
156
164
|
pass
|
|
@@ -164,10 +172,10 @@ class Manager(utils.HookableMixin):
|
|
|
164
172
|
delattr(self, cache_attr)
|
|
165
173
|
|
|
166
174
|
def write_to_completion_cache(self, cache_type, val):
|
|
167
|
-
cache = getattr(self, "_
|
|
175
|
+
cache = getattr(self, f"_{cache_type}_cache", None)
|
|
168
176
|
if cache:
|
|
169
177
|
try:
|
|
170
|
-
cache.write("
|
|
178
|
+
cache.write(f"{val}\n")
|
|
171
179
|
except UnicodeEncodeError:
|
|
172
180
|
pass
|
|
173
181
|
|
|
@@ -183,8 +191,11 @@ class Manager(utils.HookableMixin):
|
|
|
183
191
|
def _get_with_base_url(self, url, response_key=None):
|
|
184
192
|
resp, body = self.api.client.get_with_base_url(url)
|
|
185
193
|
if response_key:
|
|
186
|
-
return [
|
|
187
|
-
|
|
194
|
+
return [
|
|
195
|
+
self.resource_class(self, res, loaded=True)
|
|
196
|
+
for res in body[response_key]
|
|
197
|
+
if res
|
|
198
|
+
]
|
|
188
199
|
else:
|
|
189
200
|
return self.resource_class(self, body, loaded=True)
|
|
190
201
|
|
|
@@ -215,14 +226,14 @@ class Manager(utils.HookableMixin):
|
|
|
215
226
|
|
|
216
227
|
def _build_query_string(self, search_opts):
|
|
217
228
|
search_opts = search_opts or {}
|
|
218
|
-
params = sorted(
|
|
219
|
-
|
|
220
|
-
query_string = "?%s" % utils.safe_urlencode(params) if params else ''
|
|
229
|
+
params = sorted([(k, v) for (k, v) in search_opts.items() if v])
|
|
230
|
+
query_string = f"?{utils.safe_urlencode(params)}" if params else ''
|
|
221
231
|
return query_string
|
|
222
232
|
|
|
223
233
|
|
|
224
234
|
class ManagerWithFind(Manager):
|
|
225
235
|
"""Like a `Manager`, but with additional `find()`/`findall()` methods."""
|
|
236
|
+
|
|
226
237
|
def find(self, **kwargs):
|
|
227
238
|
"""Find a single item with attributes matching ``**kwargs``.
|
|
228
239
|
|
|
@@ -232,7 +243,7 @@ class ManagerWithFind(Manager):
|
|
|
232
243
|
matches = self.findall(**kwargs)
|
|
233
244
|
num_matches = len(matches)
|
|
234
245
|
if num_matches == 0:
|
|
235
|
-
msg = "No
|
|
246
|
+
msg = f"No {self.resource_class.__name__} matching {kwargs}."
|
|
236
247
|
raise exceptions.NotFound(404, msg)
|
|
237
248
|
elif num_matches > 1:
|
|
238
249
|
raise exceptions.NoUniqueMatch
|
|
@@ -250,16 +261,17 @@ class ManagerWithFind(Manager):
|
|
|
250
261
|
|
|
251
262
|
search_opts = {'all_tenants': 1}
|
|
252
263
|
resources = self.list(search_opts=search_opts)
|
|
253
|
-
if
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
264
|
+
if 'v2.shares.ShareManager' in str(
|
|
265
|
+
self.__class__
|
|
266
|
+
) and self.api_version >= api_versions.APIVersion("2.69"):
|
|
267
|
+
search_opts_2 = {'all_tenants': 1, 'is_soft_deleted': True}
|
|
257
268
|
shares_soft_deleted = self.list(search_opts=search_opts_2)
|
|
258
269
|
resources += shares_soft_deleted
|
|
259
270
|
for obj in resources:
|
|
260
271
|
try:
|
|
261
|
-
if all(
|
|
262
|
-
|
|
272
|
+
if all(
|
|
273
|
+
getattr(obj, attr) == value for (attr, value) in searches
|
|
274
|
+
):
|
|
263
275
|
found.append(obj)
|
|
264
276
|
except AttributeError:
|
|
265
277
|
continue
|
|
@@ -270,7 +282,7 @@ class ManagerWithFind(Manager):
|
|
|
270
282
|
raise NotImplementedError
|
|
271
283
|
|
|
272
284
|
|
|
273
|
-
class Resource
|
|
285
|
+
class Resource:
|
|
274
286
|
"""Base class for OpenStack resources (tenant, user, etc.).
|
|
275
287
|
|
|
276
288
|
This is pretty much just a bag for attributes.
|
|
@@ -292,11 +304,11 @@ class Resource(object):
|
|
|
292
304
|
self._loaded = loaded
|
|
293
305
|
|
|
294
306
|
def __repr__(self):
|
|
295
|
-
reprkeys = sorted(
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
info = ", ".join("
|
|
299
|
-
return "
|
|
307
|
+
reprkeys = sorted(
|
|
308
|
+
k for k in self.__dict__.keys() if k[0] != '_' and k != 'manager'
|
|
309
|
+
)
|
|
310
|
+
info = ", ".join(f"{k}={getattr(self, k)}" for k in reprkeys)
|
|
311
|
+
return f"<{self.__class__.__name__} {info}>"
|
|
300
312
|
|
|
301
313
|
@property
|
|
302
314
|
def human_id(self):
|
|
@@ -308,7 +320,7 @@ class Resource(object):
|
|
|
308
320
|
return None
|
|
309
321
|
|
|
310
322
|
def _add_details(self, info):
|
|
311
|
-
for
|
|
323
|
+
for k, v in info.items():
|
|
312
324
|
try:
|
|
313
325
|
setattr(self, k, v)
|
|
314
326
|
self._info[k] = v
|
|
@@ -366,7 +378,6 @@ class Resource(object):
|
|
|
366
378
|
|
|
367
379
|
|
|
368
380
|
class MetadataCapableResource(Resource, metaclass=abc.ABCMeta):
|
|
369
|
-
|
|
370
381
|
superresource = None
|
|
371
382
|
|
|
372
383
|
def _get_subresource_and_resource(self, superresource):
|
|
@@ -388,7 +399,8 @@ class MetadataCapableResource(Resource, metaclass=abc.ABCMeta):
|
|
|
388
399
|
"""
|
|
389
400
|
|
|
390
401
|
resource, subresource = self._get_subresource_and_resource(
|
|
391
|
-
superresource
|
|
402
|
+
superresource
|
|
403
|
+
)
|
|
392
404
|
|
|
393
405
|
return self.manager.get_metadata(resource, subresource=subresource)
|
|
394
406
|
|
|
@@ -403,10 +415,12 @@ class MetadataCapableResource(Resource, metaclass=abc.ABCMeta):
|
|
|
403
415
|
by default
|
|
404
416
|
"""
|
|
405
417
|
resource, subresource = self._get_subresource_and_resource(
|
|
406
|
-
superresource
|
|
418
|
+
superresource
|
|
419
|
+
)
|
|
407
420
|
|
|
408
|
-
return self.manager.set_metadata(
|
|
409
|
-
|
|
421
|
+
return self.manager.set_metadata(
|
|
422
|
+
resource, metadata, subresource=subresource
|
|
423
|
+
)
|
|
410
424
|
|
|
411
425
|
def delete_metadata(self, keys, superresource=None):
|
|
412
426
|
"""Delete specified keys from the given resource.
|
|
@@ -418,10 +432,12 @@ class MetadataCapableResource(Resource, metaclass=abc.ABCMeta):
|
|
|
418
432
|
by default
|
|
419
433
|
"""
|
|
420
434
|
resource, subresource = self._get_subresource_and_resource(
|
|
421
|
-
superresource
|
|
435
|
+
superresource
|
|
436
|
+
)
|
|
422
437
|
|
|
423
|
-
return self.manager.delete_metadata(
|
|
424
|
-
|
|
438
|
+
return self.manager.delete_metadata(
|
|
439
|
+
resource, keys, subresource=subresource
|
|
440
|
+
)
|
|
425
441
|
|
|
426
442
|
def update_all_metadata(self, metadata, superresource=None):
|
|
427
443
|
"""Update all metadata for this resource.
|
|
@@ -434,11 +450,12 @@ class MetadataCapableResource(Resource, metaclass=abc.ABCMeta):
|
|
|
434
450
|
by default
|
|
435
451
|
"""
|
|
436
452
|
resource, subresource = self._get_subresource_and_resource(
|
|
437
|
-
superresource
|
|
453
|
+
superresource
|
|
454
|
+
)
|
|
438
455
|
|
|
439
|
-
return self.manager.update_all_metadata(
|
|
440
|
-
|
|
441
|
-
|
|
456
|
+
return self.manager.update_all_metadata(
|
|
457
|
+
resource, metadata, subresource=subresource
|
|
458
|
+
)
|
|
442
459
|
|
|
443
460
|
|
|
444
461
|
class MetadataCapableManager(ManagerWithFind, metaclass=abc.ABCMeta):
|
|
@@ -458,8 +475,9 @@ class MetadataCapableManager(ManagerWithFind, metaclass=abc.ABCMeta):
|
|
|
458
475
|
subresource = getid(subresource)
|
|
459
476
|
resource = f"{resource}{self.subresource_path}/{subresource}"
|
|
460
477
|
|
|
461
|
-
return self._get(
|
|
462
|
-
|
|
478
|
+
return self._get(
|
|
479
|
+
f"{self.resource_path}/{resource}/metadata", "metadata"
|
|
480
|
+
)
|
|
463
481
|
|
|
464
482
|
def set_metadata(self, resource, metadata, subresource=None):
|
|
465
483
|
"""Set or update metadata for resource.
|
|
@@ -475,9 +493,9 @@ class MetadataCapableManager(ManagerWithFind, metaclass=abc.ABCMeta):
|
|
|
475
493
|
subresource = getid(subresource)
|
|
476
494
|
resource = f"{resource}{self.subresource_path}/{subresource}"
|
|
477
495
|
|
|
478
|
-
return self._create(
|
|
479
|
-
|
|
480
|
-
|
|
496
|
+
return self._create(
|
|
497
|
+
f"{self.resource_path}/{resource}/metadata", body, "metadata"
|
|
498
|
+
)
|
|
481
499
|
|
|
482
500
|
def delete_metadata(self, resource, keys, subresource=None):
|
|
483
501
|
"""Delete specified keys from resource metadata.
|
|
@@ -508,5 +526,4 @@ class MetadataCapableManager(ManagerWithFind, metaclass=abc.ABCMeta):
|
|
|
508
526
|
subresource = getid(subresource)
|
|
509
527
|
resource = f"{resource}{self.subresource_path}/{subresource}"
|
|
510
528
|
|
|
511
|
-
return self._update(f"{self.resource_path}/{resource}/metadata",
|
|
512
|
-
body)
|
|
529
|
+
return self._update(f"{self.resource_path}/{resource}/metadata", body)
|