entrypoint.py 7.69 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
# Copyright (c) 2016, Daniele Venzano
#
# 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.

"""
This module contains the entrypoint for the commandline Zoe client
"""

20
import datetime
21 22 23 24 25 26 27
import json
import logging
import os
import sys
from argparse import ArgumentParser, Namespace, FileType, RawDescriptionHelpFormatter

from zoe_cmd import utils
28
from zoe_lib.info import ZoeInfoAPI
Daniele Venzano's avatar
Daniele Venzano committed
29
from zoe_lib.services import ZoeServiceAPI
30
from zoe_lib.exceptions import ZoeAPIException, InvalidApplicationDescription
31
from zoe_lib.executions import ZoeExecutionsAPI
32
from zoe_lib.applications import app_validate
33 34


35 36 37 38 39 40 41 42 43 44
def info_cmd(args_):
    """Queries the info endpoint."""
    info_api = ZoeInfoAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
    info = info_api.info()
    print("Zoe version: ", info['version'])
    print("Zoe API version: ", info['api_version'])
    print("ZApp format version: ", info['application_format_version'])
    print("Deployment name: ", info['deployment_name'])


45
def app_validate_cmd(args):
46
    """Validate an application description."""
47
    app_descr = json.load(args.jsonfile)
48
    try:
49 50 51
        app_validate(app_descr)
    except InvalidApplicationDescription as e:
        print(e)
52
    else:
53
        print("Static validation OK")
54 55 56


def app_get_cmd(args):
57
    """Extract an application description from an execution."""
58
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
59
    execution = exec_api.get(args.id)
60
    if execution is None:
61
        print("no such execution")
62
    else:
63
        json.dump(execution['description'], sys.stdout, sort_keys=True, indent=4)
64 65


66 67
def exec_list_cmd(args_):
    """List executions"""
68 69 70
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
    data = exec_api.list()
    for e in data:
71
        print('Execution {} (User: {}, ID: {}): {}'.format(e['name'], e['user_id'], e['id'], e['status']))
72 73 74


def exec_start_cmd(args):
75
    """Submit an execution."""
76
    app_descr = json.load(args.jsonfile)
77
    app_validate(app_descr)
78
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
79
    ret = exec_api.start(args.name, app_descr)
80 81 82 83
    print("Application scheduled successfully with ID {}, use the exec-get command to check its status".format(ret))


def exec_get_cmd(args):
84
    """Gather information about an execution."""
85
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
Daniele Venzano's avatar
Daniele Venzano committed
86
    cont_api = ZoeServiceAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
87
    execution = exec_api.get(args.id)
88 89 90 91 92
    if execution is None:
        print('Execution not found')
    else:
        print('Execution {} (ID: {})'.format(execution['name'], execution['id']))
        print('Status: {}'.format(execution['status']))
93
        if execution['status'] == 'error':
94
            print('Last error: {}'.format(execution['error']))
95 96 97 98 99 100 101 102 103 104 105 106 107
        print('Time submit: {}'.format(datetime.datetime.fromtimestamp(execution['time_submit'])))

        if execution['time_start'] is None:
            print('Time start: {}'.format('not yet'))
        else:
            print('Time start: {}'.format(datetime.datetime.fromtimestamp(execution['time_start'])))

        if execution['time_end'] is None:
            print('Time end: {}'.format('not yet'))
        else:
            print('Time end: {}'.format(datetime.datetime.fromtimestamp(execution['time_end'])))

        app = execution['description']
108
        print('Application name: {}'.format(app['name']))
109
        for c_id in execution['services']:
110 111 112 113 114
            service = cont_api.get(c_id)
            ip = service['ip_address']
            print('Service {} (ID: {}, {})'.format(service['name'], service['id'], service['status']))
            for port in service['description']['ports']:
                print(' - {}: {}://{}:{}{}'.format(port['name'], port['protocol'], ip, port['port_number'], port['path']))
115 116 117


def exec_kill_cmd(args):
118
    """Kill an execution."""
119 120 121 122
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
    exec_api.terminate(args.id)


123
def exec_rm_cmd(args):
124
    """Delete an execution and kill it if necessary."""
125 126 127 128
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
    exec_api.delete(args.id)


129 130 131 132 133 134 135
ENV_HELP_TEXT = '''To use this tool you need also to define three environment variables:
ZOE_URL: point to the URL of the Zoe Scheduler (ex.: http://localhost:5000/
ZOE_USER: the username used for authentication
ZOE_PASS: the password used for authentication'''


def process_arguments() -> Namespace:
136
    """Parse command line arguments."""
137 138 139 140 141
    parser = ArgumentParser(description="Zoe command-line client", epilog=ENV_HELP_TEXT, formatter_class=RawDescriptionHelpFormatter)
    parser.add_argument('--debug', action='store_true', help='Enable debug output')

    subparser = parser.add_subparsers()

142 143 144
    argparser_info = subparser.add_parser('info', help="Queries the API for supported versions")
    argparser_info.set_defaults(func=info_cmd)

145 146 147
    argparser_app_validate = subparser.add_parser('app-validate', help='Validate an application description')
    argparser_app_validate.add_argument('jsonfile', type=FileType("r"), help='Application description')
    argparser_app_validate.set_defaults(func=app_validate_cmd)
148

Francesco Pace's avatar
Francesco Pace committed
149
    argparser_exec_start = subparser.add_parser('start', help="Start an application")
150
    argparser_exec_start.add_argument('name', help="Name of the execution")
151
    argparser_exec_start.add_argument('jsonfile', type=FileType("r"), help='Application description')
152 153
    argparser_exec_start.set_defaults(func=exec_start_cmd)

154 155 156
    argparser_app_list = subparser.add_parser('exec-ls', help="List all executions for the calling user")
    argparser_app_list.set_defaults(func=exec_list_cmd)

157 158 159 160
    argparser_execution_get = subparser.add_parser('exec-get', help="Get execution status")
    argparser_execution_get.add_argument('id', type=int, help="Execution id")
    argparser_execution_get.set_defaults(func=exec_get_cmd)

161
    argparser_app_get = subparser.add_parser('exec-app-get', help="Retrieve an already defined application description")
162
    argparser_app_get.add_argument('id', help='The ID of the application')
163
    argparser_app_get.set_defaults(func=app_get_cmd)
164 165 166 167 168

    argparser_execution_kill = subparser.add_parser('terminate', help="Terminates an execution")
    argparser_execution_kill.add_argument('id', type=int, help="Execution id")
    argparser_execution_kill.set_defaults(func=exec_kill_cmd)

169 170 171 172
    argparser_execution_kill = subparser.add_parser('exec-rm', help="Deletes an execution")
    argparser_execution_kill.add_argument('id', type=int, help="Execution id")
    argparser_execution_kill.set_defaults(func=exec_rm_cmd)

173 174 175 176
    return parser, parser.parse_args()


def zoe():
177
    """Main entrypoint."""
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
    parser, args = process_arguments()
    if args.debug:
        logging.basicConfig(level=logging.DEBUG)
    else:
        logging.basicConfig(level=logging.INFO)
    logging.getLogger("requests").setLevel(logging.WARNING)

    if not hasattr(args, "func"):
        parser.print_help()
        return

    if 'ZOE_URL' not in os.environ or 'ZOE_USER' not in os.environ or 'ZOE_PASS' not in os.environ:
        parser.print_help()
        return

    try:
        args.func(args)
    except ZoeAPIException as e:
        print(e.message)
    sys.exit(0)