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> 950837436SPatrick Williams# FORCE_DOCKER_BUILD: <optional, a non-zero value with force all Docker 1050837436SPatrick Williams# images to be rebuilt rather than reusing caches.> 1150837436SPatrick Williams# BUILD_URL: <optional, used to detect running under CI context 1250837436SPatrick Williams# (ex. Jenkins)> 1302871c91SPatrick Williams# BRANCH: <optional, branch to build from each of the openbmc/ 1402871c91SPatrick Williams# repositories> 1502871c91SPatrick Williams# default is master, which will be used if input branch not 1602871c91SPatrick Williams# provided or not found 1702871c91SPatrick Williams# UBUNTU_MIRROR: <optional, the URL of a mirror of Ubuntu to override the 1802871c91SPatrick Williams# default ones in /etc/apt/sources.list> 1902871c91SPatrick Williams# default is empty, and no mirror is used. 2002871c91SPatrick Williams# http_proxy The HTTP address of the proxy server to connect to. 2102871c91SPatrick Williams# Default: "", proxy is not setup if this is not set 2202871c91SPatrick Williams 2302871c91SPatrick Williamsimport os 2402871c91SPatrick Williamsimport sys 25b16f3e20SPatrick Williamsimport threading 26a18d9c57SPatrick Williamsfrom datetime import date 27a18d9c57SPatrick Williamsfrom hashlib import sha256 28e08ffba8SPatrick Williams 29e08ffba8SPatrick Williams# typing.Dict is used for type-hints. 30e08ffba8SPatrick Williamsfrom typing import Any, Callable, Dict, Iterable, Optional # noqa: F401 3102871c91SPatrick Williams 3241d86218SPatrick Williamsfrom sh import docker, git, nproc, uname # type: ignore 3341d86218SPatrick Williams 34ee3c9eebSPatrick Williamstry: 35ee3c9eebSPatrick Williams # Python before 3.8 doesn't have TypedDict, so reroute to standard 'dict'. 36ee3c9eebSPatrick Williams from typing import TypedDict 3741d86218SPatrick Williamsexcept Exception: 38ee3c9eebSPatrick Williams 39ee3c9eebSPatrick Williams class TypedDict(dict): # type: ignore 40ee3c9eebSPatrick Williams # We need to do this to eat the 'total' argument. 4141d86218SPatrick Williams def __init_subclass__(cls, **kwargs: Any) -> None: 42ee3c9eebSPatrick Williams super().__init_subclass__() 43ee3c9eebSPatrick Williams 44ee3c9eebSPatrick Williams 45ee3c9eebSPatrick Williams# Declare some variables used in package definitions. 46aae36d18SPatrick Williamsprefix = "/usr/local" 4702871c91SPatrick Williamsproc_count = nproc().strip() 4802871c91SPatrick Williams 49ee3c9eebSPatrick Williams 50ee3c9eebSPatrick Williamsclass PackageDef(TypedDict, total=False): 51ee3c9eebSPatrick Williams """Package Definition for packages dictionary.""" 52ee3c9eebSPatrick Williams 53ee3c9eebSPatrick Williams # rev [optional]: Revision of package to use. 54ee3c9eebSPatrick Williams rev: str 55ee3c9eebSPatrick Williams # url [optional]: lambda function to create URL: (package, rev) -> url. 56ee3c9eebSPatrick Williams url: Callable[[str, str], str] 57ee3c9eebSPatrick Williams # depends [optional]: List of package dependencies. 58ee3c9eebSPatrick Williams depends: Iterable[str] 59ee3c9eebSPatrick Williams # build_type [required]: Build type used for package. 60ee3c9eebSPatrick Williams # Currently supported: autoconf, cmake, custom, make, meson 61ee3c9eebSPatrick Williams build_type: str 62ee3c9eebSPatrick Williams # build_steps [optional]: Steps to run for 'custom' build_type. 63ee3c9eebSPatrick Williams build_steps: Iterable[str] 64ee3c9eebSPatrick Williams # config_flags [optional]: List of options to pass configuration tool. 65ee3c9eebSPatrick Williams config_flags: Iterable[str] 66ee3c9eebSPatrick Williams # config_env [optional]: List of environment variables to set for config. 67ee3c9eebSPatrick Williams config_env: Iterable[str] 68ee3c9eebSPatrick Williams # custom_post_dl [optional]: List of steps to run after download, but 69ee3c9eebSPatrick Williams # before config / build / install. 70ee3c9eebSPatrick Williams custom_post_dl: Iterable[str] 716bce2ca1SPatrick Williams # custom_post_install [optional]: List of steps to run after install. 726bce2ca1SPatrick Williams custom_post_install: Iterable[str] 73ee3c9eebSPatrick Williams 74ee3c9eebSPatrick Williams # __tag [private]: Generated Docker tag name for package stage. 75ee3c9eebSPatrick Williams __tag: str 76ee3c9eebSPatrick Williams # __package [private]: Package object associated with this package. 77ee3c9eebSPatrick Williams __package: Any # Type is Package, but not defined yet. 78ee3c9eebSPatrick Williams 7902871c91SPatrick Williams 807204324cSPatrick Williams# Packages to include in image. 817204324cSPatrick Williamspackages = { 82ee3c9eebSPatrick Williams "boost": PackageDef( 8342ff4328SEd Tanous rev="1.83.0", 84ee3c9eebSPatrick Williams url=( 8545bfd1ffSEd Tanous lambda pkg, rev: f"https://boostorg.jfrog.io/artifactory/main/release/{rev}/source/{pkg}_{rev.replace('.', '_')}.tar.gz" # noqa: E501 862abc4a48SPatrick Williams ), 87ee3c9eebSPatrick Williams build_type="custom", 88ee3c9eebSPatrick Williams build_steps=[ 89e08ffba8SPatrick Williams ( 90782f41f4SBrad Bishop "curl --remote-name" 91876ea1efSPatrick Williams " https://github.com/williamspatrick/beast/commit/98f8b1fbd059a35754c2c7b2841769cf8d021272.patch" 92876ea1efSPatrick Williams " && patch -p2 <" 93876ea1efSPatrick Williams " 98f8b1fbd059a35754c2c7b2841769cf8d021272.patch &&" 94e08ffba8SPatrick Williams " ./bootstrap.sh" 9542ff4328SEd Tanous f" --prefix={prefix} --with-libraries=context,coroutine,url" 96e08ffba8SPatrick Williams ), 97aae36d18SPatrick Williams "./b2", 98aae36d18SPatrick Williams f"./b2 install --prefix={prefix}", 99aae36d18SPatrick Williams ], 100ee3c9eebSPatrick Williams ), 101ee3c9eebSPatrick Williams "USCiLab/cereal": PackageDef( 102c1977839SPatrick Williams rev="v1.3.2", 103ee3c9eebSPatrick Williams build_type="custom", 104ee3c9eebSPatrick Williams build_steps=[f"cp -a include/cereal/ {prefix}/include/"], 105ee3c9eebSPatrick Williams ), 106c7198558SEd Tanous "danmar/cppcheck": PackageDef( 10751021786SPatrick Williams rev="2.12.1", 108c7198558SEd Tanous build_type="cmake", 109c7198558SEd Tanous ), 110ee3c9eebSPatrick Williams "CLIUtils/CLI11": PackageDef( 111fc39733aSPatrick Williams rev="v2.3.2", 112ee3c9eebSPatrick Williams build_type="cmake", 113ee3c9eebSPatrick Williams config_flags=[ 114aae36d18SPatrick Williams "-DBUILD_TESTING=OFF", 115aae36d18SPatrick Williams "-DCLI11_BUILD_DOCS=OFF", 116aae36d18SPatrick Williams "-DCLI11_BUILD_EXAMPLES=OFF", 117aae36d18SPatrick Williams ], 118ee3c9eebSPatrick Williams ), 119ee3c9eebSPatrick Williams "fmtlib/fmt": PackageDef( 120c061e07bSPatrick Williams rev="10.1.1", 121ee3c9eebSPatrick Williams build_type="cmake", 122ee3c9eebSPatrick Williams config_flags=[ 123aae36d18SPatrick Williams "-DFMT_DOC=OFF", 124aae36d18SPatrick Williams "-DFMT_TEST=OFF", 125aae36d18SPatrick Williams ], 126ee3c9eebSPatrick Williams ), 127ee3c9eebSPatrick Williams "Naios/function2": PackageDef( 128cb09974cSPatrick Williams rev="4.2.4", 129ee3c9eebSPatrick Williams build_type="custom", 130ee3c9eebSPatrick Williams build_steps=[ 131aae36d18SPatrick Williams f"mkdir {prefix}/include/function2", 132aae36d18SPatrick Williams f"cp include/function2/function2.hpp {prefix}/include/function2/", 133aae36d18SPatrick Williams ], 134ee3c9eebSPatrick Williams ), 135ee3c9eebSPatrick Williams "google/googletest": PackageDef( 136fdf243bbSPatrick Williams rev="v1.14.0", 137ee3c9eebSPatrick Williams build_type="cmake", 1384dd32c02SWilliam A. Kennington III config_env=["CXXFLAGS=-std=c++20"], 139ee3c9eebSPatrick Williams config_flags=["-DTHREADS_PREFER_PTHREAD_FLAG=ON"], 140ee3c9eebSPatrick Williams ), 141178b4b29SEd Tanous "nghttp2/nghttp2": PackageDef( 1422b5df8bcSPatrick Williams rev="v1.57.0", 143178b4b29SEd Tanous build_type="cmake", 144178b4b29SEd Tanous config_env=["CXXFLAGS=-std=c++20"], 145178b4b29SEd Tanous config_flags=[ 146178b4b29SEd Tanous "-DENABLE_LIB_ONLY=ON", 147178b4b29SEd Tanous "-DENABLE_STATIC_LIB=ON", 148178b4b29SEd Tanous ], 149178b4b29SEd Tanous ), 150ee3c9eebSPatrick Williams "nlohmann/json": PackageDef( 151c1977839SPatrick Williams rev="v3.11.2", 1526bce2ca1SPatrick Williams build_type="cmake", 1536bce2ca1SPatrick Williams config_flags=["-DJSON_BuildTests=OFF"], 1546bce2ca1SPatrick Williams custom_post_install=[ 155e08ffba8SPatrick Williams ( 156e08ffba8SPatrick Williams f"ln -s {prefix}/include/nlohmann/json.hpp" 157e08ffba8SPatrick Williams f" {prefix}/include/json.hpp" 158e08ffba8SPatrick Williams ), 159aae36d18SPatrick Williams ], 160ee3c9eebSPatrick Williams ), 161058e3a34SPrzemyslaw Czarnowski "json-c/json-c": PackageDef( 162eee65beeSPatrick Williams rev="json-c-0.17-20230812", 163058e3a34SPrzemyslaw Czarnowski build_type="cmake", 164058e3a34SPrzemyslaw Czarnowski ), 165ee3c9eebSPatrick Williams "linux-test-project/lcov": PackageDef( 166f01a7242SPatrick Williams rev="v1.16", 167ee3c9eebSPatrick Williams build_type="make", 168ee3c9eebSPatrick Williams ), 169ee3c9eebSPatrick Williams "LibVNC/libvncserver": PackageDef( 170c042132cSPatrick Williams rev="LibVNCServer-0.9.14", 171ee3c9eebSPatrick Williams build_type="cmake", 172ee3c9eebSPatrick Williams ), 173ee3c9eebSPatrick Williams "leethomason/tinyxml2": PackageDef( 174c1977839SPatrick Williams rev="9.0.0", 175ee3c9eebSPatrick Williams build_type="cmake", 176ee3c9eebSPatrick Williams ), 177ee3c9eebSPatrick Williams "tristanpenman/valijson": PackageDef( 1785a2c113cSPatrick Williams rev="v1.0.1", 179ee3c9eebSPatrick Williams build_type="cmake", 180ee3c9eebSPatrick Williams config_flags=[ 1810eedeedaSPatrick Williams "-Dvalijson_BUILD_TESTS=0", 1820eedeedaSPatrick Williams "-Dvalijson_INSTALL_HEADERS=1", 183aae36d18SPatrick Williams ], 184ee3c9eebSPatrick Williams ), 185ee3c9eebSPatrick Williams "open-power/pdbg": PackageDef(build_type="autoconf"), 186ee3c9eebSPatrick Williams "openbmc/gpioplus": PackageDef( 187ee3c9eebSPatrick Williams depends=["openbmc/stdplus"], 188ee3c9eebSPatrick Williams build_type="meson", 189ee3c9eebSPatrick Williams config_flags=[ 190aae36d18SPatrick Williams "-Dexamples=false", 191aae36d18SPatrick Williams "-Dtests=disabled", 192aae36d18SPatrick Williams ], 193ee3c9eebSPatrick Williams ), 194ee3c9eebSPatrick Williams "openbmc/phosphor-dbus-interfaces": PackageDef( 195ee3c9eebSPatrick Williams depends=["openbmc/sdbusplus"], 196ee3c9eebSPatrick Williams build_type="meson", 1974fe87776SWilliam A. Kennington III config_flags=["-Dgenerate_md=false"], 198ee3c9eebSPatrick Williams ), 199ee3c9eebSPatrick Williams "openbmc/phosphor-logging": PackageDef( 200ee3c9eebSPatrick Williams depends=[ 20183394610SPatrick Williams "USCiLab/cereal", 20283394610SPatrick Williams "openbmc/phosphor-dbus-interfaces", 20383394610SPatrick Williams "openbmc/sdbusplus", 20483394610SPatrick Williams "openbmc/sdeventplus", 205aae36d18SPatrick Williams ], 206f79ce4c4SPatrick Williams build_type="meson", 207ee3c9eebSPatrick Williams config_flags=[ 2086c98f280SWilliam A. Kennington III "-Dlibonly=true", 2096c98f280SWilliam A. Kennington III "-Dtests=disabled", 2105eabdae9SPatrick Williams f"-Dyamldir={prefix}/share/phosphor-dbus-yaml/yaml", 211aae36d18SPatrick Williams ], 212ee3c9eebSPatrick Williams ), 213ee3c9eebSPatrick Williams "openbmc/phosphor-objmgr": PackageDef( 214ee3c9eebSPatrick Williams depends=[ 21511e5762cSBrad Bishop "CLIUtils/CLI11", 21670af95caSPatrick Williams "boost", 21783394610SPatrick Williams "leethomason/tinyxml2", 21870af95caSPatrick Williams "openbmc/phosphor-dbus-interfaces", 21983394610SPatrick Williams "openbmc/phosphor-logging", 22083394610SPatrick Williams "openbmc/sdbusplus", 221aae36d18SPatrick Williams ], 2221197e359SBrad Bishop build_type="meson", 2231197e359SBrad Bishop config_flags=[ 2241197e359SBrad Bishop "-Dtests=disabled", 2251197e359SBrad Bishop ], 226ee3c9eebSPatrick Williams ), 227c02ff271SJason M. Bills "openbmc/libpeci": PackageDef( 228c02ff271SJason M. Bills build_type="meson", 229c02ff271SJason M. Bills config_flags=[ 230c02ff271SJason M. Bills "-Draw-peci=disabled", 231c02ff271SJason M. Bills ], 232c02ff271SJason M. Bills ), 2331c19e453SManojkiran Eda "openbmc/libpldm": PackageDef( 234ee3c9eebSPatrick Williams build_type="meson", 235ee3c9eebSPatrick Williams config_flags=[ 23629d69bb0SAndrew Jeffery "-Dabi=deprecated,stable", 237aae36d18SPatrick Williams "-Doem-ibm=enabled", 238aae36d18SPatrick Williams "-Dtests=disabled", 239aae36d18SPatrick Williams ], 240ee3c9eebSPatrick Williams ), 241ee3c9eebSPatrick Williams "openbmc/sdbusplus": PackageDef( 242ee3c9eebSPatrick Williams build_type="meson", 243ee3c9eebSPatrick Williams custom_post_dl=[ 244aae36d18SPatrick Williams "cd tools", 245aae36d18SPatrick Williams f"./setup.py install --root=/ --prefix={prefix}", 246aae36d18SPatrick Williams "cd ..", 247aae36d18SPatrick Williams ], 248ee3c9eebSPatrick Williams config_flags=[ 249aae36d18SPatrick Williams "-Dexamples=disabled", 250aae36d18SPatrick Williams "-Dtests=disabled", 251aae36d18SPatrick Williams ], 252b16f3e20SPatrick Williams ), 253ee3c9eebSPatrick Williams "openbmc/sdeventplus": PackageDef( 25470af95caSPatrick Williams depends=[ 25570af95caSPatrick Williams "Naios/function2", 25670af95caSPatrick Williams "openbmc/stdplus", 25770af95caSPatrick Williams ], 258ee3c9eebSPatrick Williams build_type="meson", 259ee3c9eebSPatrick Williams config_flags=[ 260ee3c9eebSPatrick Williams "-Dexamples=false", 261ee3c9eebSPatrick Williams "-Dtests=disabled", 262ee3c9eebSPatrick Williams ], 263ee3c9eebSPatrick Williams ), 264ee3c9eebSPatrick Williams "openbmc/stdplus": PackageDef( 26570af95caSPatrick Williams depends=[ 26670af95caSPatrick Williams "fmtlib/fmt", 267ca1bf0c0SWilliam A. Kennington III "google/googletest", 268ca1bf0c0SWilliam A. Kennington III "Naios/function2", 26970af95caSPatrick Williams ], 270ee3c9eebSPatrick Williams build_type="meson", 271ee3c9eebSPatrick Williams config_flags=[ 272ee3c9eebSPatrick Williams "-Dexamples=false", 273ee3c9eebSPatrick Williams "-Dtests=disabled", 274ca1bf0c0SWilliam A. Kennington III "-Dgtest=enabled", 275ee3c9eebSPatrick Williams ], 276ee3c9eebSPatrick Williams ), 277ee3c9eebSPatrick Williams} # type: Dict[str, PackageDef] 27802871c91SPatrick Williams 27902871c91SPatrick Williams# Define common flags used for builds 28002871c91SPatrick Williamsconfigure_flags = " ".join( 28102871c91SPatrick Williams [ 28202871c91SPatrick Williams f"--prefix={prefix}", 28302871c91SPatrick Williams ] 28402871c91SPatrick Williams) 28502871c91SPatrick Williamscmake_flags = " ".join( 28602871c91SPatrick Williams [ 28702871c91SPatrick Williams "-DBUILD_SHARED_LIBS=ON", 2880f2086b3SPatrick Williams "-DCMAKE_BUILD_TYPE=RelWithDebInfo", 28902871c91SPatrick Williams f"-DCMAKE_INSTALL_PREFIX:PATH={prefix}", 2900f2086b3SPatrick Williams "-GNinja", 2910f2086b3SPatrick Williams "-DCMAKE_MAKE_PROGRAM=ninja", 29202871c91SPatrick Williams ] 29302871c91SPatrick Williams) 29402871c91SPatrick Williamsmeson_flags = " ".join( 29502871c91SPatrick Williams [ 29602871c91SPatrick Williams "--wrap-mode=nodownload", 29702871c91SPatrick Williams f"-Dprefix={prefix}", 29802871c91SPatrick Williams ] 29902871c91SPatrick Williams) 30002871c91SPatrick Williams 301ee3c9eebSPatrick Williams 302ee3c9eebSPatrick Williamsclass Package(threading.Thread): 303ee3c9eebSPatrick Williams """Class used to build the Docker stages for each package. 304ee3c9eebSPatrick Williams 305ee3c9eebSPatrick Williams Generally, this class should not be instantiated directly but through 306ee3c9eebSPatrick Williams Package.generate_all(). 307ee3c9eebSPatrick Williams """ 308ee3c9eebSPatrick Williams 309ee3c9eebSPatrick Williams # Copy the packages dictionary. 310ee3c9eebSPatrick Williams packages = packages.copy() 311ee3c9eebSPatrick Williams 312ee3c9eebSPatrick Williams # Lock used for thread-safety. 313ee3c9eebSPatrick Williams lock = threading.Lock() 314ee3c9eebSPatrick Williams 315ee3c9eebSPatrick Williams def __init__(self, pkg: str): 316ee3c9eebSPatrick Williams """pkg - The name of this package (ex. foo/bar )""" 317ee3c9eebSPatrick Williams super(Package, self).__init__() 318ee3c9eebSPatrick Williams 319ee3c9eebSPatrick Williams self.package = pkg 320ee3c9eebSPatrick Williams self.exception = None # type: Optional[Exception] 321ee3c9eebSPatrick Williams 322ee3c9eebSPatrick Williams # Reference to this package's 323ee3c9eebSPatrick Williams self.pkg_def = Package.packages[pkg] 324ee3c9eebSPatrick Williams self.pkg_def["__package"] = self 325ee3c9eebSPatrick Williams 326ee3c9eebSPatrick Williams def run(self) -> None: 327ee3c9eebSPatrick Williams """Thread 'run' function. Builds the Docker stage.""" 328ee3c9eebSPatrick Williams 329ee3c9eebSPatrick Williams # In case this package has no rev, fetch it from Github. 330ee3c9eebSPatrick Williams self._update_rev() 331ee3c9eebSPatrick Williams 332ee3c9eebSPatrick Williams # Find all the Package objects that this package depends on. 333ee3c9eebSPatrick Williams # This section is locked because we are looking into another 334ee3c9eebSPatrick Williams # package's PackageDef dict, which could be being modified. 335ee3c9eebSPatrick Williams Package.lock.acquire() 336ee3c9eebSPatrick Williams deps: Iterable[Package] = [ 337ee3c9eebSPatrick Williams Package.packages[deppkg]["__package"] 338ee3c9eebSPatrick Williams for deppkg in self.pkg_def.get("depends", []) 339ee3c9eebSPatrick Williams ] 340ee3c9eebSPatrick Williams Package.lock.release() 341ee3c9eebSPatrick Williams 342ee3c9eebSPatrick Williams # Wait until all the depends finish building. We need them complete 343ee3c9eebSPatrick Williams # for the "COPY" commands. 344ee3c9eebSPatrick Williams for deppkg in deps: 345ee3c9eebSPatrick Williams deppkg.join() 346ee3c9eebSPatrick Williams 347ee3c9eebSPatrick Williams # Generate this package's Dockerfile. 348ee3c9eebSPatrick Williams dockerfile = f""" 349ee3c9eebSPatrick WilliamsFROM {docker_base_img_name} 350ee3c9eebSPatrick Williams{self._df_copycmds()} 351ee3c9eebSPatrick Williams{self._df_build()} 352ee3c9eebSPatrick Williams""" 353ee3c9eebSPatrick Williams 354ee3c9eebSPatrick Williams # Generate the resulting tag name and save it to the PackageDef. 355ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef, 356ee3c9eebSPatrick Williams # which can be accessed by other threads. 357ee3c9eebSPatrick Williams Package.lock.acquire() 358ee3c9eebSPatrick Williams tag = Docker.tagname(self._stagename(), dockerfile) 359ee3c9eebSPatrick Williams self.pkg_def["__tag"] = tag 360ee3c9eebSPatrick Williams Package.lock.release() 361ee3c9eebSPatrick Williams 362ee3c9eebSPatrick Williams # Do the build / save any exceptions. 363ee3c9eebSPatrick Williams try: 364ee3c9eebSPatrick Williams Docker.build(self.package, tag, dockerfile) 365ee3c9eebSPatrick Williams except Exception as e: 366ee3c9eebSPatrick Williams self.exception = e 367ee3c9eebSPatrick Williams 368ee3c9eebSPatrick Williams @classmethod 369ee3c9eebSPatrick Williams def generate_all(cls) -> None: 370ee3c9eebSPatrick Williams """Ensure a Docker stage is created for all defined packages. 371ee3c9eebSPatrick Williams 372ee3c9eebSPatrick Williams These are done in parallel but with appropriate blocking per 373ee3c9eebSPatrick Williams package 'depends' specifications. 374ee3c9eebSPatrick Williams """ 375ee3c9eebSPatrick Williams 376ee3c9eebSPatrick Williams # Create a Package for each defined package. 377ee3c9eebSPatrick Williams pkg_threads = [Package(p) for p in cls.packages.keys()] 378ee3c9eebSPatrick Williams 379ee3c9eebSPatrick Williams # Start building them all. 3806dbd7807SPatrick Williams # This section is locked because threads depend on each other, 3816dbd7807SPatrick Williams # based on the packages, and they cannot 'join' on a thread 3826dbd7807SPatrick Williams # which is not yet started. Adding a lock here allows all the 3836dbd7807SPatrick Williams # threads to start before they 'join' their dependencies. 3846dbd7807SPatrick Williams Package.lock.acquire() 385ee3c9eebSPatrick Williams for t in pkg_threads: 386ee3c9eebSPatrick Williams t.start() 3876dbd7807SPatrick Williams Package.lock.release() 388ee3c9eebSPatrick Williams 389ee3c9eebSPatrick Williams # Wait for completion. 390ee3c9eebSPatrick Williams for t in pkg_threads: 391ee3c9eebSPatrick Williams t.join() 392ee3c9eebSPatrick Williams # Check if the thread saved off its own exception. 393ee3c9eebSPatrick Williams if t.exception: 394ee3c9eebSPatrick Williams print(f"Package {t.package} failed!", file=sys.stderr) 395ee3c9eebSPatrick Williams raise t.exception 396ee3c9eebSPatrick Williams 397ee3c9eebSPatrick Williams @staticmethod 398ee3c9eebSPatrick Williams def df_all_copycmds() -> str: 399ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to copy all packages 400ee3c9eebSPatrick Williams into the final image. 401ee3c9eebSPatrick Williams """ 402ee3c9eebSPatrick Williams return Package.df_copycmds_set(Package.packages.keys()) 403ee3c9eebSPatrick Williams 404ee3c9eebSPatrick Williams @classmethod 405ee3c9eebSPatrick Williams def depcache(cls) -> str: 406ee3c9eebSPatrick Williams """Create the contents of the '/tmp/depcache'. 407ee3c9eebSPatrick Williams This file is a comma-separated list of "<pkg>:<rev>". 408ee3c9eebSPatrick Williams """ 409ee3c9eebSPatrick Williams 410ee3c9eebSPatrick Williams # This needs to be sorted for consistency. 411ee3c9eebSPatrick Williams depcache = "" 412ee3c9eebSPatrick Williams for pkg in sorted(cls.packages.keys()): 413ee3c9eebSPatrick Williams depcache += "%s:%s," % (pkg, cls.packages[pkg]["rev"]) 414ee3c9eebSPatrick Williams return depcache 415ee3c9eebSPatrick Williams 416ee3c9eebSPatrick Williams def _update_rev(self) -> None: 417ee3c9eebSPatrick Williams """Look up the HEAD for missing a static rev.""" 418ee3c9eebSPatrick Williams 419ee3c9eebSPatrick Williams if "rev" in self.pkg_def: 420ee3c9eebSPatrick Williams return 421ee3c9eebSPatrick Williams 42265b21fb9SPatrick Williams # Check if Jenkins/Gerrit gave us a revision and use it. 42365b21fb9SPatrick Williams if gerrit_project == self.package and gerrit_rev: 42465b21fb9SPatrick Williams print( 42565b21fb9SPatrick Williams f"Found Gerrit revision for {self.package}: {gerrit_rev}", 42665b21fb9SPatrick Williams file=sys.stderr, 42765b21fb9SPatrick Williams ) 42865b21fb9SPatrick Williams self.pkg_def["rev"] = gerrit_rev 42965b21fb9SPatrick Williams return 43065b21fb9SPatrick Williams 431ee3c9eebSPatrick Williams # Ask Github for all the branches. 43205fb2a0aSPatrick Williams lookup = git( 43305fb2a0aSPatrick Williams "ls-remote", "--heads", f"https://github.com/{self.package}" 43405fb2a0aSPatrick Williams ) 435ee3c9eebSPatrick Williams 436ee3c9eebSPatrick Williams # Find the branch matching {branch} (or fallback to master). 437ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef. 438ee3c9eebSPatrick Williams Package.lock.acquire() 439ee3c9eebSPatrick Williams for line in lookup.split("\n"): 440ee3c9eebSPatrick Williams if f"refs/heads/{branch}" in line: 441ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 442c7d73646SPatrick Williams elif ( 443c7d73646SPatrick Williams "refs/heads/master" in line or "refs/heads/main" in line 444c7d73646SPatrick Williams ) and "rev" not in self.pkg_def: 445ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 446ee3c9eebSPatrick Williams Package.lock.release() 447ee3c9eebSPatrick Williams 448ee3c9eebSPatrick Williams def _stagename(self) -> str: 449ee3c9eebSPatrick Williams """Create a name for the Docker stage associated with this pkg.""" 450ee3c9eebSPatrick Williams return self.package.replace("/", "-").lower() 451ee3c9eebSPatrick Williams 452ee3c9eebSPatrick Williams def _url(self) -> str: 453ee3c9eebSPatrick Williams """Get the URL for this package.""" 454ee3c9eebSPatrick Williams rev = self.pkg_def["rev"] 455ee3c9eebSPatrick Williams 456ee3c9eebSPatrick Williams # If the lambda exists, call it. 457ee3c9eebSPatrick Williams if "url" in self.pkg_def: 458ee3c9eebSPatrick Williams return self.pkg_def["url"](self.package, rev) 459ee3c9eebSPatrick Williams 460ee3c9eebSPatrick Williams # Default to the github archive URL. 461ee3c9eebSPatrick Williams return f"https://github.com/{self.package}/archive/{rev}.tar.gz" 462ee3c9eebSPatrick Williams 463ee3c9eebSPatrick Williams def _cmd_download(self) -> str: 464ee3c9eebSPatrick Williams """Formulate the command necessary to download and unpack to source.""" 465ee3c9eebSPatrick Williams 466ee3c9eebSPatrick Williams url = self._url() 467ee3c9eebSPatrick Williams if ".tar." not in url: 468ee3c9eebSPatrick Williams raise NotImplementedError( 469ee3c9eebSPatrick Williams f"Unhandled download type for {self.package}: {url}" 470ee3c9eebSPatrick Williams ) 471ee3c9eebSPatrick Williams 472ee3c9eebSPatrick Williams cmd = f"curl -L {url} | tar -x" 473ee3c9eebSPatrick Williams 474ee3c9eebSPatrick Williams if url.endswith(".bz2"): 475ee3c9eebSPatrick Williams cmd += "j" 476ee3c9eebSPatrick Williams elif url.endswith(".gz"): 477ee3c9eebSPatrick Williams cmd += "z" 478ee3c9eebSPatrick Williams else: 479ee3c9eebSPatrick Williams raise NotImplementedError( 480ee3c9eebSPatrick Williams f"Unknown tar flags needed for {self.package}: {url}" 481ee3c9eebSPatrick Williams ) 482ee3c9eebSPatrick Williams 483ee3c9eebSPatrick Williams return cmd 484ee3c9eebSPatrick Williams 485ee3c9eebSPatrick Williams def _cmd_cd_srcdir(self) -> str: 486ee3c9eebSPatrick Williams """Formulate the command necessary to 'cd' into the source dir.""" 487ee3c9eebSPatrick Williams return f"cd {self.package.split('/')[-1]}*" 488ee3c9eebSPatrick Williams 489ee3c9eebSPatrick Williams def _df_copycmds(self) -> str: 490ee3c9eebSPatrick Williams """Formulate the dockerfile snippet necessary to COPY all depends.""" 491ee3c9eebSPatrick Williams 492ee3c9eebSPatrick Williams if "depends" not in self.pkg_def: 493ee3c9eebSPatrick Williams return "" 494ee3c9eebSPatrick Williams return Package.df_copycmds_set(self.pkg_def["depends"]) 495ee3c9eebSPatrick Williams 496ee3c9eebSPatrick Williams @staticmethod 497ee3c9eebSPatrick Williams def df_copycmds_set(pkgs: Iterable[str]) -> str: 498ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to COPY a set of 499ee3c9eebSPatrick Williams packages into a Docker stage. 500ee3c9eebSPatrick Williams """ 501ee3c9eebSPatrick Williams 502ee3c9eebSPatrick Williams copy_cmds = "" 503ee3c9eebSPatrick Williams 504ee3c9eebSPatrick Williams # Sort the packages for consistency. 505ee3c9eebSPatrick Williams for p in sorted(pkgs): 506ee3c9eebSPatrick Williams tag = Package.packages[p]["__tag"] 507ee3c9eebSPatrick Williams copy_cmds += f"COPY --from={tag} {prefix} {prefix}\n" 508ee3c9eebSPatrick Williams # Workaround for upstream docker bug and multiple COPY cmds 509ee3c9eebSPatrick Williams # https://github.com/moby/moby/issues/37965 510ee3c9eebSPatrick Williams copy_cmds += "RUN true\n" 511ee3c9eebSPatrick Williams 512ee3c9eebSPatrick Williams return copy_cmds 513ee3c9eebSPatrick Williams 514ee3c9eebSPatrick Williams def _df_build(self) -> str: 515ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to download, build, and 516ee3c9eebSPatrick Williams install a package into a Docker stage. 517ee3c9eebSPatrick Williams """ 518ee3c9eebSPatrick Williams 519ee3c9eebSPatrick Williams # Download and extract source. 520ee3c9eebSPatrick Williams result = f"RUN {self._cmd_download()} && {self._cmd_cd_srcdir()} && " 521ee3c9eebSPatrick Williams 522ee3c9eebSPatrick Williams # Handle 'custom_post_dl' commands. 523ee3c9eebSPatrick Williams custom_post_dl = self.pkg_def.get("custom_post_dl") 524ee3c9eebSPatrick Williams if custom_post_dl: 525ee3c9eebSPatrick Williams result += " && ".join(custom_post_dl) + " && " 526ee3c9eebSPatrick Williams 527ee3c9eebSPatrick Williams # Build and install package based on 'build_type'. 528ee3c9eebSPatrick Williams build_type = self.pkg_def["build_type"] 529ee3c9eebSPatrick Williams if build_type == "autoconf": 530ee3c9eebSPatrick Williams result += self._cmd_build_autoconf() 531ee3c9eebSPatrick Williams elif build_type == "cmake": 532ee3c9eebSPatrick Williams result += self._cmd_build_cmake() 533ee3c9eebSPatrick Williams elif build_type == "custom": 534ee3c9eebSPatrick Williams result += self._cmd_build_custom() 535ee3c9eebSPatrick Williams elif build_type == "make": 536ee3c9eebSPatrick Williams result += self._cmd_build_make() 537ee3c9eebSPatrick Williams elif build_type == "meson": 538ee3c9eebSPatrick Williams result += self._cmd_build_meson() 539ee3c9eebSPatrick Williams else: 540ee3c9eebSPatrick Williams raise NotImplementedError( 541ee3c9eebSPatrick Williams f"Unhandled build type for {self.package}: {build_type}" 542ee3c9eebSPatrick Williams ) 543ee3c9eebSPatrick Williams 5446bce2ca1SPatrick Williams # Handle 'custom_post_install' commands. 5456bce2ca1SPatrick Williams custom_post_install = self.pkg_def.get("custom_post_install") 5466bce2ca1SPatrick Williams if custom_post_install: 5476bce2ca1SPatrick Williams result += " && " + " && ".join(custom_post_install) 5486bce2ca1SPatrick Williams 549ee3c9eebSPatrick Williams return result 550ee3c9eebSPatrick Williams 551ee3c9eebSPatrick Williams def _cmd_build_autoconf(self) -> str: 552ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 553ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 554ee3c9eebSPatrick Williams result = "./bootstrap.sh && " 555ee3c9eebSPatrick Williams result += f"{env} ./configure {configure_flags} {options} && " 556ee3c9eebSPatrick Williams result += f"make -j{proc_count} && make install" 557ee3c9eebSPatrick Williams return result 558ee3c9eebSPatrick Williams 559ee3c9eebSPatrick Williams def _cmd_build_cmake(self) -> str: 560ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 561ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 562ee3c9eebSPatrick Williams result = "mkdir builddir && cd builddir && " 563ee3c9eebSPatrick Williams result += f"{env} cmake {cmake_flags} {options} .. && " 564ee3c9eebSPatrick Williams result += "cmake --build . --target all && " 565ee3c9eebSPatrick Williams result += "cmake --build . --target install && " 566ee3c9eebSPatrick Williams result += "cd .." 567ee3c9eebSPatrick Williams return result 568ee3c9eebSPatrick Williams 569ee3c9eebSPatrick Williams def _cmd_build_custom(self) -> str: 570ee3c9eebSPatrick Williams return " && ".join(self.pkg_def.get("build_steps", [])) 571ee3c9eebSPatrick Williams 572ee3c9eebSPatrick Williams def _cmd_build_make(self) -> str: 573ee3c9eebSPatrick Williams return f"make -j{proc_count} && make install" 574ee3c9eebSPatrick Williams 575ee3c9eebSPatrick Williams def _cmd_build_meson(self) -> str: 576ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 577ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 578e2da11adSAndrew Jeffery result = f"{env} meson setup builddir {meson_flags} {options} && " 579ee3c9eebSPatrick Williams result += "ninja -C builddir && ninja -C builddir install" 580ee3c9eebSPatrick Williams return result 581ee3c9eebSPatrick Williams 582ee3c9eebSPatrick Williams 583ee3c9eebSPatrick Williamsclass Docker: 584ee3c9eebSPatrick Williams """Class to assist with Docker interactions. All methods are static.""" 585ee3c9eebSPatrick Williams 586ee3c9eebSPatrick Williams @staticmethod 587ee3c9eebSPatrick Williams def timestamp() -> str: 588ee3c9eebSPatrick Williams """Generate a timestamp for today using the ISO week.""" 589ee3c9eebSPatrick Williams today = date.today().isocalendar() 590ee3c9eebSPatrick Williams return f"{today[0]}-W{today[1]:02}" 591ee3c9eebSPatrick Williams 592ee3c9eebSPatrick Williams @staticmethod 59341d86218SPatrick Williams def tagname(pkgname: Optional[str], dockerfile: str) -> str: 594ee3c9eebSPatrick Williams """Generate a tag name for a package using a hash of the Dockerfile.""" 595ee3c9eebSPatrick Williams result = docker_image_name 596ee3c9eebSPatrick Williams if pkgname: 597ee3c9eebSPatrick Williams result += "-" + pkgname 598ee3c9eebSPatrick Williams 599ee3c9eebSPatrick Williams result += ":" + Docker.timestamp() 600ee3c9eebSPatrick Williams result += "-" + sha256(dockerfile.encode()).hexdigest()[0:16] 601ee3c9eebSPatrick Williams 602ee3c9eebSPatrick Williams return result 603ee3c9eebSPatrick Williams 604ee3c9eebSPatrick Williams @staticmethod 605ee3c9eebSPatrick Williams def build(pkg: str, tag: str, dockerfile: str) -> None: 60622e6110bSAndrew Geissler """Build a docker image using the Dockerfile and tagging it with 'tag'.""" 607ee3c9eebSPatrick Williams 608ee3c9eebSPatrick Williams # If we're not forcing builds, check if it already exists and skip. 609ee3c9eebSPatrick Williams if not force_build: 610ee3c9eebSPatrick Williams if docker.image.ls(tag, "--format", '"{{.Repository}}:{{.Tag}}"'): 61105fb2a0aSPatrick Williams print( 61205fb2a0aSPatrick Williams f"Image {tag} already exists. Skipping.", file=sys.stderr 61305fb2a0aSPatrick Williams ) 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. 64305fb2a0aSPatrick Williamsdocker_image_name = os.environ.get( 64405fb2a0aSPatrick Williams "DOCKER_IMAGE_NAME", "openbmc/ubuntu-unit-test" 64505fb2a0aSPatrick Williams) 646ee3c9eebSPatrick Williamsforce_build = os.environ.get("FORCE_DOCKER_BUILD") 647ee3c9eebSPatrick Williamsis_automated_ci_build = os.environ.get("BUILD_URL", False) 648c6caa184SWilliam A. Kennington IIIdistro = os.environ.get("DISTRO", "ubuntu:mantic") 649ee3c9eebSPatrick Williamsbranch = os.environ.get("BRANCH", "master") 650ee3c9eebSPatrick Williamsubuntu_mirror = os.environ.get("UBUNTU_MIRROR") 651ee3c9eebSPatrick Williamshttp_proxy = os.environ.get("http_proxy") 652ee3c9eebSPatrick Williams 65365b21fb9SPatrick Williamsgerrit_project = os.environ.get("GERRIT_PROJECT") 65465b21fb9SPatrick Williamsgerrit_rev = os.environ.get("GERRIT_PATCHSET_REVISION") 65565b21fb9SPatrick Williams 656d0dabc3eSAndrew Geissler# Ensure appropriate docker build output to see progress and identify 657d0dabc3eSAndrew Geissler# any issues 658d0dabc3eSAndrew Geissleros.environ["BUILDKIT_PROGRESS"] = "plain" 659d0dabc3eSAndrew Geissler 660ee3c9eebSPatrick Williams# Set up some common variables. 661ee3c9eebSPatrick Williamsusername = os.environ.get("USER", "root") 662ee3c9eebSPatrick Williamshomedir = os.environ.get("HOME", "/root") 663ee3c9eebSPatrick Williamsgid = os.getgid() 664ee3c9eebSPatrick Williamsuid = os.getuid() 665ee3c9eebSPatrick Williams 6666825a018SJosh Lehan# Use well-known constants if user is root 6676825a018SJosh Lehanif username == "root": 6686825a018SJosh Lehan homedir = "/root" 6696825a018SJosh Lehan gid = 0 6706825a018SJosh Lehan uid = 0 6716825a018SJosh Lehan 672ee3c9eebSPatrick Williams# Determine the architecture for Docker. 673ee3c9eebSPatrick Williamsarch = uname("-m").strip() 674ee3c9eebSPatrick Williamsif arch == "ppc64le": 675ee3c9eebSPatrick Williams docker_base = "ppc64le/" 676ee3c9eebSPatrick Williamselif arch == "x86_64": 677ee3c9eebSPatrick Williams docker_base = "" 678051b05b7SThang Q. Nguyenelif arch == "aarch64": 679f98f1a8dSThang Q. Nguyen docker_base = "arm64v8/" 680ee3c9eebSPatrick Williamselse: 681ee3c9eebSPatrick Williams print( 682ee3c9eebSPatrick Williams f"Unsupported system architecture({arch}) found for docker image", 683ee3c9eebSPatrick Williams file=sys.stderr, 684ee3c9eebSPatrick Williams ) 685ee3c9eebSPatrick Williams sys.exit(1) 686ee3c9eebSPatrick Williams 68702871c91SPatrick Williams# Special flags if setting up a deb mirror. 68802871c91SPatrick Williamsmirror = "" 68902871c91SPatrick Williamsif "ubuntu" in distro and ubuntu_mirror: 69002871c91SPatrick Williams mirror = f""" 691e08ffba8SPatrick WilliamsRUN echo "deb {ubuntu_mirror} \ 692e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME) \ 693e08ffba8SPatrick Williams main restricted universe multiverse" > /etc/apt/sources.list && \\ 694e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 695e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-updates \ 696e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 697e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 698e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-security \ 699e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 700e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 701e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-proposed \ 702e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 703e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 704e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-backports \ 705e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list 70602871c91SPatrick Williams""" 70702871c91SPatrick Williams 70802871c91SPatrick Williams# Special flags for proxying. 70902871c91SPatrick Williamsproxy_cmd = "" 71034ec77e8SAdrian Ambrożewiczproxy_keyserver = "" 71102871c91SPatrick Williamsproxy_args = [] 71202871c91SPatrick Williamsif http_proxy: 71302871c91SPatrick Williams proxy_cmd = f""" 71402871c91SPatrick WilliamsRUN echo "[http]" >> {homedir}/.gitconfig && \ 71502871c91SPatrick Williams echo "proxy = {http_proxy}" >> {homedir}/.gitconfig 71602871c91SPatrick Williams""" 71734ec77e8SAdrian Ambrożewicz proxy_keyserver = f"--keyserver-options http-proxy={http_proxy}" 71834ec77e8SAdrian Ambrożewicz 71902871c91SPatrick Williams proxy_args.extend( 72002871c91SPatrick Williams [ 72102871c91SPatrick Williams "--build-arg", 72202871c91SPatrick Williams f"http_proxy={http_proxy}", 72302871c91SPatrick Williams "--build-arg", 724d461cd6aSLei YU f"https_proxy={http_proxy}", 72502871c91SPatrick Williams ] 72602871c91SPatrick Williams ) 72702871c91SPatrick Williams 728ee3c9eebSPatrick Williams# Create base Dockerfile. 729a18d9c57SPatrick Williamsdockerfile_base = f""" 730a18d9c57SPatrick WilliamsFROM {docker_base}{distro} 73102871c91SPatrick Williams 73202871c91SPatrick Williams{mirror} 73302871c91SPatrick Williams 73402871c91SPatrick WilliamsENV DEBIAN_FRONTEND noninteractive 73502871c91SPatrick Williams 7368949d3c3SPatrick WilliamsENV PYTHONPATH "/usr/local/lib/python3.10/site-packages/" 73702871c91SPatrick Williams 738bb16ac14SPatrick Williams# Sometimes the ubuntu key expires and we need a way to force an execution 739bb16ac14SPatrick Williams# of the apt-get commands for the dbgsym-keyring. When this happens we see 740bb16ac14SPatrick Williams# an error like: "Release: The following signatures were invalid:" 741bb16ac14SPatrick Williams# Insert a bogus echo that we can change here when we get this error to force 742bb16ac14SPatrick Williams# the update. 743bb16ac14SPatrick WilliamsRUN echo "ubuntu keyserver rev as of 2021-04-21" 744bb16ac14SPatrick Williams 74502871c91SPatrick Williams# We need the keys to be imported for dbgsym repos 74602871c91SPatrick Williams# New releases have a package, older ones fall back to manual fetching 74702871c91SPatrick Williams# https://wiki.ubuntu.com/Debug%20Symbol%20Packages 748575b5e4cSJagpal Singh Gill# Known issue with gpg to get keys via proxy - 749575b5e4cSJagpal Singh Gill# https://bugs.launchpad.net/ubuntu/+source/gnupg2/+bug/1788190, hence using 750575b5e4cSJagpal Singh Gill# curl to get keys. 75150837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && \ 752938d303fSJian Zhang ( apt-get install -yy gpgv ubuntu-dbgsym-keyring || \ 753575b5e4cSJagpal Singh Gill ( apt-get install -yy dirmngr curl && \ 754575b5e4cSJagpal Singh Gill curl -sSL \ 755575b5e4cSJagpal Singh Gill 'https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xF2EDC64DC5AEE1F6B9C621F0C8CAB6595FDFF622' \ 756575b5e4cSJagpal Singh Gill | apt-key add - )) 75702871c91SPatrick Williams 75802871c91SPatrick Williams# Parse the current repo list into a debug repo list 759e08ffba8SPatrick WilliamsRUN sed -n '/^deb /s,^deb [^ ]* ,deb http://ddebs.ubuntu.com ,p' \ 760e08ffba8SPatrick Williams /etc/apt/sources.list >/etc/apt/sources.list.d/debug.list 76102871c91SPatrick Williams 76202871c91SPatrick Williams# Remove non-existent debug repos 76341d86218SPatrick WilliamsRUN sed -i '/-\\(backports\\|security\\) /d' /etc/apt/sources.list.d/debug.list 76402871c91SPatrick Williams 76502871c91SPatrick WilliamsRUN cat /etc/apt/sources.list.d/debug.list 76602871c91SPatrick Williams 76702871c91SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && apt-get install -yy \ 76858f1915eSAndrew Jeffery abi-compliance-checker \ 7698b112068SAndrew Jeffery abi-dumper \ 77002871c91SPatrick Williams autoconf \ 77102871c91SPatrick Williams autoconf-archive \ 772af49ed51SAndrew Geissler bison \ 773e2e62e5cSPatrick Williams clang-17 \ 774e2e62e5cSPatrick Williams clang-format-17 \ 775e2e62e5cSPatrick Williams clang-tidy-17 \ 776e2e62e5cSPatrick Williams clang-tools-17 \ 777af49ed51SAndrew Geissler cmake \ 778af49ed51SAndrew Geissler curl \ 779af49ed51SAndrew Geissler dbus \ 780af49ed51SAndrew Geissler device-tree-compiler \ 781af49ed51SAndrew Geissler flex \ 782961f148bSPatrick Williams g++-13 \ 783961f148bSPatrick Williams gcc-13 \ 784af49ed51SAndrew Geissler git \ 78502871c91SPatrick Williams iproute2 \ 786af49ed51SAndrew Geissler iputils-ping \ 787524a331cSManojkiran Eda libaudit-dev \ 788af49ed51SAndrew Geissler libc6-dbg \ 789af49ed51SAndrew Geissler libc6-dev \ 790af49ed51SAndrew Geissler libconfig++-dev \ 791af49ed51SAndrew Geissler libcryptsetup-dev \ 792af49ed51SAndrew Geissler libdbus-1-dev \ 793af49ed51SAndrew Geissler libevdev-dev \ 794af49ed51SAndrew Geissler libgpiod-dev \ 795af49ed51SAndrew Geissler libi2c-dev \ 796af49ed51SAndrew Geissler libjpeg-dev \ 797af49ed51SAndrew Geissler libjson-perl \ 798af49ed51SAndrew Geissler libldap2-dev \ 799af49ed51SAndrew Geissler libmimetic-dev \ 80002871c91SPatrick Williams libnl-3-dev \ 80102871c91SPatrick Williams libnl-genl-3-dev \ 80202871c91SPatrick Williams libpam0g-dev \ 80302871c91SPatrick Williams libpciaccess-dev \ 804af49ed51SAndrew Geissler libperlio-gzip-perl \ 805af49ed51SAndrew Geissler libpng-dev \ 806af49ed51SAndrew Geissler libprotobuf-dev \ 807af49ed51SAndrew Geissler libsnmp-dev \ 808af49ed51SAndrew Geissler libssl-dev \ 809af49ed51SAndrew Geissler libsystemd-dev \ 810af49ed51SAndrew Geissler libtool \ 811af49ed51SAndrew Geissler liburing-dev \ 81202871c91SPatrick Williams libxml2-utils \ 8130eedeedaSPatrick Williams libxml-simple-perl \ 814af49ed51SAndrew Geissler ninja-build \ 815af49ed51SAndrew Geissler npm \ 816af49ed51SAndrew Geissler pkg-config \ 817af49ed51SAndrew Geissler protobuf-compiler \ 818af49ed51SAndrew Geissler python3 \ 819af49ed51SAndrew Geissler python3-dev\ 820af49ed51SAndrew Geissler python3-git \ 821af49ed51SAndrew Geissler python3-mako \ 822af49ed51SAndrew Geissler python3-pip \ 823af49ed51SAndrew Geissler python3-setuptools \ 824af49ed51SAndrew Geissler python3-socks \ 825af49ed51SAndrew Geissler python3-yaml \ 8269adf68d6SJohn Wedig rsync \ 827af49ed51SAndrew Geissler shellcheck \ 828af49ed51SAndrew Geissler sudo \ 829af49ed51SAndrew Geissler systemd \ 830af49ed51SAndrew Geissler valgrind \ 831eef3c37dSAndrew Geissler valgrind-dbgsym \ 832b565f825SAndrew Geissler vim \ 833af49ed51SAndrew Geissler wget \ 834af49ed51SAndrew Geissler xxd 83502871c91SPatrick Williams 836961f148bSPatrick WilliamsRUN update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-13 13 \ 837961f148bSPatrick Williams --slave /usr/bin/g++ g++ /usr/bin/g++-13 \ 838961f148bSPatrick Williams --slave /usr/bin/gcov gcov /usr/bin/gcov-13 \ 839961f148bSPatrick Williams --slave /usr/bin/gcov-dump gcov-dump /usr/bin/gcov-dump-13 \ 840961f148bSPatrick Williams --slave /usr/bin/gcov-tool gcov-tool /usr/bin/gcov-tool-13 841961f148bSPatrick WilliamsRUN update-alternatives --remove cpp /usr/bin/cpp && \ 842961f148bSPatrick Williams update-alternatives --install /usr/bin/cpp cpp /usr/bin/cpp-13 13 84302871c91SPatrick Williams 844e2e62e5cSPatrick WilliamsRUN update-alternatives --install /usr/bin/clang clang /usr/bin/clang-17 1000 \ 845e2e62e5cSPatrick Williams --slave /usr/bin/clang++ clang++ /usr/bin/clang++-17 \ 846e2e62e5cSPatrick Williams --slave /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-17 \ 847e2e62e5cSPatrick Williams --slave /usr/bin/clang-format clang-format /usr/bin/clang-format-17 \ 848e08ffba8SPatrick Williams --slave /usr/bin/run-clang-tidy run-clang-tidy.py \ 849e2e62e5cSPatrick Williams /usr/bin/run-clang-tidy-17 \ 850e2e62e5cSPatrick Williams --slave /usr/bin/scan-build scan-build /usr/bin/scan-build-17 85102871c91SPatrick Williams 85250837436SPatrick Williams""" 85350837436SPatrick Williams 85450837436SPatrick Williamsif is_automated_ci_build: 85550837436SPatrick Williams dockerfile_base += f""" 85650837436SPatrick Williams# Run an arbitrary command to polute the docker cache regularly force us 85750837436SPatrick Williams# to re-run `apt-get update` daily. 858ee3c9eebSPatrick WilliamsRUN echo {Docker.timestamp()} 85950837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy 86050837436SPatrick Williams 86150837436SPatrick Williams""" 86250837436SPatrick Williams 86341d86218SPatrick Williamsdockerfile_base += """ 8645e4d8402SPatrick WilliamsRUN pip3 install --break-system-packages \ 865818023dfSPatrick Williams beautysh \ 866818023dfSPatrick Williams black \ 867818023dfSPatrick Williams codespell \ 868818023dfSPatrick Williams flake8 \ 869818023dfSPatrick Williams gitlint \ 870818023dfSPatrick Williams inflection \ 871818023dfSPatrick Williams isort \ 872818023dfSPatrick Williams jsonschema \ 873*16baaf73SPatrick Williams meson==1.3.0 \ 874818023dfSPatrick Williams protobuf \ 875818023dfSPatrick Williams requests 876b08ddf77SPatrick Williams 877b08ddf77SPatrick WilliamsRUN npm install -g \ 878b08ddf77SPatrick Williams eslint@latest eslint-plugin-json@latest \ 8797d41f6d2SPatrick Williams markdownlint-cli@latest \ 880b08ddf77SPatrick Williams prettier@latest 881fb9948a3SEd Tanous""" 882fb9948a3SEd Tanous 883ee3c9eebSPatrick Williams# Build the base and stage docker images. 884ee3c9eebSPatrick Williamsdocker_base_img_name = Docker.tagname("base", dockerfile_base) 885ee3c9eebSPatrick WilliamsDocker.build("base", docker_base_img_name, dockerfile_base) 886ee3c9eebSPatrick WilliamsPackage.generate_all() 88702871c91SPatrick Williams 888ee3c9eebSPatrick Williams# Create the final Dockerfile. 889a18d9c57SPatrick Williamsdockerfile = f""" 89002871c91SPatrick Williams# Build the final output image 891a18d9c57SPatrick WilliamsFROM {docker_base_img_name} 892ee3c9eebSPatrick Williams{Package.df_all_copycmds()} 89302871c91SPatrick Williams 89402871c91SPatrick Williams# Some of our infrastructure still relies on the presence of this file 89502871c91SPatrick Williams# even though it is no longer needed to rebuild the docker environment 89602871c91SPatrick Williams# NOTE: The file is sorted to ensure the ordering is stable. 897ee3c9eebSPatrick WilliamsRUN echo '{Package.depcache()}' > /tmp/depcache 89802871c91SPatrick Williams 89967cc0616SPatrick Williams# Ensure the group, user, and home directory are created (or rename them if 90067cc0616SPatrick Williams# they already exist). 90167cc0616SPatrick WilliamsRUN if grep -q ":{gid}:" /etc/group ; then \ 90267cc0616SPatrick Williams groupmod -n {username} $(awk -F : '{{ if ($3 == {gid}) {{ print $1 }} }}' /etc/group) ; \ 90367cc0616SPatrick Williams else \ 90467cc0616SPatrick Williams groupadd -f -g {gid} {username} ; \ 90567cc0616SPatrick Williams fi 90602871c91SPatrick WilliamsRUN mkdir -p "{os.path.dirname(homedir)}" 90767cc0616SPatrick WilliamsRUN if grep -q ":{uid}:" /etc/passwd ; then \ 90873b3ee91SPatrick Williams usermod -l {username} -d {homedir} -m $(awk -F : '{{ if ($3 == {uid}) {{ print $1 }} }}' /etc/passwd) ; \ 90967cc0616SPatrick Williams else \ 91067cc0616SPatrick Williams useradd -d {homedir} -m -u {uid} -g {gid} {username} ; \ 91167cc0616SPatrick Williams fi 91202871c91SPatrick WilliamsRUN sed -i '1iDefaults umask=000' /etc/sudoers 91302871c91SPatrick WilliamsRUN echo "{username} ALL=(ALL) NOPASSWD: ALL" >>/etc/sudoers 91402871c91SPatrick Williams 915305a9a5dSAndrew Geissler# Ensure user has ability to write to /usr/local for different tool 916305a9a5dSAndrew Geissler# and data installs 9177bb00b13SAndrew GeisslerRUN chown -R {username}:{username} /usr/local/share 918305a9a5dSAndrew Geissler 91902871c91SPatrick Williams{proxy_cmd} 92002871c91SPatrick Williams 92102871c91SPatrick WilliamsRUN /bin/bash 92202871c91SPatrick Williams""" 92302871c91SPatrick Williams 924a18d9c57SPatrick Williams# Do the final docker build 925ee3c9eebSPatrick Williamsdocker_final_img_name = Docker.tagname(None, dockerfile) 926ee3c9eebSPatrick WilliamsDocker.build("final", docker_final_img_name, dockerfile) 927ee3c9eebSPatrick Williams 92800536fbeSPatrick Williams# Print the tag of the final image. 92900536fbeSPatrick Williamsprint(docker_final_img_name) 930