cloudbuild.yaml

# Copyright 2017 Google LLC All Rights Reserved.
#
# 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.

#
# Google Cloud Builder CI configuration
#

steps:

#
# Print Docker version
#

- name: gcr.io/cloud-builders/docker
  id: docker-version
  args: ["--version"]

#
# Restore any caches
#

- name: us-docker.pkg.dev/$PROJECT_ID/ci/restore_cache
  id: htmltest-restore-cache
  args:
    - '--bucket=gs://$_CACHE_BUCKET'
    - '--key=$_HTMLTEST_CACHE_KEY'
  waitFor: ['-']

- name: us-docker.pkg.dev/$PROJECT_ID/ci/restore_cache
  id: cpp-sdk-build-restore-cache
  args:
    - '--bucket=gs://$_CACHE_BUCKET'
    - '--key=$_CPP_SDK_BUILD_CACHE_KEY-$( checksum sdks/cpp/cmake/prerequisites.cmake )'
  waitFor: ['-']

- name: us-docker.pkg.dev/$PROJECT_ID/ci/restore_cache
  id: cpp-sdk-conformance-restore-cache
  args:
    - '--bucket=gs://$_CACHE_BUCKET'
    - '--key=$_CPP_SDK_CONFORMANCE_CACHE_KEY-$( checksum sdks/cpp/cmake/prerequisites.cmake )'
  waitFor: ['-']

- name: us-docker.pkg.dev/$PROJECT_ID/ci/restore_cache
  id: rust-sdk-build-restore-cache
  args:
    - '--bucket=gs://$_CACHE_BUCKET'
    - '--key=$_RUST_SDK_BUILD_CACHE_KEY-$( checksum test/sdk/rust/Cargo.toml )'
  waitFor: ['-']

#
# Creates the initial make + docker build platform
#

- name: "ubuntu"
  args: ["bash", "-c", "echo 'FROM gcr.io/cloud-builders/docker\nRUN apt-get install make\nENTRYPOINT [\"/usr/bin/make\"]' > Dockerfile.build"]
  waitFor: ['-']
- name: gcr.io/cloud-builders/docker
  id: build-make-docker
  args: ['build', '-f', 'Dockerfile.build', '-t', 'make-docker', '.'] # we need docker and make to run everything.

#
# pull the main build image if it exists
#
- name: "make-docker"
  id: pull-build-image
  dir: "build"
  env:
    - "REGISTRY=${_REGISTRY}"
  args: ["pull-build-image"]
  waitFor:
    - build-make-docker

#
# pull the sdk base image, if it exists
#

- name: "make-docker"
  id: pull-build-sdk-base-image
  dir: "build"
  env:
    - "REGISTRY=${_REGISTRY}"
  args: ["pull-build-sdk-base-image"]
  waitFor:
    - build-make-docker

#
# Ensure that there is the sdk base image, so that both tests
# and build can use them
#

- name: "make-docker"
  id: ensure-build-sdk-image-base
  waitFor:
    - pull-build-sdk-base-image
  dir: "build"
  args: ["ensure-build-sdk-image-base"]

#
# build the e2e test runner
#

- name: gcr.io/cloud-builders/docker
  args: ['build', '-f', 'Dockerfile', '-t', 'e2e-runner', '.']
  dir: 'build/e2e-image'
  id: build-e2e
  waitFor: ['-']

#
# Runs the linter -- but also builds the build image, if not able to download
#

- name: "make-docker"
  id: lint
  waitFor:
    - pull-build-image
  dir: "build"
  args: ["lint"] # pull the build image if it exists

#
# Push the build image, can run while we do other things.
#

- name: "make-docker"
  waitFor:
    - lint
  dir: "build"
  env:
    - "REGISTRY=${_REGISTRY}"
  args: ["push-build-image"] # push the build image (which won't do anything if it's already there)

#
# Push the sdk base build image, which can also run while we do other things
#

- name: "make-docker"
  waitFor:
    - ensure-build-sdk-image-base
  dir: "build"
  env:
    - "REGISTRY=${_REGISTRY}"
  args: ["push-build-sdk-base-image"]

#
# Build all the images and sdks, and push them up to the repository
#

- name: "make-docker"
  id: build-images
  waitFor:
    - lint
  dir: "build"
  env:
    - "REGISTRY=${_REGISTRY}"
  args: [ "-j", "4", "build-images"]
- name: "make-docker"
  id: push-images
  waitFor:
    - build-images
  dir: "build"
  env:
    - "REGISTRY=${_REGISTRY}"
  args: [ "-j", "4", "push"]

#
# Build all the SDKs
#

- name: "make-docker"
  id: build-sdks
  waitFor:
    - lint
    - cpp-sdk-build-restore-cache
    - ensure-build-sdk-image-base
  dir: "build"
  args: [ "-j", "4", "--output-sync=target", "build-sdks"]

#
# Cache the cpp sdk build directory, to speed up subsequent builds (considerably)
#

- name: 'us-docker.pkg.dev/$PROJECT_ID/ci/save_cache'
  args:
    - '--bucket=gs://$_CACHE_BUCKET'
    - '--key=$_CPP_SDK_BUILD_CACHE_KEY-$( checksum sdks/cpp/cmake/prerequisites.cmake )'
    - '--path=sdks/cpp/.build'
  id: cpp-sdk-build-save-cache
  waitFor:
    - build-sdks

#
# Run the all the automated tests (except e2e) in parallel
#

- name: "make-docker"
  id: tests
  waitFor:
    - lint
    - ensure-build-sdk-image-base
    - htmltest-restore-cache
    - build-sdks
  dir: "build"
  args: [ "-j", "5", "--output-sync=target", "test" ]

#
# Cache the htmltest url checks. Faster builds, and lower network flakiness.
#
- name: 'us-docker.pkg.dev/$PROJECT_ID/ci/save_cache'
  args:
    - '--bucket=gs://$_CACHE_BUCKET'
    - '--key=$_HTMLTEST_CACHE_KEY'
    - '--path=site/tmp'
  id: htmltest-save-cache
  waitFor:
    - tests

#
# Site preview
#

# don't promote, as it can cause failures when two deploys try and promote at the same time.

- name: "make-docker" # build a preview of the website
  id: site-static
  waitFor:
    - tests
  dir: "build"
  args: ["site-static-preview", "site-gen-app-yaml", "SERVICE=preview"]
- name: "gcr.io/cloud-builders/gcloud" # deploy the preview of the website
  id: "deploy-site-static"
  waitFor:
    - site-static
  dir: "site"
  args: ["app", "deploy", ".app.yaml", "--no-promote", "--version=$SHORT_SHA"]
  env:
    - GOPATH=/workspace/go
    - GO111MODULE=on

# wait for us to be the oldest ongoing build before we run e2es

- name: 'gcr.io/cloud-builders/gcloud'
  id: e2e-wait-to-become-leader
  waitFor:
    - push-images
    - build-e2e
  script: |
    #!/usr/bin/env bash

    TS='date --utc +%FT%TZ' # e.g. 2023-01-26T13:30:37Z
    echo "$(${TS}): Waiting to become oldest running build"
    while true; do
      # Filter to running builds within the same TRIGGER_NAME. We use the trigger name to
      # filter rather than buildTriggerId because there is no substitution available for
      # buildTriggerId.
      TRIGGER_FILTER="status=WORKING AND substitutions[TRIGGER_NAME]='${TRIGGER_NAME}'"
      OLDEST=$(gcloud builds list --filter "${TRIGGER_FILTER}" --format="value(id,startTime)" --sort-by=startTime --limit=1)
      echo "$(${TS}): Oldest is (id startTime): ${OLDEST}"

      if echo ${OLDEST} | grep -q "${BUILD_ID}"; then
        echo "$(${TS}): That's us, we're done!"
        break
      fi

      sleep 60
    done
  timeout: 5400s # 90m - leave an hour for e2es to run on top of the global timeout of 2.5h
  env:
  - 'CLOUDSDK_CORE_PROJECT=$PROJECT_ID'
  - 'BUILD_ID=$BUILD_ID'
  - 'TRIGGER_NAME=$TRIGGER_NAME'

#
# Run the e2e tests with FeatureGates inverted compared to Stable
#
# Keep in sync with (the inverse of) pkg/util/runtime/features.go:featureDefaults

- name: 'e2e-runner'
  args:
    - 'CustomFasSyncInterval=false&SDKGracefulTermination=false&StateAllocationFilter=false&PlayerAllocationFilter=true&PlayerTracking=true&ResetMetricsOnDelete=true&SafeToEvict=true&PodHostname=true&Example=true'
    - 'generic'
    - 'e2e-test-cluster'
    - 'us-west1-c'
    - "${_REGISTRY}"
  id: e2e-feature-gates
  waitFor:
    - e2e-wait-to-become-leader

#
# Run the e2e tests without FeatureGates
#

- name: 'e2e-runner'
  args:
    - ''
    - 'generic'
    - 'e2e-test-cluster'
    - 'us-west1-c'
    - "${_REGISTRY}"
  id: e2e-stable
  waitFor:
    - e2e-feature-gates

#
# Run the e2e tests on GKE Autopilot with FeatureGates inverted compared to Stable
#
# Keep in sync with (the inverse of) pkg/util/runtime/features.go:featureDefaults

- name: 'e2e-runner'
  args:
    - 'CustomFasSyncInterval=false&SDKGracefulTermination=false&StateAllocationFilter=false&PlayerAllocationFilter=true&PlayerTracking=true&ResetMetricsOnDelete=true&SafeToEvict=true&PodHostname=true&Example=true'
    - 'gke-autopilot'
    - 'gke-autopilot-e2e-test-cluster-1-24'
    - 'us-west1'
    - "${_REGISTRY}"
  id: e2e-feature-gates-gke-autopilot
  allowFailure: true # for now, run the step but don't block on it
  waitFor:
    - e2e-wait-to-become-leader

#
# Run the e2e tests on GKE Autopilot without FeatureGates, except SafeToEvict, which we need on Autopilot
#

- name: 'e2e-runner'
  args:
    - 'SafeToEvict=true'
    - 'gke-autopilot'
    - 'gke-autopilot-e2e-test-cluster-1-24'
    - 'us-west1'
    - "${_REGISTRY}"
  id: e2e-stable-gke-autopilot
  allowFailure: true # for now, run the step but don't block on it
  waitFor:
    - e2e-feature-gates-gke-autopilot

#
# SDK conformance tests
#

- name: "make-docker"
  id: sdk-conformance
  dir: "build"
  env:
    - "REGISTRY=${_REGISTRY}"
  args: [ "-j", "5", "--output-sync=target", "run-sdk-conformance-tests"]
  waitFor:
    - build-images
    - tests

#
# Cache the CPP conformance build directory, to speed up subsequent builds (considerably)
#

- name: 'us-docker.pkg.dev/$PROJECT_ID/ci/save_cache'
  args:
    - '--bucket=gs://$_CACHE_BUCKET'
    - '--key=$_CPP_SDK_CONFORMANCE_CACHE_KEY-$( checksum sdks/cpp/cmake/prerequisites.cmake )'
    - '--path=test/sdk/cpp/sdk'
  id: cpp-sdk-conformance-save-cache
  waitFor:
    - sdk-conformance

#
# Cache the Rust SDK build directory, to speed up subsequent builds (considerably)
#

- name: 'us-docker.pkg.dev/$PROJECT_ID/ci/save_cache'
  args:
    - '--bucket=gs://$_CACHE_BUCKET'
    - '--key=$_RUST_SDK_BUILD_CACHE_KEY-$( checksum test/sdk/rust/Cargo.toml )'
    - '--path=test/sdk/rust/.cargo'
    - '--path=test/sdk/rust/.cargo-targets'
    - '--no-clobber'
  id: rust-build-save-cache
  waitFor:
    - sdk-conformance

#
# Zip up artifacts and push to storage
#

- name: 'gcr.io/cloud-builders/gsutil'
  waitFor:
    - build-sdks
    - tests
  dir: "sdks/cpp/.archives"
  args: [ '-m', 'cp', '*.tar.gz', 'gs://agones-artifacts/cpp-sdk']
- name: 'gcr.io/cloud-builders/gsutil'
  waitFor:
    - build-images
    - tests
  dir: "cmd/sdk-server/bin"
  args: [ '-m', 'cp', '*.zip', 'gs://agones-artifacts/sdk-server']

substitutions:
  _CACHE_BUCKET: agones-build-cache
  _HTMLTEST_CACHE_KEY: htmltest-0.10.1
  _CPP_SDK_BUILD_CACHE_KEY: cpp-sdk-build
  _CPP_SDK_CONFORMANCE_CACHE_KEY: cpp-sdk-conformance
  _RUST_SDK_BUILD_CACHE_KEY: rust-sdk-build
  _REGISTRY: us-docker.pkg.dev/${PROJECT_ID}/ci
tags: ['ci']
timeout: 9000s # 2.5h - if you change this, change e2e-wait-to-become-leader as well
queueTtl: 259200s # 72h
images:
  - '${_REGISTRY}/agones-controller'
  - '${_REGISTRY}/agones-sdk'
  - '${_REGISTRY}/agones-ping'
  - '${_REGISTRY}/agones-allocator'
logsBucket: "gs://agones-build-logs"
options:
  machineType: 'E2_HIGHCPU_32'
  dynamic_substitutions: true