1#!/usr/bin/env bash
2# Copyright 2021 gRPC authors.
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8#     http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
16set -eo pipefail
17
18# Constants
19readonly GITHUB_REPOSITORY_NAME="grpc"
20readonly TEST_DRIVER_INSTALL_SCRIPT_URL="https://raw.githubusercontent.com/${TEST_DRIVER_REPO_OWNER:-grpc}/grpc/${TEST_DRIVER_BRANCH:-master}/tools/internal_ci/linux/grpc_xds_k8s_install_test_driver.sh"
21## xDS test server/client Docker images
22readonly SERVER_IMAGE_NAME="gcr.io/grpc-testing/xds-interop/cpp-server"
23readonly CLIENT_IMAGE_NAME="gcr.io/grpc-testing/xds-interop/cpp-client"
24readonly FORCE_IMAGE_BUILD="${FORCE_IMAGE_BUILD:-0}"
25readonly BUILD_APP_PATH="interop-testing/build/install/grpc-interop-testing"
26
27#######################################
28# Builds test app Docker images and pushes them to GCR
29# Globals:
30#   BUILD_APP_PATH
31#   SERVER_IMAGE_NAME: Test server Docker image name
32#   CLIENT_IMAGE_NAME: Test client Docker image name
33#   GIT_COMMIT: SHA-1 of git commit being built
34#   TESTING_VERSION: version branch under test, f.e. v1.42.x, master
35# Arguments:
36#   None
37# Outputs:
38#   Writes the output of `gcloud builds submit` to stdout, stderr
39#######################################
40build_test_app_docker_images() {
41  echo "Building C++ xDS interop test app Docker images"
42  docker build -f "${SRC_DIR}/tools/dockerfile/interoptest/grpc_interop_cxx_xds/Dockerfile.xds_client" -t "${CLIENT_IMAGE_NAME}:${GIT_COMMIT}" "${SRC_DIR}"
43  docker build -f "${SRC_DIR}/tools/dockerfile/interoptest/grpc_interop_cxx_xds/Dockerfile.xds_server" -t "${SERVER_IMAGE_NAME}:${GIT_COMMIT}" "${SRC_DIR}"
44  gcloud -q auth configure-docker
45  docker push "${CLIENT_IMAGE_NAME}:${GIT_COMMIT}"
46  docker push "${SERVER_IMAGE_NAME}:${GIT_COMMIT}"
47  if is_version_branch "${TESTING_VERSION}"; then
48    tag_and_push_docker_image "${CLIENT_IMAGE_NAME}" "${GIT_COMMIT}" "${TESTING_VERSION}"
49    tag_and_push_docker_image "${SERVER_IMAGE_NAME}" "${GIT_COMMIT}" "${TESTING_VERSION}"
50  fi
51}
52
53#######################################
54# Builds test app and its docker images unless they already exist
55# Globals:
56#   SERVER_IMAGE_NAME: Test server Docker image name
57#   CLIENT_IMAGE_NAME: Test client Docker image name
58#   GIT_COMMIT: SHA-1 of git commit being built
59#   FORCE_IMAGE_BUILD
60# Arguments:
61#   None
62# Outputs:
63#   Writes the output to stdout, stderr
64#######################################
65build_docker_images_if_needed() {
66  # Check if images already exist
67  server_tags="$(gcloud_gcr_list_image_tags "${SERVER_IMAGE_NAME}" "${GIT_COMMIT}")"
68  printf "Server image: %s:%s\n" "${SERVER_IMAGE_NAME}" "${GIT_COMMIT}"
69  echo "${server_tags:-Server image not found}"
70
71  client_tags="$(gcloud_gcr_list_image_tags "${CLIENT_IMAGE_NAME}" "${GIT_COMMIT}")"
72  printf "Client image: %s:%s\n" "${CLIENT_IMAGE_NAME}" "${GIT_COMMIT}"
73  echo "${client_tags:-Client image not found}"
74
75  # Build if any of the images are missing, or FORCE_IMAGE_BUILD=1
76  if [[ "${FORCE_IMAGE_BUILD}" == "1" || -z "${server_tags}" || -z "${client_tags}" ]]; then
77    build_test_app_docker_images
78  else
79    echo "Skipping C++ test app build"
80  fi
81}
82
83#######################################
84# Executes the test case
85# Globals:
86#   TEST_DRIVER_FLAGFILE: Relative path to test driver flagfile
87#   KUBE_CONTEXT: The name of kubectl context with GKE cluster access
88#   TEST_XML_OUTPUT_DIR: Output directory for the test xUnit XML report
89#   SERVER_IMAGE_NAME: Test server Docker image name
90#   CLIENT_IMAGE_NAME: Test client Docker image name
91#   GIT_COMMIT: SHA-1 of git commit being built
92#   TESTING_VERSION: version branch under test: used by the framework to determine the supported PSM
93#                    features.
94# Arguments:
95#   Test case name
96# Outputs:
97#   Writes the output of test execution to stdout, stderr
98#   Test xUnit report to ${TEST_XML_OUTPUT_DIR}/${test_name}/sponge_log.xml
99#######################################
100run_test() {
101  # Test driver usage:
102  # https://github.com/grpc/grpc/tree/master/tools/run_tests/xds_k8s_test_driver#basic-usage
103  local test_name="${1:?Usage: run_test test_name}"
104  local out_dir="${TEST_XML_OUTPUT_DIR}/${test_name}"
105  mkdir -pv "${out_dir}"
106  set -x
107  python3 -m "tests.${test_name}" \
108    --flagfile="${TEST_DRIVER_FLAGFILE}" \
109    --kube_context="${KUBE_CONTEXT}" \
110    --server_image="${SERVER_IMAGE_NAME}:${GIT_COMMIT}" \
111    --client_image="${CLIENT_IMAGE_NAME}:${GIT_COMMIT}" \
112    --testing_version="${TESTING_VERSION}" \
113    --nocheck_local_certs \
114    --force_cleanup \
115    --collect_app_logs \
116    --log_dir="${out_dir}" \
117    --xml_output_file="${out_dir}/sponge_log.xml" \
118    |& tee "${out_dir}/sponge_log.log"
119}
120
121#######################################
122# Main function: provision software necessary to execute tests, and run them
123# Globals:
124#   KOKORO_ARTIFACTS_DIR
125#   GITHUB_REPOSITORY_NAME
126#   SRC_DIR: Populated with absolute path to the source repo
127#   TEST_DRIVER_REPO_DIR: Populated with the path to the repo containing
128#                         the test driver
129#   TEST_DRIVER_FULL_DIR: Populated with the path to the test driver source code
130#   TEST_DRIVER_FLAGFILE: Populated with relative path to test driver flagfile
131#   TEST_XML_OUTPUT_DIR: Populated with the path to test xUnit XML report
132#   GIT_ORIGIN_URL: Populated with the origin URL of git repo used for the build
133#   GIT_COMMIT: Populated with the SHA-1 of git commit being built
134#   GIT_COMMIT_SHORT: Populated with the short SHA-1 of git commit being built
135#   KUBE_CONTEXT: Populated with name of kubectl context with GKE cluster access
136# Arguments:
137#   None
138# Outputs:
139#   Writes the output of test execution to stdout, stderr
140#######################################
141main() {
142  local script_dir
143  script_dir="$(dirname "$0")"
144
145  # Source the test driver from the master branch.
146  echo "Sourcing test driver install script from: ${TEST_DRIVER_INSTALL_SCRIPT_URL}"
147  source /dev/stdin <<< "$(curl -s "${TEST_DRIVER_INSTALL_SCRIPT_URL}")"
148
149  activate_gke_cluster GKE_CLUSTER_PSM_SECURITY
150
151  set -x
152  if [[ -n "${KOKORO_ARTIFACTS_DIR}" ]]; then
153    kokoro_setup_test_driver "${GITHUB_REPOSITORY_NAME}"
154  else
155    local_setup_test_driver "${script_dir}"
156  fi
157  build_docker_images_if_needed
158  # Run tests
159  cd "${TEST_DRIVER_FULL_DIR}"
160  local failed_tests=0
161  test_suites=("baseline_test" "security_test" "authz_test")
162  for test in "${test_suites[@]}"; do
163    run_test $test || (( ++failed_tests ))
164  done
165  echo "Failed test suites: ${failed_tests}"
166}
167
168main "$@"
169