entrypoint.py 9.32 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
import json
import logging
import os
import sys
25
import time
26
from argparse import ArgumentParser, Namespace, FileType, RawDescriptionHelpFormatter
Daniele Venzano's avatar
Daniele Venzano committed
27
from typing import Tuple
28 29

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


38 39 40 41 42 43 44 45 46 47
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'])


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


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


69 70
def exec_list_cmd(args_):
    """List executions"""
71 72
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
    data = exec_api.list()
73
    for e in sorted(data.values(), key=lambda x: x['id']):
74
        print('Execution {} (User: {}, ID: {}): {}'.format(e['name'], e['user_id'], e['id'], e['status']))
75 76 77


def exec_start_cmd(args):
78
    """Submit an execution."""
79
    app_descr = json.load(args.jsonfile)
80
    app_validate(app_descr)
81
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
    exec_id = exec_api.start(args.name, app_descr)
    if not args.synchronous:
        print("Application scheduled successfully with ID {}, use the exec-get command to check its status".format(exec_id))
    else:
        print("Application scheduled successfully with ID {}, waiting for status change".format(exec_id))
        old_status = 'submitted'
        while True:
            execution = exec_api.get(exec_id)
            current_status = execution['status']
            if old_status != current_status:
                print('Execution is now {}'.format(current_status))
                old_status = current_status
            if current_status == 'running':
                break
            time.sleep(1)
97 98 99


def exec_get_cmd(args):
100
    """Gather information about an execution."""
101
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
Daniele Venzano's avatar
Daniele Venzano committed
102
    cont_api = ZoeServiceAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
103
    execution = exec_api.get(args.id)
104 105 106 107 108
    if execution is None:
        print('Execution not found')
    else:
        print('Execution {} (ID: {})'.format(execution['name'], execution['id']))
        print('Status: {}'.format(execution['status']))
109
        if execution['status'] == 'error':
110
            print('Last error: {}'.format(execution['error_message']))
111 112 113 114 115 116 117 118 119 120 121 122 123
        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']
124
        print('Application name: {}'.format(app['name']))
125
        for c_id in execution['services']:
126
            service = cont_api.get(c_id)
127 128
            print('Service {} (ID: {})'.format(service['name'], service['id']))
            print(' - zoe status: {}'.format(service['status']))
129
            print(' - backend status: {}'.format(service['backend_status']))
130 131
            if service['error_message'] is not None:
                print(' - error: {}'.format(service['error_message']))
132
            if service['backend_status'] == 'started':
133 134 135
                ip = service['ip_address']
                for port in service['description']['ports']:
                    print(' - {}: {}://{}:{}{}'.format(port['name'], port['protocol'], ip, port['port_number'], port['path']))
136 137 138


def exec_kill_cmd(args):
139
    """Kill an execution."""
140 141 142 143
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
    exec_api.terminate(args.id)


144
def exec_rm_cmd(args):
145
    """Delete an execution and kill it if necessary."""
146 147 148 149
    exec_api = ZoeExecutionsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
    exec_api.delete(args.id)


150 151 152 153 154 155 156
def stats_cmd(args_):
    """Prints statistics on Zoe internals."""
    stats_api = ZoeStatisticsAPI(utils.zoe_url(), utils.zoe_user(), utils.zoe_pass())
    sched = stats_api.scheduler()
    print('Scheduler queue length: {}'.format(sched['queue_length']))
    print('Termination threads count: {}'.format(sched['termination_threads_count']))

157 158 159 160 161 162
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'''


Daniele Venzano's avatar
Daniele Venzano committed
163
def process_arguments() -> Tuple[ArgumentParser, Namespace]:
164
    """Parse command line arguments."""
165 166 167 168 169
    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()

170 171 172
    argparser_info = subparser.add_parser('info', help="Queries the API for supported versions")
    argparser_info.set_defaults(func=info_cmd)

173 174 175
    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)
176

Francesco Pace's avatar
Francesco Pace committed
177
    argparser_exec_start = subparser.add_parser('start', help="Start an application")
178
    argparser_exec_start.add_argument('-s', '--synchronous', action='store_true', help="Do not detach immediately, wait for execution to start before exiting")
179
    argparser_exec_start.add_argument('name', help="Name of the execution")
180
    argparser_exec_start.add_argument('jsonfile', type=FileType("r"), help='Application description')
181 182
    argparser_exec_start.set_defaults(func=exec_start_cmd)

183 184 185
    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)

186 187 188 189
    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)

190
    argparser_app_get = subparser.add_parser('exec-app-get', help="Retrieve an already defined application description")
191
    argparser_app_get.add_argument('id', help='The ID of the application')
192
    argparser_app_get.set_defaults(func=app_get_cmd)
193 194 195 196 197

    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)

198 199 200 201
    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)

202 203 204
    argparser_stats = subparser.add_parser('stats', help="Prints all available statistics")
    argparser_stats.set_defaults(func=stats_cmd)

205 206 207 208
    return parser, parser.parse_args()


def zoe():
209
    """Main entrypoint."""
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    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)