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( 8345bfd1ffSEd Tanous rev="1.81.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 ( 90e08ffba8SPatrick Williams "./bootstrap.sh" 91e08ffba8SPatrick Williams f" --prefix={prefix} --with-libraries=context,coroutine" 92e08ffba8SPatrick Williams ), 93aae36d18SPatrick Williams "./b2", 94aae36d18SPatrick Williams f"./b2 install --prefix={prefix}", 95aae36d18SPatrick Williams ], 96ee3c9eebSPatrick Williams ), 97ee3c9eebSPatrick Williams "USCiLab/cereal": PackageDef( 98c1977839SPatrick Williams rev="v1.3.2", 99ee3c9eebSPatrick Williams build_type="custom", 100ee3c9eebSPatrick Williams build_steps=[f"cp -a include/cereal/ {prefix}/include/"], 101ee3c9eebSPatrick Williams ), 102c7198558SEd Tanous "danmar/cppcheck": PackageDef( 103be4bd084SPatrick Williams rev="2.9", 104c7198558SEd Tanous build_type="cmake", 105c7198558SEd Tanous ), 106ee3c9eebSPatrick Williams "CLIUtils/CLI11": PackageDef( 107ee3c9eebSPatrick Williams rev="v1.9.1", 108ee3c9eebSPatrick Williams build_type="cmake", 109ee3c9eebSPatrick Williams config_flags=[ 110aae36d18SPatrick Williams "-DBUILD_TESTING=OFF", 111aae36d18SPatrick Williams "-DCLI11_BUILD_DOCS=OFF", 112aae36d18SPatrick Williams "-DCLI11_BUILD_EXAMPLES=OFF", 113aae36d18SPatrick Williams ], 114ee3c9eebSPatrick Williams ), 115ee3c9eebSPatrick Williams "fmtlib/fmt": PackageDef( 116652d8aeaSWilliam A. Kennington III rev="9.1.0", 117ee3c9eebSPatrick Williams build_type="cmake", 118ee3c9eebSPatrick Williams config_flags=[ 119aae36d18SPatrick Williams "-DFMT_DOC=OFF", 120aae36d18SPatrick Williams "-DFMT_TEST=OFF", 121aae36d18SPatrick Williams ], 122ee3c9eebSPatrick Williams ), 123ee3c9eebSPatrick Williams "Naios/function2": PackageDef( 124c1977839SPatrick Williams rev="4.2.1", 125ee3c9eebSPatrick Williams build_type="custom", 126ee3c9eebSPatrick Williams build_steps=[ 127aae36d18SPatrick Williams f"mkdir {prefix}/include/function2", 128aae36d18SPatrick Williams f"cp include/function2/function2.hpp {prefix}/include/function2/", 129aae36d18SPatrick Williams ], 130ee3c9eebSPatrick Williams ), 131ed9414e8SPatrick Williams # release-1.12.1 132ee3c9eebSPatrick Williams "google/googletest": PackageDef( 133ed9414e8SPatrick Williams rev="58d77fa8070e8cec2dc1ed015d66b454c8d78850", 134ee3c9eebSPatrick Williams build_type="cmake", 1354dd32c02SWilliam A. Kennington III config_env=["CXXFLAGS=-std=c++20"], 136ee3c9eebSPatrick Williams config_flags=["-DTHREADS_PREFER_PTHREAD_FLAG=ON"], 137ee3c9eebSPatrick Williams ), 138ee3c9eebSPatrick Williams "nlohmann/json": PackageDef( 139c1977839SPatrick Williams rev="v3.11.2", 1406bce2ca1SPatrick Williams build_type="cmake", 1416bce2ca1SPatrick Williams config_flags=["-DJSON_BuildTests=OFF"], 1426bce2ca1SPatrick Williams custom_post_install=[ 143e08ffba8SPatrick Williams ( 144e08ffba8SPatrick Williams f"ln -s {prefix}/include/nlohmann/json.hpp" 145e08ffba8SPatrick Williams f" {prefix}/include/json.hpp" 146e08ffba8SPatrick Williams ), 147aae36d18SPatrick Williams ], 148ee3c9eebSPatrick Williams ), 149058e3a34SPrzemyslaw Czarnowski "json-c/json-c": PackageDef( 150058e3a34SPrzemyslaw Czarnowski rev="json-c-0.16-20220414", 151058e3a34SPrzemyslaw Czarnowski build_type="cmake", 152058e3a34SPrzemyslaw Czarnowski ), 15302871c91SPatrick Williams # Snapshot from 2019-05-24 154ee3c9eebSPatrick Williams "linux-test-project/lcov": PackageDef( 155ee3c9eebSPatrick Williams rev="v1.15", 156ee3c9eebSPatrick Williams build_type="make", 157ee3c9eebSPatrick Williams ), 158001055b8SPatrick Williams # dev-6.0 2022-11-28 159ee3c9eebSPatrick Williams "openbmc/linux": PackageDef( 160001055b8SPatrick Williams rev="1b16243b004ce4d977a9f3b9d9e715cf5028f867", 161ee3c9eebSPatrick Williams build_type="custom", 162ee3c9eebSPatrick Williams build_steps=[ 163aae36d18SPatrick Williams f"make -j{proc_count} defconfig", 164aae36d18SPatrick Williams f"make INSTALL_HDR_PATH={prefix} headers_install", 165aae36d18SPatrick Williams ], 166ee3c9eebSPatrick Williams ), 167ee3c9eebSPatrick Williams "LibVNC/libvncserver": PackageDef( 168ee3c9eebSPatrick Williams rev="LibVNCServer-0.9.13", 169ee3c9eebSPatrick Williams build_type="cmake", 170ee3c9eebSPatrick Williams ), 171ee3c9eebSPatrick Williams "leethomason/tinyxml2": PackageDef( 172c1977839SPatrick Williams rev="9.0.0", 173ee3c9eebSPatrick Williams build_type="cmake", 174ee3c9eebSPatrick Williams ), 175ee3c9eebSPatrick Williams "tristanpenman/valijson": PackageDef( 176c1977839SPatrick Williams rev="v0.7", 177ee3c9eebSPatrick Williams build_type="cmake", 178ee3c9eebSPatrick Williams config_flags=[ 1790eedeedaSPatrick Williams "-Dvalijson_BUILD_TESTS=0", 1800eedeedaSPatrick Williams "-Dvalijson_INSTALL_HEADERS=1", 181aae36d18SPatrick Williams ], 182ee3c9eebSPatrick Williams ), 183ee3c9eebSPatrick Williams "open-power/pdbg": PackageDef(build_type="autoconf"), 184ee3c9eebSPatrick Williams "openbmc/gpioplus": PackageDef( 185ee3c9eebSPatrick Williams depends=["openbmc/stdplus"], 186ee3c9eebSPatrick Williams build_type="meson", 187ee3c9eebSPatrick Williams config_flags=[ 188aae36d18SPatrick Williams "-Dexamples=false", 189aae36d18SPatrick Williams "-Dtests=disabled", 190aae36d18SPatrick Williams ], 191ee3c9eebSPatrick Williams ), 192ee3c9eebSPatrick Williams "openbmc/phosphor-dbus-interfaces": PackageDef( 193ee3c9eebSPatrick Williams depends=["openbmc/sdbusplus"], 194ee3c9eebSPatrick Williams build_type="meson", 1954fe87776SWilliam A. Kennington III config_flags=["-Dgenerate_md=false"], 196ee3c9eebSPatrick Williams ), 197ee3c9eebSPatrick Williams "openbmc/phosphor-logging": PackageDef( 198ee3c9eebSPatrick Williams depends=[ 19983394610SPatrick Williams "USCiLab/cereal", 20083394610SPatrick Williams "openbmc/phosphor-dbus-interfaces", 20183394610SPatrick Williams "openbmc/sdbusplus", 20283394610SPatrick Williams "openbmc/sdeventplus", 203aae36d18SPatrick Williams ], 204f79ce4c4SPatrick Williams build_type="meson", 205ee3c9eebSPatrick Williams config_flags=[ 2066c98f280SWilliam A. Kennington III "-Dlibonly=true", 2076c98f280SWilliam A. Kennington III "-Dtests=disabled", 2085eabdae9SPatrick Williams f"-Dyamldir={prefix}/share/phosphor-dbus-yaml/yaml", 209aae36d18SPatrick Williams ], 210ee3c9eebSPatrick Williams ), 211ee3c9eebSPatrick Williams "openbmc/phosphor-objmgr": PackageDef( 212ee3c9eebSPatrick Williams depends=[ 21311e5762cSBrad Bishop "CLIUtils/CLI11", 21470af95caSPatrick Williams "boost", 21583394610SPatrick Williams "leethomason/tinyxml2", 21670af95caSPatrick Williams "openbmc/phosphor-dbus-interfaces", 21783394610SPatrick Williams "openbmc/phosphor-logging", 21883394610SPatrick Williams "openbmc/sdbusplus", 219aae36d18SPatrick Williams ], 2201197e359SBrad Bishop build_type="meson", 2211197e359SBrad Bishop config_flags=[ 2221197e359SBrad Bishop "-Dtests=disabled", 2231197e359SBrad Bishop ], 224ee3c9eebSPatrick Williams ), 2251c19e453SManojkiran Eda "openbmc/libpldm": PackageDef( 226ee3c9eebSPatrick Williams build_type="meson", 227ee3c9eebSPatrick Williams config_flags=[ 228aae36d18SPatrick Williams "-Doem-ibm=enabled", 229aae36d18SPatrick Williams "-Dtests=disabled", 230aae36d18SPatrick Williams ], 231ee3c9eebSPatrick Williams ), 232ee3c9eebSPatrick Williams "openbmc/sdbusplus": PackageDef( 233ee3c9eebSPatrick Williams build_type="meson", 234ee3c9eebSPatrick Williams custom_post_dl=[ 235aae36d18SPatrick Williams "cd tools", 236aae36d18SPatrick Williams f"./setup.py install --root=/ --prefix={prefix}", 237aae36d18SPatrick Williams "cd ..", 238aae36d18SPatrick Williams ], 239ee3c9eebSPatrick Williams config_flags=[ 240aae36d18SPatrick Williams "-Dexamples=disabled", 241aae36d18SPatrick Williams "-Dtests=disabled", 242aae36d18SPatrick Williams ], 243b16f3e20SPatrick Williams ), 244ee3c9eebSPatrick Williams "openbmc/sdeventplus": PackageDef( 24570af95caSPatrick Williams depends=[ 24670af95caSPatrick Williams "Naios/function2", 24770af95caSPatrick Williams "openbmc/stdplus", 24870af95caSPatrick Williams ], 249ee3c9eebSPatrick Williams build_type="meson", 250ee3c9eebSPatrick Williams config_flags=[ 251ee3c9eebSPatrick Williams "-Dexamples=false", 252ee3c9eebSPatrick Williams "-Dtests=disabled", 253ee3c9eebSPatrick Williams ], 254ee3c9eebSPatrick Williams ), 255ee3c9eebSPatrick Williams "openbmc/stdplus": PackageDef( 25670af95caSPatrick Williams depends=[ 25770af95caSPatrick Williams "fmtlib/fmt", 258ca1bf0c0SWilliam A. Kennington III "google/googletest", 259ca1bf0c0SWilliam A. Kennington III "Naios/function2", 26070af95caSPatrick Williams ], 261ee3c9eebSPatrick Williams build_type="meson", 262ee3c9eebSPatrick Williams config_flags=[ 263ee3c9eebSPatrick Williams "-Dexamples=false", 264ee3c9eebSPatrick Williams "-Dtests=disabled", 265ca1bf0c0SWilliam A. Kennington III "-Dgtest=enabled", 266ee3c9eebSPatrick Williams ], 267ee3c9eebSPatrick Williams ), 268ee3c9eebSPatrick Williams} # type: Dict[str, PackageDef] 26902871c91SPatrick Williams 27002871c91SPatrick Williams# Define common flags used for builds 27102871c91SPatrick Williamsconfigure_flags = " ".join( 27202871c91SPatrick Williams [ 27302871c91SPatrick Williams f"--prefix={prefix}", 27402871c91SPatrick Williams ] 27502871c91SPatrick Williams) 27602871c91SPatrick Williamscmake_flags = " ".join( 27702871c91SPatrick Williams [ 27802871c91SPatrick Williams "-DBUILD_SHARED_LIBS=ON", 2790f2086b3SPatrick Williams "-DCMAKE_BUILD_TYPE=RelWithDebInfo", 28002871c91SPatrick Williams f"-DCMAKE_INSTALL_PREFIX:PATH={prefix}", 2810f2086b3SPatrick Williams "-GNinja", 2820f2086b3SPatrick Williams "-DCMAKE_MAKE_PROGRAM=ninja", 28302871c91SPatrick Williams ] 28402871c91SPatrick Williams) 28502871c91SPatrick Williamsmeson_flags = " ".join( 28602871c91SPatrick Williams [ 28702871c91SPatrick Williams "--wrap-mode=nodownload", 28802871c91SPatrick Williams f"-Dprefix={prefix}", 28902871c91SPatrick Williams ] 29002871c91SPatrick Williams) 29102871c91SPatrick Williams 292ee3c9eebSPatrick Williams 293ee3c9eebSPatrick Williamsclass Package(threading.Thread): 294ee3c9eebSPatrick Williams """Class used to build the Docker stages for each package. 295ee3c9eebSPatrick Williams 296ee3c9eebSPatrick Williams Generally, this class should not be instantiated directly but through 297ee3c9eebSPatrick Williams Package.generate_all(). 298ee3c9eebSPatrick Williams """ 299ee3c9eebSPatrick Williams 300ee3c9eebSPatrick Williams # Copy the packages dictionary. 301ee3c9eebSPatrick Williams packages = packages.copy() 302ee3c9eebSPatrick Williams 303ee3c9eebSPatrick Williams # Lock used for thread-safety. 304ee3c9eebSPatrick Williams lock = threading.Lock() 305ee3c9eebSPatrick Williams 306ee3c9eebSPatrick Williams def __init__(self, pkg: str): 307ee3c9eebSPatrick Williams """pkg - The name of this package (ex. foo/bar )""" 308ee3c9eebSPatrick Williams super(Package, self).__init__() 309ee3c9eebSPatrick Williams 310ee3c9eebSPatrick Williams self.package = pkg 311ee3c9eebSPatrick Williams self.exception = None # type: Optional[Exception] 312ee3c9eebSPatrick Williams 313ee3c9eebSPatrick Williams # Reference to this package's 314ee3c9eebSPatrick Williams self.pkg_def = Package.packages[pkg] 315ee3c9eebSPatrick Williams self.pkg_def["__package"] = self 316ee3c9eebSPatrick Williams 317ee3c9eebSPatrick Williams def run(self) -> None: 318ee3c9eebSPatrick Williams """Thread 'run' function. Builds the Docker stage.""" 319ee3c9eebSPatrick Williams 320ee3c9eebSPatrick Williams # In case this package has no rev, fetch it from Github. 321ee3c9eebSPatrick Williams self._update_rev() 322ee3c9eebSPatrick Williams 323ee3c9eebSPatrick Williams # Find all the Package objects that this package depends on. 324ee3c9eebSPatrick Williams # This section is locked because we are looking into another 325ee3c9eebSPatrick Williams # package's PackageDef dict, which could be being modified. 326ee3c9eebSPatrick Williams Package.lock.acquire() 327ee3c9eebSPatrick Williams deps: Iterable[Package] = [ 328ee3c9eebSPatrick Williams Package.packages[deppkg]["__package"] 329ee3c9eebSPatrick Williams for deppkg in self.pkg_def.get("depends", []) 330ee3c9eebSPatrick Williams ] 331ee3c9eebSPatrick Williams Package.lock.release() 332ee3c9eebSPatrick Williams 333ee3c9eebSPatrick Williams # Wait until all the depends finish building. We need them complete 334ee3c9eebSPatrick Williams # for the "COPY" commands. 335ee3c9eebSPatrick Williams for deppkg in deps: 336ee3c9eebSPatrick Williams deppkg.join() 337ee3c9eebSPatrick Williams 338ee3c9eebSPatrick Williams # Generate this package's Dockerfile. 339ee3c9eebSPatrick Williams dockerfile = f""" 340ee3c9eebSPatrick WilliamsFROM {docker_base_img_name} 341ee3c9eebSPatrick Williams{self._df_copycmds()} 342ee3c9eebSPatrick Williams{self._df_build()} 343ee3c9eebSPatrick Williams""" 344ee3c9eebSPatrick Williams 345ee3c9eebSPatrick Williams # Generate the resulting tag name and save it to the PackageDef. 346ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef, 347ee3c9eebSPatrick Williams # which can be accessed by other threads. 348ee3c9eebSPatrick Williams Package.lock.acquire() 349ee3c9eebSPatrick Williams tag = Docker.tagname(self._stagename(), dockerfile) 350ee3c9eebSPatrick Williams self.pkg_def["__tag"] = tag 351ee3c9eebSPatrick Williams Package.lock.release() 352ee3c9eebSPatrick Williams 353ee3c9eebSPatrick Williams # Do the build / save any exceptions. 354ee3c9eebSPatrick Williams try: 355ee3c9eebSPatrick Williams Docker.build(self.package, tag, dockerfile) 356ee3c9eebSPatrick Williams except Exception as e: 357ee3c9eebSPatrick Williams self.exception = e 358ee3c9eebSPatrick Williams 359ee3c9eebSPatrick Williams @classmethod 360ee3c9eebSPatrick Williams def generate_all(cls) -> None: 361ee3c9eebSPatrick Williams """Ensure a Docker stage is created for all defined packages. 362ee3c9eebSPatrick Williams 363ee3c9eebSPatrick Williams These are done in parallel but with appropriate blocking per 364ee3c9eebSPatrick Williams package 'depends' specifications. 365ee3c9eebSPatrick Williams """ 366ee3c9eebSPatrick Williams 367ee3c9eebSPatrick Williams # Create a Package for each defined package. 368ee3c9eebSPatrick Williams pkg_threads = [Package(p) for p in cls.packages.keys()] 369ee3c9eebSPatrick Williams 370ee3c9eebSPatrick Williams # Start building them all. 3716dbd7807SPatrick Williams # This section is locked because threads depend on each other, 3726dbd7807SPatrick Williams # based on the packages, and they cannot 'join' on a thread 3736dbd7807SPatrick Williams # which is not yet started. Adding a lock here allows all the 3746dbd7807SPatrick Williams # threads to start before they 'join' their dependencies. 3756dbd7807SPatrick Williams Package.lock.acquire() 376ee3c9eebSPatrick Williams for t in pkg_threads: 377ee3c9eebSPatrick Williams t.start() 3786dbd7807SPatrick Williams Package.lock.release() 379ee3c9eebSPatrick Williams 380ee3c9eebSPatrick Williams # Wait for completion. 381ee3c9eebSPatrick Williams for t in pkg_threads: 382ee3c9eebSPatrick Williams t.join() 383ee3c9eebSPatrick Williams # Check if the thread saved off its own exception. 384ee3c9eebSPatrick Williams if t.exception: 385ee3c9eebSPatrick Williams print(f"Package {t.package} failed!", file=sys.stderr) 386ee3c9eebSPatrick Williams raise t.exception 387ee3c9eebSPatrick Williams 388ee3c9eebSPatrick Williams @staticmethod 389ee3c9eebSPatrick Williams def df_all_copycmds() -> str: 390ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to copy all packages 391ee3c9eebSPatrick Williams into the final image. 392ee3c9eebSPatrick Williams """ 393ee3c9eebSPatrick Williams return Package.df_copycmds_set(Package.packages.keys()) 394ee3c9eebSPatrick Williams 395ee3c9eebSPatrick Williams @classmethod 396ee3c9eebSPatrick Williams def depcache(cls) -> str: 397ee3c9eebSPatrick Williams """Create the contents of the '/tmp/depcache'. 398ee3c9eebSPatrick Williams This file is a comma-separated list of "<pkg>:<rev>". 399ee3c9eebSPatrick Williams """ 400ee3c9eebSPatrick Williams 401ee3c9eebSPatrick Williams # This needs to be sorted for consistency. 402ee3c9eebSPatrick Williams depcache = "" 403ee3c9eebSPatrick Williams for pkg in sorted(cls.packages.keys()): 404ee3c9eebSPatrick Williams depcache += "%s:%s," % (pkg, cls.packages[pkg]["rev"]) 405ee3c9eebSPatrick Williams return depcache 406ee3c9eebSPatrick Williams 407ee3c9eebSPatrick Williams def _update_rev(self) -> None: 408ee3c9eebSPatrick Williams """Look up the HEAD for missing a static rev.""" 409ee3c9eebSPatrick Williams 410ee3c9eebSPatrick Williams if "rev" in self.pkg_def: 411ee3c9eebSPatrick Williams return 412ee3c9eebSPatrick Williams 41365b21fb9SPatrick Williams # Check if Jenkins/Gerrit gave us a revision and use it. 41465b21fb9SPatrick Williams if gerrit_project == self.package and gerrit_rev: 41565b21fb9SPatrick Williams print( 41665b21fb9SPatrick Williams f"Found Gerrit revision for {self.package}: {gerrit_rev}", 41765b21fb9SPatrick Williams file=sys.stderr, 41865b21fb9SPatrick Williams ) 41965b21fb9SPatrick Williams self.pkg_def["rev"] = gerrit_rev 42065b21fb9SPatrick Williams return 42165b21fb9SPatrick Williams 422ee3c9eebSPatrick Williams # Ask Github for all the branches. 42305fb2a0aSPatrick Williams lookup = git( 42405fb2a0aSPatrick Williams "ls-remote", "--heads", f"https://github.com/{self.package}" 42505fb2a0aSPatrick Williams ) 426ee3c9eebSPatrick Williams 427ee3c9eebSPatrick Williams # Find the branch matching {branch} (or fallback to master). 428ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef. 429ee3c9eebSPatrick Williams Package.lock.acquire() 430ee3c9eebSPatrick Williams for line in lookup.split("\n"): 431ee3c9eebSPatrick Williams if f"refs/heads/{branch}" in line: 432ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 433c7d73646SPatrick Williams elif ( 434c7d73646SPatrick Williams "refs/heads/master" in line or "refs/heads/main" in line 435c7d73646SPatrick Williams ) and "rev" not in self.pkg_def: 436ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 437ee3c9eebSPatrick Williams Package.lock.release() 438ee3c9eebSPatrick Williams 439ee3c9eebSPatrick Williams def _stagename(self) -> str: 440ee3c9eebSPatrick Williams """Create a name for the Docker stage associated with this pkg.""" 441ee3c9eebSPatrick Williams return self.package.replace("/", "-").lower() 442ee3c9eebSPatrick Williams 443ee3c9eebSPatrick Williams def _url(self) -> str: 444ee3c9eebSPatrick Williams """Get the URL for this package.""" 445ee3c9eebSPatrick Williams rev = self.pkg_def["rev"] 446ee3c9eebSPatrick Williams 447ee3c9eebSPatrick Williams # If the lambda exists, call it. 448ee3c9eebSPatrick Williams if "url" in self.pkg_def: 449ee3c9eebSPatrick Williams return self.pkg_def["url"](self.package, rev) 450ee3c9eebSPatrick Williams 451ee3c9eebSPatrick Williams # Default to the github archive URL. 452ee3c9eebSPatrick Williams return f"https://github.com/{self.package}/archive/{rev}.tar.gz" 453ee3c9eebSPatrick Williams 454ee3c9eebSPatrick Williams def _cmd_download(self) -> str: 455ee3c9eebSPatrick Williams """Formulate the command necessary to download and unpack to source.""" 456ee3c9eebSPatrick Williams 457ee3c9eebSPatrick Williams url = self._url() 458ee3c9eebSPatrick Williams if ".tar." not in url: 459ee3c9eebSPatrick Williams raise NotImplementedError( 460ee3c9eebSPatrick Williams f"Unhandled download type for {self.package}: {url}" 461ee3c9eebSPatrick Williams ) 462ee3c9eebSPatrick Williams 463ee3c9eebSPatrick Williams cmd = f"curl -L {url} | tar -x" 464ee3c9eebSPatrick Williams 465ee3c9eebSPatrick Williams if url.endswith(".bz2"): 466ee3c9eebSPatrick Williams cmd += "j" 467ee3c9eebSPatrick Williams elif url.endswith(".gz"): 468ee3c9eebSPatrick Williams cmd += "z" 469ee3c9eebSPatrick Williams else: 470ee3c9eebSPatrick Williams raise NotImplementedError( 471ee3c9eebSPatrick Williams f"Unknown tar flags needed for {self.package}: {url}" 472ee3c9eebSPatrick Williams ) 473ee3c9eebSPatrick Williams 474ee3c9eebSPatrick Williams return cmd 475ee3c9eebSPatrick Williams 476ee3c9eebSPatrick Williams def _cmd_cd_srcdir(self) -> str: 477ee3c9eebSPatrick Williams """Formulate the command necessary to 'cd' into the source dir.""" 478ee3c9eebSPatrick Williams return f"cd {self.package.split('/')[-1]}*" 479ee3c9eebSPatrick Williams 480ee3c9eebSPatrick Williams def _df_copycmds(self) -> str: 481ee3c9eebSPatrick Williams """Formulate the dockerfile snippet necessary to COPY all depends.""" 482ee3c9eebSPatrick Williams 483ee3c9eebSPatrick Williams if "depends" not in self.pkg_def: 484ee3c9eebSPatrick Williams return "" 485ee3c9eebSPatrick Williams return Package.df_copycmds_set(self.pkg_def["depends"]) 486ee3c9eebSPatrick Williams 487ee3c9eebSPatrick Williams @staticmethod 488ee3c9eebSPatrick Williams def df_copycmds_set(pkgs: Iterable[str]) -> str: 489ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to COPY a set of 490ee3c9eebSPatrick Williams packages into a Docker stage. 491ee3c9eebSPatrick Williams """ 492ee3c9eebSPatrick Williams 493ee3c9eebSPatrick Williams copy_cmds = "" 494ee3c9eebSPatrick Williams 495ee3c9eebSPatrick Williams # Sort the packages for consistency. 496ee3c9eebSPatrick Williams for p in sorted(pkgs): 497ee3c9eebSPatrick Williams tag = Package.packages[p]["__tag"] 498ee3c9eebSPatrick Williams copy_cmds += f"COPY --from={tag} {prefix} {prefix}\n" 499ee3c9eebSPatrick Williams # Workaround for upstream docker bug and multiple COPY cmds 500ee3c9eebSPatrick Williams # https://github.com/moby/moby/issues/37965 501ee3c9eebSPatrick Williams copy_cmds += "RUN true\n" 502ee3c9eebSPatrick Williams 503ee3c9eebSPatrick Williams return copy_cmds 504ee3c9eebSPatrick Williams 505ee3c9eebSPatrick Williams def _df_build(self) -> str: 506ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to download, build, and 507ee3c9eebSPatrick Williams install a package into a Docker stage. 508ee3c9eebSPatrick Williams """ 509ee3c9eebSPatrick Williams 510ee3c9eebSPatrick Williams # Download and extract source. 511ee3c9eebSPatrick Williams result = f"RUN {self._cmd_download()} && {self._cmd_cd_srcdir()} && " 512ee3c9eebSPatrick Williams 513ee3c9eebSPatrick Williams # Handle 'custom_post_dl' commands. 514ee3c9eebSPatrick Williams custom_post_dl = self.pkg_def.get("custom_post_dl") 515ee3c9eebSPatrick Williams if custom_post_dl: 516ee3c9eebSPatrick Williams result += " && ".join(custom_post_dl) + " && " 517ee3c9eebSPatrick Williams 518ee3c9eebSPatrick Williams # Build and install package based on 'build_type'. 519ee3c9eebSPatrick Williams build_type = self.pkg_def["build_type"] 520ee3c9eebSPatrick Williams if build_type == "autoconf": 521ee3c9eebSPatrick Williams result += self._cmd_build_autoconf() 522ee3c9eebSPatrick Williams elif build_type == "cmake": 523ee3c9eebSPatrick Williams result += self._cmd_build_cmake() 524ee3c9eebSPatrick Williams elif build_type == "custom": 525ee3c9eebSPatrick Williams result += self._cmd_build_custom() 526ee3c9eebSPatrick Williams elif build_type == "make": 527ee3c9eebSPatrick Williams result += self._cmd_build_make() 528ee3c9eebSPatrick Williams elif build_type == "meson": 529ee3c9eebSPatrick Williams result += self._cmd_build_meson() 530ee3c9eebSPatrick Williams else: 531ee3c9eebSPatrick Williams raise NotImplementedError( 532ee3c9eebSPatrick Williams f"Unhandled build type for {self.package}: {build_type}" 533ee3c9eebSPatrick Williams ) 534ee3c9eebSPatrick Williams 5356bce2ca1SPatrick Williams # Handle 'custom_post_install' commands. 5366bce2ca1SPatrick Williams custom_post_install = self.pkg_def.get("custom_post_install") 5376bce2ca1SPatrick Williams if custom_post_install: 5386bce2ca1SPatrick Williams result += " && " + " && ".join(custom_post_install) 5396bce2ca1SPatrick Williams 540ee3c9eebSPatrick Williams return result 541ee3c9eebSPatrick Williams 542ee3c9eebSPatrick Williams def _cmd_build_autoconf(self) -> str: 543ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 544ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 545ee3c9eebSPatrick Williams result = "./bootstrap.sh && " 546ee3c9eebSPatrick Williams result += f"{env} ./configure {configure_flags} {options} && " 547ee3c9eebSPatrick Williams result += f"make -j{proc_count} && make install" 548ee3c9eebSPatrick Williams return result 549ee3c9eebSPatrick Williams 550ee3c9eebSPatrick Williams def _cmd_build_cmake(self) -> str: 551ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 552ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 553ee3c9eebSPatrick Williams result = "mkdir builddir && cd builddir && " 554ee3c9eebSPatrick Williams result += f"{env} cmake {cmake_flags} {options} .. && " 555ee3c9eebSPatrick Williams result += "cmake --build . --target all && " 556ee3c9eebSPatrick Williams result += "cmake --build . --target install && " 557ee3c9eebSPatrick Williams result += "cd .." 558ee3c9eebSPatrick Williams return result 559ee3c9eebSPatrick Williams 560ee3c9eebSPatrick Williams def _cmd_build_custom(self) -> str: 561ee3c9eebSPatrick Williams return " && ".join(self.pkg_def.get("build_steps", [])) 562ee3c9eebSPatrick Williams 563ee3c9eebSPatrick Williams def _cmd_build_make(self) -> str: 564ee3c9eebSPatrick Williams return f"make -j{proc_count} && make install" 565ee3c9eebSPatrick Williams 566ee3c9eebSPatrick Williams def _cmd_build_meson(self) -> str: 567ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 568ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 569ee3c9eebSPatrick Williams result = f"{env} meson builddir {meson_flags} {options} && " 570ee3c9eebSPatrick Williams result += "ninja -C builddir && ninja -C builddir install" 571ee3c9eebSPatrick Williams return result 572ee3c9eebSPatrick Williams 573ee3c9eebSPatrick Williams 574ee3c9eebSPatrick Williamsclass Docker: 575ee3c9eebSPatrick Williams """Class to assist with Docker interactions. All methods are static.""" 576ee3c9eebSPatrick Williams 577ee3c9eebSPatrick Williams @staticmethod 578ee3c9eebSPatrick Williams def timestamp() -> str: 579ee3c9eebSPatrick Williams """Generate a timestamp for today using the ISO week.""" 580ee3c9eebSPatrick Williams today = date.today().isocalendar() 581ee3c9eebSPatrick Williams return f"{today[0]}-W{today[1]:02}" 582ee3c9eebSPatrick Williams 583ee3c9eebSPatrick Williams @staticmethod 58441d86218SPatrick Williams def tagname(pkgname: Optional[str], dockerfile: str) -> str: 585ee3c9eebSPatrick Williams """Generate a tag name for a package using a hash of the Dockerfile.""" 586ee3c9eebSPatrick Williams result = docker_image_name 587ee3c9eebSPatrick Williams if pkgname: 588ee3c9eebSPatrick Williams result += "-" + pkgname 589ee3c9eebSPatrick Williams 590ee3c9eebSPatrick Williams result += ":" + Docker.timestamp() 591ee3c9eebSPatrick Williams result += "-" + sha256(dockerfile.encode()).hexdigest()[0:16] 592ee3c9eebSPatrick Williams 593ee3c9eebSPatrick Williams return result 594ee3c9eebSPatrick Williams 595ee3c9eebSPatrick Williams @staticmethod 596ee3c9eebSPatrick Williams def build(pkg: str, tag: str, dockerfile: str) -> None: 59722e6110bSAndrew Geissler """Build a docker image using the Dockerfile and tagging it with 'tag'.""" 598ee3c9eebSPatrick Williams 599ee3c9eebSPatrick Williams # If we're not forcing builds, check if it already exists and skip. 600ee3c9eebSPatrick Williams if not force_build: 601ee3c9eebSPatrick Williams if docker.image.ls(tag, "--format", '"{{.Repository}}:{{.Tag}}"'): 60205fb2a0aSPatrick Williams print( 60305fb2a0aSPatrick Williams f"Image {tag} already exists. Skipping.", file=sys.stderr 60405fb2a0aSPatrick Williams ) 605ee3c9eebSPatrick Williams return 606ee3c9eebSPatrick Williams 607ee3c9eebSPatrick Williams # Build it. 608ee3c9eebSPatrick Williams # Capture the output of the 'docker build' command and send it to 609ee3c9eebSPatrick Williams # stderr (prefixed with the package name). This allows us to see 610ee3c9eebSPatrick Williams # progress but not polute stdout. Later on we output the final 611ee3c9eebSPatrick Williams # docker tag to stdout and we want to keep that pristine. 612ee3c9eebSPatrick Williams # 613ee3c9eebSPatrick Williams # Other unusual flags: 614ee3c9eebSPatrick Williams # --no-cache: Bypass the Docker cache if 'force_build'. 615ee3c9eebSPatrick Williams # --force-rm: Clean up Docker processes if they fail. 616ee3c9eebSPatrick Williams docker.build( 617ee3c9eebSPatrick Williams proxy_args, 618ee3c9eebSPatrick Williams "--network=host", 619ee3c9eebSPatrick Williams "--force-rm", 620ee3c9eebSPatrick Williams "--no-cache=true" if force_build else "--no-cache=false", 621ee3c9eebSPatrick Williams "-t", 622ee3c9eebSPatrick Williams tag, 623ee3c9eebSPatrick Williams "-", 624ee3c9eebSPatrick Williams _in=dockerfile, 625ee3c9eebSPatrick Williams _out=( 626ee3c9eebSPatrick Williams lambda line: print( 627ee3c9eebSPatrick Williams pkg + ":", line, end="", file=sys.stderr, flush=True 628ee3c9eebSPatrick Williams ) 629ee3c9eebSPatrick Williams ), 630ee3c9eebSPatrick Williams ) 631ee3c9eebSPatrick Williams 632ee3c9eebSPatrick Williams 633ee3c9eebSPatrick Williams# Read a bunch of environment variables. 63405fb2a0aSPatrick Williamsdocker_image_name = os.environ.get( 63505fb2a0aSPatrick Williams "DOCKER_IMAGE_NAME", "openbmc/ubuntu-unit-test" 63605fb2a0aSPatrick Williams) 637ee3c9eebSPatrick Williamsforce_build = os.environ.get("FORCE_DOCKER_BUILD") 638ee3c9eebSPatrick Williamsis_automated_ci_build = os.environ.get("BUILD_URL", False) 6395b08dc6bSPatrick Williamsdistro = os.environ.get("DISTRO", "ubuntu:kinetic") 640ee3c9eebSPatrick Williamsbranch = os.environ.get("BRANCH", "master") 641ee3c9eebSPatrick Williamsubuntu_mirror = os.environ.get("UBUNTU_MIRROR") 642ee3c9eebSPatrick Williamshttp_proxy = os.environ.get("http_proxy") 643ee3c9eebSPatrick Williams 64465b21fb9SPatrick Williamsgerrit_project = os.environ.get("GERRIT_PROJECT") 64565b21fb9SPatrick Williamsgerrit_rev = os.environ.get("GERRIT_PATCHSET_REVISION") 64665b21fb9SPatrick Williams 647d0dabc3eSAndrew Geissler# Ensure appropriate docker build output to see progress and identify 648d0dabc3eSAndrew Geissler# any issues 649d0dabc3eSAndrew Geissleros.environ["BUILDKIT_PROGRESS"] = "plain" 650d0dabc3eSAndrew Geissler 651ee3c9eebSPatrick Williams# Set up some common variables. 652ee3c9eebSPatrick Williamsusername = os.environ.get("USER", "root") 653ee3c9eebSPatrick Williamshomedir = os.environ.get("HOME", "/root") 654ee3c9eebSPatrick Williamsgid = os.getgid() 655ee3c9eebSPatrick Williamsuid = os.getuid() 656ee3c9eebSPatrick Williams 6576825a018SJosh Lehan# Use well-known constants if user is root 6586825a018SJosh Lehanif username == "root": 6596825a018SJosh Lehan homedir = "/root" 6606825a018SJosh Lehan gid = 0 6616825a018SJosh Lehan uid = 0 6626825a018SJosh Lehan 663ee3c9eebSPatrick Williams# Determine the architecture for Docker. 664ee3c9eebSPatrick Williamsarch = uname("-m").strip() 665ee3c9eebSPatrick Williamsif arch == "ppc64le": 666ee3c9eebSPatrick Williams docker_base = "ppc64le/" 667ee3c9eebSPatrick Williamselif arch == "x86_64": 668ee3c9eebSPatrick Williams docker_base = "" 669051b05b7SThang Q. Nguyenelif arch == "aarch64": 670f98f1a8dSThang Q. Nguyen docker_base = "arm64v8/" 671ee3c9eebSPatrick Williamselse: 672ee3c9eebSPatrick Williams print( 673ee3c9eebSPatrick Williams f"Unsupported system architecture({arch}) found for docker image", 674ee3c9eebSPatrick Williams file=sys.stderr, 675ee3c9eebSPatrick Williams ) 676ee3c9eebSPatrick Williams sys.exit(1) 677ee3c9eebSPatrick Williams 67802871c91SPatrick Williams# Special flags if setting up a deb mirror. 67902871c91SPatrick Williamsmirror = "" 68002871c91SPatrick Williamsif "ubuntu" in distro and ubuntu_mirror: 68102871c91SPatrick Williams mirror = f""" 682e08ffba8SPatrick WilliamsRUN echo "deb {ubuntu_mirror} \ 683e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME) \ 684e08ffba8SPatrick Williams main restricted universe multiverse" > /etc/apt/sources.list && \\ 685e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 686e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-updates \ 687e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 688e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 689e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-security \ 690e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 691e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 692e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-proposed \ 693e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 694e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 695e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-backports \ 696e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list 69702871c91SPatrick Williams""" 69802871c91SPatrick Williams 69902871c91SPatrick Williams# Special flags for proxying. 70002871c91SPatrick Williamsproxy_cmd = "" 70134ec77e8SAdrian Ambrożewiczproxy_keyserver = "" 70202871c91SPatrick Williamsproxy_args = [] 70302871c91SPatrick Williamsif http_proxy: 70402871c91SPatrick Williams proxy_cmd = f""" 70502871c91SPatrick WilliamsRUN echo "[http]" >> {homedir}/.gitconfig && \ 70602871c91SPatrick Williams echo "proxy = {http_proxy}" >> {homedir}/.gitconfig 70702871c91SPatrick Williams""" 70834ec77e8SAdrian Ambrożewicz proxy_keyserver = f"--keyserver-options http-proxy={http_proxy}" 70934ec77e8SAdrian Ambrożewicz 71002871c91SPatrick Williams proxy_args.extend( 71102871c91SPatrick Williams [ 71202871c91SPatrick Williams "--build-arg", 71302871c91SPatrick Williams f"http_proxy={http_proxy}", 71402871c91SPatrick Williams "--build-arg", 715d461cd6aSLei YU f"https_proxy={http_proxy}", 71602871c91SPatrick Williams ] 71702871c91SPatrick Williams ) 71802871c91SPatrick Williams 719ee3c9eebSPatrick Williams# Create base Dockerfile. 720a18d9c57SPatrick Williamsdockerfile_base = f""" 721a18d9c57SPatrick WilliamsFROM {docker_base}{distro} 72202871c91SPatrick Williams 72302871c91SPatrick Williams{mirror} 72402871c91SPatrick Williams 72502871c91SPatrick WilliamsENV DEBIAN_FRONTEND noninteractive 72602871c91SPatrick Williams 7278949d3c3SPatrick WilliamsENV PYTHONPATH "/usr/local/lib/python3.10/site-packages/" 72802871c91SPatrick Williams 729bb16ac14SPatrick Williams# Sometimes the ubuntu key expires and we need a way to force an execution 730bb16ac14SPatrick Williams# of the apt-get commands for the dbgsym-keyring. When this happens we see 731bb16ac14SPatrick Williams# an error like: "Release: The following signatures were invalid:" 732bb16ac14SPatrick Williams# Insert a bogus echo that we can change here when we get this error to force 733bb16ac14SPatrick Williams# the update. 734bb16ac14SPatrick WilliamsRUN echo "ubuntu keyserver rev as of 2021-04-21" 735bb16ac14SPatrick Williams 73602871c91SPatrick Williams# We need the keys to be imported for dbgsym repos 73702871c91SPatrick Williams# New releases have a package, older ones fall back to manual fetching 73802871c91SPatrick Williams# https://wiki.ubuntu.com/Debug%20Symbol%20Packages 73950837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && \ 740f79ce4c4SPatrick Williams ( apt-get install gpgv ubuntu-dbgsym-keyring || \ 74150837436SPatrick Williams ( apt-get install -yy dirmngr && \ 74250837436SPatrick Williams apt-key adv --keyserver keyserver.ubuntu.com \ 74334ec77e8SAdrian Ambrożewicz {proxy_keyserver} \ 74450837436SPatrick Williams --recv-keys F2EDC64DC5AEE1F6B9C621F0C8CAB6595FDFF622 ) ) 74502871c91SPatrick Williams 74602871c91SPatrick Williams# Parse the current repo list into a debug repo list 747e08ffba8SPatrick WilliamsRUN sed -n '/^deb /s,^deb [^ ]* ,deb http://ddebs.ubuntu.com ,p' \ 748e08ffba8SPatrick Williams /etc/apt/sources.list >/etc/apt/sources.list.d/debug.list 74902871c91SPatrick Williams 75002871c91SPatrick Williams# Remove non-existent debug repos 75141d86218SPatrick WilliamsRUN sed -i '/-\\(backports\\|security\\) /d' /etc/apt/sources.list.d/debug.list 75202871c91SPatrick Williams 75302871c91SPatrick WilliamsRUN cat /etc/apt/sources.list.d/debug.list 75402871c91SPatrick Williams 75502871c91SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && apt-get install -yy \ 75602871c91SPatrick Williams autoconf \ 75702871c91SPatrick Williams autoconf-archive \ 758af49ed51SAndrew Geissler bison \ 75927a646b6SPatrick Williams clang-15 \ 76027a646b6SPatrick Williams clang-format-15 \ 76127a646b6SPatrick Williams clang-tidy-15 \ 76227a646b6SPatrick Williams clang-tools-15 \ 763af49ed51SAndrew Geissler cmake \ 764af49ed51SAndrew Geissler curl \ 765af49ed51SAndrew Geissler dbus \ 766af49ed51SAndrew Geissler device-tree-compiler \ 767af49ed51SAndrew Geissler flex \ 768af49ed51SAndrew Geissler g++-12 \ 769af49ed51SAndrew Geissler gcc-12 \ 770af49ed51SAndrew Geissler git \ 77102871c91SPatrick Williams iproute2 \ 772af49ed51SAndrew Geissler iputils-ping \ 773*524a331cSManojkiran Eda libaudit-dev \ 774af49ed51SAndrew Geissler libc6-dbg \ 775af49ed51SAndrew Geissler libc6-dev \ 776af49ed51SAndrew Geissler libconfig++-dev \ 777af49ed51SAndrew Geissler libcryptsetup-dev \ 778af49ed51SAndrew Geissler libdbus-1-dev \ 779af49ed51SAndrew Geissler libevdev-dev \ 780af49ed51SAndrew Geissler libgpiod-dev \ 781af49ed51SAndrew Geissler libi2c-dev \ 782af49ed51SAndrew Geissler libjpeg-dev \ 783af49ed51SAndrew Geissler libjson-perl \ 784af49ed51SAndrew Geissler libldap2-dev \ 785af49ed51SAndrew Geissler libmimetic-dev \ 78602871c91SPatrick Williams libnl-3-dev \ 78702871c91SPatrick Williams libnl-genl-3-dev \ 78802871c91SPatrick Williams libpam0g-dev \ 78902871c91SPatrick Williams libpciaccess-dev \ 790af49ed51SAndrew Geissler libperlio-gzip-perl \ 791af49ed51SAndrew Geissler libpng-dev \ 792af49ed51SAndrew Geissler libprotobuf-dev \ 793af49ed51SAndrew Geissler libsnmp-dev \ 794af49ed51SAndrew Geissler libssl-dev \ 795af49ed51SAndrew Geissler libsystemd-dev \ 796af49ed51SAndrew Geissler libtool \ 797af49ed51SAndrew Geissler liburing2-dbgsym \ 798af49ed51SAndrew Geissler liburing-dev \ 79902871c91SPatrick Williams libxml2-utils \ 8000eedeedaSPatrick Williams libxml-simple-perl \ 801af49ed51SAndrew Geissler ninja-build \ 802af49ed51SAndrew Geissler npm \ 803af49ed51SAndrew Geissler pkg-config \ 804af49ed51SAndrew Geissler protobuf-compiler \ 805af49ed51SAndrew Geissler python3 \ 806af49ed51SAndrew Geissler python3-dev\ 807af49ed51SAndrew Geissler python3-git \ 808af49ed51SAndrew Geissler python3-mako \ 809af49ed51SAndrew Geissler python3-pip \ 810af49ed51SAndrew Geissler python3-setuptools \ 811af49ed51SAndrew Geissler python3-socks \ 812af49ed51SAndrew Geissler python3-yaml \ 8139adf68d6SJohn Wedig rsync \ 814af49ed51SAndrew Geissler shellcheck \ 815af49ed51SAndrew Geissler sudo \ 816af49ed51SAndrew Geissler systemd \ 817af49ed51SAndrew Geissler valgrind \ 818af49ed51SAndrew Geissler valgrind-dbg \ 819b565f825SAndrew Geissler vim \ 820af49ed51SAndrew Geissler wget \ 821af49ed51SAndrew Geissler xxd 82202871c91SPatrick Williams 8235b08dc6bSPatrick Williams# Kinetic comes with GCC-12, so skip this. 8245b08dc6bSPatrick Williams#RUN update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 12 \ 8255b08dc6bSPatrick Williams# --slave /usr/bin/g++ g++ /usr/bin/g++-12 \ 8265b08dc6bSPatrick Williams# --slave /usr/bin/gcov gcov /usr/bin/gcov-12 \ 8275b08dc6bSPatrick Williams# --slave /usr/bin/gcov-dump gcov-dump /usr/bin/gcov-dump-12 \ 8285b08dc6bSPatrick Williams# --slave /usr/bin/gcov-tool gcov-tool /usr/bin/gcov-tool-12 8295b08dc6bSPatrick Williams#RUN update-alternatives --install /usr/bin/cpp cpp /usr/bin/cpp-12 12 83002871c91SPatrick Williams 83127a646b6SPatrick WilliamsRUN update-alternatives --install /usr/bin/clang clang /usr/bin/clang-15 1000 \ 83227a646b6SPatrick Williams --slave /usr/bin/clang++ clang++ /usr/bin/clang++-15 \ 83327a646b6SPatrick Williams --slave /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-15 \ 83427a646b6SPatrick Williams --slave /usr/bin/clang-format clang-format /usr/bin/clang-format-15 \ 835e08ffba8SPatrick Williams --slave /usr/bin/run-clang-tidy run-clang-tidy.py \ 836e08ffba8SPatrick Williams /usr/bin/run-clang-tidy-15 \ 83727a646b6SPatrick Williams --slave /usr/bin/scan-build scan-build /usr/bin/scan-build-15 83802871c91SPatrick Williams 83950837436SPatrick Williams""" 84050837436SPatrick Williams 84150837436SPatrick Williamsif is_automated_ci_build: 84250837436SPatrick Williams dockerfile_base += f""" 84350837436SPatrick Williams# Run an arbitrary command to polute the docker cache regularly force us 84450837436SPatrick Williams# to re-run `apt-get update` daily. 845ee3c9eebSPatrick WilliamsRUN echo {Docker.timestamp()} 84650837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy 84750837436SPatrick Williams 84850837436SPatrick Williams""" 84950837436SPatrick Williams 85041d86218SPatrick Williamsdockerfile_base += """ 851c5969599SPatrick WilliamsRUN pip3 install beautysh 852e795dfe4SPatrick WilliamsRUN pip3 install black 853bc0d5a3aSPatrick WilliamsRUN pip3 install codespell 854c5ad7ff4SPatrick WilliamsRUN pip3 install flake8 855bc0d5a3aSPatrick WilliamsRUN pip3 install gitlint 85602871c91SPatrick WilliamsRUN pip3 install inflection 857e795dfe4SPatrick WilliamsRUN pip3 install isort 85802871c91SPatrick WilliamsRUN pip3 install jsonschema 859fb612a51SMichael ShenRUN pip3 install meson==0.63.0 86002871c91SPatrick WilliamsRUN pip3 install protobuf 861ca8c4a8bSEd TanousRUN pip3 install requests 862b08ddf77SPatrick Williams 863b08ddf77SPatrick WilliamsRUN npm install -g \ 864b08ddf77SPatrick Williams eslint@latest eslint-plugin-json@latest \ 8657d41f6d2SPatrick Williams markdownlint-cli@latest \ 866b08ddf77SPatrick Williams prettier@latest 867fb9948a3SEd Tanous""" 868fb9948a3SEd Tanous 869ee3c9eebSPatrick Williams# Build the base and stage docker images. 870ee3c9eebSPatrick Williamsdocker_base_img_name = Docker.tagname("base", dockerfile_base) 871ee3c9eebSPatrick WilliamsDocker.build("base", docker_base_img_name, dockerfile_base) 872ee3c9eebSPatrick WilliamsPackage.generate_all() 87302871c91SPatrick Williams 874ee3c9eebSPatrick Williams# Create the final Dockerfile. 875a18d9c57SPatrick Williamsdockerfile = f""" 87602871c91SPatrick Williams# Build the final output image 877a18d9c57SPatrick WilliamsFROM {docker_base_img_name} 878ee3c9eebSPatrick Williams{Package.df_all_copycmds()} 87902871c91SPatrick Williams 88002871c91SPatrick Williams# Some of our infrastructure still relies on the presence of this file 88102871c91SPatrick Williams# even though it is no longer needed to rebuild the docker environment 88202871c91SPatrick Williams# NOTE: The file is sorted to ensure the ordering is stable. 883ee3c9eebSPatrick WilliamsRUN echo '{Package.depcache()}' > /tmp/depcache 88402871c91SPatrick Williams 88502871c91SPatrick Williams# Final configuration for the workspace 8866825a018SJosh LehanRUN grep -q {gid} /etc/group || groupadd -f -g {gid} {username} 88702871c91SPatrick WilliamsRUN mkdir -p "{os.path.dirname(homedir)}" 888e08ffba8SPatrick WilliamsRUN grep -q {uid} /etc/passwd || \ 889e08ffba8SPatrick Williams useradd -d {homedir} -m -u {uid} -g {gid} {username} 89002871c91SPatrick WilliamsRUN sed -i '1iDefaults umask=000' /etc/sudoers 89102871c91SPatrick WilliamsRUN echo "{username} ALL=(ALL) NOPASSWD: ALL" >>/etc/sudoers 89202871c91SPatrick Williams 893305a9a5dSAndrew Geissler# Ensure user has ability to write to /usr/local for different tool 894305a9a5dSAndrew Geissler# and data installs 8957bb00b13SAndrew GeisslerRUN chown -R {username}:{username} /usr/local/share 896305a9a5dSAndrew Geissler 89702871c91SPatrick Williams{proxy_cmd} 89802871c91SPatrick Williams 89902871c91SPatrick WilliamsRUN /bin/bash 90002871c91SPatrick Williams""" 90102871c91SPatrick Williams 902a18d9c57SPatrick Williams# Do the final docker build 903ee3c9eebSPatrick Williamsdocker_final_img_name = Docker.tagname(None, dockerfile) 904ee3c9eebSPatrick WilliamsDocker.build("final", docker_final_img_name, dockerfile) 905ee3c9eebSPatrick Williams 90600536fbeSPatrick Williams# Print the tag of the final image. 90700536fbeSPatrick Williamsprint(docker_final_img_name) 908