-
Notifications
You must be signed in to change notification settings - Fork 1
/
launch.py
executable file
·331 lines (255 loc) · 12.2 KB
/
launch.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# framework is available at github: https://github.com/mushkevych/launch.py
"""
@author Bohdan Mushkevych
@author Shawn MacIntyre
"""
import sys
import shutil
import traceback
import subprocess
import argparse
from os import path
PROCESS_STARTER = 'process_starter.py'
PROJECT_ROOT = path.abspath(path.dirname(__file__))
# script is run to install virtual environment library into the global interpreter
VE_GLOBAL_SCRIPT = path.join(PROJECT_ROOT, 'scripts', 'install_ve_globally.sh')
# script creates virtual environment for the project
VE_SCRIPT = path.join(PROJECT_ROOT, 'scripts', 'install_virtualenv.sh')
VE_ROOT = path.join(PROJECT_ROOT, '.ve')
def init_parser():
try:
from synergy.conf import context, settings
process_names = context.process_context.keys()
config_file = settings.settings['config_file']
except ImportError:
process_names = ['Virtual Environment is pending installation']
config_file = 'Virtual Environment is pending installation'
main_parser = argparse.ArgumentParser(prog='launch.py')
subparsers = main_parser.add_subparsers(title='sub-commands', description='list of available sub-commands')
install_parser = subparsers.add_parser('install', help='install a virtualenv for the runtime to use')
install_parser.set_defaults(func=install_virtualenv)
shell_parser = subparsers.add_parser('shell', help='run an iPython shell within the virtualenv')
shell_parser.set_defaults(func=run_shell)
list_parser = subparsers.add_parser('list', help='list available processes')
list_parser.set_defaults(func=list_processes)
db_parser = subparsers.add_parser('db', help='manages Synergy Scheduler DB')
db_parser.set_defaults(func=db_command)
db_group = db_parser.add_mutually_exclusive_group()
db_group.add_argument('--init', action='store_true',
help='writes to managed_process table records from the context.process_context')
db_group.add_argument('--flush', action='store_true',
help='drops the *scheduler* database, resets schema, initializes db')
super_parser = subparsers.add_parser('super', help='super a process by name')
super_parser.set_defaults(func=supervisor_command)
super_group = super_parser.add_mutually_exclusive_group()
super_group.add_argument('--start', action='store_true', help='marks the process to be started by Supervisor')
super_group.add_argument('--stop', action='store_true', help='marks the process to be stopped by Supervisor')
super_group.add_argument('--query', action='store_true', help='queries the state of Supervisor-managed processes')
super_group.add_argument('--init', action='store_true', help='defines the DB schema for Supervisor table')
super_group.add_argument('--boxid', action='store_true',
help='creates {0} and records BOX_ID in it'.format(config_file))
super_parser.add_argument('argument', nargs='?')
start_parser = subparsers.add_parser('start', help='start a process by name')
start_parser.set_defaults(func=start_process)
start_parser.add_argument('process_name', choices=process_names)
start_parser.add_argument('--console', action='store_true', help='process is run in interactive (non-daemon) mode')
stop_parser = subparsers.add_parser('stop', help='kill a process by name')
stop_parser.set_defaults(func=stop_process)
stop_parser.add_argument('process_name', choices=process_names)
query_parser = subparsers.add_parser('query',
help='query a process state [RUNNING, TERMINATED] by name')
query_parser.set_defaults(func=query_configuration)
query_parser.add_argument('process_name', nargs='?', choices=process_names)
test_parser = subparsers.add_parser('test', help='run unit tests from the settings.test_cases list')
test_parser.add_argument('-o', '--outfile', action='store', help='save report results into a file')
test_parser.set_defaults(func=run_tests)
test_group = test_parser.add_mutually_exclusive_group()
test_group.add_argument('-x', '--xunit', action='store_true',
help='measure coverage during unit tests execution')
test_group.add_argument('-p', '--pylint', action='store_true', help='run pylint on the project')
return main_parser
def get_python():
"""Determine the path to the virtualenv python"""
if sys.platform == 'win32':
python = path.join(VE_ROOT, 'Scripts', 'python.exe')
else:
python = path.join(VE_ROOT, 'bin', 'python')
return python
def go_to_ve():
"""Rerun this script within the virtualenv with same args
Note: parent process will wait for created subprocess to complete"""
# two options are possible
if not path.abspath(sys.prefix) == VE_ROOT:
# Option A: we are in the parental process that was called from command line like
# $> ./launch.py start PROCESS_NAME
# in this case sys.prefix points to Global Interpreter
python = get_python()
retcode = subprocess.call([python, __file__] + sys.argv[1:])
sys.exit(retcode)
else:
# Option B: we have already followed Option A and instantiated Virtual Environment command
# This mean that sys.prefix points to Virtual Environment
pass
def install_virtualenv_p2(root, python_version):
"""Install virtual environment for Python 2.7+; removing the old one if it exists"""
try:
import virtualenv
except ImportError:
sys.stdout.write('Installing virtualenv into global interpreter \n')
ret_code = subprocess.call([VE_GLOBAL_SCRIPT, PROJECT_ROOT])
sys.stdout.write('Installation finished with code {0}. Re-run ./launch.py install \n'.format(ret_code))
sys.exit(ret_code)
if path.exists(root):
shutil.rmtree(root)
virtualenv.logger = virtualenv.Logger(consumers=[])
virtualenv.create_environment(root, site_packages=False)
ret_code = subprocess.call([VE_SCRIPT, PROJECT_ROOT, root, python_version])
sys.exit(ret_code)
def install_virtualenv_p3(root, python_version):
"""Install virtual environment for Python 3.3+; removing the old one if it exists"""
import venv
builder = venv.EnvBuilder(system_site_packages=False, clear=True, symlinks=False, upgrade=False)
builder.create(root)
ret_code = subprocess.call([VE_SCRIPT, PROJECT_ROOT, root, python_version])
sys.exit(ret_code)
def install_virtualenv(parser_args):
""" Installs virtual environment """
sys.stdout.write('Installing virtualenv into {0} \n'.format(VE_ROOT))
python_version = '.'.join(str(v) for v in sys.version_info[:2])
if sys.version_info < (3, 3):
install_virtualenv_p2(VE_ROOT, python_version)
else:
install_virtualenv_p3(VE_ROOT, python_version)
def query_configuration(parser_args):
""" Queries process state """
from synergy.system import process_helper
from synergy.conf import context
process_names = [parser_args.process_name] if parser_args.process_name else context.process_context.keys()
for process_name in process_names:
process_helper.poll_process(process_name)
sys.stdout.write('\n')
def db_command(parser_args):
""" Manages Synergy DB state """
from synergy.db.manager import db_manager
if parser_args.flush:
db_manager.flush_db()
# initialize DB with the context.process_context entries
parser_args.init = True
if parser_args.init:
db_manager.init_db()
def supervisor_command(parser_args):
""" Supervisor-related commands """
import logging
from synergy.supervisor.supervisor_configurator import SupervisorConfigurator, set_box_id
if parser_args.boxid:
set_box_id(logging, parser_args.argument)
return
sc = SupervisorConfigurator()
if parser_args.init:
sc.init_db()
elif parser_args.start:
sc.mark_for_start(parser_args.argument)
elif parser_args.stop:
sc.mark_for_stop(parser_args.argument)
elif parser_args.query:
sc.query()
elif parser_args.init:
sc.init_db()
def start_process(parser_args):
""" Start up specific daemon """
import psutil
import process_starter
from synergy.system import process_helper
try:
pid = process_helper.get_process_pid(parser_args.process_name)
if pid is not None:
if psutil.pid_exists(pid):
message = 'ERROR: Process {0} is already running with pid {1}\n'.format(parser_args.process_name, pid)
sys.stderr.write(message)
sys.exit(1)
if not parser_args.console:
# this block triggers if the options.console is not defined or is False
process_helper.start_process(parser_args.process_name, parser_args.extra_parameters)
else:
process_starter.start_by_process_name(parser_args.process_name, parser_args.extra_parameters)
except Exception as e:
sys.stderr.write('Exception on starting {0} : {1}\n'.format(parser_args.process_name, str(e)))
traceback.print_exc(file=sys.stderr)
def stop_process(parser_args):
""" Stop/Kill specific daemon"""
from synergy.system import process_helper
try:
pid = process_helper.get_process_pid(parser_args.process_name)
if pid is None or process_helper.poll_process(parser_args.process_name) is False:
message = 'ERROR: Process {0} is already terminated {1}\n'.format(parser_args.process_name, pid)
sys.stderr.write(message)
sys.exit(1)
process_helper.kill_process(parser_args.process_name)
except Exception as e:
sys.stderr.write('Exception on killing {0} : {1}\n'.format(parser_args.process_name, str(e)))
traceback.print_exc(file=sys.stderr)
def run_shell(parser_args):
"""Run IPython in the virtualenv
http://ipython.org/ipython-doc/stable/interactive/reference.html
"""
from IPython import embed
embed()
def list_processes(parser_args):
from synergy.conf import context
msg = 'List of registered processes: {0} \n'.format(context.process_context.keys())
sys.stdout.write(msg)
def load_all_tests():
import unittest
from settings import test_cases
return unittest.defaultTestLoader.loadTestsFromNames(test_cases)
def run_tests(parser_args):
import unittest
import logging
import settings
settings.enable_test_mode()
def unittest_main(test_runner=None):
try:
argv = [sys.argv[0]] + parser_args.extra_parameters
unittest.main(module=None, defaultTest='__main__.load_all_tests',
argv=argv, testRunner=test_runner)
except SystemExit as e:
if e.code == 0:
logging.info('PASS')
else:
logging.error('FAIL')
raise
if parser_args.pylint:
from pylint import lint
from pylint.reporters.text import ParseableTextReporter
output = sys.stdout
if parser_args.outfile:
output = open(parser_args.outfile, 'w')
config = "--rcfile=" + path.join(PROJECT_ROOT, 'pylint.rc')
lint.Run([config] + settings.testable_modules,
reporter=ParseableTextReporter(output=output), exit=False)
elif parser_args.xunit:
import xmlrunner
output = 'reports'
if parser_args.outfile:
output = parser_args.outfile
unittest_main(xmlrunner.XMLTestRunner(output=output))
else:
unittest_main(None)
if __name__ == '__main__':
python = get_python()
if path.exists(python):
go_to_ve()
parser = init_parser()
parser_namespace, extra_parameters = parser.parse_known_args()
parser_namespace.extra_parameters = extra_parameters
if parser_namespace.func != install_virtualenv:
# before calling any sub-commands, switch to virtual environment
if path.exists(VE_ROOT):
go_to_ve()
else:
sys.stdout.write('No virtual environment detected. Run ./launch.py install \n')
sys.exit(1)
# calling a function associated with the sub-command in *parser.set_defaults(func=...)*
parser_namespace.func(parser_namespace)