102871c91SPatrick Williams#!/usr/bin/env python3 202871c91SPatrick Williams# 302871c91SPatrick Williams# Build the required docker image to run package unit tests 402871c91SPatrick Williams# 502871c91SPatrick Williams# Script Variables: 602871c91SPatrick Williams# DOCKER_IMG_NAME: <optional, the name of the docker image to generate> 702871c91SPatrick Williams# default is openbmc/ubuntu-unit-test 802871c91SPatrick Williams# DISTRO: <optional, the distro to build a docker image against> 973395159SPatrick Williams# default is ubuntu:hirsute 1050837436SPatrick Williams# FORCE_DOCKER_BUILD: <optional, a non-zero value with force all Docker 1150837436SPatrick Williams# images to be rebuilt rather than reusing caches.> 1250837436SPatrick Williams# BUILD_URL: <optional, used to detect running under CI context 1350837436SPatrick Williams# (ex. Jenkins)> 1402871c91SPatrick Williams# BRANCH: <optional, branch to build from each of the openbmc/ 1502871c91SPatrick Williams# repositories> 1602871c91SPatrick Williams# default is master, which will be used if input branch not 1702871c91SPatrick Williams# provided or not found 1802871c91SPatrick Williams# UBUNTU_MIRROR: <optional, the URL of a mirror of Ubuntu to override the 1902871c91SPatrick Williams# default ones in /etc/apt/sources.list> 2002871c91SPatrick Williams# default is empty, and no mirror is used. 2102871c91SPatrick Williams# http_proxy The HTTP address of the proxy server to connect to. 2202871c91SPatrick Williams# Default: "", proxy is not setup if this is not set 2302871c91SPatrick Williams 2402871c91SPatrick Williamsimport os 2502871c91SPatrick Williamsimport sys 26b16f3e20SPatrick Williamsimport threading 27a18d9c57SPatrick Williamsfrom datetime import date 28a18d9c57SPatrick Williamsfrom hashlib import sha256 29ee3c9eebSPatrick Williamsfrom sh import docker, git, nproc, uname # type: ignore 30ee3c9eebSPatrick Williamsfrom typing import Any, Callable, Dict, Iterable, Optional 3102871c91SPatrick Williams 32ee3c9eebSPatrick Williamstry: 33ee3c9eebSPatrick Williams # Python before 3.8 doesn't have TypedDict, so reroute to standard 'dict'. 34ee3c9eebSPatrick Williams from typing import TypedDict 35ee3c9eebSPatrick Williamsexcept: 36ee3c9eebSPatrick Williams 37ee3c9eebSPatrick Williams class TypedDict(dict): # type: ignore 38ee3c9eebSPatrick Williams # We need to do this to eat the 'total' argument. 39ee3c9eebSPatrick Williams def __init_subclass__(cls, **kwargs): 40ee3c9eebSPatrick Williams super().__init_subclass__() 41ee3c9eebSPatrick Williams 42ee3c9eebSPatrick Williams 43ee3c9eebSPatrick Williams# Declare some variables used in package definitions. 44aae36d18SPatrick Williamsprefix = "/usr/local" 4502871c91SPatrick Williamsproc_count = nproc().strip() 4602871c91SPatrick Williams 47ee3c9eebSPatrick Williams 48ee3c9eebSPatrick Williamsclass PackageDef(TypedDict, total=False): 49ee3c9eebSPatrick Williams """ Package Definition for packages dictionary. """ 50ee3c9eebSPatrick Williams 51ee3c9eebSPatrick Williams # rev [optional]: Revision of package to use. 52ee3c9eebSPatrick Williams rev: str 53ee3c9eebSPatrick Williams # url [optional]: lambda function to create URL: (package, rev) -> url. 54ee3c9eebSPatrick Williams url: Callable[[str, str], str] 55ee3c9eebSPatrick Williams # depends [optional]: List of package dependencies. 56ee3c9eebSPatrick Williams depends: Iterable[str] 57ee3c9eebSPatrick Williams # build_type [required]: Build type used for package. 58ee3c9eebSPatrick Williams # Currently supported: autoconf, cmake, custom, make, meson 59ee3c9eebSPatrick Williams build_type: str 60ee3c9eebSPatrick Williams # build_steps [optional]: Steps to run for 'custom' build_type. 61ee3c9eebSPatrick Williams build_steps: Iterable[str] 62ee3c9eebSPatrick Williams # config_flags [optional]: List of options to pass configuration tool. 63ee3c9eebSPatrick Williams config_flags: Iterable[str] 64ee3c9eebSPatrick Williams # config_env [optional]: List of environment variables to set for config. 65ee3c9eebSPatrick Williams config_env: Iterable[str] 66ee3c9eebSPatrick Williams # custom_post_dl [optional]: List of steps to run after download, but 67ee3c9eebSPatrick Williams # before config / build / install. 68ee3c9eebSPatrick Williams custom_post_dl: Iterable[str] 696bce2ca1SPatrick Williams # custom_post_install [optional]: List of steps to run after install. 706bce2ca1SPatrick Williams custom_post_install: Iterable[str] 71ee3c9eebSPatrick Williams 72ee3c9eebSPatrick Williams # __tag [private]: Generated Docker tag name for package stage. 73ee3c9eebSPatrick Williams __tag: str 74ee3c9eebSPatrick Williams # __package [private]: Package object associated with this package. 75ee3c9eebSPatrick Williams __package: Any # Type is Package, but not defined yet. 76ee3c9eebSPatrick Williams 7702871c91SPatrick Williams 787204324cSPatrick Williams# Packages to include in image. 797204324cSPatrick Williamspackages = { 80ee3c9eebSPatrick Williams "boost": PackageDef( 81ee3c9eebSPatrick Williams rev="1.75.0", 82ee3c9eebSPatrick Williams url=( 835f2549eaSPatrick Williams lambda pkg, rev: f"https://downloads.yoctoproject.org/mirror/sources/{pkg}_{rev.replace('.', '_')}.tar.bz2" 842abc4a48SPatrick Williams ), 85ee3c9eebSPatrick Williams build_type="custom", 86ee3c9eebSPatrick Williams build_steps=[ 87aae36d18SPatrick Williams f"./bootstrap.sh --prefix={prefix} --with-libraries=context,coroutine", 88aae36d18SPatrick Williams "./b2", 89aae36d18SPatrick Williams f"./b2 install --prefix={prefix}", 90aae36d18SPatrick Williams ], 91ee3c9eebSPatrick Williams ), 92ee3c9eebSPatrick Williams "USCiLab/cereal": PackageDef( 933f8b5294SPatrick Williams rev="3e4d1b84cab4891368d2179a61a7ba06a5693e7f", 94ee3c9eebSPatrick Williams build_type="custom", 95ee3c9eebSPatrick Williams build_steps=[f"cp -a include/cereal/ {prefix}/include/"], 96ee3c9eebSPatrick Williams ), 97ee3c9eebSPatrick Williams "catchorg/Catch2": PackageDef( 9896b43455SWilliam A. Kennington III rev="v2.13.6", 99ee3c9eebSPatrick Williams build_type="cmake", 100ee3c9eebSPatrick Williams config_flags=["-DBUILD_TESTING=OFF", "-DCATCH_INSTALL_DOCS=OFF"], 101ee3c9eebSPatrick Williams ), 102ee3c9eebSPatrick Williams "CLIUtils/CLI11": PackageDef( 103ee3c9eebSPatrick Williams rev="v1.9.1", 104ee3c9eebSPatrick Williams build_type="cmake", 105ee3c9eebSPatrick Williams config_flags=[ 106aae36d18SPatrick Williams "-DBUILD_TESTING=OFF", 107aae36d18SPatrick Williams "-DCLI11_BUILD_DOCS=OFF", 108aae36d18SPatrick Williams "-DCLI11_BUILD_EXAMPLES=OFF", 109aae36d18SPatrick Williams ], 110ee3c9eebSPatrick Williams ), 111ee3c9eebSPatrick Williams "fmtlib/fmt": PackageDef( 112ee3c9eebSPatrick Williams rev="7.1.3", 113ee3c9eebSPatrick Williams build_type="cmake", 114ee3c9eebSPatrick Williams config_flags=[ 115aae36d18SPatrick Williams "-DFMT_DOC=OFF", 116aae36d18SPatrick Williams "-DFMT_TEST=OFF", 117aae36d18SPatrick Williams ], 118ee3c9eebSPatrick Williams ), 119ee3c9eebSPatrick Williams "Naios/function2": PackageDef( 12096b43455SWilliam A. Kennington III rev="4.1.0", 121ee3c9eebSPatrick Williams build_type="custom", 122ee3c9eebSPatrick Williams build_steps=[ 123aae36d18SPatrick Williams f"mkdir {prefix}/include/function2", 124aae36d18SPatrick Williams f"cp include/function2/function2.hpp {prefix}/include/function2/", 125aae36d18SPatrick Williams ], 126ee3c9eebSPatrick Williams ), 127ee3c9eebSPatrick Williams "google/googletest": PackageDef( 128ee3c9eebSPatrick Williams rev="release-1.10.0", 129ee3c9eebSPatrick Williams build_type="cmake", 130ee3c9eebSPatrick Williams config_env=["CXXFLAGS=-std=c++17"], 131ee3c9eebSPatrick Williams config_flags=["-DTHREADS_PREFER_PTHREAD_FLAG=ON"], 132ee3c9eebSPatrick Williams ), 13302871c91SPatrick Williams # Release 2020-08-06 134ee3c9eebSPatrick Williams "nlohmann/json": PackageDef( 135ee3c9eebSPatrick Williams rev="v3.9.1", 1366bce2ca1SPatrick Williams build_type="cmake", 1376bce2ca1SPatrick Williams config_flags=["-DJSON_BuildTests=OFF"], 1386bce2ca1SPatrick Williams custom_post_install=[ 139aae36d18SPatrick Williams f"ln -s {prefix}/include/nlohmann/json.hpp {prefix}/include/json.hpp", 140aae36d18SPatrick Williams ], 141ee3c9eebSPatrick Williams ), 14202871c91SPatrick Williams # Snapshot from 2019-05-24 143ee3c9eebSPatrick Williams "linux-test-project/lcov": PackageDef( 144ee3c9eebSPatrick Williams rev="v1.15", 145ee3c9eebSPatrick Williams build_type="make", 146ee3c9eebSPatrick Williams ), 1470eedeedaSPatrick Williams # dev-5.8 2021-01-11 148ee3c9eebSPatrick Williams "openbmc/linux": PackageDef( 149ee3c9eebSPatrick Williams rev="3cc95ae40716e56f81b69615781f54c78079042d", 150ee3c9eebSPatrick Williams build_type="custom", 151ee3c9eebSPatrick Williams build_steps=[ 152aae36d18SPatrick Williams f"make -j{proc_count} defconfig", 153aae36d18SPatrick Williams f"make INSTALL_HDR_PATH={prefix} headers_install", 154aae36d18SPatrick Williams ], 155ee3c9eebSPatrick Williams ), 1560eedeedaSPatrick Williams # Snapshot from 2020-06-13 157ee3c9eebSPatrick Williams "LibVNC/libvncserver": PackageDef( 158ee3c9eebSPatrick Williams rev="LibVNCServer-0.9.13", 159ee3c9eebSPatrick Williams build_type="cmake", 160ee3c9eebSPatrick Williams ), 161ee3c9eebSPatrick Williams "martinmoene/span-lite": PackageDef( 16296b43455SWilliam A. Kennington III rev="v0.9.2", 163ee3c9eebSPatrick Williams build_type="cmake", 164ee3c9eebSPatrick Williams config_flags=[ 165aae36d18SPatrick Williams "-DSPAN_LITE_OPT_BUILD_TESTS=OFF", 166aae36d18SPatrick Williams ], 167ee3c9eebSPatrick Williams ), 1680eedeedaSPatrick Williams # version from meta-openembedded/meta-oe/recipes-support/libtinyxml2/libtinyxml2_8.0.0.bb 169ee3c9eebSPatrick Williams "leethomason/tinyxml2": PackageDef( 170ee3c9eebSPatrick Williams rev="8.0.0", 171ee3c9eebSPatrick Williams build_type="cmake", 172ee3c9eebSPatrick Williams ), 17302871c91SPatrick Williams # version from /meta-openembedded/meta-oe/recipes-devtools/boost-url/boost-url_git.bb 174ee3c9eebSPatrick Williams "CPPAlliance/url": PackageDef( 175ee3c9eebSPatrick Williams rev="a56ae0df6d3078319755fbaa67822b4fa7fd352b", 176ee3c9eebSPatrick Williams build_type="cmake", 177ee3c9eebSPatrick Williams config_flags=[ 178aae36d18SPatrick Williams "-DBOOST_URL_BUILD_EXAMPLES=OFF", 179aae36d18SPatrick Williams "-DBOOST_URL_BUILD_TESTS=OFF", 180aae36d18SPatrick Williams "-DBOOST_URL_STANDALONE=ON", 181aae36d18SPatrick Williams ], 182ee3c9eebSPatrick Williams ), 1830eedeedaSPatrick Williams # version from ./meta-openembedded/meta-oe/dynamic-layers/networking-layer/recipes-devtools/valijson/valijson_0.3.bb 1840eedeedaSPatrick Williams # Snapshot from 2020-12-02 - fix for curlpp dependency 185ee3c9eebSPatrick Williams "tristanpenman/valijson": PackageDef( 186ee3c9eebSPatrick Williams rev="8cc83c8be9c1c927f5da952b2333b30e5f0353be", 187ee3c9eebSPatrick Williams build_type="cmake", 188ee3c9eebSPatrick Williams config_flags=[ 1890eedeedaSPatrick Williams "-Dvalijson_BUILD_TESTS=0", 1900eedeedaSPatrick Williams "-Dvalijson_INSTALL_HEADERS=1", 191aae36d18SPatrick Williams ], 192ee3c9eebSPatrick Williams ), 19302871c91SPatrick Williams # version from meta-openembedded/meta-oe/recipes-devtools/nlohmann-fifo/nlohmann-fifo_git.bb 194ee3c9eebSPatrick Williams "nlohmann/fifo_map": PackageDef( 195ee3c9eebSPatrick Williams rev="0dfbf5dacbb15a32c43f912a7e66a54aae39d0f9", 196ee3c9eebSPatrick Williams build_type="custom", 197ee3c9eebSPatrick Williams build_steps=[f"cp src/fifo_map.hpp {prefix}/include/"], 198ee3c9eebSPatrick Williams ), 199ee3c9eebSPatrick Williams "open-power/pdbg": PackageDef(build_type="autoconf"), 200ee3c9eebSPatrick Williams "openbmc/gpioplus": PackageDef( 201ee3c9eebSPatrick Williams depends=["openbmc/stdplus"], 202ee3c9eebSPatrick Williams build_type="meson", 203ee3c9eebSPatrick Williams config_flags=[ 204aae36d18SPatrick Williams "-Dexamples=false", 205aae36d18SPatrick Williams "-Dtests=disabled", 206aae36d18SPatrick Williams ], 207ee3c9eebSPatrick Williams ), 208ee3c9eebSPatrick Williams "openbmc/phosphor-dbus-interfaces": PackageDef( 209ee3c9eebSPatrick Williams depends=["openbmc/sdbusplus"], 210ee3c9eebSPatrick Williams build_type="meson", 211ee3c9eebSPatrick Williams config_flags=[ 212aae36d18SPatrick Williams "-Ddata_com_ibm=true", 213aae36d18SPatrick Williams "-Ddata_org_open_power=true", 214aae36d18SPatrick Williams ], 215ee3c9eebSPatrick Williams ), 216ee3c9eebSPatrick Williams "openbmc/phosphor-logging": PackageDef( 217ee3c9eebSPatrick Williams depends=[ 21883394610SPatrick Williams "USCiLab/cereal", 21983394610SPatrick Williams "nlohmann/fifo_map", 22083394610SPatrick Williams "openbmc/phosphor-dbus-interfaces", 22183394610SPatrick Williams "openbmc/sdbusplus", 22283394610SPatrick Williams "openbmc/sdeventplus", 223aae36d18SPatrick Williams ], 224f79ce4c4SPatrick Williams build_type="meson", 225ee3c9eebSPatrick Williams config_flags=[ 226f79ce4c4SPatrick Williams f"-Dyaml_dir={prefix}/share/phosphor-dbus-yaml/yaml", 227aae36d18SPatrick Williams ], 228ee3c9eebSPatrick Williams ), 229ee3c9eebSPatrick Williams "openbmc/phosphor-objmgr": PackageDef( 230ee3c9eebSPatrick Williams depends=[ 23183394610SPatrick Williams "boost", 23283394610SPatrick Williams "leethomason/tinyxml2", 23383394610SPatrick Williams "openbmc/phosphor-logging", 23483394610SPatrick Williams "openbmc/sdbusplus", 235aae36d18SPatrick Williams ], 236ee3c9eebSPatrick Williams build_type="autoconf", 237ee3c9eebSPatrick Williams ), 238ee3c9eebSPatrick Williams "openbmc/pldm": PackageDef( 239ee3c9eebSPatrick Williams depends=[ 24083394610SPatrick Williams "CLIUtils/CLI11", 24183394610SPatrick Williams "boost", 24283394610SPatrick Williams "nlohmann/json", 24383394610SPatrick Williams "openbmc/phosphor-dbus-interfaces", 24483394610SPatrick Williams "openbmc/phosphor-logging", 24583394610SPatrick Williams "openbmc/sdbusplus", 24683394610SPatrick Williams "openbmc/sdeventplus", 247aae36d18SPatrick Williams ], 248ee3c9eebSPatrick Williams build_type="meson", 249ee3c9eebSPatrick Williams config_flags=[ 250aae36d18SPatrick Williams "-Dlibpldm-only=enabled", 251aae36d18SPatrick Williams "-Doem-ibm=enabled", 252aae36d18SPatrick Williams "-Dtests=disabled", 253aae36d18SPatrick Williams ], 254ee3c9eebSPatrick Williams ), 255ee3c9eebSPatrick Williams "openbmc/sdbusplus": PackageDef( 256ee3c9eebSPatrick Williams build_type="meson", 257ee3c9eebSPatrick Williams custom_post_dl=[ 258aae36d18SPatrick Williams "cd tools", 259aae36d18SPatrick Williams f"./setup.py install --root=/ --prefix={prefix}", 260aae36d18SPatrick Williams "cd ..", 261aae36d18SPatrick Williams ], 262ee3c9eebSPatrick Williams config_flags=[ 263aae36d18SPatrick Williams "-Dexamples=disabled", 264aae36d18SPatrick Williams "-Dtests=disabled", 265aae36d18SPatrick Williams ], 266b16f3e20SPatrick Williams ), 267ee3c9eebSPatrick Williams "openbmc/sdeventplus": PackageDef( 268ee3c9eebSPatrick Williams depends=["Naios/function2", "openbmc/stdplus"], 269ee3c9eebSPatrick Williams build_type="meson", 270ee3c9eebSPatrick Williams config_flags=[ 271ee3c9eebSPatrick Williams "-Dexamples=false", 272ee3c9eebSPatrick Williams "-Dtests=disabled", 273ee3c9eebSPatrick Williams ], 274ee3c9eebSPatrick Williams ), 275ee3c9eebSPatrick Williams "openbmc/stdplus": PackageDef( 276ee3c9eebSPatrick Williams depends=["fmtlib/fmt", "martinmoene/span-lite"], 277ee3c9eebSPatrick Williams build_type="meson", 278ee3c9eebSPatrick Williams config_flags=[ 279ee3c9eebSPatrick Williams "-Dexamples=false", 280ee3c9eebSPatrick Williams "-Dtests=disabled", 281ee3c9eebSPatrick Williams ], 282ee3c9eebSPatrick Williams ), 283ee3c9eebSPatrick Williams} # type: Dict[str, PackageDef] 28402871c91SPatrick Williams 28502871c91SPatrick Williams# Define common flags used for builds 28602871c91SPatrick Williamsconfigure_flags = " ".join( 28702871c91SPatrick Williams [ 28802871c91SPatrick Williams f"--prefix={prefix}", 28902871c91SPatrick Williams ] 29002871c91SPatrick Williams) 29102871c91SPatrick Williamscmake_flags = " ".join( 29202871c91SPatrick Williams [ 29302871c91SPatrick Williams "-DBUILD_SHARED_LIBS=ON", 2940f2086b3SPatrick Williams "-DCMAKE_BUILD_TYPE=RelWithDebInfo", 29502871c91SPatrick Williams f"-DCMAKE_INSTALL_PREFIX:PATH={prefix}", 2960f2086b3SPatrick Williams "-GNinja", 2970f2086b3SPatrick Williams "-DCMAKE_MAKE_PROGRAM=ninja", 29802871c91SPatrick Williams ] 29902871c91SPatrick Williams) 30002871c91SPatrick Williamsmeson_flags = " ".join( 30102871c91SPatrick Williams [ 30202871c91SPatrick Williams "--wrap-mode=nodownload", 30302871c91SPatrick Williams f"-Dprefix={prefix}", 30402871c91SPatrick Williams ] 30502871c91SPatrick Williams) 30602871c91SPatrick Williams 307ee3c9eebSPatrick Williams 308ee3c9eebSPatrick Williamsclass Package(threading.Thread): 309ee3c9eebSPatrick Williams """Class used to build the Docker stages for each package. 310ee3c9eebSPatrick Williams 311ee3c9eebSPatrick Williams Generally, this class should not be instantiated directly but through 312ee3c9eebSPatrick Williams Package.generate_all(). 313ee3c9eebSPatrick Williams """ 314ee3c9eebSPatrick Williams 315ee3c9eebSPatrick Williams # Copy the packages dictionary. 316ee3c9eebSPatrick Williams packages = packages.copy() 317ee3c9eebSPatrick Williams 318ee3c9eebSPatrick Williams # Lock used for thread-safety. 319ee3c9eebSPatrick Williams lock = threading.Lock() 320ee3c9eebSPatrick Williams 321ee3c9eebSPatrick Williams def __init__(self, pkg: str): 322ee3c9eebSPatrick Williams """ pkg - The name of this package (ex. foo/bar ) """ 323ee3c9eebSPatrick Williams super(Package, self).__init__() 324ee3c9eebSPatrick Williams 325ee3c9eebSPatrick Williams self.package = pkg 326ee3c9eebSPatrick Williams self.exception = None # type: Optional[Exception] 327ee3c9eebSPatrick Williams 328ee3c9eebSPatrick Williams # Reference to this package's 329ee3c9eebSPatrick Williams self.pkg_def = Package.packages[pkg] 330ee3c9eebSPatrick Williams self.pkg_def["__package"] = self 331ee3c9eebSPatrick Williams 332ee3c9eebSPatrick Williams def run(self) -> None: 333ee3c9eebSPatrick Williams """ Thread 'run' function. Builds the Docker stage. """ 334ee3c9eebSPatrick Williams 335ee3c9eebSPatrick Williams # In case this package has no rev, fetch it from Github. 336ee3c9eebSPatrick Williams self._update_rev() 337ee3c9eebSPatrick Williams 338ee3c9eebSPatrick Williams # Find all the Package objects that this package depends on. 339ee3c9eebSPatrick Williams # This section is locked because we are looking into another 340ee3c9eebSPatrick Williams # package's PackageDef dict, which could be being modified. 341ee3c9eebSPatrick Williams Package.lock.acquire() 342ee3c9eebSPatrick Williams deps: Iterable[Package] = [ 343ee3c9eebSPatrick Williams Package.packages[deppkg]["__package"] 344ee3c9eebSPatrick Williams for deppkg in self.pkg_def.get("depends", []) 345ee3c9eebSPatrick Williams ] 346ee3c9eebSPatrick Williams Package.lock.release() 347ee3c9eebSPatrick Williams 348ee3c9eebSPatrick Williams # Wait until all the depends finish building. We need them complete 349ee3c9eebSPatrick Williams # for the "COPY" commands. 350ee3c9eebSPatrick Williams for deppkg in deps: 351ee3c9eebSPatrick Williams deppkg.join() 352ee3c9eebSPatrick Williams 353ee3c9eebSPatrick Williams # Generate this package's Dockerfile. 354ee3c9eebSPatrick Williams dockerfile = f""" 355ee3c9eebSPatrick WilliamsFROM {docker_base_img_name} 356ee3c9eebSPatrick Williams{self._df_copycmds()} 357ee3c9eebSPatrick Williams{self._df_build()} 358ee3c9eebSPatrick Williams""" 359ee3c9eebSPatrick Williams 360ee3c9eebSPatrick Williams # Generate the resulting tag name and save it to the PackageDef. 361ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef, 362ee3c9eebSPatrick Williams # which can be accessed by other threads. 363ee3c9eebSPatrick Williams Package.lock.acquire() 364ee3c9eebSPatrick Williams tag = Docker.tagname(self._stagename(), dockerfile) 365ee3c9eebSPatrick Williams self.pkg_def["__tag"] = tag 366ee3c9eebSPatrick Williams Package.lock.release() 367ee3c9eebSPatrick Williams 368ee3c9eebSPatrick Williams # Do the build / save any exceptions. 369ee3c9eebSPatrick Williams try: 370ee3c9eebSPatrick Williams Docker.build(self.package, tag, dockerfile) 371ee3c9eebSPatrick Williams except Exception as e: 372ee3c9eebSPatrick Williams self.exception = e 373ee3c9eebSPatrick Williams 374ee3c9eebSPatrick Williams @classmethod 375ee3c9eebSPatrick Williams def generate_all(cls) -> None: 376ee3c9eebSPatrick Williams """Ensure a Docker stage is created for all defined packages. 377ee3c9eebSPatrick Williams 378ee3c9eebSPatrick Williams These are done in parallel but with appropriate blocking per 379ee3c9eebSPatrick Williams package 'depends' specifications. 380ee3c9eebSPatrick Williams """ 381ee3c9eebSPatrick Williams 382ee3c9eebSPatrick Williams # Create a Package for each defined package. 383ee3c9eebSPatrick Williams pkg_threads = [Package(p) for p in cls.packages.keys()] 384ee3c9eebSPatrick Williams 385ee3c9eebSPatrick Williams # Start building them all. 3866dbd7807SPatrick Williams # This section is locked because threads depend on each other, 3876dbd7807SPatrick Williams # based on the packages, and they cannot 'join' on a thread 3886dbd7807SPatrick Williams # which is not yet started. Adding a lock here allows all the 3896dbd7807SPatrick Williams # threads to start before they 'join' their dependencies. 3906dbd7807SPatrick Williams Package.lock.acquire() 391ee3c9eebSPatrick Williams for t in pkg_threads: 392ee3c9eebSPatrick Williams t.start() 3936dbd7807SPatrick Williams Package.lock.release() 394ee3c9eebSPatrick Williams 395ee3c9eebSPatrick Williams # Wait for completion. 396ee3c9eebSPatrick Williams for t in pkg_threads: 397ee3c9eebSPatrick Williams t.join() 398ee3c9eebSPatrick Williams # Check if the thread saved off its own exception. 399ee3c9eebSPatrick Williams if t.exception: 400ee3c9eebSPatrick Williams print(f"Package {t.package} failed!", file=sys.stderr) 401ee3c9eebSPatrick Williams raise t.exception 402ee3c9eebSPatrick Williams 403ee3c9eebSPatrick Williams @staticmethod 404ee3c9eebSPatrick Williams def df_all_copycmds() -> str: 405ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to copy all packages 406ee3c9eebSPatrick Williams into the final image. 407ee3c9eebSPatrick Williams """ 408ee3c9eebSPatrick Williams return Package.df_copycmds_set(Package.packages.keys()) 409ee3c9eebSPatrick Williams 410ee3c9eebSPatrick Williams @classmethod 411ee3c9eebSPatrick Williams def depcache(cls) -> str: 412ee3c9eebSPatrick Williams """Create the contents of the '/tmp/depcache'. 413ee3c9eebSPatrick Williams This file is a comma-separated list of "<pkg>:<rev>". 414ee3c9eebSPatrick Williams """ 415ee3c9eebSPatrick Williams 416ee3c9eebSPatrick Williams # This needs to be sorted for consistency. 417ee3c9eebSPatrick Williams depcache = "" 418ee3c9eebSPatrick Williams for pkg in sorted(cls.packages.keys()): 419ee3c9eebSPatrick Williams depcache += "%s:%s," % (pkg, cls.packages[pkg]["rev"]) 420ee3c9eebSPatrick Williams return depcache 421ee3c9eebSPatrick Williams 422ee3c9eebSPatrick Williams def _update_rev(self) -> None: 423ee3c9eebSPatrick Williams """ Look up the HEAD for missing a static rev. """ 424ee3c9eebSPatrick Williams 425ee3c9eebSPatrick Williams if "rev" in self.pkg_def: 426ee3c9eebSPatrick Williams return 427ee3c9eebSPatrick Williams 42865b21fb9SPatrick Williams # Check if Jenkins/Gerrit gave us a revision and use it. 42965b21fb9SPatrick Williams if gerrit_project == self.package and gerrit_rev: 43065b21fb9SPatrick Williams print( 43165b21fb9SPatrick Williams f"Found Gerrit revision for {self.package}: {gerrit_rev}", 43265b21fb9SPatrick Williams file=sys.stderr, 43365b21fb9SPatrick Williams ) 43465b21fb9SPatrick Williams self.pkg_def["rev"] = gerrit_rev 43565b21fb9SPatrick Williams return 43665b21fb9SPatrick Williams 437ee3c9eebSPatrick Williams # Ask Github for all the branches. 438ee3c9eebSPatrick Williams lookup = git("ls-remote", "--heads", f"https://github.com/{self.package}") 439ee3c9eebSPatrick Williams 440ee3c9eebSPatrick Williams # Find the branch matching {branch} (or fallback to master). 441ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef. 442ee3c9eebSPatrick Williams Package.lock.acquire() 443ee3c9eebSPatrick Williams for line in lookup.split("\n"): 444ee3c9eebSPatrick Williams if f"refs/heads/{branch}" in line: 445ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 446ee3c9eebSPatrick Williams elif f"refs/heads/master" in line and "rev" not in self.pkg_def: 447ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 448ee3c9eebSPatrick Williams Package.lock.release() 449ee3c9eebSPatrick Williams 450ee3c9eebSPatrick Williams def _stagename(self) -> str: 451ee3c9eebSPatrick Williams """ Create a name for the Docker stage associated with this pkg. """ 452ee3c9eebSPatrick Williams return self.package.replace("/", "-").lower() 453ee3c9eebSPatrick Williams 454ee3c9eebSPatrick Williams def _url(self) -> str: 455ee3c9eebSPatrick Williams """ Get the URL for this package. """ 456ee3c9eebSPatrick Williams rev = self.pkg_def["rev"] 457ee3c9eebSPatrick Williams 458ee3c9eebSPatrick Williams # If the lambda exists, call it. 459ee3c9eebSPatrick Williams if "url" in self.pkg_def: 460ee3c9eebSPatrick Williams return self.pkg_def["url"](self.package, rev) 461ee3c9eebSPatrick Williams 462ee3c9eebSPatrick Williams # Default to the github archive URL. 463ee3c9eebSPatrick Williams return f"https://github.com/{self.package}/archive/{rev}.tar.gz" 464ee3c9eebSPatrick Williams 465ee3c9eebSPatrick Williams def _cmd_download(self) -> str: 466ee3c9eebSPatrick Williams """Formulate the command necessary to download and unpack to source.""" 467ee3c9eebSPatrick Williams 468ee3c9eebSPatrick Williams url = self._url() 469ee3c9eebSPatrick Williams if ".tar." not in url: 470ee3c9eebSPatrick Williams raise NotImplementedError( 471ee3c9eebSPatrick Williams f"Unhandled download type for {self.package}: {url}" 472ee3c9eebSPatrick Williams ) 473ee3c9eebSPatrick Williams 474ee3c9eebSPatrick Williams cmd = f"curl -L {url} | tar -x" 475ee3c9eebSPatrick Williams 476ee3c9eebSPatrick Williams if url.endswith(".bz2"): 477ee3c9eebSPatrick Williams cmd += "j" 478ee3c9eebSPatrick Williams elif url.endswith(".gz"): 479ee3c9eebSPatrick Williams cmd += "z" 480ee3c9eebSPatrick Williams else: 481ee3c9eebSPatrick Williams raise NotImplementedError( 482ee3c9eebSPatrick Williams f"Unknown tar flags needed for {self.package}: {url}" 483ee3c9eebSPatrick Williams ) 484ee3c9eebSPatrick Williams 485ee3c9eebSPatrick Williams return cmd 486ee3c9eebSPatrick Williams 487ee3c9eebSPatrick Williams def _cmd_cd_srcdir(self) -> str: 488ee3c9eebSPatrick Williams """ Formulate the command necessary to 'cd' into the source dir. """ 489ee3c9eebSPatrick Williams return f"cd {self.package.split('/')[-1]}*" 490ee3c9eebSPatrick Williams 491ee3c9eebSPatrick Williams def _df_copycmds(self) -> str: 492ee3c9eebSPatrick Williams """ Formulate the dockerfile snippet necessary to COPY all depends. """ 493ee3c9eebSPatrick Williams 494ee3c9eebSPatrick Williams if "depends" not in self.pkg_def: 495ee3c9eebSPatrick Williams return "" 496ee3c9eebSPatrick Williams return Package.df_copycmds_set(self.pkg_def["depends"]) 497ee3c9eebSPatrick Williams 498ee3c9eebSPatrick Williams @staticmethod 499ee3c9eebSPatrick Williams def df_copycmds_set(pkgs: Iterable[str]) -> str: 500ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to COPY a set of 501ee3c9eebSPatrick Williams packages into a Docker stage. 502ee3c9eebSPatrick Williams """ 503ee3c9eebSPatrick Williams 504ee3c9eebSPatrick Williams copy_cmds = "" 505ee3c9eebSPatrick Williams 506ee3c9eebSPatrick Williams # Sort the packages for consistency. 507ee3c9eebSPatrick Williams for p in sorted(pkgs): 508ee3c9eebSPatrick Williams tag = Package.packages[p]["__tag"] 509ee3c9eebSPatrick Williams copy_cmds += f"COPY --from={tag} {prefix} {prefix}\n" 510ee3c9eebSPatrick Williams # Workaround for upstream docker bug and multiple COPY cmds 511ee3c9eebSPatrick Williams # https://github.com/moby/moby/issues/37965 512ee3c9eebSPatrick Williams copy_cmds += "RUN true\n" 513ee3c9eebSPatrick Williams 514ee3c9eebSPatrick Williams return copy_cmds 515ee3c9eebSPatrick Williams 516ee3c9eebSPatrick Williams def _df_build(self) -> str: 517ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to download, build, and 518ee3c9eebSPatrick Williams install a package into a Docker stage. 519ee3c9eebSPatrick Williams """ 520ee3c9eebSPatrick Williams 521ee3c9eebSPatrick Williams # Download and extract source. 522ee3c9eebSPatrick Williams result = f"RUN {self._cmd_download()} && {self._cmd_cd_srcdir()} && " 523ee3c9eebSPatrick Williams 524ee3c9eebSPatrick Williams # Handle 'custom_post_dl' commands. 525ee3c9eebSPatrick Williams custom_post_dl = self.pkg_def.get("custom_post_dl") 526ee3c9eebSPatrick Williams if custom_post_dl: 527ee3c9eebSPatrick Williams result += " && ".join(custom_post_dl) + " && " 528ee3c9eebSPatrick Williams 529ee3c9eebSPatrick Williams # Build and install package based on 'build_type'. 530ee3c9eebSPatrick Williams build_type = self.pkg_def["build_type"] 531ee3c9eebSPatrick Williams if build_type == "autoconf": 532ee3c9eebSPatrick Williams result += self._cmd_build_autoconf() 533ee3c9eebSPatrick Williams elif build_type == "cmake": 534ee3c9eebSPatrick Williams result += self._cmd_build_cmake() 535ee3c9eebSPatrick Williams elif build_type == "custom": 536ee3c9eebSPatrick Williams result += self._cmd_build_custom() 537ee3c9eebSPatrick Williams elif build_type == "make": 538ee3c9eebSPatrick Williams result += self._cmd_build_make() 539ee3c9eebSPatrick Williams elif build_type == "meson": 540ee3c9eebSPatrick Williams result += self._cmd_build_meson() 541ee3c9eebSPatrick Williams else: 542ee3c9eebSPatrick Williams raise NotImplementedError( 543ee3c9eebSPatrick Williams f"Unhandled build type for {self.package}: {build_type}" 544ee3c9eebSPatrick Williams ) 545ee3c9eebSPatrick Williams 5466bce2ca1SPatrick Williams # Handle 'custom_post_install' commands. 5476bce2ca1SPatrick Williams custom_post_install = self.pkg_def.get("custom_post_install") 5486bce2ca1SPatrick Williams if custom_post_install: 5496bce2ca1SPatrick Williams result += " && " + " && ".join(custom_post_install) 5506bce2ca1SPatrick Williams 551ee3c9eebSPatrick Williams return result 552ee3c9eebSPatrick Williams 553ee3c9eebSPatrick Williams def _cmd_build_autoconf(self) -> str: 554ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 555ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 556ee3c9eebSPatrick Williams result = "./bootstrap.sh && " 557ee3c9eebSPatrick Williams result += f"{env} ./configure {configure_flags} {options} && " 558ee3c9eebSPatrick Williams result += f"make -j{proc_count} && make install" 559ee3c9eebSPatrick Williams return result 560ee3c9eebSPatrick Williams 561ee3c9eebSPatrick Williams def _cmd_build_cmake(self) -> str: 562ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 563ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 564ee3c9eebSPatrick Williams result = "mkdir builddir && cd builddir && " 565ee3c9eebSPatrick Williams result += f"{env} cmake {cmake_flags} {options} .. && " 566ee3c9eebSPatrick Williams result += "cmake --build . --target all && " 567ee3c9eebSPatrick Williams result += "cmake --build . --target install && " 568ee3c9eebSPatrick Williams result += "cd .." 569ee3c9eebSPatrick Williams return result 570ee3c9eebSPatrick Williams 571ee3c9eebSPatrick Williams def _cmd_build_custom(self) -> str: 572ee3c9eebSPatrick Williams return " && ".join(self.pkg_def.get("build_steps", [])) 573ee3c9eebSPatrick Williams 574ee3c9eebSPatrick Williams def _cmd_build_make(self) -> str: 575ee3c9eebSPatrick Williams return f"make -j{proc_count} && make install" 576ee3c9eebSPatrick Williams 577ee3c9eebSPatrick Williams def _cmd_build_meson(self) -> str: 578ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 579ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 580ee3c9eebSPatrick Williams result = f"{env} meson builddir {meson_flags} {options} && " 581ee3c9eebSPatrick Williams result += "ninja -C builddir && ninja -C builddir install" 582ee3c9eebSPatrick Williams return result 583ee3c9eebSPatrick Williams 584ee3c9eebSPatrick Williams 585ee3c9eebSPatrick Williamsclass Docker: 586ee3c9eebSPatrick Williams """Class to assist with Docker interactions. All methods are static.""" 587ee3c9eebSPatrick Williams 588ee3c9eebSPatrick Williams @staticmethod 589ee3c9eebSPatrick Williams def timestamp() -> str: 590ee3c9eebSPatrick Williams """ Generate a timestamp for today using the ISO week. """ 591ee3c9eebSPatrick Williams today = date.today().isocalendar() 592ee3c9eebSPatrick Williams return f"{today[0]}-W{today[1]:02}" 593ee3c9eebSPatrick Williams 594ee3c9eebSPatrick Williams @staticmethod 595ee3c9eebSPatrick Williams def tagname(pkgname: str, dockerfile: str) -> str: 596ee3c9eebSPatrick Williams """ Generate a tag name for a package using a hash of the Dockerfile. """ 597ee3c9eebSPatrick Williams result = docker_image_name 598ee3c9eebSPatrick Williams if pkgname: 599ee3c9eebSPatrick Williams result += "-" + pkgname 600ee3c9eebSPatrick Williams 601ee3c9eebSPatrick Williams result += ":" + Docker.timestamp() 602ee3c9eebSPatrick Williams result += "-" + sha256(dockerfile.encode()).hexdigest()[0:16] 603ee3c9eebSPatrick Williams 604ee3c9eebSPatrick Williams return result 605ee3c9eebSPatrick Williams 606ee3c9eebSPatrick Williams @staticmethod 607ee3c9eebSPatrick Williams def build(pkg: str, tag: str, dockerfile: str) -> None: 608ee3c9eebSPatrick Williams """Build a docker image using the Dockerfile and tagging it with 'tag'.""" 609ee3c9eebSPatrick Williams 610ee3c9eebSPatrick Williams # If we're not forcing builds, check if it already exists and skip. 611ee3c9eebSPatrick Williams if not force_build: 612ee3c9eebSPatrick Williams if docker.image.ls(tag, "--format", '"{{.Repository}}:{{.Tag}}"'): 613ee3c9eebSPatrick Williams print(f"Image {tag} already exists. Skipping.", file=sys.stderr) 614ee3c9eebSPatrick Williams return 615ee3c9eebSPatrick Williams 616ee3c9eebSPatrick Williams # Build it. 617ee3c9eebSPatrick Williams # Capture the output of the 'docker build' command and send it to 618ee3c9eebSPatrick Williams # stderr (prefixed with the package name). This allows us to see 619ee3c9eebSPatrick Williams # progress but not polute stdout. Later on we output the final 620ee3c9eebSPatrick Williams # docker tag to stdout and we want to keep that pristine. 621ee3c9eebSPatrick Williams # 622ee3c9eebSPatrick Williams # Other unusual flags: 623ee3c9eebSPatrick Williams # --no-cache: Bypass the Docker cache if 'force_build'. 624ee3c9eebSPatrick Williams # --force-rm: Clean up Docker processes if they fail. 625ee3c9eebSPatrick Williams docker.build( 626ee3c9eebSPatrick Williams proxy_args, 627ee3c9eebSPatrick Williams "--network=host", 628ee3c9eebSPatrick Williams "--force-rm", 629ee3c9eebSPatrick Williams "--no-cache=true" if force_build else "--no-cache=false", 630ee3c9eebSPatrick Williams "-t", 631ee3c9eebSPatrick Williams tag, 632ee3c9eebSPatrick Williams "-", 633ee3c9eebSPatrick Williams _in=dockerfile, 634ee3c9eebSPatrick Williams _out=( 635ee3c9eebSPatrick Williams lambda line: print( 636ee3c9eebSPatrick Williams pkg + ":", line, end="", file=sys.stderr, flush=True 637ee3c9eebSPatrick Williams ) 638ee3c9eebSPatrick Williams ), 639ee3c9eebSPatrick Williams ) 640ee3c9eebSPatrick Williams 641ee3c9eebSPatrick Williams 642ee3c9eebSPatrick Williams# Read a bunch of environment variables. 643ee3c9eebSPatrick Williamsdocker_image_name = os.environ.get("DOCKER_IMAGE_NAME", "openbmc/ubuntu-unit-test") 644ee3c9eebSPatrick Williamsforce_build = os.environ.get("FORCE_DOCKER_BUILD") 645ee3c9eebSPatrick Williamsis_automated_ci_build = os.environ.get("BUILD_URL", False) 64673395159SPatrick Williamsdistro = os.environ.get("DISTRO", "ubuntu:hirsute") 647ee3c9eebSPatrick Williamsbranch = os.environ.get("BRANCH", "master") 648ee3c9eebSPatrick Williamsubuntu_mirror = os.environ.get("UBUNTU_MIRROR") 649ee3c9eebSPatrick Williamshttp_proxy = os.environ.get("http_proxy") 650ee3c9eebSPatrick Williams 65165b21fb9SPatrick Williamsgerrit_project = os.environ.get("GERRIT_PROJECT") 65265b21fb9SPatrick Williamsgerrit_rev = os.environ.get("GERRIT_PATCHSET_REVISION") 65365b21fb9SPatrick Williams 654ee3c9eebSPatrick Williams# Set up some common variables. 655ee3c9eebSPatrick Williamsusername = os.environ.get("USER", "root") 656ee3c9eebSPatrick Williamshomedir = os.environ.get("HOME", "/root") 657ee3c9eebSPatrick Williamsgid = os.getgid() 658ee3c9eebSPatrick Williamsuid = os.getuid() 659ee3c9eebSPatrick Williams 660ee3c9eebSPatrick Williams# Determine the architecture for Docker. 661ee3c9eebSPatrick Williamsarch = uname("-m").strip() 662ee3c9eebSPatrick Williamsif arch == "ppc64le": 663ee3c9eebSPatrick Williams docker_base = "ppc64le/" 664ee3c9eebSPatrick Williamselif arch == "x86_64": 665ee3c9eebSPatrick Williams docker_base = "" 666ee3c9eebSPatrick Williamselse: 667ee3c9eebSPatrick Williams print( 668ee3c9eebSPatrick Williams f"Unsupported system architecture({arch}) found for docker image", 669ee3c9eebSPatrick Williams file=sys.stderr, 670ee3c9eebSPatrick Williams ) 671ee3c9eebSPatrick Williams sys.exit(1) 672ee3c9eebSPatrick Williams 67302871c91SPatrick Williams# Special flags if setting up a deb mirror. 67402871c91SPatrick Williamsmirror = "" 67502871c91SPatrick Williamsif "ubuntu" in distro and ubuntu_mirror: 67602871c91SPatrick Williams mirror = f""" 67702871c91SPatrick WilliamsRUN echo "deb {ubuntu_mirror} $(. /etc/os-release && echo $VERSION_CODENAME) main restricted universe multiverse" > /etc/apt/sources.list && \\ 67802871c91SPatrick Williams echo "deb {ubuntu_mirror} $(. /etc/os-release && echo $VERSION_CODENAME)-updates main restricted universe multiverse" >> /etc/apt/sources.list && \\ 67902871c91SPatrick Williams echo "deb {ubuntu_mirror} $(. /etc/os-release && echo $VERSION_CODENAME)-security main restricted universe multiverse" >> /etc/apt/sources.list && \\ 68002871c91SPatrick Williams echo "deb {ubuntu_mirror} $(. /etc/os-release && echo $VERSION_CODENAME)-proposed main restricted universe multiverse" >> /etc/apt/sources.list && \\ 68102871c91SPatrick Williams echo "deb {ubuntu_mirror} $(. /etc/os-release && echo $VERSION_CODENAME)-backports main restricted universe multiverse" >> /etc/apt/sources.list 68202871c91SPatrick Williams""" 68302871c91SPatrick Williams 68402871c91SPatrick Williams# Special flags for proxying. 68502871c91SPatrick Williamsproxy_cmd = "" 68602871c91SPatrick Williamsproxy_args = [] 68702871c91SPatrick Williamsif http_proxy: 68802871c91SPatrick Williams proxy_cmd = f""" 68902871c91SPatrick WilliamsRUN echo "[http]" >> {homedir}/.gitconfig && \ 69002871c91SPatrick Williams echo "proxy = {http_proxy}" >> {homedir}/.gitconfig 69102871c91SPatrick Williams""" 69202871c91SPatrick Williams proxy_args.extend( 69302871c91SPatrick Williams [ 69402871c91SPatrick Williams "--build-arg", 69502871c91SPatrick Williams f"http_proxy={http_proxy}", 69602871c91SPatrick Williams "--build-arg", 697d461cd6aSLei YU f"https_proxy={http_proxy}", 69802871c91SPatrick Williams ] 69902871c91SPatrick Williams ) 70002871c91SPatrick Williams 701ee3c9eebSPatrick Williams# Create base Dockerfile. 702a18d9c57SPatrick Williamsdockerfile_base = f""" 703a18d9c57SPatrick WilliamsFROM {docker_base}{distro} 70402871c91SPatrick Williams 70502871c91SPatrick Williams{mirror} 70602871c91SPatrick Williams 70702871c91SPatrick WilliamsENV DEBIAN_FRONTEND noninteractive 70802871c91SPatrick Williams 70902871c91SPatrick WilliamsENV PYTHONPATH "/usr/local/lib/python3.8/site-packages/" 71002871c91SPatrick Williams 711bb16ac14SPatrick Williams# Sometimes the ubuntu key expires and we need a way to force an execution 712bb16ac14SPatrick Williams# of the apt-get commands for the dbgsym-keyring. When this happens we see 713bb16ac14SPatrick Williams# an error like: "Release: The following signatures were invalid:" 714bb16ac14SPatrick Williams# Insert a bogus echo that we can change here when we get this error to force 715bb16ac14SPatrick Williams# the update. 716bb16ac14SPatrick WilliamsRUN echo "ubuntu keyserver rev as of 2021-04-21" 717bb16ac14SPatrick Williams 71802871c91SPatrick Williams# We need the keys to be imported for dbgsym repos 71902871c91SPatrick Williams# New releases have a package, older ones fall back to manual fetching 72002871c91SPatrick Williams# https://wiki.ubuntu.com/Debug%20Symbol%20Packages 72150837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && \ 722f79ce4c4SPatrick Williams ( apt-get install gpgv ubuntu-dbgsym-keyring || \ 72350837436SPatrick Williams ( apt-get install -yy dirmngr && \ 72450837436SPatrick Williams apt-key adv --keyserver keyserver.ubuntu.com \ 72550837436SPatrick Williams --recv-keys F2EDC64DC5AEE1F6B9C621F0C8CAB6595FDFF622 ) ) 72602871c91SPatrick Williams 72702871c91SPatrick Williams# Parse the current repo list into a debug repo list 72802871c91SPatrick WilliamsRUN sed -n '/^deb /s,^deb [^ ]* ,deb http://ddebs.ubuntu.com ,p' /etc/apt/sources.list >/etc/apt/sources.list.d/debug.list 72902871c91SPatrick Williams 73002871c91SPatrick Williams# Remove non-existent debug repos 73102871c91SPatrick WilliamsRUN sed -i '/-\(backports\|security\) /d' /etc/apt/sources.list.d/debug.list 73202871c91SPatrick Williams 73302871c91SPatrick WilliamsRUN cat /etc/apt/sources.list.d/debug.list 73402871c91SPatrick Williams 73502871c91SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && apt-get install -yy \ 73602871c91SPatrick Williams gcc-10 \ 73702871c91SPatrick Williams g++-10 \ 73802871c91SPatrick Williams libc6-dbg \ 73902871c91SPatrick Williams libc6-dev \ 74002871c91SPatrick Williams libtool \ 74102871c91SPatrick Williams bison \ 74202871c91SPatrick Williams libdbus-1-dev \ 74302871c91SPatrick Williams flex \ 74402871c91SPatrick Williams cmake \ 74502871c91SPatrick Williams python3 \ 74602871c91SPatrick Williams python3-dev\ 74702871c91SPatrick Williams python3-yaml \ 74802871c91SPatrick Williams python3-mako \ 74902871c91SPatrick Williams python3-pip \ 75002871c91SPatrick Williams python3-setuptools \ 75102871c91SPatrick Williams python3-git \ 75202871c91SPatrick Williams python3-socks \ 75302871c91SPatrick Williams pkg-config \ 75402871c91SPatrick Williams autoconf \ 75502871c91SPatrick Williams autoconf-archive \ 75602871c91SPatrick Williams libsystemd-dev \ 75702871c91SPatrick Williams systemd \ 75802871c91SPatrick Williams libssl-dev \ 75902871c91SPatrick Williams libevdev-dev \ 76002871c91SPatrick Williams libjpeg-dev \ 76102871c91SPatrick Williams libpng-dev \ 76202871c91SPatrick Williams ninja-build \ 76302871c91SPatrick Williams sudo \ 76402871c91SPatrick Williams curl \ 76502871c91SPatrick Williams git \ 76602871c91SPatrick Williams dbus \ 76702871c91SPatrick Williams iputils-ping \ 768d83ca9a3SPatrick Williams clang-11 \ 769d83ca9a3SPatrick Williams clang-format-11 \ 770d83ca9a3SPatrick Williams clang-tidy-11 \ 771d83ca9a3SPatrick Williams clang-tools-11 \ 77202871c91SPatrick Williams shellcheck \ 77302871c91SPatrick Williams npm \ 77402871c91SPatrick Williams iproute2 \ 77502871c91SPatrick Williams libnl-3-dev \ 77602871c91SPatrick Williams libnl-genl-3-dev \ 77702871c91SPatrick Williams libconfig++-dev \ 77802871c91SPatrick Williams libsnmp-dev \ 77902871c91SPatrick Williams valgrind \ 78002871c91SPatrick Williams valgrind-dbg \ 78102871c91SPatrick Williams libpam0g-dev \ 78202871c91SPatrick Williams xxd \ 78302871c91SPatrick Williams libi2c-dev \ 78402871c91SPatrick Williams wget \ 78502871c91SPatrick Williams libldap2-dev \ 78602871c91SPatrick Williams libprotobuf-dev \ 78702871c91SPatrick Williams libperlio-gzip-perl \ 78802871c91SPatrick Williams libjson-perl \ 78902871c91SPatrick Williams protobuf-compiler \ 79002871c91SPatrick Williams libgpiod-dev \ 79102871c91SPatrick Williams device-tree-compiler \ 79202871c91SPatrick Williams cppcheck \ 79302871c91SPatrick Williams libpciaccess-dev \ 79402871c91SPatrick Williams libmimetic-dev \ 79502871c91SPatrick Williams libxml2-utils \ 7960eedeedaSPatrick Williams libxml-simple-perl \ 7970eedeedaSPatrick Williams rsync 79802871c91SPatrick Williams 79902871c91SPatrick WilliamsRUN update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 1000 \ 80002871c91SPatrick Williams --slave /usr/bin/g++ g++ /usr/bin/g++-10 \ 80102871c91SPatrick Williams --slave /usr/bin/gcov gcov /usr/bin/gcov-10 \ 80202871c91SPatrick Williams --slave /usr/bin/gcov-dump gcov-dump /usr/bin/gcov-dump-10 \ 80302871c91SPatrick Williams --slave /usr/bin/gcov-tool gcov-tool /usr/bin/gcov-tool-10 80402871c91SPatrick Williams 805d83ca9a3SPatrick WilliamsRUN update-alternatives --install /usr/bin/clang clang /usr/bin/clang-11 1000 \ 806d83ca9a3SPatrick Williams --slave /usr/bin/clang++ clang++ /usr/bin/clang++-11 \ 807d83ca9a3SPatrick Williams --slave /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-11 \ 808d83ca9a3SPatrick Williams --slave /usr/bin/clang-format clang-format /usr/bin/clang-format-11 \ 809d83ca9a3SPatrick Williams --slave /usr/bin/run-clang-tidy.py run-clang-tidy.py /usr/bin/run-clang-tidy-11.py \ 810d83ca9a3SPatrick Williams --slave /usr/bin/scan-build scan-build /usr/bin/scan-build-11 81102871c91SPatrick Williams 81250837436SPatrick Williams""" 81350837436SPatrick Williams 81450837436SPatrick Williamsif is_automated_ci_build: 81550837436SPatrick Williams dockerfile_base += f""" 81650837436SPatrick Williams# Run an arbitrary command to polute the docker cache regularly force us 81750837436SPatrick Williams# to re-run `apt-get update` daily. 818ee3c9eebSPatrick WilliamsRUN echo {Docker.timestamp()} 81950837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy 82050837436SPatrick Williams 82150837436SPatrick Williams""" 82250837436SPatrick Williams 82350837436SPatrick Williamsdockerfile_base += f""" 82402871c91SPatrick WilliamsRUN pip3 install inflection 82502871c91SPatrick WilliamsRUN pip3 install pycodestyle 82602871c91SPatrick WilliamsRUN pip3 install jsonschema 827*3992d10cSWilliam A. Kennington IIIRUN pip3 install meson==0.58.0 82802871c91SPatrick WilliamsRUN pip3 install protobuf 829e6f120aaSManojkiran EdaRUN pip3 install codespell 830a18d9c57SPatrick Williams""" 83102871c91SPatrick Williams 832ee3c9eebSPatrick Williams# Build the base and stage docker images. 833ee3c9eebSPatrick Williamsdocker_base_img_name = Docker.tagname("base", dockerfile_base) 834ee3c9eebSPatrick WilliamsDocker.build("base", docker_base_img_name, dockerfile_base) 835ee3c9eebSPatrick WilliamsPackage.generate_all() 83602871c91SPatrick Williams 837ee3c9eebSPatrick Williams# Create the final Dockerfile. 838a18d9c57SPatrick Williamsdockerfile = f""" 83902871c91SPatrick Williams# Build the final output image 840a18d9c57SPatrick WilliamsFROM {docker_base_img_name} 841ee3c9eebSPatrick Williams{Package.df_all_copycmds()} 84202871c91SPatrick Williams 84302871c91SPatrick Williams# Some of our infrastructure still relies on the presence of this file 84402871c91SPatrick Williams# even though it is no longer needed to rebuild the docker environment 84502871c91SPatrick Williams# NOTE: The file is sorted to ensure the ordering is stable. 846ee3c9eebSPatrick WilliamsRUN echo '{Package.depcache()}' > /tmp/depcache 84702871c91SPatrick Williams 84802871c91SPatrick Williams# Final configuration for the workspace 84902871c91SPatrick WilliamsRUN grep -q {gid} /etc/group || groupadd -g {gid} {username} 85002871c91SPatrick WilliamsRUN mkdir -p "{os.path.dirname(homedir)}" 85102871c91SPatrick WilliamsRUN grep -q {uid} /etc/passwd || useradd -d {homedir} -m -u {uid} -g {gid} {username} 85202871c91SPatrick WilliamsRUN sed -i '1iDefaults umask=000' /etc/sudoers 85302871c91SPatrick WilliamsRUN echo "{username} ALL=(ALL) NOPASSWD: ALL" >>/etc/sudoers 85402871c91SPatrick Williams 855305a9a5dSAndrew Geissler# Ensure user has ability to write to /usr/local for different tool 856305a9a5dSAndrew Geissler# and data installs 8577bb00b13SAndrew GeisslerRUN chown -R {username}:{username} /usr/local/share 858305a9a5dSAndrew Geissler 85902871c91SPatrick Williams{proxy_cmd} 86002871c91SPatrick Williams 86102871c91SPatrick WilliamsRUN /bin/bash 86202871c91SPatrick Williams""" 86302871c91SPatrick Williams 864a18d9c57SPatrick Williams# Do the final docker build 865ee3c9eebSPatrick Williamsdocker_final_img_name = Docker.tagname(None, dockerfile) 866ee3c9eebSPatrick WilliamsDocker.build("final", docker_final_img_name, dockerfile) 867ee3c9eebSPatrick Williams 86800536fbeSPatrick Williams# Print the tag of the final image. 86900536fbeSPatrick Williamsprint(docker_final_img_name) 870