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( 83c1977839SPatrick Williams rev="1.80.0", 84ee3c9eebSPatrick Williams url=( 85e08ffba8SPatrick Williams lambda pkg, rev: f"https://downloads.yoctoproject.org/mirror/sources/{pkg}_{rev.replace('.', '_')}.tar.bz2" # 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 ), 14902871c91SPatrick Williams # Snapshot from 2019-05-24 150ee3c9eebSPatrick Williams "linux-test-project/lcov": PackageDef( 151ee3c9eebSPatrick Williams rev="v1.15", 152ee3c9eebSPatrick Williams build_type="make", 153ee3c9eebSPatrick Williams ), 154001055b8SPatrick Williams # dev-6.0 2022-11-28 155ee3c9eebSPatrick Williams "openbmc/linux": PackageDef( 156001055b8SPatrick Williams rev="1b16243b004ce4d977a9f3b9d9e715cf5028f867", 157ee3c9eebSPatrick Williams build_type="custom", 158ee3c9eebSPatrick Williams build_steps=[ 159aae36d18SPatrick Williams f"make -j{proc_count} defconfig", 160aae36d18SPatrick Williams f"make INSTALL_HDR_PATH={prefix} headers_install", 161aae36d18SPatrick Williams ], 162ee3c9eebSPatrick Williams ), 163ee3c9eebSPatrick Williams "LibVNC/libvncserver": PackageDef( 164ee3c9eebSPatrick Williams rev="LibVNCServer-0.9.13", 165ee3c9eebSPatrick Williams build_type="cmake", 166ee3c9eebSPatrick Williams ), 167ee3c9eebSPatrick Williams "leethomason/tinyxml2": PackageDef( 168c1977839SPatrick Williams rev="9.0.0", 169ee3c9eebSPatrick Williams build_type="cmake", 170ee3c9eebSPatrick Williams ), 171e08ffba8SPatrick Williams # version from /meta-openembedded/meta-oe/recipes-devtools/boost-url/boost-url_git.bb # noqa: E501 172ee3c9eebSPatrick Williams "CPPAlliance/url": PackageDef( 173ab640cdaSEd Tanous rev="d740a92d38e3a8f4d5b2153f53b82f1c98e312ab", 174eed466e3SEd Tanous build_type="custom", 175eed466e3SEd Tanous build_steps=[f"cp -a include/** {prefix}/include/"], 176ee3c9eebSPatrick Williams ), 177ee3c9eebSPatrick Williams "tristanpenman/valijson": PackageDef( 178c1977839SPatrick Williams rev="v0.7", 179ee3c9eebSPatrick Williams build_type="cmake", 180ee3c9eebSPatrick Williams config_flags=[ 1810eedeedaSPatrick Williams "-Dvalijson_BUILD_TESTS=0", 1820eedeedaSPatrick Williams "-Dvalijson_INSTALL_HEADERS=1", 183aae36d18SPatrick Williams ], 184ee3c9eebSPatrick Williams ), 185ee3c9eebSPatrick Williams "open-power/pdbg": PackageDef(build_type="autoconf"), 186ee3c9eebSPatrick Williams "openbmc/gpioplus": PackageDef( 187ee3c9eebSPatrick Williams depends=["openbmc/stdplus"], 188ee3c9eebSPatrick Williams build_type="meson", 189ee3c9eebSPatrick Williams config_flags=[ 190aae36d18SPatrick Williams "-Dexamples=false", 191aae36d18SPatrick Williams "-Dtests=disabled", 192aae36d18SPatrick Williams ], 193ee3c9eebSPatrick Williams ), 194ee3c9eebSPatrick Williams "openbmc/phosphor-dbus-interfaces": PackageDef( 195ee3c9eebSPatrick Williams depends=["openbmc/sdbusplus"], 196ee3c9eebSPatrick Williams build_type="meson", 1974fe87776SWilliam A. Kennington III config_flags=["-Dgenerate_md=false"], 198ee3c9eebSPatrick Williams ), 199ee3c9eebSPatrick Williams "openbmc/phosphor-logging": PackageDef( 200ee3c9eebSPatrick Williams depends=[ 20183394610SPatrick Williams "USCiLab/cereal", 20283394610SPatrick Williams "openbmc/phosphor-dbus-interfaces", 20383394610SPatrick Williams "openbmc/sdbusplus", 20483394610SPatrick Williams "openbmc/sdeventplus", 205aae36d18SPatrick Williams ], 206f79ce4c4SPatrick Williams build_type="meson", 207ee3c9eebSPatrick Williams config_flags=[ 2086c98f280SWilliam A. Kennington III "-Dlibonly=true", 2096c98f280SWilliam A. Kennington III "-Dtests=disabled", 2105eabdae9SPatrick Williams f"-Dyamldir={prefix}/share/phosphor-dbus-yaml/yaml", 211aae36d18SPatrick Williams ], 212ee3c9eebSPatrick Williams ), 213ee3c9eebSPatrick Williams "openbmc/phosphor-objmgr": PackageDef( 214ee3c9eebSPatrick Williams depends=[ 21511e5762cSBrad Bishop "CLIUtils/CLI11", 21670af95caSPatrick Williams "boost", 21783394610SPatrick Williams "leethomason/tinyxml2", 21870af95caSPatrick Williams "openbmc/phosphor-dbus-interfaces", 21983394610SPatrick Williams "openbmc/phosphor-logging", 22083394610SPatrick Williams "openbmc/sdbusplus", 221aae36d18SPatrick Williams ], 2221197e359SBrad Bishop build_type="meson", 2231197e359SBrad Bishop config_flags=[ 2241197e359SBrad Bishop "-Dtests=disabled", 2251197e359SBrad Bishop ], 226ee3c9eebSPatrick Williams ), 2271c19e453SManojkiran Eda "openbmc/libpldm": PackageDef( 228ee3c9eebSPatrick Williams build_type="meson", 229ee3c9eebSPatrick Williams config_flags=[ 230aae36d18SPatrick Williams "-Doem-ibm=enabled", 231aae36d18SPatrick Williams "-Dtests=disabled", 232aae36d18SPatrick Williams ], 233ee3c9eebSPatrick Williams ), 234ee3c9eebSPatrick Williams "openbmc/sdbusplus": PackageDef( 235ee3c9eebSPatrick Williams build_type="meson", 236ee3c9eebSPatrick Williams custom_post_dl=[ 237aae36d18SPatrick Williams "cd tools", 238aae36d18SPatrick Williams f"./setup.py install --root=/ --prefix={prefix}", 239aae36d18SPatrick Williams "cd ..", 240aae36d18SPatrick Williams ], 241ee3c9eebSPatrick Williams config_flags=[ 242aae36d18SPatrick Williams "-Dexamples=disabled", 243aae36d18SPatrick Williams "-Dtests=disabled", 244aae36d18SPatrick Williams ], 245b16f3e20SPatrick Williams ), 246ee3c9eebSPatrick Williams "openbmc/sdeventplus": PackageDef( 24770af95caSPatrick Williams depends=[ 24870af95caSPatrick Williams "Naios/function2", 24970af95caSPatrick Williams "openbmc/stdplus", 25070af95caSPatrick Williams ], 251ee3c9eebSPatrick Williams build_type="meson", 252ee3c9eebSPatrick Williams config_flags=[ 253ee3c9eebSPatrick Williams "-Dexamples=false", 254ee3c9eebSPatrick Williams "-Dtests=disabled", 255ee3c9eebSPatrick Williams ], 256ee3c9eebSPatrick Williams ), 257ee3c9eebSPatrick Williams "openbmc/stdplus": PackageDef( 25870af95caSPatrick Williams depends=[ 25970af95caSPatrick Williams "fmtlib/fmt", 260ca1bf0c0SWilliam A. Kennington III "google/googletest", 261ca1bf0c0SWilliam A. Kennington III "Naios/function2", 26270af95caSPatrick Williams ], 263ee3c9eebSPatrick Williams build_type="meson", 264ee3c9eebSPatrick Williams config_flags=[ 265ee3c9eebSPatrick Williams "-Dexamples=false", 266ee3c9eebSPatrick Williams "-Dtests=disabled", 267ca1bf0c0SWilliam A. Kennington III "-Dgtest=enabled", 268ee3c9eebSPatrick Williams ], 269ee3c9eebSPatrick Williams ), 270ee3c9eebSPatrick Williams} # type: Dict[str, PackageDef] 27102871c91SPatrick Williams 27202871c91SPatrick Williams# Define common flags used for builds 27302871c91SPatrick Williamsconfigure_flags = " ".join( 27402871c91SPatrick Williams [ 27502871c91SPatrick Williams f"--prefix={prefix}", 27602871c91SPatrick Williams ] 27702871c91SPatrick Williams) 27802871c91SPatrick Williamscmake_flags = " ".join( 27902871c91SPatrick Williams [ 28002871c91SPatrick Williams "-DBUILD_SHARED_LIBS=ON", 2810f2086b3SPatrick Williams "-DCMAKE_BUILD_TYPE=RelWithDebInfo", 28202871c91SPatrick Williams f"-DCMAKE_INSTALL_PREFIX:PATH={prefix}", 2830f2086b3SPatrick Williams "-GNinja", 2840f2086b3SPatrick Williams "-DCMAKE_MAKE_PROGRAM=ninja", 28502871c91SPatrick Williams ] 28602871c91SPatrick Williams) 28702871c91SPatrick Williamsmeson_flags = " ".join( 28802871c91SPatrick Williams [ 28902871c91SPatrick Williams "--wrap-mode=nodownload", 29002871c91SPatrick Williams f"-Dprefix={prefix}", 29102871c91SPatrick Williams ] 29202871c91SPatrick Williams) 29302871c91SPatrick Williams 294ee3c9eebSPatrick Williams 295ee3c9eebSPatrick Williamsclass Package(threading.Thread): 296ee3c9eebSPatrick Williams """Class used to build the Docker stages for each package. 297ee3c9eebSPatrick Williams 298ee3c9eebSPatrick Williams Generally, this class should not be instantiated directly but through 299ee3c9eebSPatrick Williams Package.generate_all(). 300ee3c9eebSPatrick Williams """ 301ee3c9eebSPatrick Williams 302ee3c9eebSPatrick Williams # Copy the packages dictionary. 303ee3c9eebSPatrick Williams packages = packages.copy() 304ee3c9eebSPatrick Williams 305ee3c9eebSPatrick Williams # Lock used for thread-safety. 306ee3c9eebSPatrick Williams lock = threading.Lock() 307ee3c9eebSPatrick Williams 308ee3c9eebSPatrick Williams def __init__(self, pkg: str): 309ee3c9eebSPatrick Williams """pkg - The name of this package (ex. foo/bar )""" 310ee3c9eebSPatrick Williams super(Package, self).__init__() 311ee3c9eebSPatrick Williams 312ee3c9eebSPatrick Williams self.package = pkg 313ee3c9eebSPatrick Williams self.exception = None # type: Optional[Exception] 314ee3c9eebSPatrick Williams 315ee3c9eebSPatrick Williams # Reference to this package's 316ee3c9eebSPatrick Williams self.pkg_def = Package.packages[pkg] 317ee3c9eebSPatrick Williams self.pkg_def["__package"] = self 318ee3c9eebSPatrick Williams 319ee3c9eebSPatrick Williams def run(self) -> None: 320ee3c9eebSPatrick Williams """Thread 'run' function. Builds the Docker stage.""" 321ee3c9eebSPatrick Williams 322ee3c9eebSPatrick Williams # In case this package has no rev, fetch it from Github. 323ee3c9eebSPatrick Williams self._update_rev() 324ee3c9eebSPatrick Williams 325ee3c9eebSPatrick Williams # Find all the Package objects that this package depends on. 326ee3c9eebSPatrick Williams # This section is locked because we are looking into another 327ee3c9eebSPatrick Williams # package's PackageDef dict, which could be being modified. 328ee3c9eebSPatrick Williams Package.lock.acquire() 329ee3c9eebSPatrick Williams deps: Iterable[Package] = [ 330ee3c9eebSPatrick Williams Package.packages[deppkg]["__package"] 331ee3c9eebSPatrick Williams for deppkg in self.pkg_def.get("depends", []) 332ee3c9eebSPatrick Williams ] 333ee3c9eebSPatrick Williams Package.lock.release() 334ee3c9eebSPatrick Williams 335ee3c9eebSPatrick Williams # Wait until all the depends finish building. We need them complete 336ee3c9eebSPatrick Williams # for the "COPY" commands. 337ee3c9eebSPatrick Williams for deppkg in deps: 338ee3c9eebSPatrick Williams deppkg.join() 339ee3c9eebSPatrick Williams 340ee3c9eebSPatrick Williams # Generate this package's Dockerfile. 341ee3c9eebSPatrick Williams dockerfile = f""" 342ee3c9eebSPatrick WilliamsFROM {docker_base_img_name} 343ee3c9eebSPatrick Williams{self._df_copycmds()} 344ee3c9eebSPatrick Williams{self._df_build()} 345ee3c9eebSPatrick Williams""" 346ee3c9eebSPatrick Williams 347ee3c9eebSPatrick Williams # Generate the resulting tag name and save it to the PackageDef. 348ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef, 349ee3c9eebSPatrick Williams # which can be accessed by other threads. 350ee3c9eebSPatrick Williams Package.lock.acquire() 351ee3c9eebSPatrick Williams tag = Docker.tagname(self._stagename(), dockerfile) 352ee3c9eebSPatrick Williams self.pkg_def["__tag"] = tag 353ee3c9eebSPatrick Williams Package.lock.release() 354ee3c9eebSPatrick Williams 355ee3c9eebSPatrick Williams # Do the build / save any exceptions. 356ee3c9eebSPatrick Williams try: 357ee3c9eebSPatrick Williams Docker.build(self.package, tag, dockerfile) 358ee3c9eebSPatrick Williams except Exception as e: 359ee3c9eebSPatrick Williams self.exception = e 360ee3c9eebSPatrick Williams 361ee3c9eebSPatrick Williams @classmethod 362ee3c9eebSPatrick Williams def generate_all(cls) -> None: 363ee3c9eebSPatrick Williams """Ensure a Docker stage is created for all defined packages. 364ee3c9eebSPatrick Williams 365ee3c9eebSPatrick Williams These are done in parallel but with appropriate blocking per 366ee3c9eebSPatrick Williams package 'depends' specifications. 367ee3c9eebSPatrick Williams """ 368ee3c9eebSPatrick Williams 369ee3c9eebSPatrick Williams # Create a Package for each defined package. 370ee3c9eebSPatrick Williams pkg_threads = [Package(p) for p in cls.packages.keys()] 371ee3c9eebSPatrick Williams 372ee3c9eebSPatrick Williams # Start building them all. 3736dbd7807SPatrick Williams # This section is locked because threads depend on each other, 3746dbd7807SPatrick Williams # based on the packages, and they cannot 'join' on a thread 3756dbd7807SPatrick Williams # which is not yet started. Adding a lock here allows all the 3766dbd7807SPatrick Williams # threads to start before they 'join' their dependencies. 3776dbd7807SPatrick Williams Package.lock.acquire() 378ee3c9eebSPatrick Williams for t in pkg_threads: 379ee3c9eebSPatrick Williams t.start() 3806dbd7807SPatrick Williams Package.lock.release() 381ee3c9eebSPatrick Williams 382ee3c9eebSPatrick Williams # Wait for completion. 383ee3c9eebSPatrick Williams for t in pkg_threads: 384ee3c9eebSPatrick Williams t.join() 385ee3c9eebSPatrick Williams # Check if the thread saved off its own exception. 386ee3c9eebSPatrick Williams if t.exception: 387ee3c9eebSPatrick Williams print(f"Package {t.package} failed!", file=sys.stderr) 388ee3c9eebSPatrick Williams raise t.exception 389ee3c9eebSPatrick Williams 390ee3c9eebSPatrick Williams @staticmethod 391ee3c9eebSPatrick Williams def df_all_copycmds() -> str: 392ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to copy all packages 393ee3c9eebSPatrick Williams into the final image. 394ee3c9eebSPatrick Williams """ 395ee3c9eebSPatrick Williams return Package.df_copycmds_set(Package.packages.keys()) 396ee3c9eebSPatrick Williams 397ee3c9eebSPatrick Williams @classmethod 398ee3c9eebSPatrick Williams def depcache(cls) -> str: 399ee3c9eebSPatrick Williams """Create the contents of the '/tmp/depcache'. 400ee3c9eebSPatrick Williams This file is a comma-separated list of "<pkg>:<rev>". 401ee3c9eebSPatrick Williams """ 402ee3c9eebSPatrick Williams 403ee3c9eebSPatrick Williams # This needs to be sorted for consistency. 404ee3c9eebSPatrick Williams depcache = "" 405ee3c9eebSPatrick Williams for pkg in sorted(cls.packages.keys()): 406ee3c9eebSPatrick Williams depcache += "%s:%s," % (pkg, cls.packages[pkg]["rev"]) 407ee3c9eebSPatrick Williams return depcache 408ee3c9eebSPatrick Williams 409ee3c9eebSPatrick Williams def _update_rev(self) -> None: 410ee3c9eebSPatrick Williams """Look up the HEAD for missing a static rev.""" 411ee3c9eebSPatrick Williams 412ee3c9eebSPatrick Williams if "rev" in self.pkg_def: 413ee3c9eebSPatrick Williams return 414ee3c9eebSPatrick Williams 41565b21fb9SPatrick Williams # Check if Jenkins/Gerrit gave us a revision and use it. 41665b21fb9SPatrick Williams if gerrit_project == self.package and gerrit_rev: 41765b21fb9SPatrick Williams print( 41865b21fb9SPatrick Williams f"Found Gerrit revision for {self.package}: {gerrit_rev}", 41965b21fb9SPatrick Williams file=sys.stderr, 42065b21fb9SPatrick Williams ) 42165b21fb9SPatrick Williams self.pkg_def["rev"] = gerrit_rev 42265b21fb9SPatrick Williams return 42365b21fb9SPatrick Williams 424ee3c9eebSPatrick Williams # Ask Github for all the branches. 42505fb2a0aSPatrick Williams lookup = git( 42605fb2a0aSPatrick Williams "ls-remote", "--heads", f"https://github.com/{self.package}" 42705fb2a0aSPatrick Williams ) 428ee3c9eebSPatrick Williams 429ee3c9eebSPatrick Williams # Find the branch matching {branch} (or fallback to master). 430ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef. 431ee3c9eebSPatrick Williams Package.lock.acquire() 432ee3c9eebSPatrick Williams for line in lookup.split("\n"): 433ee3c9eebSPatrick Williams if f"refs/heads/{branch}" in line: 434ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 435c7d73646SPatrick Williams elif ( 436c7d73646SPatrick Williams "refs/heads/master" in line or "refs/heads/main" in line 437c7d73646SPatrick Williams ) and "rev" not in self.pkg_def: 438ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 439ee3c9eebSPatrick Williams Package.lock.release() 440ee3c9eebSPatrick Williams 441ee3c9eebSPatrick Williams def _stagename(self) -> str: 442ee3c9eebSPatrick Williams """Create a name for the Docker stage associated with this pkg.""" 443ee3c9eebSPatrick Williams return self.package.replace("/", "-").lower() 444ee3c9eebSPatrick Williams 445ee3c9eebSPatrick Williams def _url(self) -> str: 446ee3c9eebSPatrick Williams """Get the URL for this package.""" 447ee3c9eebSPatrick Williams rev = self.pkg_def["rev"] 448ee3c9eebSPatrick Williams 449ee3c9eebSPatrick Williams # If the lambda exists, call it. 450ee3c9eebSPatrick Williams if "url" in self.pkg_def: 451ee3c9eebSPatrick Williams return self.pkg_def["url"](self.package, rev) 452ee3c9eebSPatrick Williams 453ee3c9eebSPatrick Williams # Default to the github archive URL. 454ee3c9eebSPatrick Williams return f"https://github.com/{self.package}/archive/{rev}.tar.gz" 455ee3c9eebSPatrick Williams 456ee3c9eebSPatrick Williams def _cmd_download(self) -> str: 457ee3c9eebSPatrick Williams """Formulate the command necessary to download and unpack to source.""" 458ee3c9eebSPatrick Williams 459ee3c9eebSPatrick Williams url = self._url() 460ee3c9eebSPatrick Williams if ".tar." not in url: 461ee3c9eebSPatrick Williams raise NotImplementedError( 462ee3c9eebSPatrick Williams f"Unhandled download type for {self.package}: {url}" 463ee3c9eebSPatrick Williams ) 464ee3c9eebSPatrick Williams 465ee3c9eebSPatrick Williams cmd = f"curl -L {url} | tar -x" 466ee3c9eebSPatrick Williams 467ee3c9eebSPatrick Williams if url.endswith(".bz2"): 468ee3c9eebSPatrick Williams cmd += "j" 469ee3c9eebSPatrick Williams elif url.endswith(".gz"): 470ee3c9eebSPatrick Williams cmd += "z" 471ee3c9eebSPatrick Williams else: 472ee3c9eebSPatrick Williams raise NotImplementedError( 473ee3c9eebSPatrick Williams f"Unknown tar flags needed for {self.package}: {url}" 474ee3c9eebSPatrick Williams ) 475ee3c9eebSPatrick Williams 476ee3c9eebSPatrick Williams return cmd 477ee3c9eebSPatrick Williams 478ee3c9eebSPatrick Williams def _cmd_cd_srcdir(self) -> str: 479ee3c9eebSPatrick Williams """Formulate the command necessary to 'cd' into the source dir.""" 480ee3c9eebSPatrick Williams return f"cd {self.package.split('/')[-1]}*" 481ee3c9eebSPatrick Williams 482ee3c9eebSPatrick Williams def _df_copycmds(self) -> str: 483ee3c9eebSPatrick Williams """Formulate the dockerfile snippet necessary to COPY all depends.""" 484ee3c9eebSPatrick Williams 485ee3c9eebSPatrick Williams if "depends" not in self.pkg_def: 486ee3c9eebSPatrick Williams return "" 487ee3c9eebSPatrick Williams return Package.df_copycmds_set(self.pkg_def["depends"]) 488ee3c9eebSPatrick Williams 489ee3c9eebSPatrick Williams @staticmethod 490ee3c9eebSPatrick Williams def df_copycmds_set(pkgs: Iterable[str]) -> str: 491ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to COPY a set of 492ee3c9eebSPatrick Williams packages into a Docker stage. 493ee3c9eebSPatrick Williams """ 494ee3c9eebSPatrick Williams 495ee3c9eebSPatrick Williams copy_cmds = "" 496ee3c9eebSPatrick Williams 497ee3c9eebSPatrick Williams # Sort the packages for consistency. 498ee3c9eebSPatrick Williams for p in sorted(pkgs): 499ee3c9eebSPatrick Williams tag = Package.packages[p]["__tag"] 500ee3c9eebSPatrick Williams copy_cmds += f"COPY --from={tag} {prefix} {prefix}\n" 501ee3c9eebSPatrick Williams # Workaround for upstream docker bug and multiple COPY cmds 502ee3c9eebSPatrick Williams # https://github.com/moby/moby/issues/37965 503ee3c9eebSPatrick Williams copy_cmds += "RUN true\n" 504ee3c9eebSPatrick Williams 505ee3c9eebSPatrick Williams return copy_cmds 506ee3c9eebSPatrick Williams 507ee3c9eebSPatrick Williams def _df_build(self) -> str: 508ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to download, build, and 509ee3c9eebSPatrick Williams install a package into a Docker stage. 510ee3c9eebSPatrick Williams """ 511ee3c9eebSPatrick Williams 512ee3c9eebSPatrick Williams # Download and extract source. 513ee3c9eebSPatrick Williams result = f"RUN {self._cmd_download()} && {self._cmd_cd_srcdir()} && " 514ee3c9eebSPatrick Williams 515ee3c9eebSPatrick Williams # Handle 'custom_post_dl' commands. 516ee3c9eebSPatrick Williams custom_post_dl = self.pkg_def.get("custom_post_dl") 517ee3c9eebSPatrick Williams if custom_post_dl: 518ee3c9eebSPatrick Williams result += " && ".join(custom_post_dl) + " && " 519ee3c9eebSPatrick Williams 520ee3c9eebSPatrick Williams # Build and install package based on 'build_type'. 521ee3c9eebSPatrick Williams build_type = self.pkg_def["build_type"] 522ee3c9eebSPatrick Williams if build_type == "autoconf": 523ee3c9eebSPatrick Williams result += self._cmd_build_autoconf() 524ee3c9eebSPatrick Williams elif build_type == "cmake": 525ee3c9eebSPatrick Williams result += self._cmd_build_cmake() 526ee3c9eebSPatrick Williams elif build_type == "custom": 527ee3c9eebSPatrick Williams result += self._cmd_build_custom() 528ee3c9eebSPatrick Williams elif build_type == "make": 529ee3c9eebSPatrick Williams result += self._cmd_build_make() 530ee3c9eebSPatrick Williams elif build_type == "meson": 531ee3c9eebSPatrick Williams result += self._cmd_build_meson() 532ee3c9eebSPatrick Williams else: 533ee3c9eebSPatrick Williams raise NotImplementedError( 534ee3c9eebSPatrick Williams f"Unhandled build type for {self.package}: {build_type}" 535ee3c9eebSPatrick Williams ) 536ee3c9eebSPatrick Williams 5376bce2ca1SPatrick Williams # Handle 'custom_post_install' commands. 5386bce2ca1SPatrick Williams custom_post_install = self.pkg_def.get("custom_post_install") 5396bce2ca1SPatrick Williams if custom_post_install: 5406bce2ca1SPatrick Williams result += " && " + " && ".join(custom_post_install) 5416bce2ca1SPatrick Williams 542ee3c9eebSPatrick Williams return result 543ee3c9eebSPatrick Williams 544ee3c9eebSPatrick Williams def _cmd_build_autoconf(self) -> str: 545ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 546ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 547ee3c9eebSPatrick Williams result = "./bootstrap.sh && " 548ee3c9eebSPatrick Williams result += f"{env} ./configure {configure_flags} {options} && " 549ee3c9eebSPatrick Williams result += f"make -j{proc_count} && make install" 550ee3c9eebSPatrick Williams return result 551ee3c9eebSPatrick Williams 552ee3c9eebSPatrick Williams def _cmd_build_cmake(self) -> str: 553ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 554ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 555ee3c9eebSPatrick Williams result = "mkdir builddir && cd builddir && " 556ee3c9eebSPatrick Williams result += f"{env} cmake {cmake_flags} {options} .. && " 557ee3c9eebSPatrick Williams result += "cmake --build . --target all && " 558ee3c9eebSPatrick Williams result += "cmake --build . --target install && " 559ee3c9eebSPatrick Williams result += "cd .." 560ee3c9eebSPatrick Williams return result 561ee3c9eebSPatrick Williams 562ee3c9eebSPatrick Williams def _cmd_build_custom(self) -> str: 563ee3c9eebSPatrick Williams return " && ".join(self.pkg_def.get("build_steps", [])) 564ee3c9eebSPatrick Williams 565ee3c9eebSPatrick Williams def _cmd_build_make(self) -> str: 566ee3c9eebSPatrick Williams return f"make -j{proc_count} && make install" 567ee3c9eebSPatrick Williams 568ee3c9eebSPatrick Williams def _cmd_build_meson(self) -> str: 569ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 570ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 571ee3c9eebSPatrick Williams result = f"{env} meson builddir {meson_flags} {options} && " 572ee3c9eebSPatrick Williams result += "ninja -C builddir && ninja -C builddir install" 573ee3c9eebSPatrick Williams return result 574ee3c9eebSPatrick Williams 575ee3c9eebSPatrick Williams 576ee3c9eebSPatrick Williamsclass Docker: 577ee3c9eebSPatrick Williams """Class to assist with Docker interactions. All methods are static.""" 578ee3c9eebSPatrick Williams 579ee3c9eebSPatrick Williams @staticmethod 580ee3c9eebSPatrick Williams def timestamp() -> str: 581ee3c9eebSPatrick Williams """Generate a timestamp for today using the ISO week.""" 582ee3c9eebSPatrick Williams today = date.today().isocalendar() 583ee3c9eebSPatrick Williams return f"{today[0]}-W{today[1]:02}" 584ee3c9eebSPatrick Williams 585ee3c9eebSPatrick Williams @staticmethod 58641d86218SPatrick Williams def tagname(pkgname: Optional[str], dockerfile: str) -> str: 587ee3c9eebSPatrick Williams """Generate a tag name for a package using a hash of the Dockerfile.""" 588ee3c9eebSPatrick Williams result = docker_image_name 589ee3c9eebSPatrick Williams if pkgname: 590ee3c9eebSPatrick Williams result += "-" + pkgname 591ee3c9eebSPatrick Williams 592ee3c9eebSPatrick Williams result += ":" + Docker.timestamp() 593ee3c9eebSPatrick Williams result += "-" + sha256(dockerfile.encode()).hexdigest()[0:16] 594ee3c9eebSPatrick Williams 595ee3c9eebSPatrick Williams return result 596ee3c9eebSPatrick Williams 597ee3c9eebSPatrick Williams @staticmethod 598ee3c9eebSPatrick Williams def build(pkg: str, tag: str, dockerfile: str) -> None: 599e08ffba8SPatrick Williams """Build a docker image using the Dockerfile and tagging it with 'tag'. 600e08ffba8SPatrick Williams """ 601ee3c9eebSPatrick Williams 602ee3c9eebSPatrick Williams # If we're not forcing builds, check if it already exists and skip. 603ee3c9eebSPatrick Williams if not force_build: 604ee3c9eebSPatrick Williams if docker.image.ls(tag, "--format", '"{{.Repository}}:{{.Tag}}"'): 60505fb2a0aSPatrick Williams print( 60605fb2a0aSPatrick Williams f"Image {tag} already exists. Skipping.", file=sys.stderr 60705fb2a0aSPatrick Williams ) 608ee3c9eebSPatrick Williams return 609ee3c9eebSPatrick Williams 610ee3c9eebSPatrick Williams # Build it. 611ee3c9eebSPatrick Williams # Capture the output of the 'docker build' command and send it to 612ee3c9eebSPatrick Williams # stderr (prefixed with the package name). This allows us to see 613ee3c9eebSPatrick Williams # progress but not polute stdout. Later on we output the final 614ee3c9eebSPatrick Williams # docker tag to stdout and we want to keep that pristine. 615ee3c9eebSPatrick Williams # 616ee3c9eebSPatrick Williams # Other unusual flags: 617ee3c9eebSPatrick Williams # --no-cache: Bypass the Docker cache if 'force_build'. 618ee3c9eebSPatrick Williams # --force-rm: Clean up Docker processes if they fail. 619ee3c9eebSPatrick Williams docker.build( 620ee3c9eebSPatrick Williams proxy_args, 621ee3c9eebSPatrick Williams "--network=host", 622ee3c9eebSPatrick Williams "--force-rm", 623ee3c9eebSPatrick Williams "--no-cache=true" if force_build else "--no-cache=false", 624ee3c9eebSPatrick Williams "-t", 625ee3c9eebSPatrick Williams tag, 626ee3c9eebSPatrick Williams "-", 627ee3c9eebSPatrick Williams _in=dockerfile, 628ee3c9eebSPatrick Williams _out=( 629ee3c9eebSPatrick Williams lambda line: print( 630ee3c9eebSPatrick Williams pkg + ":", line, end="", file=sys.stderr, flush=True 631ee3c9eebSPatrick Williams ) 632ee3c9eebSPatrick Williams ), 633ee3c9eebSPatrick Williams ) 634ee3c9eebSPatrick Williams 635ee3c9eebSPatrick Williams 636ee3c9eebSPatrick Williams# Read a bunch of environment variables. 63705fb2a0aSPatrick Williamsdocker_image_name = os.environ.get( 63805fb2a0aSPatrick Williams "DOCKER_IMAGE_NAME", "openbmc/ubuntu-unit-test" 63905fb2a0aSPatrick Williams) 640ee3c9eebSPatrick Williamsforce_build = os.environ.get("FORCE_DOCKER_BUILD") 641ee3c9eebSPatrick Williamsis_automated_ci_build = os.environ.get("BUILD_URL", False) 6425b08dc6bSPatrick Williamsdistro = os.environ.get("DISTRO", "ubuntu:kinetic") 643ee3c9eebSPatrick Williamsbranch = os.environ.get("BRANCH", "master") 644ee3c9eebSPatrick Williamsubuntu_mirror = os.environ.get("UBUNTU_MIRROR") 645ee3c9eebSPatrick Williamshttp_proxy = os.environ.get("http_proxy") 646ee3c9eebSPatrick Williams 64765b21fb9SPatrick Williamsgerrit_project = os.environ.get("GERRIT_PROJECT") 64865b21fb9SPatrick Williamsgerrit_rev = os.environ.get("GERRIT_PATCHSET_REVISION") 64965b21fb9SPatrick Williams 650ee3c9eebSPatrick Williams# Set up some common variables. 651ee3c9eebSPatrick Williamsusername = os.environ.get("USER", "root") 652ee3c9eebSPatrick Williamshomedir = os.environ.get("HOME", "/root") 653ee3c9eebSPatrick Williamsgid = os.getgid() 654ee3c9eebSPatrick Williamsuid = os.getuid() 655ee3c9eebSPatrick Williams 6566825a018SJosh Lehan# Use well-known constants if user is root 6576825a018SJosh Lehanif username == "root": 6586825a018SJosh Lehan homedir = "/root" 6596825a018SJosh Lehan gid = 0 6606825a018SJosh Lehan uid = 0 6616825a018SJosh Lehan 662ee3c9eebSPatrick Williams# Determine the architecture for Docker. 663ee3c9eebSPatrick Williamsarch = uname("-m").strip() 664ee3c9eebSPatrick Williamsif arch == "ppc64le": 665ee3c9eebSPatrick Williams docker_base = "ppc64le/" 666ee3c9eebSPatrick Williamselif arch == "x86_64": 667ee3c9eebSPatrick Williams docker_base = "" 668051b05b7SThang Q. Nguyenelif arch == "aarch64": 669f98f1a8dSThang Q. Nguyen docker_base = "arm64v8/" 670ee3c9eebSPatrick Williamselse: 671ee3c9eebSPatrick Williams print( 672ee3c9eebSPatrick Williams f"Unsupported system architecture({arch}) found for docker image", 673ee3c9eebSPatrick Williams file=sys.stderr, 674ee3c9eebSPatrick Williams ) 675ee3c9eebSPatrick Williams sys.exit(1) 676ee3c9eebSPatrick Williams 67702871c91SPatrick Williams# Special flags if setting up a deb mirror. 67802871c91SPatrick Williamsmirror = "" 67902871c91SPatrick Williamsif "ubuntu" in distro and ubuntu_mirror: 68002871c91SPatrick Williams mirror = f""" 681e08ffba8SPatrick WilliamsRUN echo "deb {ubuntu_mirror} \ 682e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME) \ 683e08ffba8SPatrick Williams main restricted universe multiverse" > /etc/apt/sources.list && \\ 684e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 685e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-updates \ 686e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 687e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 688e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-security \ 689e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 690e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 691e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-proposed \ 692e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 693e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 694e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-backports \ 695e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list 69602871c91SPatrick Williams""" 69702871c91SPatrick Williams 69802871c91SPatrick Williams# Special flags for proxying. 69902871c91SPatrick Williamsproxy_cmd = "" 70034ec77e8SAdrian Ambrożewiczproxy_keyserver = "" 70102871c91SPatrick Williamsproxy_args = [] 70202871c91SPatrick Williamsif http_proxy: 70302871c91SPatrick Williams proxy_cmd = f""" 70402871c91SPatrick WilliamsRUN echo "[http]" >> {homedir}/.gitconfig && \ 70502871c91SPatrick Williams echo "proxy = {http_proxy}" >> {homedir}/.gitconfig 70602871c91SPatrick Williams""" 70734ec77e8SAdrian Ambrożewicz proxy_keyserver = f"--keyserver-options http-proxy={http_proxy}" 70834ec77e8SAdrian Ambrożewicz 70902871c91SPatrick Williams proxy_args.extend( 71002871c91SPatrick Williams [ 71102871c91SPatrick Williams "--build-arg", 71202871c91SPatrick Williams f"http_proxy={http_proxy}", 71302871c91SPatrick Williams "--build-arg", 714d461cd6aSLei YU f"https_proxy={http_proxy}", 71502871c91SPatrick Williams ] 71602871c91SPatrick Williams ) 71702871c91SPatrick Williams 718ee3c9eebSPatrick Williams# Create base Dockerfile. 719a18d9c57SPatrick Williamsdockerfile_base = f""" 720a18d9c57SPatrick WilliamsFROM {docker_base}{distro} 72102871c91SPatrick Williams 72202871c91SPatrick Williams{mirror} 72302871c91SPatrick Williams 72402871c91SPatrick WilliamsENV DEBIAN_FRONTEND noninteractive 72502871c91SPatrick Williams 7268949d3c3SPatrick WilliamsENV PYTHONPATH "/usr/local/lib/python3.10/site-packages/" 72702871c91SPatrick Williams 728bb16ac14SPatrick Williams# Sometimes the ubuntu key expires and we need a way to force an execution 729bb16ac14SPatrick Williams# of the apt-get commands for the dbgsym-keyring. When this happens we see 730bb16ac14SPatrick Williams# an error like: "Release: The following signatures were invalid:" 731bb16ac14SPatrick Williams# Insert a bogus echo that we can change here when we get this error to force 732bb16ac14SPatrick Williams# the update. 733bb16ac14SPatrick WilliamsRUN echo "ubuntu keyserver rev as of 2021-04-21" 734bb16ac14SPatrick Williams 73502871c91SPatrick Williams# We need the keys to be imported for dbgsym repos 73602871c91SPatrick Williams# New releases have a package, older ones fall back to manual fetching 73702871c91SPatrick Williams# https://wiki.ubuntu.com/Debug%20Symbol%20Packages 73850837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && \ 739f79ce4c4SPatrick Williams ( apt-get install gpgv ubuntu-dbgsym-keyring || \ 74050837436SPatrick Williams ( apt-get install -yy dirmngr && \ 74150837436SPatrick Williams apt-key adv --keyserver keyserver.ubuntu.com \ 74234ec77e8SAdrian Ambrożewicz {proxy_keyserver} \ 74350837436SPatrick Williams --recv-keys F2EDC64DC5AEE1F6B9C621F0C8CAB6595FDFF622 ) ) 74402871c91SPatrick Williams 74502871c91SPatrick Williams# Parse the current repo list into a debug repo list 746e08ffba8SPatrick WilliamsRUN sed -n '/^deb /s,^deb [^ ]* ,deb http://ddebs.ubuntu.com ,p' \ 747e08ffba8SPatrick Williams /etc/apt/sources.list >/etc/apt/sources.list.d/debug.list 74802871c91SPatrick Williams 74902871c91SPatrick Williams# Remove non-existent debug repos 75041d86218SPatrick WilliamsRUN sed -i '/-\\(backports\\|security\\) /d' /etc/apt/sources.list.d/debug.list 75102871c91SPatrick Williams 75202871c91SPatrick WilliamsRUN cat /etc/apt/sources.list.d/debug.list 75302871c91SPatrick Williams 75402871c91SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && apt-get install -yy \ 755274e3a9eSPatrick Williams gcc-12 \ 756274e3a9eSPatrick Williams g++-12 \ 75702871c91SPatrick Williams libc6-dbg \ 75802871c91SPatrick Williams libc6-dev \ 75902871c91SPatrick Williams libtool \ 76002871c91SPatrick Williams bison \ 76102871c91SPatrick Williams libdbus-1-dev \ 76202871c91SPatrick Williams flex \ 76302871c91SPatrick Williams cmake \ 76402871c91SPatrick Williams python3 \ 76502871c91SPatrick Williams python3-dev\ 76602871c91SPatrick Williams python3-yaml \ 76702871c91SPatrick Williams python3-mako \ 76802871c91SPatrick Williams python3-pip \ 76902871c91SPatrick Williams python3-setuptools \ 77002871c91SPatrick Williams python3-git \ 77102871c91SPatrick Williams python3-socks \ 77202871c91SPatrick Williams pkg-config \ 77302871c91SPatrick Williams autoconf \ 77402871c91SPatrick Williams autoconf-archive \ 77502871c91SPatrick Williams libsystemd-dev \ 77602871c91SPatrick Williams systemd \ 77702871c91SPatrick Williams libssl-dev \ 77802871c91SPatrick Williams libevdev-dev \ 77902871c91SPatrick Williams libjpeg-dev \ 78002871c91SPatrick Williams libpng-dev \ 78102871c91SPatrick Williams ninja-build \ 78202871c91SPatrick Williams sudo \ 78302871c91SPatrick Williams curl \ 78402871c91SPatrick Williams git \ 78502871c91SPatrick Williams dbus \ 78602871c91SPatrick Williams iputils-ping \ 78727a646b6SPatrick Williams clang-15 \ 78827a646b6SPatrick Williams clang-format-15 \ 78927a646b6SPatrick Williams clang-tidy-15 \ 79027a646b6SPatrick Williams clang-tools-15 \ 79102871c91SPatrick Williams shellcheck \ 79202871c91SPatrick Williams npm \ 79302871c91SPatrick Williams iproute2 \ 79402871c91SPatrick Williams libnl-3-dev \ 79502871c91SPatrick Williams libnl-genl-3-dev \ 79602871c91SPatrick Williams libconfig++-dev \ 79702871c91SPatrick Williams libsnmp-dev \ 79802871c91SPatrick Williams valgrind \ 79902871c91SPatrick Williams valgrind-dbg \ 80002871c91SPatrick Williams libpam0g-dev \ 80102871c91SPatrick Williams xxd \ 80202871c91SPatrick Williams libi2c-dev \ 80302871c91SPatrick Williams wget \ 80402871c91SPatrick Williams libldap2-dev \ 80502871c91SPatrick Williams libprotobuf-dev \ 806dafe7529SWilliam A. Kennington III liburing-dev \ 8078949d3c3SPatrick Williams liburing2-dbgsym \ 80802871c91SPatrick Williams libperlio-gzip-perl \ 80902871c91SPatrick Williams libjson-perl \ 81002871c91SPatrick Williams protobuf-compiler \ 81102871c91SPatrick Williams libgpiod-dev \ 81202871c91SPatrick Williams device-tree-compiler \ 81302871c91SPatrick Williams libpciaccess-dev \ 81402871c91SPatrick Williams libmimetic-dev \ 81502871c91SPatrick Williams libxml2-utils \ 8160eedeedaSPatrick Williams libxml-simple-perl \ 8179adf68d6SJohn Wedig rsync \ 8189adf68d6SJohn Wedig libcryptsetup-dev 81902871c91SPatrick Williams 8205b08dc6bSPatrick Williams# Kinetic comes with GCC-12, so skip this. 8215b08dc6bSPatrick Williams#RUN update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 12 \ 8225b08dc6bSPatrick Williams# --slave /usr/bin/g++ g++ /usr/bin/g++-12 \ 8235b08dc6bSPatrick Williams# --slave /usr/bin/gcov gcov /usr/bin/gcov-12 \ 8245b08dc6bSPatrick Williams# --slave /usr/bin/gcov-dump gcov-dump /usr/bin/gcov-dump-12 \ 8255b08dc6bSPatrick Williams# --slave /usr/bin/gcov-tool gcov-tool /usr/bin/gcov-tool-12 8265b08dc6bSPatrick Williams#RUN update-alternatives --install /usr/bin/cpp cpp /usr/bin/cpp-12 12 82702871c91SPatrick Williams 82827a646b6SPatrick WilliamsRUN update-alternatives --install /usr/bin/clang clang /usr/bin/clang-15 1000 \ 82927a646b6SPatrick Williams --slave /usr/bin/clang++ clang++ /usr/bin/clang++-15 \ 83027a646b6SPatrick Williams --slave /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-15 \ 83127a646b6SPatrick Williams --slave /usr/bin/clang-format clang-format /usr/bin/clang-format-15 \ 832e08ffba8SPatrick Williams --slave /usr/bin/run-clang-tidy run-clang-tidy.py \ 833e08ffba8SPatrick Williams /usr/bin/run-clang-tidy-15 \ 83427a646b6SPatrick Williams --slave /usr/bin/scan-build scan-build /usr/bin/scan-build-15 83502871c91SPatrick Williams 83650837436SPatrick Williams""" 83750837436SPatrick Williams 83850837436SPatrick Williamsif is_automated_ci_build: 83950837436SPatrick Williams dockerfile_base += f""" 84050837436SPatrick Williams# Run an arbitrary command to polute the docker cache regularly force us 84150837436SPatrick Williams# to re-run `apt-get update` daily. 842ee3c9eebSPatrick WilliamsRUN echo {Docker.timestamp()} 84350837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy 84450837436SPatrick Williams 84550837436SPatrick Williams""" 84650837436SPatrick Williams 84741d86218SPatrick Williamsdockerfile_base += """ 848bc0d5a3aSPatrick WilliamsRUN pip3 install codespell 849c5ad7ff4SPatrick WilliamsRUN pip3 install flake8 850bc0d5a3aSPatrick WilliamsRUN pip3 install gitlint 85102871c91SPatrick WilliamsRUN pip3 install inflection 85202871c91SPatrick WilliamsRUN pip3 install jsonschema 853fb612a51SMichael ShenRUN pip3 install meson==0.63.0 85402871c91SPatrick WilliamsRUN pip3 install protobuf 855ca8c4a8bSEd TanousRUN pip3 install requests 856*b08ddf77SPatrick Williams 857*b08ddf77SPatrick WilliamsRUN npm install -g \ 858*b08ddf77SPatrick Williams eslint@latest eslint-plugin-json@latest \ 859*b08ddf77SPatrick Williams prettier@latest 860fb9948a3SEd Tanous""" 861fb9948a3SEd Tanous 862ee3c9eebSPatrick Williams# Build the base and stage docker images. 863ee3c9eebSPatrick Williamsdocker_base_img_name = Docker.tagname("base", dockerfile_base) 864ee3c9eebSPatrick WilliamsDocker.build("base", docker_base_img_name, dockerfile_base) 865ee3c9eebSPatrick WilliamsPackage.generate_all() 86602871c91SPatrick Williams 867ee3c9eebSPatrick Williams# Create the final Dockerfile. 868a18d9c57SPatrick Williamsdockerfile = f""" 86902871c91SPatrick Williams# Build the final output image 870a18d9c57SPatrick WilliamsFROM {docker_base_img_name} 871ee3c9eebSPatrick Williams{Package.df_all_copycmds()} 87202871c91SPatrick Williams 87302871c91SPatrick Williams# Some of our infrastructure still relies on the presence of this file 87402871c91SPatrick Williams# even though it is no longer needed to rebuild the docker environment 87502871c91SPatrick Williams# NOTE: The file is sorted to ensure the ordering is stable. 876ee3c9eebSPatrick WilliamsRUN echo '{Package.depcache()}' > /tmp/depcache 87702871c91SPatrick Williams 87802871c91SPatrick Williams# Final configuration for the workspace 8796825a018SJosh LehanRUN grep -q {gid} /etc/group || groupadd -f -g {gid} {username} 88002871c91SPatrick WilliamsRUN mkdir -p "{os.path.dirname(homedir)}" 881e08ffba8SPatrick WilliamsRUN grep -q {uid} /etc/passwd || \ 882e08ffba8SPatrick Williams useradd -d {homedir} -m -u {uid} -g {gid} {username} 88302871c91SPatrick WilliamsRUN sed -i '1iDefaults umask=000' /etc/sudoers 88402871c91SPatrick WilliamsRUN echo "{username} ALL=(ALL) NOPASSWD: ALL" >>/etc/sudoers 88502871c91SPatrick Williams 886305a9a5dSAndrew Geissler# Ensure user has ability to write to /usr/local for different tool 887305a9a5dSAndrew Geissler# and data installs 8887bb00b13SAndrew GeisslerRUN chown -R {username}:{username} /usr/local/share 889305a9a5dSAndrew Geissler 89002871c91SPatrick Williams{proxy_cmd} 89102871c91SPatrick Williams 89202871c91SPatrick WilliamsRUN /bin/bash 89302871c91SPatrick Williams""" 89402871c91SPatrick Williams 895a18d9c57SPatrick Williams# Do the final docker build 896ee3c9eebSPatrick Williamsdocker_final_img_name = Docker.tagname(None, dockerfile) 897ee3c9eebSPatrick WilliamsDocker.build("final", docker_final_img_name, dockerfile) 898ee3c9eebSPatrick Williams 89900536fbeSPatrick Williams# Print the tag of the final image. 90000536fbeSPatrick Williamsprint(docker_final_img_name) 901