From 70da99e4f70845da37ae368c4788ecc18546792d Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Sat, 28 Mar 2020 17:19:43 +0000 Subject: WIP: restructure A stupid attempt to reduce code duplication led me to believe that all the scripts could use _a bit_ of refactoring. This is going to be a major pain (factoring out all the things), which I'll take gladly. All the links and usage examples are broken right now, but nobody cares, so whatevs. --- cmake/build/README.md | 13 ---- cmake/build/build.py | 190 --------------------------------------------- cmake/build/ci/appveyor.py | 167 --------------------------------------- cmake/build/ci/travis.py | 102 ------------------------ 4 files changed, 472 deletions(-) delete mode 100644 cmake/build/README.md delete mode 100755 cmake/build/build.py delete mode 100755 cmake/build/ci/appveyor.py delete mode 100755 cmake/build/ci/travis.py (limited to 'cmake/build') diff --git a/cmake/build/README.md b/cmake/build/README.md deleted file mode 100644 index b63564d..0000000 --- a/cmake/build/README.md +++ /dev/null @@ -1,13 +0,0 @@ -CMake -===== - -Build a CMake project. -Consult the output of `build.py --help` for details. - -A simple usage example: - - > python3 build.py --configuration Release --install path/to/somewhere -- ../examples/simple - ... - - > ./path/to/somewhere/bin/foo - foo diff --git a/cmake/build/build.py b/cmake/build/build.py deleted file mode 100755 index 695489b..0000000 --- a/cmake/build/build.py +++ /dev/null @@ -1,190 +0,0 @@ -#!/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. - -R'''Build a CMake project. - -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). - -A simple usage example: - - $ %(prog)s --configuration Release --install path/to/somewhere -- ../examples/simple - ... - - $ ./path/to/somewhere/bin/foo - foo - -Picking the target platform is build system-specific. On Visual Studio, pass -the target platform using the `-A` flag like this: - - > %(prog)s --install path\to\somewhere -- ..\examples\simple -A Win32 - ... - -Using GCC-like compilers, the best way is to use CMake toolchain files (see -cmake/toolchains in this repository for examples). - - $ %(prog)s --install path/to/somewhere -- ../examples/simple -D CMAKE_TOOLCHAIN_FILE="$( pwd )/../toolchains/mingw-x86.cmake" - ... -''' - -import argparse -from contextlib import contextmanager -import logging -from enum import Enum -import os -import os.path -import subprocess -import sys -import tempfile - - -def _run_executable(cmd_line): - logging.info('Running executable: %s', cmd_line) - return subprocess.run(cmd_line, check=True) - - -def _run_cmake(cmake_args): - _run_executable(['cmake'] + cmake_args) - - -class Configuration(Enum): - DEBUG = 'Debug' - MINSIZEREL = 'MinSizeRel' - RELWITHDEBINFO = 'RelWithDebInfo' - 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}') - - -@contextmanager -def _create_build_dir(args): - if args.build_dir is not None: - logging.info('Build directory: %s', args.build_dir) - yield args.build_dir - return - - with tempfile.TemporaryDirectory(dir=os.path.dirname(args.src_dir)) as build_dir: - logging.info('Build directory: %s', build_dir) - try: - yield build_dir - finally: - logging.info('Removing build directory: %s', build_dir) - return - - -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.install_dir is not None: - result += ['-D', f'CMAKE_INSTALL_PREFIX={args.install_dir}'] - if args.configuration is not None: - result += ['-D', f'CMAKE_BUILD_TYPE={args.configuration}'] - if args.cmake_args is not None: - result += args.cmake_args - result += [f'-B{build_dir}', 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] - 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()) - - -def _parse_dir(s): - return os.path.abspath(os.path.normpath(s)) - - -def _parse_args(argv=None): - if argv is None: - argv = sys.argv[1:] - logging.info('Command line arguments: %s', argv) - - parser = argparse.ArgumentParser( - description=__doc__, - formatter_class=argparse.RawDescriptionHelpFormatter) - - parser.add_argument('--build', metavar='DIR', dest='build_dir', - type=_parse_dir, - help='build directory (temporary directory unless specified)') - parser.add_argument('--install', metavar='DIR', dest='install_dir', - type=_parse_dir, - help='install directory') - parser.add_argument('--configuration', metavar='CONFIG', - type=_parse_configuration, default=Configuration.DEBUG, - help=f'build configuration ({"/".join(map(str, Configuration))})') - parser.add_argument('src_dir', metavar='DIR', - type=_parse_dir, - help='source directory') - 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 _create_build_dir(args) as build_dir: - gen_phase = GenerationPhase(build_dir, args) - gen_phase.run() - build_phase = BuildPhase(build_dir, args) - build_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/cmake/build/ci/appveyor.py b/cmake/build/ci/appveyor.py deleted file mode 100755 index b9141ec..0000000 --- a/cmake/build/ci/appveyor.py +++ /dev/null @@ -1,167 +0,0 @@ -#!/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. - -'''Build a CMake project on AppVeyor. - -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. -''' - -import argparse -from enum import Enum -import logging -import os -import sys - - -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 _check_appveyor(): - if 'APPVEYOR' not in os.environ: - raise RuntimeError('not running on AppVeyor') - - -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 _parse_args(argv=None): - if argv is None: - argv = sys.argv[1:] - logging.info('Command line arguments: %s', argv) - - parser = argparse.ArgumentParser( - description=__doc__, - formatter_class=argparse.RawDescriptionHelpFormatter) - - parser.add_argument('--install', metavar='DIR', dest='install_dir', - help='install directory') - parser.add_argument('cmake_args', nargs='*', metavar='CMAKE_ARG', default=[], - help='additional CMake arguments, to be passed verbatim') - return parser.parse_args(argv) - - -def build_appveyor(argv=None): - args = _parse_args(argv) - _check_appveyor() - - this_module_dir = os.path.dirname(os.path.abspath(__file__)) - parent_module_dir = os.path.dirname(this_module_dir) - sys.path.insert(1, parent_module_dir) - from build import build - - appveyor_argv = [ - '--build', _get_build_dir(), - '--configuration', _get_configuration(), - ] - if args.install_dir is not None: - appveyor_argv += [ - '--install', args.install_dir, - ] - appveyor_argv += [ - '--', - _get_src_dir(), - '-G', _get_generator(), - '-A', _get_platform(), - ] - build(appveyor_argv + args.cmake_args) - - -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/cmake/build/ci/travis.py b/cmake/build/ci/travis.py deleted file mode 100755 index ab93711..0000000 --- a/cmake/build/ci/travis.py +++ /dev/null @@ -1,102 +0,0 @@ -#!/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. - -'''Build a CMake project on Travis. - -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 argparse -import logging -import os -import os.path -import sys - - -def _env(name): - if name not in os.environ: - raise RuntimeError(f'undefined environment variable: {name}') - return os.environ[name] - - -def _check_travis(): - if 'TRAVIS' not in os.environ: - raise RuntimeError('not running on Travis') - - -def _get_src_dir(): - return _env('TRAVIS_BUILD_DIR') - - -def _get_build_dir(): - return os.path.join(_env('HOME'), 'build') - - -def _get_configuration(): - return _env('configuration') - - -def _setup_logging(): - logging.basicConfig( - format='%(asctime)s | %(levelname)s | %(message)s', - level=logging.INFO) - - -def _parse_args(argv=None): - if argv is None: - argv = sys.argv[1:] - logging.info('Command line arguments: %s', argv) - - parser = argparse.ArgumentParser( - description=__doc__, - formatter_class=argparse.RawDescriptionHelpFormatter) - - parser.add_argument('--install', metavar='DIR', dest='install_dir', - help='install directory') - parser.add_argument('cmake_args', nargs='*', metavar='CMAKE_ARG', default=[], - help='additional CMake arguments, to be passed verbatim') - return parser.parse_args(argv) - - -def build_travis(argv=None): - args = _parse_args(argv) - _check_travis() - - this_module_dir = os.path.dirname(os.path.abspath(__file__)) - parent_module_dir = os.path.dirname(this_module_dir) - sys.path.insert(1, parent_module_dir) - from build import build - - travis_argv = [ - '--build', _get_build_dir(), - '--configuration', _get_configuration(), - ] - if args.install_dir is not None: - travis_argv += [ - '--install', args.install_dir, - ] - travis_argv += [ - '--', - _get_src_dir(), - ] - build(travis_argv + args.cmake_args) - - -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