docker/scripts/lib_csit.sh

   1 # lib_csit.sh - Docker build script CSIT library.
   2 #               For import only.
   3
   4 # Copyright (c) 2023 Cisco and/or its affiliates.
   5 # Licensed under the Apache License, Version 2.0 (the "License");
   6 # you may not use this file except in compliance with the License.
   7 # You may obtain a copy of the License at:
   8 #
   9 #     http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing, software
  12 # distributed under the License is distributed on an "AS IS" BASIS,
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16
  17 # Don't import more than once.
  18 if [ -n "$(alias lib_csit_imported 2> /dev/null)" ] ; then
  19     return 0
  20 fi
  21 alias lib_csit_imported=true
  22
  23 export CIMAN_DOCKER_SCRIPTS="${CIMAN_DOCKER_SCRIPTS:-$(dirname $BASH_SOURCE)}"
  24 . "$CIMAN_DOCKER_SCRIPTS/lib_common.sh"
  25 . "$CIMAN_DOCKER_SCRIPTS/lib_apt.sh"
  26
  27 CSIT_SUPPORTED_EXECUTOR_CLASSES="builder csit_dut"
  28 csit_supported_executor_class() {
  29     if ! grep -q "${1:-}" <<< "$CSIT_SUPPORTED_EXECUTOR_CLASSES" ; then
  30         return 1
  31     fi
  32     return 0
  33 }
  34
  35 csit_supported_os() {
  36     case "$1" in
  37         ubuntu-22.04) return 0 ;;
  38                    *) ;;
  39     esac
  40     return 1
  41 }
  42
  43 csit_checkout_branch_for_vpp() {
  44     local vpp_branch="$1"
  45     local csit_dir="$DOCKER_CSIT_DIR"
  46     local csit_bash_function_dir="$csit_dir/resources/libraries/bash/function"
  47
  48     # import checkout_csit_for_vpp() if not defined
  49     set +e && [ -z "$(declare -f checkout_csit_for_vpp)" ] \
  50         && source "$csit_bash_function_dir/branch.sh"
  51     CSIT_DIR="$csit_dir" checkout_csit_for_vpp "$vpp_branch"
  52
  53     csit_branch="$(git branch | grep -e '^*' | mawk '{print $2}')"
  54 }
  55
  56 csit_install_packages() {
  57     local branch="$1"
  58     local branchname="$(echo $branch | sed -e 's,/,_,')"
  59     local csit_dir="$DOCKER_CSIT_DIR"
  60     local csit_ansible_dir="$csit_dir/fdio.infra.ansible"
  61     if [ ! -d "$csit_ansible_dir" ] ; then
  62         csit_ansible_dir="$csit_dir/resources/tools/testbed-setup/ansible"
  63     fi
  64     local bld_log="$DOCKER_BUILD_LOG_DIR/$FDIOTOOLS_IMAGENAME"
  65     bld_log="${bld_log}-$branchname-csit_install_packages-bld.log"
  66
  67     git clean -qfdx
  68     python3 -m pip install pyyaml
  69
  70     local exclude_roles="-e calibration -e kernel -e mellanox -e nomad -e consul"
  71     [ "$OS_ARCH" = "aarch64" ] && exclude_roles="$exclude_roles -e iperf"
  72
  73     # Not in double quotes to let bash remove newline characters
  74     local yaml_files="$(grep -r packages_by $csit_ansible_dir | cut -d: -f1 | sort -u | grep -v $exclude_roles)"
  75     packages="$(dbld_csit_find_ansible_packages.py --$OS_ID --$OS_ARCH $yaml_files)"
  76     packages="${packages/bionic /}"
  77     packages="${packages/focal /}"
  78     packages="${packages/libmbedcrypto1/libmbedcrypto3}"
  79     packages="${packages/libmbedtls10/libmbedtls12}"
  80     packages="$(echo ${packages//python\-/python3\-} | tr ' ' '\n' | sort -u | xargs)"
  81
  82     if [ -n "$packages" ] ; then
  83         case "$OS_NAME" in
  84             ubuntu*)
  85                 apt_install_packages $packages
  86                 ;;
  87             debian*)
  88                 apt_install_packages $packages
  89                 ;;
  90             *)
  91                 echo "Unsupported OS ($OS_ID): CSIT packages NOT INSTALLED!"
  92                 ;;
  93         esac
  94     fi
  95 }
  96
  97 csit_pip_cache() {
  98     local branch="$1"
  99     local VENV_OPTS=""
 100     # ensure PS1 is defined (used by virtualenv activate script)
 101     PS1=${PS1:-"#"}
 102     CSIT_DIR="$DOCKER_CSIT_DIR"
 103
 104     if [ -f "$CSIT_DIR/VPP_REPO_URL" ] \
 105            && [ -f "$CSIT_DIR/requirements.txt" ]; then
 106
 107         local csit_bash_function_dir="$CSIT_DIR/resources/libraries/bash/function"
 108         local branchname="$(echo $branch | sed -e 's,/,_,')"
 109         local bld_log="$DOCKER_BUILD_LOG_DIR"
 110         bld_log="${bld_log}/$FDIOTOOLS_IMAGENAME-$branchname-csit_pip_cache-bld.log"
 111         local pip_cmd="python3 -m pip --disable-pip-version-check"
 112         export PYTHONPATH=$CSIT_DIR
 113
 114         description="Install CSIT python packages from $branch branch"
 115         echo_log "    Starting  $description..."
 116         git clean -qfdx
 117         rm -rf "$PYTHONPATH/env"
 118
 119         # TODO: Update CSIT release branches to avoid build breakage
 120         #       Fixes https://github.com/pypa/pip/issues/8260
 121         $pip_cmd install pip==21.0.1
 122         #       rls2009_lts-* branches missing cherry-pick of
 123         #       https://gerrit.fd.io/r/c/csit/+/31338
 124         sed -i 's/scipy==1.1.0/scipy==1.5.4/' "$PYTHONPATH/requirements.txt"
 125
 126         # Virtualenv version is pinned in common.sh in newer csit branches.
 127         # (note: xargs removes leading/trailing spaces)
 128         local common_sh="$csit_bash_function_dir/common.sh"
 129         install_virtualenv="$(grep 'virtualenv' $common_sh | grep pip | grep install | cut -d'|' -f1 | xargs)"
 130         $install_virtualenv
 131         virtualenv --no-download --python=$(which python3) "$CSIT_DIR/env"
 132         source "$CSIT_DIR/env/bin/activate"
 133
 134         if [ "$OS_ARCH" = "aarch64" ] ; then
 135             local numpy_ver="$(grep numpy $PYTHONPATH/requirements.txt)"
 136             [ -n "$numpy_ver" ] && $pip_cmd install $numpy_ver 2>&1 | \
 137                 tee -a $bld_log
 138         fi
 139
 140         # Install csit python requirements
 141         $pip_cmd install -r "$CSIT_DIR/requirements.txt" 2>&1 | \
 142             tee -a "$bld_log"
 143         # Install tox python requirements
 144         $pip_cmd install -r "$CSIT_DIR/tox-requirements.txt" 2>&1 | \
 145             tee -a "$bld_log"
 146         # Run tox which installs pylint requirments
 147         pushd $CSIT_DIR >& /dev/null
 148         tox || true
 149         popd >& /dev/null
 150
 151         # Clean up virtualenv directories
 152         deactivate
 153         git checkout -q -- .
 154         git clean -qfdx
 155         echo_log "    Completed $description!"
 156     else
 157         echo_log "ERROR: Missing or invalid CSIT_DIR: '$CSIT_DIR'!"
 158         return 1
 159     fi
 160 }
 161
 162 docker_build_setup_csit() {
 163     if csit_supported_executor_class "$EXECUTOR_CLASS" ; then
 164         if [ ! -d "$DOCKER_CSIT_DIR" ] ; then
 165             echo_log "Cloning CSIT into $DOCKER_CSIT_DIR..."
 166             git clone -q https://gerrit.fd.io/r/csit "$DOCKER_CSIT_DIR"
 167         fi
 168         clean_git_repo "$DOCKER_CSIT_DIR"
 169     fi
 170 }
 171
 172 csit_dut_generate_docker_build_files() {
 173     local build_files_dir="$DOCKER_BUILD_FILES_DIR"
 174
 175     mkdir -p "$build_files_dir"
 176     cat <<EOF >"$build_files_dir/supervisord.conf"
 177 [unix_http_server]
 178 file = /tmp/supervisor.sock
 179 chmod = 0777
 180
 181 [rpcinterface:supervisor]
 182 supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
 183
 184 [supervisorctl]
 185 serverurl = unix:///tmp/supervisor.sock
 186
 187 [supervisord]
 188 pidfile = /tmp/supervisord.pid
 189 identifier = supervisor
 190 directory = /tmp
 191 logfile = /tmp/supervisord.log
 192 loglevel = debug
 193 nodaemon = false
 194
 195 [program:vpp]
 196 command = /usr/bin/vpp -c /etc/vpp/startup.conf
 197 autostart = false
 198 autorestart = true
 199 redirect_stderr = true
 200 priority = 1
 201 EOF
 202 }
 203
 204 csit_builder_generate_docker_build_files() {
 205     local build_files_dir="$DOCKER_BUILD_FILES_DIR"
 206     local dashes="-----"
 207     local dbeg="${dashes}BEGIN"
 208     local dend="${dashes}END"
 209     local pvt="PRIVATE"
 210     local kd="KEY$dashes"
 211
 212     # TODO: Verify why badkey is required & figure out how to avoid it.
 213     mkdir -p "$build_files_dir"
 214     cat <<EOF >"$build_files_dir/badkey"
 215 $dbeg RSA $pvt $kd
 216 MIIEowIBAAKCAQEAslDXf4kZOQI8OGQQdIF8o83nBM0B4fzHLYLxxiY2rKiQ5MGM
 217 mQa7p1KKzmd5/NlvFRnXefnjSDQljjPxEY7mh457rX2nXvqHD4GUXZPpBIE73rQ1
 218 TViIAXdDzFXJ6ee4yX8ewmVakzYBnlUPDidkWyRnjm/xCgKUCO+CD5AH3ND0onks
 219 OYAtHqhDh29/QMIKdMnK87FBxfzhInHwpqPur76zBnpw3u36ylKEymDFrO5dwzsh
 220 QvDWjsYRg9ydTXubtwP6+MOpjdR1SNKxcCHKJrPrdAeJW9jg1imYmYpEHZ/P3qsL
 221 Jm0hGWbFjdxZLIYIz0vN/nTalcAeqT2OWKrXuwIDAQABAoIBAQCcj1g2FOR9ZlYD
 222 WPANqucJVy4/y9OcXHlwnyiyRjj47WOSRdGxRfUa2uEeikHT3ACo8TB8WwfQDGDw
 223 8u/075e+az5xvAJo5OQSnD3sz4Hmv6UWSvkFuPZo+xMe5C/M2/QljiQuoBifaeqP
 224 3rTCQ5ncYCFAMU7b8BmTot551Ybhu2jCbDMHU7nFHEFOvYinkwfVcaqkrVDUuH+D
 225 c3NkAEH9Jz2MEYA2Va4uqFpGt5lfGiED2kMenwPa8eS5LS5HJsxkfMHGlaHXHFUb
 226 D+dG/qJtSslVxdzVPgEGvzswo6TgtY1nZTQcB8U63rktFg38B7QGtOkvswAYzxyk
 227 HdMIiU3RAoGBAOdIEQRcAThj9eiIFywtBgLBOSg4SoOnvELLr6lgUg2+ICmx06LQ
 228 yaai1QRdOWw1VwZ6apNCD00kaUhBu+ou93yLSDnR2uYftkylhcnVuhDyIeNyb81V
 229 hV2z0WuNv3aKBFlBxaq391S7WW1XxhpAAagm8fZZur73wV390EVd/hZJAoGBAMVf
 230 negT2bg5PVKWvsiEU6eZ00W97tlEDLclkiZawXNnM2/c+2x1Tks6Yf1E/j2FFTB4
 231 r0fesbwN346hCejtq5Bup5YEdFA3KtwT5UyeQQLFGYlCtRmBtOd10wkRS93D0tpX
 232 iIqkf43Gpx6iFdvBWY5A7N+ZmojCy9zpL5TJ4G3jAoGADOGEoRuGrd9TWMoLkFhJ
 233 l2mvhz/rVn3HDGlPtT06FK3cGLZgtRavxGoZNw8CHbayzBeRS/ZH5+H5Qx72GkrX
 234 WcZgFWhMqrhlbMtjMiSHIl556LL86xCyRs+3ACh6211AdMAnBCUOz1dH2cEjtV6P
 235 ORBCNZg1wGEIEfYK3XIorpECgYBubXfQj8KhUs0fdx3Y3Ehdni/ZdlG7F1qx4YBq
 236 mx5e7d+Wd6Hn5Z3fcxO9+yrvypS3YN5YrJzuZSiuCSWdP9RcY7y5r1ZQRv1g0nTZ
 237 MDWZUiNea4cddTd8xKxFB3tV4SkIZi8LustuzDVWa0Mlh4EOmP6uf6c5WxtqRsEL
 238 UwORFwKBgEjZsfmZGBurjOtSrcsteulOB0D2nOqPVRWXmbSNJT/l73DkEllvVyA/
 239 wdW39nyFrA2Qw1K2F+l8DkzMd/WEjmioSWCsvTkXlvrqPfByKg01zCbYy/mhRW7d
 240 7sQrPOIl8ygsc3JrxmvzibdWmng1MehvpAM1ogWeTUa1lsDTNJ/6
 241 $dend RSA $pvt $kd
 242 EOF
 243     chmod 600 "$build_files_dir/badkey"
 244     cat <<EOF >"$build_files_dir/sshconfig"
 245 Host 172.17.0.*
 246         StrictHostKeyChecking no
 247         UserKnownHostsFile=/dev/null
 248 EOF
 249 }
 250
 251 csit_shim_generate_docker_build_files() {
 252     local build_files_dir="$DOCKER_BUILD_FILES_DIR"
 253     # TODO: Verify why badkey is required & figure out how to avoid it.
 254     local badkey='AAAAB3NzaC1yc2EAAAADAQABAAABAQCyUNd/iRk5Ajw4ZBB0gXyjzecEzQHh/MctgvHGJjasqJDkwYyZBrunUorOZ3n82W8VGdd5+eNINCWOM/ERjuaHjnutfade+ocPgZRdk+kEgTvetDVNWIgBd0PMVcnp57jJfx7CZVqTNgGeVQ8OJ2RbJGeOb/EKApQI74IPkAfc0PSieSw5gC0eqEOHb39Awgp0ycrzsUHF/OEicfCmo+6vvrMGenDe7frKUoTKYMWs7l3DOyFC8NaOxhGD3J1Ne5u3A/r4w6mN1HVI0rFwIcoms+t0B4lb2ODWKZiZikQdn8/eqwsmbSEZZsWN3FkshgjPS83+dNqVwB6pPY5Yqte7'
 255
 256     mkdir -p "$build_files_dir"
 257     # TODO: Verify why badkeypub is required & figure out how to avoid it.
 258     echo "ssh-rsa $badkey ejk@bhima.local" >"$build_files_dir/badkeypub"
 259
 260     cat <<EOF >"$build_files_dir/sshconfig"
 261 Host 172.17.0.*
 262         StrictHostKeyChecking no
 263         UserKnownHostsFile=/dev/null
 264 EOF
 265     cat <<EOF >"$build_files_dir/wrapdocker"
 266 #!/bin/bash
 267
 268 # Ensure that all nodes in /dev/mapper correspond to mapped devices currently loaded by the device-mapper kernel driver
 269 dmsetup mknodes
 270
 271 # First, make sure that cgroups are mounted correctly.
 272 CGROUP=/sys/fs/cgroup
 273 : {LOG:=stdio}
 274
 275 [ -d \$CGROUP ] ||
 276     mkdir \$CGROUP
 277
 278 mountpoint -q \$CGROUP ||
 279     mount -n -t tmpfs -o uid=0,gid=0,mode=0755 cgroup \$CGROUP || {
 280         echo "Could not make a tmpfs mount. Did you use --privileged?"
 281         exit 1
 282     }
 283
 284 if [ -d /sys/kernel/security ] && ! mountpoint -q /sys/kernel/security
 285 then
 286     mount -t securityfs none /sys/kernel/security || {
 287         echo "Could not mount /sys/kernel/security."
 288         echo "AppArmor detection and --privileged mode might break."
 289     }
 290 fi
 291
 292 # Mount the cgroup hierarchies exactly as they are in the parent system.
 293 for SUBSYS in \$(cut -d: -f2 /proc/1/cgroup)
 294 do
 295         [ -d \$CGROUP/\$SUBSYS ] || mkdir \$CGROUP/\$SUBSYS
 296         mountpoint -q \$CGROUP/\$SUBSYS ||
 297                 mount -n -t cgroup -o \$SUBSYS cgroup \$CGROUP/\$SUBSYS
 298
 299         # The two following sections address a bug which manifests itself
 300         # by a cryptic "lxc-start: no ns_cgroup option specified" when
 301         # trying to start containers withina container.
 302         # The bug seems to appear when the cgroup hierarchies are not
 303         # mounted on the exact same directories in the host, and in the
 304         # container.
 305
 306         # Named, control-less cgroups are mounted with "-o name=foo"
 307         # (and appear as such under /proc/<pid>/cgroup) but are usually
 308         # mounted on a directory named "foo" (without the "name=" prefix).
 309         # Systemd and OpenRC (and possibly others) both create such a
 310         # cgroup. To avoid the aforementioned bug, we symlink "foo" to
 311         # "name=foo". This shouldn't have any adverse effect.
 312         echo \$SUBSYS | grep -q ^name= && {
 313                 NAME=\$(echo \$SUBSYS | sed s/^name=//)
 314                 ln -s \$SUBSYS \$CGROUP/\$NAME
 315         }
 316
 317         # Likewise, on at least one system, it has been reported that
 318         # systemd would mount the CPU and CPU accounting controllers
 319         # (respectively "cpu" and "cpuacct") with "-o cpuacct,cpu"
 320         # but on a directory called "cpu,cpuacct" (note the inversion
 321         # in the order of the groups). This tries to work around it.
 322         [ \$SUBSYS = cpuacct,cpu ] && ln -s \$SUBSYS \$CGROUP/cpu,cpuacct
 323 done
 324
 325 # Note: as I write those lines, the LXC userland tools cannot setup
 326 # a "sub-container" properly if the "devices" cgroup is not in its
 327 # own hierarchy. Let's detect this and issue a warning.
 328 grep -q :devices: /proc/1/cgroup ||
 329     echo "WARNING: the 'devices' cgroup should be in its own hierarchy."
 330 grep -qw devices /proc/1/cgroup ||
 331     echo "WARNING: it looks like the 'devices' cgroup is not mounted."
 332
 333 # Now, close extraneous file descriptors.
 334 pushd /proc/self/fd >/dev/null
 335 for FD in *
 336 do
 337     case "\$FD" in
 338     # Keep stdin/stdout/stderr
 339     [012])
 340         ;;
 341     # Nuke everything else
 342     *)
 343         eval exec "\$FD>&-"
 344         ;;
 345     esac
 346 done
 347 popd >/dev/null
 348
 349
 350 # If a pidfile is still around (for example after a container restart),
 351 # delete it so that docker can start.
 352 rm -rf /var/run/docker.pid
 353
 354 # If we were given a PORT environment variable, start as a simple daemon;
 355 # otherwise, spawn a shell as well
 356 if [ "\$PORT" ]
 357 then
 358     exec dockerd -H 0.0.0.0:\$PORT -H unix:///var/run/docker.sock \
 359         \$DOCKER_DAEMON_ARGS
 360 else
 361     if [ "\$LOG" == "file" ]
 362     then
 363         dockerd \$DOCKER_DAEMON_ARGS &>/var/log/docker.log &
 364     else
 365         dockerd \$DOCKER_DAEMON_ARGS &
 366     fi
 367     (( timeout = 60 + SECONDS ))
 368     until docker info >/dev/null 2>&1
 369     do
 370         if (( SECONDS >= timeout )); then
 371             echo 'Timed out trying to connect to internal docker host.' >&2
 372             break
 373         fi
 374         sleep 1
 375     done
 376     [[ \$1 ]] && exec "\$@"
 377     exec bash --login
 378 fi
 379 EOF
 380 }