b6d7af07fa
Rather than always returning JSON or YAML, add functionality to return table responses when applicable for ease of reading. Adds some marker exceptions to the Shipyard API Client to handle cases where the user of the client would generally want to take a specific and repeatable course of action instead of handling the response in a case-by-case basis. Moved cli action testing to use the responses library instead of as many internal mocks. Added test response generators for standard api responses. Change-Id: I3a593fb29b6e76d971adc7f3bb3a4b7f378ed091
91 lines
3.3 KiB
Python
91 lines
3.3 KiB
Python
# 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 shipyard_client.cli.action import CliAction
|
|
from shipyard_client.cli import cli_format_common
|
|
from shipyard_client.cli import format_utils
|
|
|
|
|
|
class CreateAction(CliAction):
|
|
"""Action to Create Action"""
|
|
|
|
def __init__(self, ctx, action_name, param):
|
|
"""Sets parameters."""
|
|
super().__init__(ctx)
|
|
self.logger.debug("CreateAction action initialized with action command"
|
|
"%s and parameters %s", action_name, param)
|
|
self.action_name = action_name
|
|
self.param = param
|
|
|
|
def invoke(self):
|
|
"""Returns the response from API Client"""
|
|
self.logger.debug("Calling API Client post_actions.")
|
|
return self.get_api_client().post_actions(name=self.action_name,
|
|
parameters=self.param)
|
|
|
|
# Handle 400, 409 with default error handler for cli.
|
|
cli_handled_err_resp_codes = [400, 409]
|
|
|
|
# Handle 201 responses using the cli_format_response_handler
|
|
cli_handled_succ_resp_codes = [201]
|
|
|
|
def cli_format_response_handler(self, response):
|
|
"""CLI output handler
|
|
|
|
:param response: a requests response object
|
|
:returns: a string representing a formatted response
|
|
Handles 201 responses
|
|
"""
|
|
resp_j = response.json()
|
|
action_list = [resp_j] if resp_j else []
|
|
return cli_format_common.gen_action_table(action_list)
|
|
|
|
|
|
class CreateConfigdocs(CliAction):
|
|
"""Action to Create Configdocs"""
|
|
|
|
def __init__(self, ctx, collection, buffer, data):
|
|
"""Sets parameters."""
|
|
super().__init__(ctx)
|
|
self.logger.debug("CreateConfigdocs action initialized with" +
|
|
" collection=%s,buffer=%s and data=%s", collection,
|
|
buffer, str(data))
|
|
self.collection = collection
|
|
self.buffer = buffer
|
|
self.data = data
|
|
|
|
def invoke(self):
|
|
"""Calls API Client and formats response from API Client"""
|
|
self.logger.debug("Calling API Client post_configdocs.")
|
|
return self.get_api_client().post_configdocs(
|
|
collection_id=self.collection,
|
|
buffer_mode=self.buffer,
|
|
document_data=self.data
|
|
)
|
|
|
|
# Handle 409 with default error handler for cli.
|
|
cli_handled_err_resp_codes = [409]
|
|
|
|
# Handle 201 responses using the cli_format_response_handler
|
|
cli_handled_succ_resp_codes = [201]
|
|
|
|
def cli_format_response_handler(self, response):
|
|
"""CLI output handler
|
|
|
|
:param response: a requests response object
|
|
:returns: a string representing a formatted response
|
|
Handles 201 responses
|
|
"""
|
|
outfmt_string = "Configuration documents added.\n{}"
|
|
return outfmt_string.format(
|
|
format_utils.cli_format_status_handler(response)
|
|
)
|