From 4276a68cf3cdb2af2ef8108c97ce49d4f14b09d0 Mon Sep 17 00:00:00 2001 From: "Brian C. Lane" Date: Mon, 23 Sep 2019 17:02:13 -0700 Subject: [PATCH] composer-cli: Add support for providers command Add commands for listing, saving, and adding new provider profiles. Also adds a list command to upload. --- src/composer/cli/__init__.py | 4 +- src/composer/cli/help.py | 22 +++- src/composer/cli/providers.py | 236 ++++++++++++++++++++++++++++++++++ src/composer/cli/upload.py | 35 +++++ 4 files changed, 294 insertions(+), 3 deletions(-) create mode 100644 src/composer/cli/providers.py diff --git a/src/composer/cli/__init__.py b/src/composer/cli/__init__.py index eddbbaa5..4dcbcb43 100644 --- a/src/composer/cli/__init__.py +++ b/src/composer/cli/__init__.py @@ -26,6 +26,7 @@ from composer.cli.compose import compose_cmd from composer.cli.sources import sources_cmd from composer.cli.status import status_cmd from composer.cli.upload import upload_cmd +from composer.cli.providers import providers_cmd command_map = { "blueprints": blueprints_cmd, @@ -34,7 +35,8 @@ command_map = { "compose": compose_cmd, "sources": sources_cmd, "status": status_cmd, - "upload": upload_cmd + "upload": upload_cmd, + "providers": providers_cmd } diff --git a/src/composer/cli/help.py b/src/composer/cli/help.py index f27b4a30..a2c65e28 100644 --- a/src/composer/cli/help.py +++ b/src/composer/cli/help.py @@ -137,7 +137,7 @@ upload_help = """ upload info Details about an upload -upload start | +upload start [ |] Upload a build image to the selected provider. upload log @@ -153,4 +153,22 @@ upload reset Reset the upload so that it can be tried again """ -epilog = compose_help + blueprints_help + modules_help + projects_help + sources_help + status_help + upload_help +providers_help = """ +providers list + List the available providers, or list the available profiles + +providers show + show the details of a specific provider's profile + +providers push + Add a new profile, or overwrite an existing one + +providers save + Save the profile's details to a TOML file named .toml + +providers delete + Delete a profile from a provider +""" + +epilog = compose_help + blueprints_help + modules_help + projects_help \ + + sources_help + status_help + upload_help + providers_help diff --git a/src/composer/cli/providers.py b/src/composer/cli/providers.py new file mode 100644 index 00000000..dec0caf5 --- /dev/null +++ b/src/composer/cli/providers.py @@ -0,0 +1,236 @@ +# +# Copyright (C) 2019 Red Hat, Inc. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +import logging +log = logging.getLogger("composer-cli") + +import json +import toml +import os + +from composer import http_client as client +from composer.cli.help import providers_help +from composer.cli.utilities import handle_api_result, toml_filename + +def providers_cmd(opts): + """Process providers commands + + :param opts: Cmdline arguments + :type opts: argparse.Namespace + :returns: Value to return from sys.exit() + :rtype: int + + This dispatches the providers commands to a function + """ + cmd_map = { + "list": providers_list, + "show": providers_show, + "push": providers_push, + "save": providers_save, + "delete": providers_delete + } + if opts.args[1] == "help" or opts.args[1] == "--help": + print(providers_help) + return 0 + elif opts.args[1] not in cmd_map: + log.error("Unknown providers command: %s", opts.args[1]) + return 1 + + return cmd_map[opts.args[1]](opts.socket, opts.api_version, opts.args[2:], opts.json, opts.testmode) + +def providers_list(socket_path, api_version, args, show_json=False, testmode=0): + """Return the list of providers + + :param socket_path: Path to the Unix socket to use for API communication + :type socket_path: str + :param api_version: Version of the API to talk to. eg. "0" + :type api_version: str + :param args: List of remaining arguments from the cmdline + :type args: list of str + :param show_json: Set to True to show the JSON output instead of the human readable output + :type show_json: bool + :param testmode: unused in this function + :type testmode: int + + providers list + """ + api_route = client.api_url(api_version, "/upload/providers") + r = client.get_url_json(socket_path, api_route) + results = r["providers"] + if not results: + return 0 + + if show_json: + print(json.dumps(results, indent=4)) + else: + if len(args) == 1: + if args[0] not in results: + log.error("%s is not a valid provider", args[0]) + return 1 + print("\n".join(sorted(results[args[0]]["profiles"].keys()))) + else: + print("\n".join(sorted(results.keys()))) + + return 0 + +def providers_show(socket_path, api_version, args, show_json=False, testmode=0): + """Return details about a provider + + :param socket_path: Path to the Unix socket to use for API communication + :type socket_path: str + :param api_version: Version of the API to talk to. eg. "0" + :type api_version: str + :param args: List of remaining arguments from the cmdline + :type args: list of str + :param show_json: Set to True to show the JSON output instead of the human readable output + :type show_json: bool + :param testmode: unused in this function + :type testmode: int + + providers show + """ + if len(args) == 0: + log.error("show is missing the provider name") + return 1 + if len(args) == 1: + log.error("show is missing the profile name") + return 1 + + api_route = client.api_url(api_version, "/upload/providers") + r = client.get_url_json(socket_path, api_route) + results = r["providers"] + if not results: + return 0 + + if show_json: + print(json.dumps(results, indent=4)) + else: + if args[0] not in results: + log.error("%s is not a valid provider", args[0]) + return 1 + if args[1] not in results[args[0]]["profiles"]: + log.error("%s is not a valid %s profile", args[1], args[0]) + return 1 + + # Print the details for this profile + # fields are different for each provider, so we just print out the key:values + for k in results[args[0]]["profiles"][args[1]]: + print("%s: %s" % (k, results[args[0]]["profiles"][args[1]][k])) + return 0 + +def providers_push(socket_path, api_version, args, show_json=False, testmode=0): + """Add a new provider profile or overwrite an existing one + + :param socket_path: Path to the Unix socket to use for API communication + :type socket_path: str + :param api_version: Version of the API to talk to. eg. "0" + :type api_version: str + :param args: List of remaining arguments from the cmdline + :type args: list of str + :param show_json: Set to True to show the JSON output instead of the human readable output + :type show_json: bool + :param testmode: unused in this function + :type testmode: int + + providers push + + """ + if len(args) == 0: + log.error("push is missing the profile TOML file") + if not os.path.exists(args[0]): + log.error("Missing profile TOML file: %s", args[0]) + + api_route = client.api_url(api_version, "/upload/providers/save") + profile = toml.load(args[0]) + result = client.post_url_json(socket_path, api_route, json.dumps(profile)) + return handle_api_result(result, show_json)[0] + +def providers_save(socket_path, api_version, args, show_json=False, testmode=0): + """Save a provider's profile to a TOML file + + :param socket_path: Path to the Unix socket to use for API communication + :type socket_path: str + :param api_version: Version of the API to talk to. eg. "0" + :type api_version: str + :param args: List of remaining arguments from the cmdline + :type args: list of str + :param show_json: Set to True to show the JSON output instead of the human readable output + :type show_json: bool + :param testmode: unused in this function + :type testmode: int + + providers save + + """ + if len(args) == 0: + log.error("save is missing the provider name") + return 1 + if len(args) == 1: + log.error("save is missing the profile name") + return 1 + + api_route = client.api_url(api_version, "/upload/providers") + r = client.get_url_json(socket_path, api_route) + results = r["providers"] + if not results: + return 0 + + if show_json: + print(json.dumps(results, indent=4)) + else: + if args[0] not in results: + log.error("%s is not a valid provider", args[0]) + return 1 + if args[1] not in results[args[0]]["profiles"]: + log.error("%s is not a valid %s profile", args[1], args[0]) + return 1 + + profile = { + "provider": args[0], + "profile": args[1], + "settings": results[args[0]]["profiles"][args[1]] + } + open(toml_filename(args[1]), "w").write(toml.dumps(profile)) + + return 0 + +def providers_delete(socket_path, api_version, args, show_json=False, testmode=0): + """Delete a profile from a provider + + :param socket_path: Path to the Unix socket to use for API communication + :type socket_path: str + :param api_version: Version of the API to talk to. eg. "0" + :type api_version: str + :param args: List of remaining arguments from the cmdline + :type args: list of str + :param show_json: Set to True to show the JSON output instead of the human readable output + :type show_json: bool + :param testmode: unused in this function + :type testmode: int + + providers delete + + """ + if len(args) == 0: + log.error("delete is missing the provider name") + return 1 + if len(args) == 1: + log.error("delete is missing the profile name") + return 1 + + api_route = client.api_url(api_version, "/upload/providers/delete/%s/%s" % (args[0], args[1])) + result = client.delete_url_json(socket_path, api_route) + return handle_api_result(result, show_json)[0] diff --git a/src/composer/cli/upload.py b/src/composer/cli/upload.py index 0c0d4da1..8b9e32d4 100644 --- a/src/composer/cli/upload.py +++ b/src/composer/cli/upload.py @@ -36,6 +36,7 @@ def upload_cmd(opts): This dispatches the upload commands to a function """ cmd_map = { + "list": upload_list, "info": upload_info, "start": upload_start, "log": upload_log, @@ -52,6 +53,40 @@ def upload_cmd(opts): return cmd_map[opts.args[1]](opts.socket, opts.api_version, opts.args[2:], opts.json, opts.testmode) +def upload_list(socket_path, api_version, args, show_json=False, testmode=0): + """Return the composes and their associated upload uuids and status + + :param socket_path: Path to the Unix socket to use for API communication + :type socket_path: str + :param api_version: Version of the API to talk to. eg. "0" + :type api_version: str + :param args: List of remaining arguments from the cmdline + :type args: list of str + :param show_json: Set to True to show the JSON output instead of the human readable output + :type show_json: bool + :param testmode: unused in this function + :type testmode: int + + upload list + """ + api_route = client.api_url(api_version, "/compose/finished") + r = client.get_url_json(socket_path, api_route) + results = r["finished"] + if not results: + return 0 + + if show_json: + print(json.dumps(results, indent=4)) + else: + compose_fmt = "{id} {queue_status} {blueprint} {version} {compose_type}" + upload_fmt = ' {uuid} "{image_name}" {provider_name} {status}' + for c in results: + print(compose_fmt.format(**c)) + print("\n".join(upload_fmt.format(**u) for u in c["uploads"])) + print() + + return 0 + def upload_info(socket_path, api_version, args, show_json=False, testmode=0): """Return detailed information about the upload