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#  DEFAULT_IMAGE_LOC  = The image location of the target MACHINE. Default to
53#                       "./tmp/deploy/images/"
54#
55###############################################################################
56
57set -uo pipefail
58
59QEMU_RUN_TIMER=${QEMU_RUN_TIMER:-300}
60QEMU_LOGIN_TIMER=${QEMU_LOGIN_TIMER:-180}
61WORKSPACE=${WORKSPACE:-${HOME}/${RANDOM}${RANDOM}}
62DOCKER_IMG_NAME=${DOCKER_IMG_NAME:-openbmc/ubuntu-robot-qemu}
63OBMC_BUILD_DIR=${OBMC_BUILD_DIR:-/tmp/openbmc/build}
64UPSTREAM_WORKSPACE=${UPSTREAM_WORKSPACE:-${1}}
65LAUNCH=${LAUNCH:-local}
66DEFAULT_MACHINE=versatilepb
67MACHINE=${MACHINE:-${DEFAULT_MACHINE}}
68DEFAULT_IMAGE_LOC=${DEFAULT_IMAGE_LOC:-./tmp/deploy/images/}
69
70# The automated test suite needs a real machine type so
71# if we're using versatilepb for our qemu start parameter
72# then we need to just let our run-robot use the default
73if [[ "$MACHINE" == "$DEFAULT_MACHINE" ]]; then
74    MACHINE_QEMU=
75else
76    MACHINE_QEMU=${MACHINE}
77fi
78
79# Determine the architecture
80ARCH=$(uname -m)
81
82# Determine the prefix of the Dockerfile's base image and the QEMU_ARCH variable
83case ${ARCH} in
84    "ppc64le")
85        QEMU_ARCH="ppc64le-linux"
86        ;;
87    "x86_64")
88        QEMU_ARCH="x86_64-linux"
89        ;;
90    "aarch64")
91        QEMU_ARCH="arm64-linux"
92        ;;
93    *)
94        echo "Unsupported system architecture(${ARCH}) found for docker image"
95        exit 1
96esac
97
98# Set the location of the qemu binary relative to UPSTREAM_WORKSPACE
99QEMU_BIN=${QEMU_BIN:-./tmp/sysroots/${QEMU_ARCH}/usr/bin/qemu-system-arm}
100
101# Get the base directory of the openbmc-build-scripts repo so we can return
102DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
103
104# Create the base Docker image for QEMU and Robot
105# shellcheck source=scripts/build-qemu-robot-docker.sh
106. "$DIR/scripts/build-qemu-robot-docker.sh" "$DOCKER_IMG_NAME"
107
108# Copy the scripts to start and verify QEMU in the workspace
109cp "$DIR"/scripts/boot-qemu* "${UPSTREAM_WORKSPACE}"
110
111################################################################################
112
113if [[ ${LAUNCH} == "local" ]]; then
114
115    # Start QEMU docker instance
116    # root in docker required to open up the https/ssh ports
117    obmc_qemu_docker=$(docker run --detach \
118            --rm \
119            --user root \
120            --env HOME="${OBMC_BUILD_DIR}" \
121            --env QEMU_RUN_TIMER="${QEMU_RUN_TIMER}" \
122            --env QEMU_ARCH="${QEMU_ARCH}" \
123            --env QEMU_BIN="${QEMU_BIN}" \
124            --env MACHINE="${MACHINE}" \
125            --env DEFAULT_IMAGE_LOC="${DEFAULT_IMAGE_LOC}" \
126            --workdir "${OBMC_BUILD_DIR}"           \
127            --volume "${UPSTREAM_WORKSPACE}:${OBMC_BUILD_DIR}:ro" \
128            --tty \
129        "${DOCKER_IMG_NAME}" "${OBMC_BUILD_DIR}"/boot-qemu-test.exp)
130
131    # We can use default ports because we're going to have the 2
132    # docker instances talk over their private network
133    DOCKER_SSH_PORT=22
134    DOCKER_HTTPS_PORT=443
135
136    # This docker command intermittently asserts a SIGPIPE which
137    # causes the whole script to fail. The IP address comes through
138    # fine on these errors so just ignore the SIGPIPE
139    trap '' PIPE
140
141    DOCKER_QEMU_IP_ADDR="$(docker inspect "$obmc_qemu_docker" |  \
142                       grep "IPAddress\":" | tail -n1 | cut -d '"' -f 4)"
143
144    #Now wait for the OpenBMC QEMU Docker instance to get to standby
145    delay=5
146    attempt=$(( QEMU_LOGIN_TIMER / delay ))
147    while [ $attempt -gt 0 ]; do
148        attempt=$(( attempt - 1 ))
149        echo "Waiting for qemu to get to standby (attempt: $attempt)..."
150        result=$(docker logs "$obmc_qemu_docker")
151        if grep -q 'OPENBMC-READY' <<< "$result" ; then
152            echo "QEMU is ready!"
153            # Give QEMU a few secs to stabilize
154            sleep $delay
155            break
156        fi
157        sleep $delay
158    done
159
160    if [ "$attempt" -eq 0 ]; then
161        echo "Timed out waiting for QEMU, exiting"
162        exit 1
163    fi
164
165    # Now run the Robot test (Tests commented out until they are working again)
166
167    # Timestamp for job
168    echo "Robot Test started, $(date)"
169
170    mkdir -p "${WORKSPACE}"
171    cd "${WORKSPACE}"
172
173    # Copy in the script which will execute the Robot tests
174    cp "$DIR"/scripts/run-robot.sh "${WORKSPACE}"
175
176    # Run the Docker container to execute the Robot test cases
177    # The test results will be put in ${WORKSPACE}
178    docker run --rm \
179        --env HOME="${HOME}" \
180        --env IP_ADDR="${DOCKER_QEMU_IP_ADDR}" \
181        --env SSH_PORT="${DOCKER_SSH_PORT}" \
182        --env HTTPS_PORT="${DOCKER_HTTPS_PORT}" \
183        --env MACHINE="${MACHINE_QEMU}" \
184        --workdir "${HOME}" \
185        --volume "${WORKSPACE}":"${HOME}" \
186        --tty \
187        "${DOCKER_IMG_NAME}" "${HOME}"/run-robot.sh
188
189    # Now stop the QEMU Docker image
190    docker stop "$obmc_qemu_docker"
191
192else
193    echo "LAUNCH variable invalid, Exiting"
194    exit 1
195fi
196