tools/internal_ci/linux/grpc_xds_k8s_python.sh

   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
  16 set -ex -o igncr || set -ex
  17
  18 # Constants
  19 readonly GITHUB_REPOSITORY_NAME="grpc"
  20 # GKE Cluster
  21 readonly GKE_CLUSTER_NAME="interop-test-psm-sec-v2-us-central1-a"
  22 readonly GKE_CLUSTER_ZONE="us-central1-a"
  23 ## xDS test server/client Docker images
  24 readonly SERVER_IMAGE_NAME="gcr.io/grpc-testing/xds-interop/python-server"
  25 readonly CLIENT_IMAGE_NAME="gcr.io/grpc-testing/xds-interop/python-client"
  26 readonly FORCE_IMAGE_BUILD="${FORCE_IMAGE_BUILD:-0}"
  27 readonly BUILD_APP_PATH="interop-testing/build/install/grpc-interop-testing"
  28 readonly LANGUAGE_NAME="Python"
  29
  30 #######################################
  31 # Builds test app Docker images and pushes them to GCR
  32 # Globals:
  33 #   BUILD_APP_PATH
  34 #   SERVER_IMAGE_NAME: Test server Docker image name
  35 #   CLIENT_IMAGE_NAME: Test client Docker image name
  36 #   GIT_COMMIT: SHA-1 of git commit being built
  37 # Arguments:
  38 #   None
  39 # Outputs:
  40 #   Writes the output of `gcloud builds submit` to stdout, stderr
  41 #######################################
  42 build_test_app_docker_images() {
  43   echo "Building ${LANGUAGE_NAME} xDS interop test app Docker images"
  44
  45   pushd "${SRC_DIR}"
  46   docker build \
  47     -f src/python/grpcio_tests/tests_py3_only/interop/Dockerfile.client \
  48     -t "${CLIENT_IMAGE_NAME}:${GIT_COMMIT}" \
  49     .
  50
  51   docker build \
  52     -f src/python/grpcio_tests/tests_py3_only/interop/Dockerfile.server \
  53     -t "${SERVER_IMAGE_NAME}:${GIT_COMMIT}" \
  54     .
  55
  56   popd
  57
  58   gcloud -q auth configure-docker
  59
  60   docker push "${CLIENT_IMAGE_NAME}:${GIT_COMMIT}"
  61   docker push "${SERVER_IMAGE_NAME}:${GIT_COMMIT}"
  62
  63   if [[ -n $KOKORO_JOB_NAME ]]; then
  64     branch_name=$(echo "$KOKORO_JOB_NAME" | sed -E 's|^grpc/core/([^/]+)/.*|\1|')
  65     tag_and_push_docker_image "${CLIENT_IMAGE_NAME}" "${GIT_COMMIT}" "${branch_name}"
  66     tag_and_push_docker_image "${SERVER_IMAGE_NAME}" "${GIT_COMMIT}" "${branch_name}"
  67   fi
  68 }
  69
  70 #######################################
  71 # Builds test app and its docker images unless they already exist
  72 # Globals:
  73 #   SERVER_IMAGE_NAME: Test server Docker image name
  74 #   CLIENT_IMAGE_NAME: Test client Docker image name
  75 #   GIT_COMMIT: SHA-1 of git commit being built
  76 #   FORCE_IMAGE_BUILD
  77 # Arguments:
  78 #   None
  79 # Outputs:
  80 #   Writes the output to stdout, stderr
  81 #######################################
  82 build_docker_images_if_needed() {
  83   # Check if images already exist
  84   server_tags="$(gcloud_gcr_list_image_tags "${SERVER_IMAGE_NAME}" "${GIT_COMMIT}")"
  85   printf "Server image: %s:%s\n" "${SERVER_IMAGE_NAME}" "${GIT_COMMIT}"
  86   echo "${server_tags:-Server image not found}"
  87
  88   client_tags="$(gcloud_gcr_list_image_tags "${CLIENT_IMAGE_NAME}" "${GIT_COMMIT}")"
  89   printf "Client image: %s:%s\n" "${CLIENT_IMAGE_NAME}" "${GIT_COMMIT}"
  90   echo "${client_tags:-Client image not found}"
  91
  92   # Build if any of the images are missing, or FORCE_IMAGE_BUILD=1
  93   if [[ "${FORCE_IMAGE_BUILD}" == "1" || -z "${server_tags}" || -z "${client_tags}" ]]; then
  94     build_test_app_docker_images
  95   else
  96     echo "Skipping ${LANGUAGE_NAME} test app build"
  97   fi
  98 }
  99
 100 #######################################
 101 # Executes the test case
 102 # Globals:
 103 #   TEST_DRIVER_FLAGFILE: Relative path to test driver flagfile
 104 #   KUBE_CONTEXT: The name of kubectl context with GKE cluster access
 105 #   TEST_XML_OUTPUT_DIR: Output directory for the test xUnit XML report
 106 #   SERVER_IMAGE_NAME: Test server Docker image name
 107 #   CLIENT_IMAGE_NAME: Test client Docker image name
 108 #   GIT_COMMIT: SHA-1 of git commit being built
 109 # Arguments:
 110 #   Test case name
 111 # Outputs:
 112 #   Writes the output of test execution to stdout, stderr
 113 #   Test xUnit report to ${TEST_XML_OUTPUT_DIR}/${test_name}/sponge_log.xml
 114 #######################################
 115 run_test() {
 116   # Test driver usage:
 117   # https://github.com/grpc/grpc/tree/master/tools/run_tests/xds_k8s_test_driver#basic-usage
 118   local test_name="${1:?Usage: run_test test_name}"
 119   set -x
 120   python -m "tests.${test_name}" \
 121     --flagfile="${TEST_DRIVER_FLAGFILE}" \
 122     --kube_context="${KUBE_CONTEXT}" \
 123     --server_image="${SERVER_IMAGE_NAME}:${GIT_COMMIT}" \
 124     --client_image="${CLIENT_IMAGE_NAME}:${GIT_COMMIT}" \
 125     --xml_output_file="${TEST_XML_OUTPUT_DIR}/${test_name}/sponge_log.xml" \
 126     --force_cleanup \
 127     --nocheck_local_certs
 128   set +x
 129 }
 130
 131 #######################################
 132 # Main function: provision software necessary to execute tests, and run them
 133 # Globals:
 134 #   KOKORO_ARTIFACTS_DIR
 135 #   GITHUB_REPOSITORY_NAME
 136 #   SRC_DIR: Populated with absolute path to the source repo
 137 #   TEST_DRIVER_REPO_DIR: Populated with the path to the repo containing
 138 #                         the test driver
 139 #   TEST_DRIVER_FULL_DIR: Populated with the path to the test driver source code
 140 #   TEST_DRIVER_FLAGFILE: Populated with relative path to test driver flagfile
 141 #   TEST_XML_OUTPUT_DIR: Populated with the path to test xUnit XML report
 142 #   GIT_ORIGIN_URL: Populated with the origin URL of git repo used for the build
 143 #   GIT_COMMIT: Populated with the SHA-1 of git commit being built
 144 #   GIT_COMMIT_SHORT: Populated with the short SHA-1 of git commit being built
 145 #   KUBE_CONTEXT: Populated with name of kubectl context with GKE cluster access
 146 # Arguments:
 147 #   None
 148 # Outputs:
 149 #   Writes the output of test execution to stdout, stderr
 150 #######################################
 151 main() {
 152   local script_dir
 153   script_dir="$(dirname "$0")"
 154   # shellcheck source=tools/internal_ci/linux/grpc_xds_k8s_install_test_driver.sh
 155   source "${script_dir}/grpc_xds_k8s_install_test_driver.sh"
 156   set -x
 157   if [[ -n "${KOKORO_ARTIFACTS_DIR}" ]]; then
 158     kokoro_setup_test_driver "${GITHUB_REPOSITORY_NAME}"
 159   else
 160     local_setup_test_driver "${script_dir}"
 161   fi
 162   build_docker_images_if_needed
 163   # Run tests
 164   cd "${TEST_DRIVER_FULL_DIR}"
 165   run_test baseline_test
 166   run_test security_test
 167 }
 168
 169 main "$@"