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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
|
load ../common
# shellcheck disable=SC2034
tag=cache
# WARNING: Git timestamp precision is only one second [1]. This can cause
# unstable sorting within --tree output because the tests commit very fast. If
# it matters, add a “sleep 1”.
#
# [1]: https://stackoverflow.com/questions/28237043
treeonly () {
# Remove (1) everything including and after first blank line and (2)
# trailing whitespace on each line.
sed -E -e '/^$/Q' -e 's/\s+$//'
}
setup () {
scope standard
[[ $CH_TEST_BUILDER = ch-image ]] || skip 'ch-image only'
[[ $CH_IMAGE_CACHE = enabled ]] || skip 'build cache enabled only'
export CH_IMAGE_STORAGE=$BATS_TMPDIR/butest # don’t mess up main storage
dot_base=$BATS_TMPDIR/bu_
ch-image gestalt bucache-dot
}
### Test cases for build cache paper figures (DOI: 10.1145/3624062.3624585) ###
# Not all of these ended up as figures in the published paper, but I’m leaving
# them here because they were targeted to the paper and were used in some
# versions. If they are in the published paper, the figure number is noted.
@test "${tag}: Fig. 2: empty cache" {
rm -Rf --one-file-system "$CH_IMAGE_STORAGE"
blessed_tree=$(cat << EOF
initializing storage directory: v7 ${CH_IMAGE_STORAGE}
initializing empty build cache
* (root) ROOT
EOF
)
run ch-image build-cache --tree --dot="${dot_base}empty"
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_tree") <(echo "$output" | treeonly)
}
@test "${tag}: Fig. 3: initial pull" {
ch-image pull alpine:3.17
blessed_tree=$(cat << 'EOF'
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree --dot="${dot_base}initial-pull"
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_tree") <(echo "$output" | treeonly)
}
@test "${tag}: FROM" {
# FROM pulls
ch-image build-cache --reset
run ch-image build -v -t d -f bucache/from.df .
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'1. FROM alpine:3.17'* ]]
blessed_tree=$(cat << 'EOF'
* (d, alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree --dot="${dot_base}from"
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_tree") <(echo "$output" | treeonly)
# FROM doesn’t pull (same target name)
run ch-image build -v -t d -f bucache/from.df .
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'1* FROM alpine:3.17'* ]]
blessed_tree=$(cat << 'EOF'
* (d, alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_tree") <(echo "$output" | treeonly)
# FROM doesn’t pull (different target name)
run ch-image build -v -t d2 -f bucache/from.df .
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'1* FROM alpine:3.17'* ]]
blessed_tree=$(cat << 'EOF'
* (d2, d, alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_tree") <(echo "$output" | treeonly)
}
@test "${tag}: Fig. 4: a.df" {
ch-image build-cache --reset
ch-image build -t a -f bucache/a.df .
blessed_out=$(cat << 'EOF'
* (a) RUN.S echo bar
* RUN.S echo foo
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree --dot="${dot_base}a"
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: Fig. 5: b.df" {
ch-image build-cache --reset
ch-image build -t a -f bucache/a.df .
ch-image build -t b -f bucache/b.df .
blessed_out=$(cat << 'EOF'
* (b) RUN.S echo baz
* (a) RUN.S echo bar
* RUN.S echo foo
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree --dot="${dot_base}b"
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: Fig. 6: c.df" {
ch-image build-cache --reset
ch-image build -t a -f bucache/a.df .
ch-image build -t b -f bucache/b.df .
sleep 1
ch-image build -t c -f bucache/c.df .
blessed_out=$(cat << 'EOF'
* (c) RUN.S echo qux
| * (b) RUN.S echo baz
| * (a) RUN.S echo bar
|/
* RUN.S echo foo
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree --dot="${dot_base}c"
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: rebuild a.df" {
# Forcing a rebuild show produce a new pair of FOO and BAR commits from
# from the alpine branch.
blessed_out=$(cat << 'EOF'
* (a) RUN.S echo bar
* RUN.S echo foo
| * (c) RUN.S echo qux
| | * (b) RUN.S echo baz
| | * RUN.S echo bar
| |/
| * RUN.S echo foo
|/
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
ch-image --rebuild build -t a -f bucache/a.df .
run ch-image build-cache --tree
[[ $status -eq 0 ]]
echo "$output"
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: rebuild b.df" {
# Rebuild of B. Since A was rebuilt in the last test, and because
# the rebuild behavior only forces misses on non-FROM instructions, it
# should now be based on A's new commits.
blessed_out=$(cat << 'EOF'
* (b) RUN.S echo baz
* (a) RUN.S echo bar
* RUN.S echo foo
| * (c) RUN.S echo qux
| | * RUN.S echo baz
| | * RUN.S echo bar
| |/
| * RUN.S echo foo
|/
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
ch-image --rebuild build -t b -f bucache/b.df .
run ch-image build-cache --tree
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: c.df" {
# Rebuild C. Since C doesn’t reference img_a (like img_b does) rebuilding
# causes a miss on FOO. Thus C makes new FOO and QUX commits.
#
# Shouldn’t FOO hit? --reidpr 2/16
# - No! Rebuild forces misses; since c.df has it’s own FOO it should miss.
# --jogas 2/24
blessed_out=$(cat << 'EOF'
* (c) RUN.S echo qux
* RUN.S echo foo
| * (b) RUN.S echo baz
| * (a) RUN.S echo bar
| * RUN.S echo foo
|/
| * RUN.S echo qux
| | * RUN.S echo baz
| | * RUN.S echo bar
| |/
| * RUN.S echo foo
|/
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
# avoid race condition
sleep 1
ch-image --rebuild build -t c -f bucache/c.df .
run ch-image build-cache --tree
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: Fig. 7: change then revert" {
ch-image build-cache --reset
ch-image build -t e -f bucache/a.df .
# “change” by using a different Dockerfile
sleep 1
ch-image build -t e -f bucache/c.df .
blessed_out=$(cat << 'EOF'
* (e) RUN.S echo qux
| * RUN.S echo bar
|/
* RUN.S echo foo
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree --dot="${dot_base}revert1"
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
# “revert change”; no need to check for miss b/c it will show up in graph
ch-image build -t e -f bucache/a.df .
blessed_out=$(cat << 'EOF'
* RUN.S echo qux
| * (e) RUN.S echo bar
|/
* RUN.S echo foo
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree --dot="${dot_base}revert2"
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: two pulls, same" {
ch-image build-cache --reset
ch-image pull alpine:3.17
ch-image pull alpine:3.17
blessed_out=$(cat << 'EOF'
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: two pulls, different" {
localregistry_init
unset CH_IMAGE_AUTH # don’t give local creds to Docker Hub
# Simulate a change in an image from a remote repo; ensure that “ch-image
# pull” downloads the next image. Note ch-image pull behavior is the same
# with or without the build cache. This test is here for two reasons:
#
# 1. The build cache interactions with pull is more complex, i.e., we
# assume that if pull works here with the cache enabled, it also
# works without it.
#
# 2. We emit debugging PDFs for use in the paper, and doing that
# anywhere else would be too surprising.
df_ours=$(cat <<'EOF'
FROM localhost:5000/champ
RUN cat /worldchampion
EOF
)
tree_ours_before=$(cat <<'EOF'
* (wc) RUN.S cat /worldchampion
* (localhost+5000%champ) PULL localhost:5000/champ
* (root) ROOT
EOF
)
echo
echo '*** Prepare “ours” and “theirs” storages.'
so=$BATS_TMPDIR/pull-local
st=$BATS_TMPDIR/pull-remote
rm -Rf --one-file-system "$so" "$st"
echo
echo '*** Them: Create the initial image state.'
ch-image -s "$st" build -v -t capablanca -f - . <<EOF
FROM alpine:3.17
RUN echo josé > /worldchampion
EOF
ch-image -s "$st" --auth --tls-no-verify \
push capablanca localhost:5000/champ
echo '*** Us: Build image using theirs as base.'
# Both download and build caches are cold; FROM will do a (lazy) pull.
# Files should be downloaded and all instructions should miss. Then do it
# again; nothing should download and it should be all hits.
run ch-image -s "$so" --auth --tls-no-verify \
build -t wc -f <(echo "$df_ours") /tmp
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'. FROM'* ]]
[[ $output = *'manifest list: downloading'* ]]
[[ $output != *'manifest: downloading'* ]]
[[ $output = *'config: downloading'* ]]
[[ $output = *'. RUN.S'* ]]
run ch-image -s "$so" --tls-no-verify build -t wc -f <(echo "$df_ours") /tmp
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output != *'manifest list: downloading'* ]]
[[ $output != *'manifest: downloading'* ]]
[[ $output != *'config: downloading'* ]]
[[ $output = *'* RUN.S'* ]]
run ch-image -s "$so" build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$tree_ours_before") <(echo "$output" | treeonly)
echo
echo '*** Us: explicit (eager) pull.'
# This should download the manifest list and manifest, see that there are
# no changes, and not download the config or layers.
run ch-image -s "$so" --auth --tls-no-verify pull localhost:5000/champ
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'manifest list: downloading'* ]]
[[ $output != *'manifest: downloading'* ]]
[[ $output = *'config: using existing file'* ]]
[[ $output = *'layer'*'using existing file'* ]]
run ch-image -s "$so" build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$tree_ours_before") <(echo "$output" | treeonly)
echo
echo '*** Them: Change and push the image.'
ch-image -s "$st" build -t fischer -f - . <<EOF
FROM alpine:3.17
RUN echo "bobby" > /worldchampion
EOF
ch-image -s "$st" --auth --tls-no-verify push fischer localhost:5000/champ
echo
echo '*** Us: Rebuild our image (lazy pull does not update).'
# FROM should not notice the updated remote image.
run ch-image -s "$so" --tls-no-verify build -t wc -f <(echo "$df_ours") /tmp
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output != *'manifest list: downloading'* ]]
[[ $output != *'manifest: downloading'* ]]
[[ $output != *'config: downloading'* ]]
[[ $output = *'* RUN.S'* ]]
run ch-image -s "$so" build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$tree_ours_before") <(echo "$output" | treeonly)
echo
echo '*** Us: Explicitly pull updated image.'
# Returned config hash should differ from what is in storage; thus, the
# new layer(s) should be pulled and the image branch in the cache updated.
run ch-image -s "$so" --auth --tls-no-verify pull localhost:5000/champ
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'manifest list: downloading'* ]]
[[ $output != *'manifest: downloading'* ]]
[[ $output = *'config: downloading'* ]]
[[ $output = *'layer'*'downloading:'*'100%'* ]]
run ch-image -s "$so" build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u - <(echo "$output" | treeonly) <<'EOF'
* (localhost+5000%champ) PULL localhost:5000/champ
| * (wc) RUN.S cat /worldchampion
| * PULL localhost:5000/champ
|/
* (root) ROOT
EOF
echo
echo '*** Us: Rebuild our image (uses updated image).'
# After the eager pull above, the base image exists in storage. Thus, the
# FROM instruction hits; however, the resulting SID differs from the
# original. Thus, instructions after FROM should miss.
run ch-image -s "$so" --tls-no-verify build -t wc -f <(echo "$df_ours") /tmp
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output != *'manifest list: downloading'* ]]
[[ $output != *'manifest: downloading'* ]]
[[ $output != *'config: using existing file'* ]]
[[ $output = *'. RUN.S'* ]]
run ch-image -s "$so" build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u - <(echo "$output" | treeonly) <<'EOF'
* (wc) RUN.S cat /worldchampion
* (localhost+5000%champ) PULL localhost:5000/champ
| * RUN.S cat /worldchampion
| * PULL localhost:5000/champ
|/
* (root) ROOT
EOF
}
# FIXME: for issue #1359, add test here where they revert the image in the
# remote registry to a previous state; our next pull will hit, and so too
# should any subsequent previously cached instructions based on the FROM SID.
@test "${tag}: branch ready" {
ch-image build-cache --reset
# Build A as “foo”.
ch-image build -t foo -f bucache/a.df ./bucache
# Rebuild A, except this is a broken version; the second instruction fails
# leaving the new branch in a not-ready state pointing to “echo foo”.
# The old branch remains.
run ch-image build -t foo -f ./bucache/a-fail.df ./bucache
sleep 1
echo "$output"
[[ $status -eq 1 ]]
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
blessed_out=$(cat << 'EOF'
* (foo) RUN.S echo bar
* (foo#) RUN.S echo foo
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
# Build C as “foo”. Now branch “foo” points to the completed build of the
# new Dockerfile, and the not-ready branch is gone.
ch-image build -t foo -f ./bucache/c.df ./bucache
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
blessed_out=$(cat << 'EOF'
* (foo) RUN.S echo qux
| * RUN.S echo bar
|/
* RUN.S echo foo
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: --force" {
ch-image build-cache --reset
# First build, without --force.
ch-image build --force=none -t force -f ./bucache/force.df ./bucache
# Second build, with --force. This should diverge after the first WORKDIR.
sleep 1
ch-image build --force=seccomp -t force -f ./bucache/force.df ./bucache
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u - <(echo "$output" | treeonly) <<'EOF'
* (force) WORKDIR /usr
* RUN.S dnf install -y ed # doesn’t need --force
| * WORKDIR /usr
| * RUN.N dnf install -y ed # doesn’t need --force
|/
* WORKDIR /
* (almalinux+8) PULL almalinux:8
* (root) ROOT
EOF
# Third build, without --force. This should re-use the first build.
sleep 1
ch-image build --force=none -t force -f ./bucache/force.df ./bucache
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u - <(echo "$output" | treeonly) <<'EOF'
* WORKDIR /usr
* RUN.S dnf install -y ed # doesn’t need --force
| * (force) WORKDIR /usr
| * RUN.N dnf install -y ed # doesn’t need --force
|/
* WORKDIR /
* (almalinux+8) PULL almalinux:8
* (root) ROOT
EOF
}
@test "${tag}: Fig. 8: rebuild" {
ch-image build-cache --reset
# Build. Mode should not matter here, but we use enabled because that’s
# more lifelike.
ch-image build -t a -f ./bucache/a.df ./bucache
# Re-build in “rebuild” mode. FROM should hit, others miss, and we should
# have two branches.
sleep 1
run ch-image build --rebuild -t a -f ./bucache/a.df ./bucache
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'. RUN.S echo foo'* ]]
[[ $output = *'. RUN.S echo bar'* ]]
blessed_out=$(cat << 'EOF'
* (a) RUN.S echo bar
* RUN.S echo foo
| * RUN.S echo bar
| * RUN.S echo foo
|/
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree --dot="${dot_base}rebuild"
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
# Re-build again in “rebuild” mode. The branch pointer should move to the
# newer execution.
run ch-image build-cache -v --tree
echo "$output"
[[ $status -eq 0 ]]
commit_before=$(echo "$output" | sed -En 's/^.+\(a\) ([0-9a-f]+).+$/\1/p')
echo "before: ${commit_before}"
sleep 1
ch-image build --rebuild -t a -f ./bucache/a.df ./bucache
run ch-image build-cache -v --tree
echo "$output"
[[ $status -eq 0 ]]
commit_after=$(echo "$output" | sed -En 's/^.+\(a\) ([0-9a-f]+).+$/\1/p')
echo "after: ${commit_after}"
[[ $commit_before != "$commit_after" ]]
}
### Additional test cases for correctness ###
@test "${tag}: reset" {
# re-init
run ch-image build-cache --reset
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'deleting build cache'* ]]
[[ $output = *'initializing empty build cache'* ]]
# fail if build cache disabled
run ch-image build-cache --no-cache --reset
[[ $status -eq 1 ]]
echo "$output"
[[ $output = *'build-cache subcommand invalid with build cache disabled'* ]]
}
@test "${tag}: gc" {
ch-image build-cache --reset
# Initial number of commits.
diff -u <( ch-image build-cache \
| grep "commits" | awk '{print $2}') <(echo 1)
# Number of commits after A.
ch-image build -t a -f ./bucache/a.df .
diff -u <( ch-image build-cache \
| grep "commits" | awk '{print $2}') <(echo 4)
# Number of commits after 2x forced rebuilds of A (4 dangling)
ch-image build --rebuild -t a -f ./bucache/a.df .
ch-image build --rebuild -t a -f ./bucache/a.df .
diff -u <( ch-image build-cache \
| grep "commits" | awk '{print $2}') <(echo 8)
# Number of commits after garbage collecting.
ch-image build-cache --tree
ch-image build-cache --gc
diff -u <( ch-image build-cache \
| grep "commits" | awk '{print $2}') <(echo 4)
ch-image build-cache --tree
}
@test "${tag}: ARG and ENV" {
ch-image build-cache --reset
# Build.
run ch-image build -t ae1 -f ./bucache/argenv.df ./bucache
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'1 vargA vargBvargA venvA venvBvargA'* ]]
# Rebuild; this should hit and print the correct values.
run ch-image build -t ae1 -f ./bucache/argenv.df ./bucache
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'5* RUN.S'* ]]
# Re-build, with partial hits. ARG and ENV from first build should pass
# through with correct values.
sleep 1
run ch-image build -t ae2 -f ./bucache/argenv2.df ./bucache
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'2 vargA vargBvargA venvA venvBvargA'* ]]
# Re-build, setting ARG from the command line. This should miss.
sleep 1
run ch-image build --build-arg=argB=foo \
-t ae3 -f ./bucache/argenv.df ./bucache
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *"3. ARG argB='foo'"* ]]
# Re-build, setting ARG from the command line to the same. Should hit.
sleep 1
run ch-image build --build-arg=argB=foo \
-t ae4 -f ./bucache/argenv.df ./bucache
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *"3* ARG argB='foo'"* ]]
# Re-build, setting ARG from the command line to thing different. Miss.
sleep 1
run ch-image build --build-arg=argB=bar \
-t ae5 -f ./bucache/argenv.df ./bucache
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *"3. ARG argB='bar'"* ]]
[[ $output = *'1 vargA bar venvA venvB'* ]]
# Check for expected tree.
run ch-image build-cache --tree --dot="${dot_base}argenv"
echo "$output"
[[ $status -eq 0 ]]
blessed_out=$(cat << 'EOF'
* (ae5) RUN.S echo 1 $argA $argB $envA $envB
* ENV envB='venvBvargA'
* ENV envA='venvA'
* ARG argB='bar'
| * (ae4, ae3) RUN.S echo 1 $argA $argB $envA $envB
| * ENV envB='venvBvargA'
| * ENV envA='venvA'
| * ARG argB='foo'
|/
| * (ae2) RUN.S echo 2 $argA $argB $envA $envB
| | * (ae1) RUN.S echo 1 $argA $argB $envA $envB
| |/
| * ENV envB='venvBvargA'
| * ENV envA='venvA'
| * ARG argB='vargBvargA'
|/
* ARG argA='vargA'
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: ARG special variables" {
ch-image build-cache --reset
unset SSH_AUTH_SOCK
# Build. Should miss.
run ch-image build -t foo -f ./bucache/argenv-special.df ./bucache
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'1. FROM'* ]]
[[ $output = *'2. ARG'* ]]
[[ $output = *'3. ARG'* ]]
[[ $output = *'4. RUN.S'* ]]
[[ $output = *'vargA sockA'* ]]
# Re-build. All hits.
run ch-image build -t foo -f ./bucache/argenv-special.df ./bucache
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'1* FROM'* ]]
[[ $output = *'2* ARG'* ]]
[[ $output = *'3* ARG'* ]]
[[ $output = *'4* RUN.S'* ]]
[[ $output != *'vargA sockA'* ]]
# Re-build with new value from command line. All hits again.
run ch-image build --build-arg=SSH_AUTH_SOCK=sockB \
-t foo -f ./bucache/argenv-special.df ./bucache
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'1* FROM'* ]]
[[ $output = *'2* ARG'* ]]
[[ $output = *'3* ARG'* ]]
[[ $output = *'4* RUN.S'* ]]
[[ $output != *'vargA sockA'* ]]
[[ $output != *'vargA sockB'* ]]
}
@test "${tag}: COPY" {
ch-image build-cache --reset
# Prepare fixtures. These need various manipulating during the test, which
# is why they're built here on the fly.
fixtures=${BATS_TMPDIR}/copy-cache
mkdir -p "$fixtures"
echo hello > "$fixtures"/file1
rm -f "$fixtures"/file1a
mkdir -p "$fixtures"/dir1
touch "$fixtures"/dir1/file1 "$fixtures"/dir1/file2
printf '\n*** Build; all misses.\n\n'
run ch-image build -t foo -f ./bucache/copy.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'. FROM'* ]]
[[ $output = *'. COPY'* ]]
printf '\n*** Re-build; all hits.\n\n'
run ch-image build -t foo -f ./bucache/copy.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* COPY'* ]]
printf '\n*** Add remove file in directory; should miss b/c dir mtime.\n\n'
touch "$fixtures"/dir1/file2
rm "$fixtures"/dir1/file2
run ch-image build -t foo -f ./bucache/copy.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'. COPY'* ]]
printf '\n*** Re-build; all hits.\n\n'
run ch-image build -t foo -f ./bucache/copy.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* COPY'* ]]
printf '\n*** Touch file; should miss because file mtime.\n\n'
touch "$fixtures"/file1
run ch-image build -t foo -f ./bucache/copy.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'. COPY'* ]]
printf '\n*** Re-build; all hits.\n\n'
run ch-image build -t foo -f ./bucache/copy.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* COPY'* ]]
printf '\n*** Rename file; should miss because filename.\n\n'
mv "$fixtures"/file1 "$fixtures"/file1a
run ch-image build -t foo -f ./bucache/copy.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'. COPY'* ]]
printf '\n*** Re-build; all hits.\n\n'
run ch-image build -t foo -f ./bucache/copy.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* COPY'* ]]
printf '\n*** Rename file back; all hits.\n\n'
stat "$fixtures"/file1a
mv "$fixtures"/file1a "$fixtures"/file1
stat "$fixtures"/file1
run ch-image build -t foo -f ./bucache/copy.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* COPY'* ]]
printf '\n*** Update content, same length, reset mtime; all hits.\n\n'
cat "$fixtures"/file1
stat "$fixtures"/file1
mtime=$(stat -c %y "$fixtures"/file1)
echo world > "$fixtures"/file1
touch -d "$mtime" "$fixtures"/file1
cat "$fixtures"/file1
stat "$fixtures"/file1
run ch-image build -t foo -f ./bucache/copy.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* COPY'* ]]
}
@test "${tag}: FROM non-cached base image" {
ch-image build-cache --reset
# Pull base image w/o cache.
ch-image pull --no-cache alpine:3.17
[[ ! -e $CH_IMAGE_STORAGE/img/alpine+3.17/.git ]]
# Build child image.
run ch-image build -t foo - <<'EOF'
FROM alpine:3.17
RUN echo foo
EOF
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'. FROM'* ]]
[[ $output = *'base image only exists non-cached; adding to cache'* ]]
[[ $output = *'. RUN.S'* ]]
# Check tree.
blessed_out=$(cat << 'EOF'
* (foo) RUN.S echo foo
* (alpine+3.17) IMPORT alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: RSYNC" {
ch-image build-cache --reset
# Prepare fixtures. These need various manipulating during the test, which
# is why they’re built here on the fly.
fixtures=${BATS_TMPDIR}/rsync-cache
rm -Rf --one-file-system "$fixtures"
mkdir "$fixtures"
echo hello > "$fixtures"/file1
mkdir "$fixtures"/dir1
touch "$fixtures"/dir1/file1 "$fixtures"/dir1/file2
printf '\n*** Build; all misses.\n\n'
run ch-image build -f ./bucache/rsync.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'. FROM'* ]]
[[ $output = *'. RSYNC'* ]]
printf '\n*** Re-build; all hits.\n\n'
run ch-image build -f ./bucache/rsync.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* RSYNC'* ]]
printf '\n*** Add remove file in directory; should miss b/c dir mtime.\n\n'
touch "$fixtures"/dir1/file2
rm "$fixtures"/dir1/file2
run ch-image build -f ./bucache/rsync.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'. RSYNC'* ]]
printf '\n*** Re-build; all hits.\n\n'
run ch-image build -f ./bucache/rsync.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* RSYNC'* ]]
printf '\n*** Touch file; should miss because file mtime.\n\n'
touch "$fixtures"/file1
run ch-image build -f ./bucache/rsync.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'. RSYNC'* ]]
printf '\n*** Re-build; all hits.\n\n'
run ch-image build -f ./bucache/rsync.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* RSYNC'* ]]
printf '\n*** Rename file; should miss because filename.\n\n'
mv "$fixtures"/file1 "$fixtures"/file1a
run ch-image build -f ./bucache/rsync.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'. RSYNC'* ]]
printf '\n*** Re-build; all hits.\n\n'
run ch-image build -f ./bucache/rsync.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* RSYNC'* ]]
printf '\n*** Rename file back; all hits.\n\n'
stat "$fixtures"/file1a
mv "$fixtures"/file1a "$fixtures"/file1
stat "$fixtures"/file1
run ch-image build -f ./bucache/rsync.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* RSYNC'* ]]
printf '\n*** Update content, same length, reset mtime; all hits.\n\n'
cat "$fixtures"/file1
stat "$fixtures"/file1
mtime=$(stat -c %y "$fixtures"/file1)
echo world > "$fixtures"/file1
touch -d "$mtime" "$fixtures"/file1
cat "$fixtures"/file1
stat "$fixtures"/file1
run ch-image build -f ./bucache/rsync.df "$fixtures"
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* RSYNC'* ]]
}
@test "${tag}: all hits, new name" {
ch-image build-cache --reset
blessed_out=$(cat << 'EOF'
* (a2, a) RUN.S echo bar
* RUN.S echo foo
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
ch-image build -t a -f ./bucache/a.df .
ch-image build -t a2 -f ./bucache/a.df .
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: pull to default destination" {
ch-image build-cache --reset
printf '\n*** Case 1: Not in build cache\n\n'
run ch-image pull alpine:3.17
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'pulling image: alpine:3.17'* ]]
[[ $output = *'pulled image: adding to build cache'* ]] # C1, C4
[[ $output != *'pulled image: found in build cache'* ]] # C2, C3
printf '\n*** Case 2: In build cache, up to date\n\n'
run ch-image pull alpine:3.17
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'pulling image: alpine:3.17'* ]]
[[ $output != *'pulled image: adding to build cache'* ]] # C1, C4
[[ $output = *'pulled image: found in build cache'* ]] # C2, C3
printf '\n*** Case 3: In build cache, not UTD, UTD commit present\n\n'
printf 'FROM alpine:3.17\n' | ch-image build -t foo -
printf 'FROM foo\nRUN echo foo\n' | ch-image build -t alpine:3.17 -
blessed_out=$(cat << 'EOF'
* (alpine+3.17) RUN.S echo foo
* (foo) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
sleep 1
run ch-image pull alpine:3.17
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'pulling image: alpine:3.17'* ]]
[[ $output != *'pulled image: adding to build cache'* ]] # C1, C4
[[ $output = *'pulled image: found in build cache'* ]] # C2, C3
blessed_out=$(cat << 'EOF'
* RUN.S echo foo
* (foo, alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
printf '\n*** Case 4: In build cache, not UTD, UTD commit absent\n\n'
sleep 1
printf 'FROM alpine:3.17\n' | ch-image build -t alpine:3.16 -
blessed_out=$(cat << 'EOF'
* RUN.S echo foo
* (foo, alpine+3.17, alpine+3.16) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
run ch-image pull alpine:3.16
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'pulling image: alpine:3.16'* ]]
[[ $output = *'pulled image: adding to build cache'* ]] # C1, C4
[[ $output != *'pulled image: found in build cache'* ]] # C2, C3
blessed_out=$(cat << 'EOF'
* (alpine+3.16) PULL alpine:3.16
| * RUN.S echo foo
| * (foo, alpine+3.17) PULL alpine:3.17
|/
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
@test "${tag}: multistage COPY" {
# Multi-stage build with no instructions in the first stage.
df_no=$(cat <<'EOF'
FROM alpine:3.17
FROM alpine:3.16
COPY --from=0 /etc/os-release /
EOF
)
# Multi-stage build with instruction in the first stage.
df_yes=$(cat <<'EOF'
FROM alpine:3.17
RUN echo foo
FROM alpine:3.16
COPY --from=0 /etc/os-release /
EOF
)
ch-image build-cache --reset
run ch-image build -t tmpimg -f <(echo "$df_no") . # cold
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'. COPY'* ]]
run ch-image build -t tmpimg -f <(echo "$df_no") . # hot
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* COPY'* ]]
ch-image build-cache --reset
run ch-image build -t tmpimg -f <(echo "$df_yes") . # cold
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'. COPY'* ]]
run ch-image build -t tmpimg -f <(echo "$df_yes") . # hot
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* COPY'* ]]
}
@test "${tag}: pull to specified destination" {
ch-image reset
# pull special image to weird destination
ch-image pull scratch foo
# pull normal image to weird destination
sleep 1
ch-image pull alpine:3.17 bar
# everything in order?
blessed_tree=$(cat << 'EOF'
* (bar, alpine+3.17) PULL alpine:3.17
| * (scratch, foo) PULL scratch
|/
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_tree") <(echo "$output" | treeonly)
ls -x "$CH_IMAGE_STORAGE"/img
[[ $(ls -x "$CH_IMAGE_STORAGE"/img) == "bar foo" ]]
# pull same normal image normally
sleep 1
ch-image pull alpine:3.17
# everything still in order?
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_tree") <(echo "$output" | treeonly)
ls -x "$CH_IMAGE_STORAGE"/img
[[ $(ls -x "$CH_IMAGE_STORAGE"/img) == "alpine+3.17 bar foo" ]]
}
@test "${tag}: empty dir persistence" {
ch-image build-cache --reset
ch-image delete tmpimg || true
ch-image build -t tmpimg - <<'EOF'
FROM alpine:3.17
RUN mkdir /foo && mkdir /foo/bar
EOF
sleep 1
ch-image build -t tmpimg - <<'EOF'
FROM alpine:3.17
RUN true # miss
RUN mkdir /foo # should not collide with leftover /foo from above
EOF
}
@test "${tag}: garbage vs. reset" {
scope full
rm -Rf --one-file-system "$CH_IMAGE_STORAGE"
# Init build cache.
ch-image list
cd "$CH_IMAGE_STORAGE"/bucache
# Turn off auto-gc so it’s not triggered during the build itself.
git config gc.auto 0
# Build an image that’s going to be annoying to garbage collect, but not
# too annoying, so the test isn’t too long. Keep in mind this is probably
# happening on a tmpfs.
ch-image build -t tmpimg - <<'EOF'
FROM alpine:3.17
RUN for i in $(seq 0 1024); do \
dd if=/dev/urandom of=/$i bs=4096K count=1 status=none; \
done
EOF
# Turn auto-gc back on, and configure it to run basically always.
git config gc.auto 1
#git config gc.autoDetach false # for testing
cat config
# Garbage collect. Use raw Git commands so we can control exactly what is
# going on.
git gc --auto
# Reset the cache while garbage collection is still running.
cd ..
run ch-image build-cache --reset
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'stopping build cache garbage collection'* ]]
}
@test "${tag}: all hits, no image" {
df=$(cat <<'EOF'
FROM alpine:3.17
RUN echo foo
EOF
)
ch-image build-cache --reset
ch-image build -t tmpimg -f <(echo "$df") .
ch-image delete tmpimg
[[ ! -e $CH_IMAGE_STORAGE/img/tmpimg ]]
run ch-image build -v -t tmpimg -f <(echo "$df") .
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* FROM'* ]]
[[ $output = *'* RUN.S'* ]]
[[ $output = *"no image found: $CH_IMAGE_STORAGE/img/tmpimg"* ]]
[[ $output = *'created worktree'* ]]
}
@test "${tag}: difficult files" {
ch-image build-cache --reset
statwalk () {
# Remove (1) mtime and atime for symlinks, where it cannot be set, and
# (2) directory sizes, which vary by filesystem and maybe other stuff.
( cd "$CH_IMAGE_STORAGE"/img/tmpimg/test
find . -printf '%n %M %4s m=%TFT%TT a=%AFT%AT %p (%l)\n' \
| sed -E 's/^(1 l.+)([am]=[0-9T:.-]+ ){2}(.+)$/\1m=::: a=::: \3/' \
| sed -E 's/^([1-9] d[rwxs-]{9}) [0-9 ]{4}/\1 0000/' \
| LC_ALL=C sort -k6 )
}
# Set umask so permissions match our reference data.
umask 0027
# Build it. Every instruction does a quick restore, so this validates that
# works, aside from mtime and atime which are expected to vary. Note that
# “--force=none” is necessary because the dockerfile includes a call to
# mkfifo(1), which uses the system call mknod(2), which is intercepted by
# our seccomp(2) filter (see also: #1646).
ch-image build --force=none -t tmpimg -f ./bucache/difficult.df .
stat "$CH_IMAGE_STORAGE"/img/tmpimg/test/fifo_
stat1=$(statwalk)
diff -u - <(echo "$stat1" | sed -E 's/([am])=[0-9T:.-]+/\1=:::/g') <<'EOF'
7 drwxr-x--- 0000 m=::: a=::: . ()
2 drwsrwxrwx 0000 m=::: a=::: ./dir_all ()
1 -rwsrwxrwx 0 m=::: a=::: ./dir_all/file_all ()
2 drwxr-x--- 0000 m=::: a=::: ./dir_empty ()
3 drwxr-x--- 0000 m=::: a=::: ./dir_empty_empty ()
2 drwxr-x--- 0000 m=::: a=::: ./dir_empty_empty/dir_empty ()
2 drwx------ 0000 m=::: a=::: ./dir_min ()
1 -r-------- 0 m=::: a=::: ./dir_min/file_min ()
1 prw-r----- 0 m=::: a=::: ./fifo_ ()
3 drwxr-x--- 0000 m=::: a=::: ./gitrepo ()
7 drwxr-x--- 0000 m=::: a=::: ./gitrepo/.git ()
1 -rw-r----- 23 m=::: a=::: ./gitrepo/.git/HEAD ()
2 drwxr-x--- 0000 m=::: a=::: ./gitrepo/.git/branches ()
1 -rw-r----- 92 m=::: a=::: ./gitrepo/.git/config ()
1 -rw-r----- 73 m=::: a=::: ./gitrepo/.git/description ()
2 drwxr-x--- 0000 m=::: a=::: ./gitrepo/.git/hooks ()
1 -rwxr-x--- 478 m=::: a=::: ./gitrepo/.git/hooks/applypatch-msg.sample ()
1 -rwxr-x--- 896 m=::: a=::: ./gitrepo/.git/hooks/commit-msg.sample ()
1 -rwxr-x--- 189 m=::: a=::: ./gitrepo/.git/hooks/post-update.sample ()
1 -rwxr-x--- 424 m=::: a=::: ./gitrepo/.git/hooks/pre-applypatch.sample ()
1 -rwxr-x--- 1643 m=::: a=::: ./gitrepo/.git/hooks/pre-commit.sample ()
1 -rwxr-x--- 416 m=::: a=::: ./gitrepo/.git/hooks/pre-merge-commit.sample ()
1 -rwxr-x--- 1374 m=::: a=::: ./gitrepo/.git/hooks/pre-push.sample ()
1 -rwxr-x--- 4898 m=::: a=::: ./gitrepo/.git/hooks/pre-rebase.sample ()
1 -rwxr-x--- 544 m=::: a=::: ./gitrepo/.git/hooks/pre-receive.sample ()
1 -rwxr-x--- 1492 m=::: a=::: ./gitrepo/.git/hooks/prepare-commit-msg.sample ()
1 -rwxr-x--- 2783 m=::: a=::: ./gitrepo/.git/hooks/push-to-checkout.sample ()
1 -rwxr-x--- 3650 m=::: a=::: ./gitrepo/.git/hooks/update.sample ()
2 drwxr-x--- 0000 m=::: a=::: ./gitrepo/.git/info ()
1 -rw-r----- 240 m=::: a=::: ./gitrepo/.git/info/exclude ()
4 drwxr-x--- 0000 m=::: a=::: ./gitrepo/.git/objects ()
2 drwxr-x--- 0000 m=::: a=::: ./gitrepo/.git/objects/info ()
2 drwxr-x--- 0000 m=::: a=::: ./gitrepo/.git/objects/pack ()
4 drwxr-x--- 0000 m=::: a=::: ./gitrepo/.git/refs ()
2 drwxr-x--- 0000 m=::: a=::: ./gitrepo/.git/refs/heads ()
2 drwxr-x--- 0000 m=::: a=::: ./gitrepo/.git/refs/tags ()
2 -rw-r----- 0 m=::: a=::: ./hard_src ()
2 -rw-r----- 0 m=::: a=::: ./hard_target ()
1 lrwxrwxrwx 11 m=::: a=::: ./soft_src (soft_target)
1 -rw-r----- 0 m=::: a=::: ./soft_target ()
EOF
# Build again; tests full restore because we delete the image. Compare
# against the (already validated) results of the first build, this time
# including timestamps.
ch-image delete tmpimg
[[ ! -e $CH_IMAGE_STORAGE/img/tmpimg ]]
run ch-image build --force=none -t tmpimg -f ./bucache/difficult.df .
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'* RUN.N echo last'* ]]
statwalk | diff -u <(echo "$stat1") -
}
@test "${tag}: ignore patterns" {
# fails unless “__ch-test_ignore__” is included in the global gitignore file.
git check-ignore -q __ch-test_ignore__ \
|| pedantic_fail 'global ignore not configured'
ch-image build-cache --reset
df=$(cat <<'EOF'
FROM alpine:3.17
RUN touch __ch-test_ignore__
EOF
)
echo "$df" | ch-image build -t tmpimg -
ch-image delete tmpimg
echo "$df" | ch-image build -t tmpimg -
ls -lh "$CH_IMAGE_STORAGE"/img/tmpimg/__ch-test_ignore__
}
@test "${tag}: delete" {
ch-image build-cache --reset
printf 'FROM alpine:3.17\nRUN echo 1a\n' | ch-image build -t 1a -
printf 'FROM alpine:3.17\nRUN echo 1b\n' | ch-image build -t 1b -
printf 'FROM alpine:3.17\nRUN echo 2a\n' | ch-image build -t 2a -
# Blessèd tree, with substitutions corresponding to images that will be
# deleted.
blessed_tree=$( ch-image build-cache --tree \
| treeonly \
| sed -E 's/\((..|alpine\+3\.17)\) //')
echo "$blessed_tree"
# starting point
diff -u <(printf "1a\n1b\n2a\nalpine:3.17\n") <(ch-image list)
# no glob
ch-image delete 2a
# the blessed tree needs to be updated, since 2a is now untagged
diff -u <(printf "1a\n1b\nalpine:3.17\n") <(ch-image list)
# matches none (non-empty)
run ch-image delete 'foo*'
echo "$output"
[[ $status -eq 1 ]]
[[ $output = *'no matching image, can'?'t delete: foo*'* ]]
# matches some
ch-image delete '1*'
diff -u <(printf "alpine:3.17\n") <(ch-image list)
# matches all
ch-image delete '*'
diff -u <(printf "") <(ch-image list)
# matches none (empty)
run ch-image delete '*'
echo "$output"
[[ $status -eq 1 ]]
[[ $output = *'no matching image, can'?'t delete: *'* ]]
# build cache unchanged
diff -u <(echo "$blessed_tree") <(ch-image build-cache --tree | treeonly)
}
@test "${tag}: large files" {
# We use files of size 3, 4, 5 MiB to avoid /lib/libcrypto.so.1.1, which
# is about 2.5 MIB and which we don’t have control over.
df=$(cat <<'EOF'
FROM alpine:3.17
RUN dd if=/dev/urandom of=/bigfile3 bs=1M count=3 \
&& dd if=/dev/urandom of=/bigfile4 bs=1M count=4 \
&& dd if=/dev/urandom of=/bigfile5 bs=1M count=5 \
&& touch -t 198005120000.00 /bigfile? \
&& chmod 644 /bigfile?
RUN ls -l /bigfile? /lib/libcrypto*
EOF
)
echo
echo '*** no large files'
ch-image build-cache --reset
echo "$df" | ch-image build --cache-large=0 -t tmpimg -
run ls "$CH_IMAGE_STORAGE"/bularge
echo "$output"
[[ $status -eq 0 ]]
[[ -z $output ]]
echo
echo '*** threshold = 5'
ch-image build-cache --reset
echo "$df" | ch-image build --cache-large=5 -t tmpimg -
run ls "$CH_IMAGE_STORAGE"/bularge
echo "$output"
[[ $status -eq 0 ]]
diff -u - <(echo "$output") <<'EOF'
b2dbc2a2bb35d6d0d5590aedc122cab6%bigfile5
EOF
echo
echo '*** threshold = 4, rebuild'
echo "$df" | ch-image build --rebuild --cache-large=4 -t tmpimg -
run ls "$CH_IMAGE_STORAGE"/bularge
echo "$output"
[[ $status -eq 0 ]]
# should re-use existing bigfile5
diff -u - <(echo "$output") <<'EOF'
6f7a3513121d79c42283f6f758439c3a%bigfile4
b2dbc2a2bb35d6d0d5590aedc122cab6%bigfile5
EOF
echo
echo '*** threshold = 4, reset'
ch-image build-cache --reset
echo "$df" | ch-image build --rebuild --cache-large=4 -t tmpimg -
run ls "$CH_IMAGE_STORAGE"/bularge
echo "$output"
[[ $status -eq 0 ]]
diff -u - <(echo "$output") <<'EOF'
6f7a3513121d79c42283f6f758439c3a%bigfile4
b2dbc2a2bb35d6d0d5590aedc122cab6%bigfile5
EOF
}
@test "${tag}: hard links with Git-incompatible name" { # issue #1569
ch-image build-cache --reset
ch-image build -t tmpimg - <<'EOF'
FROM alpine:3.17
RUN mkdir -p a/b
RUN mkdir -p a/c
RUN touch a/b/.gitignore
RUN ln a/b/.gitignore a/c/.gitignore
RUN stat -c'%n %h %d/%i' a/?/.gitignore
EOF
}
@test "${tag}: Git commands at image root" { # issue 1285
ch-image build-cache --reset
# Use mount(8) to create a private /tmp; otherwise the bucache repo under
# $BATS_TMPDIR *does* exist because /tmp is shared with the host.
ch-image build -t tmpimg - <<'EOF'
FROM alpine:3.17
RUN apk add git
RUN cat /proc/mounts
RUN mount -t tmpfs -o size=4m none /tmp \
&& git config --system http.sslVerify false
EOF
}
@test "${tag}: delete RPM databases" { # issue #1351
ch-image build-cache --reset
run ch-image build -v -t tmpimg - <<'EOF'
FROM alpine:3.17
RUN mkdir -p /var/lib/rpm
RUN touch /var/lib/rpm/__db.001
EOF
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'deleting, see issue #1351: var/lib/rpm/__db.001'* ]]
[[ ! -e $CH_IMAGE_STORAGE/img/tmpimg/var/lib/rpm/__db.001 ]]
}
@test "${tag}: restore ACLs, xattrs" { # issue #1287
# Check if test needs to be skipped
touch "$BATS_TMPDIR/tmpfs_test"
if ! setfattr -n user.foo -v bar "$BATS_TMPDIR/tmpfs_test" \
&& [[ -z $GITHUB_ACTIONS ]]; then
skip "xattrs unsupported in ${BATS_TMPDIR}"
fi
# Build an image, then re-build from cache to test xattr/ACL cache
# functionality.
TMP_CX=$BATS_TMPDIR
TMP_DF=$BATS_TMPDIR/weirdal.df
cat <<'EOF' > "$TMP_DF"
FROM alpine:3.17
RUN apk add attr
RUN apk add acl
RUN touch /home/foo
RUN setfattr -n user.foo -v bar /home/foo
RUN setfacl -m u:root:r /home/foo
EOF
ch-image build-cache --reset
ch-image build -t tmpimg -f "$TMP_DF" "$TMP_CX"
ch-image delete tmpimg
ch-image build -t tmpimg -f "$TMP_DF" "$TMP_CX"
run ch-run tmpimg -- getfattr home/foo
# don’t check for ACL xattr bc it’s more straightforward to use getfacl(1).
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'# file: home/foo'* ]]
[[ $output = *'user.foo'* ]]
run ch-run tmpimg -- getfacl home/foo
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *"user:$USER:r--"* ]]
}
@test "${tag}: orphaned worktrees" { # PR #1824
img_metadata=$CH_IMAGE_STORAGE/img/tmpimg/ch
img_to_git=$img_metadata/git
git_worktrees=$CH_IMAGE_STORAGE/bucache/worktrees
git_to_img=$git_worktrees/tmpimg
# pull image, should be unlinked
ch-image pull --no-cache scratch tmpimg
ch-image build-cache # rm leftover $git_to_img if it exists
ls -lh "$img_metadata" "$git_worktrees"
[[ ! -e "$img_to_git" ]]
[[ ! -e "$git_to_img" ]]
# add fake link
touch "$img_to_git"
ls -lh "$img_metadata" "$git_worktrees"
[[ -e "$img_to_git" ]]
[[ ! -e "$git_to_img" ]]
# ch-image should warn and fix instead of crashing
run ch-image list
echo "$output"
[[ $status -eq 0 ]]
[[ $output = *'image erroneously marked cached, fixing'* ]]
# warning should now be gone and the state be good
ls -lh "$img_metadata" "$git_worktrees"
[[ ! -e "$img_to_git" ]]
[[ ! -e "$git_to_img" ]]
run ch-image list
echo "$output"
[[ $status -eq 0 ]]
[[ $output != *'image erroneously marked cached, fixing'* ]]
}
@test "${tag}: modify" {
ch-image build-cache --reset
ch-image pull alpine:3.17
ch-image modify -c "echo foo" -c "echo bar" -- alpine:3.17 tmpimg
blessed_out=$(cat << 'EOF'
* (tmpimg) RUN.S echo bar
* RUN.S echo foo
* SHELL ['/bin/sh', '-c']
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
echo "touch /home/bar" >> "${BATS_TMPDIR}/script.sh"
chmod 755 "${BATS_TMPDIR}/script.sh"
ch-image modify alpine:3.17 tmpimg "${BATS_TMPDIR}/script.sh"
blessed_out=$(cat <<EOF
* (tmpimg) RUN.S /bin/sh /ch/script.sh
* COPY ['${BATS_TMPDIR}/script.sh'] -> '/ch/script.sh'
| * RUN.S echo bar
| * RUN.S echo foo
| * SHELL ['/bin/sh', '-c']
|/
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
ch-image build-cache --reset
ch-image pull alpine:3.17
printf 'echo hello\nexit\n' | ch-image modify -i alpine:3.17 tmpimg
blessed_out=$(cat <<EOF
* (tmpimg) MODIFY interactive
* (alpine+3.17) PULL alpine:3.17
* (root) ROOT
EOF
)
run ch-image build-cache --tree
echo "$output"
[[ $status -eq 0 ]]
diff -u <(echo "$blessed_out") <(echo "$output" | treeonly)
}
|