path: root/tools/run_tests.sh

#!/bin/bash

# Copyright 2018 The gVisor Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Fail on any error. Treat unset variables as error. Print commands as executed.
set -eux

###################
# GLOBAL ENV VARS #
###################

if [[ -v KOKORO_GIT_COMMIT ]] && [[ -d git/repo ]]; then
  readonly WORKSPACE_DIR="${PWD}/git/repo"
elif [[ -v KOKORO_GIT_COMMIT ]] && [[ -d github/repo ]]; then
  readonly WORKSPACE_DIR="${PWD}/github/repo"
else
  readonly WORKSPACE_DIR="${PWD}"
fi

# Used to configure RBE.
readonly CLOUD_PROJECT_ID="gvisor-rbe"
readonly RBE_PROJECT_ID="projects/${CLOUD_PROJECT_ID}/instances/default_instance"

# Random runtime name to avoid collisions.
readonly RUNTIME="runsc_test_$((RANDOM))"

# Packages that will be built and tested.
readonly BUILD_PACKAGES=("//...")
readonly TEST_PACKAGES=("//pkg/..." "//runsc/..." "//tools/...")

#######################
# BAZEL CONFIGURATION #
#######################

# Install the latest version of Bazel and log the version.
(which use_bazel.sh && use_bazel.sh 0.28.0) || which bazel
bazel version

# Load the kvm module.
sudo -n -E modprobe kvm

# General Bazel build/test flags.
BAZEL_BUILD_FLAGS=(
  "--show_timestamps"
  "--test_output=errors"
  "--keep_going"
  "--verbose_failures=true"
)

# Bazel build/test for RBE, a super-set of BAZEL_BUILD_FLAGS.
BAZEL_BUILD_RBE_FLAGS=(
  "${BAZEL_BUILD_FLAGS[@]}"
  "--config=remote"
  "--project_id=${CLOUD_PROJECT_ID}"
  "--remote_instance_name=${RBE_PROJECT_ID}"
)
if [[ -v KOKORO_BAZEL_AUTH_CREDENTIAL ]]; then
  BAZEL_BUILD_RBE_FLAGS=(
    "${BAZEL_BUILD_RBE_FLAGS[@]}"
    "--auth_credentials=${KOKORO_BAZEL_AUTH_CREDENTIAL}"
  )
fi

####################
# Helper Functions #
####################

sanity_checks() {
  cd ${WORKSPACE_DIR}
  bazel run //:gazelle -- update-repos -from_file=go.mod
  git diff --exit-code WORKSPACE
}

build_everything() {
  FLAVOR="${1}"

  cd ${WORKSPACE_DIR}
  bazel build \
    -c "${FLAVOR}" "${BAZEL_BUILD_RBE_FLAGS[@]}" \
    "${BUILD_PACKAGES[@]}"
}

build_runsc_debian() {
  cd ${WORKSPACE_DIR}

  # TODO(b/135475885): pkg_deb is incompatible with Python3.
  # https://github.com/bazelbuild/bazel/issues/8443
  bazel build --host_force_python=py2 runsc:runsc-debian
}

# Run simple tests runs the tests that require no special setup or
# configuration.
run_simple_tests() {
  cd ${WORKSPACE_DIR}
  bazel test \
    "${BAZEL_BUILD_FLAGS[@]}" \
    "${TEST_PACKAGES[@]}"
}

install_runtime() {
  cd ${WORKSPACE_DIR}
  sudo -n ${WORKSPACE_DIR}/runsc/test/install.sh --runtime ${RUNTIME}
}

install_helper() {
  PACKAGE="${1}"
  TAG="${2}"
  GOPATH="${3}"

  # Clone the repository.
  mkdir -p "${GOPATH}"/src/$(dirname "${PACKAGE}") && \
     git clone https://"${PACKAGE}" "${GOPATH}"/src/"${PACKAGE}"

  # Checkout and build the repository.
  (cd "${GOPATH}"/src/"${PACKAGE}" && \
      git checkout "${TAG}" && \
      GOPATH="${GOPATH}" make && \
      sudo -n -E env GOPATH="${GOPATH}" make install)
}

# Install dependencies for the crictl tests.
install_crictl_test_deps() {
  sudo -n -E apt-get update
  sudo -n -E apt-get install -y btrfs-tools libseccomp-dev

  # Install containerd & cri-tools.
  GOPATH=$(mktemp -d --tmpdir gopathXXXXX)
  install_helper github.com/containerd/containerd v1.2.2 "${GOPATH}"
  install_helper github.com/kubernetes-sigs/cri-tools v1.11.0 "${GOPATH}"

  # Install gvisor-containerd-shim.
  local latest=/tmp/gvisor-containerd-shim-latest
  local shim_path=/tmp/gvisor-containerd-shim
  wget --no-verbose https://storage.googleapis.com/cri-containerd-staging/gvisor-containerd-shim/latest -O ${latest}
  wget --no-verbose https://storage.googleapis.com/cri-containerd-staging/gvisor-containerd-shim/gvisor-containerd-shim-$(cat ${latest}) -O ${shim_path}
  chmod +x ${shim_path}
  sudo -n -E mv ${shim_path} /usr/local/bin

  # Configure containerd-shim.
  local shim_config_path=/etc/containerd
  local shim_config_tmp_path=/tmp/gvisor-containerd-shim.toml
  sudo -n -E mkdir -p ${shim_config_path}
  cat > ${shim_config_tmp_path} <<-EOF
    runc_shim = "/usr/local/bin/containerd-shim"

    [runsc_config]
      debug = "true"
      debug-log = "/tmp/runsc-logs/"
      strace = "true"
      file-access = "shared"
EOF
  sudo mv ${shim_config_tmp_path} ${shim_config_path}

  # Configure CNI.
  (cd "${GOPATH}" && sudo -n -E env PATH="${PATH}" GOPATH="${GOPATH}" \
      src/github.com/containerd/containerd/script/setup/install-cni)
}

# Run the tests that require docker.
run_docker_tests() {
  cd ${WORKSPACE_DIR}

  # Run tests with a default runtime (runc).
  bazel test \
    "${BAZEL_BUILD_FLAGS[@]}" \
    --test_env=RUNSC_RUNTIME="" \
    //runsc/test/image:image_test

  # These names are used to exclude tests not supported in certain
  # configuration, e.g. save/restore not supported with hostnet.
  # Run runsc tests with docker that are tagged manual.
  #
  # The --nocache_test_results option is used here to eliminate cached results
  # from the previous run for the runc runtime.
  bazel test \
    "${BAZEL_BUILD_FLAGS[@]}" \
    --test_env=RUNSC_RUNTIME="${RUNTIME}" \
    --nocache_test_results \
    //runsc/test/integration:integration_test \
    //runsc/test/integration:integration_test_hostnet \
    //runsc/test/integration:integration_test_overlay \
    //runsc/test/integration:integration_test_kvm \
    //runsc/test/image:image_test \
    //runsc/test/image:image_test_overlay \
    //runsc/test/image:image_test_hostnet \
    //runsc/test/image:image_test_kvm
}

# Run the tests that require root.
run_root_tests() {
  cd ${WORKSPACE_DIR}
  bazel build //runsc/test/root:root_test
  local root_test=$(find -L ./bazel-bin/ -executable -type f -name root_test | grep __main__)
  if [[ ! -f "${root_test}" ]]; then
    echo "root_test executable not found"
    exit 1
  fi
  sudo -n -E RUNSC_RUNTIME="${RUNTIME}" RUNSC_EXEC=/tmp/"${RUNTIME}"/runsc ${root_test}
}

# Run syscall unit tests.
run_syscall_tests() {
  cd ${WORKSPACE_DIR}
  bazel test "${BAZEL_BUILD_RBE_FLAGS[@]}" \
    --test_tag_filters=runsc_ptrace //test/syscalls/...
}

run_runsc_do_tests() {
  local runsc=$(find bazel-bin/runsc -type f -executable -name "runsc" | head -n1)

  # run runsc do without root privileges.
  ${runsc} --rootless do true
  ${runsc} --rootless --network=none do true

  # run runsc do with root privileges.
  sudo -n -E ${runsc} do true
}

# Find and rename all test xml and log files so that Sponge can pick them up.
# XML files must be named sponge_log.xml, and log files must be named
# sponge_log.log. We move all such files into KOKORO_ARTIFACTS_DIR, in a
# subdirectory named with the test name.
upload_test_artifacts() {
  # Skip if no kokoro directory.
  [[ -v KOKORO_ARTIFACTS_DIR ]] || return

  cd ${WORKSPACE_DIR}
  find -L "bazel-testlogs" -name "test.xml" -o -name "test.log" -o -name "outputs.zip" |
    tar --create --files-from - --transform 's/test\./sponge_log./' |
    tar --extract --directory ${KOKORO_ARTIFACTS_DIR}
  if [[ -d "/tmp/${RUNTIME}/logs" ]]; then
    tar --create --gzip "--file=${KOKORO_ARTIFACTS_DIR}/runsc-logs.tar.gz" -C /tmp/ ${RUNTIME}/logs
  fi
}

# Finish runs in the event of an error, uploading all artifacts.
finish() {
  # Grab the last exit code, we will return it.
  local exit_code=${?}
  upload_test_artifacts
  exit ${exit_code}
}

# Run bazel in a docker container
build_in_docker() {
  cd ${WORKSPACE_DIR}
  bazel clean
  bazel shutdown
  make
  make runsc
  make bazel-shutdown
}

########
# MAIN #
########

main() {
  # Register finish to run at exit.
  trap finish EXIT

  # Build and run the simple tests.
  sanity_checks
  build_everything opt
  run_simple_tests

  # So far so good. Install more deps and run the integration tests.
  install_runtime
  install_crictl_test_deps
  run_docker_tests
  run_root_tests

  run_syscall_tests
  run_runsc_do_tests

  build_runsc_debian

  # Build other flavors too.
  build_everything dbg

  # We need to upload all the existing test logs and artifacts before shutting
  # down and cleaning bazel, otherwise all test information is lost. After this
  # point, we don't expect any logs or artifacts.
  upload_test_artifacts
  trap - EXIT

  # Run docker build tests.
  build_in_docker
}

# Kick it off.
main