pyrox.dev
1# this test creates a simple GNU image with docker tools and sees if it executes
2
3import ./make-test-python.nix ({ pkgs, ... }: {
4 name = "docker-tools";
5 meta = with pkgs.lib.maintainers; {
6 maintainers = [ lnl7 roberth ];
7 };
8
9 nodes = {
10 docker = { ... }: {
11 virtualisation = {
12 diskSize = 2048;
13 docker.enable = true;
14 };
15 };
16 };
17
18 testScript = with pkgs.dockerTools; ''
19 unix_time_second1 = "1970-01-01T00:00:01Z"
20
21 docker.wait_for_unit("sockets.target")
22
23 with subtest("includeStorePath"):
24 with subtest("assumption"):
25 docker.succeed("${examples.helloOnRoot} | docker load")
26 docker.succeed("docker run --rm hello | grep -i hello")
27 docker.succeed("docker image rm hello:latest")
28 with subtest("includeStorePath = false; breaks example"):
29 docker.succeed("${examples.helloOnRootNoStore} | docker load")
30 docker.fail("docker run --rm hello | grep -i hello")
31 docker.succeed("docker image rm hello:latest")
32 with subtest("includeStorePath = false; works with mounted store"):
33 docker.succeed("${examples.helloOnRootNoStore} | docker load")
34 docker.succeed("docker run --rm --volume ${builtins.storeDir}:${builtins.storeDir}:ro hello | grep -i hello")
35 docker.succeed("docker image rm hello:latest")
36
37 with subtest("Ensure Docker images use a stable date by default"):
38 docker.succeed(
39 "docker load --input='${examples.bash}'"
40 )
41 assert unix_time_second1 in docker.succeed(
42 "docker inspect ${examples.bash.imageName} "
43 + "| ${pkgs.jq}/bin/jq -r .[].Created",
44 )
45
46 docker.succeed("docker run --rm ${examples.bash.imageName} bash --version")
47 # Check imageTag attribute matches image
48 docker.succeed("docker images --format '{{.Tag}}' | grep -F '${examples.bash.imageTag}'")
49 docker.succeed("docker rmi ${examples.bash.imageName}")
50
51 # The remaining combinations
52 with subtest("Ensure imageTag attribute matches image"):
53 docker.succeed(
54 "docker load --input='${examples.bashNoTag}'"
55 )
56 docker.succeed(
57 "docker images --format '{{.Tag}}' | grep -F '${examples.bashNoTag.imageTag}'"
58 )
59 docker.succeed("docker rmi ${examples.bashNoTag.imageName}:${examples.bashNoTag.imageTag}")
60
61 docker.succeed(
62 "docker load --input='${examples.bashNoTagLayered}'"
63 )
64 docker.succeed(
65 "docker images --format '{{.Tag}}' | grep -F '${examples.bashNoTagLayered.imageTag}'"
66 )
67 docker.succeed("docker rmi ${examples.bashNoTagLayered.imageName}:${examples.bashNoTagLayered.imageTag}")
68
69 docker.succeed(
70 "${examples.bashNoTagStreamLayered} | docker load"
71 )
72 docker.succeed(
73 "docker images --format '{{.Tag}}' | grep -F '${examples.bashNoTagStreamLayered.imageTag}'"
74 )
75 docker.succeed(
76 "docker rmi ${examples.bashNoTagStreamLayered.imageName}:${examples.bashNoTagStreamLayered.imageTag}"
77 )
78
79 docker.succeed(
80 "docker load --input='${examples.nixLayered}'"
81 )
82 docker.succeed("docker images --format '{{.Tag}}' | grep -F '${examples.nixLayered.imageTag}'")
83 docker.succeed("docker rmi ${examples.nixLayered.imageName}")
84
85
86 with subtest(
87 "Check if the nix store is correctly initialized by listing "
88 "dependencies of the installed Nix binary"
89 ):
90 docker.succeed(
91 "docker load --input='${examples.nix}'",
92 "docker run --rm ${examples.nix.imageName} nix-store -qR ${pkgs.nix}",
93 "docker rmi ${examples.nix.imageName}",
94 )
95
96 with subtest(
97 "Ensure (layered) nix store has correct permissions "
98 "and that the container starts when its process does not have uid 0"
99 ):
100 docker.succeed(
101 "docker load --input='${examples.bashLayeredWithUser}'",
102 "docker run -u somebody --rm ${examples.bashLayeredWithUser.imageName} ${pkgs.bash}/bin/bash -c 'test 555 == $(stat --format=%a /nix) && test 555 == $(stat --format=%a /nix/store)'",
103 "docker rmi ${examples.bashLayeredWithUser.imageName}",
104 )
105
106 with subtest("The nix binary symlinks are intact"):
107 docker.succeed(
108 "docker load --input='${examples.nix}'",
109 "docker run --rm ${examples.nix.imageName} ${pkgs.bash}/bin/bash -c 'test nix == $(readlink ${pkgs.nix}/bin/nix-daemon)'",
110 "docker rmi ${examples.nix.imageName}",
111 )
112
113 with subtest("The nix binary symlinks are intact when the image is layered"):
114 docker.succeed(
115 "docker load --input='${examples.nixLayered}'",
116 "docker run --rm ${examples.nixLayered.imageName} ${pkgs.bash}/bin/bash -c 'test nix == $(readlink ${pkgs.nix}/bin/nix-daemon)'",
117 "docker rmi ${examples.nixLayered.imageName}",
118 )
119
120 with subtest("The pullImage tool works"):
121 docker.succeed(
122 "docker load --input='${examples.testNixFromDockerHub}'",
123 "docker run --rm nix:2.2.1 nix-store --version",
124 "docker rmi nix:2.2.1",
125 )
126
127 with subtest("runAsRoot and entry point work"):
128 docker.succeed(
129 "docker load --input='${examples.nginx}'",
130 "docker run --name nginx -d -p 8000:80 ${examples.nginx.imageName}",
131 )
132 docker.wait_until_succeeds("curl -f http://localhost:8000/")
133 docker.succeed(
134 "docker rm --force nginx",
135 "docker rmi '${examples.nginx.imageName}'",
136 )
137
138 with subtest("A pulled image can be used as base image"):
139 docker.succeed(
140 "docker load --input='${examples.onTopOfPulledImage}'",
141 "docker run --rm ontopofpulledimage hello",
142 "docker rmi ontopofpulledimage",
143 )
144
145 with subtest("Regression test for issue #34779"):
146 docker.succeed(
147 "docker load --input='${examples.runAsRootExtraCommands}'",
148 "docker run --rm runasrootextracommands cat extraCommands",
149 "docker run --rm runasrootextracommands cat runAsRoot",
150 "docker rmi '${examples.runAsRootExtraCommands.imageName}'",
151 )
152
153 with subtest("Ensure Docker images can use an unstable date"):
154 docker.succeed(
155 "docker load --input='${examples.unstableDate}'"
156 )
157 assert unix_time_second1 not in docker.succeed(
158 "docker inspect ${examples.unstableDate.imageName} "
159 + "| ${pkgs.jq}/bin/jq -r .[].Created"
160 )
161
162 with subtest("Ensure Layered Docker images can use an unstable date"):
163 docker.succeed(
164 "docker load --input='${examples.unstableDateLayered}'"
165 )
166 assert unix_time_second1 not in docker.succeed(
167 "docker inspect ${examples.unstableDateLayered.imageName} "
168 + "| ${pkgs.jq}/bin/jq -r .[].Created"
169 )
170
171 with subtest("Ensure Layered Docker images work"):
172 docker.succeed(
173 "docker load --input='${examples.layered-image}'",
174 "docker run --rm ${examples.layered-image.imageName}",
175 "docker run --rm ${examples.layered-image.imageName} cat extraCommands",
176 )
177
178 with subtest("Ensure images built on top of layered Docker images work"):
179 docker.succeed(
180 "docker load --input='${examples.layered-on-top}'",
181 "docker run --rm ${examples.layered-on-top.imageName}",
182 )
183
184 with subtest("Ensure layered images built on top of layered Docker images work"):
185 docker.succeed(
186 "docker load --input='${examples.layered-on-top-layered}'",
187 "docker run --rm ${examples.layered-on-top-layered.imageName}",
188 )
189
190
191 def set_of_layers(image_name):
192 return set(
193 docker.succeed(
194 f"docker inspect {image_name} "
195 + "| ${pkgs.jq}/bin/jq -r '.[] | .RootFS.Layers | .[]'"
196 ).split()
197 )
198
199
200 with subtest("Ensure layers are shared between images"):
201 docker.succeed(
202 "docker load --input='${examples.another-layered-image}'"
203 )
204 layers1 = set_of_layers("${examples.layered-image.imageName}")
205 layers2 = set_of_layers("${examples.another-layered-image.imageName}")
206 assert bool(layers1 & layers2)
207
208 with subtest("Ensure order of layers is correct"):
209 docker.succeed(
210 "docker load --input='${examples.layersOrder}'"
211 )
212
213 for index in 1, 2, 3:
214 assert f"layer{index}" in docker.succeed(
215 f"docker run --rm ${examples.layersOrder.imageName} cat /tmp/layer{index}"
216 )
217
218 with subtest("Ensure environment variables are correctly inherited"):
219 docker.succeed(
220 "docker load --input='${examples.environmentVariables}'"
221 )
222 out = docker.succeed("docker run --rm ${examples.environmentVariables.imageName} env")
223 env = out.splitlines()
224 assert "FROM_PARENT=true" in env, "envvars from the parent should be preserved"
225 assert "FROM_CHILD=true" in env, "envvars from the child should be preserved"
226 assert "LAST_LAYER=child" in env, "envvars from the child should take priority"
227
228 with subtest("Ensure environment variables of layered images are correctly inherited"):
229 docker.succeed(
230 "docker load --input='${examples.environmentVariablesLayered}'"
231 )
232 out = docker.succeed("docker run --rm ${examples.environmentVariablesLayered.imageName} env")
233 env = out.splitlines()
234 assert "FROM_PARENT=true" in env, "envvars from the parent should be preserved"
235 assert "FROM_CHILD=true" in env, "envvars from the child should be preserved"
236 assert "LAST_LAYER=child" in env, "envvars from the child should take priority"
237
238 with subtest(
239 "Ensure inherited environment variables of layered images are correctly resolved"
240 ):
241 # Read environment variables as stored in image config
242 config = docker.succeed(
243 "tar -xOf ${examples.environmentVariablesLayered} manifest.json | ${pkgs.jq}/bin/jq -r .[].Config"
244 ).strip()
245 out = docker.succeed(
246 f"tar -xOf ${examples.environmentVariablesLayered} {config} | ${pkgs.jq}/bin/jq -r '.config.Env | .[]'"
247 )
248 env = out.splitlines()
249 assert (
250 sum(entry.startswith("LAST_LAYER") for entry in env) == 1
251 ), "envvars overridden by child should be unique"
252
253 with subtest("Ensure image with only 2 layers can be loaded"):
254 docker.succeed(
255 "docker load --input='${examples.two-layered-image}'"
256 )
257
258 with subtest(
259 "Ensure the bulk layer doesn't miss store paths (regression test for #78744)"
260 ):
261 docker.succeed(
262 "docker load --input='${pkgs.dockerTools.examples.bulk-layer}'",
263 # Ensure the two output paths (ls and hello) are in the layer
264 "docker run bulk-layer ls /bin/hello",
265 )
266
267 with subtest(
268 "Ensure the bulk layer with a base image respects the number of maxLayers"
269 ):
270 docker.succeed(
271 "docker load --input='${pkgs.dockerTools.examples.layered-bulk-layer}'",
272 # Ensure the image runs correctly
273 "docker run layered-bulk-layer ls /bin/hello",
274 )
275
276 # Ensure the image has the correct number of layers
277 assert len(set_of_layers("layered-bulk-layer")) == 4
278
279 with subtest("Ensure correct behavior when no store is needed"):
280 # This check tests that buildLayeredImage can build images that don't need a store.
281 docker.succeed(
282 "docker load --input='${pkgs.dockerTools.examples.no-store-paths}'"
283 )
284
285 # This check may be loosened to allow an *empty* store rather than *no* store.
286 docker.succeed("docker run --rm no-store-paths ls /")
287 docker.fail("docker run --rm no-store-paths ls /nix/store")
288
289 with subtest("Ensure buildLayeredImage does not change store path contents."):
290 docker.succeed(
291 "docker load --input='${pkgs.dockerTools.examples.filesInStore}'",
292 "docker run --rm file-in-store nix-store --verify --check-contents",
293 "docker run --rm file-in-store |& grep 'some data'",
294 )
295
296 with subtest("Ensure cross compiled image can be loaded and has correct arch."):
297 docker.succeed(
298 "docker load --input='${pkgs.dockerTools.examples.cross}'",
299 )
300 assert (
301 docker.succeed(
302 "docker inspect ${pkgs.dockerTools.examples.cross.imageName} "
303 + "| ${pkgs.jq}/bin/jq -r .[].Architecture"
304 ).strip()
305 == "${if pkgs.system == "aarch64-linux" then "amd64" else "arm64"}"
306 )
307
308 with subtest("buildLayeredImage doesn't dereference /nix/store symlink layers"):
309 docker.succeed(
310 "docker load --input='${examples.layeredStoreSymlink}'",
311 "docker run --rm ${examples.layeredStoreSymlink.imageName} bash -c 'test -L ${examples.layeredStoreSymlink.passthru.symlink}'",
312 "docker rmi ${examples.layeredStoreSymlink.imageName}",
313 )
314
315 with subtest("buildImage supports registry/ prefix in image name"):
316 docker.succeed(
317 "docker load --input='${examples.prefixedImage}'"
318 )
319 docker.succeed(
320 "docker images --format '{{.Repository}}' | grep -F '${examples.prefixedImage.imageName}'"
321 )
322
323 with subtest("buildLayeredImage supports registry/ prefix in image name"):
324 docker.succeed(
325 "docker load --input='${examples.prefixedLayeredImage}'"
326 )
327 docker.succeed(
328 "docker images --format '{{.Repository}}' | grep -F '${examples.prefixedLayeredImage.imageName}'"
329 )
330
331 with subtest("buildLayeredImage supports running chown with fakeRootCommands"):
332 docker.succeed(
333 "docker load --input='${examples.layeredImageWithFakeRootCommands}'"
334 )
335 docker.succeed(
336 "docker run --rm ${examples.layeredImageWithFakeRootCommands.imageName} sh -c 'stat -c '%u' /home/jane | grep -E ^1000$'"
337 )
338
339 with subtest("Ensure docker load on merged images loads all of the constituent images"):
340 docker.succeed(
341 "docker load --input='${examples.mergedBashAndRedis}'"
342 )
343 docker.succeed(
344 "docker images --format '{{.Repository}}-{{.Tag}}' | grep -F '${examples.bash.imageName}-${examples.bash.imageTag}'"
345 )
346 docker.succeed(
347 "docker images --format '{{.Repository}}-{{.Tag}}' | grep -F '${examples.redis.imageName}-${examples.redis.imageTag}'"
348 )
349 docker.succeed("docker run --rm ${examples.bash.imageName} bash --version")
350 docker.succeed("docker run --rm ${examples.redis.imageName} redis-cli --version")
351 docker.succeed("docker rmi ${examples.bash.imageName}")
352 docker.succeed("docker rmi ${examples.redis.imageName}")
353
354 with subtest(
355 "Ensure docker load on merged images loads all of the constituent images (missing tags)"
356 ):
357 docker.succeed(
358 "docker load --input='${examples.mergedBashNoTagAndRedis}'"
359 )
360 docker.succeed(
361 "docker images --format '{{.Repository}}-{{.Tag}}' | grep -F '${examples.bashNoTag.imageName}-${examples.bashNoTag.imageTag}'"
362 )
363 docker.succeed(
364 "docker images --format '{{.Repository}}-{{.Tag}}' | grep -F '${examples.redis.imageName}-${examples.redis.imageTag}'"
365 )
366 # we need to explicitly specify the generated tag here
367 docker.succeed(
368 "docker run --rm ${examples.bashNoTag.imageName}:${examples.bashNoTag.imageTag} bash --version"
369 )
370 docker.succeed("docker run --rm ${examples.redis.imageName} redis-cli --version")
371 docker.succeed("docker rmi ${examples.bashNoTag.imageName}:${examples.bashNoTag.imageTag}")
372 docker.succeed("docker rmi ${examples.redis.imageName}")
373
374 with subtest("mergeImages preserves owners of the original images"):
375 docker.succeed(
376 "docker load --input='${examples.mergedBashFakeRoot}'"
377 )
378 docker.succeed(
379 "docker run --rm ${examples.layeredImageWithFakeRootCommands.imageName} sh -c 'stat -c '%u' /home/jane | grep -E ^1000$'"
380 )
381
382 with subtest("exportImage produces a valid tarball"):
383 docker.succeed(
384 "tar -tf ${examples.exportBash} | grep '\./bin/bash' > /dev/null"
385 )
386
387 with subtest("Ensure bare paths in contents are loaded correctly"):
388 docker.succeed(
389 "docker load --input='${examples.build-image-with-path}'",
390 "docker run --rm build-image-with-path bash -c '[[ -e /hello.txt ]]'",
391 "docker rmi build-image-with-path",
392 )
393 docker.succeed(
394 "${examples.layered-image-with-path} | docker load",
395 "docker run --rm layered-image-with-path bash -c '[[ -e /hello.txt ]]'",
396 "docker rmi layered-image-with-path",
397 )
398
399 '';
400})