-
Notifications
You must be signed in to change notification settings - Fork 273
/
install.py
561 lines (505 loc) · 20.5 KB
/
install.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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
# -*- coding: utf-8 -*-
# vim: tabstop=4 shiftwidth=4 softtabstop=4
#
# Copyright (C) 2020-2024 GEM Foundation
#
# OpenQuake is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# OpenQuake 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with OpenQuake. If not, see <http://www.gnu.org/licenses/>.
"""
Universal installation script for the OpenQuake engine.
Four installation methods are supported:
1. "server" installation, i.e. system-wide installation on /opt/openquake
2. "devel_server" installation, i.e. developement system-wide installation on
/opt/openquake
3. "user" installation on $HOME/openquake
4. "devel" installation on $HOME/openquake from the engine repository
To disinstall use the --remove flag, which remove the services and the
directories /opt/openquake/venv or $HOME/openquake.
The calculations will NOT be removed since they live in
/opt/openquake/oqdata or $HOME/oqdata.
You have to remove the data directories manually, if you so wish.
"""
import os
import re
import sys
import json
import glob
import shutil
import socket
import getpass
import zipfile
import tempfile
import argparse
import platform
import subprocess
from urllib.request import urlopen
try:
import ensurepip # noqa
except ImportError:
sys.exit("ensurepip is missing; on Ubuntu the solution is to install "
"python3-venv with apt")
try:
import venv
except ImportError:
# check platform
if sys.platform != 'win32':
sys.exit('venv is missing! Please see the documentation of your '
'Operating System to install it')
else:
if os.path.exists('python\\python._pth.old'):
print('This is method of the installation from the installer '
'windows')
else:
sys.exit('venv is missing! Please see the documentation of your '
'Operating System to install it')
PYVER = sys.version_info
if PYVER < (3, 9, 0):
sys.exit('Error: you need at least Python 3.9, but you have %s' %
'.'.join(map(str, sys.version_info)))
CDIR = os.path.dirname(os.path.abspath(__file__))
REMOVE_VENV = '''Found pre-existing venv %s
If you proceeed you will have to reinstall manually any software other
than the engine that you may have there. Proceed? [y/N]'''
class server:
"""
Parameters for a server installation (with root permissions)
"""
VENV = '/opt/openquake/venv'
CFG = os.path.join(VENV, 'openquake.cfg')
OQ = '/usr/bin/oq'
OQL = ['sudo', '-H', '-u', 'openquake', OQ]
OQDATA = '/opt/openquake/oqdata'
DBPATH = os.path.join(OQDATA, 'db.sqlite3')
DBPORT = 1907
CONFIG = '''[dbserver]
host = localhost
port = %d
file = %s
[directory]
''' % (DBPORT, DBPATH)
@classmethod
def exit(cls):
return f'''There is a DbServer running on port {cls.DBPORT} from a
previous installation.
On linux please stop the server with the command
`sudo systemctl stop openquake-dbserver` or `fuser -k {cls.DBPORT}/tcp`
On Windows please use Task Manager to stop the process
On macOS please use Activity Monitor to stop the process'''
class devel_server:
"""
Parameters for a development on server installation (with root permissions)
"""
VENV = '/opt/openquake/venv'
CFG = os.path.join(VENV, 'openquake.cfg')
OQ = '/usr/bin/oq'
OQL = ['sudo', '-H', '-u', 'openquake', OQ]
OQDATA = '/opt/openquake/oqdata'
DBPATH = os.path.join(OQDATA, 'db.sqlite3')
DBPORT = 1907
CONFIG = '''[dbserver]
host = localhost
port = %d
file = %s
[directory]
''' % (DBPORT, DBPATH)
exit = server.exit
class user:
"""
Parameters for a user installation
"""
if sys.platform == 'win32':
if os.path.exists('python\\python._pth.old'):
VENV = r'C:\Program Files\\OpenQuake\\python'
OQ = os.path.join(VENV, '\\Scripts\\oq')
OQDATA = os.path.expanduser('~\\oqdata')
else:
VENV = os.path.expanduser('~\\openquake')
OQ = os.path.join(VENV, '\\Scripts\\oq')
OQDATA = os.path.expanduser('~\\oqdata')
else:
VENV = os.path.expanduser('~/openquake')
OQ = os.path.join(VENV, '/bin/oq')
OQDATA = os.path.expanduser('~/oqdata')
CFG = os.path.join(VENV, 'openquake.cfg')
DBPATH = os.path.join(OQDATA, 'db.sqlite3')
DBPORT = 1908
CONFIG = ''
@classmethod
def exit(cls):
return f'''There is a DbServer running on port {cls.DBPORT} from a
previous installation. Please stop the server with the command
`oq dbserver stop` or set a different port with the --port option'''
class devel(user):
"""
Parameters for a devel installation (same as user)
"""
exit = user.exit
PACKAGES = '''It looks like you have an installation from packages.
Please remove it with `sudo apt remove oq-python38` on Debian derivatives
or with `sudo yum remove python3-oq-engine` on Red Hat derivatives.
Then give the command `sudo rm -rf /opt/openquake /etc/openquake/openquake.cfg`
'''
SERVICE = '''\
[Unit]
Description=The OpenQuake Engine {service}
Documentation=https://github.com/gem/oq-engine/
After= {afterservice}
[Service]
User=openquake
Group=openquake
Environment=
WorkingDirectory={OQDATA}
ExecStart=/opt/openquake/venv/bin/oq {command}
Restart=always
RestartSec=30
KillMode=control-group
TimeoutStopSec=10
[Install]
WantedBy=multi-user.target
'''
PLATFORM = {'linux': ('linux64',), # from sys.platform to requirements.txt
'darwin': ('macos',),
'win32': ('win64',)}
DEMOS = 'https://artifacts.openquake.org/travis/demos-master.zip'
GITBRANCH = 'https://github.com/gem/oq-engine/archive/%s.zip'
URL_STANDALONE = "https://wheelhouse.openquake.org/py/standalone/latest/"
def ensure(pip=None, pyvenv=None):
"""
Create venv and install pip
"""
try:
if pyvenv:
if os.path.exists(pyvenv):
answer = input(REMOVE_VENV % pyvenv)
if answer.lower() == 'y':
shutil.rmtree(pyvenv)
else:
sys.exit(0)
venv.EnvBuilder(with_pip=True).create(pyvenv)
else:
subprocess.check_call([pip, '-m', 'ensurepip', '--upgrade'])
except subprocess.CalledProcessError as exc:
if 'died with <Signals.SIGABRT' in str(exc):
shutil.rmtree(inst.VENV)
raise RuntimeError(
'Could not execute ensurepip --upgrade: %s'
% ('Probably you are using the system Python (%s)'
% sys.executable))
def get_requirements_branch(version, inst, from_fork):
"""
Convert "version" into a branch name
"""
# in actions triggered by forks we want requirements to be taken from
# master
if from_fork:
return 'master'
# in cases such as 'install.py user', for instance while running tests from
# another gem repository, we need requirements to be read from the latest
# stable version unless differently specified.
if version is None:
if (inst is devel or inst is devel_server):
return 'master'
# retrieve the tag name of the current stable version
with urlopen('https://pypi.org/pypi/openquake.engine/json') as resp:
content = resp.read()
stable_version_number = json.loads(content)['info']['version']
stable_version_tag_name = f'v{stable_version_number}'
return stable_version_tag_name
mo = re.match(r'(\d+\.\d+)+', version)
if mo:
return 'engine-' + mo.group(0)
else:
return version
def install_standalone(venv):
"""
Install the standalone Django applications if possible
"""
print("The standalone applications are not installed yet")
if sys.platform == 'win32':
if os.path.exists('python\\python._pth.old'):
pycmd = inst.VENV + '\\python.exe'
else:
pycmd = inst.VENV + '\\Scripts\\python.exe'
else:
pycmd = inst.VENV + '/bin/python3'
for app in ['oq-platform-standalone',
'oq-platform-ipt',
'oq-platform-taxonomy',
'oq-platform-taxtweb',
'openquake.taxonomy']:
try:
print("Applications " + app + " are not installed yet \n")
subprocess.check_call([pycmd, '-m', 'pip', 'install',
'--find-links', URL_STANDALONE, app])
except Exception as exc:
print('%s: could not install %s' % (exc, app))
def before_checks(inst, venv, port, remove, usage):
"""
Checks to perform before the installation
"""
if venv:
inst.VENV = os.path.abspath(os.path.expanduser(venv))
if port:
inst.DBPORT = int(port)
# check platform
if ((inst is server and sys.platform != 'linux') or (
inst is devel_server and sys.platform != 'linux')):
sys.exit('Error: this installation method is meant for linux!')
# check venv
if sys.prefix != sys.base_prefix:
sys.exit('You are inside a virtual environment! Please deactivate')
# check user
user = getpass.getuser()
if ((inst is server and user != 'root') or (
inst is devel_server and user != 'root')):
sys.exit('Error: you cannot perform a server or devel_server '
'installation unless '
'you are root. If you do not have root permissions, you '
'can install the engine in user mode.\n\n' + usage)
elif ((inst is user and user == 'root') or (
inst is devel and user == 'root')):
sys.exit('Error: you cannot perform a user or devel installation'
' as root.')
# check if there is a DbServer running
if not remove:
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
try:
errcode = sock.connect_ex(('localhost', inst.DBPORT))
finally:
sock.close()
if errcode == 0: # no error, the DbServer is up
inst.exit()
# check if there is an installation from packages
if inst in (server, devel_server) and os.path.exists(
'/etc/openquake/openquake.cfg'):
sys.exit(PACKAGES)
if ((inst is server and os.path.exists(inst.OQ) and
os.readlink(inst.OQ) != '%s/bin/oq' % inst.VENV) or
(inst is devel_server and os.path.exists(inst.OQ) and
os.readlink(inst.OQ) != '%s/bin/oq' % inst.VENV)):
sys.exit('Error: there is already a link %s->%s; please remove it' %
(inst.OQ, os.readlink(inst.OQ)))
# this is only called for user or server installations
def latest_commit(branch):
url = 'https://api.github.com/repos/GEM/oq-engine/commits/' + branch
with urlopen(url) as f:
js = json.loads(f.read())
return js['sha']
def fix_version(commit, venv):
"""
Fix the file baselib/__init__.py with the git version
"""
if sys.platform == 'win32':
path = '/lib/site-packages/openquake/baselib/__init__.py'
else:
path = '/lib/python*/site-packages/openquake/baselib/__init__.py'
[fname] = glob.glob(venv + path)
lines = []
for line in open(fname):
if line.startswith('__version__ = ') and '-git' not in line:
vers = line.split('=')[1].strip()[1:-1] # i.e. '3.12.0'
lines.append('__version__ = "%s-git%s"\n' % (vers, commit))
else:
lines.append(line)
with open(fname, 'w') as f:
f.write(''.join(lines))
def install(inst, version, from_fork):
"""
Install the engine in one of the three possible modes
"""
if inst is server or inst is devel_server:
import pwd
# create the openquake user if necessary
try:
pwd.getpwnam('openquake')
except KeyError:
subprocess.check_call(['useradd', '-m', '-U', 'openquake'])
print('Created user openquake')
# create the database
if not os.path.exists(inst.OQDATA):
os.makedirs(inst.OQDATA)
if inst is server or inst is devel_server:
subprocess.check_call(['chown', 'openquake', inst.OQDATA])
# recreate the openquake venv
ensure(pyvenv=inst.VENV)
print('Created %s' % inst.VENV)
if sys.platform == 'win32':
if os.path.exists('python\\python._pth.old'):
pycmd = inst.VENV + '\\python.exe'
else:
pycmd = inst.VENV + '\\Scripts\\python.exe'
else:
pycmd = inst.VENV + '/bin/python3'
# upgrade pip and before check that it is installed in venv
if sys.platform != 'win32':
ensure(pip=pycmd)
subprocess.check_call([pycmd, '-m', 'pip', 'install', '--upgrade',
'pip', 'wheel'])
else:
if os.path.exists('python\\python._pth.old'):
subprocess.check_call([pycmd, '-m', 'pip', 'install', '--upgrade',
'pip', 'wheel', 'urllib3'])
else:
subprocess.check_call([pycmd, '-m', 'ensurepip', '--upgrade'])
subprocess.check_call([pycmd, '-m', 'pip', 'install', '--upgrade',
'pip', 'wheel', 'urllib3'])
# install the requirements
branch = get_requirements_branch(version, inst, from_fork)
if sys.platform == 'darwin':
mac = '_' + platform.machine(), # x86_64 or arm64
else:
mac = '',
req = f'https://raw.githubusercontent.com/gem/oq-engine/{branch}/' \
'requirements-py%d%d-%s%s.txt' % (
PYVER[:2] + PLATFORM[sys.platform] + mac)
subprocess.check_call(
[pycmd, '-m', 'pip', 'install',
'--trusted-host', 'wheelhouse.openquake.org',
'--trusted-host', 'raw.githubusercontent.com',
'-r', req])
if (inst is devel or inst is devel_server): # install from the local repo
subprocess.check_call([pycmd, '-m', 'pip', 'install', '-e', CDIR])
elif version is None: # install the stable version
subprocess.check_call([pycmd, '-m', 'pip', 'install',
'--upgrade', 'openquake.engine'])
elif re.match(r'\d+(\.\d+)+', version): # install an official version
subprocess.check_call([pycmd, '-m', 'pip', 'install',
'--upgrade', 'openquake.engine==' + version])
else: # install a branch from github (only for user or server)
commit = latest_commit(version)
print('Installing commit', commit)
subprocess.check_call([pycmd, '-m', 'pip', 'install',
'--upgrade', GITBRANCH % commit])
fix_version(commit, inst.VENV)
install_standalone(inst.VENV)
# create openquake.cfg
if (inst is server or inst is devel_server):
if os.path.exists(inst.CFG):
print('There is an old file %s; it will not be overwritten, '
'but consider updating it with\n%s' %
(inst.CFG, inst.CONFIG))
else:
with open(inst.CFG, 'w') as cfg:
cfg.write(inst.CONFIG)
print('Created %s' % inst.CFG)
# create symlink to oq
oqreal = '%s/bin/oq' % inst.VENV
if sys.platform == 'win32':
oqreal = '%s\\Scripts\\oq' % inst.VENV
else:
oqreal = '%s/bin/oq' % inst.VENV
print('Compiling python/numba modules')
subprocess.run([oqreal, '--version']) # compile numba
if inst in (user, devel): # create/upgrade the db in the default location
# do not stop if `oq dbserver upgrade` is missing (versions < 3.15)
subprocess.run([oqreal, 'dbserver', 'upgrade'])
if (inst is server and not os.path.exists(inst.OQ) or
inst is devel_server and not os.path.exists(inst.OQ)):
os.symlink(oqreal, inst.OQ)
if sys.platform == 'win32' and inst in (user, devel):
print(f'Please activate the virtualenv with {inst.VENV}'
f'\\Scripts\\activate.bat (in CMD) or {inst.VENV}'
'\\Scripts\\activate.ps1 (in PowerShell)')
elif inst in (user, devel):
print(f'Please activate the venv with source {inst.VENV}'
'/bin/activate')
# create systemd services
if ((inst is server and os.path.exists('/run/systemd/system')) or
(inst is devel_server and os.path.exists('/run/systemd/system'))):
for service in ['dbserver', 'webui']:
service_name = 'openquake-%s.service' % service
service_path = '/etc/systemd/system/' + service_name
afterservice = 'network.target'
command = service + ' start -f'
if 'webui' in service:
afterservice = 'network.target openquake-dbserver.service'
command = service + ' -s start'
if not os.path.exists(service_path):
with open(service_path, 'w') as f:
srv = SERVICE.format(service=service, OQDATA=inst.OQDATA,
afterservice=afterservice,
command=command)
f.write(srv)
subprocess.check_call(
['systemctl', 'enable', '--now', service_name])
subprocess.check_call(['systemctl', 'start', service_name])
if inst in (user, server):
# download and unzip the demos
try:
with urlopen(DEMOS) as f:
data = f.read()
except OSError:
msg = 'However, we could not download the demos from %s' % DEMOS
else:
th, tmp = tempfile.mkstemp(suffix='.zip')
with os.fdopen(th, 'wb') as t:
t.write(data)
zipfile.ZipFile(tmp).extractall(inst.VENV)
os.remove(tmp)
path = os.path.join(inst.VENV, 'demos', 'hazard',
'AreaSourceClassicalPSHA', 'job.ini')
msg = ('You can run a test calculation with the command\n'
f'{oqreal} engine --run {path}')
print('The engine was installed successfully.\n' + msg)
def remove(inst):
"""
Remove the virtualenv directory. In case of a server installation, also
remove the systemd services.
"""
if inst is server or inst is devel_server:
for service in ['dbserver', 'webui']:
service_name = 'openquake-%s.service' % service
service_path = '/etc/systemd/system/' + service_name
if os.path.exists(service_path):
subprocess.check_call(['systemctl', 'stop', service_name])
print('stopped ' + service_name)
os.remove(service_path)
print('removed ' + service_name)
subprocess.check_call(['systemctl', 'daemon-reload'])
shutil.rmtree(inst.VENV)
print('%s has been removed' % inst.VENV)
if inst is server and os.path.exists(server.OQ) or (
inst is devel_server and os.path.exists(server.OQ)):
os.remove(server.OQ)
print('%s has been removed' % server.OQ)
if __name__ == '__main__':
parser = argparse.ArgumentParser(
description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument("inst",
choices=['server', 'user', 'devel', 'devel_server'],
nargs='?',
help='the kind of installation you want')
parser.add_argument("--venv", help="venv directory")
parser.add_argument("--remove", action="store_true",
help="disinstall the engine")
parser.add_argument("--version",
help="version to install (default stable)")
parser.add_argument("--dbport",
help="DbServer port (default 1907 or 1908)")
# NOTE: This flag should be set when installing the engine from an action
# triggered by a fork
parser.add_argument("--from_fork", dest='from_fork', action='store_true',
help=argparse.SUPPRESS)
parser.set_defaults(from_fork=False)
args = parser.parse_args()
if args.inst:
inst = globals()[args.inst]
before_checks(inst, args.venv, args.dbport, args.remove,
parser.format_usage())
if args.remove:
remove(inst)
else:
install(inst, args.version, args.from_fork)
else:
sys.exit("Please specify the kind of installation")