mirror of
https://github.com/cozystack/cozystack.git
synced 2026-11-21 12:13:55 +09:00
fix(ci): take the main ref for a bare image ref in a drifted file
A file whose configuration drifted from the cozystack-packages:main artifact keeps its committed refs. For a digest-pinned ref that runs an older image; for the bare <repo>:<tag> a new image is first committed with, it names a tag that was never pushed, so the component cannot pull. The merge commit CI tests is fixed when the run starts, so a PR whose merge commit predates a config change to observability-proxy's values.yaml installed observability-proxy:v0.0.0 and failed E2E. In a drifted values file, a bare ref under an image key now takes the artifact line with the same key, the same image name and a digest, when exactly one exists. The rest of the file stays as the PR has it. Assisted-by: LLM Signed-off-by: Maxim Belyy <maximbel2003@gmail.com>
This commit is contained in:
1 parent
3ede7c4d33
commit
fd15ad282e
2 files changed
+170
-4
No files matched your search
@@ -42,9 +42,13 @@
|
||||
# a change: `yq -i`, which every `make image` uses to stamp the ref, drops one.
|
||||
# If any OTHER line differs — the PR branched from a
|
||||
# main whose config for that file differs from the artifact's base — the file is
|
||||
# left on its committed ref (safe degradation, logged, never fatal). CI checks
|
||||
# out the pull_request merge commit (current main + PR), so for an unbuilt file
|
||||
# the config already matches current main and only ref lines differ.
|
||||
# left on its committed ref (safe degradation, logged, never fatal), except
|
||||
# that a bare digest-less ref in it, which no registry serves, still takes the
|
||||
# artifact's ref (see replace_bare_refs). CI checks out the pull_request merge
|
||||
# commit (main + PR), so for an unbuilt file the config matches main as of
|
||||
# that merge commit. It is fixed when the run starts, so a rerun, or a PR not
|
||||
# pushed to since, can be older than the artifact and drift on files it never
|
||||
# touched.
|
||||
#
|
||||
# Usage: hack/overlay-main-images.sh <mainpkgs-dir> <built-matrix-json> [touched-pkg-dirs]
|
||||
# <mainpkgs-dir> = extracted cozystack-packages:main tree; its root holds
|
||||
@@ -123,8 +127,76 @@ img_line='(@sha256:|^[[:space:]]*(- )?(image|repository|registry|tag|digest):|^[
|
||||
# match branch for this same shape and for this same reason.
|
||||
bare_ref_line='^[^[:space:]#][^[:space:]]*/[^[:space:]]+$'
|
||||
|
||||
# A drifted file keeps its committed refs. For a ref pinned by digest that is a
|
||||
# pullable older image, which is the safe answer. A bare `<repo>:<tag>` with no
|
||||
# digest is different: it is the first commit of a new image
|
||||
# (docs/agents/image-refs.md), its tag was never pushed, and keeping it makes the
|
||||
# component fail to pull instead of run an older image. The merge commit CI
|
||||
# checks out is fixed when the run starts, so a PR whose merge commit predates a
|
||||
# config change to such a file drifts on it, and every new image is exposed
|
||||
# until a release stamps its ref (#5328).
|
||||
#
|
||||
# replace_bare_refs <cur> <new> rewrites, in <cur> only, each line whose value is
|
||||
# such a bare ref under an image key, taking the line from <new> that has the
|
||||
# same key and indentation, the same image name and an @sha256: digest. Exactly
|
||||
# one such line must exist; two are ambiguous and none means build-main did not
|
||||
# stamp it, so there is nothing more pullable to take. Every other line of <cur>
|
||||
# stays as the PR has it. The current image may expect configuration the PR's
|
||||
# older chart lacks, but the committed ref cannot run at all. Prints the number
|
||||
# of lines replaced.
|
||||
replace_bare_refs() {
|
||||
tmp="$1.overlay-bare.$$"
|
||||
n=$(awk -v newf="$2" -v out="$tmp" '
|
||||
function key_prefix(s) {
|
||||
if (match(s, /^[[:space:]]*(- )?([A-Za-z]+[Ii]mage|image):[[:space:]]*/)) return substr(s, 1, RLENGTH)
|
||||
return ""
|
||||
}
|
||||
function ref_value(s, p, v) {
|
||||
v = substr(s, length(p) + 1)
|
||||
sub(/[[:space:]]+$/, "", v)
|
||||
gsub(/"/, "", v)
|
||||
return v
|
||||
}
|
||||
function image_name(v) {
|
||||
sub(/@.*/, "", v)
|
||||
sub(/.*\//, "", v)
|
||||
sub(/:.*/, "", v)
|
||||
return v
|
||||
}
|
||||
BEGIN {
|
||||
while ((getline l < newf) > 0) {
|
||||
p = key_prefix(l)
|
||||
if (p == "" || index(l, "@sha256:") == 0) continue
|
||||
k = p SUBSEP image_name(ref_value(l, p))
|
||||
cnt[k]++
|
||||
line[k] = l
|
||||
}
|
||||
close(newf)
|
||||
}
|
||||
{
|
||||
p = key_prefix($0)
|
||||
if (p != "") {
|
||||
v = ref_value($0, p)
|
||||
if (v ~ /^[^@[:space:]]+\/[^@[:space:]\/]+:[^@[:space:]\/]+$/) {
|
||||
k = p SUBSEP image_name(v)
|
||||
if (cnt[k] == 1) { print line[k] > out; r++; next }
|
||||
}
|
||||
}
|
||||
print > out
|
||||
}
|
||||
END { close(out); print r + 0 }
|
||||
' "$1")
|
||||
if [ "$n" -gt 0 ]; then
|
||||
mv "$tmp" "$1"
|
||||
else
|
||||
rm -f "$tmp"
|
||||
fi
|
||||
echo "$n"
|
||||
}
|
||||
|
||||
overlaid=0
|
||||
same=0
|
||||
bare=0
|
||||
skipped=0
|
||||
drift=0
|
||||
drift_files=""
|
||||
@@ -164,6 +236,15 @@ for new in $(find "$MAINPKGS" -type d -name charts -prune -o \
|
||||
| grep -vE '^[[:space:]]*$' | grep -qvE "$line_pat"; then
|
||||
echo "drift (non-ref change) in $cur -> keeping committed ref"
|
||||
drift=$((drift + 1))
|
||||
case "$cur" in
|
||||
*.yaml)
|
||||
r=$(replace_bare_refs "$cur" "$new") || r=0
|
||||
if [ "$r" -gt 0 ]; then
|
||||
echo "bare ref in $cur -> current-main ($r line(s))"
|
||||
bare=$((bare + r))
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
# Name the PACKAGE, not the directory the file happens to sit in: an
|
||||
# images/*.tag drift would otherwise read as "<pkg>/images", which is not
|
||||
# something anyone can go and look at.
|
||||
@@ -181,7 +262,7 @@ for new in $(find "$MAINPKGS" -type d -name charts -prune -o \
|
||||
fi
|
||||
done
|
||||
|
||||
echo "Overlay current-main images: overlaid=$overlaid same=$same skipped(rebuilt/owned/edited)=$skipped drift=$drift failed=$failed"
|
||||
echo "Overlay current-main images: overlaid=$overlaid same=$same skipped(rebuilt/owned/edited)=$skipped drift=$drift bare-refs=$bare failed=$failed"
|
||||
|
||||
# Keeping the committed ref is the safe answer to a config that does not match
|
||||
# the artifact, but it is not a neutral one: that component then runs its last
|
||||
|
||||
@@ -502,3 +502,88 @@ load test_helper
|
||||
cd "$root"
|
||||
rm -rf "$w"
|
||||
}
|
||||
|
||||
# A drifted file keeps its committed refs, and for a digest-pinned ref that is
|
||||
# a pullable older image. A bare <repo>:<tag> is the first commit of a new image
|
||||
# (docs/agents/image-refs.md) and names a tag no registry serves, so keeping it
|
||||
# turns drift into ImagePullBackOff. That hit every fork PR whose merge commit
|
||||
# predated a config change to observability-proxy's values.yaml (#5328). Only
|
||||
# such a bare line takes the artifact's ref; the rest of the file stays as the
|
||||
# PR has it.
|
||||
@test "a drifted file still takes the artifact ref for a bare (digest-less) ref line" {
|
||||
root=$(pwd)
|
||||
w=$(mktemp -d)
|
||||
mkdir -p "$w/packages/system/proxy" "$w/main/system/proxy"
|
||||
printf 'proxy:\n image: "ghcr.io/cozystack/cozystack/proxy:v0.0.0"\n lookback: 1h\n' \
|
||||
> "$w/packages/system/proxy/values.yaml"
|
||||
printf 'proxy:\n image: "iad.ocir.io/x/cozystack/proxy:main@sha256:bbbb"\n lookback: 1h\n prefix: cozy-\n' \
|
||||
> "$w/main/system/proxy/values.yaml"
|
||||
( cd "$w" && "$root/hack/overlay-main-images.sh" main '[]' ) > "$w/out.txt"
|
||||
grep -q 'drift (non-ref change) in packages/system/proxy/values.yaml' "$w/out.txt"
|
||||
grep -q ' image: "iad.ocir.io/x/cozystack/proxy:main@sha256:bbbb"' "$w/packages/system/proxy/values.yaml"
|
||||
# The config stays the PR's: the new key is not introduced.
|
||||
if grep -q 'prefix:' "$w/packages/system/proxy/values.yaml"; then
|
||||
echo "FAIL: a config line was taken from the artifact" >&2; exit 1
|
||||
fi
|
||||
grep -q 'bare ref in packages/system/proxy/values.yaml -> current-main' "$w/out.txt"
|
||||
grep -q 'bare-refs=1' "$w/out.txt"
|
||||
rm -rf "$w"
|
||||
}
|
||||
|
||||
@test "a drifted file replaces only its bare ref, not a digest-pinned sibling" {
|
||||
root=$(pwd)
|
||||
w=$(mktemp -d)
|
||||
mkdir -p "$w/packages/system/pair" "$w/main/system/pair"
|
||||
printf 'tuning: old\nimage: ghcr.io/cozystack/cozystack/pair:v1.5.0@sha256:aaaa\nclientImage: ghcr.io/cozystack/cozystack/pair-client:latest\n' \
|
||||
> "$w/packages/system/pair/values.yaml"
|
||||
printf 'tuning: new\nimage: iad.ocir.io/x/cozystack/pair:main@sha256:bbbb\nclientImage: iad.ocir.io/x/cozystack/pair-client:main@sha256:cccc\n' \
|
||||
> "$w/main/system/pair/values.yaml"
|
||||
( cd "$w" && "$root/hack/overlay-main-images.sh" main '[]' ) > "$w/out.txt"
|
||||
grep -q '^image: ghcr.io/cozystack/cozystack/pair:v1.5.0@sha256:aaaa$' "$w/packages/system/pair/values.yaml"
|
||||
grep -q '^clientImage: iad.ocir.io/x/cozystack/pair-client:main@sha256:cccc$' "$w/packages/system/pair/values.yaml"
|
||||
grep -q '^tuning: old$' "$w/packages/system/pair/values.yaml"
|
||||
rm -rf "$w"
|
||||
}
|
||||
|
||||
@test "a bare ref is not replaced by an artifact line for a different image" {
|
||||
# The same key can hold another image in the artifact, e.g. after a rename.
|
||||
# Matching on the key alone would swap in an image the chart never asked for.
|
||||
root=$(pwd)
|
||||
w=$(mktemp -d)
|
||||
mkdir -p "$w/packages/system/ren" "$w/main/system/ren"
|
||||
printf 'tuning: old\nimage: ghcr.io/cozystack/cozystack/old-name:v0.0.0\n' > "$w/packages/system/ren/values.yaml"
|
||||
printf 'tuning: new\nimage: iad.ocir.io/x/cozystack/new-name:main@sha256:bbbb\n' > "$w/main/system/ren/values.yaml"
|
||||
( cd "$w" && "$root/hack/overlay-main-images.sh" main '[]' ) > "$w/out.txt"
|
||||
grep -q '^image: ghcr.io/cozystack/cozystack/old-name:v0.0.0$' "$w/packages/system/ren/values.yaml"
|
||||
grep -q 'bare-refs=0' "$w/out.txt"
|
||||
rm -rf "$w"
|
||||
}
|
||||
|
||||
@test "a bare ref is kept when the artifact carries no digest for it either" {
|
||||
# A ref build-main does not stamp (third-party, or not built yet) has no
|
||||
# digest in the artifact, so there is nothing more pullable to take.
|
||||
root=$(pwd)
|
||||
w=$(mktemp -d)
|
||||
mkdir -p "$w/packages/system/tp" "$w/main/system/tp"
|
||||
printf 'tuning: old\nimage: docker.io/library/busybox:1.37.0\n' > "$w/packages/system/tp/values.yaml"
|
||||
printf 'tuning: new\nimage: docker.io/library/busybox:1.38.0\n' > "$w/main/system/tp/values.yaml"
|
||||
( cd "$w" && "$root/hack/overlay-main-images.sh" main '[]' ) > "$w/out.txt"
|
||||
grep -q '^image: docker.io/library/busybox:1.37.0$' "$w/packages/system/tp/values.yaml"
|
||||
grep -q 'bare-refs=0' "$w/out.txt"
|
||||
rm -rf "$w"
|
||||
}
|
||||
|
||||
@test "a bare ref is kept when the artifact has two candidate lines for it" {
|
||||
# Two lines with the same key and image name (e.g. one per component in a
|
||||
# list) cannot be told apart, so neither is taken.
|
||||
root=$(pwd)
|
||||
w=$(mktemp -d)
|
||||
mkdir -p "$w/packages/system/dup" "$w/main/system/dup"
|
||||
printf 'tuning: old\na:\n image: ghcr.io/cozystack/cozystack/dup:v0.0.0\n' > "$w/packages/system/dup/values.yaml"
|
||||
printf 'tuning: new\na:\n image: iad.ocir.io/x/cozystack/dup:main@sha256:bbbb\nb:\n image: iad.ocir.io/x/cozystack/dup:main@sha256:cccc\n' \
|
||||
> "$w/main/system/dup/values.yaml"
|
||||
( cd "$w" && "$root/hack/overlay-main-images.sh" main '[]' ) > "$w/out.txt"
|
||||
grep -q '^ image: ghcr.io/cozystack/cozystack/dup:v0.0.0$' "$w/packages/system/dup/values.yaml"
|
||||
grep -q 'bare-refs=0' "$w/out.txt"
|
||||
rm -rf "$w"
|
||||
}
|
||||
Reference in new issue
Block a user