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 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# Arguments:
35#   None
36# Outputs:
37#   Writes the output of `gcloud builds submit` to stdout, stderr
38#######################################
39build_test_app_docker_images() {
40  echo "Building C++ xDS interop test app Docker images"
41  docker build -f "${SRC_DIR}/tools/dockerfile/interoptest/grpc_interop_cxx_xds/Dockerfile.xds_client" -t "${CLIENT_IMAGE_NAME}:${GIT_COMMIT}" "${SRC_DIR}"
42  docker build -f "${SRC_DIR}/tools/dockerfile/interoptest/grpc_interop_cxx_xds/Dockerfile.xds_server" -t "${SERVER_IMAGE_NAME}:${GIT_COMMIT}" "${SRC_DIR}"
43  gcloud -q auth configure-docker
44  docker push "${CLIENT_IMAGE_NAME}:${GIT_COMMIT}"
45  docker push "${SERVER_IMAGE_NAME}:${GIT_COMMIT}"
46  if is_version_branch "${TESTING_VERSION}"; then
47    tag_and_push_docker_image "${CLIENT_IMAGE_NAME}" "${GIT_COMMIT}" "${TESTING_VERSION}"
48    tag_and_push_docker_image "${SERVER_IMAGE_NAME}" "${GIT_COMMIT}" "${TESTING_VERSION}"
49  fi
50}
51
52#######################################
53# Builds test app and its docker images unless they already exist
54# Globals:
55#   SERVER_IMAGE_NAME: Test server Docker image name
56#   CLIENT_IMAGE_NAME: Test client Docker image name
57#   GIT_COMMIT: SHA-1 of git commit being built
58#   FORCE_IMAGE_BUILD
59# Arguments:
60#   None
61# Outputs:
62#   Writes the output to stdout, stderr
63#######################################
64build_docker_images_if_needed() {
65  # Check if images already exist
66  server_tags="$(gcloud_gcr_list_image_tags "${SERVER_IMAGE_NAME}" "${GIT_COMMIT}")"
67  printf "Server image: %s:%s\n" "${SERVER_IMAGE_NAME}" "${GIT_COMMIT}"
68  echo "${server_tags:-Server image not found}"
69
70  client_tags="$(gcloud_gcr_list_image_tags "${CLIENT_IMAGE_NAME}" "${GIT_COMMIT}")"
71  printf "Client image: %s:%s\n" "${CLIENT_IMAGE_NAME}" "${GIT_COMMIT}"
72  echo "${client_tags:-Client image not found}"
73
74  # Build if any of the images are missing, or FORCE_IMAGE_BUILD=1
75  if [[ "${FORCE_IMAGE_BUILD}" == "1" || -z "${server_tags}" || -z "${client_tags}" ]]; then
76    build_test_app_docker_images
77  else
78    echo "Skipping C++ test app build"
79  fi
80}
81
82#######################################
83# Executes the test case
84# Globals:
85#   TEST_DRIVER_FLAGFILE: Relative path to test driver flagfile
86#   KUBE_CONTEXT: The name of kubectl context with GKE cluster access
87#   SECONDARY_KUBE_CONTEXT: The name of kubectl context with secondary GKE cluster access, if any
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    --secondary_kube_context="${SECONDARY_KUBE_CONTEXT}" \
111    --server_image="${SERVER_IMAGE_NAME}:${GIT_COMMIT}" \
112    --client_image="${CLIENT_IMAGE_NAME}:${GIT_COMMIT}" \
113    --testing_version="${TESTING_VERSION}" \
114    --force_cleanup \
115    --collect_app_logs \
116    --log_dir="${out_dir}" \
117    --xml_output_file="${out_dir}/sponge_log.xml" \
118    ${@:2} \
119    |& tee "${out_dir}/sponge_log.log"
120}
121
122run_alpha_test() {
123  local test_name=$1
124  run_test ${test_name} \
125    --compute_api_version="v1alpha"
126}
127
128#######################################
129# Main function: provision software necessary to execute tests, and run them
130# Globals:
131#   KOKORO_ARTIFACTS_DIR
132#   GITHUB_REPOSITORY_NAME
133#   SRC_DIR: Populated with absolute path to the source repo
134#   TEST_DRIVER_REPO_DIR: Populated with the path to the repo containing
135#                         the test driver
136#   TEST_DRIVER_FULL_DIR: Populated with the path to the test driver source code
137#   TEST_DRIVER_FLAGFILE: Populated with relative path to test driver flagfile
138#   TEST_XML_OUTPUT_DIR: Populated with the path to test xUnit XML report
139#   GIT_ORIGIN_URL: Populated with the origin URL of git repo used for the build
140#   GIT_COMMIT: Populated with the SHA-1 of git commit being built
141#   GIT_COMMIT_SHORT: Populated with the short SHA-1 of git commit being built
142#   KUBE_CONTEXT: Populated with name of kubectl context with GKE cluster access
143#   SECONDARY_KUBE_CONTEXT: Populated with name of kubectl context with secondary GKE cluster access, if any
144# Arguments:
145#   None
146# Outputs:
147#   Writes the output of test execution to stdout, stderr
148#######################################
149main() {
150  local script_dir
151  script_dir="$(dirname "$0")"
152
153  # Source the test captured from the master branch.
154  echo "Sourcing test driver install captured from: ${TEST_DRIVER_INSTALL_SCRIPT_URL}"
155  source /dev/stdin <<< "$(curl -s "${TEST_DRIVER_INSTALL_SCRIPT_URL}")"
156
157  activate_gke_cluster GKE_CLUSTER_PSM_LB
158  activate_secondary_gke_cluster GKE_CLUSTER_PSM_LB
159
160  set -x
161  if [[ -n "${KOKORO_ARTIFACTS_DIR}" ]]; then
162    kokoro_setup_test_driver "${GITHUB_REPOSITORY_NAME}"
163  else
164    local_setup_test_driver "${script_dir}"
165  fi
166  build_docker_images_if_needed
167
168  # Run tests
169  cd "${TEST_DRIVER_FULL_DIR}"
170  local failed_tests=0
171  run_alpha_test subsetting_test || (( ++failed_tests ))
172  test_suites=("api_listener_test" "change_backend_service_test" "failover_test" "remove_neg_test" "round_robin_test" "affinity_test" "outlier_detection_test" "custom_lb_test")
173  for test in "${test_suites[@]}"; do
174    run_test $test || (( ++failed_tests ))
175  done
176  echo "Failed test suites: ${failed_tests}"
177}
178
179main "$@"
180