/usr/lib/python3/dist-packages/biomaj/workflow.py is in python3-biomaj3 3.1.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 | from builtins import str
from builtins import range
from builtins import object
import logging
import datetime
import time
import os
import shutil
import tempfile
import re
import traceback
import json
import hashlib
from biomaj_core.utils import Utils
from biomaj_download.downloadclient import DownloadClient
from biomaj_download.message import message_pb2
from biomaj_download.download.http import HTTPParse
from biomaj_download.download.localcopy import LocalDownload
from biomaj.mongo_connector import MongoConnector
from biomaj.options import Options
from biomaj.process.processfactory import RemoveProcessFactory, PreProcessFactory, PostProcessFactory
from biomaj_zipkin.zipkin import Zipkin
class Workflow(object):
"""
Bank update workflow
"""
FLOW_INIT = 'init'
FLOW_CHECK = 'check'
FLOW_DEPENDS = 'depends'
FLOW_PREPROCESS = 'preprocess'
FLOW_RELEASE = 'release'
FLOW_DOWNLOAD = 'download'
FLOW_POSTPROCESS = 'postprocess'
FLOW_REMOVEPROCESS = 'removeprocess'
FLOW_PUBLISH = 'publish'
FLOW_OVER = 'over'
FLOW = [
{'name': 'init', 'steps': []},
{'name': 'check', 'steps': []},
{'name': 'over', 'steps': []}
]
def __init__(self, bank, session=None):
"""
Instantiate a new workflow
:param bank: bank on which to apply the workflow
:type bank: :class:`biomaj.bank.Bank`
"""
self.bank = bank
if session is None:
self.session = bank.session
else:
self.session = session
self.bank.session = session
self.options = bank.options
self.name = bank.name
# Skip all remaining tasks, no need to update
self.skip_all = False
self.session._session['update'] = False
self.session._session['remove'] = False
self.session.config.set('localrelease', '')
self.session.config.set('remoterelease', '')
# For micro services
self.redis_client = None
self.redis_prefix = None
# Zipkin
self.span = None
def get_flow(self, task):
for flow in Workflow.FLOW:
if flow['name'] == task:
return flow
def start(self):
"""
Start the workflow
"""
logging.info('Workflow:Start')
if 'stats' not in self.session._session:
self.session._session['stats'] = {
'workflow': {},
'nb_downloaded_files': 0
}
for flow in self.session.flow:
dt = datetime.datetime.now()
start_timestamp = time.mktime(dt.timetuple())
if self.skip_all:
logging.info('Workflow:Skip:' + flow['name'])
self.session._session['status'][flow['name']] = None
self.session._session['status'][Workflow.FLOW_OVER] = True
continue
if self.options.get_option(Options.STOP_BEFORE) == flow['name']:
self.wf_over()
break
# Check for cancel request
if self.redis_client and self.redis_client.get(self.redis_prefix + ':' + self.bank.name + ':action:cancel'):
logging.warn('Cancel requested, stopping update')
self.redis_client.delete(self.redis_prefix + ':' + self.bank.name + ':action:cancel')
self.wf_over()
return False
# Always run INIT
if flow['name'] != Workflow.FLOW_INIT and self.session.get_status(flow['name']):
logging.info('Workflow:Skip:' + flow['name'])
if flow['name'] == Workflow.FLOW_INIT or not self.session.get_status(flow['name']):
logging.info('Workflow:Start:' + flow['name'])
span = None
if self.options.get_option('traceId'):
trace_id = self.options.get_option('traceId')
span_id = self.options.get_option('spanId')
span = Zipkin('biomaj-workflow', flow['name'], trace_id=trace_id, parent_id=span_id)
self.span = span
self.bank.config.set('zipkin_trace_id', span.get_trace_id())
self.bank.config.set('zipkin_span_id', span.get_span_id())
try:
self.session._session['status'][flow['name']] = getattr(self, 'wf_' + flow['name'])()
except Exception as e:
self.session._session['status'][flow['name']] = False
logging.exception('Workflow:' + flow['name'] + ':Exception:' + str(e))
logging.debug(traceback.format_exc())
finally:
self.wf_progress(flow['name'], self.session._session['status'][flow['name']])
if span:
span.add_binary_annotation('status', str(self.session._session['status'][flow['name']]))
span.trace()
if flow['name'] != Workflow.FLOW_OVER and not self.session.get_status(flow['name']):
logging.error('Error during task ' + flow['name'])
if flow['name'] != Workflow.FLOW_INIT:
self.wf_over()
return False
# Main task is over, execute sub tasks of main
if not self.skip_all:
for step in flow['steps']:
span = None
try:
# Check for cancel request
if self.redis_client and self.redis_client.get(self.redis_prefix + ':' + self.bank.name + ':action:cancel'):
logging.warn('Cancel requested, stopping update')
self.redis_client.delete(self.redis_prefix + ':' + self.bank.name + ':action:cancel')
self.wf_over()
return False
if self.options.get_option('traceId'):
trace_id = self.options.get_option('traceId')
span_id = self.options.get_option('spanId')
span = Zipkin('biomaj-workflow', flow['name'] + ":wf_" + step, trace_id=trace_id, parent_id=span_id)
self.span = span
self.bank.config.set('zipkin_trace_id', span.get_trace_id())
self.bank.config.set('zipkin_span_id', span.get_span_id())
res = getattr(self, 'wf_' + step)()
if span:
span.add_binary_annotation('status', str(res))
span.trace()
if not res:
logging.error('Error during ' + flow['name'] + ' subtask: wf_' + step)
logging.error('Revert main task status ' + flow['name'] + ' to error status')
self.session._session['status'][flow['name']] = False
self.wf_over()
return False
except Exception as e:
logging.error('Workflow:' + flow['name'] + ' subtask: wf_' + step + ':Exception:' + str(e))
self.session._session['status'][flow['name']] = False
logging.debug(traceback.format_exc())
self.wf_over()
return False
dt = datetime.datetime.now()
end_timestamp = time.mktime(dt.timetuple())
self.session._session['stats']['workflow'][flow['name']] = end_timestamp - start_timestamp
if self.options.get_option(Options.STOP_AFTER) == flow['name']:
self.wf_over()
break
self.wf_progress_end()
return True
def wf_progress_init(self):
"""
Set up new progress status
"""
status = {}
status['log_file'] = {'status': self.session.config.log_file, 'progress': 0}
status['session'] = self.session._session['id']
for flow in self.session.flow:
if flow['name'] == 'download':
status[flow['name']] = {'status': None, 'progress': 0, 'total': 0}
elif flow['name'].endswith('process'):
status[flow['name']] = {'status': None, 'progress': {}}
elif flow['name'] == 'release':
status[flow['name']] = {'status': None, 'progress': ''}
else:
status[flow['name']] = {'status': None, 'progress': 0}
MongoConnector.banks.update({'name': self.name}, {'$set': {'status': status}})
def wf_progress_end(self):
"""
Reset progress status when workflow is over
"""
return True
def wf_progress(self, task, status):
"""
Update bank status
"""
subtask = 'status.' + task + '.status'
MongoConnector.banks.update({'name': self.name}, {'$set': {subtask: status}})
def wf_init(self):
"""
Initialize workflow
"""
logging.info('Workflow:wf_init')
data_dir = self.session.config.get('data.dir')
lock_dir = self.session.config.get('lock.dir', default=data_dir)
if not os.path.exists(lock_dir):
os.mkdir(lock_dir)
lock_file = os.path.join(lock_dir, self.name + '.lock')
maintenance_lock_file = os.path.join(lock_dir, 'biomaj.lock')
if os.path.exists(maintenance_lock_file):
logging.error('Biomaj is in maintenance')
return False
if os.path.exists(lock_file):
logging.error('Bank ' + self.name + ' is locked, a process may be in progress, else remove the lock file ' + lock_file)
return False
f = open(lock_file, 'w')
f.write('1')
f.close()
self.wf_progress_init()
return True
def wf_over(self):
"""
Workflow is over
"""
logging.info('Workflow:wf_over')
data_dir = self.session.config.get('data.dir')
lock_dir = self.session.config.get('lock.dir', default=data_dir)
lock_file = os.path.join(lock_dir, self.name + '.lock')
os.remove(lock_file)
return True
class RemoveWorkflow(Workflow):
"""
Workflow to remove a bank instance
"""
FLOW = [
{'name': 'init', 'steps': []},
{'name': 'removeprocess', 'steps': []},
{'name': 'remove_release', 'steps': []},
{'name': 'over', 'steps': []}
]
def __init__(self, bank, session):
"""
Instantiate a new workflow
:param bank: bank on which to apply the workflow
:type bank: Bank
:param session: session to remove
:type session: :class:`biomaj.session.Session`
"""
Workflow.__init__(self, bank, session)
logging.debug('New workflow')
self.session._session['remove'] = True
def wf_remove_release(self):
logging.info('Workflow:wf_remove_release')
if not self.session.get('update_session_id'):
logging.error('Bug: update_session_id not set in session')
return False
if os.path.exists(self.session.get_full_release_directory()):
shutil.rmtree(self.session.get_full_release_directory())
return self.bank.remove_session(self.session.get('update_session_id'))
def wf_removeprocess(self):
logging.info('Workflow:wf_removepreprocess')
metas = self.session._session['process']['removeprocess']
pfactory = RemoveProcessFactory(self.bank, metas, redis_client=self.redis_client, redis_prefix=self.redis_prefix)
res = pfactory.run()
self.session._session['process']['removeprocess'] = pfactory.meta_status
return res
class UpdateWorkflow(Workflow):
"""
Workflow for a bank update
"""
FLOW = [
{'name': 'init', 'steps': []},
{'name': 'check', 'steps': []},
{'name': 'depends', 'steps': []},
{'name': 'preprocess', 'steps': []},
{'name': 'release', 'steps': []},
{'name': 'download', 'steps': ['checksum', 'uncompress', 'copy', 'copydepends']},
{'name': 'postprocess', 'steps': ['metadata', 'stats']},
{'name': 'publish', 'steps': ['old_biomaj_api', 'clean_offline', 'delete_old', 'clean_old_sessions']},
{'name': 'over', 'steps': []}
]
def __init__(self, bank):
"""
Instantiate a new workflow
:param bank: bank on which to apply the workflow
:type bank: Bank
"""
Workflow.__init__(self, bank)
logging.debug('New workflow')
self.session._session['update'] = True
def wf_init(self):
err = super(UpdateWorkflow, self).wf_init()
if not err:
return False
offline_dir = self.session.get_offline_directory()
if not os.path.exists(offline_dir):
logging.debug('Create offline directory: %s' % (str(offline_dir)))
os.makedirs(offline_dir)
if self.options.get_option(Options.FROMSCRATCH):
return self.wf_clean_offline()
return True
def _md5(self, fname):
hash_md5 = hashlib.md5()
with open(fname, "rb") as f:
for chunk in iter(lambda: f.read(4096), b""):
hash_md5.update(chunk)
return hash_md5.hexdigest()
def _sha256(self, fname):
hash_sha256 = hashlib.sha256()
with open(fname, "rb") as f:
for chunk in iter(lambda: f.read(4096), b""):
hash_sha256.update(chunk)
return hash_sha256.hexdigest()
def wf_checksum(self):
logging.info('Workflow:wf_checksum')
'''
if self.bank.config.get('file.md5.check', 'false') != 'true':
logging.info('Workflow:wf_checksum:skipping')
return True
'''
offline_dir = self.session.get_offline_directory()
error = False
for downloaded_file in self.downloaded_files:
downloaded_file_name = downloaded_file['name']
if 'save_as' in downloaded_file:
downloaded_file_name = downloaded_file['save_as']
md5_file = os.path.join(offline_dir, downloaded_file_name + '.md5')
if os.path.exists(md5_file):
with open(md5_file, 'r') as md5_content:
data = md5_content.read().split()
md5_cksum = data[0]
downloaded_file_md5 = self._md5(os.path.join(offline_dir, downloaded_file_name))
logging.debug('Wf_checksum:md5:%s:%s:%s' % (downloaded_file_name, downloaded_file_md5, md5_cksum))
if downloaded_file_md5 != md5_cksum:
logging.error('Invalid md5 checksum for file %s' % (downloaded_file_name))
error = True
sha256_file = os.path.join(offline_dir, downloaded_file_name + '.sha256')
if os.path.exists(sha256_file):
with open(sha256_file, 'r') as sha256_content:
data = sha256_content.read().split()
sha256_cksum = data[0]
downloaded_file_sha256 = self._sha256(os.path.join(offline_dir, downloaded_file_name))
logging.debug('Wf_checksum:sha256:%s:%s:%s' % (downloaded_file_name, downloaded_file_sha256, sha256_cksum))
if downloaded_file_sha256 != sha256_cksum:
logging.error('Invalid sha256 checksum for file %s' % (downloaded_file_name))
error = True
if error:
return False
return True
def wf_check(self):
"""
Basic checks
"""
logging.info('Workflow:wf_check')
return True
def wf_depends(self):
"""
Checks bank dependencies with other banks. If bank has dependencies, execute update on other banks first
"""
logging.info('Workflow:wf_depends')
# Always rescan depends, there might be a new release
self.session.set('depends', {})
res = self.bank.update_dependencies()
logging.info('Workflow:wf_depends:' + str(res))
if res and len(self.bank.depends) > 0:
depend_updated = False
for bdep in self.bank.depends:
logging.info('Workflow:wf_depends:' + bdep.name + ':' + str(bdep.session.get('update')))
if bdep.session.get('update'):
depend_updated = True
break
if not depend_updated:
logging.info('Workflow:wf_depends:no bank updated')
return res
def wf_copydepends(self):
"""
Copy files from dependent banks if needed
"""
logging.info('Workflow:wf_copydepends')
deps = self.bank.get_dependencies()
for dep in deps:
if self.bank.config.get(dep + '.files.move'):
logging.info('Worflow:wf_depends:Files:Move:' + self.bank.config.get(dep + '.files.move'))
bdir = None
for bdep in self.bank.depends:
if bdep.name == dep:
bdir = bdep.session.get_full_release_directory()
break
if bdir is None:
logging.error('Could not find a session update for bank ' + dep)
return False
# b = self.bank.get_bank(dep, no_log=True)
locald = LocalDownload(bdir)
(file_list, dir_list) = locald.list()
locald.match(self.bank.config.get(dep + '.files.move').split(), file_list, dir_list)
bankdepdir = self.bank.session.get_full_release_directory() + "/" + dep
if not os.path.exists(bankdepdir):
os.mkdir(bankdepdir)
downloadedfiles = locald.download(bankdepdir)
locald.close()
if not downloadedfiles:
logging.info('Workflow:wf_copydepends:no files to copy')
return False
return True
def wf_preprocess(self):
"""
Execute pre-processes
"""
logging.info('Workflow:wf_preprocess')
metas = self.session._session['process']['preprocess']
pfactory = PreProcessFactory(self.bank, metas, redis_client=self.redis_client, redis_prefix=self.redis_prefix)
res = pfactory.run()
self.session._session['process']['preprocess'] = pfactory.meta_status
return res
def _close_download_service(self, dserv):
'''
Cleanup of downloader
'''
logging.info("Workflow:DownloadService:CleanSession")
if dserv:
dserv.clean()
dserv.close()
def __update_info(self, info):
'''
Update some info in db for current bank
'''
if info is not None:
MongoConnector.banks.update({'name': self.bank.name},
info)
def wf_release(self):
"""
Find current release on remote
"""
logging.info('Workflow:wf_release')
cf = self.session.config
if cf.get('ref.release') and self.bank.depends:
# Bank is a computed bank and we ask to set release to the same
# than an other dependant bank
depbank = self.bank.get_bank(cf.get('ref.release'), no_log=True)
got_match = False
got_update = False
for dep in self.bank.depends:
if dep.session.get('update'):
got_update = True
if dep.name == depbank.name:
self.session.set('release', dep.session.get('release'))
self.session.set('remoterelease', dep.session.get('remoterelease'))
got_match = True
if not got_match:
logging.error('Workflow:wf_release: no release found for bank ' + depbank.name)
return False
release = self.session.get('release')
self.__update_info({'$set': {'status.release.progress': str(release)}})
'''
MongoConnector.banks.update({'name': self.bank.name},
{'$set': {'status.release.progress': str(release)}})
'''
logging.info('Workflow:wf_release:FromDepends:' + depbank.name + ':' + self.session.get('release'))
if got_update:
index = 0
# Release directory exits, set index to 1
if os.path.exists(self.session.get_full_release_directory()):
index = 1
for x in range(1, 100):
if os.path.exists(self.session.get_full_release_directory() + '__' + str(x)):
index = x + 1
if index > 0:
self.session.set('release', release + '__' + str(index))
release = release + '__' + str(index)
self.session.previous_release = self.session.get('previous_release')
logging.info('Workflow:wf_release:previous_session:' + str(self.session.previous_release))
if self.session.get('release'):
# Release already set from a previous run or an other bank
logging.info('Workflow:wf_release:session:' + str(self.session.get('release')))
if self.session.previous_release == self.session.get('release') and not self.session.config.get_bool('release.control', default=False):
logging.info('Workflow:wf_release:same_as_previous_session')
return self.no_need_to_update()
else:
return True
if self.session.config.get('release.file') == '' or self.session.config.get('release.file') is None:
logging.debug('Workflow:wf_release:norelease')
self.session.set('release', None)
return True
else:
# """""""""""""""""""""""
dserv = None
if self.bank.config.get('micro.biomaj.service.download', default=None) == '1':
dserv = DownloadClient(
self.bank.config.get('micro.biomaj.rabbit_mq'),
int(self.bank.config.get('micro.biomaj.rabbit_mq_port', default='5672')),
self.bank.config.get('micro.biomaj.rabbit_mq_virtualhost', default='/'),
self.bank.config.get('micro.biomaj.rabbit_mq_user', default=None),
self.bank.config.get('micro.biomaj.rabbit_mq_password', default=None)
)
else:
dserv = DownloadClient()
proxy = self.bank.config.get('micro.biomaj.proxy')
session = dserv.create_session(self.name, proxy)
logging.info("Workflow:wf_release:DownloadSession:" + str(session))
http_parse = HTTPParse(
cf.get('http.parse.dir.line'),
cf.get('http.parse.file.line'),
int(cf.get('http.group.dir.name')),
int(cf.get('http.group.dir.date')),
int(cf.get('http.group.file.name')),
int(cf.get('http.group.file.date')),
cf.get('http.group.file.date_format', default=None),
int(cf.get('http.group.file.size'))
)
proxy = cf.get('proxy')
if cf.get('release.proxy') is not None:
proxy = cf.get('release.proxy')
proxy_auth = cf.get('proxy_auth')
if cf.get('release.proxy_auth') is not None:
proxy = cf.get('release.proxy_auth')
protocol = cf.get('protocol')
if cf.get('release.protocol') is not None:
protocol = cf.get('release.protocol')
server = cf.get('server')
if cf.get('release.server') is not None:
server = cf.get('release.server')
remote_dir = cf.get('remote.dir')
if cf.get('release.remote.dir') is not None:
remote_dir = cf.get('release.remote.dir')
params = None
keys = cf.get('url.params')
if keys is not None:
params = {}
keys = keys.split(',')
for key in keys:
param = cf.get(key.strip() + '.value')
params[key.strip()] = param.strip()
credentials = cf.get('server.credentials')
if cf.get('release.credentials') is not None:
credentials = cf.get('release.credentials')
save_as = None
method = 'GET'
if protocol == 'directhttp' or protocol == 'directhttps' or protocol == 'directftp':
save_as = cf.get('release.file')
remotes = [remote_dir]
remote_dir = '/'
method = cf.get('url.method')
if cf.get('release.url.method') is not None:
method = cf.get('release.url.method')
release_downloader = dserv.get_handler(
protocol,
server,
remote_dir,
credentials=credentials,
http_parse=http_parse,
http_method=method,
param=params,
proxy=proxy,
proxy_auth=proxy_auth,
save_as=save_as,
timeout_download=cf.get('timeout.download'),
offline_dir=self.session.get_offline_directory()
)
if protocol == 'directhttp' or protocol == 'directhttps' or protocol == 'directftp':
release_downloader.set_files_to_download(remotes)
# """"""""""""""""""""""""
if release_downloader is None:
logging.error('Protocol ' + protocol + ' not supported')
self._close_download_service(dserv)
return False
try:
(file_list, dir_list) = release_downloader.list()
except Exception as e:
self._close_download_service(dserv)
logging.exception('Workflow:wf_release:Exception:' + str(e))
return False
release_downloader.match([cf.get('release.file')], file_list, dir_list)
if len(release_downloader.files_to_download) == 0:
logging.error('release.file defined but does not match any file')
self._close_download_service(dserv)
return False
if len(release_downloader.files_to_download) > 1:
logging.error('release.file defined but matches multiple files')
self._close_download_service(dserv)
return False
if cf.get('release.regexp') is None or not cf.get('release.regexp'):
# Try to get from regexp in file name
rel = re.search(cf.get('release.file'), release_downloader.files_to_download[0]['name'])
if rel is None:
logging.error('release.file defined but does not match any file')
self._close_download_service(dserv)
return False
release = rel.group(1)
else:
# Download and extract
tmp_dir = tempfile.mkdtemp('biomaj')
rel_files = release_downloader.download(tmp_dir)
rel_file = open(tmp_dir + '/' + rel_files[0]['name'])
rel_content = rel_file.read()
rel_file.close()
shutil.rmtree(tmp_dir)
rel = re.search(cf.get('release.regexp'), rel_content)
if rel is None:
logging.error('release.regexp defined but does not match any file content')
self._close_download_service(dserv)
return False
# If regexp contains matching group, else take whole match
if len(rel.groups()) > 0:
release = rel.group(1)
else:
release = rel.group(0)
release_downloader.close()
self._close_download_service(dserv)
if release_downloader.error:
logging.error('An error occured during download')
return False
self.session.set('release', release)
self.session.set('remoterelease', release)
self.__update_info({'$set': {'status.release.progress': str(release)}})
'''
MongoConnector.banks.update(
{'name': self.bank.name},
{'$set': {'status.release.progress': str(release)}}
)
'''
# We restart from scratch, a directory with this release already exists
# Check directory existence if from scratch to change local release
if self.options.get_option(Options.FROMSCRATCH):
index = 0
# Release directory exits, set index to 1
if os.path.exists(self.session.get_full_release_directory()):
index = 1
for x in range(1, 100):
if os.path.exists(self.session.get_full_release_directory() + '__' + str(x)):
index = x + 1
if index > 0:
self.session.set('release', release + '__' + str(index))
release = release + '__' + str(index)
self.download_go_ahead = False
if self.options.get_option(Options.FROM_TASK) == 'download':
# We want to download again in same release, that's fine, we do not care it is the same release
self.download_go_ahead = True
if not self.download_go_ahead and self.session.previous_release == self.session.get('remoterelease'):
if not self.session.config.get_bool('release.control', default=False):
logging.info('Workflow:wf_release:same_as_previous_session')
return self.no_need_to_update()
logging.info('Session:RemoteRelease:' + self.session.get('remoterelease'))
logging.info('Session:Release:' + self.session.get('release'))
return True
def no_need_to_update(self):
"""
Set status to over and update = False because there is not a need to update bank
"""
self.skip_all = True
self.session._session['status'][Workflow.FLOW_OVER] = True
self.wf_progress(Workflow.FLOW_OVER, True)
self.session._session['update'] = False
self.session.set('download_files', [])
self.session.set('files', [])
last_session = self.get_last_prod_session_for_release(self.session.get('remoterelease'))
self.session.set('release', last_session['release'])
self.wf_over()
return True
def get_last_prod_session_for_release(self, release):
"""
find last session matching a release in production
"""
last_session = None
for prod in self.bank.bank['production']:
if prod['remoterelease'] == release:
# Search session related to this production release
for s in self.bank.bank['sessions']:
if s['id'] == prod['session']:
last_session = s
break
return last_session
def _load_local_files_from_session(self, session_id):
"""
Load lccal files for sessions from cache directory
"""
cache_dir = self.bank.config.get('cache.dir')
f_local_files = None
file_path = os.path.join(cache_dir, 'local_files_' + str(session_id))
if not os.path.exists(file_path):
return f_local_files
with open(file_path) as data_file:
f_local_files = json.load(data_file)
return f_local_files
def _load_download_files_from_session(self, session_id):
"""
Load download files for sessions from cache directory
"""
cache_dir = self.bank.config.get('cache.dir')
f_downloaded_files = None
file_path = os.path.join(cache_dir, 'files_' + str(session_id))
if not os.path.exists(file_path):
return f_downloaded_files
with open(file_path) as data_file:
f_downloaded_files = json.load(data_file)
return f_downloaded_files
def is_previous_release_content_identical(self):
"""
Checks if releases (previous_release and remoterelease) are identical in release id and content.
Expects release.control parameter to be set to true or 1, else skip control.
"""
if not self.session.config.get_bool('release.control', default=False):
return True
# Different releases, so different
if self.session.get('remoterelease') != self.session.previous_release:
logging.info('Workflow:wf_download:DifferentRelease')
return False
# Same release number, check further
previous_release_session = self.get_last_prod_session_for_release(self.session.previous_release)
if previous_release_session is None:
return False
previous_downloaded_files = self._load_download_files_from_session(previous_release_session.get('id'))
previous_release_session['download_files'] = previous_downloaded_files
if previous_downloaded_files is None:
# No info on previous download, consider that base release is enough
logging.warn('Workflow:wf_download:SameRelease:download_files not available, cannot compare to previous release')
return True
nb_elts = len(previous_downloaded_files)
if self.session.get('download_files') is not None and nb_elts != len(self.session.get('download_files')):
# Number of files to download vs previously downloaded files differ
logging.info('Workflow:wf_download:SameRelease:Number of files differ')
return False
# Same number of files, check hash of files
list1 = sorted(previous_downloaded_files, key=lambda k: k['hash'])
list2 = sorted(self.session.get('download_files'), key=lambda k: k['hash'])
for index in range(0, nb_elts):
if list1[index]['hash'] != list2[index]['hash']:
return False
return True
def check_and_incr_release(self):
"""
Checks if local release already exists on disk. If it exists, create a new
local release, appending __X to the release.
:returns: str local release
"""
index = 0
release = self.session.get('release')
# Release directory exits, set index to 1
if os.path.exists(self.session.get_full_release_directory()):
index = 1
for x in range(1, 100):
if os.path.exists(self.session.get_full_release_directory() + '__' + str(x)):
index = x + 1
# If we found a directory for this release: XX or XX__Y
if index > 0:
self.session.set('release', release + '__' + str(index))
release = release + '__' + str(index)
logging.info('Workflow:wf_download:release:incr_release:' + release)
return release
def _create_dir_structure(self, downloader, offline_dir):
"""
Create expected directory structure in offline directory before download
"""
logging.debug('Workflow:wf_download:create_dir_structure:start')
for rfile in downloader.files_to_download:
save_as = None
if 'save_as' not in rfile or rfile['save_as'] is None:
save_as = rfile['name']
else:
save_as = rfile['save_as']
file_dir = offline_dir + '/' + os.path.dirname(save_as)
try:
if not os.path.exists(file_dir):
os.makedirs(file_dir)
except Exception as e:
logging.error(e)
logging.debug('Workflow:wf_download:create_dir_structure:done')
def _get_list_from_file(self, remote_list):
"""
Load files to download from a file
"""
if not os.path.exists(remote_list):
logging.info("remote.list " + remote_list + " does not exists, we suppose there is no new release available")
return None
data = []
with open(remote_list) as data_file:
data = json.load(data_file)
for rfile in data:
if 'year' not in rfile or 'month' not in rfile or 'day' not in rfile:
today = datetime.date.today()
rfile['month'] = today.month
rfile['day'] = today.day
rfile['year'] = today.year
if 'permissions' not in rfile:
rfile['permissions'] = ''
if 'group' not in rfile:
rfile['group'] = ''
if 'size' not in rfile:
rfile['size'] = 0
if 'hash' not in rfile:
rfile['hash'] = None
if 'root' not in rfile and self.session.config.get('remote.dir'):
rfile['root'] = self.session.config.get('remote.dir')
return data
def wf_download(self):
"""
Download remote files or use an available local copy from last production directory if possible.
"""
logging.info('Workflow:wf_download')
# flow = self.get_flow(Workflow.FLOW_DOWNLOAD)
downloader = None
cf = self.session.config
self.session.previous_release = self.session.get('previous_release')
if self.session.get('release') is not None:
self.session.config.set('localrelease', self.session.get('release'))
self.session.config.set('remoterelease', self.session.get('remoterelease'))
if self.session.config.get_bool('releaseonly', default=False):
return True
if cf.get('protocol') == 'none':
if self.session.get('release') is None:
logging.error('Workflow:wf_download:no download file but no release found')
return False
else:
logging.info('Workflow:wf_download:no download file expected')
self.downloaded_files = []
if not os.path.exists(self.session.get_full_release_directory()):
os.makedirs(self.session.get_full_release_directory())
return True
downloaders = []
pool_size = self.session.config.get('files.num.threads', default=None)
dserv = None
if self.bank.config.get('micro.biomaj.service.download', default=None) == '1':
dserv = DownloadClient(
self.bank.config.get('micro.biomaj.rabbit_mq'),
int(self.bank.config.get('micro.biomaj.rabbit_mq_port', default='5672')),
self.bank.config.get('micro.biomaj.rabbit_mq_virtualhost', default='/'),
self.bank.config.get('micro.biomaj.rabbit_mq_user', default=None),
self.bank.config.get('micro.biomaj.rabbit_mq_password', default=None),
)
else:
dserv = DownloadClient()
if pool_size:
dserv.set_queue_size(int(pool_size))
proxy = self.bank.config.get('micro.biomaj.proxy')
session = dserv.create_session(self.name, proxy)
logging.info("Workflow:wf_download:DownloadSession:" + str(session))
use_remote_list = False
http_parse = HTTPParse(
cf.get('http.parse.dir.line'),
cf.get('http.parse.file.line'),
int(cf.get('http.group.dir.name')),
int(cf.get('http.group.dir.date')),
int(cf.get('http.group.file.name')),
int(cf.get('http.group.file.date')),
cf.get('http.group.file.date_format', default=None),
int(cf.get('http.group.file.size'))
)
proxy = cf.get('proxy')
proxy_auth = cf.get('proxy_auth')
if cf.get('protocol') == 'multi':
"""
Search for:
protocol = multi
remote.file.0.protocol = directftp
remote.file.0.server = ftp.ncbi.org
remote.file.0.path = /musmusculus/chr1/chr1.fa
=> http://ftp2.fr.debian.org/debian/README.html?key1=value&key2=value2
remote.file.1.protocol = directhttp
remote.file.1.server = ftp2.fr.debian.org
remote.file.1.path = debian/README.html
remote.file.1.method = GET
remote.file.1.params.keys = key1,key2
remote.file.1.params.key1 = value1
remote.file.1.params.key2 = value2
=> http://ftp2.fr.debian.org/debian/README.html
#POST PARAMS:
key1=value
key2=value2
remote.file.1.protocol = directhttp
remote.file.1.server = ftp2.fr.debian.org
remote.file.1.path = debian/README.html
remote.file.1.method = POST
remote.file.1.params.keys = key1,key2
remote.file.1.params.key1 = value1
remote.file.1.params.key2 = value2
......
"""
# Creates multiple downloaders
i = 0
rfile = cf.get('remote.file.' + str(i) + '.path')
server = None
while rfile is not None:
protocol = cf.get('protocol')
if cf.get('remote.file.' + str(i) + '.protocol') is not None:
protocol = cf.get('remote.file.' + str(i) + '.protocol')
server = cf.get('server')
if cf.get('remote.file.' + str(i) + '.server') is not None:
server = cf.get('remote.file.' + str(i) + '.server')
params = None
keys = cf.get('remote.file.' + str(i) + '.params.keys')
if keys is not None:
params = {}
keys = keys.split(',')
for key in keys:
param = cf.get('remote.file.' + str(i) + '.params.' + key.strip())
params[key.strip()] = param.strip()
method = cf.get('remote.file.' + str(i) + '.method')
if method is None:
if cf.get('url.method') is not None:
method = cf.get('url.method')
else:
method = 'GET'
credentials = cf.get('remote.file.' + str(i) + '.credentials')
if not method:
credentials = cf.get('server.credentials')
remotes = [cf.get('remote.file.' + str(i) + '.path')]
save_as = cf.get('remote.file.' + str(i) + '.path')
if cf.get('remote.file.' + str(i) + '.name'):
save_as = cf.get('remote.file.' + str(i) + '.name')
subdownloader = dserv.get_handler(
protocol,
server,
'',
credentials=credentials,
http_parse=http_parse,
http_method=method,
param=params,
proxy=proxy,
proxy_auth=proxy_auth,
save_as=save_as,
timeout_download=cf.get('timeout.download'),
offline_dir=self.session.get_offline_directory()
)
subdownloader.set_files_to_download(remotes)
downloaders.append(subdownloader)
i += 1
rfile = cf.get('remote.file.' + str(i) + '.path')
else:
"""
Simple case, one downloader with regexp
"""
protocol = cf.get('protocol')
server = cf.get('server')
params = None
keys = cf.get('url.params')
if keys is not None:
params = {}
keys = keys.split(',')
for key in keys:
param = cf.get(key.strip() + '.value')
params[key.strip()] = param.strip()
method = cf.get('url.method')
if method is None:
method = 'GET'
credentials = cf.get('server.credentials')
remote_dir = cf.get('remote.dir')
if protocol == 'directhttp' or protocol == 'directhttps' or protocol == 'directftp':
remotes = [cf.get('remote.dir')[:-1]]
remote_dir = '/'
save_as = cf.get('target.name')
downloader = dserv.get_handler(
protocol,
server,
remote_dir,
credentials=credentials,
http_parse=http_parse,
http_method=method,
param=params,
proxy=proxy,
proxy_auth=proxy_auth,
save_as=save_as,
timeout_download=cf.get('timeout.download'),
offline_dir=self.session.get_offline_directory()
)
if protocol == 'directhttp' or protocol == 'directhttps' or protocol == 'directftp':
downloader.set_files_to_download(remotes)
remote_list = cf.get('remote.list', default=None)
if remote_list is not None:
logging.info("Use list from " + remote_list)
downloader.files_to_download = self._get_list_from_file(remote_list)
use_remote_list = True
downloaders.append(downloader)
self._close_download_service(dserv)
for downloader in downloaders:
if downloader is None:
logging.error('Protocol ' + downloader.protocol + ' not supported')
return False
files_to_download = []
for downloader in downloaders:
if use_remote_list:
if not downloader.files_to_download:
self.session.set('remoterelease', self.session.previous_release)
return self.no_need_to_update()
else:
(file_list, dir_list) = downloader.list()
downloader.match(cf.get('remote.files', default='.*').split(), file_list, dir_list)
# Check if save_as defined, else check if regexp contains some save information with groups
for f in downloader.files_to_download:
if 'save_as' not in f or not f['save_as']:
f['save_as'] = f['name']
for p in cf.get('remote.files', default='.*').split():
if p.startswith('^'):
p = p.replace('^', '^/')
else:
p = '/' + p
res = re.match(p, f['name'])
if res is not None and res.groups() is not None and len(res.groups()) >= 1:
f['save_as'] = '/'.join(res.groups())
break
files_to_download += downloader.files_to_download
self.session.set('download_files', downloader.files_to_download)
self.session._session['stats']['nb_downloaded_files'] = len(files_to_download)
logging.info('Workflow:wf_download:nb_files_to_download:%d' % (len(files_to_download)))
if self.session.get('release') and self.session.config.get_bool('release.control', default=False):
if self.session.previous_release == self.session.get('remoterelease'):
if self.is_previous_release_content_identical():
logging.info('Workflow:wf_release:same_as_previous_session')
return self.no_need_to_update()
else:
release = self.check_and_incr_release()
if self.session.get('release') is None:
# Not defined, or could not get it ealier
# Set release to most recent file to download
release_dict = Utils.get_more_recent_file(downloader.files_to_download)
if release_dict is None:
today = datetime.datetime.now()
release_dict = {'year': today.year, 'month': today.month, 'day': today.day}
release = str(release_dict['year']) + '-' + str(release_dict['month']) + '-' + str(release_dict['day'])
if cf.get('release.format'):
release_date = datetime.datetime.now()
release_date = release_date.replace(year=int(release_dict['year']), month=int(release_dict['month']), day=int(release_dict['day']))
# Fix configparser problem between py2 and py3
release = release_date.strftime(cf.get('release.format').replace('%%', '%'))
self.session.set('release', release)
self.session.set('remoterelease', release)
logging.info('Workflow:wf_download:release:remoterelease:' + self.session.get('remoterelease'))
logging.info('Workflow:wf_download:release:release:' + release)
self.__update_info({'$set': {'status.release.progress': str(release)}})
'''
MongoConnector.banks.update(
{'name': self.bank.name},
{'$set': {'status.release.progress': str(release)}}
)
'''
self.download_go_ahead = False
if self.options.get_option(Options.FROM_TASK) == 'download':
# We want to download again in same release, that's fine, we do not care it is the same release
self.download_go_ahead = True
if not self.download_go_ahead and self.session.previous_release == self.session.get('remoterelease') and self.is_previous_release_content_identical():
logging.info('Workflow:wf_release:same_as_previous_session')
return self.no_need_to_update()
# We restart from scratch, check if directory with this release already exists
if self.options.get_option(Options.FROMSCRATCH) or self.options.get_option('release') is None:
release = self.check_and_incr_release()
self.session.config.set('localrelease', self.session.get('release'))
self.session.config.set('remoterelease', self.session.get('remoterelease'))
if self.session.config.get_bool('releaseonly', default=False):
return True
self.banks = MongoConnector.banks
self.bank.bank = self.banks.find_one({'name': self.name})
nb_prod_dir = len(self.bank.bank['production'])
offline_dir = self.session.get_offline_directory()
copied_files = []
# Check if already in offlinedir
files_in_offline = 0
nb_expected_files = 0
for downloader in downloaders:
keep_files = []
nb_expected_files += len(downloader.files_to_download)
if os.path.exists(offline_dir):
for file_to_download in downloader.files_to_download:
# If file is in offline dir and has same date and size, do not download again
if os.path.exists(offline_dir + '/' + file_to_download['name']):
try:
file_stat = os.stat(offline_dir + '/' + file_to_download['name'])
f_stat = datetime.datetime.fromtimestamp(os.path.getmtime(offline_dir + '/' + file_to_download['name']))
year = str(f_stat.year)
month = str(f_stat.month)
day = str(f_stat.day)
if str(file_stat.st_size) != str(file_to_download['size']) or \
str(year) != str(file_to_download['year']) or \
str(month) != str(file_to_download['month']) or \
str(day) != str(file_to_download['day']):
logging.debug('Workflow:wf_download:different_from_offline:' + file_to_download['name'])
keep_files.append(file_to_download)
else:
logging.debug('Workflow:wf_download:offline:' + file_to_download['name'])
files_in_offline += 1
copied_files.append(file_to_download)
except Exception as e:
# Could not get stats on file
logging.debug('Workflow:wf_download:offline:failed to stat file: ' + str(e))
os.remove(offline_dir + '/' + file_to_download['name'])
keep_files.append(file_to_download)
else:
keep_files.append(file_to_download)
downloader.files_to_download = keep_files
logging.info("Workflow:wf_download:nb_expected_files:" + str(nb_expected_files))
logging.info("Workflow:wf_download:nb_files_in_offline_dir:" + str(files_in_offline))
# If everything was already in offline dir
everything_present = True
for downloader in downloaders:
if len(downloader.files_to_download) > 0:
everything_present = False
break
if everything_present:
self.downloaded_files = []
logging.info("Workflow:wf_download:all_files_in_offline:skip download")
return True
for downloader in downloaders:
self._create_dir_structure(downloader, offline_dir)
self.download_go_ahead = False
if self.options.get_option(Options.FROM_TASK) == 'download':
# We want to download again in same release, that's fine, we do not care it is the same release
self.download_go_ahead = True
if not self.options.get_option(Options.FROMSCRATCH) and not self.download_go_ahead and nb_prod_dir > 0:
# Get last production
last_production = self.bank.bank['production'][nb_prod_dir - 1]
# Get session corresponding to production directory
last_production_session = self.banks.find_one({'name': self.name, 'sessions.id': last_production['session']}, {'sessions.$': 1})
last_production_session_release_directory = self.session.get_full_release_directory(release=last_production['release'])
last_production_dir = os.path.join(last_production_session_release_directory, 'flat')
# Checks if some files can be copied instead of downloaded
last_production_files = None
if len(last_production_session['sessions']) > 0:
last_production_files = self._load_local_files_from_session(last_production_session['sessions'][0]['id'])
if not cf.get_bool('copy.skip', default=False):
for downloader in downloaders:
downloader.download_or_copy(last_production_files, last_production_dir)
everything_copied = True
for downloader in downloaders:
if len(downloader.files_to_download) > 0:
everything_copied = False
break
if everything_copied:
logging.info('Workflow:wf_download:all files copied from %s' % (str(last_production_dir)))
# return self.no_need_to_update()
logging.debug('Workflow:wf_download:Copy files from ' + last_production_dir)
for downloader in downloaders:
copied_files += downloader.files_to_copy
Utils.copy_files(downloader.files_to_copy, offline_dir)
downloader.close()
pool_size = self.session.config.get('files.num.threads', default=None)
dserv = None
if self.bank.config.get('micro.biomaj.service.download', default=None) == '1':
dserv = DownloadClient(
self.bank.config.get('micro.biomaj.rabbit_mq'),
int(self.bank.config.get('micro.biomaj.rabbit_mq_port', default='5672')),
self.bank.config.get('micro.biomaj.rabbit_mq_virtualhost', default='/'),
self.bank.config.get('micro.biomaj.rabbit_mq_user', default=None),
self.bank.config.get('micro.biomaj.rabbit_mq_password', default=None),
redis_client=self.redis_client,
redis_prefix=self.redis_prefix
)
if pool_size:
logging.debug('Set rate limiting: %s' % (str(pool_size)))
dserv.set_rate_limiting(int(pool_size))
else:
dserv = DownloadClient()
if pool_size:
dserv.set_queue_size(int(pool_size))
proxy = self.bank.config.get('micro.biomaj.proxy')
session = dserv.create_session(self.name, proxy)
logging.info("Workflow:wf_download:DownloadSession:" + str(session))
for downloader in downloaders:
for file_to_download in downloader.files_to_download:
operation = message_pb2.Operation()
operation.type = 1
message = message_pb2.DownloadFile()
message.bank = self.name
message.session = session
message.local_dir = offline_dir
remote_file = message_pb2.DownloadFile.RemoteFile()
protocol = downloader.protocol
remote_file.protocol = message_pb2.DownloadFile.Protocol.Value(protocol.upper())
if downloader.credentials:
remote_file.credentials = downloader.credentials
remote_file.server = downloader.server
if cf.get('remote.dir'):
remote_file.remote_dir = cf.get('remote.dir')
else:
remote_file.remote_dir = ''
if http_parse:
msg_http_parse = message_pb2.DownloadFile.HttpParse()
msg_http_parse.dir_line = http_parse.dir_line
msg_http_parse.file_line = http_parse.file_line
msg_http_parse.dir_name = http_parse.dir_name
msg_http_parse.dir_date = http_parse.dir_date
msg_http_parse.file_name = http_parse.file_name
msg_http_parse.file_date = http_parse.file_date
msg_http_parse.file_size = http_parse.file_size
if http_parse.file_date_format:
msg_http_parse.file_date_format = http_parse.file_date_format
remote_file.http_parse.MergeFrom(msg_http_parse)
biomaj_file = remote_file.files.add()
biomaj_file.name = file_to_download['name']
if 'root' in file_to_download and file_to_download['root']:
biomaj_file.root = file_to_download['root']
if downloader.param:
for key in list(downloader.param.keys()):
param = remote_file.param.add()
param.name = key
param.value = downloader.param[key]
if 'save_as' in file_to_download and file_to_download['save_as']:
biomaj_file.save_as = file_to_download['save_as']
if 'url' in file_to_download and file_to_download['url']:
biomaj_file.url = file_to_download['url']
if 'permissions' in file_to_download and file_to_download['permissions']:
biomaj_file.metadata.permissions = file_to_download['permissions']
if 'size' in file_to_download and file_to_download['size']:
biomaj_file.metadata.size = file_to_download['size']
if 'year' in file_to_download and file_to_download['year']:
biomaj_file.metadata.year = file_to_download['year']
if 'month' in file_to_download and file_to_download['month']:
biomaj_file.metadata.month = file_to_download['month']
if 'day' in file_to_download and file_to_download['day']:
biomaj_file.metadata.day = file_to_download['day']
if 'hash' in file_to_download and file_to_download['hash']:
biomaj_file.metadata.hash = file_to_download['hash']
if 'md5' in file_to_download and file_to_download['md5']:
biomaj_file.metadata.md5 = file_to_download['md5']
message.http_method = message_pb2.DownloadFile.HTTP_METHOD.Value(downloader.method.upper())
timeout_download = cf.get('timeout.download', default=None)
if timeout_download:
try:
message.timeout_download = int(timeout_download)
except Exception as e:
logging.error('Wrong timeout type for timeout.download: ' + str(e))
if self.span:
trace = message_pb2.Operation.Trace()
trace.trace_id = self.span.get_trace_id()
trace.span_id = self.span.get_span_id()
operation.trace.MergeFrom(trace)
message.remote_file.MergeFrom(remote_file)
operation.download.MergeFrom(message)
dserv.download_remote_file(operation)
logging.info("Workflow:wf_download:Download:Waiting")
download_error = False
try:
download_error = dserv.wait_for_download()
except Exception as e:
self._close_download_service(dserv)
logging.exception('Workflow:wf_download:Exception:' + str(e))
return False
except KeyboardInterrupt:
logging.warn("Ctrl-c received! Stop downloads...")
logging.warn("Running downloads will continue and process will stop.")
self._close_download_service(dserv)
return False
self._close_download_service(dserv)
self.downloaded_files = copied_files
for downloader in downloaders:
self.downloaded_files += downloader.files_to_download
if download_error:
logging.error('An error occured during download')
return False
return True
def wf_uncompress(self):
"""
Uncompress files if archives and no.extract = false
"""
logging.info('Workflow:wf_uncompress')
if len(self.downloaded_files) == 0:
logging.info("Workflow:wf_uncompress:NoFileDownload:NoExtract")
return True
no_extract = self.session.config.get('no.extract')
if no_extract is None or no_extract == 'false':
for file in self.downloaded_files:
if 'save_as' not in file:
file['save_as'] = file['name']
nb_try = 1
not_ok = True
while nb_try < 3 and not_ok:
status = Utils.uncompress(self.session.get_offline_directory() + '/' + file['save_as'])
if status:
not_ok = False
else:
logging.warn('Workflow:wf_uncompress:Failure:' + file['name'] + ':' + str(nb_try))
nb_try += 1
if not_ok:
logging.error('Workflow:wf_uncompress:Failure:' + file['name'])
return False
else:
logging.info("Workflow:wf_uncompress:NoExtract")
return True
def wf_copy(self):
"""
Copy files from offline directory to release directory
"""
logging.info('Workflow:wf_copy')
if len(self.downloaded_files) == 0:
logging.info("Workflow:wf_copy:NoFileDownload:NoCopy")
return True
from_dir = os.path.join(self.session.config.get('data.dir'),
self.session.config.get('offline.dir.name'))
regexp = self.session.config.get('local.files', default='**/*').split()
to_dir = os.path.join(
self.session.config.get('data.dir'),
self.session.config.get('dir.version'),
self.session.get_release_directory(),
'flat'
)
local_files = Utils.copy_files_with_regexp(from_dir, to_dir, regexp, True)
self.session._session['files'] = local_files
if len(self.session._session['files']) == 0:
logging.error('Workflow:wf_copy:No file match in offline dir')
return False
return True
def wf_metadata(self):
"""
Update metadata with info gathered from processes
"""
logging.info('Workflow:wf_metadata')
self.bank.session.set('formats', {})
per_process_meta_data = self.session.get('per_process_metadata')
for proc in list(per_process_meta_data.keys()):
for meta_data in list(per_process_meta_data[proc].keys()):
session_formats = self.bank.session.get('formats')
if meta_data not in session_formats:
session_formats[meta_data] = per_process_meta_data[proc][meta_data]
else:
session_formats[meta_data] += per_process_meta_data[proc][meta_data]
return True
def wf_stats(self):
"""
Get some stats from current release data dir
"""
logging.info('Workflow:wf_stats')
do_stats = self.bank.config.get('data.stats')
if do_stats is None or do_stats == '0':
self.session.set('fullsize', 0)
return True
prod_dir = self.session.get_full_release_directory()
dir_size = Utils.get_folder_size(prod_dir)
self.session.set('fullsize', dir_size)
return True
def wf_postprocess(self):
"""
Execute post processes
"""
# Creates a temporary symlink future_release to keep compatibility if process
# tries to access dir with this name
future_link = os.path.join(
self.bank.config.get('data.dir'),
self.bank.config.get('dir.version'),
'future_release'
)
# prod_dir = self.session.get_full_release_directory()
to_dir = os.path.join(
self.bank.config.get('data.dir'),
self.bank.config.get('dir.version')
)
if os.path.lexists(future_link):
os.remove(future_link)
os.chdir(to_dir)
os.symlink(self.session.get_release_directory(), 'future_release')
logging.info('Workflow:wf_postprocess')
blocks = self.session._session['process']['postprocess']
pfactory = PostProcessFactory(self.bank, blocks, redis_client=self.redis_client, redis_prefix=self.redis_prefix)
res = pfactory.run()
self.session._session['process']['postprocess'] = pfactory.blocks
# In any way, delete symlink
if os.path.lexists(future_link):
os.remove(future_link)
return res
def wf_publish(self):
"""
Add *current* symlink to this release
"""
if self.bank.config.get_bool('auto_publish', default=False):
logging.info('Workflow:wf_publish')
self.bank.publish()
return True
if not self.options.get_option(Options.PUBLISH):
logging.info('Workflow:wf_publish:no')
return True
logging.info('Workflow:wf_publish')
self.bank.publish()
return True
def wf_old_biomaj_api(self):
"""
Generates a listing.format file containing the list of files in directories declared in formats
"""
release_dir = self.session.get_full_release_directory()
for release_format in self.bank.session.get('formats'):
format_file = os.path.join(release_dir, 'listingv1.' + release_format.replace('/', '_'))
section = self.list_section(release_dir, release_format, release_format)
logging.debug("Worfklow:OldAPI:WriteListing: " + format_file)
fd = os.open(format_file, os.O_RDWR | os.O_CREAT)
os.write(fd, json.dumps(section).encode('utf-8'))
os.close(fd)
return True
def list_section(self, base_dir, release_format, base_format):
"""
Get section files and sub-section from base_dir for directory release_format
:param base_dir: root directory
:type base_dir: str
:param base_dir: sub directory to scan
:type base_dir: str
:param base_format: first directroy indicating format
:type base_format: str
:return: dict section details
"""
section = {"name": release_format, "sections": [], "files": []}
format_dir = os.path.join(base_dir, release_format)
if not os.path.exists(format_dir):
logging.info("Worfklow:OldAPI:Format directory " + release_format + " does not exists, skipping")
return section
format_dir_list = os.listdir(format_dir)
for format_dir_file in format_dir_list:
if os.path.isfile(os.path.join(format_dir, format_dir_file)):
if base_format.lower() == 'blast':
if format_dir_file.endswith('.nal'):
fileName, fileExtension = os.path.splitext(format_dir_file)
section['files'].append(os.path.join(format_dir, fileName))
else:
section['files'].append(os.path.join(format_dir, format_dir_file))
else:
# This is a sub directory
new_section = self.list_section(format_dir, format_dir_file, base_format)
section['sections'].append(new_section)
return section
def wf_clean_offline(self):
"""
Clean offline directory
"""
logging.info('Workflow:wf_clean_offline')
if os.path.exists(self.session.get_offline_directory()):
shutil.rmtree(self.session.get_offline_directory())
return True
def wf_clean_old_sessions(self):
"""
Delete old sessions not related to a production directory or last run
"""
logging.info('Workflow:wf_clean_old_sessions')
self.bank.clean_old_sessions()
return True
def wf_delete_old(self):
"""
Delete old production dirs
"""
logging.info('Workflow:wf_delete_old')
if self.options.get_option(Options.FROM_TASK) is not None:
# This is a run on an already present release, skip delete
logging.info('Workflow:wf_delete_old:Skip')
return True
if not self.session.config.get('keep.old.version'):
keep = 1
else:
keep = int(self.session.config.get('keep.old.version'))
# Current production dir is not yet in list
nb_prod = len(self.bank.bank['production'])
# save session during delete workflow
keep_session = self.bank.session
if nb_prod > keep:
for prod in self.bank.bank['production']:
if prod['release'] == keep_session.get('release'):
continue
if 'freeze' in prod and prod['freeze']:
continue
if self.bank.bank['current'] == prod['session']:
continue
if nb_prod - keep > 0:
nb_prod -= 1
session = self.bank.get_new_session(RemoveWorkflow.FLOW)
# Delete init and over because we are already in a run
i_init = -1
i_over = -1
for i in range(0, len(session.flow)):
if session.flow[i]['name'] == 'init':
i_init = i
if i_init >= 0:
del session.flow[i_init]
for i in range(0, len(session.flow)):
if session.flow[i]['name'] == 'over':
i_over = i
if i_over >= 0:
del session.flow[i_over]
session.set('action', 'remove')
session.set('release', prod['release'])
session.set('remoterelease', prod['remoterelease'])
session.set('update_session_id', prod['session'])
logging.info('Workflow:wf_delete_old:Delete:' + prod['release'])
res = self.bank.start_remove(session)
if not res:
logging.error('Workflow:wf_delete_old:ErrorDelete:' + prod['release'])
else:
break
# Set session back
self.bank.session = keep_session
return True
class ReleaseCheckWorkflow(UpdateWorkflow):
"""
Workflow for a bank update
"""
FLOW = [
{'name': 'init', 'steps': []},
{'name': 'check', 'steps': []},
{'name': 'preprocess', 'steps': []},
{'name': 'release', 'steps': []},
{'name': 'download', 'steps': []},
{'name': 'over', 'steps': []}
]
def __init__(self, bank):
"""
Instantiate a new workflow
:param bank: bank on which to apply the workflow
:type bank: Bank
"""
UpdateWorkflow.__init__(self, bank)
logging.debug('New release check workflow')
self.session.config.set('releaseonly', 'true')
def wf_init(self):
"""
Initialize workflow, do not lock bank as it is not modified
If bank is already locked, stop workflow
"""
logging.info('Workflow:wf_init')
data_dir = self.session.config.get('data.dir')
lock_dir = self.session.config.get('lock.dir', default=data_dir)
lock_file = os.path.join(lock_dir, self.name + '.lock')
if os.path.exists(lock_file):
logging.error('Bank ' + self.name + ' is locked, a process may be in progress, else remove the lock file ' + lock_file)
return False
return True
def wf_over(self):
"""
Workflow is over
"""
logging.info('Workflow:wf_over')
return True
def __update_info(self, info):
return
def wf_progress(self, task, status):
return
|