# Copyright 2019 Rackspace US Inc. 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 oslo_log import log as logging from tempest.lib import exceptions from octavia_tempest_plugin.services.load_balancer.v2 import base_client LOG = logging.getLogger(__name__) Unset = base_client.Unset class AvailabilityZoneProfileClient(base_client.BaseLBaaSClient): root_tag = 'availability_zone_profile' list_root_tag = 'availability_zone_profiles' resource_path = 'availabilityzoneprofiles' def __init__(self, *args, **kwargs): super(AvailabilityZoneProfileClient, self).__init__(*args, **kwargs) self.uri = self.base_uri.format(object=self.resource_path) def create_availability_zone_profile(self, name, provider_name, availability_zone_data, return_object_only=True): """Create an availability zone profile. :param name: Human-readable name of the resource. :param provider_name: The octavia provider name. :param availability_zone_data: The JSON string containing the availability zone metadata. :raises AssertionError: if the expected_code isn't a valid http success response code :raises BadRequest: If a 400 response code is received :raises Conflict: If a 409 response code is received :raises Forbidden: If a 403 response code is received :raises Gone: If a 410 response code is received :raises InvalidContentType: If a 415 response code is received :raises InvalidHTTPResponseBody: The response body wasn't valid JSON :raises InvalidHttpSuccessCode: if the read code isn't an expected http success code :raises NotFound: If a 404 response code is received :raises NotImplemented: If a 501 response code is received :raises OverLimit: If a 413 response code is received and over_limit is not in the response body :raises RateLimitExceeded: If a 413 response code is received and over_limit is in the response body :raises ServerFault: If a 500 response code is received :raises Unauthorized: If a 401 response code is received :raises UnexpectedContentType: If the content-type of the response isn't an expect type :raises UnexpectedResponseCode: If a response code above 400 is received and it doesn't fall into any of the handled checks :raises UnprocessableEntity: If a 422 response code is received and couldn't be parsed :returns: An availability zone profile object. """ kwargs = {arg: value for arg, value in locals().items() if arg != 'self' and value is not Unset} return self._create_object(**kwargs) def show_availability_zone_profile(self, availability_zone_profile_id, query_params=None, return_object_only=True): """Get the availability zone profile details. :param availability_zone_profile_id: The availability zone profile ID to query. :param query_params: The optional query parameters to append to the request. Ex. fields=id&fields=name :param return_object_only: If True, the response returns the object inside the root tag. False returns the full response from the API. :raises AssertionError: if the expected_code isn't a valid http success response code :raises BadRequest: If a 400 response code is received :raises Conflict: If a 409 response code is received :raises Forbidden: If a 403 response code is received :raises Gone: If a 410 response code is received :raises InvalidContentType: If a 415 response code is received :raises InvalidHTTPResponseBody: The response body wasn't valid JSON :raises InvalidHttpSuccessCode: if the read code isn't an expected http success code :raises NotFound: If a 404 response code is received :raises NotImplemented: If a 501 response code is received :raises OverLimit: If a 413 response code is received and over_limit is not in the response body :raises RateLimitExceeded: If a 413 response code is received and over_limit is in the response body :raises ServerFault: If a 500 response code is received :raises Unauthorized: If a 401 response code is received :raises UnexpectedContentType: If the content-type of the response isn't an expect type :raises UnexpectedResponseCode: If a response code above 400 is received and it doesn't fall into any of the handled checks :raises UnprocessableEntity: If a 422 response code is received and couldn't be parsed :returns: An availability zone profile object. """ return self._show_object(obj_id=availability_zone_profile_id, query_params=query_params, return_object_only=return_object_only) def list_availability_zone_profiles(self, query_params=None, return_object_only=True): """Get a list of availability zone profile objects. :param query_params: The optional query parameters to append to the request. Ex. fields=id&fields=name :param return_object_only: If True, the response returns the object inside the root tag. False returns the full response from the API. :raises AssertionError: if the expected_code isn't a valid http success response code :raises BadRequest: If a 400 response code is received :raises Conflict: If a 409 response code is received :raises Forbidden: If a 403 response code is received :raises Gone: If a 410 response code is received :raises InvalidContentType: If a 415 response code is received :raises InvalidHTTPResponseBody: The response body wasn't valid JSON :raises InvalidHttpSuccessCode: if the read code isn't an expected http success code :raises NotFound: If a 404 response code is received :raises NotImplemented: If a 501 response code is received :raises OverLimit: If a 413 response code is received and over_limit is not in the response body :raises RateLimitExceeded: If a 413 response code is received and over_limit is in the response body :raises ServerFault: If a 500 response code is received :raises Unauthorized: If a 401 response code is received :raises UnexpectedContentType: If the content-type of the response isn't an expect type :raises UnexpectedResponseCode: If a response code above 400 is received and it doesn't fall into any of the handled checks :raises UnprocessableEntity: If a 422 response code is received and couldn't be parsed :returns: A list of availability zone profile objects. """ return self._list_objects(query_params=query_params, return_object_only=return_object_only) def update_availability_zone_profile( self, availability_zone_profile_id, name=Unset, provider_name=Unset, availability_zone_data=Unset, return_object_only=True): """Update an availability zone profile. :param availability_zone_profile_id: The availability zone profile ID to update. :param name: Human-readable name of the resource. :param provider_name: The octavia provider name. :param availability_zone_data: The JSON string containing the availability zone metadata. :raises AssertionError: if the expected_code isn't a valid http success response code :raises BadRequest: If a 400 response code is received :raises Conflict: If a 409 response code is received :raises Forbidden: If a 403 response code is received :raises Gone: If a 410 response code is received :raises InvalidContentType: If a 415 response code is received :raises InvalidHTTPResponseBody: The response body wasn't valid JSON :raises InvalidHttpSuccessCode: if the read code isn't an expected http success code :raises NotFound: If a 404 response code is received :raises NotImplemented: If a 501 response code is received :raises OverLimit: If a 413 response code is received and over_limit is not in the response body :raises RateLimitExceeded: If a 413 response code is received and over_limit is in the response body :raises ServerFault: If a 500 response code is received :raises Unauthorized: If a 401 response code is received :raises UnexpectedContentType: If the content-type of the response isn't an expect type :raises UnexpectedResponseCode: If a response code above 400 is received and it doesn't fall into any of the handled checks :raises UnprocessableEntity: If a 422 response code is received and couldn't be parsed :returns: An availability zone profile object. """ kwargs = {arg: value for arg, value in locals().items() if arg != 'self' and value is not Unset} kwargs['obj_id'] = kwargs.pop('availability_zone_profile_id') return self._update_object(**kwargs) def delete_availability_zone_profile(self, availability_zone_profile_id, ignore_errors=False): """Delete an availability zone profile. :param availability_zone_profile_id: The availability zone profile ID to delete. :param ignore_errors: True if errors should be ignored. :raises AssertionError: if the expected_code isn't a valid http success response code :raises BadRequest: If a 400 response code is received :raises Conflict: If a 409 response code is received :raises Forbidden: If a 403 response code is received :raises Gone: If a 410 response code is received :raises InvalidContentType: If a 415 response code is received :raises InvalidHTTPResponseBody: The response body wasn't valid JSON :raises InvalidHttpSuccessCode: if the read code isn't an expected http success code :raises NotFound: If a 404 response code is received :raises NotImplemented: If a 501 response code is received :raises OverLimit: If a 413 response code is received and over_limit is not in the response body :raises RateLimitExceeded: If a 413 response code is received and over_limit is in the response body :raises ServerFault: If a 500 response code is received :raises Unauthorized: If a 401 response code is received :raises UnexpectedContentType: If the content-type of the response isn't an expect type :raises UnexpectedResponseCode: If a response code above 400 is received and it doesn't fall into any of the handled checks :raises UnprocessableEntity: If a 422 response code is received and couldn't be parsed :returns: None if ignore_errors is True, the response status code if not. """ return self._delete_obj(obj_id=availability_zone_profile_id, ignore_errors=ignore_errors) def cleanup_availability_zone_profile(self, availability_zone_profile_id): """Delete an availability zone profile for tempest cleanup. We cannot use the cleanup_availability_zone_profile method as availability zone profiles do not have a provisioning_status. :param availability_zone_profile_id: The availability zone profile ID to delete. :raises AssertionError: if the expected_code isn't a valid http success response code :raises BadRequest: If a 400 response code is received :raises Conflict: If a 409 response code is received :raises Forbidden: If a 403 response code is received :raises Gone: If a 410 response code is received :raises InvalidContentType: If a 415 response code is received :raises InvalidHTTPResponseBody: The response body wasn't valid JSON :raises InvalidHttpSuccessCode: if the read code isn't an expected http success code :raises NotImplemented: If a 501 response code is received :raises OverLimit: If a 413 response code is received and over_limit is not in the response body :raises RateLimitExceeded: If a 413 response code is received and over_limit is in the response body :raises ServerFault: If a 500 response code is received :raises Unauthorized: If a 401 response code is received :raises UnexpectedContentType: If the content-type of the response isn't an expect type :raises UnexpectedResponseCode: If a response code above 400 is received and it doesn't fall into any of the handled checks :raises UnprocessableEntity: If a 422 response code is received and couldn't be parsed :returns: None if ignore_errors is True, the response status code if not. """ try: self._delete_obj(obj_id=availability_zone_profile_id) except exceptions.NotFound: # Already gone, cleanup complete LOG.info("Availability zone profile %s is already gone. " "Cleanup considered complete.", availability_zone_profile_id)