102871c91SPatrick Williams#!/usr/bin/env python3 202871c91SPatrick Williams# 302871c91SPatrick Williams# Build the required docker image to run package unit tests 402871c91SPatrick Williams# 502871c91SPatrick Williams# Script Variables: 602871c91SPatrick Williams# DOCKER_IMG_NAME: <optional, the name of the docker image to generate> 702871c91SPatrick Williams# default is openbmc/ubuntu-unit-test 802871c91SPatrick Williams# DISTRO: <optional, the distro to build a docker image against> 950837436SPatrick Williams# FORCE_DOCKER_BUILD: <optional, a non-zero value with force all Docker 1050837436SPatrick Williams# images to be rebuilt rather than reusing caches.> 1150837436SPatrick Williams# BUILD_URL: <optional, used to detect running under CI context 1250837436SPatrick Williams# (ex. Jenkins)> 1302871c91SPatrick Williams# BRANCH: <optional, branch to build from each of the openbmc/ 1402871c91SPatrick Williams# repositories> 1502871c91SPatrick Williams# default is master, which will be used if input branch not 1602871c91SPatrick Williams# provided or not found 1702871c91SPatrick Williams# UBUNTU_MIRROR: <optional, the URL of a mirror of Ubuntu to override the 1802871c91SPatrick Williams# default ones in /etc/apt/sources.list> 1902871c91SPatrick Williams# default is empty, and no mirror is used. 2002871c91SPatrick Williams# http_proxy The HTTP address of the proxy server to connect to. 2102871c91SPatrick Williams# Default: "", proxy is not setup if this is not set 2202871c91SPatrick Williams 2302871c91SPatrick Williamsimport os 2402871c91SPatrick Williamsimport sys 25b16f3e20SPatrick Williamsimport threading 26a18d9c57SPatrick Williamsfrom datetime import date 27a18d9c57SPatrick Williamsfrom hashlib import sha256 28e08ffba8SPatrick Williams 29e08ffba8SPatrick Williams# typing.Dict is used for type-hints. 30e08ffba8SPatrick Williamsfrom typing import Any, Callable, Dict, Iterable, Optional # noqa: F401 3102871c91SPatrick Williams 3241d86218SPatrick Williamsfrom sh import docker, git, nproc, uname # type: ignore 3341d86218SPatrick Williams 34ee3c9eebSPatrick Williamstry: 35ee3c9eebSPatrick Williams # Python before 3.8 doesn't have TypedDict, so reroute to standard 'dict'. 36ee3c9eebSPatrick Williams from typing import TypedDict 3741d86218SPatrick Williamsexcept Exception: 38ee3c9eebSPatrick Williams 39ee3c9eebSPatrick Williams class TypedDict(dict): # type: ignore 40ee3c9eebSPatrick Williams # We need to do this to eat the 'total' argument. 4141d86218SPatrick Williams def __init_subclass__(cls, **kwargs: Any) -> None: 42ee3c9eebSPatrick Williams super().__init_subclass__() 43ee3c9eebSPatrick Williams 44ee3c9eebSPatrick Williams 45ee3c9eebSPatrick Williams# Declare some variables used in package definitions. 46aae36d18SPatrick Williamsprefix = "/usr/local" 4702871c91SPatrick Williamsproc_count = nproc().strip() 4802871c91SPatrick Williams 49ee3c9eebSPatrick Williams 50ee3c9eebSPatrick Williamsclass PackageDef(TypedDict, total=False): 51ee3c9eebSPatrick Williams """Package Definition for packages dictionary.""" 52ee3c9eebSPatrick Williams 53ee3c9eebSPatrick Williams # rev [optional]: Revision of package to use. 54ee3c9eebSPatrick Williams rev: str 55ee3c9eebSPatrick Williams # url [optional]: lambda function to create URL: (package, rev) -> url. 56ee3c9eebSPatrick Williams url: Callable[[str, str], str] 57ee3c9eebSPatrick Williams # depends [optional]: List of package dependencies. 58ee3c9eebSPatrick Williams depends: Iterable[str] 59ee3c9eebSPatrick Williams # build_type [required]: Build type used for package. 60ee3c9eebSPatrick Williams # Currently supported: autoconf, cmake, custom, make, meson 61ee3c9eebSPatrick Williams build_type: str 62ee3c9eebSPatrick Williams # build_steps [optional]: Steps to run for 'custom' build_type. 63ee3c9eebSPatrick Williams build_steps: Iterable[str] 64ee3c9eebSPatrick Williams # config_flags [optional]: List of options to pass configuration tool. 65ee3c9eebSPatrick Williams config_flags: Iterable[str] 66ee3c9eebSPatrick Williams # config_env [optional]: List of environment variables to set for config. 67ee3c9eebSPatrick Williams config_env: Iterable[str] 68ee3c9eebSPatrick Williams # custom_post_dl [optional]: List of steps to run after download, but 69ee3c9eebSPatrick Williams # before config / build / install. 70ee3c9eebSPatrick Williams custom_post_dl: Iterable[str] 716bce2ca1SPatrick Williams # custom_post_install [optional]: List of steps to run after install. 726bce2ca1SPatrick Williams custom_post_install: Iterable[str] 73ee3c9eebSPatrick Williams 74ee3c9eebSPatrick Williams # __tag [private]: Generated Docker tag name for package stage. 75ee3c9eebSPatrick Williams __tag: str 76ee3c9eebSPatrick Williams # __package [private]: Package object associated with this package. 77ee3c9eebSPatrick Williams __package: Any # Type is Package, but not defined yet. 78ee3c9eebSPatrick Williams 7902871c91SPatrick Williams 807204324cSPatrick Williams# Packages to include in image. 817204324cSPatrick Williamspackages = { 82ee3c9eebSPatrick Williams "boost": PackageDef( 8378173cd4SEd Tanous rev="1.82.0", 84ee3c9eebSPatrick Williams url=( 8545bfd1ffSEd Tanous lambda pkg, rev: f"https://boostorg.jfrog.io/artifactory/main/release/{rev}/source/{pkg}_{rev.replace('.', '_')}.tar.gz" # noqa: E501 862abc4a48SPatrick Williams ), 87ee3c9eebSPatrick Williams build_type="custom", 88ee3c9eebSPatrick Williams build_steps=[ 89e08ffba8SPatrick Williams ( 90782f41f4SBrad Bishop "curl --remote-name" 91876ea1efSPatrick Williams " https://github.com/williamspatrick/beast/commit/98f8b1fbd059a35754c2c7b2841769cf8d021272.patch" 92876ea1efSPatrick Williams " && patch -p2 <" 93876ea1efSPatrick Williams " 98f8b1fbd059a35754c2c7b2841769cf8d021272.patch &&" 94e08ffba8SPatrick Williams " ./bootstrap.sh" 95e08ffba8SPatrick Williams f" --prefix={prefix} --with-libraries=context,coroutine" 96e08ffba8SPatrick Williams ), 97aae36d18SPatrick Williams "./b2", 98aae36d18SPatrick Williams f"./b2 install --prefix={prefix}", 99aae36d18SPatrick Williams ], 100ee3c9eebSPatrick Williams ), 101ee3c9eebSPatrick Williams "USCiLab/cereal": PackageDef( 102c1977839SPatrick Williams rev="v1.3.2", 103ee3c9eebSPatrick Williams build_type="custom", 104ee3c9eebSPatrick Williams build_steps=[f"cp -a include/cereal/ {prefix}/include/"], 105ee3c9eebSPatrick Williams ), 106c7198558SEd Tanous "danmar/cppcheck": PackageDef( 107be4bd084SPatrick Williams rev="2.9", 108c7198558SEd Tanous build_type="cmake", 109c7198558SEd Tanous ), 110ee3c9eebSPatrick Williams "CLIUtils/CLI11": PackageDef( 111ee3c9eebSPatrick Williams rev="v1.9.1", 112ee3c9eebSPatrick Williams build_type="cmake", 113ee3c9eebSPatrick Williams config_flags=[ 114aae36d18SPatrick Williams "-DBUILD_TESTING=OFF", 115aae36d18SPatrick Williams "-DCLI11_BUILD_DOCS=OFF", 116aae36d18SPatrick Williams "-DCLI11_BUILD_EXAMPLES=OFF", 117aae36d18SPatrick Williams ], 118ee3c9eebSPatrick Williams ), 119ee3c9eebSPatrick Williams "fmtlib/fmt": PackageDef( 120652d8aeaSWilliam A. Kennington III rev="9.1.0", 121ee3c9eebSPatrick Williams build_type="cmake", 122ee3c9eebSPatrick Williams config_flags=[ 123aae36d18SPatrick Williams "-DFMT_DOC=OFF", 124aae36d18SPatrick Williams "-DFMT_TEST=OFF", 125aae36d18SPatrick Williams ], 126ee3c9eebSPatrick Williams ), 127ee3c9eebSPatrick Williams "Naios/function2": PackageDef( 128c1977839SPatrick Williams rev="4.2.1", 129ee3c9eebSPatrick Williams build_type="custom", 130ee3c9eebSPatrick Williams build_steps=[ 131aae36d18SPatrick Williams f"mkdir {prefix}/include/function2", 132aae36d18SPatrick Williams f"cp include/function2/function2.hpp {prefix}/include/function2/", 133aae36d18SPatrick Williams ], 134ee3c9eebSPatrick Williams ), 135ed9414e8SPatrick Williams # release-1.12.1 136ee3c9eebSPatrick Williams "google/googletest": PackageDef( 137ed9414e8SPatrick Williams rev="58d77fa8070e8cec2dc1ed015d66b454c8d78850", 138ee3c9eebSPatrick Williams build_type="cmake", 1394dd32c02SWilliam A. Kennington III config_env=["CXXFLAGS=-std=c++20"], 140ee3c9eebSPatrick Williams config_flags=["-DTHREADS_PREFER_PTHREAD_FLAG=ON"], 141ee3c9eebSPatrick Williams ), 142ee3c9eebSPatrick Williams "nlohmann/json": PackageDef( 143c1977839SPatrick Williams rev="v3.11.2", 1446bce2ca1SPatrick Williams build_type="cmake", 1456bce2ca1SPatrick Williams config_flags=["-DJSON_BuildTests=OFF"], 1466bce2ca1SPatrick Williams custom_post_install=[ 147e08ffba8SPatrick Williams ( 148e08ffba8SPatrick Williams f"ln -s {prefix}/include/nlohmann/json.hpp" 149e08ffba8SPatrick Williams f" {prefix}/include/json.hpp" 150e08ffba8SPatrick Williams ), 151aae36d18SPatrick Williams ], 152ee3c9eebSPatrick Williams ), 153058e3a34SPrzemyslaw Czarnowski "json-c/json-c": PackageDef( 154058e3a34SPrzemyslaw Czarnowski rev="json-c-0.16-20220414", 155058e3a34SPrzemyslaw Czarnowski build_type="cmake", 156058e3a34SPrzemyslaw Czarnowski ), 15702871c91SPatrick Williams # Snapshot from 2019-05-24 158ee3c9eebSPatrick Williams "linux-test-project/lcov": PackageDef( 159ee3c9eebSPatrick Williams rev="v1.15", 160ee3c9eebSPatrick Williams build_type="make", 161ee3c9eebSPatrick Williams ), 162ee3c9eebSPatrick Williams "LibVNC/libvncserver": PackageDef( 163ee3c9eebSPatrick Williams rev="LibVNCServer-0.9.13", 164ee3c9eebSPatrick Williams build_type="cmake", 165ee3c9eebSPatrick Williams ), 166ee3c9eebSPatrick Williams "leethomason/tinyxml2": PackageDef( 167c1977839SPatrick Williams rev="9.0.0", 168ee3c9eebSPatrick Williams build_type="cmake", 169ee3c9eebSPatrick Williams ), 170ee3c9eebSPatrick Williams "tristanpenman/valijson": PackageDef( 171c1977839SPatrick Williams rev="v0.7", 172ee3c9eebSPatrick Williams build_type="cmake", 173ee3c9eebSPatrick Williams config_flags=[ 1740eedeedaSPatrick Williams "-Dvalijson_BUILD_TESTS=0", 1750eedeedaSPatrick Williams "-Dvalijson_INSTALL_HEADERS=1", 176aae36d18SPatrick Williams ], 177ee3c9eebSPatrick Williams ), 178ee3c9eebSPatrick Williams "open-power/pdbg": PackageDef(build_type="autoconf"), 179ee3c9eebSPatrick Williams "openbmc/gpioplus": PackageDef( 180ee3c9eebSPatrick Williams depends=["openbmc/stdplus"], 181ee3c9eebSPatrick Williams build_type="meson", 182ee3c9eebSPatrick Williams config_flags=[ 183aae36d18SPatrick Williams "-Dexamples=false", 184aae36d18SPatrick Williams "-Dtests=disabled", 185aae36d18SPatrick Williams ], 186ee3c9eebSPatrick Williams ), 187ee3c9eebSPatrick Williams "openbmc/phosphor-dbus-interfaces": PackageDef( 188ee3c9eebSPatrick Williams depends=["openbmc/sdbusplus"], 189ee3c9eebSPatrick Williams build_type="meson", 1904fe87776SWilliam A. Kennington III config_flags=["-Dgenerate_md=false"], 191ee3c9eebSPatrick Williams ), 192ee3c9eebSPatrick Williams "openbmc/phosphor-logging": PackageDef( 193ee3c9eebSPatrick Williams depends=[ 19483394610SPatrick Williams "USCiLab/cereal", 19583394610SPatrick Williams "openbmc/phosphor-dbus-interfaces", 19683394610SPatrick Williams "openbmc/sdbusplus", 19783394610SPatrick Williams "openbmc/sdeventplus", 198aae36d18SPatrick Williams ], 199f79ce4c4SPatrick Williams build_type="meson", 200ee3c9eebSPatrick Williams config_flags=[ 2016c98f280SWilliam A. Kennington III "-Dlibonly=true", 2026c98f280SWilliam A. Kennington III "-Dtests=disabled", 2035eabdae9SPatrick Williams f"-Dyamldir={prefix}/share/phosphor-dbus-yaml/yaml", 204aae36d18SPatrick Williams ], 205ee3c9eebSPatrick Williams ), 206ee3c9eebSPatrick Williams "openbmc/phosphor-objmgr": PackageDef( 207ee3c9eebSPatrick Williams depends=[ 20811e5762cSBrad Bishop "CLIUtils/CLI11", 20970af95caSPatrick Williams "boost", 21083394610SPatrick Williams "leethomason/tinyxml2", 21170af95caSPatrick Williams "openbmc/phosphor-dbus-interfaces", 21283394610SPatrick Williams "openbmc/phosphor-logging", 21383394610SPatrick Williams "openbmc/sdbusplus", 214aae36d18SPatrick Williams ], 2151197e359SBrad Bishop build_type="meson", 2161197e359SBrad Bishop config_flags=[ 2171197e359SBrad Bishop "-Dtests=disabled", 2181197e359SBrad Bishop ], 219ee3c9eebSPatrick Williams ), 2201c19e453SManojkiran Eda "openbmc/libpldm": PackageDef( 221ee3c9eebSPatrick Williams build_type="meson", 222ee3c9eebSPatrick Williams config_flags=[ 223aae36d18SPatrick Williams "-Doem-ibm=enabled", 224aae36d18SPatrick Williams "-Dtests=disabled", 225aae36d18SPatrick Williams ], 226ee3c9eebSPatrick Williams ), 227ee3c9eebSPatrick Williams "openbmc/sdbusplus": PackageDef( 228ee3c9eebSPatrick Williams build_type="meson", 229ee3c9eebSPatrick Williams custom_post_dl=[ 230aae36d18SPatrick Williams "cd tools", 231aae36d18SPatrick Williams f"./setup.py install --root=/ --prefix={prefix}", 232aae36d18SPatrick Williams "cd ..", 233aae36d18SPatrick Williams ], 234ee3c9eebSPatrick Williams config_flags=[ 235aae36d18SPatrick Williams "-Dexamples=disabled", 236aae36d18SPatrick Williams "-Dtests=disabled", 237aae36d18SPatrick Williams ], 238b16f3e20SPatrick Williams ), 239ee3c9eebSPatrick Williams "openbmc/sdeventplus": PackageDef( 24070af95caSPatrick Williams depends=[ 24170af95caSPatrick Williams "Naios/function2", 24270af95caSPatrick Williams "openbmc/stdplus", 24370af95caSPatrick Williams ], 244ee3c9eebSPatrick Williams build_type="meson", 245ee3c9eebSPatrick Williams config_flags=[ 246ee3c9eebSPatrick Williams "-Dexamples=false", 247ee3c9eebSPatrick Williams "-Dtests=disabled", 248ee3c9eebSPatrick Williams ], 249ee3c9eebSPatrick Williams ), 250ee3c9eebSPatrick Williams "openbmc/stdplus": PackageDef( 25170af95caSPatrick Williams depends=[ 25270af95caSPatrick Williams "fmtlib/fmt", 253ca1bf0c0SWilliam A. Kennington III "google/googletest", 254ca1bf0c0SWilliam A. Kennington III "Naios/function2", 25570af95caSPatrick Williams ], 256ee3c9eebSPatrick Williams build_type="meson", 257ee3c9eebSPatrick Williams config_flags=[ 258ee3c9eebSPatrick Williams "-Dexamples=false", 259ee3c9eebSPatrick Williams "-Dtests=disabled", 260ca1bf0c0SWilliam A. Kennington III "-Dgtest=enabled", 261ee3c9eebSPatrick Williams ], 262ee3c9eebSPatrick Williams ), 263ee3c9eebSPatrick Williams} # type: Dict[str, PackageDef] 26402871c91SPatrick Williams 26502871c91SPatrick Williams# Define common flags used for builds 26602871c91SPatrick Williamsconfigure_flags = " ".join( 26702871c91SPatrick Williams [ 26802871c91SPatrick Williams f"--prefix={prefix}", 26902871c91SPatrick Williams ] 27002871c91SPatrick Williams) 27102871c91SPatrick Williamscmake_flags = " ".join( 27202871c91SPatrick Williams [ 27302871c91SPatrick Williams "-DBUILD_SHARED_LIBS=ON", 2740f2086b3SPatrick Williams "-DCMAKE_BUILD_TYPE=RelWithDebInfo", 27502871c91SPatrick Williams f"-DCMAKE_INSTALL_PREFIX:PATH={prefix}", 2760f2086b3SPatrick Williams "-GNinja", 2770f2086b3SPatrick Williams "-DCMAKE_MAKE_PROGRAM=ninja", 27802871c91SPatrick Williams ] 27902871c91SPatrick Williams) 28002871c91SPatrick Williamsmeson_flags = " ".join( 28102871c91SPatrick Williams [ 28202871c91SPatrick Williams "--wrap-mode=nodownload", 28302871c91SPatrick Williams f"-Dprefix={prefix}", 28402871c91SPatrick Williams ] 28502871c91SPatrick Williams) 28602871c91SPatrick Williams 287ee3c9eebSPatrick Williams 288ee3c9eebSPatrick Williamsclass Package(threading.Thread): 289ee3c9eebSPatrick Williams """Class used to build the Docker stages for each package. 290ee3c9eebSPatrick Williams 291ee3c9eebSPatrick Williams Generally, this class should not be instantiated directly but through 292ee3c9eebSPatrick Williams Package.generate_all(). 293ee3c9eebSPatrick Williams """ 294ee3c9eebSPatrick Williams 295ee3c9eebSPatrick Williams # Copy the packages dictionary. 296ee3c9eebSPatrick Williams packages = packages.copy() 297ee3c9eebSPatrick Williams 298ee3c9eebSPatrick Williams # Lock used for thread-safety. 299ee3c9eebSPatrick Williams lock = threading.Lock() 300ee3c9eebSPatrick Williams 301ee3c9eebSPatrick Williams def __init__(self, pkg: str): 302ee3c9eebSPatrick Williams """pkg - The name of this package (ex. foo/bar )""" 303ee3c9eebSPatrick Williams super(Package, self).__init__() 304ee3c9eebSPatrick Williams 305ee3c9eebSPatrick Williams self.package = pkg 306ee3c9eebSPatrick Williams self.exception = None # type: Optional[Exception] 307ee3c9eebSPatrick Williams 308ee3c9eebSPatrick Williams # Reference to this package's 309ee3c9eebSPatrick Williams self.pkg_def = Package.packages[pkg] 310ee3c9eebSPatrick Williams self.pkg_def["__package"] = self 311ee3c9eebSPatrick Williams 312ee3c9eebSPatrick Williams def run(self) -> None: 313ee3c9eebSPatrick Williams """Thread 'run' function. Builds the Docker stage.""" 314ee3c9eebSPatrick Williams 315ee3c9eebSPatrick Williams # In case this package has no rev, fetch it from Github. 316ee3c9eebSPatrick Williams self._update_rev() 317ee3c9eebSPatrick Williams 318ee3c9eebSPatrick Williams # Find all the Package objects that this package depends on. 319ee3c9eebSPatrick Williams # This section is locked because we are looking into another 320ee3c9eebSPatrick Williams # package's PackageDef dict, which could be being modified. 321ee3c9eebSPatrick Williams Package.lock.acquire() 322ee3c9eebSPatrick Williams deps: Iterable[Package] = [ 323ee3c9eebSPatrick Williams Package.packages[deppkg]["__package"] 324ee3c9eebSPatrick Williams for deppkg in self.pkg_def.get("depends", []) 325ee3c9eebSPatrick Williams ] 326ee3c9eebSPatrick Williams Package.lock.release() 327ee3c9eebSPatrick Williams 328ee3c9eebSPatrick Williams # Wait until all the depends finish building. We need them complete 329ee3c9eebSPatrick Williams # for the "COPY" commands. 330ee3c9eebSPatrick Williams for deppkg in deps: 331ee3c9eebSPatrick Williams deppkg.join() 332ee3c9eebSPatrick Williams 333ee3c9eebSPatrick Williams # Generate this package's Dockerfile. 334ee3c9eebSPatrick Williams dockerfile = f""" 335ee3c9eebSPatrick WilliamsFROM {docker_base_img_name} 336ee3c9eebSPatrick Williams{self._df_copycmds()} 337ee3c9eebSPatrick Williams{self._df_build()} 338ee3c9eebSPatrick Williams""" 339ee3c9eebSPatrick Williams 340ee3c9eebSPatrick Williams # Generate the resulting tag name and save it to the PackageDef. 341ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef, 342ee3c9eebSPatrick Williams # which can be accessed by other threads. 343ee3c9eebSPatrick Williams Package.lock.acquire() 344ee3c9eebSPatrick Williams tag = Docker.tagname(self._stagename(), dockerfile) 345ee3c9eebSPatrick Williams self.pkg_def["__tag"] = tag 346ee3c9eebSPatrick Williams Package.lock.release() 347ee3c9eebSPatrick Williams 348ee3c9eebSPatrick Williams # Do the build / save any exceptions. 349ee3c9eebSPatrick Williams try: 350ee3c9eebSPatrick Williams Docker.build(self.package, tag, dockerfile) 351ee3c9eebSPatrick Williams except Exception as e: 352ee3c9eebSPatrick Williams self.exception = e 353ee3c9eebSPatrick Williams 354ee3c9eebSPatrick Williams @classmethod 355ee3c9eebSPatrick Williams def generate_all(cls) -> None: 356ee3c9eebSPatrick Williams """Ensure a Docker stage is created for all defined packages. 357ee3c9eebSPatrick Williams 358ee3c9eebSPatrick Williams These are done in parallel but with appropriate blocking per 359ee3c9eebSPatrick Williams package 'depends' specifications. 360ee3c9eebSPatrick Williams """ 361ee3c9eebSPatrick Williams 362ee3c9eebSPatrick Williams # Create a Package for each defined package. 363ee3c9eebSPatrick Williams pkg_threads = [Package(p) for p in cls.packages.keys()] 364ee3c9eebSPatrick Williams 365ee3c9eebSPatrick Williams # Start building them all. 3666dbd7807SPatrick Williams # This section is locked because threads depend on each other, 3676dbd7807SPatrick Williams # based on the packages, and they cannot 'join' on a thread 3686dbd7807SPatrick Williams # which is not yet started. Adding a lock here allows all the 3696dbd7807SPatrick Williams # threads to start before they 'join' their dependencies. 3706dbd7807SPatrick Williams Package.lock.acquire() 371ee3c9eebSPatrick Williams for t in pkg_threads: 372ee3c9eebSPatrick Williams t.start() 3736dbd7807SPatrick Williams Package.lock.release() 374ee3c9eebSPatrick Williams 375ee3c9eebSPatrick Williams # Wait for completion. 376ee3c9eebSPatrick Williams for t in pkg_threads: 377ee3c9eebSPatrick Williams t.join() 378ee3c9eebSPatrick Williams # Check if the thread saved off its own exception. 379ee3c9eebSPatrick Williams if t.exception: 380ee3c9eebSPatrick Williams print(f"Package {t.package} failed!", file=sys.stderr) 381ee3c9eebSPatrick Williams raise t.exception 382ee3c9eebSPatrick Williams 383ee3c9eebSPatrick Williams @staticmethod 384ee3c9eebSPatrick Williams def df_all_copycmds() -> str: 385ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to copy all packages 386ee3c9eebSPatrick Williams into the final image. 387ee3c9eebSPatrick Williams """ 388ee3c9eebSPatrick Williams return Package.df_copycmds_set(Package.packages.keys()) 389ee3c9eebSPatrick Williams 390ee3c9eebSPatrick Williams @classmethod 391ee3c9eebSPatrick Williams def depcache(cls) -> str: 392ee3c9eebSPatrick Williams """Create the contents of the '/tmp/depcache'. 393ee3c9eebSPatrick Williams This file is a comma-separated list of "<pkg>:<rev>". 394ee3c9eebSPatrick Williams """ 395ee3c9eebSPatrick Williams 396ee3c9eebSPatrick Williams # This needs to be sorted for consistency. 397ee3c9eebSPatrick Williams depcache = "" 398ee3c9eebSPatrick Williams for pkg in sorted(cls.packages.keys()): 399ee3c9eebSPatrick Williams depcache += "%s:%s," % (pkg, cls.packages[pkg]["rev"]) 400ee3c9eebSPatrick Williams return depcache 401ee3c9eebSPatrick Williams 402ee3c9eebSPatrick Williams def _update_rev(self) -> None: 403ee3c9eebSPatrick Williams """Look up the HEAD for missing a static rev.""" 404ee3c9eebSPatrick Williams 405ee3c9eebSPatrick Williams if "rev" in self.pkg_def: 406ee3c9eebSPatrick Williams return 407ee3c9eebSPatrick Williams 40865b21fb9SPatrick Williams # Check if Jenkins/Gerrit gave us a revision and use it. 40965b21fb9SPatrick Williams if gerrit_project == self.package and gerrit_rev: 41065b21fb9SPatrick Williams print( 41165b21fb9SPatrick Williams f"Found Gerrit revision for {self.package}: {gerrit_rev}", 41265b21fb9SPatrick Williams file=sys.stderr, 41365b21fb9SPatrick Williams ) 41465b21fb9SPatrick Williams self.pkg_def["rev"] = gerrit_rev 41565b21fb9SPatrick Williams return 41665b21fb9SPatrick Williams 417ee3c9eebSPatrick Williams # Ask Github for all the branches. 41805fb2a0aSPatrick Williams lookup = git( 41905fb2a0aSPatrick Williams "ls-remote", "--heads", f"https://github.com/{self.package}" 42005fb2a0aSPatrick Williams ) 421ee3c9eebSPatrick Williams 422ee3c9eebSPatrick Williams # Find the branch matching {branch} (or fallback to master). 423ee3c9eebSPatrick Williams # This section is locked because we are modifying the PackageDef. 424ee3c9eebSPatrick Williams Package.lock.acquire() 425ee3c9eebSPatrick Williams for line in lookup.split("\n"): 426ee3c9eebSPatrick Williams if f"refs/heads/{branch}" in line: 427ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 428c7d73646SPatrick Williams elif ( 429c7d73646SPatrick Williams "refs/heads/master" in line or "refs/heads/main" in line 430c7d73646SPatrick Williams ) and "rev" not in self.pkg_def: 431ee3c9eebSPatrick Williams self.pkg_def["rev"] = line.split()[0] 432ee3c9eebSPatrick Williams Package.lock.release() 433ee3c9eebSPatrick Williams 434ee3c9eebSPatrick Williams def _stagename(self) -> str: 435ee3c9eebSPatrick Williams """Create a name for the Docker stage associated with this pkg.""" 436ee3c9eebSPatrick Williams return self.package.replace("/", "-").lower() 437ee3c9eebSPatrick Williams 438ee3c9eebSPatrick Williams def _url(self) -> str: 439ee3c9eebSPatrick Williams """Get the URL for this package.""" 440ee3c9eebSPatrick Williams rev = self.pkg_def["rev"] 441ee3c9eebSPatrick Williams 442ee3c9eebSPatrick Williams # If the lambda exists, call it. 443ee3c9eebSPatrick Williams if "url" in self.pkg_def: 444ee3c9eebSPatrick Williams return self.pkg_def["url"](self.package, rev) 445ee3c9eebSPatrick Williams 446ee3c9eebSPatrick Williams # Default to the github archive URL. 447ee3c9eebSPatrick Williams return f"https://github.com/{self.package}/archive/{rev}.tar.gz" 448ee3c9eebSPatrick Williams 449ee3c9eebSPatrick Williams def _cmd_download(self) -> str: 450ee3c9eebSPatrick Williams """Formulate the command necessary to download and unpack to source.""" 451ee3c9eebSPatrick Williams 452ee3c9eebSPatrick Williams url = self._url() 453ee3c9eebSPatrick Williams if ".tar." not in url: 454ee3c9eebSPatrick Williams raise NotImplementedError( 455ee3c9eebSPatrick Williams f"Unhandled download type for {self.package}: {url}" 456ee3c9eebSPatrick Williams ) 457ee3c9eebSPatrick Williams 458ee3c9eebSPatrick Williams cmd = f"curl -L {url} | tar -x" 459ee3c9eebSPatrick Williams 460ee3c9eebSPatrick Williams if url.endswith(".bz2"): 461ee3c9eebSPatrick Williams cmd += "j" 462ee3c9eebSPatrick Williams elif url.endswith(".gz"): 463ee3c9eebSPatrick Williams cmd += "z" 464ee3c9eebSPatrick Williams else: 465ee3c9eebSPatrick Williams raise NotImplementedError( 466ee3c9eebSPatrick Williams f"Unknown tar flags needed for {self.package}: {url}" 467ee3c9eebSPatrick Williams ) 468ee3c9eebSPatrick Williams 469ee3c9eebSPatrick Williams return cmd 470ee3c9eebSPatrick Williams 471ee3c9eebSPatrick Williams def _cmd_cd_srcdir(self) -> str: 472ee3c9eebSPatrick Williams """Formulate the command necessary to 'cd' into the source dir.""" 473ee3c9eebSPatrick Williams return f"cd {self.package.split('/')[-1]}*" 474ee3c9eebSPatrick Williams 475ee3c9eebSPatrick Williams def _df_copycmds(self) -> str: 476ee3c9eebSPatrick Williams """Formulate the dockerfile snippet necessary to COPY all depends.""" 477ee3c9eebSPatrick Williams 478ee3c9eebSPatrick Williams if "depends" not in self.pkg_def: 479ee3c9eebSPatrick Williams return "" 480ee3c9eebSPatrick Williams return Package.df_copycmds_set(self.pkg_def["depends"]) 481ee3c9eebSPatrick Williams 482ee3c9eebSPatrick Williams @staticmethod 483ee3c9eebSPatrick Williams def df_copycmds_set(pkgs: Iterable[str]) -> str: 484ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to COPY a set of 485ee3c9eebSPatrick Williams packages into a Docker stage. 486ee3c9eebSPatrick Williams """ 487ee3c9eebSPatrick Williams 488ee3c9eebSPatrick Williams copy_cmds = "" 489ee3c9eebSPatrick Williams 490ee3c9eebSPatrick Williams # Sort the packages for consistency. 491ee3c9eebSPatrick Williams for p in sorted(pkgs): 492ee3c9eebSPatrick Williams tag = Package.packages[p]["__tag"] 493ee3c9eebSPatrick Williams copy_cmds += f"COPY --from={tag} {prefix} {prefix}\n" 494ee3c9eebSPatrick Williams # Workaround for upstream docker bug and multiple COPY cmds 495ee3c9eebSPatrick Williams # https://github.com/moby/moby/issues/37965 496ee3c9eebSPatrick Williams copy_cmds += "RUN true\n" 497ee3c9eebSPatrick Williams 498ee3c9eebSPatrick Williams return copy_cmds 499ee3c9eebSPatrick Williams 500ee3c9eebSPatrick Williams def _df_build(self) -> str: 501ee3c9eebSPatrick Williams """Formulate the Dockerfile snippet necessary to download, build, and 502ee3c9eebSPatrick Williams install a package into a Docker stage. 503ee3c9eebSPatrick Williams """ 504ee3c9eebSPatrick Williams 505ee3c9eebSPatrick Williams # Download and extract source. 506ee3c9eebSPatrick Williams result = f"RUN {self._cmd_download()} && {self._cmd_cd_srcdir()} && " 507ee3c9eebSPatrick Williams 508ee3c9eebSPatrick Williams # Handle 'custom_post_dl' commands. 509ee3c9eebSPatrick Williams custom_post_dl = self.pkg_def.get("custom_post_dl") 510ee3c9eebSPatrick Williams if custom_post_dl: 511ee3c9eebSPatrick Williams result += " && ".join(custom_post_dl) + " && " 512ee3c9eebSPatrick Williams 513ee3c9eebSPatrick Williams # Build and install package based on 'build_type'. 514ee3c9eebSPatrick Williams build_type = self.pkg_def["build_type"] 515ee3c9eebSPatrick Williams if build_type == "autoconf": 516ee3c9eebSPatrick Williams result += self._cmd_build_autoconf() 517ee3c9eebSPatrick Williams elif build_type == "cmake": 518ee3c9eebSPatrick Williams result += self._cmd_build_cmake() 519ee3c9eebSPatrick Williams elif build_type == "custom": 520ee3c9eebSPatrick Williams result += self._cmd_build_custom() 521ee3c9eebSPatrick Williams elif build_type == "make": 522ee3c9eebSPatrick Williams result += self._cmd_build_make() 523ee3c9eebSPatrick Williams elif build_type == "meson": 524ee3c9eebSPatrick Williams result += self._cmd_build_meson() 525ee3c9eebSPatrick Williams else: 526ee3c9eebSPatrick Williams raise NotImplementedError( 527ee3c9eebSPatrick Williams f"Unhandled build type for {self.package}: {build_type}" 528ee3c9eebSPatrick Williams ) 529ee3c9eebSPatrick Williams 5306bce2ca1SPatrick Williams # Handle 'custom_post_install' commands. 5316bce2ca1SPatrick Williams custom_post_install = self.pkg_def.get("custom_post_install") 5326bce2ca1SPatrick Williams if custom_post_install: 5336bce2ca1SPatrick Williams result += " && " + " && ".join(custom_post_install) 5346bce2ca1SPatrick Williams 535ee3c9eebSPatrick Williams return result 536ee3c9eebSPatrick Williams 537ee3c9eebSPatrick Williams def _cmd_build_autoconf(self) -> str: 538ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 539ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 540ee3c9eebSPatrick Williams result = "./bootstrap.sh && " 541ee3c9eebSPatrick Williams result += f"{env} ./configure {configure_flags} {options} && " 542ee3c9eebSPatrick Williams result += f"make -j{proc_count} && make install" 543ee3c9eebSPatrick Williams return result 544ee3c9eebSPatrick Williams 545ee3c9eebSPatrick Williams def _cmd_build_cmake(self) -> str: 546ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 547ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 548ee3c9eebSPatrick Williams result = "mkdir builddir && cd builddir && " 549ee3c9eebSPatrick Williams result += f"{env} cmake {cmake_flags} {options} .. && " 550ee3c9eebSPatrick Williams result += "cmake --build . --target all && " 551ee3c9eebSPatrick Williams result += "cmake --build . --target install && " 552ee3c9eebSPatrick Williams result += "cd .." 553ee3c9eebSPatrick Williams return result 554ee3c9eebSPatrick Williams 555ee3c9eebSPatrick Williams def _cmd_build_custom(self) -> str: 556ee3c9eebSPatrick Williams return " && ".join(self.pkg_def.get("build_steps", [])) 557ee3c9eebSPatrick Williams 558ee3c9eebSPatrick Williams def _cmd_build_make(self) -> str: 559ee3c9eebSPatrick Williams return f"make -j{proc_count} && make install" 560ee3c9eebSPatrick Williams 561ee3c9eebSPatrick Williams def _cmd_build_meson(self) -> str: 562ee3c9eebSPatrick Williams options = " ".join(self.pkg_def.get("config_flags", [])) 563ee3c9eebSPatrick Williams env = " ".join(self.pkg_def.get("config_env", [])) 564ee3c9eebSPatrick Williams result = f"{env} meson builddir {meson_flags} {options} && " 565ee3c9eebSPatrick Williams result += "ninja -C builddir && ninja -C builddir install" 566ee3c9eebSPatrick Williams return result 567ee3c9eebSPatrick Williams 568ee3c9eebSPatrick Williams 569ee3c9eebSPatrick Williamsclass Docker: 570ee3c9eebSPatrick Williams """Class to assist with Docker interactions. All methods are static.""" 571ee3c9eebSPatrick Williams 572ee3c9eebSPatrick Williams @staticmethod 573ee3c9eebSPatrick Williams def timestamp() -> str: 574ee3c9eebSPatrick Williams """Generate a timestamp for today using the ISO week.""" 575ee3c9eebSPatrick Williams today = date.today().isocalendar() 576ee3c9eebSPatrick Williams return f"{today[0]}-W{today[1]:02}" 577ee3c9eebSPatrick Williams 578ee3c9eebSPatrick Williams @staticmethod 57941d86218SPatrick Williams def tagname(pkgname: Optional[str], dockerfile: str) -> str: 580ee3c9eebSPatrick Williams """Generate a tag name for a package using a hash of the Dockerfile.""" 581ee3c9eebSPatrick Williams result = docker_image_name 582ee3c9eebSPatrick Williams if pkgname: 583ee3c9eebSPatrick Williams result += "-" + pkgname 584ee3c9eebSPatrick Williams 585ee3c9eebSPatrick Williams result += ":" + Docker.timestamp() 586ee3c9eebSPatrick Williams result += "-" + sha256(dockerfile.encode()).hexdigest()[0:16] 587ee3c9eebSPatrick Williams 588ee3c9eebSPatrick Williams return result 589ee3c9eebSPatrick Williams 590ee3c9eebSPatrick Williams @staticmethod 591ee3c9eebSPatrick Williams def build(pkg: str, tag: str, dockerfile: str) -> None: 59222e6110bSAndrew Geissler """Build a docker image using the Dockerfile and tagging it with 'tag'.""" 593ee3c9eebSPatrick Williams 594ee3c9eebSPatrick Williams # If we're not forcing builds, check if it already exists and skip. 595ee3c9eebSPatrick Williams if not force_build: 596ee3c9eebSPatrick Williams if docker.image.ls(tag, "--format", '"{{.Repository}}:{{.Tag}}"'): 59705fb2a0aSPatrick Williams print( 59805fb2a0aSPatrick Williams f"Image {tag} already exists. Skipping.", file=sys.stderr 59905fb2a0aSPatrick Williams ) 600ee3c9eebSPatrick Williams return 601ee3c9eebSPatrick Williams 602ee3c9eebSPatrick Williams # Build it. 603ee3c9eebSPatrick Williams # Capture the output of the 'docker build' command and send it to 604ee3c9eebSPatrick Williams # stderr (prefixed with the package name). This allows us to see 605ee3c9eebSPatrick Williams # progress but not polute stdout. Later on we output the final 606ee3c9eebSPatrick Williams # docker tag to stdout and we want to keep that pristine. 607ee3c9eebSPatrick Williams # 608ee3c9eebSPatrick Williams # Other unusual flags: 609ee3c9eebSPatrick Williams # --no-cache: Bypass the Docker cache if 'force_build'. 610ee3c9eebSPatrick Williams # --force-rm: Clean up Docker processes if they fail. 611ee3c9eebSPatrick Williams docker.build( 612ee3c9eebSPatrick Williams proxy_args, 613ee3c9eebSPatrick Williams "--network=host", 614ee3c9eebSPatrick Williams "--force-rm", 615ee3c9eebSPatrick Williams "--no-cache=true" if force_build else "--no-cache=false", 616ee3c9eebSPatrick Williams "-t", 617ee3c9eebSPatrick Williams tag, 618ee3c9eebSPatrick Williams "-", 619ee3c9eebSPatrick Williams _in=dockerfile, 620ee3c9eebSPatrick Williams _out=( 621ee3c9eebSPatrick Williams lambda line: print( 622ee3c9eebSPatrick Williams pkg + ":", line, end="", file=sys.stderr, flush=True 623ee3c9eebSPatrick Williams ) 624ee3c9eebSPatrick Williams ), 625ee3c9eebSPatrick Williams ) 626ee3c9eebSPatrick Williams 627ee3c9eebSPatrick Williams 628ee3c9eebSPatrick Williams# Read a bunch of environment variables. 62905fb2a0aSPatrick Williamsdocker_image_name = os.environ.get( 63005fb2a0aSPatrick Williams "DOCKER_IMAGE_NAME", "openbmc/ubuntu-unit-test" 63105fb2a0aSPatrick Williams) 632ee3c9eebSPatrick Williamsforce_build = os.environ.get("FORCE_DOCKER_BUILD") 633ee3c9eebSPatrick Williamsis_automated_ci_build = os.environ.get("BUILD_URL", False) 6345e4d8402SPatrick Williamsdistro = os.environ.get("DISTRO", "ubuntu:lunar") 635ee3c9eebSPatrick Williamsbranch = os.environ.get("BRANCH", "master") 636ee3c9eebSPatrick Williamsubuntu_mirror = os.environ.get("UBUNTU_MIRROR") 637ee3c9eebSPatrick Williamshttp_proxy = os.environ.get("http_proxy") 638ee3c9eebSPatrick Williams 63965b21fb9SPatrick Williamsgerrit_project = os.environ.get("GERRIT_PROJECT") 64065b21fb9SPatrick Williamsgerrit_rev = os.environ.get("GERRIT_PATCHSET_REVISION") 64165b21fb9SPatrick Williams 642d0dabc3eSAndrew Geissler# Ensure appropriate docker build output to see progress and identify 643d0dabc3eSAndrew Geissler# any issues 644d0dabc3eSAndrew Geissleros.environ["BUILDKIT_PROGRESS"] = "plain" 645d0dabc3eSAndrew Geissler 646ee3c9eebSPatrick Williams# Set up some common variables. 647ee3c9eebSPatrick Williamsusername = os.environ.get("USER", "root") 648ee3c9eebSPatrick Williamshomedir = os.environ.get("HOME", "/root") 649ee3c9eebSPatrick Williamsgid = os.getgid() 650ee3c9eebSPatrick Williamsuid = os.getuid() 651ee3c9eebSPatrick Williams 6526825a018SJosh Lehan# Use well-known constants if user is root 6536825a018SJosh Lehanif username == "root": 6546825a018SJosh Lehan homedir = "/root" 6556825a018SJosh Lehan gid = 0 6566825a018SJosh Lehan uid = 0 6576825a018SJosh Lehan 658ee3c9eebSPatrick Williams# Determine the architecture for Docker. 659ee3c9eebSPatrick Williamsarch = uname("-m").strip() 660ee3c9eebSPatrick Williamsif arch == "ppc64le": 661ee3c9eebSPatrick Williams docker_base = "ppc64le/" 662ee3c9eebSPatrick Williamselif arch == "x86_64": 663ee3c9eebSPatrick Williams docker_base = "" 664051b05b7SThang Q. Nguyenelif arch == "aarch64": 665f98f1a8dSThang Q. Nguyen docker_base = "arm64v8/" 666ee3c9eebSPatrick Williamselse: 667ee3c9eebSPatrick Williams print( 668ee3c9eebSPatrick Williams f"Unsupported system architecture({arch}) found for docker image", 669ee3c9eebSPatrick Williams file=sys.stderr, 670ee3c9eebSPatrick Williams ) 671ee3c9eebSPatrick Williams sys.exit(1) 672ee3c9eebSPatrick Williams 67302871c91SPatrick Williams# Special flags if setting up a deb mirror. 67402871c91SPatrick Williamsmirror = "" 67502871c91SPatrick Williamsif "ubuntu" in distro and ubuntu_mirror: 67602871c91SPatrick Williams mirror = f""" 677e08ffba8SPatrick WilliamsRUN echo "deb {ubuntu_mirror} \ 678e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME) \ 679e08ffba8SPatrick Williams main restricted universe multiverse" > /etc/apt/sources.list && \\ 680e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 681e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-updates \ 682e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 683e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 684e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-security \ 685e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 686e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 687e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-proposed \ 688e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list && \\ 689e08ffba8SPatrick Williams echo "deb {ubuntu_mirror} \ 690e08ffba8SPatrick Williams $(. /etc/os-release && echo $VERSION_CODENAME)-backports \ 691e08ffba8SPatrick Williams main restricted universe multiverse" >> /etc/apt/sources.list 69202871c91SPatrick Williams""" 69302871c91SPatrick Williams 69402871c91SPatrick Williams# Special flags for proxying. 69502871c91SPatrick Williamsproxy_cmd = "" 69634ec77e8SAdrian Ambrożewiczproxy_keyserver = "" 69702871c91SPatrick Williamsproxy_args = [] 69802871c91SPatrick Williamsif http_proxy: 69902871c91SPatrick Williams proxy_cmd = f""" 70002871c91SPatrick WilliamsRUN echo "[http]" >> {homedir}/.gitconfig && \ 70102871c91SPatrick Williams echo "proxy = {http_proxy}" >> {homedir}/.gitconfig 70202871c91SPatrick Williams""" 70334ec77e8SAdrian Ambrożewicz proxy_keyserver = f"--keyserver-options http-proxy={http_proxy}" 70434ec77e8SAdrian Ambrożewicz 70502871c91SPatrick Williams proxy_args.extend( 70602871c91SPatrick Williams [ 70702871c91SPatrick Williams "--build-arg", 70802871c91SPatrick Williams f"http_proxy={http_proxy}", 70902871c91SPatrick Williams "--build-arg", 710d461cd6aSLei YU f"https_proxy={http_proxy}", 71102871c91SPatrick Williams ] 71202871c91SPatrick Williams ) 71302871c91SPatrick Williams 714ee3c9eebSPatrick Williams# Create base Dockerfile. 715a18d9c57SPatrick Williamsdockerfile_base = f""" 716a18d9c57SPatrick WilliamsFROM {docker_base}{distro} 71702871c91SPatrick Williams 71802871c91SPatrick Williams{mirror} 71902871c91SPatrick Williams 72002871c91SPatrick WilliamsENV DEBIAN_FRONTEND noninteractive 72102871c91SPatrick Williams 7228949d3c3SPatrick WilliamsENV PYTHONPATH "/usr/local/lib/python3.10/site-packages/" 72302871c91SPatrick Williams 724bb16ac14SPatrick Williams# Sometimes the ubuntu key expires and we need a way to force an execution 725bb16ac14SPatrick Williams# of the apt-get commands for the dbgsym-keyring. When this happens we see 726bb16ac14SPatrick Williams# an error like: "Release: The following signatures were invalid:" 727bb16ac14SPatrick Williams# Insert a bogus echo that we can change here when we get this error to force 728bb16ac14SPatrick Williams# the update. 729bb16ac14SPatrick WilliamsRUN echo "ubuntu keyserver rev as of 2021-04-21" 730bb16ac14SPatrick Williams 73102871c91SPatrick Williams# We need the keys to be imported for dbgsym repos 73202871c91SPatrick Williams# New releases have a package, older ones fall back to manual fetching 73302871c91SPatrick Williams# https://wiki.ubuntu.com/Debug%20Symbol%20Packages 734575b5e4cSJagpal Singh Gill# Known issue with gpg to get keys via proxy - 735575b5e4cSJagpal Singh Gill# https://bugs.launchpad.net/ubuntu/+source/gnupg2/+bug/1788190, hence using 736575b5e4cSJagpal Singh Gill# curl to get keys. 73750837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && \ 738f79ce4c4SPatrick Williams ( apt-get install gpgv ubuntu-dbgsym-keyring || \ 739575b5e4cSJagpal Singh Gill ( apt-get install -yy dirmngr curl && \ 740575b5e4cSJagpal Singh Gill curl -sSL \ 741575b5e4cSJagpal Singh Gill 'https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xF2EDC64DC5AEE1F6B9C621F0C8CAB6595FDFF622' \ 742575b5e4cSJagpal Singh Gill | apt-key add - )) 74302871c91SPatrick Williams 74402871c91SPatrick Williams# Parse the current repo list into a debug repo list 745e08ffba8SPatrick WilliamsRUN sed -n '/^deb /s,^deb [^ ]* ,deb http://ddebs.ubuntu.com ,p' \ 746e08ffba8SPatrick Williams /etc/apt/sources.list >/etc/apt/sources.list.d/debug.list 74702871c91SPatrick Williams 74802871c91SPatrick Williams# Remove non-existent debug repos 74941d86218SPatrick WilliamsRUN sed -i '/-\\(backports\\|security\\) /d' /etc/apt/sources.list.d/debug.list 75002871c91SPatrick Williams 75102871c91SPatrick WilliamsRUN cat /etc/apt/sources.list.d/debug.list 75202871c91SPatrick Williams 75302871c91SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy && apt-get install -yy \ 75458f1915eSAndrew Jeffery abi-compliance-checker \ 755*8b112068SAndrew Jeffery abi-dumper \ 75602871c91SPatrick Williams autoconf \ 75702871c91SPatrick Williams autoconf-archive \ 758af49ed51SAndrew Geissler bison \ 75964b6f9d2SPatrick Williams clang-16 \ 76064b6f9d2SPatrick Williams clang-format-16 \ 76164b6f9d2SPatrick Williams clang-tidy-16 \ 76264b6f9d2SPatrick Williams clang-tools-16 \ 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 \ 773524a331cSManojkiran 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 liburing-dev \ 79802871c91SPatrick Williams libxml2-utils \ 7990eedeedaSPatrick Williams libxml-simple-perl \ 800af49ed51SAndrew Geissler ninja-build \ 801af49ed51SAndrew Geissler npm \ 802af49ed51SAndrew Geissler pkg-config \ 803af49ed51SAndrew Geissler protobuf-compiler \ 804af49ed51SAndrew Geissler python3 \ 805af49ed51SAndrew Geissler python3-dev\ 806af49ed51SAndrew Geissler python3-git \ 807af49ed51SAndrew Geissler python3-mako \ 808af49ed51SAndrew Geissler python3-pip \ 809af49ed51SAndrew Geissler python3-setuptools \ 810af49ed51SAndrew Geissler python3-socks \ 811af49ed51SAndrew Geissler python3-yaml \ 8129adf68d6SJohn Wedig rsync \ 813af49ed51SAndrew Geissler shellcheck \ 814af49ed51SAndrew Geissler sudo \ 815af49ed51SAndrew Geissler systemd \ 816af49ed51SAndrew Geissler valgrind \ 817af49ed51SAndrew Geissler valgrind-dbg \ 818b565f825SAndrew Geissler vim \ 819af49ed51SAndrew Geissler wget \ 820af49ed51SAndrew Geissler xxd 82102871c91SPatrick Williams 8225e4d8402SPatrick Williams# Lunar comes with GCC-12, so skip this. 8235b08dc6bSPatrick Williams#RUN update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 12 \ 8245b08dc6bSPatrick Williams# --slave /usr/bin/g++ g++ /usr/bin/g++-12 \ 8255b08dc6bSPatrick Williams# --slave /usr/bin/gcov gcov /usr/bin/gcov-12 \ 8265b08dc6bSPatrick Williams# --slave /usr/bin/gcov-dump gcov-dump /usr/bin/gcov-dump-12 \ 8275b08dc6bSPatrick Williams# --slave /usr/bin/gcov-tool gcov-tool /usr/bin/gcov-tool-12 8285b08dc6bSPatrick Williams#RUN update-alternatives --install /usr/bin/cpp cpp /usr/bin/cpp-12 12 82902871c91SPatrick Williams 83064b6f9d2SPatrick WilliamsRUN update-alternatives --install /usr/bin/clang clang /usr/bin/clang-16 1000 \ 83164b6f9d2SPatrick Williams --slave /usr/bin/clang++ clang++ /usr/bin/clang++-16 \ 83264b6f9d2SPatrick Williams --slave /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-16 \ 83364b6f9d2SPatrick Williams --slave /usr/bin/clang-format clang-format /usr/bin/clang-format-16 \ 834e08ffba8SPatrick Williams --slave /usr/bin/run-clang-tidy run-clang-tidy.py \ 83564b6f9d2SPatrick Williams /usr/bin/run-clang-tidy-16 \ 83664b6f9d2SPatrick Williams --slave /usr/bin/scan-build scan-build /usr/bin/scan-build-16 83702871c91SPatrick Williams 83850837436SPatrick Williams""" 83950837436SPatrick Williams 84050837436SPatrick Williamsif is_automated_ci_build: 84150837436SPatrick Williams dockerfile_base += f""" 84250837436SPatrick Williams# Run an arbitrary command to polute the docker cache regularly force us 84350837436SPatrick Williams# to re-run `apt-get update` daily. 844ee3c9eebSPatrick WilliamsRUN echo {Docker.timestamp()} 84550837436SPatrick WilliamsRUN apt-get update && apt-get dist-upgrade -yy 84650837436SPatrick Williams 84750837436SPatrick Williams""" 84850837436SPatrick Williams 84941d86218SPatrick Williamsdockerfile_base += """ 8505e4d8402SPatrick WilliamsRUN pip3 install --break-system-packages \ 851818023dfSPatrick Williams beautysh \ 852818023dfSPatrick Williams black \ 853818023dfSPatrick Williams codespell \ 854818023dfSPatrick Williams flake8 \ 855818023dfSPatrick Williams gitlint \ 856818023dfSPatrick Williams inflection \ 857818023dfSPatrick Williams isort \ 858818023dfSPatrick Williams jsonschema \ 8590044f69cSPatrick Williams meson==1.0.1 \ 860818023dfSPatrick Williams protobuf \ 861818023dfSPatrick Williams 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 88567cc0616SPatrick Williams# Ensure the group, user, and home directory are created (or rename them if 88667cc0616SPatrick Williams# they already exist). 88767cc0616SPatrick WilliamsRUN if grep -q ":{gid}:" /etc/group ; then \ 88867cc0616SPatrick Williams groupmod -n {username} $(awk -F : '{{ if ($3 == {gid}) {{ print $1 }} }}' /etc/group) ; \ 88967cc0616SPatrick Williams else \ 89067cc0616SPatrick Williams groupadd -f -g {gid} {username} ; \ 89167cc0616SPatrick Williams fi 89202871c91SPatrick WilliamsRUN mkdir -p "{os.path.dirname(homedir)}" 89367cc0616SPatrick WilliamsRUN if grep -q ":{uid}:" /etc/passwd ; then \ 89473b3ee91SPatrick Williams usermod -l {username} -d {homedir} -m $(awk -F : '{{ if ($3 == {uid}) {{ print $1 }} }}' /etc/passwd) ; \ 89567cc0616SPatrick Williams else \ 89667cc0616SPatrick Williams useradd -d {homedir} -m -u {uid} -g {gid} {username} ; \ 89767cc0616SPatrick Williams fi 89802871c91SPatrick WilliamsRUN sed -i '1iDefaults umask=000' /etc/sudoers 89902871c91SPatrick WilliamsRUN echo "{username} ALL=(ALL) NOPASSWD: ALL" >>/etc/sudoers 90002871c91SPatrick Williams 901305a9a5dSAndrew Geissler# Ensure user has ability to write to /usr/local for different tool 902305a9a5dSAndrew Geissler# and data installs 9037bb00b13SAndrew GeisslerRUN chown -R {username}:{username} /usr/local/share 904305a9a5dSAndrew Geissler 90502871c91SPatrick Williams{proxy_cmd} 90602871c91SPatrick Williams 90702871c91SPatrick WilliamsRUN /bin/bash 90802871c91SPatrick Williams""" 90902871c91SPatrick Williams 910a18d9c57SPatrick Williams# Do the final docker build 911ee3c9eebSPatrick Williamsdocker_final_img_name = Docker.tagname(None, dockerfile) 912ee3c9eebSPatrick WilliamsDocker.build("final", docker_final_img_name, dockerfile) 913ee3c9eebSPatrick Williams 91400536fbeSPatrick Williams# Print the tag of the final image. 91500536fbeSPatrick Williamsprint(docker_final_img_name) 916