1#!/bin/bash -xe
2#
3# Build the required docker image to run QEMU and Robot test cases
4
5# Script Variables:
6#  UBUNTU_MIRROR:    <optional, the URL of a mirror of Ubuntu to override the
7#                    default ones in /etc/apt/sources.list>
8#                    default is empty, and no mirror is used.
9#  PIP_MIRROR:       <optional, the URL of a PIP mirror>
10#                    default is empty, and no mirror is used.
11#
12#  Parameters:
13#   parm1:  <optional, the name of the docker image to generate>
14#            default is openbmc/ubuntu-robot-qemu
15#   param2: <optional, the distro to build a docker image against>
16
17set -uo pipefail
18
19http_proxy=${http_proxy:-}
20
21DOCKER_IMG_NAME=${1:-"openbmc/ubuntu-robot-qemu"}
22DISTRO=${2:-"ubuntu:jammy"}
23UBUNTU_MIRROR=${UBUNTU_MIRROR:-""}
24PIP_MIRROR=${PIP_MIRROR:-""}
25
26# Determine our architecture, ppc64le or the other one
27if [ "$(uname -m)" == "ppc64le" ]; then
28    DOCKER_BASE="ppc64le/"
29else
30    DOCKER_BASE=""
31fi
32
33MIRROR=""
34if [[ -n "${UBUNTU_MIRROR}" ]]; then
35    MIRROR="RUN echo \"deb ${UBUNTU_MIRROR} \$(. /etc/os-release && echo \$VERSION_CODENAME) main restricted universe multiverse\" > /etc/apt/sources.list && \
36        echo \"deb ${UBUNTU_MIRROR} \$(. /etc/os-release && echo \$VERSION_CODENAME)-updates main restricted universe multiverse\" >> /etc/apt/sources.list && \
37        echo \"deb ${UBUNTU_MIRROR} \$(. /etc/os-release && echo \$VERSION_CODENAME)-security main restricted universe multiverse\" >> /etc/apt/sources.list && \
38        echo \"deb ${UBUNTU_MIRROR} \$(. /etc/os-release && echo \$VERSION_CODENAME)-proposed main restricted universe multiverse\" >> /etc/apt/sources.list && \
39        echo \"deb ${UBUNTU_MIRROR} \$(. /etc/os-release && echo \$VERSION_CODENAME)-backports main restricted universe multiverse\" >> /etc/apt/sources.list"
40fi
41
42PIP_MIRROR_CMD=""
43if [[ -n "${PIP_MIRROR}" ]]; then
44    PIP_HOSTNAME=$(echo "${PIP_MIRROR}" | awk -F[/:] '{print $4}')
45    PIP_MIRROR_CMD="RUN mkdir -p \${HOME}/.pip && \
46        echo \"[global]\" > \${HOME}/.pip/pip.conf && \
47        echo \"index-url=${PIP_MIRROR}\" >> \${HOME}/.pip/pip.conf &&\
48        echo \"[install]\" >> \${HOME}/.pip/pip.conf &&\
49        echo \"trusted-host=${PIP_HOSTNAME}\" >> \${HOME}/.pip/pip.conf"
50fi
51
52################################# docker img # #################################
53# Create docker image that can run QEMU and Robot Tests
54Dockerfile=$(cat << EOF
55FROM ${DOCKER_BASE}${DISTRO}
56
57${MIRROR}
58
59ARG DEBIAN_FRONTEND=noninteractive
60
61RUN apt-get update && apt-get install -yy \
62    debianutils \
63    gawk \
64    git \
65    python2 \
66    python2-dev \
67    python-setuptools \
68    python3 \
69    python3-dev \
70    python3-setuptools \
71    socat \
72    texinfo \
73    wget \
74    gcc \
75    libffi-dev \
76    libssl-dev \
77    xterm \
78    mwm \
79    ssh \
80    vim \
81    iputils-ping \
82    sudo \
83    cpio \
84    unzip \
85    diffstat \
86    expect \
87    curl \
88    build-essential \
89    libpixman-1-0 \
90    libglib2.0-0 \
91    sshpass \
92    libasound2 \
93    libfdt1 \
94    libpcre3 \
95    libslirp-dev \
96    openssl \
97    libxml2-dev \
98    libxslt-dev \
99    python3-pip \
100    ipmitool \
101    xvfb \
102    rustc
103
104RUN apt-get update -qqy \
105  && apt-get -qqy --no-install-recommends install firefox \
106  && wget --no-verbose -O /tmp/firefox.tar.bz2 https://download-installer.cdn.mozilla.net/pub/firefox/releases/112.0.2/linux-x86_64/en-US/firefox-112.0.2.tar.bz2 \
107  && apt-get -y purge firefox \
108  && tar -C /opt -xjf /tmp/firefox.tar.bz2 \
109  && mv /opt/firefox /opt/firefox-112.0.2 \
110  && ln -fs /opt/firefox-112.0.2/firefox /usr/bin/firefox
111
112ENV HOME ${HOME}
113
114${PIP_MIRROR_CMD}
115
116RUN pip3 install \
117    tox \
118    requests \
119    retrying \
120    websocket-client \
121    json2yaml \
122    robotframework==6.1.1 \
123    robotframework-requests \
124    robotframework-jsonlibrary \
125    robotframework-sshlibrary \
126    robotframework-scplibrary \
127    pysnmp \
128    redfish>=3.1.7 \
129    beautifulsoup4 --upgrade \
130    lxml \
131    jsonschema \
132    redfishtool \
133    redfish_utilities \
134    robotframework-httplibrary \
135    robotframework-seleniumlibrary==6.0.0 \
136    robotframework-xvfb==1.2.2 \
137    robotframework-angularjs \
138    scp \
139    selenium==4.8.2 \
140    urllib3 \
141    click \
142    xvfbwrapper==0.2.9
143
144RUN wget https://github.com/mozilla/geckodriver/releases/download/v0.32.2/geckodriver-v0.32.2-linux64.tar.gz \
145        && tar xvzf geckodriver-*.tar.gz \
146        && mv geckodriver /usr/local/bin \
147        && chmod a+x /usr/local/bin/geckodriver
148
149RUN grep -q ${GROUPS[0]} /etc/group || groupadd -g ${GROUPS[0]} ${USER}
150RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -l -m -u ${UID} -g ${GROUPS[0]} \
151                    ${USER}
152USER ${USER}
153RUN /bin/bash
154EOF
155)
156
157################################# docker img # #################################
158
159PROXY_ARGS=""
160if [[ -n "${http_proxy}" ]]; then
161    PROXY_ARGS="--build-arg http_proxy=${http_proxy} --build-arg https_proxy=${http_proxy}"
162fi
163
164# Build above image
165# shellcheck disable=SC2086 # PROXY_ARGS is intentionally word-split.
166docker build ${PROXY_ARGS} -t "${DOCKER_IMG_NAME}" - <<< "${Dockerfile}"
167