/
mzbuild.py
1089 lines (928 loc) · 39 KB
/
mzbuild.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright Materialize, Inc. and contributors. All rights reserved.
#
# Use of this software is governed by the Business Source License
# included in the LICENSE file at the root of this repository.
#
# As of the Change Date specified in that file, in accordance with
# the Business Source License, use of this software will be governed
# by the Apache License, Version 2.0.
"""The implementation of the mzbuild system for Docker images.
For an overview of what mzbuild is and why it exists, see the [user-facing
documentation][user-docs].
[user-docs]: https://github.com/MaterializeInc/materialize/blob/main/doc/developer/mzbuild.md
"""
import argparse
import base64
import collections
import hashlib
import json
import multiprocessing
import os
import re
import shlex
import shutil
import stat
import subprocess
import sys
import time
from collections import OrderedDict
from collections.abc import Callable, Iterable, Iterator, Sequence
from functools import cache
from pathlib import Path
from tempfile import TemporaryFile
from typing import IO, Any, cast
import yaml
from materialize import cargo, git, rustc_flags, spawn, ui, xcompile
from materialize.rustc_flags import Sanitizer
from materialize.xcompile import Arch, target
class Fingerprint(bytes):
"""A SHA-1 hash of the inputs to an `Image`.
The string representation uses base32 encoding to distinguish mzbuild
fingerprints from Git's hex encoded SHA-1 hashes while still being
URL safe.
"""
def __str__(self) -> str:
return base64.b32encode(self).decode()
class RepositoryDetails:
"""Immutable details about a `Repository`.
Used internally by mzbuild.
Attributes:
root: The path to the root of the repository.
arch: The CPU architecture to build for.
release_mode: Whether the repository is being built in release mode.
coverage: Whether the repository has code coverage instrumentation
enabled.
sanitizer: Whether to use a sanitizer (address, hwaddress, cfi, thread, leak, memory, none)
cargo_workspace: The `cargo.Workspace` associated with the repository.
image_registry: The Docker image registry to pull images from and push
images to.
image_prefix: A prefix to apply to all Docker image names.
"""
def __init__(
self,
root: Path,
arch: Arch,
release_mode: bool,
coverage: bool,
sanitizer: Sanitizer,
image_registry: str,
image_prefix: str,
):
self.root = root
self.arch = arch
self.release_mode = release_mode
self.coverage = coverage
self.sanitizer = sanitizer
self.cargo_workspace = cargo.Workspace(root)
self.image_registry = image_registry
self.image_prefix = image_prefix
def cargo(
self,
subcommand: str,
rustflags: list[str],
channel: str | None = None,
extra_env: dict[str, str] = {},
) -> list[str]:
"""Start a cargo invocation for the configured architecture."""
return xcompile.cargo(
arch=self.arch,
channel=channel,
subcommand=subcommand,
rustflags=rustflags,
extra_env=extra_env,
)
def tool(self, name: str) -> list[str]:
"""Start a binutils tool invocation for the configured architecture."""
return xcompile.tool(self.arch, name)
def cargo_target_dir(self) -> Path:
"""Determine the path to the target directory for Cargo."""
return self.root / "target-xcompile" / xcompile.target(self.arch)
def rewrite_builder_path_for_host(self, path: Path) -> Path:
"""Rewrite a path that is relative to the target directory inside the
builder to a path that is relative to the target directory on the host.
If path does is not relative to the target directory inside the builder,
it is returned unchanged.
"""
builder_target_dir = Path("/mnt/build") / xcompile.target(self.arch)
try:
return self.cargo_target_dir() / path.relative_to(builder_target_dir)
except ValueError:
return path
def docker_images() -> set[str]:
"""List the Docker images available on the local machine."""
return set(
spawn.capture(["docker", "images", "--format", "{{.Repository}}:{{.Tag}}"])
.strip()
.split("\n")
)
def is_docker_image_pushed(name: str) -> bool:
"""Check whether the named image is pushed to Docker Hub.
Note that this operation requires a rather slow network request.
"""
proc = subprocess.run(
["docker", "manifest", "inspect", name],
stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL,
env=dict(os.environ, DOCKER_CLI_EXPERIMENTAL="enabled"),
)
return proc.returncode == 0
def chmod_x(path: Path) -> None:
"""Set the executable bit on a file or directory."""
# https://stackoverflow.com/a/30463972/1122351
mode = os.stat(path).st_mode
mode |= (mode & 0o444) >> 2 # copy R bits to X
os.chmod(path, mode)
class PreImage:
"""An action to run before building a Docker image.
Args:
rd: The `RepositoryDetails` for the repository.
path: The path to the `Image` associated with this action.
"""
def __init__(self, rd: RepositoryDetails, path: Path):
self.rd = rd
self.path = path
@classmethod
def prepare_batch(cls, instances: list["PreImage"]) -> None:
"""Prepare a batch of actions.
This is useful for `PreImage` actions that are more efficient when
their actions are applied to several images in bulk.
"""
pass
def run(self) -> None:
"""Perform the action."""
pass
def inputs(self) -> set[str]:
"""Return the files which are considered inputs to the action."""
raise NotImplementedError
def extra(self) -> str:
"""Returns additional data for incorporation in the fingerprint."""
return ""
class Copy(PreImage):
"""A `PreImage` action which copies files from a directory.
See doc/developer/mzbuild.md for an explanation of the user-facing
parameters.
"""
def __init__(self, rd: RepositoryDetails, path: Path, config: dict[str, Any]):
super().__init__(rd, path)
self.source = config.pop("source", None)
if self.source is None:
raise ValueError("mzbuild config is missing 'source' argument")
self.destination = config.pop("destination", None)
if self.destination is None:
raise ValueError("mzbuild config is missing 'destination' argument")
self.matching = config.pop("matching", "*")
def run(self) -> None:
super().run()
for src in self.inputs():
dst = self.path / self.destination / src
dst.parent.mkdir(parents=True, exist_ok=True)
shutil.copy(self.rd.root / self.source / src, dst)
def inputs(self) -> set[str]:
return set(git.expand_globs(self.rd.root / self.source, self.matching))
class CargoPreImage(PreImage):
"""A `PreImage` action that uses Cargo."""
def inputs(self) -> set[str]:
return {
"ci/builder",
"Cargo.toml",
# TODO(benesch): we could in theory fingerprint only the subset of
# Cargo.lock that applies to the crates at hand, but that is a
# *lot* of work.
"Cargo.lock",
".cargo/config",
}
def extra(self) -> str:
# Cargo images depend on the release mode and whether
# coverage/sanitizer is enabled.
flags: list[str] = []
if self.rd.release_mode:
flags += "release"
if self.rd.coverage:
flags += "coverage"
if self.rd.sanitizer != Sanitizer.none:
flags += self.rd.sanitizer.value
flags.sort()
return ",".join(flags)
class CargoBuild(CargoPreImage):
"""A `PreImage` action that builds a single binary with Cargo.
See doc/developer/mzbuild.md for an explanation of the user-facing
parameters.
"""
def __init__(self, rd: RepositoryDetails, path: Path, config: dict[str, Any]):
super().__init__(rd, path)
bin = config.pop("bin", [])
self.bins = bin if isinstance(bin, list) else [bin]
example = config.pop("example", [])
self.examples = example if isinstance(example, list) else [example]
self.strip = config.pop("strip", True)
self.extract = config.pop("extract", {})
if len(self.bins) == 0 and len(self.examples) == 0:
raise ValueError("mzbuild config is missing pre-build target")
@staticmethod
def generate_cargo_build_command(
rd: RepositoryDetails,
bins: list[str],
examples: list[str],
) -> list[str]:
rustflags = (
rustc_flags.coverage
if rd.coverage
else (
rustc_flags.sanitizer[rd.sanitizer]
if rd.sanitizer != Sanitizer.none
else ["--cfg=tokio_unstable"]
)
)
cflags = (
[
f"--target={target(rd.arch)}",
f"--gcc-toolchain=/opt/x-tools/{target(rd.arch)}/",
"-fuse-ld=lld",
f"--sysroot=/opt/x-tools/{target(rd.arch)}/{target(rd.arch)}/sysroot",
f"-L/opt/x-tools/{target(rd.arch)}/{target(rd.arch)}/lib64",
]
+ rustc_flags.sanitizer_cflags[rd.sanitizer]
if rd.sanitizer != Sanitizer.none
else []
)
extra_env = (
{
"CFLAGS": " ".join(cflags),
"CXXFLAGS": " ".join(cflags),
"LDFLAGS": " ".join(cflags),
"CXXSTDLIB": "stdc++",
"CC": "cc",
"CXX": "c++",
"CPP": "clang-cpp-15",
"CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_LINKER": "cc",
"CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER": "cc",
"PATH": f"/sanshim:/opt/x-tools/{target(rd.arch)}/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
"TSAN_OPTIONS": "report_bugs=0", # build-scripts fail
}
if rd.sanitizer != Sanitizer.none
else {}
)
cargo_build = [
*rd.cargo("build", channel=None, rustflags=rustflags, extra_env=extra_env),
"--workspace",
]
for bin in bins:
cargo_build.extend(["--bin", bin])
for example in examples:
cargo_build.extend(["--example", example])
if rd.release_mode:
cargo_build.append("--release")
if rd.sanitizer != Sanitizer.none:
# ASan doesn't work with jemalloc
cargo_build.append("--no-default-features")
# Uses more memory, so reduce the number of jobs
cargo_build.extend(
["--jobs", str(round(multiprocessing.cpu_count() * 2 / 3))]
)
return cargo_build
@classmethod
def prepare_batch(cls, cargo_builds: list["PreImage"]) -> None:
super().prepare_batch(cargo_builds)
if not cargo_builds:
return
# Building all binaries and examples in the same `cargo build` command
# allows Cargo to link in parallel with other work, which can
# meaningfully speed up builds.
rd: RepositoryDetails | None = None
builds = cast(list[CargoBuild], cargo_builds)
bins = set()
examples = set()
for build in builds:
if not rd:
rd = build.rd
bins.update(build.bins)
examples.update(build.examples)
assert rd
ui.say(f"Common cargo build for: {', '.join(bins | examples)}")
cargo_build = cls.generate_cargo_build_command(rd, list(bins), list(examples))
spawn.runv(cargo_build, cwd=rd.root)
def build(self) -> None:
cargo_profile = "release" if self.rd.release_mode else "debug"
def copy(exe: Path) -> None:
exe_path = self.path / exe
exe_path.parent.mkdir(parents=True, exist_ok=True)
shutil.copy(self.rd.cargo_target_dir() / cargo_profile / exe, exe_path)
if self.strip:
# The debug information is large enough that it slows down CI,
# since we're packaging these binaries up into Docker images and
# shipping them around.
spawn.runv(
[*self.rd.tool("strip"), "--strip-debug", exe_path],
cwd=self.rd.root,
)
else:
# Even if we've been asked not to strip the binary, remove the
# `.debug_pubnames` and `.debug_pubtypes` sections. These are just
# indexes that speed up launching a debugger against the binary,
# and we're happy to have slower debugger start up in exchange for
# smaller binaries. Plus the sections have been obsoleted by a
# `.debug_names` section in DWARF 5, and so debugger support for
# `.debug_pubnames`/`.debug_pubtypes` is minimal anyway.
# See: https://github.com/rust-lang/rust/issues/46034
spawn.runv(
[
*self.rd.tool("objcopy"),
"-R",
".debug_pubnames",
"-R",
".debug_pubtypes",
exe_path,
],
cwd=self.rd.root,
)
for bin in self.bins:
copy(Path(bin))
for example in self.examples:
copy(Path("examples") / example)
if self.extract:
cargo_build = self.generate_cargo_build_command(
self.rd, self.bins, self.examples
)
output = spawn.capture(
cargo_build + ["--message-format=json"],
cwd=self.rd.root,
)
target_dir = self.rd.cargo_target_dir()
for line in output.split("\n"):
if line.strip() == "" or not line.startswith("{"):
continue
message = json.loads(line)
if message["reason"] != "build-script-executed":
continue
out_dir = self.rd.rewrite_builder_path_for_host(
Path(message["out_dir"])
)
if not out_dir.is_relative_to(target_dir):
# Some crates are built for both the host and the target.
# Ignore the built-for-host out dir.
continue
# parse the package name from a package_id that looks like one of:
# git+https://github.com/MaterializeInc/rust-server-sdk#launchdarkly-server-sdk@1.0.0
# path+file:///Users/roshan/materialize/src/catalog#mz-catalog@0.0.0
# registry+https://github.com/rust-lang/crates.io-index#num-rational@0.4.0
# file:///path/to/my-package#0.1.0
package_id = message["package_id"]
if "@" in package_id:
package = package_id.split("@")[0].split("#")[-1]
else:
package = message["package_id"].split("#")[0].split("/")[-1]
for src, dst in self.extract.get(package, {}).items():
spawn.runv(["cp", "-R", out_dir / src, self.path / dst])
self.acquired = True
def run(self) -> None:
super().run()
self.build()
def inputs(self) -> set[str]:
deps = set()
for bin in self.bins:
crate = self.rd.cargo_workspace.crate_for_bin(bin)
deps |= self.rd.cargo_workspace.transitive_path_dependencies(crate)
for example in self.examples:
crate = self.rd.cargo_workspace.crate_for_example(example)
deps |= self.rd.cargo_workspace.transitive_path_dependencies(
crate, dev=True
)
return super().inputs() | set(inp for dep in deps for inp in dep.inputs())
class Image:
"""A Docker image whose build and dependencies are managed by mzbuild.
An image corresponds to a directory in a repository that contains a
`mzbuild.yml` file. This directory is called an "mzbuild context."
Attributes:
name: The name of the image.
publish: Whether the image should be pushed to Docker Hub.
depends_on: The names of the images upon which this image depends.
root: The path to the root of the associated `Repository`.
path: The path to the directory containing the `mzbuild.yml`
configuration file.
pre_images: Optional actions to perform before running `docker build`.
build_args: An optional list of --build-arg to pass to the dockerfile
"""
_DOCKERFILE_MZFROM_RE = re.compile(rb"^MZFROM\s*(\S+)")
def __init__(self, rd: RepositoryDetails, path: Path):
self.rd = rd
self.path = path
self.pre_images: list[PreImage] = []
with open(self.path / "mzbuild.yml") as f:
data = yaml.safe_load(f)
self.name: str = data.pop("name")
self.publish: bool = data.pop("publish", True)
self.description: str | None = data.pop("description", None)
self.mainline: bool = data.pop("mainline", True)
for pre_image in data.pop("pre-image", []):
typ = pre_image.pop("type", None)
if typ == "cargo-build":
self.pre_images.append(CargoBuild(self.rd, self.path, pre_image))
elif typ == "copy":
self.pre_images.append(Copy(self.rd, self.path, pre_image))
else:
raise ValueError(
f"mzbuild config in {self.path} has unknown pre-image type"
)
self.build_args = data.pop("build-args", {})
if re.search(r"[^A-Za-z0-9\-]", self.name):
raise ValueError(
f"mzbuild image name {self.name} contains invalid character; only alphanumerics and hyphens allowed"
)
self.depends_on: list[str] = []
with open(self.path / "Dockerfile", "rb") as f:
for line in f:
match = self._DOCKERFILE_MZFROM_RE.match(line)
if match:
self.depends_on.append(match.group(1).decode())
def sync_description(self) -> None:
"""Sync the description to Docker Hub if the image is publishable
and a README.md file exists."""
if not self.publish:
ui.say(f"{self.name} is not publishable")
return
readme_path = self.path / "README.md"
has_readme = readme_path.exists()
if not has_readme:
ui.say(f"{self.name} has no README.md or description")
return
docker_config = os.getenv("DOCKER_CONFIG")
spawn.runv(
[
"docker",
"pushrm",
f"--file={readme_path}",
*([f"--config={docker_config}/config.json"] if docker_config else []),
*([f"--short={self.description}"] if self.description else []),
self.docker_name(),
]
)
def docker_name(self, tag: str | None = None) -> str:
"""Return the name of the image on Docker Hub at the given tag."""
name = f"{self.rd.image_registry}/{self.rd.image_prefix}{self.name}"
if tag:
name += f":{tag}"
return name
class ResolvedImage:
"""An `Image` whose dependencies have been resolved.
Attributes:
image: The underlying `Image`.
acquired: Whether the image is available locally.
dependencies: A mapping from dependency name to `ResolvedImage` for
each of the images that `image` depends upon.
"""
def __init__(self, image: Image, dependencies: Iterable["ResolvedImage"]):
self.image = image
self.acquired = False
self.dependencies = {}
for d in dependencies:
self.dependencies[d.name] = d
def __repr__(self) -> str:
return f"ResolvedImage<{self.spec()}>"
@property
def name(self) -> str:
"""The name of the underlying image."""
return self.image.name
@property
def publish(self) -> bool:
"""Whether the underlying image should be pushed to Docker Hub."""
return self.image.publish
def spec(self) -> str:
"""Return the "spec" for the image.
A spec is the unique identifier for the image given its current
fingerprint. It is a valid Docker Hub name.
"""
return self.image.docker_name(tag=f"mzbuild-{self.fingerprint()}")
def write_dockerfile(self) -> IO[bytes]:
"""Render the Dockerfile without mzbuild directives.
Returns:
file: A handle to a temporary file containing the adjusted
Dockerfile."""
with open(self.image.path / "Dockerfile", "rb") as f:
lines = f.readlines()
f = TemporaryFile()
for line in lines:
match = Image._DOCKERFILE_MZFROM_RE.match(line)
if match:
image = match.group(1).decode()
spec = self.dependencies[image].spec()
line = Image._DOCKERFILE_MZFROM_RE.sub(b"FROM %b" % spec.encode(), line)
f.write(line)
f.seek(0)
return f
def build(self) -> None:
"""Build the image from source.
Requires that the caller has already acquired all dependencies and
prepared all `PreImage` actions via `PreImage.prepare_batch`.
"""
ui.header(f"Building {self.spec()}")
spawn.runv(["git", "clean", "-ffdX", self.image.path])
for pre_image in self.image.pre_images:
pre_image.run()
build_args = {
**self.image.build_args,
"ARCH_GCC": str(self.image.rd.arch),
"ARCH_GO": self.image.rd.arch.go_str(),
}
f = self.write_dockerfile()
cmd: Sequence[str] = [
"docker",
"build",
"-f",
"-",
*(f"--build-arg={k}={v}" for k, v in build_args.items()),
"-t",
self.spec(),
f"--platform=linux/{self.image.rd.arch.go_str()}",
str(self.image.path),
]
spawn.runv(cmd, stdin=f, stdout=sys.stderr.buffer)
def try_pull(self, max_retries: int) -> bool:
"""Download the image if it does not exist locally. Returns whether it was found."""
ui.header(f"Acquiring {self.spec()}")
if not self.acquired:
for retry in range(1, max_retries + 1):
try:
spawn.runv(
["docker", "pull", self.spec()],
stdout=sys.stderr.buffer,
)
self.acquired = True
except subprocess.CalledProcessError:
if retry < max_retries:
# There seems to be no good way to tell what error
# happened based on error code
# (https://github.com/docker/cli/issues/538) and we
# want to print output directly to terminal.
print("Retrying ...")
time.sleep(1)
continue
else:
break
return self.acquired
def is_published_if_necessary(self) -> bool:
"""Report whether the image exists on Docker Hub if it is publishable."""
if self.publish and is_docker_image_pushed(self.spec()):
ui.say(f"{self.spec()} already exists")
return True
return False
def run(self, args: list[str] = [], docker_args: list[str] = []) -> None:
"""Run a command in the image.
Creates a container from the image and runs the command described by
`args` in the image.
"""
spawn.runv(
[
"docker",
"run",
"--tty",
"--rm",
"--init",
*docker_args,
self.spec(),
*args,
]
)
def list_dependencies(self, transitive: bool = False) -> set[str]:
out = set()
for dep in self.dependencies.values():
out.add(dep.name)
if transitive:
out |= dep.list_dependencies(transitive)
return out
def inputs(self, transitive: bool = False) -> set[str]:
"""List the files tracked as inputs to the image.
These files are used to compute the fingerprint for the image. See
`ResolvedImage.fingerprint` for details.
Returns:
inputs: A list of input files, relative to the root of the
repository.
"""
paths = set(git.expand_globs(self.image.rd.root, f"{self.image.path}/**"))
if not paths:
# While we could find an `mzbuild.yml` file for this service, expland_globs didn't
# return any files that matched this service. At the very least, the `mzbuild.yml`
# file itself should have been returned. We have a bug if paths is empty.
raise AssertionError(
f"{self.image.name} mzbuild exists but its files are unknown to git"
)
for pre_image in self.image.pre_images:
paths |= pre_image.inputs()
if transitive:
for dep in self.dependencies.values():
paths |= dep.inputs(transitive)
return paths
@cache
def fingerprint(self) -> Fingerprint:
"""Fingerprint the inputs to the image.
Compute the fingerprint of the image. Changing the contents of any of
the files or adding or removing files to the image will change the
fingerprint, as will modifying the inputs to any of its dependencies.
The image considers all non-gitignored files in its mzbuild context to
be inputs. If it has a pre-image action, that action may add additional
inputs via `PreImage.inputs`.
"""
self_hash = hashlib.sha1()
for rel_path in sorted(
set(git.expand_globs(self.image.rd.root, *self.inputs()))
):
abs_path = self.image.rd.root / rel_path
file_hash = hashlib.sha1()
raw_file_mode = os.lstat(abs_path).st_mode
# Compute a simplified file mode using the same rules as Git.
# https://github.com/git/git/blob/3bab5d562/Documentation/git-fast-import.txt#L610-L616
if stat.S_ISLNK(raw_file_mode):
file_mode = 0o120000
elif raw_file_mode & stat.S_IXUSR:
file_mode = 0o100755
else:
file_mode = 0o100644
with open(abs_path, "rb") as f:
file_hash.update(f.read())
self_hash.update(file_mode.to_bytes(2, byteorder="big"))
self_hash.update(rel_path.encode())
self_hash.update(file_hash.digest())
self_hash.update(b"\0")
for pre_image in self.image.pre_images:
self_hash.update(pre_image.extra().encode())
self_hash.update(b"\0")
self_hash.update(f"arch={self.image.rd.arch}".encode())
self_hash.update(f"coverage={self.image.rd.coverage}".encode())
self_hash.update(f"sanitizer={self.image.rd.sanitizer}".encode())
full_hash = hashlib.sha1()
full_hash.update(self_hash.digest())
for dep in sorted(self.dependencies.values(), key=lambda d: d.name):
full_hash.update(dep.name.encode())
full_hash.update(dep.fingerprint())
full_hash.update(b"\0")
return Fingerprint(full_hash.digest())
class DependencySet:
"""A set of `ResolvedImage`s.
Iterating over a dependency set yields the contained images in an arbitrary
order. Indexing a dependency set yields the image with the specified name.
"""
def __init__(self, dependencies: Iterable[Image]):
"""Construct a new `DependencySet`.
The provided `dependencies` must be topologically sorted.
"""
self._dependencies: dict[str, ResolvedImage] = {}
known_images = docker_images()
for d in dependencies:
image = ResolvedImage(
image=d,
dependencies=(self._dependencies[d0] for d0 in d.depends_on),
)
image.acquired = image.spec() in known_images
self._dependencies[d.name] = image
def _prepare_batch(self, images: list[ResolvedImage]) -> None:
pre_images = collections.defaultdict(list)
for image in images:
for pre_image in image.image.pre_images:
pre_images[type(pre_image)].append(pre_image)
for cls, instances in pre_images.items():
cast(PreImage, cls).prepare_batch(instances)
def acquire(self, max_retries: int | None = None) -> None:
"""Download or build all of the images in the dependency set that do not
already exist locally.
Args:
max_retries: Number of retries on failure.
"""
# Only retry in CI runs since we struggle with flaky docker pulls there
if not max_retries:
max_retries = 3 if ui.env_is_truthy("CI") else 1
assert max_retries > 0
deps_to_build = [dep for dep in self if not dep.try_pull(max_retries)]
self._prepare_batch(deps_to_build)
for dep in deps_to_build:
dep.build()
def ensure(self, post_build: Callable[[ResolvedImage], None] | None = None):
"""Ensure all publishable images in this dependency set exist on Docker
Hub.
Images are pushed using their spec as their tag.
Args:
post_build: A callback to invoke with each dependency that was built
locally.
"""
deps_to_build = [dep for dep in self if not dep.is_published_if_necessary()]
self._prepare_batch(deps_to_build)
images_to_push = []
for dep in deps_to_build:
dep.build()
if post_build:
post_build(dep)
if dep.publish:
images_to_push.append(dep.spec())
# Push all Docker images in parallel to minimize build time.
ui.header("Pushing images")
pushes: list[subprocess.Popen] = []
for image in images_to_push:
# Piping through `cat` disables terminal control codes, and so the
# interleaved progress output from multiple pushes is less hectic.
# We don't use `docker push --quiet`, as that disables progress
# output entirely.
push = subprocess.Popen(
f"docker push {shlex.quote(image)} | cat",
shell=True,
)
pushes.append(push)
for push in pushes:
returncode = push.wait()
if returncode:
raise subprocess.CalledProcessError(returncode, push.args)
def check(self) -> bool:
"""Check all publishable images in this dependency set exist on Docker
Hub. Don't try to download or build them."""
return all(dep.is_published_if_necessary() for dep in self)
def __iter__(self) -> Iterator[ResolvedImage]:
return iter(self._dependencies.values())
def __getitem__(self, key: str) -> ResolvedImage:
return self._dependencies[key]
class Repository:
"""A collection of mzbuild `Image`s.
Creating a repository will walk the filesystem beneath `root` to
automatically discover all contained `Image`s.
Iterating over a repository yields the contained images in an arbitrary
order.
Args:
root: The path to the root of the repository.
arch: The CPU architecture to build for.
release_mode: Whether to build the repository in release mode.
coverage: Whether to enable code coverage instrumentation.
sanitizer: Whether to a sanitizer (address, thread, leak, memory, none)
image_registry: The Docker image registry to pull images from and push
images to.
image_prefix: A prefix to apply to all Docker image names.
Attributes:
images: A mapping from image name to `Image` for all contained images.
compose_dirs: The set of directories containing a `mzcompose.py` file.
"""
def __init__(
self,
root: Path,
arch: Arch = Arch.host(),
release_mode: bool = True,
coverage: bool = False,
sanitizer: Sanitizer = Sanitizer.none,
image_registry: str = "materialize",
image_prefix: str = "",
):
self.rd = RepositoryDetails(
root, arch, release_mode, coverage, sanitizer, image_registry, image_prefix
)
self.images: dict[str, Image] = {}
self.compositions: dict[str, Path] = {}
for path, dirs, files in os.walk(self.root, topdown=True):
if path == str(root / "misc"):
dirs.remove("python")
# Filter out some particularly massive ignored directories to keep
# things snappy. Not required for correctness.
dirs[:] = set(dirs) - {
".git",
".mypy_cache",
"target",
"target-ra",
"target-xcompile",
"mzdata",
"node_modules",
"venv",
}
if "mzbuild.yml" in files:
image = Image(self.rd, Path(path))
if not image.name:
raise ValueError(f"config at {path} missing name")
if image.name in self.images:
raise ValueError(f"image {image.name} exists twice")
self.images[image.name] = image
if "mzcompose.py" in files:
name = Path(path).name
if name in self.compositions:
raise ValueError(f"composition {name} exists twice")
self.compositions[name] = Path(path)
# Validate dependencies.
for image in self.images.values():
for d in image.depends_on:
if d not in self.images:
raise ValueError(
f"image {image.name} depends on non-existent image {d}"
)
@staticmethod
def install_arguments(parser: argparse.ArgumentParser) -> None:
"""Install options to configure a repository into an argparse parser.
This function installs the following options:
* The mutually-exclusive `--dev`/`--release` options to control the
`release_mode` repository attribute.
* The `--coverage` boolean option to control the `coverage` repository
attribute.
Use `Repository.from_arguments` to construct a repository from the
parsed command-line arguments.
"""
build_mode = parser.add_mutually_exclusive_group()
build_mode.add_argument(
"--dev",
dest="release",
action="store_false",
help="build Rust binaries with the dev profile",
)
build_mode.add_argument(
"--release",
action="store_true",
help="build Rust binaries with the release profile (default)",
)
parser.add_argument(
"--coverage",
help="whether to enable code coverage compilation flags",
default=ui.env_is_truthy("CI_COVERAGE_ENABLED"),
action="store_true",
)
parser.add_argument(
"--sanitizer",
help="whether to enable a sanitizer",
default=Sanitizer[os.getenv("CI_SANITIZER", "none")],
type=Sanitizer,
choices=Sanitizer,
)
parser.add_argument(
"--arch",
default=Arch.host(),
help="the CPU architecture to build for",
type=Arch,
choices=Arch,
)
parser.add_argument(
"--image-registry",
default="materialize",