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
|
# @copyright 2016-2023 Clarity Genomics BVBA
# @copyright 2012-2016 Bonsai Bioinformatics Research Group
# @copyright 2014-2016 Knight Lab, Department of Pediatrics, UCSD, La Jolla
#
# SortMeRNA - next-generation reads filter for metatranscriptomic or total RNA
# This is a free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# SortMeRNA 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with SortMeRNA. If not, see <http://www.gnu.org/licenses/>.
#
# contributors: Jenya Kopylova jenya.kopylov@gmail.com
# Laurent Noé laurent.noe@lifl.fr
# Pierre Pericard pierre.pericard@lifl.fr
# Daniel McDonald wasade@gmail.com
# Mikaël Salson mikael.salson@lifl.fr
# Hélène Touzet helene.touzet@lifl.fr
# Rob Knight robknight@ucsd.edu
'''
file: setup.py
created: Jul 31, 2019 Wed
Dependencies:
conda install pyyaml jinja2 requests
'''
import os
import sys
import subprocess
import platform
from optparse import OptionParser
import requests
import tarfile
import re
import fileinput
#import json
import yaml
from jinja2 import Environment, FileSystemLoader
from pathlib import Path
import zipfile
import time
import shutil
from io import BytesIO
#pkn = __name__.split('.')[-1]
# define platform
pf = platform.platform()
IS_WIN = 'Windows' in pf
IS_WSL = 'Linux' in pf and 'Microsoft' in pf # Windows Subsystem for Linux (WSL)
IS_LNX = 'Linux' in pf and not 'Microsoft' in pf
IS_OSX = 'macOS' in pf
MY_OS = 'WIN' if IS_WIN else 'LIN' if IS_LNX else 'WSL' if IS_WSL else 'OSX' if IS_OSX else None
if not MY_OS:
print(f'[setup.py] Unexpected platform: {pf}')
sys.exit(1)
else:
print(f'[setup.py] running on: {pf}, id: {MY_OS}')
modfunc = {} # holds refs to functions in this module
# globals
SMR = 'sortmerna'
ZLIB = 'zlib'
ROCKS = 'rocksdb'
#RAPID = 'rapidjson'
DIRENT = 'dirent'
CMAKE = 'cmake'
CONDA = 'conda'
ALL = 'all'
CCQUEUE = 'concurrentqueue'
ENV = None # WIN | WSL | LNX_AWS | LNX_TRAVIS
UHOME = os.environ['USERPROFILE'] if IS_WIN else os.environ['HOME']
def test():
'''
'''
print(os.path.dirname(os.path.realpath(__file__)))
print(os.getcwd())
#END test
def load_tar(url, tgtd):
'''
'''
ST = '[load_tar]'
ret = {'result': True}
# check path already exists
if Path(tgtd).exists():
msg = f'{ST} directory already exists {tgtd}. Skipping download'
print(msg)
ret['stdout'] = msg
else:
try:
with requests.get(url) as res:
tf = tarfile.open(mode='r:gz', fileobj=BytesIO(res.content))
pp = Path(tgtd).parent / tf.firstmember.name
msg = f'{ST} extracting into: {pp}'
tf.extractall(Path(tgtd).parent) # -> e.g. ./3rdparty/rocksdb-7.10.2 35.7 MB
ppn = pp.replace(Path(tgtd))
msg += f'\n{ST} moved {pp} -> {ppn}'
ret['stdout'] = msg
print(msg)
except Exception as ex:
ret['result'] = False
ret['stderr'] = f'{ex}'
return ret
def git_clone(url, repo_dir, commit='master', shallow=False, force=False):
'''
clone a git repo if not already existing
:param str url url to clone
:param str repo_dir directory where to clone
'''
ST = '[git_clone]'
ret = {}
# make sure parent directory where to clone exists
if not os.path.exists(os.path.split(repo_dir)[0]):
os.makedirs(os.path.dirname(repo_dir)) # create parent repo
# check clone already exists
if os.path.exists(repo_dir) and os.path.exists(os.path.join(repo_dir, '.git')):
print('{} git clone already exists: {}'.format(ST, repo_dir))
cmd = ['git', 'status']
ret = proc_run(cmd, repo_dir)
else: # do clone
cmd = [ 'git', 'clone', url, repo_dir]
ret = proc_run(cmd)
return ret
#END git_clone
def conda_install(dir=None, force=False, clean=False, **cfg):
'''
:param cfg Config dictionary
:param dir installation root dir. Default: User Home
pip install -U pyyaml
pip install -U Jinja2
'''
ST = '[conda_install]'
dir = dir or UHOME
fsh = 'miniconda.sh'
is_install_ok = False
#os.chdir(dir)
# check already installed
bin_conda = os.path.join(dir, 'miniconda3', 'bin')
if os.path.exists(bin_conda):
cmd = ['python', '--version']
ret = proc_run(cmd, bin_conda, True)
if not ret['retcode']:
print('{} Conda already installed: {} : {}'.format(ST, bin_conda, ret['stdout']))
if force:
print('{} TODO: Force specified - removing the existing installation: {}'.format(ST, bin_conda))
return
# download the installer if not already present
if not os.path.exists(os.path.join(dir, fsh)):
url_conda = cfg[CONDA]['url'][MY_OS]
#if sys.version_info[1] < 7:
# 'Mozilla/5.0 (Windows NT 6.1; Win64; x64)'
# req = urllib.request.Request(url_conda, headers={'User-Agent': 'Mozilla/5.0'})
#else:
# this works with conda but not standard python3
# req = url_conda
print('{} Loading Conda from url: {}'.format(ST, url_conda))
try:
req = requests.get(url_conda, allow_redirects=True)
#with urllib.request.urlopen(req) as surl:
with open(fsh, 'wb') as fp:
fp.write(req.content) # loads the file into memory before writing to disk. No good for very big files.
except:
print('{} Exception getting Conda distro: {} {}'.format(ST, sys.exc_info()[1], sys.exc_info()[0]))
sys.exit(1)
# run the installer
if os.path.exists(os.path.join(dir, fsh)):
cmd = ['bash', fsh, '-b']
#cmd = ['bash', fsh, '-b', '-p', '{}/miniconda'.format(dir)]
proc_run(cmd, dir)
# delete the installer
if clean:
print('{} Deleting the installer {}'.format(ST, os.path.join(dir, fsh)))
os.remove(os.path.join(dir, fsh))
print('{} Installed conda in {}'.format(ST, os.path.join(dir, 'miniconda3')))
# install packages required to use sortmerna's build.py
print('{} Installing PyYaml package'.format(ST))
bin_pip = os.path.join(bin_conda, 'pip')
cmd = [bin_pip, 'install', 'pyyaml']
proc_run(cmd, bin_conda)
print('{} Installing Jinja2 package'.format(ST))
cmd = [bin_pip, 'install', 'jinja2']
proc_run(cmd, bin_conda)
print('{} Installing NumPy package'.format(ST))
cmd = [bin_pip, 'install', 'numpy']
proc_run(cmd, bin_conda)
print('{} Installing scikit-bio package'.format(ST))
cmd = [bin_pip, 'install', 'scikit-bio']
proc_run(cmd, bin_conda)
else:
print('{} Conda installer not found - likely failed to download'.format(ST))
print('{} Done'.format(ST))
#END conda_install
def cmake_install(dir=None, force=False, **cfg):
'''
:param dict cfg configuration dict
:param str dir installation directory. Default User Home
Download and extract CMake release archive
python build.py --name cmake
'''
ST = '[cmake_install]'
is_installed = False
cmake_cfg = cfg.get(CMAKE)
url = cmake_cfg['url'][MY_OS]
zipped = url.split('/')[-1] # tar.gz or zip
env = cfg.get('env')
cmake_home = cmake_cfg.get('home',{}).get(env)
#cmake_home = val if val else os.path.join(UHOME, 'cmake-{}-win64-x64'.format(cmake_cfg.get('ver')))
# |_ default
# check already installed
cmake_bin = '{}/bin/cmake'.format(cmake_home)
if IS_WIN: cmake_bin = '{}.exe'.format(cmake_bin)
if os.path.exists(cmake_bin):
print('{} Cmake is already installed: {}'.format(ST, cmake_bin))
if not force:
is_installed = True
if not is_installed:
print('{} CMake not found at: {} - installing'.format(ST, cmake_bin))
os.chdir(Path(cmake_home).parent.as_posix()) # navigate to the parent dir e.g. installation root (pathlib)
# download the installer if not already present
if not os.path.exists(zipped):
# load file from URL
req = requests.get(url, allow_redirects=True)
try:
#with urllib.request.urlopen(url) as surl:
with open(zipped, 'wb') as fp:
fp.write(req.content) # loads all file into memory first before writing to disk. No good for very big files.
except:
print('{} Exception getting CMake distro: {} {}'.format(ST, sys.exc_info()[1], sys.exc_info()[0]))
sys.exit(1)
# extract archive
ext = os.path.splitext(zipped)[1]
if '.gz' == ext:
tar = tarfile.open(zipped)
tar.extractall()
tar.close()
elif '.zip' == ext:
with zipfile.ZipFile(zipped, 'r') as fp:
fp.extractall(os.curdir)
# delete archive
os.remove(zipped)
# Verify installation
if os.path.exists(cmake_bin):
print('{} Installed CMake {}'.format(ST, cmake_bin))
else:
print('{} Failed to install CMake {}'.format(ST, cmake_bin))
# copy binarties to HOME/bin to avoid setting the PATH
#if IS_LNX:
# copy_tree('{}/bin'.format(cmake_home), '{}/bin'.format(UHOME))
#os.environ('PATH')
#END cmake_install
def gcc_install(**cfg):
'''
sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt update
sudo apt install gcc-7 g++-7
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-7 60 --slave /usr/bin/g++ g++ /usr/bin/g++-7
| | | |_priority
| | |_path (target)
| |_name of the symlink (alias)
|_link
sudo update-alternatives --install /usr/bin/cpp cpp-bin /usr/bin/cpp-9 60
'''
ST = '[gcc_install]'
GCC_MINVER = 9
is_gcc = False
if shutil.which('gcc'):
cmd = ['gcc', '--version']
ret = proc_run(cmd, capture=True)
if ret['retcode'] == 0:
gccver = ret['stdout'].decode('utf-8').split('\n')[0].split()[3].split('.')[0]
if int(gccver) >= GCC_MINVER:
print(f'{ST} gcc version {gccver} found - OK')
is_gcc = True
if not is_gcc:
print(f'{ST} gcc is not found. Please, install prior using this script')
#END gcc_install
def make_install(**cfg):
'''
TODO
sudo apt install make
'''
...
#END make_install
def git_install(**cfg):
'''
'''
cmd = ['apt', 'policy', 'git']
proc_run(cmd)
def clean(dir):
'''
:param str dir Directory to clean
remove content of the given directory.
'''
cmd = ['rm', '-rf', './*']
ret = proc_run(cmd, dir)
return ret
#END clean
def proc_run(cmd, cwd=None, capture=False):
'''
:param list cmd command to execute
:param str cwd CWD
:param bool capture capture the output
'''
ST = '[proc_run]'
ret = {'retcode':0, 'stdout':None, 'stderr':None}
spr = '==========================================================='
cwdp = cwd or Path().resolve()
print('{} Running in {}:\n{}\n{}\n{}'.format(ST, cwdp, spr, ' '.join(cmd), spr))
start = time.time()
# print compiler version e.g. 'Microsoft (R) C/C++ Optimizing Compiler Version 19.16.27031.1 for x86'
#"%VS_HOME%"\bin\Hostx86\x86\cl.exe
# check executable
if shutil.which(cmd[0]):
try:
if cwd:
if not os.path.exists(cwd):
os.makedirs(cwd)
if sys.version_info[1] > 6:
proc = subprocess.run(cmd, cwd=cwd, capture_output=capture)
else:
proc = subprocess.run(cmd, cwd=cwd)
else:
if sys.version_info[1] > 6:
proc = subprocess.run(cmd, capture_output=capture)
else:
proc = subprocess.run(cmd)
if proc.returncode:
for info in sys.exc_info(): print(info)
ret['retcode'] = proc.returncode
if capture:
ret['stdout'] = proc.stdout
ret['stderr'] = proc.stderr
except OSError as err:
print(err)
ret['retcode'] = 1
ret['stderr'] = err
except:
for info in sys.exc_info(): print(info)
ret['retcode'] = 1
ret['stderr'] = sys.exc_info()
print("{} Run time: {}".format(ST, time.time() - start))
else:
msg = '{} Executable {} not found'.format(ST, cmd[0])
ret['retcode'] = 1
ret['stderr'] = msg
print(msg)
return ret
#END proc_run
def zlib_build(**kwargs):
'''
args:
- url
- path str local filesystem directory where to clone the repo
- commit str git commit
- cmake_build_type str Build type Relase | Debug | ..
- ptype str Linkage type like statuc, dynamic, mixed
- is_git bool use git as source. Otherwise - archive (.tar.gz)
'''
is_git = kwargs.get('is_git', False)
url = kwargs.get('url') if is_git else kwargs.get('url2')
path = kwargs.get('path')
commit = kwargs.get('commit')
shallow = kwargs.get('shallow')
btype = kwargs.get('cmake_build_type', 'Release')
gen = kwargs.get('cmake_gen', 'Ninja Multi-Config')
ret = git_clone(url, path, commit=commit) if is_git else load_tar(url, path) # URL_ZLIB
# cmake configure
# set CMAKE_INSTALL_PREFIX here because original zlib CMakeLists.txt uses it
# to set cache variables used in installation at configure time (not a good solution).
# Instead the relative paths should be used, and CMake will add the prefix during installation automatically).
# https://discourse.cmake.org/t/cmake-install-prefix-not-work
# https://github.com/madler/zlib/pull/170 <- PR to fix zlib CMakeLists.txt (never merged)
pfx = kwargs.get('dist') or Path(f'build/{path}/dist').absolute()
#pfx = kwargs.get('dist') or os.path.abspath(f'build/{path}/dist').replace('\\', '/')
cmd = ['cmake', '-S', path, '-B', f'build/{path}', '-G', gen, '--fresh', '-D', f'CMAKE_INSTALL_PREFIX={pfx}']
ret = proc_run(cmd)
# cmake build
if ret['retcode'] == 0:
cmd = [ 'cmake', '--build', f'build/{path}', '--target', 'install', '--config', btype]
proc_run(cmd)
return ret
#END zlib_build
"""def rapidjson_build(btype='Release'):
'''
'''
BUILD_EXAMPLES = 0
BUILD_DOC = 0
git_clone(URL_RAPID, LIB_DIR)
cmd = [
'cmake', '-G', CMAKE_GEN,
f'-DRAPIDJSON_BUILD_EXAMPLES={BUILD_EXAMPLES}',
f'-DRAPIDJSON_BUILD_DOC={BUILD_DOC}',
f'-DCMAKE_INSTALL_PREFIX={RAPID_DIST}',
RAPID_SRC
]
proc_run(cmd, RAPID_BUILD)
cmd = [ 'cmake', '--build', '.', '--config', btype, '--target', 'install' ]
proc_run(cmd, RAPID_BUILD)
#END rapidjson_build
"""
def rocksdb_modify_3party_zlib(link_type='t1', **kwargs):
'''
modify 'thirdparty.inc' config file provided with RocksDb distro to point to zlib installation
only used on Windows
:param str ptype library linkage type as in 'env.jinja.yaml:rocksdb:link:win:t3'
:param dict cfg build configuration from 'env.jinja.yaml'
'''
ST = '[rocksdb_modify_3party_zlib]'
if not IS_WIN:
print('{} not used on Non-Windows'.format(ST))
return
print('{} fixing \'thirdparty.inc\' for linkage type [{}] on Windows'.format(ST, link_type))
link_type = kwargs.get(ROCKS,{}).get('link.type', {}).get('windows',{}).get(link_type,{})
zlib_rel = link_type.get('zlib.release') # cfg[ROCKS]['link']['WIN'][ptype]['ZLIB_LIB_RELEASE']
zlib_dbg = link_type.get('zlib.debug') # cfg[ROCKS]['link']['WIN'][ptype]['ZLIB_LIB_DEBUG']
file3p = os.path.join(kwargs.get(ROCKS).get('path'), 'thirdparty.inc')
zlib_dist = kwargs.get('zlib',{}).get('dist')
for line in fileinput.FileInput(file3p, inplace=True):
if line.startswith('set(ZLIB_HOME'):
line = re.sub(r'ZLIB_HOME .*\)', r'ZLIB_HOME {})'.format(zlib_dist), line, flags = re.M)
if line.startswith('set(ZLIB_INCLUDE'):
line = re.sub(r'ZLIB_INCLUDE .*\)', r'ZLIB_INCLUDE ${ZLIB_HOME}/include)', line, flags = re.M)
if line.startswith('set(ZLIB_LIB_DEBUG'):
line = re.sub(r'ZLIB_LIB_DEBUG .*\)', r'ZLIB_LIB_DEBUG ${{ZLIB_HOME}}/lib/{})'.format(zlib_dbg), line, flags = re.M)
if line.startswith('set(ZLIB_LIB_RELEASE'):
line = re.sub(r'ZLIB_LIB_RELEASE .*\)', r'ZLIB_LIB_RELEASE ${{ZLIB_HOME}}/lib/{})'.format(zlib_rel), line, flags = re.M)
sys.stdout.write(line)
#mo = re.search(r'ZLIB_HOME .*\)+?', txt)
#txtn = re.sub(r'ZLIB_HOME .*\)+?', r'ZLIB_HOME {})'.format(ZLIB_DIST.replace('\\', '/')), txt, flags = re.M)
#txtn = re.sub(r'ZLIB_INCLUDE .*\)+?', r'ZLIB_INCLUDE ${ZLIB_HOME}/include)', txtn, flags = re.M)
#txtn = re.sub(r'ZLIB_LIB_DEBUG .*\)', r'ZLIB_LIB_DEBUG ${{ZLIB_HOME}}/lib/{})'.format(lib_dbg), txtn, flags = re.M)
#txtn = re.sub(r'ZLIB_LIB_RELEASE .*\)', r'ZLIB_LIB_RELEASE ${{ZLIB_HOME}}/lib/{})'.format(lib_rel), txtn, flags = re.M)
#END rocksdb_fix_3party
def rocksdb_build(link_type='t1', **kwargs): # ver=None, btype='Release', ptype='t3', **cfg
'''
:param str btype build type Release | Debug
:param str ptype Linkage type on Windows t1 | t2 | t3
NOTE: on Windows 'thridparty.inc' file has to be modified.
'''
ST = '[rocksdb_build]'
print(f'{ST} started')
is_git = kwargs.get(ROCKS).get('is_git', False)
url = kwargs.get(ROCKS).get('url') if is_git else kwargs.get(ROCKS).get('url2')
path = kwargs.get(ROCKS).get('path')
commit = kwargs.get(ROCKS).get('commit')
shallow = kwargs.get(ROCKS).get('shallow')
btype = kwargs.get(ROCKS).get('cmake_build_type', 'Release')
presets_file = kwargs.get(ROCKS).get('preset')
zlib_dist = kwargs.get(ZLIB).get('dist')
ret = git_clone(url, path, commit=commit) if is_git else load_tar(url, path)
if is_git:
cmd = ['git', 'checkout', commit] if commit else ['git', 'checkout', 'master']
ret = proc_run(cmd, path)
cmd = ['git', 'rev-parse', 'HEAD']
ret = proc_run(cmd, path, capture=True)
chash = ret.get('stdout')
print(f'{ST} building commit: {chash}')
if IS_WIN:
rocksdb_modify_3party_zlib(link_type, **kwargs)
# copy presets file
src = os.path.abspath(presets_file)
dst = os.path.abspath(f'{path}/CMakePresets.json')
print(f'{ST} copying {src} -> {dst}')
ret = shutil.copyfile(presets_file, f'{path}/CMakePresets.json')
dist_path = os.path.abspath(f'build/{path}/dist').replace('\\','/')
bt = btype.lower()
cmd = [
'cmake', '-S', path, '-B', f'build/{path}',
'--preset', f'{MY_OS}_{bt}',
f'-DCMAKE_INSTALL_PREFIX={dist_path}',
f'-DZLIB_ROOT={zlib_dist}',
'--fresh'
]
ret = proc_run(cmd)
if ret['retcode'] == 0:
cmd = [ 'cmake', '--build', f'build/{path}', '--config', btype, '--target', 'install' ]
ret = proc_run(cmd)
else:
print(f'{ST} failed to build')
return ret
#END rocksdb_build
def smr_build(ver=None, btype='release', link_type='t1', **kwargs):
'''
build sortmerna using CMake with CMakePresets.json
CMake flags mostly specified in presets - no need here
:param str ver git commit/tag - default master
:param str btype Build type Release | Debug
:param str link_type Linking type: t1 | t2 | t3
t1 all static
t2 static 3rd party + dynamic runtime
t3 all dynamic
'''
ST = '[smr_build]'
if ver and Path('.git').exists():
cmd = ['git', 'checkout', ver]
proc_run(cmd)
# list available presets
cmd = ['cmake', '--list-presets']
ret = proc_run(cmd, capture=True)
if bool(ret.get('retcode')):
print(ret)
return
presets = []
if ret.get('stdout'):
ol = ret.get('stdout').decode('utf8').replace('"','').split('\n')
presets = [l.strip() for l in ol if l.strip()][1:]
# cmake preset e.g. LIN_release | WIN_release
preset = f'LIN_{btype}' if IS_LNX or IS_WSL else f'WIN_{btype}'
if preset not in presets:
print('{} preset {} not found in available presets: {}'.format(ST, preset, presets))
return
# generate CMake configuration
# cmake -S . --preset LIN_Release
cmd = ['cmake', '-S', '.', '--preset', preset]
if opts.vb:
cmd.append('-DCMAKE_EXPORT_COMPILE_COMMANDS=1')
if opts.loglevel:
cmd.append('--loglevel={}'.format(opts.loglevel.upper()))
elif opts.trace:
cmd.append('--trace')
ret = proc_run(cmd)
# build and install
cmd = [ 'cmake', '--build', '--preset', preset, '--target', 'install' ]
ret = proc_run(cmd)
# generate installation package
if ret['retcode'] == 0:
cmd = [ 'cmake', '--build', '--preset', preset, '--target', 'package' ]
ret = proc_run(cmd)
# test CMAKE_INSTALL_PREFIX/bin/sortmerna --version
exe = 'sortmerna.exe' if IS_WIN else 'sortmerna'
if ret['retcode'] == 0:
cmd = [ f'dist/bin/{exe}', '--version' ]
ret = proc_run(cmd)
if ret['retcode'] == 0:
cmd = [ f'dist/bin/{exe}', '-h' ]
ret = proc_run(cmd)
return ret
#END smr_build
def concurrentqueue_build(**kwargs):
'''
a single header file - just clone and use
'''
url = kwargs.get(CCQUEUE).get('url')
path = kwargs.get(CCQUEUE).get('path')
commit = kwargs.get(CCQUEUE).get('commit')
shallow = kwargs.get(CCQUEUE).get('shallow')
ret = git_clone(url, path, commit=commit, shallow=shallow)
return ret
#END concurrentqueue_build
def env_check(**cfg):
'''
verify all pre-requisit packages/tools are present
:param dict cfg
'''
for env in cfg.get('env.config',[]):
if ENV in env.get('env', []):
for pkg in env.get('packages',[]):
funstr = f'{pkg}_install'
fun = modfunc.get(funstr)
ret = fun(**cfg)
condapkgs = ' '.join(env.get('conda.packages',[]))
if condapkgs:
cmd = f'conda install {condapkgs}'
ret = proc_run(cmd)
break
#END env_check
modfunc['git_install'] = git_install
modfunc['conda_install'] = conda_install
modfunc['gcc_install'] = gcc_install
modfunc['cmake_install'] = cmake_install
if __name__ == "__main__":
'''
python setup.py -n all build zlib + rocksdb + smr
python setup.py -n sortmerna build smr
python setup.py -n sortmerna [--cmake-preset <preset>] TODO
python setup.py -n zlib build zlib
python setup.py -n rocksdb build rocksdb
python setup.py -n conda install conda TODO
python setup.py -n cmake install cmake TODO
'''
ST = '[setup.py:__main__]'
is_opts_ok = True
# options
optpar = OptionParser()
optpar.add_option('-n', '--name', dest='name',
help='Package to build/process e.g. sortmerna | zlib | rocksdb | rapidjson | conda | all')
optpar.add_option('--zlib-dist', dest='zlib_dist', help='ZLib installation directory')
optpar.add_option('--zlib-git', action="store_true", help='use zlib git repo as source. Otherwise tarball')
optpar.add_option('--rocksdb-dist', dest='rocksdb_dist', help='ROcksDB installation directory')
optpar.add_option('--rocksdb-git', action="store_true", help='use rocksdb git repo as source. Otherwise tarball')
optpar.add_option('--build-dev', action="store_true", help='run build in development mode using git repos')
optpar.add_option('--concurrentqueue-dist', dest='concurrentqueue_dist', help='concurrentqueue installation directory')
optpar.add_option('-e', '--envn', dest='envname',
help=('Name of environment: WIN | WSL | LIN .. see env.jinja:env.list'))
optpar.add_option('--clone', action="store_true", help='Perform git clone for the given name')
optpar.add_option('-c', '--clean', action="store_true", help='clean build directory for the given name')
optpar.add_option('-b', '--btype', dest='btype', default='release', help = 'Build type: release | debug')
optpar.add_option('--pt_smr', dest='pt_smr', default='t1', help = 'Sortmerna Linkage type t1 | t2 | t3')
optpar.add_option('--pt_zlib', dest='pt_zlib', help = 'Zlib Linkage type t1 | t2 | t3')
optpar.add_option('--pt_rocks', dest='pt_rocks', help = 'Rocksdb Linkage type t1 | t2 | t3')
optpar.add_option('--rocks3p', dest='rocks3p', help='Fix thirdparty.inc when building Rocksb')
optpar.add_option('--winhome', dest='winhome',
help='when building on WSL - home directory on Windows side e.g. /mnt/c/Users/XX')
optpar.add_option('--trace', action="store_true", help='Run cmake with --trace')
optpar.add_option('--loglevel', dest='loglevel', help = 'Cmake log level')
optpar.add_option('--vb', action="store_true", help='Export compile commands')
optpar.add_option('--env', dest='envfile', help='Env configuration file.')
optpar.add_option('--config', dest='config', help='Build configuration file.')
optpar.add_option('--build-dir', dest='build_dir', help='Build directory.')
optpar.add_option('--dist-dir', dest='dist_dir', help='Distro directory.')
optpar.add_option('--local-linux', dest='local_linux', action='store_true', help='Perform the build on local source files in the current working directory.')
optpar.add_option('--cmake-preset', dest='cmake_preset', help='CMake preset')
(opts, args) = optpar.parse_args()
cur_dir = os.path.dirname(os.path.realpath(__file__)) # directory where this script is located
print(f'{ST} Current dir: {cur_dir}')
print(f'{ST} loading configuration from 3rdparty.jinja')
envjn = Environment(loader=FileSystemLoader('.'), trim_blocks=True, lstrip_blocks=True)
thirdparty_jinja = envjn.get_template('3rdparty.jinja')
# zlib
vars = { 'zlib_dist': opts.zlib_dist} if opts.zlib_dist else {}
# rocksdb
if opts.rocksdb_dist:
vars['rocksdb_dist'] = opts.rocksdb_dist
# concurrentqueue
if opts.concurrentqueue_dist:
vars['concurrentqueue_dist'] = opts.concurrentqueue_dist
jinja_str = thirdparty_jinja.render(vars)
third_party_data = yaml.load(jinja_str, Loader=yaml.FullLoader) # render jinja template
# set zlib and rocksdb default roots if not provided through options
if not third_party_data.get('zlib',{}).get('dist'):
pp = third_party_data['zlib']['path']
third_party_data['zlib']['dist'] = os.path.abspath(f'build/{pp}/dist').replace('\\', '/')
if not third_party_data.get('rocksdb',{}).get('dist'):
pp = third_party_data['rocksdb']['path']
third_party_data['rocksdb']['dist'] = os.path.abspath(f'build/{pp}/dist').replace('\\', '/')
if not third_party_data.get('concurrentqueue',{}).get('dist'):
pp = third_party_data['concurrentqueue']['path']
third_party_data['concurrentqueue']['dist'] = os.path.abspath(f'{pp}').replace('\\', '/')
opts.name = opts.name or ALL
if opts.name in [ALL]:
if opts.clean:
ret = clean('build')
if not opts.cmake_preset:
opts.cmake_preset = 'WIN_release' if IS_WIN else 'LIN_release'
kw = third_party_data.get(ZLIB,{})
if opts.zlib_git or opts.build_dev:
kw['is_git'] = True
ret = zlib_build(**kw)
if ret['retcode'] == 0:
if opts.rocksdb_git or opts.build_dev:
third_party_data['rocksdb']['is_git'] = True
ret = rocksdb_build(**third_party_data) # ROCKS_VER, cfg=env
if ret['retcode'] == 0:
ret = concurrentqueue_build(**third_party_data)
if ret['retcode'] == 0:
ret = smr_build(**third_party_data)
elif opts.name == ZLIB:
kw = third_party_data.get(ZLIB,{})
zlib_build(**kw)
elif opts.name == ROCKS:
if opts.clean:
...
rocksdb_build(**third_party_data)
elif opts.name in [SMR]:
if opts.clean:
...
smr_build(**third_party_data)
elif opts.name == CCQUEUE:
concurrentqueue_build(**third_party_data)
elif opts.name == DIRENT:
url = third_party_data[DIRENT].get('url')
path = third_party_data[DIRENT].get('path')
commit = third_party_data[DIRENT].get('commit')
shallow = third_party_data[DIRENT].get('shallow')
git_clone(url, path, commit=commit, shallow=shallow)
elif opts.name == CMAKE:
if opts.clone:
... #git_clone(env[CMAKE]['url'], LIB_DIR)
... #cmake_install(**env)
elif opts.name == CONDA:
... #conda_install(**env)
#elif opts.name == RAPID:
#rapidjson_build()
else: test()
#END main
#END END
|