From 98e3a56296cb9955e49adb09a111f26e07328338 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Mon, 30 Mar 2020 11:56:05 +0300 Subject: project.ci: dedupe code --- project/ci/appveyor/boost.py | 103 +------------------------------ project/ci/appveyor/cmake.py | 127 +-------------------------------------- project/ci/appveyor/generator.py | 51 ++++++++++++++++ project/ci/boost.py | 59 ++++++++++++++++++ project/ci/cmake.py | 41 +++++++++++++ project/ci/dirs.py | 99 ++++++++++++++++++++++++++++++ project/ci/travis/boost.py | 101 +------------------------------ project/ci/travis/cmake.py | 80 +----------------------- project/utils.py | 6 ++ 9 files changed, 268 insertions(+), 399 deletions(-) create mode 100644 project/ci/appveyor/generator.py create mode 100644 project/ci/boost.py create mode 100644 project/ci/cmake.py create mode 100644 project/ci/dirs.py (limited to 'project') diff --git a/project/ci/appveyor/boost.py b/project/ci/appveyor/boost.py index df03aea..068fc26 100644 --- a/project/ci/appveyor/boost.py +++ b/project/ci/appveyor/boost.py @@ -3,111 +3,14 @@ # For details, see https://github.com/egor-tensin/cmake-common. # Distributed under the MIT License. -R'''Download & build Boost on AppVeyor. - -This is similar to running both project.boost.download & project.boost.build, -but auto-fills some parameters from the AppVeyor-defined environment variables. -This script is rarely usefull, since AppVeyor images come with lots of -pre-built Boost distributions, but still. - -Boost is built in C:\projects\boost. -''' - -import argparse -import logging -import os -import os.path -import sys - -from project.boost.version import Version -from project.boost.download import DownloadParameters, download -from project.boost.build import BuildParameters, build -from project.configuration import Configuration -from project.linkage import Linkage -from project.platform import Platform +from project.ci.boost import build_ci +from project.ci.dirs import AppVeyor from project.utils import setup_logging -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_build_dir(): - return R'C:\projects' - - -def _get_boost_dir(): - return os.path.join(_get_build_dir(), 'boost') - - -def _get_boost_version(): - return Version.from_string(_env('appveyor_boost_version')) - - -def _get_configuration(): - return Configuration.parse(_env('CONFIGURATION')) - - -def _get_platform(): - return Platform.parse(_env('PLATFORM')) - - -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('--link', metavar='LINKAGE', - nargs='*', type=Linkage.parse, - help='how the libraries are linked') - parser.add_argument('--runtime-link', metavar='LINKAGE', - type=Linkage.parse, - help='how the libraries link to the runtime') - parser.add_argument('--mingw', action='store_true', - help='build using MinGW-w64') - parser.add_argument('b2_args', metavar='B2_ARG', - nargs='*', default=[], - help='additional b2 arguments, to be passed verbatim') - - return parser.parse_args(argv) - - -def build_appveyor(argv=None): - args = _parse_args(argv) - _check_appveyor() - - version = _get_boost_version() - build_dir = _get_build_dir() - download(DownloadParameters(version, unpack_dir=build_dir)) - - unpacked_boost_dir = version.dir_path(build_dir) - boost_dir = _get_boost_dir() - os.rename(unpacked_boost_dir, boost_dir) - - params = BuildParameters(boost_dir, - platforms=(_get_platform(),), - configurations=(_get_configuration(),), - link=args.link, - runtime_link=args.runtime_link, - mingw=args.mingw, - b2_args=args.b2_args) - build(params) - - def main(argv=None): with setup_logging(): - build_appveyor(argv) + build_ci(AppVeyor(), argv) if __name__ == '__main__': diff --git a/project/ci/appveyor/cmake.py b/project/ci/appveyor/cmake.py index b720f6b..6df28f2 100644 --- a/project/ci/appveyor/cmake.py +++ b/project/ci/appveyor/cmake.py @@ -3,135 +3,14 @@ # For details, see https://github.com/egor-tensin/cmake-common. # Distributed under the MIT License. -R'''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 - -from project.cmake.build import BuildParameters, build -from project.configuration import Configuration -from project.platform import Platform +from project.ci.cmake import build_ci +from project.ci.dirs import AppVeyor from project.utils import setup_logging -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 - - @staticmethod - def parse(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}") - - -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 = Image.parse(_env('APPVEYOR_BUILD_WORKER_IMAGE')) - return Generator.from_image(image) - - -def _get_platform(): - return Platform.parse(_env('PLATFORM')) - - -def _get_configuration(): - return Configuration.parse(_env('CONFIGURATION')) - - -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('--boost', metavar='DIR', dest='boost_dir', - help='set Boost directory path') - 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() - - cmake_args = ['-G', str(_get_generator())] - cmake_args += args.cmake_args - - params = BuildParameters(_get_src_dir(), - build_dir=_get_build_dir(), - install_dir=args.install_dir, - platform=_get_platform(), - configuration=_get_configuration(), - boost_dir=args.boost_dir, - cmake_args=cmake_args) - build(params) - - def main(argv=None): with setup_logging(): - build_appveyor(argv) + build_ci(AppVeyor(), argv) if __name__ == '__main__': diff --git a/project/ci/appveyor/generator.py b/project/ci/appveyor/generator.py new file mode 100644 index 0000000..dc1fa13 --- /dev/null +++ b/project/ci/appveyor/generator.py @@ -0,0 +1,51 @@ +# Copyright (c) 2020 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. + +from enum import Enum + +from project.utils import env + + +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 + + @staticmethod + def parse(s): + try: + return Image(s) + except ValueError as e: + raise ValueError(f'unsupported AppVeyor image: {s}') from e + + @staticmethod + def get(): + return Image.parse(env('APPVEYOR_BUILD_WORKER_IMAGE')) + + +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}") diff --git a/project/ci/boost.py b/project/ci/boost.py new file mode 100644 index 0000000..75e73f3 --- /dev/null +++ b/project/ci/boost.py @@ -0,0 +1,59 @@ +# Copyright (c) 2020 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. + +import argparse +import logging +import os +import os.path +import sys + +from project.boost.download import DownloadParameters, download +from project.boost.build import BuildParameters, build +from project.linkage import Linkage + + +def _parse_args(dirs, argv=None): + if argv is None: + argv = sys.argv[1:] + logging.info('Command line arguments: %s', argv) + + parser = argparse.ArgumentParser( + description=dirs.get_boost_help(), + formatter_class=argparse.RawDescriptionHelpFormatter) + + parser.add_argument('--link', metavar='LINKAGE', + nargs='*', type=Linkage.parse, + help='how the libraries are linked') + parser.add_argument('--runtime-link', metavar='LINKAGE', + type=Linkage.parse, + help='how the libraries link to the runtime') + parser.add_argument('--mingw', action='store_true', + help='build using MinGW-w64') + parser.add_argument('b2_args', metavar='B2_ARG', + nargs='*', default=[], + help='additional b2 arguments, to be passed verbatim') + + return parser.parse_args(argv) + + +def build_ci(dirs, argv=None): + args = _parse_args(dirs, argv) + + version = dirs.get_boost_version() + build_dir = dirs.get_build_dir() + download(DownloadParameters(version, unpack_dir=build_dir)) + + unpacked_boost_dir = version.dir_path(build_dir) + boost_dir = dirs.get_boost_dir() + os.rename(unpacked_boost_dir, boost_dir) + + params = BuildParameters(boost_dir, + platforms=(dirs.get_platform(),), + configurations=(dirs.get_configuration(),), + link=args.link, + runtime_link=args.runtime_link, + mingw=args.mingw, + b2_args=args.b2_args) + build(params) diff --git a/project/ci/cmake.py b/project/ci/cmake.py new file mode 100644 index 0000000..6331e4b --- /dev/null +++ b/project/ci/cmake.py @@ -0,0 +1,41 @@ +# Copyright (c) 2020 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. + +import argparse +import logging +import sys + +from project.cmake.build import BuildParameters, build + + +def _parse_args(dirs, argv=None): + if argv is None: + argv = sys.argv[1:] + logging.info('Command line arguments: %s', argv) + + parser = argparse.ArgumentParser( + description=dirs.get_cmake_help(), + formatter_class=argparse.RawDescriptionHelpFormatter) + + parser.add_argument('--install', metavar='DIR', dest='install_dir', + help='install directory') + parser.add_argument('--boost', metavar='DIR', dest='boost_dir', + help='set Boost directory path') + 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_ci(dirs, argv=None): + args = _parse_args(dirs, argv) + + params = BuildParameters(dirs.get_src_dir(), + build_dir=dirs.get_build_dir(), + install_dir=args.install_dir, + platform=dirs.get_platform(), + configuration=dirs.get_configuration(), + boost_dir=args.boost_dir or dirs.get_boost_dir(), + cmake_args=dirs.get_cmake_args() + args.cmake_args) + build(params) diff --git a/project/ci/dirs.py b/project/ci/dirs.py new file mode 100644 index 0000000..9234df2 --- /dev/null +++ b/project/ci/dirs.py @@ -0,0 +1,99 @@ +# Copyright (c) 2020 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. + +import abc +import os.path + +from project.boost.version import Version +from project.ci.appveyor.generator import Generator, Image +from project.configuration import Configuration +from project.platform import Platform +from project.utils import env + + +class Dirs(abc.ABC): + def __init__(self): + pass + + @abc.abstractmethod + def get_platform(self): + pass + + @abc.abstractmethod + def get_configuration(self): + pass + + @abc.abstractmethod + def get_src_dir(self): + pass + + @abc.abstractmethod + def get_build_dir(self): + pass + + def get_boost_version(self): + return Version.from_string(env('boost_version')) + + def get_boost_dir(self): + return os.path.join(self.get_build_dir(), 'boost') + + def get_cmake_dir(self): + return os.path.join(self.get_build_dir(), 'build') + + @abc.abstractmethod + def get_cmake_args(self): + pass + + def get_boost_help(self): + return f'''Download & build Boost on Travis/AppVeyor. + +This is similar to running both project.boost.download & project.boost.build, +but auto-fills some parameters from environment variables. + +Boost is built in {self.get_boost_dir()}. +''' + + def get_cmake_help(self): + return f'''Build a CMake project on AppVeyor. + +This is similar to running project.cmake.build, but auto-fills some parameters +from environment variables. + +The project is built in {self.get_cmake_dir()}. +''' + + +class Travis(Dirs): + def get_platform(self): + return Platform.parse(env('platform')) + + def get_configuration(self): + return Configuration.parse(env('configuration')) + + def get_src_dir(self): + return env('TRAVIS_BUILD_DIR') + + def get_build_dir(self): + return env('HOME') + + def get_cmake_args(self): + return [] + + +class AppVeyor(Dirs): + def get_platform(self): + return Platform.parse(env('PLATFORM')) + + def get_configuration(self): + return Configuration.parse(env('CONFIGURATION')) + + def get_src_dir(self): + return env('APPVEYOR_BUILD_FOLDER') + + def get_build_dir(self): + return R'C:\projects' + + def get_cmake_args(self): + return ['-G', str(Generator.from_image(Image.get()))] diff --git a/project/ci/travis/boost.py b/project/ci/travis/boost.py index e77370c..7aff33e 100644 --- a/project/ci/travis/boost.py +++ b/project/ci/travis/boost.py @@ -3,109 +3,14 @@ # For details, see https://github.com/egor-tensin/cmake-common. # Distributed under the MIT License. -R'''Download & build Boost on Travis. - -This is similar to running both project.boost.download & project.boost.build, -but auto-fills some parameters from the Travis-defined environment variables. - -Boost is built in $HOME/boost. -''' - -import argparse -import logging -import os -import os.path -import sys - -from project.boost.version import Version -from project.boost.download import DownloadParameters, download -from project.boost.build import BuildParameters, build -from project.configuration import Configuration -from project.linkage import Linkage -from project.platform import Platform +from project.ci.boost import build_ci +from project.ci.dirs import Travis from project.utils import setup_logging -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_build_dir(): - return _env('HOME') - - -def _get_boost_dir(): - return os.path.join(_get_build_dir(), 'boost') - - -def _get_boost_version(): - return Version.from_string(_env('travis_boost_version')) - - -def _get_configuration(): - return Configuration.parse(_env('configuration')) - - -def _get_platform(): - return Platform.parse(_env('platform')) - - -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('--link', metavar='LINKAGE', - nargs='*', type=Linkage.parse, - help='how the libraries are linked') - parser.add_argument('--runtime-link', metavar='LINKAGE', - type=Linkage.parse, - help='how the libraries link to the runtime') - parser.add_argument('--mingw', action='store_true', - help='build using MinGW-w64') - parser.add_argument('b2_args', metavar='B2_ARG', - nargs='*', default=[], - help='additional b2 arguments, to be passed verbatim') - - return parser.parse_args(argv) - - -def build_travis(argv=None): - args = _parse_args(argv) - _check_travis() - - version = _get_boost_version() - build_dir = _get_build_dir() - download(DownloadParameters(version, unpack_dir=build_dir)) - - unpacked_boost_dir = version.dir_path(_get_build_dir()) - boost_dir = _get_boost_dir() - os.rename(unpacked_boost_dir, boost_dir) - - params = BuildParameters(boost_dir, - platforms=(_get_platform(),), - configurations=(_get_configuration(),), - link=args.link, - runtime_link=args.runtime_link, - mingw=args.mingw, - b2_args=args.b2_args) - build(params) - - def main(argv=None): with setup_logging(): - build_travis(argv) + build_ci(Travis(), argv) if __name__ == '__main__': diff --git a/project/ci/travis/cmake.py b/project/ci/travis/cmake.py index 2814e41..2f030af 100644 --- a/project/ci/travis/cmake.py +++ b/project/ci/travis/cmake.py @@ -3,88 +3,14 @@ # For details, see https://github.com/egor-tensin/cmake-common. # Distributed under the MIT License. -R'''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 - -from project.cmake.build import BuildParameters, build -from project.configuration import Configuration -from project.platform import Platform +from project.ci.cmake import build_ci +from project.ci.dirs import Travis from project.utils import setup_logging -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_platform(): - return Platform.parse(_env('platform')) - - -def _get_configuration(): - return Configuration.parse(_env('configuration')) - - -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('--boost', metavar='DIR', dest='boost_dir', - help='set Boost directory path') - 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() - - params = BuildParameters(_get_src_dir(), - build_dir=_get_build_dir(), - install_dir=args.install_dir, - platform=_get_platform(), - configuration=_get_configuration(), - boost_dir=args.boost_dir, - cmake_args=args.cmake_args) - build(params) - - def main(argv=None): with setup_logging(): - build_travis(argv) + build_ci(Travis(), argv) if __name__ == '__main__': diff --git a/project/utils.py b/project/utils.py index 68327af..5874eab 100644 --- a/project/utils.py +++ b/project/utils.py @@ -74,3 +74,9 @@ def temp_file(contents, **kwargs): file.write(contents) with delete(path): yield path + + +def env(name): + if name not in os.environ: + raise RuntimeError(f'undefined environment variable: {name}') + return os.environ[name] -- cgit v1.2.3