From d878abaa769b71e973acee8de824d513ca6de7ed Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Tue, 10 Dec 2019 11:25:44 +0300 Subject: add simple build scripts They're intended to replace my build.sh (for Travis) and build.ps1 (for AppVeyor) scripts to call CMake in a platform-independent manner. --- build/.gitattributes | 1 + build/build.py | 235 ++++++++++++++++++++++++++++++++++++++++++++ build/build_appveyor.py | 131 ++++++++++++++++++++++++ build/build_boost_travis.sh | 51 ++++++++++ build/build_travis.py | 61 ++++++++++++ 5 files changed, 479 insertions(+) create mode 100644 build/.gitattributes create mode 100755 build/build.py create mode 100755 build/build_appveyor.py create mode 100755 build/build_boost_travis.sh create mode 100755 build/build_travis.py (limited to 'build') diff --git a/build/.gitattributes b/build/.gitattributes new file mode 100644 index 0000000..dfdb8b7 --- /dev/null +++ b/build/.gitattributes @@ -0,0 +1 @@ +*.sh text eol=lf diff --git a/build/build.py b/build/build.py new file mode 100755 index 0000000..8b398cf --- /dev/null +++ b/build/build.py @@ -0,0 +1,235 @@ +#!/usr/bin/env python3 + +# Copyright (c) 2019 Egor Tensin +# This file is part of the "cmake-common" project. +# For details, see https://github.com/egor-tensin/cmake-common. +# Distributed under the MIT License. + +# This script is used basically to invoke the CMake executable in a +# cross-platform way (provided the platform has Python 3, of course). +# The motivation was to merge my Travis and AppVeyor build scripts (largely +# similar, but written in bash and PowerShell, respectively). + +import argparse +from contextlib import contextmanager +import logging +from enum import Enum +import os +import os.path +import shutil +import subprocess +import sys +import tempfile + + +@contextmanager +def _chdir(path): + cwd = os.getcwd() + os.chdir(path) + try: + yield + finally: + os.chdir(cwd) + + +def _make_tmp_dir(**kwargs): + path = tempfile.mkdtemp(**kwargs) + logging.info('Created temporary directory: %s', path) + return path + + +def _log_rmtree_error(function, path, exc_info): + logging.error("Couldn't remove path '%s': %s", path, exc_info) + + +def _remove_dir(path): + logging.info('Removing directory: %s', path) + shutil.rmtree(path, onerror=_log_rmtree_error) + + +def _run_executable(cmd_line): + logging.info('Running executable: %s', cmd_line) + result = subprocess.run(cmd_line) + result.check_returncode() + + +def _run_cmake(cmake_args): + _run_executable(['cmake'] + cmake_args) + + +class Configuration(Enum): + DEBUG = 'Debug' + RELEASE = 'Release' + + def __str__(self): + return self.value + + +def _parse_configuration(s): + try: + return Configuration(s) + except ValueError: + raise argparse.ArgumentTypeError(f'invalid configuration: {s}') + + +class BuildDir: + def __init__(self, args): + self.path = args.build_dir + self.clean = args.clean_build_dir + self.tmp_dir = self.path is None + if self.tmp_dir: + self.path = self._make_build_dir() + + @staticmethod + def _make_build_dir(): + return _make_tmp_dir(prefix='build_') + + def go(self): + return _chdir(self.path) + + def __enter__(self): + return self + + def __exit__(self, *args): + if self.tmp_dir and self.clean: + _remove_dir(self.path) + + +class GenerationPhase: + def __init__(self, build_dir, args): + self.build_dir = build_dir + self.args = args + + def _cmake_args(self): + return self._to_cmake_args(self.build_dir, self.args) + + @staticmethod + def _to_cmake_args(build_dir, args): + result = [] + if args.generator is not None: + result += ['-G', args.generator] + if args.platform is not None: + result += ['-A', args.platform] + if args.install_dir is not None: + result.append(f'-DCMAKE_INSTALL_PREFIX={args.install_dir}') + if args.configuration is not None: + result.append(f'-DCMAKE_BUILD_TYPE={args.configuration}') + if args.toolchain_path is not None: + result.append(f'-DCMAKE_TOOLCHAIN_FILE={args.toolchain_path}') + if args.boost_root is not None: + result.append(f'-DBOOST_ROOT={args.boost_root}') + if args.boost_librarydir is not None: + result.append(f'-DBOOST_LIBRARYDIR={args.boost_librarydir}') + if args.cmake_args is not None: + result += [arg for arg in args.cmake_args] + result += [f'-B{build_dir.path}'] + result += [f'-H{args.src_dir}'] + return result + + def run(self): + _run_cmake(self._cmake_args()) + + +class BuildPhase: + def __init__(self, build_dir, args): + self.build_dir = build_dir + self.args = args + + def _cmake_args(self): + return self._to_cmake_args(self.build_dir, self.args) + + @staticmethod + def _to_cmake_args(build_dir, args): + result = ['--build', build_dir.path] + if args.clean_build_dir: + result.append('--clean-first') + if args.configuration is not None: + result += ['--config', str(args.configuration)] + if args.install_dir is not None: + result += ['--target', 'install'] + return result + + def run(self): + _run_cmake(self._cmake_args()) + + +class CleanPhase: + def __init__(self, build_dir, args): + self.build_dir = build_dir + self.args = args + + def _cmake_args(self): + return self._to_cmake_args(self.build_dir, self.args) + + @staticmethod + def _to_cmake_args(build_dir, args): + result = ['--build', build_dir.path] + if args.configuration is not None: + result += ['--config', str(args.configuration)] + result += ['--target', 'clean'] + return result + + def run(self): + if self.args.clean_build_dir: + _run_cmake(self._cmake_args()) + + +def _parse_args(argv=None): + if argv is None: + argv = sys.argv[1:] + logging.info('Command line arguments: %s', argv) + parser = argparse.ArgumentParser(description='Build a CMake project') + parser.add_argument('--src', required=True, dest='src_dir', + type=os.path.abspath, metavar='DIR', + help='source directory') + parser.add_argument('--build', metavar='DIR', dest='build_dir', + help='build directory (temporary directory if not specified)') + parser.add_argument('--install', metavar='DIR', dest='install_dir', + help='install directory') + parser.add_argument('--clean', action='store_true', dest='clean_build_dir', + help='clean the build directory (temporary directory will be removed)') + parser.add_argument('--generator', help='build system to use') + parser.add_argument('--platform', help='target platform (i.e. Win32/x64)') + parser.add_argument('--configuration', metavar='CONFIG', + type=_parse_configuration, + help='build configuration (i.e. Debug/Release)') + parser.add_argument('--toolchain', metavar='PATH', dest='toolchain_path', + help='CMake toolchain file path') + parser.add_argument('--boost', metavar='DIR', dest='boost_root', + help='set Boost directory') + parser.add_argument('--boost-librarydir', metavar='DIR', + help='set Boost library directory (stage/lib by default)') + parser.add_argument('cmake_args', nargs='*', metavar='CMAKE_ARG', + help='additional CMake arguments, to be passed verbatim') + args = parser.parse_args(argv) + return args + + +def _setup_logging(): + logging.basicConfig( + format='%(asctime)s | %(levelname)s | %(message)s', + level=logging.INFO) + + +def build(argv=None): + args = _parse_args(argv) + with BuildDir(args) as build_dir: + gen_phase = GenerationPhase(build_dir, args) + gen_phase.run() + build_phase = BuildPhase(build_dir, args) + build_phase.run() + clean_phase = CleanPhase(build_dir, args) + clean_phase.run() + + +def main(argv=None): + _setup_logging() + try: + build(argv) + except Exception as e: + logging.exception(e) + raise + + +if __name__ == '__main__': + main() diff --git a/build/build_appveyor.py b/build/build_appveyor.py new file mode 100755 index 0000000..2d2ee65 --- /dev/null +++ b/build/build_appveyor.py @@ -0,0 +1,131 @@ +#!/usr/bin/env python3 + +# Copyright (c) 2019 Egor Tensin +# This file is part of the "cmake-common" project. +# For details, see https://github.com/egor-tensin/cmake-common. +# Distributed under the MIT License. + +# This is similar to build.py, but auto-fills some parameters for build.py from +# the AppVeyor-defined environment variables. +# The project is built in C:\Projects\build. + +from enum import Enum +import logging +import os +import sys + +from build import build + + +class Image(Enum): + VS_2013 = 'Visual Studio 2013' + VS_2015 = 'Visual Studio 2015' + VS_2017 = 'Visual Studio 2017' + VS_2019 = 'Visual Studio 2019' + + def __str__(self): + return self.value + + +def _parse_image(s): + try: + return Image(s) + except ValueError as e: + raise ValueError(f'unsupported AppVeyor image: {s}') from e + + +class Generator(Enum): + VS_2013 = 'Visual Studio 12 2013' + VS_2015 = 'Visual Studio 14 2015' + VS_2017 = 'Visual Studio 15 2017' + VS_2019 = 'Visual Studio 16 2019' + + def __str__(self): + return self.value + + @staticmethod + def from_image(image): + if image is Image.VS_2013: + return Generator.VS_2013 + if image is Image.VS_2015: + return Generator.VS_2015 + if image is Image.VS_2017: + return Generator.VS_2017 + if image is Image.VS_2019: + return Generator.VS_2019 + raise RuntimeError(f"don't know which generator to use for image: {image}") + + +class Platform(Enum): + x86 = 'Win32' + X64 = 'x64' + + def __str__(self): + return self.value + + +def _parse_platform(s): + try: + return Platform(s) + except ValueError as e: + raise ValueError(f'unsupported AppVeyor platform: {s}') from e + + +def _env(name): + if name not in os.environ: + raise RuntimeError(f'undefined environment variable: {name}') + return os.environ[name] + + +def _get_src_dir(): + return _env('APPVEYOR_BUILD_FOLDER') + + +def _get_build_dir(): + return R'C:\Projects\build' + + +def _get_generator(): + image = _parse_image(_env('APPVEYOR_BUILD_WORKER_IMAGE')) + return str(Generator.from_image(image)) + + +def _get_platform(): + return str(_parse_platform(_env('PLATFORM'))) + + +def _get_configuration(): + return _env('CONFIGURATION') + + +def _setup_logging(): + logging.basicConfig( + format='%(asctime)s | %(levelname)s | %(message)s', + level=logging.INFO) + + +def build_appveyor(argv=None): + if argv is None: + argv = sys.argv[1:] + logging.info('Command line arguments: %s', argv) + appveyor_argv = [ + '--src', _get_src_dir(), + '--build', _get_build_dir(), + '--generator', _get_generator(), + '--platform', _get_platform(), + '--configuration', _get_configuration(), + ] + build(appveyor_argv + argv) + + +def main(argv=None): + _setup_logging() + try: + build_appveyor(argv) + except Exception as e: + logging.exception(e) + raise + + +if __name__ == '__main__': + main() diff --git a/build/build_boost_travis.sh b/build/build_boost_travis.sh new file mode 100755 index 0000000..1491bc8 --- /dev/null +++ b/build/build_boost_travis.sh @@ -0,0 +1,51 @@ +#!/usr/bin/env bash + +# Copyright (c) 2019 Egor Tensin +# This file is part of the "cmake-common" project. +# For details, see https://github.com/egor-tensin/cmake-common. +# Distributed under the MIT License. + +# This script is used during a Travis build to download and build Boost. +# Input: +# * environment variables $travis_boost_version, $configuration and $platform. +# Output: +# * unpacked Boost distribution at $HOME/boost_X_YY_Z, +# * built libraries at $HOME/boost_X_YY_Z/stage/$platform/${configuration,,}. + +set -o errexit -o nounset -o pipefail -o xtrace + +readonly base_dir="$HOME" +readonly boost_fs="boost_${travis_boost_version//\./_}" +readonly boost_url="https://dl.bintray.com/boostorg/release/$travis_boost_version/source/$boost_fs.tar.gz" +readonly boost_dir="$base_dir/$boost_fs" + +address_model=32 +[ "$platform" = x64 ] && address_model=64 +readonly address_model + +configuration="${configuration,,}" +readonly configuration + +download() { + cd -- "$base_dir" + wget --quiet -- "$boost_url" + tar xzvf "$boost_fs.tar.gz" > /dev/null +} + +build() { + cd -- "$boost_dir" + ./bootstrap.sh + + ./b2 \ + "address-model=$address_model" \ + variant="$configuration" \ + "--stagedir=stage/$platform/$configuration" \ + "$@" +} + +main() { + download + build "$@" +} + +main "$@" diff --git a/build/build_travis.py b/build/build_travis.py new file mode 100755 index 0000000..dce7fd7 --- /dev/null +++ b/build/build_travis.py @@ -0,0 +1,61 @@ +#!/usr/bin/env python3 + +# Copyright (c) 2019 Egor Tensin +# This file is part of the "cmake-common" project. +# For details, see https://github.com/egor-tensin/cmake-common. +# Distributed under the MIT License. + +# This is similar to build.py, but auto-fills some parameters for build.py from +# the Travis-defined environment variables. +# The project is built in $HOME/build. + +import logging +import os +import os.path +import sys + +from build import build + + +def _env(name): + if name not in os.environ: + raise RuntimeError(f'undefined environment variable: {name}') + return os.environ[name] + + +def _get_src_dir(): + return _env('TRAVIS_BUILD_DIR') + + +def _get_build_dir(): + return os.path.join(_env('HOME'), 'build') + + +def _setup_logging(): + logging.basicConfig( + format='%(asctime)s | %(levelname)s | %(message)s', + level=logging.INFO) + + +def build_travis(argv=None): + if argv is None: + argv = sys.argv[1:] + logging.info('Command line arguments: %s', argv) + travis_argv = [ + '--src', _get_src_dir(), + '--build', _get_build_dir(), + ] + build(travis_argv + argv) + + +def main(argv=None): + _setup_logging() + try: + build_travis(argv) + except Exception as e: + logging.exception(e) + raise + + +if __name__ == '__main__': + main() -- cgit v1.2.3