Skip to content

Resolve tagged git refs for build cache #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yoshifuminakamura merged 1 commit into from
Aug 27, 2026
Merged

Resolve tagged git refs for build cache #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions scripts/build_with_cache.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,19 +311,40 @@ host_environment_fingerprint() {
printf '%s\n' "$fingerprint_hash"
}

resolve_git_branch_commit() {
resolve_git_ref_commit() {
local repo_url="$1"
local branch="$2"
local ref="$2"
local refs=""
local refname=""
local commit=""

if [ -z "$repo_url" ] || [ -z "$branch" ] || [ "$branch" = "HEAD" ] || [ "$branch" = "detached" ]; then
if [ -z "$repo_url" ] || [ -z "$ref" ] || [ "$ref" = "HEAD" ] || [ "$ref" = "detached" ]; then
return 1
fi

commit=$(git ls-remote "$repo_url" "refs/heads/${branch}" 2>/dev/null | awk 'NR == 1 {print $1}')
refs=$(git ls-remote "$repo_url" \
"refs/heads/${ref}" \
"refs/tags/${ref}" \
"refs/tags/${ref}^{}" \
"$ref" 2>/dev/null || true)

refname="refs/heads/${ref}"
commit=$(printf '%s\n' "$refs" | awk -v ref="$refname" '$2 == ref {print $1; exit}')
if [ -z "$commit" ]; then
refname="refs/tags/${ref}^{}"
commit=$(printf '%s\n' "$refs" | awk -v ref="$refname" '$2 == ref {print $1; exit}')
fi
if [ -z "$commit" ]; then
refname="refs/tags/${ref}"
commit=$(printf '%s\n' "$refs" | awk -v ref="$refname" '$2 == ref {print $1; exit}')
fi
if [ -z "$commit" ]; then
commit=$(printf '%s\n' "$refs" | awk '$2 ~ /\^\{\}$/ {print $1; exit}')
fi
if [ -z "$commit" ]; then
commit=$(git ls-remote "$repo_url" "$branch" 2>/dev/null | awk 'NR == 1 {print $1}')
commit=$(printf '%s\n' "$refs" | awk 'NF >= 2 {print $1; exit}')
fi

[ -n "$commit" ] || return 1
printf '%s\n' "$commit"
}
Expand All @@ -350,7 +371,7 @@ validate_cached_source() {
repo_url=$(env_file_value "$source_info_file" BK_REPO_URL)
branch=$(env_file_value "$source_info_file" BK_BRANCH)
cached_commit=$(env_file_value "$source_info_file" BK_COMMIT_HASH)
if ! current_commit=$(resolve_git_branch_commit "$repo_url" "$branch"); then
if ! current_commit=$(resolve_git_ref_commit "$repo_url" "$branch"); then
echo "cannot verify current git ref for ${repo_url} ${branch}"
return 1
fi
Expand Down
46 changes: 46 additions & 0 deletions scripts/tests/test_build_cache.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ trap 'rm -rf "${TMP_DIR}"' EXIT
mkdir -p \
"${TMP_DIR}/project/programs/app" \
"${TMP_DIR}/project/programs/autotoolapp" \
"${TMP_DIR}/project/programs/tagapp" \
"${TMP_DIR}/project/programs/toolapp" \
"${TMP_DIR}/project/scripts" \
"${TMP_DIR}/project/scripts/build_tool_wrappers" \
Expand Down Expand Up @@ -41,6 +42,7 @@ chmod +x configure
git add source.txt configure
git commit -m "first" >/dev/null
first_commit=$(git rev-parse HEAD)
git tag -a v1.0 -m "version one" "$first_commit"
popd >/dev/null

cat > "${TMP_DIR}/project/programs/app/build.sh" <<'EOF'
Expand All @@ -62,6 +64,25 @@ printf 'artifact %s %s\n' "$system" "$BK_COMMIT_HASH" > artifacts/app.bin
EOF
chmod +x "${TMP_DIR}/project/programs/app/build.sh"

cat > "${TMP_DIR}/project/programs/tagapp/build.sh" <<'EOF'
#!/bin/bash
set -euo pipefail

system="$1"
source scripts/bk_functions.sh
mkdir -p artifacts
bk_fetch_source "${BK_TEST_SOURCE_REPO}" tagsrc v1.0

count=0
if [ -f "${BK_TEST_TAG_BUILD_COUNT}" ]; then
count=$(cat "${BK_TEST_TAG_BUILD_COUNT}")
fi
count=$((count + 1))
printf '%s\n' "$count" > "${BK_TEST_TAG_BUILD_COUNT}"
printf 'tag artifact %s %s\n' "$system" "$BK_COMMIT_HASH" > artifacts/tagapp.bin
EOF
chmod +x "${TMP_DIR}/project/programs/tagapp/build.sh"

cat > "${TMP_DIR}/project/programs/toolapp/build.sh" <<'EOF'
#!/bin/bash
set -euo pipefail
Expand Down Expand Up @@ -136,6 +157,18 @@ run_build_with_cache() {
run_build_with_cache_for_root "${TMP_DIR}/project"
}

run_tag_build_with_cache() {
pushd "${TMP_DIR}/project" >/dev/null
BK_BENCHKIT_ROOT="${TMP_DIR}/project" \
BK_BUILD_CACHE_DIR="${TMP_DIR}/tag-cache" \
BK_BUILD_CACHE_ALLOW_HOST_ENV_CACHE=true \
BK_BUILD_CACHE_ENV_KEY=test-toolchain-v1 \
BK_TEST_SOURCE_REPO="${TMP_DIR}/source/.git" \
BK_TEST_TAG_BUILD_COUNT="${TMP_DIR}/tag-build-count" \
bash scripts/build_with_cache.sh tagapp TestSystem programs/tagapp
popd >/dev/null
}

run_integrity_build_with_cache() {
pushd "${TMP_DIR}/project" >/dev/null
BK_BENCHKIT_ROOT="${TMP_DIR}/project" \
Expand Down Expand Up @@ -309,6 +342,19 @@ test "$(cat "${TMP_DIR}/build-count")" = "2"
grep -q "$first_commit" "${TMP_DIR}/project/artifacts/app.bin"
grep -q '^BK_BUILD_CACHE_STATUS=hit$' "${TMP_DIR}/project/results/build_cache.env"

rm -rf "${TMP_DIR}/project/artifacts" "${TMP_DIR}/project/results" "${TMP_DIR}/project/tagsrc"
rm -f "${TMP_DIR}/tag-build-count"
run_tag_build_with_cache
test "$(cat "${TMP_DIR}/tag-build-count")" = "1"
grep -q "$first_commit" "${TMP_DIR}/project/artifacts/tagapp.bin"
grep -q '^BK_BUILD_CACHE_STORED=true$' "${TMP_DIR}/project/results/build_cache.env"

rm -rf "${TMP_DIR}/project/artifacts" "${TMP_DIR}/project/results" "${TMP_DIR}/project/tagsrc"
run_tag_build_with_cache
test "$(cat "${TMP_DIR}/tag-build-count")" = "1"
grep -q "$first_commit" "${TMP_DIR}/project/artifacts/tagapp.bin"
grep -q '^BK_BUILD_CACHE_STATUS=hit$' "${TMP_DIR}/project/results/build_cache.env"

rm -rf "${TMP_DIR}/project/artifacts" "${TMP_DIR}/project/results" "${TMP_DIR}/project/toolsrc"
rm -f "${TMP_DIR}/tool-build-count"
run_tool_build_with_cache
Expand Down
Loading