From aefb8c98b00ffd23543f295b9b5b70532f1afee9 Mon Sep 17 00:00:00 2001 From: Takashi Matsuo Date: Thu, 11 Jul 2019 13:11:32 -0700 Subject: Add ci scripts (#1) * Add ci scripts * Move config files to ci/kokoro/docker * Remove dump-logs etc * Simplified grpc installation * Add Ubuntu 16.04 kokoro config * Address code review --- ci/kokoro/docker/build-in-docker-cmake.sh | 108 ++++++++++++++ ci/kokoro/docker/build.sh | 218 ++++++++++++++++++++++++++++ ci/kokoro/docker/clang-3.8-presubmit.cfg | 0 ci/kokoro/docker/clang-3.8.cfg | 0 ci/kokoro/docker/clang-tidy-presubmit.cfg | 0 ci/kokoro/docker/clang-tidy.cfg | 0 ci/kokoro/docker/common.cfg | 17 +++ ci/kokoro/docker/gcc-4.8-presubmit.cfg | 0 ci/kokoro/docker/gcc-4.8.cfg | 0 ci/kokoro/docker/ubuntu-16.04-presubmit.cfg | 0 ci/kokoro/docker/ubuntu-16.04.cfg | 0 ci/kokoro/docker/ubuntu-18.04-presubmit.cfg | 0 ci/kokoro/docker/ubuntu-18.04.cfg | 0 13 files changed, 343 insertions(+) create mode 100755 ci/kokoro/docker/build-in-docker-cmake.sh create mode 100755 ci/kokoro/docker/build.sh create mode 100644 ci/kokoro/docker/clang-3.8-presubmit.cfg create mode 100644 ci/kokoro/docker/clang-3.8.cfg create mode 100644 ci/kokoro/docker/clang-tidy-presubmit.cfg create mode 100644 ci/kokoro/docker/clang-tidy.cfg create mode 100644 ci/kokoro/docker/common.cfg create mode 100644 ci/kokoro/docker/gcc-4.8-presubmit.cfg create mode 100644 ci/kokoro/docker/gcc-4.8.cfg create mode 100644 ci/kokoro/docker/ubuntu-16.04-presubmit.cfg create mode 100644 ci/kokoro/docker/ubuntu-16.04.cfg create mode 100644 ci/kokoro/docker/ubuntu-18.04-presubmit.cfg create mode 100644 ci/kokoro/docker/ubuntu-18.04.cfg (limited to 'ci/kokoro/docker') diff --git a/ci/kokoro/docker/build-in-docker-cmake.sh b/ci/kokoro/docker/build-in-docker-cmake.sh new file mode 100755 index 000000000000..38e0d3d7885b --- /dev/null +++ b/ci/kokoro/docker/build-in-docker-cmake.sh @@ -0,0 +1,108 @@ +#!/usr/bin/env bash +# Copyright 2019 Google LLC +# +# 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. + +set -eu + +if [[ $# != 2 ]]; then + echo "Usage: $(basename "$0") " + exit 1 +fi + +readonly SOURCE_DIR="$1" +readonly BINARY_DIR="$2" + +# This script is supposed to run inside a Docker container, see +# ci/kokoro/cmake/installed-dependencies/build.sh for the expected setup. The +# /v directory is a volume pointing to a (clean-ish) checkout of the project: +if [[ -z "${PROJECT_ROOT+x}" ]]; then + readonly PROJECT_ROOT="/v" +fi +source "${PROJECT_ROOT}/ci/colors.sh" + +echo +echo "${COLOR_YELLOW}Starting docker build $(date) with $(nproc) cores${COLOR_RESET}" +echo + +echo "================================================================" +echo "Verify formatting $(date)" +(cd "${PROJECT_ROOT}" ; ./ci/check-style.sh) +echo "================================================================" + +echo "================================================================" +echo "Compiling on $(date)" +echo "================================================================" +cd "${PROJECT_ROOT}" +cmake_flags=() +if [[ "${CLANG_TIDY:-}" = "yes" ]]; then + cmake_flags+=("-DGOOGLE_CLOUD_CPP_CLANG_TIDY=yes") +fi +if [[ "${GOOGLE_CLOUD_CPP_CXX_STANDARD:-}" != "" ]]; then + cmake_flags+=( + "-DGOOGLE_CLOUD_CPP_CXX_STANDARD=${GOOGLE_CLOUD_CPP_CXX_STANDARD}") +fi + +if [[ "${CODE_COVERAGE:-}" == "yes" ]]; then + cmake_flags+=( + "-DCMAKE_BUILD_TYPE=Coverage") +fi + +# Avoid unbound variable error with older bash +if [[ "${#cmake_flags[@]}" == 0 ]]; then + cmake "-H${SOURCE_DIR}" "-B${BINARY_DIR}" +else + cmake "-H${SOURCE_DIR}" "-B${BINARY_DIR}" "${cmake_flags[@]}" +fi +cmake --build "${BINARY_DIR}" -- -j "$(nproc)" + +# When user a super-build the tests are hidden in a subdirectory. We can tell +# that ${BINARY_DIR} does not have the tests by checking for this file: +if [[ -r "${BINARY_DIR}/CTestTestfile.cmake" ]]; then + echo "================================================================" + # It is Okay to skip the tests in this case because the super build + # automatically runs them. + echo "Running the unit tests $(date)" + env -C "${BINARY_DIR}" ctest \ + -LE integration-tests \ + --output-on-failure -j "$(nproc)" + echo "================================================================" +fi + +if [[ "${GENERATE_DOCS:-}" = "yes" ]]; then + echo "================================================================" + echo "Validate Doxygen documentation $(date)" + cmake --build "${BINARY_DIR}" --target doxygen-docs + echo "================================================================" +fi + +if [[ ${RUN_INTEGRATION_TESTS} == "yes" ]]; then + echo "================================================================" + echo "Running the integration tests $(date)" + echo "================================================================" + # shellcheck disable=SC1091 + source /c/spanner-integration-tests-config.sh + export GOOGLE_APPLICATION_CREDENTIALS=/c/spanner-credentials.json + + # Run the integration tests too. + env -C "${BINARY_DIR}" ctest \ + -L integration-tests \ + --output-on-failure + echo "================================================================" +fi + +echo "================================================================" +echo "Build finished at $(date)" +echo "================================================================" + +exit 0 diff --git a/ci/kokoro/docker/build.sh b/ci/kokoro/docker/build.sh new file mode 100755 index 000000000000..a8dd2492fc1a --- /dev/null +++ b/ci/kokoro/docker/build.sh @@ -0,0 +1,218 @@ +#!/usr/bin/env bash +# Copyright 2019 Google LLC +# +# 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. + +set -eu + +export CC=gcc +export CXX=g++ +export DISTRO=ubuntu +export DISTRO_VERSION=18.04 +export CMAKE_SOURCE_DIR="." + +in_docker_script="ci/kokoro/docker/build-in-docker-cmake.sh" + +if [[ $# -eq 1 ]]; then + export BUILD_NAME="${1}" +elif [[ -n "${KOKORO_JOB_NAME:-}" ]]; then + # Kokoro injects the KOKORO_JOB_NAME environment variable, the value of this + # variable is cloud-cpp/spanner/ (or more + # generally ). By convention we name these + # files `$foo.cfg` for continuous builds and `$foo-presubmit.cfg` for + # presubmit builds. Here we extract the value of "foo" and use it as the build + # name. + BUILD_NAME="$(basename "${KOKORO_JOB_NAME}" "-presubmit")" + export BUILD_NAME +else + echo "Aborting build as the build name is not defined." + echo "If you are invoking this script via the command line use:" + echo " $0 " + echo + echo "If this script is invoked by Kokoro, the CI system is expected to set" + echo "the KOKORO_JOB_NAME environment variable." + exit 1 +fi + +if [[ "${BUILD_NAME}" = "clang-tidy" ]]; then + # Compile with clang-tidy(1) turned on. The build treats clang-tidy warnings + # as errors. + export DISTRO=fedora-install + export DISTRO_VERSION=30 + export CC=clang + export CXX=clang++ + export CHECK_STYLE=yes + export CLANG_TIDY=yes +elif [[ "${BUILD_NAME}" = "ubuntu-18.04" ]]; then + export CC=gcc + export CXX=g++ +elif [[ "${BUILD_NAME}" = "ubuntu-16.04" ]]; then + export DISTRO_VERSION=16.04 + export CC=gcc + export CXX=g++ +elif [[ "${BUILD_NAME}" = "gcc-4.8" ]]; then + # The oldest version of GCC we support is 4.8, this build checks the code + # against that version. The use of CentOS 7 for that build is not a + # coincidence: the reason we support GCC 4.8 is to support this distribution + # (and its commercial cousin: RHEL 7). + export CC=gcc + export CXX=g++ + export DISTRO=centos + export DISTRO_VERSION=7 +elif [[ "${BUILD_NAME}" = "clang-3.8" ]]; then + # The oldest version of Clang we actively test is 3.8. There is nothing + # particularly interesting about that version. It is simply the version + # included with Ubuntu:16.04, and the oldest version tested by + # google-cloud-cpp. + export DISTRO=ubuntu + export DISTRO_VERSION=16.04 + export CC=clang + export CXX=clang++ +else + echo "Unknown BUILD_NAME (${BUILD_NAME}). Fix the Kokoro .cfg file." + exit 1 +fi + +if [[ -z "${PROJECT_ROOT+x}" ]]; then + readonly PROJECT_ROOT="$(cd "$(dirname "$0")/../../.."; pwd)" +fi +source "${PROJECT_ROOT}/ci/kokoro/define-docker-variables.sh" + +echo "================================================================" +cd "${PROJECT_ROOT}" +echo "Building with $(nproc) cores $(date) on ${PWD}." + +echo "================================================================" +echo "Capture Docker version to troubleshoot $(date)." +sudo docker version +echo "================================================================" + +echo "================================================================" +echo "Creating Docker image with all the development tools $(date)." +# We do not want to print the log unless there is an error, so disable the -e +# flag. Later, we will want to print out the emulator(s) logs *only* if there +# is an error, so disabling from this point on is the right choice. +set +e +mkdir -p "${BUILD_OUTPUT}" +readonly CREATE_DOCKER_IMAGE_LOG="${BUILD_OUTPUT}/create-build-docker-image.log" +echo "Logging to ${CREATE_DOCKER_IMAGE_LOG}" +if ! "${PROJECT_ROOT}/ci/retry-command.sh" \ + "${PROJECT_ROOT}/ci/kokoro/create-docker-image.sh" \ + >"${CREATE_DOCKER_IMAGE_LOG}" 2>&1 to CMake. + "--env" "GOOGLE_CLOUD_CPP_CXX_STANDARD=${GOOGLE_CLOUD_CPP_CXX_STANDARD:-}" + + # When running the integration tests this directory contains the + # configuration files needed to run said tests. Make it available inside + # the Docker container. + "--volume" "${KOKORO_GFILE_DIR:-/dev/shm}:/c" + + # Let the Docker image script know what kind of terminal we are using, that + # produces properly colorized error messages. + "--env" "TERM=${TERM:-dumb}" + + # Run the docker script and this user id. Because the docker image gets to + # write in ${PWD} you typically want this to be your user id. + "--user" "${docker_uid}" + + # Bazel needs this environment variable to work correctly. + "--env" "USER=${docker_user}" + + # We give Bazel and CMake a fake $HOME inside the docker image. Bazel caches + # build byproducts in this directory. CMake (when ccache is enabled) uses + # it to store $HOME/.ccache + "--env" "HOME=/h" + "--volume" "${PWD}/${BUILD_HOME}:/h" + + # Mount the current directory (which is the top-level directory for the + # project) as `/v` inside the docker image, and move to that directory. + "--volume" "${PWD}:/v" + "--workdir" "/v" + + # Mask any other builds that may exist at the same time. That is, these + # directories appear as empty inside the Docker container, this prevents the + # container from writing into other builds, or to get confused by the output + # of other builds. In the CI system this does not matter, as each build runs + # on a completely separate VM. This is useful when running multiple builds + # in your workstation. + "--volume" "/v/cmake-out/home" + "--volume" "/v/cmake-out" + "--volume" "${PWD}/${BUILD_OUTPUT}:/v/${BUILD_OUTPUT}" +) + +# When running the builds from the command-line they get a tty, and the scripts +# running inside the Docker container can produce nicer output. On Kokoro the +# script does not get a tty, and Docker terminates the program if we pass the +# `-it` flag. +if [[ -t 0 ]]; then + docker_flags+=("-it") +fi + +sudo docker run "${docker_flags[@]}" "${IMAGE}:tip" \ + "/v/${in_docker_script}" "${CMAKE_SOURCE_DIR}" \ + "${BUILD_OUTPUT}" diff --git a/ci/kokoro/docker/clang-3.8-presubmit.cfg b/ci/kokoro/docker/clang-3.8-presubmit.cfg new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/ci/kokoro/docker/clang-3.8.cfg b/ci/kokoro/docker/clang-3.8.cfg new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/ci/kokoro/docker/clang-tidy-presubmit.cfg b/ci/kokoro/docker/clang-tidy-presubmit.cfg new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/ci/kokoro/docker/clang-tidy.cfg b/ci/kokoro/docker/clang-tidy.cfg new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/ci/kokoro/docker/common.cfg b/ci/kokoro/docker/common.cfg new file mode 100644 index 000000000000..213d93419a12 --- /dev/null +++ b/ci/kokoro/docker/common.cfg @@ -0,0 +1,17 @@ +# Format: //devtools/kokoro/config/proto/build.proto +# Copyright 2019 Google LLC +# +# 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. + +build_file: "cpp-cmakefiles/ci/kokoro/docker/build.sh" +timeout_mins: 120 diff --git a/ci/kokoro/docker/gcc-4.8-presubmit.cfg b/ci/kokoro/docker/gcc-4.8-presubmit.cfg new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/ci/kokoro/docker/gcc-4.8.cfg b/ci/kokoro/docker/gcc-4.8.cfg new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/ci/kokoro/docker/ubuntu-16.04-presubmit.cfg b/ci/kokoro/docker/ubuntu-16.04-presubmit.cfg new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/ci/kokoro/docker/ubuntu-16.04.cfg b/ci/kokoro/docker/ubuntu-16.04.cfg new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/ci/kokoro/docker/ubuntu-18.04-presubmit.cfg b/ci/kokoro/docker/ubuntu-18.04-presubmit.cfg new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/ci/kokoro/docker/ubuntu-18.04.cfg b/ci/kokoro/docker/ubuntu-18.04.cfg new file mode 100644 index 000000000000..e69de29bb2d1 -- cgit 1.4.1