Skip to content

Commit ed30ce7

Browse files
guysoftcursoragent
guysoft
and
cursoragent
committed
Extract setup_qemu_static() and add test coverage for QEMU binary copy logic
The QEMU binary copy logic was duplicated between execute_chroot_script() in src/custompios and chroot_correct_qemu() in src/common.sh. The inline version in custompios also had a bug: the condition used || instead of &&, making it always true (a tautology). This commit: - Extracts the copy logic into a new setup_qemu_static() function in common.sh, fixing the || to && bug and adding arch-match escape hatches - Fixes the aarch64->armv7l case to copy qemu-arm-static (not qemu-aarch64-static) - Replaces both inline copy blocks with calls to setup_qemu_static() - Adds 24 new test cases covering all host/target/OS combinations for the QEMU binary copy logic Related to PR #261 and issue #262. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 75347d1 commit ed30ce7

File tree

3 files changed

+134
-42
lines changed

3 files changed

+134
-42
lines changed

‎src/common.sh‎

Lines changed: 38 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -596,43 +596,64 @@ function load_module_config() {
596596
done
597597
}
598598

599-
function chroot_correct_qemu() {
599+
function setup_qemu_static() {
600+
# Copy the correct qemu-*-static binary into the chroot, if needed.
601+
# Usage: setup_qemu_static host_arch target_arch
600602
local host_arch="$1"
601603
local target_arch="$2"
602-
local chroot_script="$3"
603-
local custom_pi_os_path="$4"
604604

605-
# Validate inputs
606605
if [[ -z "$host_arch" ]] || [[ -z "$target_arch" ]]; then
607-
echo "Error: Missing required arguments"
608-
echo "Usage: setup_qemu_chroot host_arch target_arch chroot_script custom_pi_os_path"
606+
echo "Error: setup_qemu_static requires host_arch and target_arch"
609607
return 1
610-
fi
611-
612-
# Copy required scripts
613-
cp "$chroot_script" chroot_script
614-
chmod 755 chroot_script
615-
cp "${custom_pi_os_path}/common.sh" common.sh
616-
chmod 755 common.sh
608+
fi
617609

618-
# Set up QEMU if needed
610+
# Host is not ARM at all (e.g. x86_64) -- need full QEMU emulation
619611
if [[ "$host_arch" != "armv7l" ]] && [[ "$host_arch" != "aarch64" ]]; then
620612
if [[ "$target_arch" == "armv7l" ]] || [[ "$target_arch" == "armhf" ]]; then
621613
if grep -q gentoo /etc/os-release; then
622614
ROOT="$(realpath .)" emerge --usepkgonly --oneshot --nodeps qemu
623615
else
624-
cp "$(which qemu-arm-static)" usr/bin/qemu-arm-static
616+
if [[ "$target_arch" != "$host_arch" ]]; then
617+
cp "$(which qemu-arm-static)" usr/bin/qemu-arm-static
618+
fi
625619
fi
626620
elif [[ "$target_arch" == "aarch64" ]] || [[ "$target_arch" == "arm64" ]]; then
627621
if grep -q gentoo /etc/os-release; then
628622
ROOT="$(realpath .)" emerge --usepkgonly --oneshot --nodeps qemu
629623
else
630-
cp "$(which qemu-aarch64-static)" usr/bin/qemu-aarch64-static
624+
if [[ "$target_arch" != "$host_arch" ]]; then
625+
cp "$(which qemu-aarch64-static)" usr/bin/qemu-aarch64-static
626+
fi
631627
fi
632628
fi
633629
elif [[ ( "$target_arch" == "armv7l" || "$target_arch" == "armhf" ) && "$host_arch" != "armv7l" ]]; then
634-
cp "$(which qemu-aarch64-static)" usr/bin/qemu-aarch64-static
630+
# aarch64 host building armv7l/armhf: need 32-bit ARM emulation
631+
cp "$(which qemu-arm-static)" usr/bin/qemu-arm-static
635632
fi
633+
# Otherwise: same arch or armv7l host -- no QEMU needed
634+
}
635+
636+
function chroot_correct_qemu() {
637+
local host_arch="$1"
638+
local target_arch="$2"
639+
local chroot_script="$3"
640+
local custom_pi_os_path="$4"
641+
642+
# Validate inputs
643+
if [[ -z "$host_arch" ]] || [[ -z "$target_arch" ]]; then
644+
echo "Error: Missing required arguments"
645+
echo "Usage: setup_qemu_chroot host_arch target_arch chroot_script custom_pi_os_path"
646+
return 1
647+
fi
648+
649+
# Copy required scripts
650+
cp "$chroot_script" chroot_script
651+
chmod 755 chroot_script
652+
cp "${custom_pi_os_path}/common.sh" common.sh
653+
chmod 755 common.sh
654+
655+
# Set up QEMU if needed
656+
setup_qemu_static "$host_arch" "$target_arch"
636657

637658
# Execute chroot with appropriate QEMU setup
638659
if [[ "$host_arch" != "armv7l" ]] && [[ "$host_arch" != "aarch64" ]] && [[ "$host_arch" != "arm64" ]]; then

‎src/custompios‎

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -30,27 +30,7 @@ function execute_chroot_script() {
3030
fi
3131

3232
#black magic of qemu-arm-static
33-
if [ "$(uname -m)" != "armv7l" ] && [ "$(uname -m)" != "aarch64" ] ; then
34-
if [ "$BASE_ARCH" == "armv7l" ] || [ "$BASE_ARCH" == "armhf" ]; then
35-
if (grep -q gentoo /etc/os-release);then
36-
ROOT="`realpath .`" emerge --usepkgonly --oneshot --nodeps qemu
37-
else
38-
if [ "${BASE_ARCH}" != "$(uname -m)" ]; then
39-
cp `which qemu-arm-static` usr/bin/qemu-arm-static
40-
fi
41-
fi
42-
elif [ "$BASE_ARCH" == "aarch64" ] || [ "$BASE_ARCH" == "arm64" ]; then
43-
if (grep -q gentoo /etc/os-release);then
44-
ROOT="`realpath .`" emerge --usepkgonly --oneshot --nodeps qemu
45-
else
46-
if [ "${BASE_ARCH}" != "$(uname -m)" ]; then
47-
cp `which qemu-aarch64-static` usr/bin/qemu-aarch64-static
48-
fi
49-
fi
50-
fi
51-
elif [[ ( "$BASE_ARCH" == "armv7l" || "$BASE_ARCH" == "armhf" ) && "$(uname -m)" != "armv7l" ]]; then
52-
cp `which qemu-aarch64-static` usr/bin/qemu-aarch64-static
53-
fi
33+
setup_qemu_static "$(uname -m)" "$BASE_ARCH"
5434

5535
cp $2 chroot_script
5636
chmod 755 chroot_script
@@ -184,6 +164,7 @@ pushd "${BASE_WORKSPACE}"
184164
fi
185165
echo $ARMBIAN_CONFIG_TXT_FILE
186166
# if you need anything from common running in execute_chroot_script, export it here
167+
export -f setup_qemu_static
187168
export -f chroot_correct_qemu
188169
export -f execute_chroot_script
189170
bash -x "${CHROOT_SCRIPT}"

‎tests/test_qemu_setup.sh‎

Lines changed: 94 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,43 @@ setup_mocks() {
3939
export -f realpath
4040
}
4141

42-
# Define test matrix
42+
# Define test matrix for setup_qemu_static (QEMU binary copy logic)
43+
# Expected patterns match against the mocked cp/emerge output
44+
declare -A copy_test_matrix=(
45+
# x86_64 host -- always needs qemu
46+
["x86_64:armv7l:ubuntu"]="Copying /usr/bin/qemu-arm-static to usr/bin/qemu-arm-static"
47+
["x86_64:armhf:ubuntu"]="Copying /usr/bin/qemu-arm-static to usr/bin/qemu-arm-static"
48+
["x86_64:aarch64:ubuntu"]="Copying /usr/bin/qemu-aarch64-static to usr/bin/qemu-aarch64-static"
49+
["x86_64:arm64:ubuntu"]="Copying /usr/bin/qemu-aarch64-static to usr/bin/qemu-aarch64-static"
50+
["x86_64:armv7l:gentoo"]="Emerging qemu"
51+
["x86_64:armhf:gentoo"]="Emerging qemu"
52+
["x86_64:aarch64:gentoo"]="Emerging qemu"
53+
["x86_64:arm64:gentoo"]="Emerging qemu"
54+
55+
# armv7l host -- never needs qemu (native for armv7l/armhf, no support for aarch64)
56+
["armv7l:armv7l:ubuntu"]=""
57+
["armv7l:armhf:ubuntu"]=""
58+
["armv7l:aarch64:ubuntu"]=""
59+
["armv7l:arm64:ubuntu"]=""
60+
["armv7l:armv7l:gentoo"]=""
61+
["armv7l:armhf:gentoo"]=""
62+
["armv7l:aarch64:gentoo"]=""
63+
["armv7l:arm64:gentoo"]=""
64+
65+
# aarch64 host building aarch64/arm64 -- no qemu needed (native)
66+
["aarch64:aarch64:ubuntu"]=""
67+
["aarch64:arm64:ubuntu"]=""
68+
["aarch64:aarch64:gentoo"]=""
69+
["aarch64:arm64:gentoo"]=""
70+
71+
# aarch64 host building armv7l/armhf -- needs qemu-arm-static
72+
["aarch64:armv7l:ubuntu"]="Copying /usr/bin/qemu-arm-static to usr/bin/qemu-arm-static"
73+
["aarch64:armhf:ubuntu"]="Copying /usr/bin/qemu-arm-static to usr/bin/qemu-arm-static"
74+
["aarch64:armv7l:gentoo"]="Copying /usr/bin/qemu-arm-static to usr/bin/qemu-arm-static"
75+
["aarch64:armhf:gentoo"]="Copying /usr/bin/qemu-arm-static to usr/bin/qemu-arm-static"
76+
)
77+
78+
# Define test matrix for chroot_correct_qemu (chroot execution logic)
4379
declare -A test_matrix=(
4480
# x86_64 host
4581
["x86_64:armv7l:gentoo"]="gentoo"
@@ -113,7 +149,48 @@ print_test_matrix() {
113149
echo
114150
}
115151

116-
# Run a single test case
152+
# Run a single copy test case (for setup_qemu_static)
153+
run_copy_test_case() {
154+
local host="$1"
155+
local target="$2"
156+
local os="$3"
157+
local test_name="QEMU Copy Test"
158+
local key="${host}:${target}:${os}"
159+
local expected_pattern="${copy_test_matrix[$key]}"
160+
161+
print_test_header "$test_name"
162+
echo "Parameters:"
163+
echo " Host Architecture: $host"
164+
echo " Target Architecture: $target"
165+
echo " Operating System: $os"
166+
echo " Expected Pattern: ${expected_pattern:-(empty output)}"
167+
168+
MOCK_OS="$os"
169+
local output=$(setup_qemu_static "$host" "$target" 2>&1)
170+
local is_passed=false
171+
172+
if [[ -z "$expected_pattern" ]]; then
173+
# Expect empty output (no qemu copy needed)
174+
if [[ -z "$output" ]]; then
175+
is_passed=true
176+
fi
177+
elif [[ "$output" =~ $expected_pattern ]]; then
178+
is_passed=true
179+
fi
180+
181+
echo -e "${BLUE}Command Output:${NC}"
182+
echo "${output:-(empty)}"
183+
184+
print_test_result "$test_name" "$is_passed" "$output" "${expected_pattern:-(empty output)}"
185+
186+
if $is_passed; then
187+
return 0
188+
else
189+
return 1
190+
fi
191+
}
192+
193+
# Run a single test case (for chroot_correct_qemu)
117194
run_test_case() {
118195
local host="$1"
119196
local target="$2"
@@ -204,8 +281,21 @@ run_tests() {
204281
# Print test matrix
205282
print_test_matrix
206283

207-
# Run architecture combination tests
208-
echo -e "${BLUE}Running Architecture Combination Tests${NC}"
284+
# Run QEMU copy tests (setup_qemu_static)
285+
echo -e "${BLUE}Running QEMU Binary Copy Tests (setup_qemu_static)${NC}"
286+
for key in "${!copy_test_matrix[@]}"; do
287+
IFS=':' read -r host target os <<< "$key"
288+
((test_count++))
289+
290+
if run_copy_test_case "$host" "$target" "$os"; then
291+
((tests_passed++))
292+
else
293+
failed_tests+=("copy:$key")
294+
fi
295+
done
296+
297+
# Run architecture combination tests (chroot_correct_qemu)
298+
echo -e "${BLUE}Running Chroot Execution Tests (chroot_correct_qemu)${NC}"
209299
for key in "${!test_matrix[@]}"; do
210300
IFS=':' read -r host target os <<< "$key"
211301
((test_count++))

0 commit comments

Comments
 (0)