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( 8378173cd4SEd Tanous rev="1.82.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" 95e08ffba8SPatrick Williams f" --prefix={prefix} --with-libraries=context,coroutine" 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( 107be4bd084SPatrick Williams rev="2.9", 108c7198558SEd Tanous build_type="cmake", 109c7198558SEd Tanous ), 110ee3c9eebSPatrick Williams "CLIUtils/CLI11": PackageDef( 111ee3c9eebSPatrick Williams rev="v1.9.1", 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( 120652d8aeaSWilliam A. Kennington III rev="9.1.0", 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( 128c1977839SPatrick Williams rev="4.2.1", 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 ), 135ed9414e8SPatrick Williams # release-1.12.1 136ee3c9eebSPatrick Williams "google/googletest": PackageDef( 137ed9414e8SPatrick Williams rev="58d77fa8070e8cec2dc1ed015d66b454c8d78850", 138ee3c9eebSPatrick Williams build_type="cmake", 1394dd32c02SWilliam A. Kennington III config_env=["CXXFLAGS=-std=c++20"], 140ee3c9eebSPatrick Williams config_flags=["-DTHREADS_PREFER_PTHREAD_FLAG=ON"], 141ee3c9eebSPatrick Williams ), 142*178b4b29SEd Tanous "nghttp2/nghttp2": PackageDef( 143*178b4b29SEd Tanous rev="v1.54.0", 144*178b4b29SEd Tanous build_type="cmake", 145*178b4b29SEd Tanous config_env=["CXXFLAGS=-std=c++20"], 146*178b4b29SEd Tanous config_flags=[ 147*178b4b29SEd Tanous "-DENABLE_LIB_ONLY=ON", 148*178b4b29SEd Tanous "-DENABLE_STATIC_LIB=ON", 149*178b4b29SEd Tanous ], 150*178b4b29SEd Tanous ), 151ee3c9eebSPatrick Williams "nlohmann/json": PackageDef( 152c1977839SPatrick Williams rev="v3.11.2", 1536bce2ca1SPatrick Williams build_type="cmake", 1546bce2ca1SPatrick Williams config_flags=["-DJSON_BuildTests=OFF"], 1556bce2ca1SPatrick Williams custom_post_install=[ 156e08ffba8SPatrick Williams ( 157e08ffba8SPatrick Williams f"ln -s {prefix}/include/nlohmann/json.hpp" 158e08ffba8SPatrick Williams f" {prefix}/include/json.hpp" 159e08ffba8SPatrick Williams ), 160aae36d18SPatrick Williams ], 161ee3c9eebSPatrick Williams ), 162058e3a34SPrzemyslaw Czarnowski "json-c/json-c": PackageDef( 163058e3a34SPrzemyslaw Czarnowski rev="json-c-0.16-20220414", 164058e3a34SPrzemyslaw Czarnowski build_type="cmake", 165058e3a34SPrzemyslaw Czarnowski ), 16602871c91SPatrick Williams # Snapshot from 2019-05-24 167ee3c9eebSPatrick Williams "linux-test-project/lcov": PackageDef( 168ee3c9eebSPatrick Williams rev="v1.15", 169ee3c9eebSPatrick Williams build_type="make", 170ee3c9eebSPatrick Williams ), 171ee3c9eebSPatrick Williams "LibVNC/libvncserver": PackageDef( 172ee3c9eebSPatrick Williams rev="LibVNCServer-0.9.13", 173ee3c9eebSPatrick Williams build_type="cmake", 174ee3c9eebSPatrick Williams ), 175ee3c9eebSPatrick Williams "leethomason/tinyxml2": PackageDef( 176c1977839SPatrick Williams rev="9.0.0", 177ee3c9eebSPatrick Williams build_type="cmake", 178ee3c9eebSPatrick Williams ), 179ee3c9eebSPatrick Williams "tristanpenman/valijson": PackageDef( 180c1977839SPatrick Williams rev="v0.7", 181ee3c9eebSPatrick Williams build_type="cmake", 182ee3c9eebSPatrick Williams config_flags=[ 1830eedeedaSPatrick Williams "-Dvalijson_BUILD_TESTS=0", 1840eedeedaSPatrick Williams "-Dvalijson_INSTALL_HEADERS=1", 185aae36d18SPatrick Williams ], 186ee3c9eebSPatrick Williams ), 187ee3c9eebSPatrick Williams "open-power/pdbg": PackageDef(build_type="autoconf"), 188ee3c9eebSPatrick Williams "openbmc/gpioplus": PackageDef( 189ee3c9eebSPatrick Williams depends=["openbmc/stdplus"], 190ee3c9eebSPatrick Williams build_type="meson", 191ee3c9eebSPatrick Williams config_flags=[ 192aae36d18SPatrick Williams "-Dexamples=false", 193aae36d18SPatrick Williams "-Dtests=disabled", 194aae36d18SPatrick Williams ], 195ee3c9eebSPatrick Williams ), 196ee3c9eebSPatrick Williams "openbmc/phosphor-dbus-interfaces": PackageDef( 197ee3c9eebSPatrick Williams depends=["openbmc/sdbusplus"], 198ee3c9eebSPatrick Williams build_type="meson", 1994fe87776SWilliam A. Kennington III config_flags=["-Dgenerate_md=false"], 200ee3c9eebSPatrick Williams ), 201ee3c9eebSPatrick Williams "openbmc/phosphor-logging": PackageDef( 202ee3c9eebSPatrick Williams depends=[ 20383394610SPatrick Williams "USCiLab/cereal", 20483394610SPatrick Williams "openbmc/phosphor-dbus-interfaces", 20583394610SPatrick Williams "openbmc/sdbusplus", 20683394610SPatrick Williams "openbmc/sdeventplus", 207aae36d18SPatrick Williams ], 208f79ce4c4SPatrick Williams build_type="meson", 209ee3c9eebSPatrick Williams config_flags=[ 2106c98f280SWilliam A. Kennington III "-Dlibonly=true", 2116c98f280SWilliam A. Kennington III "-Dtests=disabled", 2125eabdae9SPatrick Williams f"-Dyamldir={prefix}/share/phosphor-dbus-yaml/yaml", 213aae36d18SPatrick Williams ], 214ee3c9eebSPatrick Williams ), 215ee3c9eebSPatrick Williams "openbmc/phosphor-objmgr": PackageDef( 216ee3c9eebSPatrick Williams depends=[ 21711e5762cSBrad Bishop "CLIUtils/CLI11", 21870af95caSPatrick Williams "boost", 21983394610SPatrick Williams "leethomason/tinyxml2", 22070af95caSPatrick Williams "openbmc/phosphor-dbus-interfaces", 22183394610SPatrick Williams "openbmc/phosphor-logging", 22283394610SPatrick Williams "openbmc/sdbusplus", 223aae36d18SPatrick Williams ], 2241197e359SBrad Bishop build_type="meson", 2251197e359SBrad Bishop config_flags=[ 2261197e359SBrad Bishop "-Dtests=disabled", 2271197e359SBrad Bishop ], 228ee3c9eebSPatrick Williams ), 2291c19e453SManojkiran Eda "openbmc/libpldm": PackageDef( 230ee3c9eebSPatrick Williams build_type="meson", 231ee3c9eebSPatrick Williams config_flags=[ 23229d69bb0SAndrew Jeffery "-Dabi=deprecated,stable", 233aae36d18SPatrick Williams "-Doem-ibm=enabled", 234aae36d18SPatrick Williams "-Dtests=disabled", 235aae36d18SPatrick Williams ], 236ee3c9eebSPatrick Williams ), 237ee3c9eebSPatrick Williams "openbmc/sdbusplus": PackageDef( 238ee3c9eebSPatrick Williams build_type="meson", 239ee3c9eebSPatrick Williams custom_post_dl=[ 240aae36d18SPatrick Williams "cd tools", 241aae36d18SPatrick Williams f"./setup.py install --root=/ --prefix={prefix}", 242aae36d18SPatrick Williams "cd ..", 243aae36d18SPatrick Williams ], 244ee3c9eebSPatrick Williams config_flags=[ 245aae36d18SPatrick Williams "-Dexamples=disabled", 246aae36d18SPatrick Williams "-Dtests=disabled", 247aae36d18SPatrick Williams ], 248b16f3e20SPatrick Williams ), 249ee3c9eebSPatrick Williams "openbmc/sdeventplus": PackageDef( 25070af95caSPatrick Williams depends=[ 25170af95caSPatrick Williams "Naios/function2", 25270af95caSPatrick Williams "openbmc/stdplus", 25370af95caSPatrick Williams ], 254ee3c9eebSPatrick Williams build_type="meson", 255ee3c9eebSPatrick Williams config_flags=[ 256ee3c9eebSPatrick Williams "-Dexamples=false", 257ee3c9eebSPatrick Williams "-Dtests=disabled", 258ee3c9eebSPatrick Williams ], 259ee3c9eebSPatrick Williams ), 260ee3c9eebSPatrick Williams "openbmc/stdplus": PackageDef( 26170af95caSPatrick Williams depends=[ 26270af95caSPatrick Williams "fmtlib/fmt", 263ca1bf0c0SWilliam A. Kennington III "google/googletest", 264ca1bf0c0SWilliam A. Kennington III "Naios/function2", 26570af95caSPatrick Williams ], 266ee3c9eebSPatrick Williams build_type="meson", 267ee3c9eebSPatrick Williams config_flags=[ 268ee3c9eebSPatrick Williams "-Dexamples=false", 269ee3c9eebSPatrick Williams "-Dtests=disabled", 270ca1bf0c0SWilliam A. Kennington III "-Dgtest=enabled", 271ee3c9eebSPatrick Williams ], 272ee3c9eebSPatrick Williams ), 273ee3c9eebSPatrick Williams} # type: Dict[str, PackageDef] 27402871c91SPatrick Williams 27502871c91SPatrick Williams# Define common flags used for builds 27602871c91SPatrick Williamsconfigure_flags = " ".join( 27702871c91SPatrick Williams [ 27802871c91SPatrick Williams f"--prefix={prefix}", 27902871c91SPatrick Williams ] 28002871c91SPatrick Williams) 28102871c91SPatrick Williamscmake_flags = " ".join( 28202871c91SPatrick Williams [ 28302871c91SPatrick Williams "-DBUILD_SHARED_LIBS=ON", 2840f2086b3SPatrick Williams "-DCMAKE_BUILD_TYPE=RelWithDebInfo", 28502871c91SPatrick Williams f"-DCMAKE_INSTALL_PREFIX:PATH={prefix}", 2860f2086b3SPatrick Williams "-GNinja", 2870f2086b3SPatrick Williams "-DCMAKE_MAKE_PROGRAM=ninja", 28802871c91SPatrick Williams ] 28902871c91SPatrick Williams) 29002871c91SPatrick Williamsmeson_flags = " ".join( 29102871c91SPatrick Williams [ 29202871c91SPatrick Williams "--wrap-mode=nodownload", 29302871c91SPatrick Williams f"-Dprefix={prefix}", 29402871c91SPatrick Williams ] 29502871c91SPatrick Williams) 29602871c91SPatrick Williams 297ee3c9eebSPatrick Williams 298ee3c9eebSPatrick Williamsclass Package(threading.Thread): 299ee3c9eebSPatrick Williams """Class used to build the Docker stages for each package. 300ee3c9eebSPatrick Williams 301ee3c9eebSPatrick Williams Generally, this class should not be instantiated directly but through 302ee3c9eebSPatrick Williams Package.generate_all(). 303ee3c9eebSPatrick Williams """ 304ee3c9eebSPatrick Williams 305ee3c9eebSPatrick Williams # Copy the packages dictionary. 306ee3c9eebSPatrick Williams packages = packages.copy() 307ee3c9eebSPatrick Williams 308ee3c9eebSPatrick Williams # Lock used for thread-safety. 309ee3c9eebSPatrick Williams lock = threading.Lock() 310ee3c9eebSPatrick Williams 311ee3c9eebSPatrick Williams def __init__(self, pkg: str): 312ee3c9eebSPatrick Williams """pkg - The name of this package (ex. foo/bar )""" 313ee3c9eebSPatrick Williams super(Package, self).__init__() 314ee3c9eebSPatrick Williams 315ee3c9eebSPatrick Williams self.package = pkg 316ee3c9eebSPatrick Williams self.exception = None # type: Optional[Exception] 317ee3c9eebSPatrick Williams 318ee3c9eebSPatrick Williams # Reference to this package's 319ee3c9eebSPatrick Williams self.pkg_def = Package.packages[pkg] 320ee3c9eebSPatrick Williams self.pkg_def["__package"] = self 321ee3c9eebSPatrick Williams 322ee3c9eebSPatrick Williams def run(self) -> None: 323ee3c9eebSPatrick Williams """Thread 'run' function. Builds the Docker stage.""" 324ee3c9eebSPatrick Williams 325ee3c9eebSPatrick Williams # In case this package has no rev, fetch it from Github. 326ee3c9eebSPatrick Williams self._update_rev() 327ee3c9eebSPatrick Williams 328ee3c9eebSPatrick Williams # Find all the Package objects that this package depends on. 329ee3c9eebSPatrick Williams # This section is locked because we are looking into another 330ee3c9eebSPatrick Williams # package's PackageDef dict, which could be being modified. 331ee3c9eebSPatrick Williams Package.lock.acquire() 332ee3c9eebSPatrick Williams deps: Iterable[Package] = [ 333ee3c9eebSPatrick Williams Package.packages[deppkg]["__package"] 334ee3c9eebSPatrick Williams for deppkg in self.pkg_def.get("depends", []) 335ee3c9eebSPatrick Williams ] 336ee3c9eebSPatrick Williams Package.lock.release() 337ee3c9eebSPatrick Williams 338ee3c9eebSPatrick Williams # Wait until all the depends finish building. We need them complete 339ee3c9eebSPatrick Williams # for the "COPY" commands. 340ee3c9eebSPatrick Williams for deppkg in deps: 341ee3c9eebSPatrick Williams deppkg.join() 342ee3c9eebSPatrick Williams 343ee3c9eebSPatrick Williams # Generate this package's Dockerfile. 344ee3c9eebSPatrick Williams dockerfile = f""" 345ee3c9eebSPatrick WilliamsFROM {docker_base_img_name} 346ee3c9eebSPatrick Williams{self._df_copycmds()} 347ee3c9eebSPatrick Williams{self._df_build()} 348ee3c9eebSPatrick Williams""" 349ee3c9eebSPatrick Williams 350ee3c9eebSPatrick Williams # Generate the resulting tag name and save it to the PackageDef. 351ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef, 352ee3c9eebSPatrick Williams # which can be accessed by other threads. 353ee3c9eebSPatrick Williams Package.lock.acquire() 354ee3c9eebSPatrick Williams tag = Docker.tagname(self._stagename(), dockerfile) 355ee3c9eebSPatrick Williams self.pkg_def["__tag"] = tag 356ee3c9eebSPatrick Williams Package.lock.release() 357ee3c9eebSPatrick Williams 358ee3c9eebSPatrick Williams # Do the build / save any exceptions. 359ee3c9eebSPatrick Williams try: 360ee3c9eebSPatrick Williams Docker.build(self.package, tag, dockerfile) 361ee3c9eebSPatrick Williams except Exception as e: 362ee3c9eebSPatrick Williams self.exception = e 363ee3c9eebSPatrick Williams 364ee3c9eebSPatrick Williams @classmethod 365ee3c9eebSPatrick Williams def generate_all(cls) -> None: 366ee3c9eebSPatrick Williams """Ensure a Docker stage is created for all defined packages. 367ee3c9eebSPatrick Williams 368ee3c9eebSPatrick Williams These are done in parallel but with appropriate blocking per 369ee3c9eebSPatrick Williams package 'depends' specifications. 370ee3c9eebSPatrick Williams """ 371ee3c9eebSPatrick Williams 372ee3c9eebSPatrick Williams # Create a Package for each defined package. 373ee3c9eebSPatrick Williams pkg_threads = [Package(p) for p in cls.packages.keys()] 374ee3c9eebSPatrick Williams 375ee3c9eebSPatrick Williams # Start building them all. 3766dbd7807SPatrick Williams # This section is locked because threads depend on each other, 3776dbd7807SPatrick Williams # based on the packages, and they cannot 'join' on a thread 3786dbd7807SPatrick Williams # which is not yet started. Adding a lock here allows all the 3796dbd7807SPatrick Williams # threads to start before they 'join' their dependencies. 3806dbd7807SPatrick Williams Package.lock.acquire() 381ee3c9eebSPatrick Williams for t in pkg_threads: 382ee3c9eebSPatrick Williams t.start() 3836dbd7807SPatrick Williams Package.lock.release() 384ee3c9eebSPatrick Williams 385ee3c9eebSPatrick Williams # Wait for completion. 386ee3c9eebSPatrick Williams for t in pkg_threads: 387ee3c9eebSPatrick Williams t.join() 388ee3c9eebSPatrick Williams # Check if the thread saved off its own exception. 389ee3c9eebSPatrick Williams if t.exception: 390ee3c9eebSPatrick Williams print(f"Package {t.package} failed!", file=sys.stderr) 391ee3c9eebSPatrick Williams raise t.exception 392ee3c9eebSPatrick Williams 393ee3c9eebSPatrick Williams @staticmethod 394ee3c9eebSPatrick Williams def df_all_copycmds() -> str: 395ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to copy all packages 396ee3c9eebSPatrick Williams into the final image. 397ee3c9eebSPatrick Williams """ 398ee3c9eebSPatrick Williams return Package.df_copycmds_set(Package.packages.keys()) 399ee3c9eebSPatrick Williams 400ee3c9eebSPatrick Williams @classmethod 401ee3c9eebSPatrick Williams def depcache(cls) -> str: 402ee3c9eebSPatrick Williams """Create the contents of the '/tmp/depcache'. 403ee3c9eebSPatrick Williams This file is a comma-separated list of "<pkg>:<rev>". 404ee3c9eebSPatrick Williams """ 405ee3c9eebSPatrick Williams 406ee3c9eebSPatrick Williams # This needs to be sorted for consistency. 407ee3c9eebSPatrick Williams depcache = "" 408ee3c9eebSPatrick Williams for pkg in sorted(cls.packages.keys()): 409ee3c9eebSPatrick Williams depcache += "%s:%s," % (pkg, cls.packages[pkg]["rev"]) 410ee3c9eebSPatrick Williams return depcache 411ee3c9eebSPatrick Williams 412ee3c9eebSPatrick Williams def _update_rev(self) -> None: 413ee3c9eebSPatrick Williams """Look up the HEAD for missing a static rev.""" 414ee3c9eebSPatrick Williams 415ee3c9eebSPatrick Williams if "rev" in self.pkg_def: 416ee3c9eebSPatrick Williams return 417ee3c9eebSPatrick Williams 41865b21fb9SPatrick Williams # Check if Jenkins/Gerrit gave us a revision and use it. 41965b21fb9SPatrick Williams if gerrit_project == self.package and gerrit_rev: 42065b21fb9SPatrick Williams print( 42165b21fb9SPatrick Williams f"Found Gerrit revision for {self.package}: {gerrit_rev}", 42265b21fb9SPatrick Williams file=sys.stderr, 42365b21fb9SPatrick Williams ) 42465b21fb9SPatrick Williams self.pkg_def["rev"] = gerrit_rev 42565b21fb9SPatrick Williams return 42665b21fb9SPatrick Williams 427ee3c9eebSPatrick Williams # Ask Github for all the branches. 42805fb2a0aSPatrick Williams lookup = git( 42905fb2a0aSPatrick Williams "ls-remote", "--heads", f"https://github.com/{self.package}" 43005fb2a0aSPatrick Williams ) 431ee3c9eebSPatrick Williams 432ee3c9eebSPatrick Williams # Find the branch matching {branch} (or fallback to master). 433ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef. 434ee3c9eebSPatrick Williams Package.lock.acquire() 435ee3c9eebSPatrick Williams for line in lookup.split("\n"): 436ee3c9eebSPatrick Williams if f"refs/heads/{branch}" in line: 437ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 438c7d73646SPatrick Williams elif ( 439c7d73646SPatrick Williams "refs/heads/master" in line or "refs/heads/main" in line 440c7d73646SPatrick Williams ) and "rev" not in self.pkg_def: 441ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 442ee3c9eebSPatrick Williams Package.lock.release() 443ee3c9eebSPatrick Williams 444ee3c9eebSPatrick Williams def _stagename(self) -> str: 445ee3c9eebSPatrick Williams """Create a name for the Docker stage associated with this pkg.""" 446ee3c9eebSPatrick Williams return self.package.replace("/", "-").lower() 447ee3c9eebSPatrick Williams 448ee3c9eebSPatrick Williams def _url(self) -> str: 449ee3c9eebSPatrick Williams """Get the URL for this package.""" 450ee3c9eebSPatrick Williams rev = self.pkg_def["rev"] 451ee3c9eebSPatrick Williams 452ee3c9eebSPatrick Williams # If the lambda exists, call it. 453ee3c9eebSPatrick Williams if "url" in self.pkg_def: 454ee3c9eebSPatrick Williams return self.pkg_def["url"](self.package, rev) 455ee3c9eebSPatrick Williams 456ee3c9eebSPatrick Williams # Default to the github archive URL. 457ee3c9eebSPatrick Williams return f"https://github.com/{self.package}/archive/{rev}.tar.gz" 458ee3c9eebSPatrick Williams 459ee3c9eebSPatrick Williams def _cmd_download(self) -> str: 460ee3c9eebSPatrick Williams """Formulate the command necessary to download and unpack to source.""" 461ee3c9eebSPatrick Williams 462ee3c9eebSPatrick Williams url = self._url() 463ee3c9eebSPatrick Williams if ".tar." not in url: 464ee3c9eebSPatrick Williams raise NotImplementedError( 465ee3c9eebSPatrick Williams f"Unhandled download type for {self.package}: {url}" 466ee3c9eebSPatrick Williams ) 467ee3c9eebSPatrick Williams 468ee3c9eebSPatrick Williams cmd = f"curl -L {url} | tar -x" 469ee3c9eebSPatrick Williams 470ee3c9eebSPatrick Williams if url.endswith(".bz2"): 471ee3c9eebSPatrick Williams cmd += "j" 472ee3c9eebSPatrick Williams elif url.endswith(".gz"): 473ee3c9eebSPatrick Williams cmd += "z" 474ee3c9eebSPatrick Williams else: 475ee3c9eebSPatrick Williams raise NotImplementedError( 476ee3c9eebSPatrick Williams f"Unknown tar flags needed for {self.package}: {url}" 477ee3c9eebSPatrick Williams ) 478ee3c9eebSPatrick Williams 479ee3c9eebSPatrick Williams return cmd 480ee3c9eebSPatrick Williams 481ee3c9eebSPatrick Williams def _cmd_cd_srcdir(self) -> str: 482ee3c9eebSPatrick Williams """Formulate the command necessary to 'cd' into the source dir.""" 483ee3c9eebSPatrick Williams return f"cd {self.package.split('/')[-1]}*" 484ee3c9eebSPatrick Williams 485ee3c9eebSPatrick Williams def _df_copycmds(self) -> str: 486ee3c9eebSPatrick Williams """Formulate the dockerfile snippet necessary to COPY all depends.""" 487ee3c9eebSPatrick Williams 488ee3c9eebSPatrick Williams if "depends" not in self.pkg_def: 489ee3c9eebSPatrick Williams return "" 490ee3c9eebSPatrick Williams return Package.df_copycmds_set(self.pkg_def["depends"]) 491ee3c9eebSPatrick Williams 492ee3c9eebSPatrick Williams @staticmethod 493ee3c9eebSPatrick Williams def df_copycmds_set(pkgs: Iterable[str]) -> str: 494ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to COPY a set of 495ee3c9eebSPatrick Williams packages into a Docker stage. 496ee3c9eebSPatrick Williams """ 497ee3c9eebSPatrick Williams 498ee3c9eebSPatrick Williams copy_cmds = "" 499ee3c9eebSPatrick Williams 500ee3c9eebSPatrick Williams # Sort the packages for consistency. 501ee3c9eebSPatrick Williams for p in sorted(pkgs): 502ee3c9eebSPatrick Williams tag = Package.packages[p]["__tag"] 503ee3c9eebSPatrick Williams copy_cmds += f"COPY --from={tag} {prefix} {prefix}\n" 504ee3c9eebSPatrick Williams # Workaround for upstream docker bug and multiple COPY cmds 505ee3c9eebSPatrick Williams # https://github.com/moby/moby/issues/37965 506ee3c9eebSPatrick Williams copy_cmds += "RUN true\n" 507ee3c9eebSPatrick Williams 508ee3c9eebSPatrick Williams return copy_cmds 509ee3c9eebSPatrick Williams 510ee3c9eebSPatrick Williams def _df_build(self) -> str: 511ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to download, build, and 512ee3c9eebSPatrick Williams install a package into a Docker stage. 513ee3c9eebSPatrick Williams """ 514ee3c9eebSPatrick Williams 515ee3c9eebSPatrick Williams # Download and extract source. 516ee3c9eebSPatrick Williams result = f"RUN {self._cmd_download()} && {self._cmd_cd_srcdir()} && " 517ee3c9eebSPatrick Williams 518ee3c9eebSPatrick Williams # Handle 'custom_post_dl' commands. 519ee3c9eebSPatrick Williams custom_post_dl = self.pkg_def.get("custom_post_dl") 520ee3c9eebSPatrick Williams if custom_post_dl: 521ee3c9eebSPatrick Williams result += " && ".join(custom_post_dl) + " && " 522ee3c9eebSPatrick Williams 523ee3c9eebSPatrick Williams # Build and install package based on 'build_type'. 524ee3c9eebSPatrick Williams build_type = self.pkg_def["build_type"] 525ee3c9eebSPatrick Williams if build_type == "autoconf": 526ee3c9eebSPatrick Williams result += self._cmd_build_autoconf() 527ee3c9eebSPatrick Williams elif build_type == "cmake": 528ee3c9eebSPatrick Williams result += self._cmd_build_cmake() 529ee3c9eebSPatrick Williams elif build_type == "custom": 530ee3c9eebSPatrick Williams result += self._cmd_build_custom() 531ee3c9eebSPatrick Williams elif build_type == "make": 532ee3c9eebSPatrick Williams result += self._cmd_build_make() 533ee3c9eebSPatrick Williams elif build_type == "meson": 534ee3c9eebSPatrick Williams result += self._cmd_build_meson() 535ee3c9eebSPatrick Williams else: 536ee3c9eebSPatrick Williams raise NotImplementedError( 537ee3c9eebSPatrick Williams f"Unhandled build type for {self.package}: {build_type}" 538ee3c9eebSPatrick Williams ) 539ee3c9eebSPatrick Williams 5406bce2ca1SPatrick Williams # Handle 'custom_post_install' commands. 5416bce2ca1SPatrick Williams custom_post_install = self.pkg_def.get("custom_post_install") 5426bce2ca1SPatrick Williams if custom_post_install: 5436bce2ca1SPatrick Williams result += " && " + " && ".join(custom_post_install) 5446bce2ca1SPatrick Williams 545ee3c9eebSPatrick Williams return result 546ee3c9eebSPatrick Williams 547ee3c9eebSPatrick Williams def _cmd_build_autoconf(self) -> str: 548ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 549ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 550ee3c9eebSPatrick Williams result = "./bootstrap.sh && " 551ee3c9eebSPatrick Williams result += f"{env} ./configure {configure_flags} {options} && " 552ee3c9eebSPatrick Williams result += f"make -j{proc_count} && make install" 553ee3c9eebSPatrick Williams return result 554ee3c9eebSPatrick Williams 555ee3c9eebSPatrick Williams def _cmd_build_cmake(self) -> str: 556ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 557ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 558ee3c9eebSPatrick Williams result = "mkdir builddir && cd builddir && " 559ee3c9eebSPatrick Williams result += f"{env} cmake {cmake_flags} {options} .. && " 560ee3c9eebSPatrick Williams result += "cmake --build . --target all && " 561ee3c9eebSPatrick Williams result += "cmake --build . --target install && " 562ee3c9eebSPatrick Williams result += "cd .." 563ee3c9eebSPatrick Williams return result 564ee3c9eebSPatrick Williams 565ee3c9eebSPatrick Williams def _cmd_build_custom(self) -> str: 566ee3c9eebSPatrick Williams return " && ".join(self.pkg_def.get("build_steps", [])) 567ee3c9eebSPatrick Williams 568ee3c9eebSPatrick Williams def _cmd_build_make(self) -> str: 569ee3c9eebSPatrick Williams return f"make -j{proc_count} && make install" 570ee3c9eebSPatrick Williams 571ee3c9eebSPatrick Williams def _cmd_build_meson(self) -> str: 572ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 573ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 574e2da11adSAndrew Jeffery result = f"{env} meson setup builddir {meson_flags} {options} && " 575ee3c9eebSPatrick Williams result += "ninja -C builddir && ninja -C builddir install" 576ee3c9eebSPatrick Williams return result 577ee3c9eebSPatrick Williams 578ee3c9eebSPatrick Williams 579ee3c9eebSPatrick Williamsclass Docker: 580ee3c9eebSPatrick Williams """Class to assist with Docker interactions. All methods are static.""" 581ee3c9eebSPatrick Williams 582ee3c9eebSPatrick Williams @staticmethod 583ee3c9eebSPatrick Williams def timestamp() -> str: 584ee3c9eebSPatrick Williams """Generate a timestamp for today using the ISO week.""" 585ee3c9eebSPatrick Williams today = date.today().isocalendar() 586ee3c9eebSPatrick Williams return f"{today[0]}-W{today[1]:02}" 587ee3c9eebSPatrick Williams 588ee3c9eebSPatrick Williams @staticmethod 58941d86218SPatrick Williams def tagname(pkgname: Optional[str], dockerfile: str) -> str: 590ee3c9eebSPatrick Williams """Generate a tag name for a package using a hash of the Dockerfile.""" 591ee3c9eebSPatrick Williams result = docker_image_name 592ee3c9eebSPatrick Williams if pkgname: 593ee3c9eebSPatrick Williams result += "-" + pkgname 594ee3c9eebSPatrick Williams 595ee3c9eebSPatrick Williams result += ":" + Docker.timestamp() 596ee3c9eebSPatrick Williams result += "-" + sha256(dockerfile.encode()).hexdigest()[0:16] 597ee3c9eebSPatrick Williams 598ee3c9eebSPatrick Williams return result 599ee3c9eebSPatrick Williams 600ee3c9eebSPatrick Williams @staticmethod 601ee3c9eebSPatrick Williams def build(pkg: str, tag: str, dockerfile: str) -> None: 60222e6110bSAndrew Geissler """Build a docker image using the Dockerfile and tagging it with 'tag'.""" 603ee3c9eebSPatrick Williams 604ee3c9eebSPatrick Williams # If we're not forcing builds, check if it already exists and skip. 605ee3c9eebSPatrick Williams if not force_build: 606ee3c9eebSPatrick Williams if docker.image.ls(tag, "--format", '"{{.Repository}}:{{.Tag}}"'): 60705fb2a0aSPatrick Williams print( 60805fb2a0aSPatrick Williams f"Image {tag} already exists. Skipping.", file=sys.stderr 60905fb2a0aSPatrick Williams ) 610ee3c9eebSPatrick Williams return 611ee3c9eebSPatrick Williams 612ee3c9eebSPatrick Williams # Build it. 613ee3c9eebSPatrick Williams # Capture the output of the 'docker build' command and send it to 614ee3c9eebSPatrick Williams # stderr (prefixed with the package name). This allows us to see 615ee3c9eebSPatrick Williams # progress but not polute stdout. Later on we output the final 616ee3c9eebSPatrick Williams # docker tag to stdout and we want to keep that pristine. 617ee3c9eebSPatrick Williams # 618ee3c9eebSPatrick Williams # Other unusual flags: 619ee3c9eebSPatrick Williams # --no-cache: Bypass the Docker cache if 'force_build'. 620ee3c9eebSPatrick Williams # --force-rm: Clean up Docker processes if they fail. 621ee3c9eebSPatrick Williams docker.build( 622ee3c9eebSPatrick Williams proxy_args, 623ee3c9eebSPatrick Williams "--network=host", 624ee3c9eebSPatrick Williams "--force-rm", 625ee3c9eebSPatrick Williams "--no-cache=true" if force_build else "--no-cache=false", 626ee3c9eebSPatrick Williams "-t", 627ee3c9eebSPatrick Williams tag, 628ee3c9eebSPatrick Williams "-", 629ee3c9eebSPatrick Williams _in=dockerfile, 630ee3c9eebSPatrick Williams _out=( 631ee3c9eebSPatrick Williams lambda line: print( 632ee3c9eebSPatrick Williams pkg + ":", line, end="", file=sys.stderr, flush=True 633ee3c9eebSPatrick Williams ) 634ee3c9eebSPatrick Williams ), 635ee3c9eebSPatrick Williams ) 636ee3c9eebSPatrick Williams 637ee3c9eebSPatrick Williams 638ee3c9eebSPatrick Williams# Read a bunch of environment variables. 63905fb2a0aSPatrick Williamsdocker_image_name = os.environ.get( 64005fb2a0aSPatrick Williams "DOCKER_IMAGE_NAME", "openbmc/ubuntu-unit-test" 64105fb2a0aSPatrick Williams) 642ee3c9eebSPatrick Williamsforce_build = os.environ.get("FORCE_DOCKER_BUILD") 643ee3c9eebSPatrick Williamsis_automated_ci_build = os.environ.get("BUILD_URL", False) 644c6caa184SWilliam A. Kennington IIIdistro = os.environ.get("DISTRO", "ubuntu:mantic") 645ee3c9eebSPatrick Williamsbranch = os.environ.get("BRANCH", "master") 646ee3c9eebSPatrick Williamsubuntu_mirror = os.environ.get("UBUNTU_MIRROR") 647ee3c9eebSPatrick Williamshttp_proxy = os.environ.get("http_proxy") 648ee3c9eebSPatrick Williams 64965b21fb9SPatrick Williamsgerrit_project = os.environ.get("GERRIT_PROJECT") 65065b21fb9SPatrick Williamsgerrit_rev = os.environ.get("GERRIT_PATCHSET_REVISION") 65165b21fb9SPatrick Williams 652d0dabc3eSAndrew Geissler# Ensure appropriate docker build output to see progress and identify 653d0dabc3eSAndrew Geissler# any issues 654d0dabc3eSAndrew Geissleros.environ["BUILDKIT_PROGRESS"] = "plain" 655d0dabc3eSAndrew Geissler 656ee3c9eebSPatrick Williams# Set up some common variables. 657ee3c9eebSPatrick Williamsusername = os.environ.get("USER", "root") 658ee3c9eebSPatrick Williamshomedir = os.environ.get("HOME", "/root") 659ee3c9eebSPatrick Williamsgid = os.getgid() 660ee3c9eebSPatrick Williamsuid = os.getuid() 661ee3c9eebSPatrick Williams 6626825a018SJosh Lehan# Use well-known constants if user is root 6636825a018SJosh Lehanif username == "root": 6646825a018SJosh Lehan homedir = "/root" 6656825a018SJosh Lehan gid = 0 6666825a018SJosh Lehan uid = 0 6676825a018SJosh Lehan 668ee3c9eebSPatrick Williams# Determine the architecture for Docker. 669ee3c9eebSPatrick Williamsarch = uname("-m").strip() 670ee3c9eebSPatrick Williamsif arch == "ppc64le": 671ee3c9eebSPatrick Williams docker_base = "ppc64le/" 672ee3c9eebSPatrick Williamselif arch == "x86_64": 673ee3c9eebSPatrick Williams docker_base = "" 674051b05b7SThang Q. Nguyenelif arch == "aarch64": 675f98f1a8dSThang Q. Nguyen docker_base = "arm64v8/" 676ee3c9eebSPatrick Williamselse: 677ee3c9eebSPatrick Williams print( 678ee3c9eebSPatrick Williams f"Unsupported system architecture({arch}) found for docker image", 679ee3c9eebSPatrick Williams file=sys.stderr, 680ee3c9eebSPatrick Williams ) 681ee3c9eebSPatrick Williams sys.exit(1) 682ee3c9eebSPatrick Williams 68302871c91SPatrick Williams# Special flags if setting up a deb mirror. 68402871c91SPatrick Williamsmirror = "" 68502871c91SPatrick Williamsif "ubuntu" in distro and ubuntu_mirror: 68602871c91SPatrick Williams mirror = f""" 687e08ffba8SPatrick WilliamsRUN echo "deb {ubuntu_mirror} \ 688e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME) \ 689e08ffba8SPatrick Williams main restricted universe multiverse" > /etc/apt/sources.list && \\ 690e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 691e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-updates \ 692e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 693e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 694e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-security \ 695e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 696e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 697e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-proposed \ 698e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 699e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 700e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-backports \ 701e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list 70202871c91SPatrick Williams""" 70302871c91SPatrick Williams 70402871c91SPatrick Williams# Special flags for proxying. 70502871c91SPatrick Williamsproxy_cmd = "" 70634ec77e8SAdrian Ambrożewiczproxy_keyserver = "" 70702871c91SPatrick Williamsproxy_args = [] 70802871c91SPatrick Williamsif http_proxy: 70902871c91SPatrick Williams proxy_cmd = f""" 71002871c91SPatrick WilliamsRUN echo "[http]" >> {homedir}/.gitconfig && \ 71102871c91SPatrick Williams echo "proxy = {http_proxy}" >> {homedir}/.gitconfig 71202871c91SPatrick Williams""" 71334ec77e8SAdrian Ambrożewicz proxy_keyserver = f"--keyserver-options http-proxy={http_proxy}" 71434ec77e8SAdrian Ambrożewicz 71502871c91SPatrick Williams proxy_args.extend( 71602871c91SPatrick Williams [ 71702871c91SPatrick Williams "--build-arg", 71802871c91SPatrick Williams f"http_proxy={http_proxy}", 71902871c91SPatrick Williams "--build-arg", 720d461cd6aSLei YU f"https_proxy={http_proxy}", 72102871c91SPatrick Williams ] 72202871c91SPatrick Williams ) 72302871c91SPatrick Williams 724ee3c9eebSPatrick Williams# Create base Dockerfile. 725a18d9c57SPatrick Williamsdockerfile_base = f""" 726a18d9c57SPatrick WilliamsFROM {docker_base}{distro} 72702871c91SPatrick Williams 72802871c91SPatrick Williams{mirror} 72902871c91SPatrick Williams 73002871c91SPatrick WilliamsENV DEBIAN_FRONTEND noninteractive 73102871c91SPatrick Williams 7328949d3c3SPatrick WilliamsENV PYTHONPATH "/usr/local/lib/python3.10/site-packages/" 73302871c91SPatrick Williams 734bb16ac14SPatrick Williams# Sometimes the ubuntu key expires and we need a way to force an execution 735bb16ac14SPatrick Williams# of the apt-get commands for the dbgsym-keyring. When this happens we see 736bb16ac14SPatrick Williams# an error like: "Release: The following signatures were invalid:" 737bb16ac14SPatrick Williams# Insert a bogus echo that we can change here when we get this error to force 738bb16ac14SPatrick Williams# the update. 739bb16ac14SPatrick WilliamsRUN echo "ubuntu keyserver rev as of 2021-04-21" 740bb16ac14SPatrick Williams 74102871c91SPatrick Williams# We need the keys to be imported for dbgsym repos 74202871c91SPatrick Williams# New releases have a package, older ones fall back to manual fetching 74302871c91SPatrick Williams# https://wiki.ubuntu.com/Debug%20Symbol%20Packages 744575b5e4cSJagpal Singh Gill# Known issue with gpg to get keys via proxy - 745575b5e4cSJagpal Singh Gill# https://bugs.launchpad.net/ubuntu/+source/gnupg2/+bug/1788190, hence using 746575b5e4cSJagpal Singh Gill# curl to get keys. 74750837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && \ 748f79ce4c4SPatrick Williams ( apt-get install gpgv ubuntu-dbgsym-keyring || \ 749575b5e4cSJagpal Singh Gill ( apt-get install -yy dirmngr curl && \ 750575b5e4cSJagpal Singh Gill curl -sSL \ 751575b5e4cSJagpal Singh Gill 'https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xF2EDC64DC5AEE1F6B9C621F0C8CAB6595FDFF622' \ 752575b5e4cSJagpal Singh Gill | apt-key add - )) 75302871c91SPatrick Williams 75402871c91SPatrick Williams# Parse the current repo list into a debug repo list 755e08ffba8SPatrick WilliamsRUN sed -n '/^deb /s,^deb [^ ]* ,deb http://ddebs.ubuntu.com ,p' \ 756e08ffba8SPatrick Williams /etc/apt/sources.list >/etc/apt/sources.list.d/debug.list 75702871c91SPatrick Williams 75802871c91SPatrick Williams# Remove non-existent debug repos 75941d86218SPatrick WilliamsRUN sed -i '/-\\(backports\\|security\\) /d' /etc/apt/sources.list.d/debug.list 76002871c91SPatrick Williams 76102871c91SPatrick WilliamsRUN cat /etc/apt/sources.list.d/debug.list 76202871c91SPatrick Williams 76302871c91SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && apt-get install -yy \ 76458f1915eSAndrew Jeffery abi-compliance-checker \ 7658b112068SAndrew Jeffery abi-dumper \ 76602871c91SPatrick Williams autoconf \ 76702871c91SPatrick Williams autoconf-archive \ 768af49ed51SAndrew Geissler bison \ 76964b6f9d2SPatrick Williams clang-16 \ 77064b6f9d2SPatrick Williams clang-format-16 \ 77164b6f9d2SPatrick Williams clang-tidy-16 \ 77264b6f9d2SPatrick Williams clang-tools-16 \ 773af49ed51SAndrew Geissler cmake \ 774af49ed51SAndrew Geissler curl \ 775af49ed51SAndrew Geissler dbus \ 776af49ed51SAndrew Geissler device-tree-compiler \ 777af49ed51SAndrew Geissler flex \ 778961f148bSPatrick Williams g++-13 \ 779961f148bSPatrick Williams gcc-13 \ 780af49ed51SAndrew Geissler git \ 78102871c91SPatrick Williams iproute2 \ 782af49ed51SAndrew Geissler iputils-ping \ 783524a331cSManojkiran Eda libaudit-dev \ 784af49ed51SAndrew Geissler libc6-dbg \ 785af49ed51SAndrew Geissler libc6-dev \ 786af49ed51SAndrew Geissler libconfig++-dev \ 787af49ed51SAndrew Geissler libcryptsetup-dev \ 788af49ed51SAndrew Geissler libdbus-1-dev \ 789af49ed51SAndrew Geissler libevdev-dev \ 790af49ed51SAndrew Geissler libgpiod-dev \ 791af49ed51SAndrew Geissler libi2c-dev \ 792af49ed51SAndrew Geissler libjpeg-dev \ 793af49ed51SAndrew Geissler libjson-perl \ 794af49ed51SAndrew Geissler libldap2-dev \ 795af49ed51SAndrew Geissler libmimetic-dev \ 79602871c91SPatrick Williams libnl-3-dev \ 79702871c91SPatrick Williams libnl-genl-3-dev \ 79802871c91SPatrick Williams libpam0g-dev \ 79902871c91SPatrick Williams libpciaccess-dev \ 800af49ed51SAndrew Geissler libperlio-gzip-perl \ 801af49ed51SAndrew Geissler libpng-dev \ 802af49ed51SAndrew Geissler libprotobuf-dev \ 803af49ed51SAndrew Geissler libsnmp-dev \ 804af49ed51SAndrew Geissler libssl-dev \ 805af49ed51SAndrew Geissler libsystemd-dev \ 806af49ed51SAndrew Geissler libtool \ 807af49ed51SAndrew Geissler liburing-dev \ 80802871c91SPatrick Williams libxml2-utils \ 8090eedeedaSPatrick Williams libxml-simple-perl \ 810af49ed51SAndrew Geissler ninja-build \ 811af49ed51SAndrew Geissler npm \ 812af49ed51SAndrew Geissler pkg-config \ 813af49ed51SAndrew Geissler protobuf-compiler \ 814af49ed51SAndrew Geissler python3 \ 815af49ed51SAndrew Geissler python3-dev\ 816af49ed51SAndrew Geissler python3-git \ 817af49ed51SAndrew Geissler python3-mako \ 818af49ed51SAndrew Geissler python3-pip \ 819af49ed51SAndrew Geissler python3-setuptools \ 820af49ed51SAndrew Geissler python3-socks \ 821af49ed51SAndrew Geissler python3-yaml \ 8229adf68d6SJohn Wedig rsync \ 823af49ed51SAndrew Geissler shellcheck \ 824af49ed51SAndrew Geissler sudo \ 825af49ed51SAndrew Geissler systemd \ 826af49ed51SAndrew Geissler valgrind \ 827af49ed51SAndrew Geissler valgrind-dbg \ 828b565f825SAndrew Geissler vim \ 829af49ed51SAndrew Geissler wget \ 830af49ed51SAndrew Geissler xxd 83102871c91SPatrick Williams 832961f148bSPatrick WilliamsRUN update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-13 13 \ 833961f148bSPatrick Williams --slave /usr/bin/g++ g++ /usr/bin/g++-13 \ 834961f148bSPatrick Williams --slave /usr/bin/gcov gcov /usr/bin/gcov-13 \ 835961f148bSPatrick Williams --slave /usr/bin/gcov-dump gcov-dump /usr/bin/gcov-dump-13 \ 836961f148bSPatrick Williams --slave /usr/bin/gcov-tool gcov-tool /usr/bin/gcov-tool-13 837961f148bSPatrick WilliamsRUN update-alternatives --remove cpp /usr/bin/cpp && \ 838961f148bSPatrick Williams update-alternatives --install /usr/bin/cpp cpp /usr/bin/cpp-13 13 83902871c91SPatrick Williams 84064b6f9d2SPatrick WilliamsRUN update-alternatives --install /usr/bin/clang clang /usr/bin/clang-16 1000 \ 84164b6f9d2SPatrick Williams --slave /usr/bin/clang++ clang++ /usr/bin/clang++-16 \ 84264b6f9d2SPatrick Williams --slave /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-16 \ 84364b6f9d2SPatrick Williams --slave /usr/bin/clang-format clang-format /usr/bin/clang-format-16 \ 844e08ffba8SPatrick Williams --slave /usr/bin/run-clang-tidy run-clang-tidy.py \ 84564b6f9d2SPatrick Williams /usr/bin/run-clang-tidy-16 \ 84664b6f9d2SPatrick Williams --slave /usr/bin/scan-build scan-build /usr/bin/scan-build-16 84702871c91SPatrick Williams 84850837436SPatrick Williams""" 84950837436SPatrick Williams 85050837436SPatrick Williamsif is_automated_ci_build: 85150837436SPatrick Williams dockerfile_base += f""" 85250837436SPatrick Williams# Run an arbitrary command to polute the docker cache regularly force us 85350837436SPatrick Williams# to re-run `apt-get update` daily. 854ee3c9eebSPatrick WilliamsRUN echo {Docker.timestamp()} 85550837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy 85650837436SPatrick Williams 85750837436SPatrick Williams""" 85850837436SPatrick Williams 85941d86218SPatrick Williamsdockerfile_base += """ 8605e4d8402SPatrick WilliamsRUN pip3 install --break-system-packages \ 861818023dfSPatrick Williams beautysh \ 862818023dfSPatrick Williams black \ 863818023dfSPatrick Williams codespell \ 864818023dfSPatrick Williams flake8 \ 865818023dfSPatrick Williams gitlint \ 866818023dfSPatrick Williams inflection \ 867818023dfSPatrick Williams isort \ 868818023dfSPatrick Williams jsonschema \ 8690044f69cSPatrick Williams meson==1.0.1 \ 870818023dfSPatrick Williams protobuf \ 871818023dfSPatrick Williams requests 872b08ddf77SPatrick Williams 873b08ddf77SPatrick WilliamsRUN npm install -g \ 874b08ddf77SPatrick Williams eslint@latest eslint-plugin-json@latest \ 8757d41f6d2SPatrick Williams markdownlint-cli@latest \ 876b08ddf77SPatrick Williams prettier@latest 877fb9948a3SEd Tanous""" 878fb9948a3SEd Tanous 879ee3c9eebSPatrick Williams# Build the base and stage docker images. 880ee3c9eebSPatrick Williamsdocker_base_img_name = Docker.tagname("base", dockerfile_base) 881ee3c9eebSPatrick WilliamsDocker.build("base", docker_base_img_name, dockerfile_base) 882ee3c9eebSPatrick WilliamsPackage.generate_all() 88302871c91SPatrick Williams 884ee3c9eebSPatrick Williams# Create the final Dockerfile. 885a18d9c57SPatrick Williamsdockerfile = f""" 88602871c91SPatrick Williams# Build the final output image 887a18d9c57SPatrick WilliamsFROM {docker_base_img_name} 888ee3c9eebSPatrick Williams{Package.df_all_copycmds()} 88902871c91SPatrick Williams 89002871c91SPatrick Williams# Some of our infrastructure still relies on the presence of this file 89102871c91SPatrick Williams# even though it is no longer needed to rebuild the docker environment 89202871c91SPatrick Williams# NOTE: The file is sorted to ensure the ordering is stable. 893ee3c9eebSPatrick WilliamsRUN echo '{Package.depcache()}' > /tmp/depcache 89402871c91SPatrick Williams 89567cc0616SPatrick Williams# Ensure the group, user, and home directory are created (or rename them if 89667cc0616SPatrick Williams# they already exist). 89767cc0616SPatrick WilliamsRUN if grep -q ":{gid}:" /etc/group ; then \ 89867cc0616SPatrick Williams groupmod -n {username} $(awk -F : '{{ if ($3 == {gid}) {{ print $1 }} }}' /etc/group) ; \ 89967cc0616SPatrick Williams else \ 90067cc0616SPatrick Williams groupadd -f -g {gid} {username} ; \ 90167cc0616SPatrick Williams fi 90202871c91SPatrick WilliamsRUN mkdir -p "{os.path.dirname(homedir)}" 90367cc0616SPatrick WilliamsRUN if grep -q ":{uid}:" /etc/passwd ; then \ 90473b3ee91SPatrick Williams usermod -l {username} -d {homedir} -m $(awk -F : '{{ if ($3 == {uid}) {{ print $1 }} }}' /etc/passwd) ; \ 90567cc0616SPatrick Williams else \ 90667cc0616SPatrick Williams useradd -d {homedir} -m -u {uid} -g {gid} {username} ; \ 90767cc0616SPatrick Williams fi 90802871c91SPatrick WilliamsRUN sed -i '1iDefaults umask=000' /etc/sudoers 90902871c91SPatrick WilliamsRUN echo "{username} ALL=(ALL) NOPASSWD: ALL" >>/etc/sudoers 91002871c91SPatrick Williams 911305a9a5dSAndrew Geissler# Ensure user has ability to write to /usr/local for different tool 912305a9a5dSAndrew Geissler# and data installs 9137bb00b13SAndrew GeisslerRUN chown -R {username}:{username} /usr/local/share 914305a9a5dSAndrew Geissler 91502871c91SPatrick Williams{proxy_cmd} 91602871c91SPatrick Williams 91702871c91SPatrick WilliamsRUN /bin/bash 91802871c91SPatrick Williams""" 91902871c91SPatrick Williams 920a18d9c57SPatrick Williams# Do the final docker build 921ee3c9eebSPatrick Williamsdocker_final_img_name = Docker.tagname(None, dockerfile) 922ee3c9eebSPatrick WilliamsDocker.build("final", docker_final_img_name, dockerfile) 923ee3c9eebSPatrick Williams 92400536fbeSPatrick Williams# Print the tag of the final image. 92500536fbeSPatrick Williamsprint(docker_final_img_name) 926