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 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
|
# 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.
import typing as ty
from openstack.database.v1 import database as _database
from openstack.database.v1 import flavor as _flavor
from openstack.database.v1 import instance as _instance
from openstack.database.v1 import user as _user
from openstack import proxy
from openstack import resource
class Proxy(proxy.Proxy):
_resource_registry = {
"database": _database.Database,
"flavor": _flavor.Flavor,
"instance": _instance.Instance,
"user": _user.User,
}
def create_database(self, instance, **attrs):
"""Create a new database from attributes
:param instance: This can be either the ID of an instance
or a :class:`~openstack.database.v1.instance.Instance`
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.database.v1.database.Database`,
comprised of the properties on the Database class.
:returns: The results of server creation
:rtype: :class:`~openstack.database.v1.database.Database`
"""
instance = self._get_resource(_instance.Instance, instance)
return self._create(
_database.Database, instance_id=instance.id, **attrs
)
def delete_database(self, database, instance=None, ignore_missing=True):
"""Delete a database
:param database: The value can be either the ID of a database or a
:class:`~openstack.database.v1.database.Database` instance.
:param instance: This parameter needs to be specified when
an ID is given as `database`.
It can be either the ID of an instance
or a :class:`~openstack.database.v1.instance.Instance`
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the database does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent database.
:returns: ``None``
"""
instance_id = self._get_uri_attribute(
database, instance, "instance_id"
)
self._delete(
_database.Database,
database,
instance_id=instance_id,
ignore_missing=ignore_missing,
)
def find_database(self, name_or_id, instance, ignore_missing=True):
"""Find a single database
:param name_or_id: The name or ID of a database.
:param instance: This can be either the ID of an instance
or a :class:`~openstack.database.v1.instance.Instance`
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.database.v1.database.Database` or None
"""
instance = self._get_resource(_instance.Instance, instance)
return self._find(
_database.Database,
name_or_id,
instance_id=instance.id,
ignore_missing=ignore_missing,
)
def databases(self, instance, **query):
"""Return a generator of databases
:param instance: This can be either the ID of an instance
or a :class:`~openstack.database.v1.instance.Instance`
instance that the interface belongs to.
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of database objects
:rtype: :class:`~openstack.database.v1.database.Database`
"""
instance = self._get_resource(_instance.Instance, instance)
return self._list(_database.Database, instance_id=instance.id, **query)
def get_database(self, database, instance=None):
"""Get a single database
:param instance: This parameter needs to be specified when
an ID is given as `database`.
It can be either the ID of an instance
or a :class:`~openstack.database.v1.instance.Instance`
:param database: The value can be the ID of a database or a
:class:`~openstack.database.v1.database.Database`
instance.
:returns: One :class:`~openstack.database.v1.database.Database`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_database.Database, database)
def find_flavor(self, name_or_id, ignore_missing=True):
"""Find a single flavor
:param name_or_id: The name or ID of a flavor.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.database.v1.flavor.Flavor` or None
"""
return self._find(
_flavor.Flavor, name_or_id, ignore_missing=ignore_missing
)
def get_flavor(self, flavor):
"""Get a single flavor
:param flavor: The value can be the ID of a flavor or a
:class:`~openstack.database.v1.flavor.Flavor` instance.
:returns: One :class:`~openstack.database.v1.flavor.Flavor`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_flavor.Flavor, flavor)
def flavors(self, **query):
"""Return a generator of flavors
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of flavor objects
:rtype: :class:`~openstack.database.v1.flavor.Flavor`
"""
return self._list(_flavor.Flavor, **query)
def create_instance(self, **attrs):
"""Create a new instance from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.database.v1.instance.Instance`,
comprised of the properties on the Instance class.
:returns: The results of server creation
:rtype: :class:`~openstack.database.v1.instance.Instance`
"""
return self._create(_instance.Instance, **attrs)
def delete_instance(self, instance, ignore_missing=True):
"""Delete an instance
:param instance: The value can be either the ID of an instance or a
:class:`~openstack.database.v1.instance.Instance` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the instance does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent instance.
:returns: ``None``
"""
self._delete(
_instance.Instance, instance, ignore_missing=ignore_missing
)
def find_instance(self, name_or_id, ignore_missing=True):
"""Find a single instance
:param name_or_id: The name or ID of a instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.database.v1.instance.Instance` or None
"""
return self._find(
_instance.Instance, name_or_id, ignore_missing=ignore_missing
)
def get_instance(self, instance):
"""Get a single instance
:param instance: The value can be the ID of an instance or a
:class:`~openstack.database.v1.instance.Instance`
instance.
:returns: One :class:`~openstack.database.v1.instance.Instance`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_instance.Instance, instance)
def instances(self, **query):
"""Return a generator of instances
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of instance objects
:rtype: :class:`~openstack.database.v1.instance.Instance`
"""
return self._list(_instance.Instance, **query)
def update_instance(self, instance, **attrs):
"""Update a instance
:param instance: Either the id of a instance or a
:class:`~openstack.database.v1.instance.Instance` instance.
:param attrs: The attributes to update on the instance represented
by ``instance``.
:returns: The updated instance
:rtype: :class:`~openstack.database.v1.instance.Instance`
"""
return self._update(_instance.Instance, instance, **attrs)
def create_user(self, instance, **attrs):
"""Create a new user from attributes
:param instance: This can be either the ID of an instance
or a :class:`~openstack.database.v1.instance.Instance`
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.database.v1.user.User`,
comprised of the properties on the User class.
:returns: The results of server creation
:rtype: :class:`~openstack.database.v1.user.User`
"""
instance = self._get_resource(_instance.Instance, instance)
return self._create(_user.User, instance_id=instance.id, **attrs)
def delete_user(self, user, instance=None, ignore_missing=True):
"""Delete a user
:param user: The value can be either the ID of a user or a
:class:`~openstack.database.v1.user.User` instance.
:param instance: This parameter needs to be specified when
an ID is given as `user`.
It can be either the ID of an instance
or a :class:`~openstack.database.v1.instance.Instance`
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the user does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent user.
:returns: ``None``
"""
instance = self._get_resource(_instance.Instance, instance)
self._delete(
_user.User,
user,
ignore_missing=ignore_missing,
instance_id=instance.id,
)
def find_user(self, name_or_id, instance, ignore_missing=True):
"""Find a single user
:param name_or_id: The name or ID of a user.
:param instance: This can be either the ID of an instance
or a :class:`~openstack.database.v1.instance.Instance`
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.database.v1.user.User` or None
"""
instance = self._get_resource(_instance.Instance, instance)
return self._find(
_user.User,
name_or_id,
instance_id=instance.id,
ignore_missing=ignore_missing,
)
def users(self, instance, **query):
"""Return a generator of users
:param instance: This can be either the ID of an instance
or a :class:`~openstack.database.v1.instance.Instance`
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of user objects
:rtype: :class:`~openstack.database.v1.user.User`
"""
instance = self._get_resource(_instance.Instance, instance)
return self._list(_user.User, instance_id=instance.id, **query)
def get_user(self, user, instance=None):
"""Get a single user
:param user: The value can be the ID of a user or a
:class:`~openstack.database.v1.user.User` instance.
:param instance: This parameter needs to be specified when
an ID is given as `database`.
It can be either the ID of an instance
or a :class:`~openstack.database.v1.instance.Instance`
:returns: One :class:`~openstack.database.v1.user.User`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
instance = self._get_resource(_instance.Instance, instance)
return self._get(_user.User, user)
# ========== Utilities ==========
def wait_for_status(
self,
res: resource.ResourceT,
status: str,
failures: ty.Optional[list[str]] = None,
interval: ty.Union[int, float, None] = 2,
wait: ty.Optional[int] = None,
attribute: str = 'status',
callback: ty.Optional[ty.Callable[[int], None]] = None,
) -> resource.ResourceT:
"""Wait for the resource to be in a particular status.
:param session: The session to use for making this request.
:param resource: The resource to wait on to reach the status. The
resource must have a status attribute specified via ``attribute``.
:param status: Desired status of the resource.
:param failures: Statuses that would indicate the transition
failed such as 'ERROR'. Defaults to ['ERROR'].
:param interval: Number of seconds to wait between checks.
:param wait: Maximum number of seconds to wait for transition.
Set to ``None`` to wait forever.
:param attribute: Name of the resource attribute that contains the
status.
:param callback: A callback function. This will be called with a single
value, progress. This is API specific but is generally a percentage
value from 0-100.
:return: The updated resource.
:raises: :class:`~openstack.exceptions.ResourceTimeout` if the
transition to status failed to occur in ``wait`` seconds.
:raises: :class:`~openstack.exceptions.ResourceFailure` if the resource
transitioned to one of the states in ``failures``.
:raises: :class:`~AttributeError` if the resource does not have a
``status`` attribute
"""
return resource.wait_for_status(
self, res, status, failures, interval, wait, attribute, callback
)
def wait_for_delete(
self,
res: resource.ResourceT,
interval: int = 2,
wait: int = 120,
callback: ty.Optional[ty.Callable[[int], None]] = None,
) -> resource.ResourceT:
"""Wait for a resource to be deleted.
:param res: The resource to wait on to be deleted.
:param interval: Number of seconds to wait before to consecutive
checks.
:param wait: Maximum number of seconds to wait before the change.
:param callback: A callback function. This will be called with a single
value, progress, which is a percentage value from 0-100.
:returns: The resource is returned on success.
:raises: :class:`~openstack.exceptions.ResourceTimeout` if transition
to delete failed to occur in the specified seconds.
"""
return resource.wait_for_delete(self, res, interval, wait, callback)
|