1#!/bin/bash -xe 2############################################################################### 3# 4# This script is for starting QEMU against the input build and running the 5# robot CI test suite against it.(ROBOT CI TEST CURRENTLY WIP) 6# 7############################################################################### 8# 9# Parameters used by the script: 10# UPSTREAM_WORKSPACE = The directory from which the QEMU components are being 11# imported from. Generally, this is the build directory 12# that is generated by the OpenBMC build-setup.sh script 13# when run with "target=qemuarm". 14# Example: /home/builder/workspace/openbmc-build/build. 15# 16# Optional Variables: 17# 18# WORKSPACE = Path of the workspace directory where some intermediate 19# files will be saved to. 20# QEMU_RUN_TIMER = Defaults to 300, a timer for the QEMU container. 21# QEMU_LOGIN_TIMER = Defaults to 180, a timer for the QEMU container to reach 22# login. 23# DOCKER_IMG_NAME = Defaults to openbmc/ubuntu-robot-qemu, the name the 24# Docker image will be tagged with when built. 25# OBMC_BUILD_DIR = Defaults to /tmp/openbmc/build, the path to the 26# directory where the UPSTREAM_WORKSPACE build files will 27# be mounted to. Since the build containers have been 28# changed to use /tmp as the parent directory for their 29# builds, move the mounting location to be the same to 30# resolve issues with file links or referrals to exact 31# paths in the original build directory. If the build 32# directory was changed in the build-setup.sh run, this 33# variable should also be changed. Otherwise, the default 34# should be used. 35# LAUNCH = Used to determine how to launch the qemu robot test 36# containers. The options are "local", and "k8s". It will 37# default to local which will launch a single container 38# to do the runs. If specified k8s will launch a group of 39# containers into a kubernetes cluster using the helper 40# script. 41# QEMU_BIN = Location of qemu-system-arm binary to use when starting 42# QEMU relative to upstream workspace. Default is 43# ./tmp/sysroots/${QEMU_ARCH}/usr/bin/qemu-system-arm 44# which is the default location when doing a bitbake 45# of obmc-phosphor-image. If you don't find the sysroots 46# folder, run `bitbake build-sysroots`. 47# 48# MACHINE = Machine to run test against. The options are "witherspoon", 49# "palmetto", "romulus", or undefined (default). Default 50# will use the versatilepb model. 51############################################################################### 52 53set -uo pipefail 54 55QEMU_RUN_TIMER=${QEMU_RUN_TIMER:-300} 56QEMU_LOGIN_TIMER=${QEMU_LOGIN_TIMER:-180} 57WORKSPACE=${WORKSPACE:-${HOME}/${RANDOM}${RANDOM}} 58DOCKER_IMG_NAME=${DOCKER_IMG_NAME:-openbmc/ubuntu-robot-qemu} 59OBMC_BUILD_DIR=${OBMC_BUILD_DIR:-/tmp/openbmc/build} 60UPSTREAM_WORKSPACE=${UPSTREAM_WORKSPACE:-${1}} 61LAUNCH=${LAUNCH:-local} 62DEFAULT_MACHINE=versatilepb 63MACHINE=${MACHINE:-${DEFAULT_MACHINE}} 64 65# The automated test suite needs a real machine type so 66# if we're using versatilepb for our qemu start parameter 67# then we need to just let our run-robot use the default 68if [[ "$MACHINE" == "$DEFAULT_MACHINE" ]]; then 69 MACHINE_QEMU= 70else 71 MACHINE_QEMU=${MACHINE} 72fi 73 74# Determine the architecture 75ARCH=$(uname -m) 76 77# Determine the prefix of the Dockerfile's base image and the QEMU_ARCH variable 78case ${ARCH} in 79 "ppc64le") 80 QEMU_ARCH="ppc64le-linux" 81 ;; 82 "x86_64") 83 QEMU_ARCH="x86_64-linux" 84 ;; 85 "aarch64") 86 QEMU_ARCH="arm64-linux" 87 ;; 88 *) 89 echo "Unsupported system architecture(${ARCH}) found for docker image" 90 exit 1 91esac 92 93# Set the location of the qemu binary relative to UPSTREAM_WORKSPACE 94QEMU_BIN=${QEMU_BIN:-./tmp/sysroots/${QEMU_ARCH}/usr/bin/qemu-system-arm} 95 96# Get the base directory of the openbmc-build-scripts repo so we can return 97DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" 98 99# Create the base Docker image for QEMU and Robot 100# shellcheck source=scripts/build-qemu-robot-docker.sh 101. "$DIR/scripts/build-qemu-robot-docker.sh" "$DOCKER_IMG_NAME" 102 103# Copy the scripts to start and verify QEMU in the workspace 104cp "$DIR"/scripts/boot-qemu* "${UPSTREAM_WORKSPACE}" 105 106################################################################################ 107 108if [[ ${LAUNCH} == "local" ]]; then 109 110 # Start QEMU docker instance 111 # root in docker required to open up the https/ssh ports 112 obmc_qemu_docker=$(docker run --detach \ 113 --rm \ 114 --user root \ 115 --env HOME="${OBMC_BUILD_DIR}" \ 116 --env QEMU_RUN_TIMER="${QEMU_RUN_TIMER}" \ 117 --env QEMU_ARCH="${QEMU_ARCH}" \ 118 --env QEMU_BIN="${QEMU_BIN}" \ 119 --env MACHINE="${MACHINE}" \ 120 --workdir "${OBMC_BUILD_DIR}" \ 121 --volume "${UPSTREAM_WORKSPACE}:${OBMC_BUILD_DIR}:ro" \ 122 --tty \ 123 "${DOCKER_IMG_NAME}" "${OBMC_BUILD_DIR}"/boot-qemu-test.exp) 124 125 # We can use default ports because we're going to have the 2 126 # docker instances talk over their private network 127 DOCKER_SSH_PORT=22 128 DOCKER_HTTPS_PORT=443 129 130 # This docker command intermittently asserts a SIGPIPE which 131 # causes the whole script to fail. The IP address comes through 132 # fine on these errors so just ignore the SIGPIPE 133 trap '' PIPE 134 135 DOCKER_QEMU_IP_ADDR="$(docker inspect "$obmc_qemu_docker" | \ 136 grep "IPAddress\":" | tail -n1 | cut -d '"' -f 4)" 137 138 #Now wait for the OpenBMC QEMU Docker instance to get to standby 139 delay=5 140 attempt=$(( QEMU_LOGIN_TIMER / delay )) 141 while [ $attempt -gt 0 ]; do 142 attempt=$(( attempt - 1 )) 143 echo "Waiting for qemu to get to standby (attempt: $attempt)..." 144 result=$(docker logs "$obmc_qemu_docker") 145 if grep -q 'OPENBMC-READY' <<< "$result" ; then 146 echo "QEMU is ready!" 147 # Give QEMU a few secs to stabilize 148 sleep $delay 149 break 150 fi 151 sleep $delay 152 done 153 154 if [ "$attempt" -eq 0 ]; then 155 echo "Timed out waiting for QEMU, exiting" 156 exit 1 157 fi 158 159 # Now run the Robot test (Tests commented out until they are working again) 160 161 # Timestamp for job 162 echo "Robot Test started, $(date)" 163 164 mkdir -p "${WORKSPACE}" 165 cd "${WORKSPACE}" 166 167 # Copy in the script which will execute the Robot tests 168 cp "$DIR"/scripts/run-robot.sh "${WORKSPACE}" 169 170 # Run the Docker container to execute the Robot test cases 171 # The test results will be put in ${WORKSPACE} 172 docker run --rm \ 173 --env HOME="${HOME}" \ 174 --env IP_ADDR="${DOCKER_QEMU_IP_ADDR}" \ 175 --env SSH_PORT="${DOCKER_SSH_PORT}" \ 176 --env HTTPS_PORT="${DOCKER_HTTPS_PORT}" \ 177 --env MACHINE="${MACHINE_QEMU}" \ 178 --workdir "${HOME}" \ 179 --volume "${WORKSPACE}":"${HOME}" \ 180 --tty \ 181 "${DOCKER_IMG_NAME}" "${HOME}"/run-robot.sh 182 183 # Now stop the QEMU Docker image 184 docker stop "$obmc_qemu_docker" 185 186else 187 echo "LAUNCH variable invalid, Exiting" 188 exit 1 189fi 190