Add smoke test for BEAM pipelines (#3037)

Created a smoke test to cover unit test gaps wrt BEAM:
- The Java and SDK compatibility in the pipeline container image
- The JPA setup in the pipelines

Both issues above can only be tested in a real pipeline.

This PR defines a new pipeline that performs a lightweight SQL
query and minimal processing. The build process can launch it
in a test environment to verify that the pipelines in the build
can run. The run script is also provided.
This commit is contained in:
Weimin Yu
2026-05-07 20:41:13 +00:00
committed by GitHub
parent 80eefc6498
commit 60d3653b46
7 changed files with 284 additions and 3 deletions
+3 -1
View File
@@ -157,7 +157,9 @@ steps:
google.registry.beam.rde.RdePipeline \
google/registry/beam/rde_pipeline_metadata.json \
google.registry.beam.resave.ResaveAllEppResourcesPipeline \
google/registry/beam/resave_all_epp_resources_pipeline_metadata.json
google/registry/beam/resave_all_epp_resources_pipeline_metadata.json \
google.registry.beam.common.SmokeTestPipeline \
google/registry/beam/smoke_test_pipeline_metadata.json
# Build and upload the schema jar as well as other artifacts needed by the schema tests.
- name: 'gcr.io/${PROJECT_ID}/builder:latest'
entrypoint: /bin/bash
+16 -2
View File
@@ -1,6 +1,7 @@
# To manually trigger a build on GCB, run:
# gcloud builds submit --config cloudbuild-release.yaml --substitutions \
# TAG_NAME=[TAG],_INTERNAL_REPO_URL=[URL] ..
# TAG_NAME=[TAG],_INTERNAL_REPO_URL=[URL],_TEST_PROJECT=[_TEST_PROJECT] \
# ..
#
# To trigger a build automatically, follow the instructions below and add a trigger:
# https://cloud.google.com/cloud-build/docs/running-builds/automate-builds
@@ -288,6 +289,19 @@ steps:
echo "Tag format '$TAG_NAME' does not match a known release type. Exiting."
exit 1
fi
timeout: 3600s
# Run the BEAM smoke test, using the builder and pipeline image just created
- name: 'gcr.io/$PROJECT_ID/builder:latest'
entrypoint: /bin/bash
args:
- -c
- |
set -e
if [[ "${TAG_NAME}" =~ ^nomulus-20[0-9]{2}[0-1][0-9][0-3][0-9]-RC[0-9]{2}$ ]]; then
gcloud secrets versions access latest \
--secret nomulus-tool-cloudbuild-credential > tool-credential.json
gcloud auth activate-service-account --key-file=tool-credential.json
./release/run_beam_smoketest.sh "${TAG_NAME}" "${PROJECT_ID}" "${_TEST_PROJECT}"
fi
timeout: 5400s
options:
machineType: 'E2_HIGHCPU_32'
+96
View File
@@ -0,0 +1,96 @@
#!/bin/bash
# Copyright 2026 The Nomulus Authors. 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.
#
# This script runs the BEAM pipeline smoke test as part of the build process.
# It assumes that all pipelines have been built and staged.
#
# This script expects the following arguments in order:
# - The release tag
# - The GCP project that serves the release artifacts
# - The GCP project id where the smoke test should run. This id should have the
# Nomulus environment name as suffix, following the last '-' in the project id,
# E.g., domain-registry-crash. Only crash and sandbox are allowed as the test
# environment. Use 'NONE' as project id to skip this test.
# - GCP region to run the test. This is optional.
set -e
if [[ $# -ne 3 && $# -ne 4 ]];
then
echo "Usage: $0 <release_tag> <build_project_id> <test_project_id> [<gcp_region>]"
exit 1
fi
release_tag="$1"
build_project="$2"
test_project="$3"
region="${4:-us-central1}"
if [[ "${test_project}" == "NONE" ]]; then
echo "BEAM smoke test skipped as requested."
exit 0
fi
test_project_id_suffix="${test_project##*-}"
if [[ "${test_project}" == *"-"* ]]; then
# Convert environment name to upper case
test_env="${test_project_id_suffix^^}"
else
test_env=""
fi
if [[ -z "${test_env}" ]]; then
echo "Cannot extract environment from project id ${test_project}"
exit 1
fi
if [[ ${test_env} != "CRASH" && ${test_env} != "SANDBOX" ]]; then
echo "Expecting CRASH or SANDBOX as test environment, got ${test_env}"
exit 1
fi
template_folder="gs://${build_project}-deploy/${release_tag}/beam"
template="${template_folder}/smoke_test_pipeline_metadata.json"
job_name=$(echo "beam-smoketest-${release_tag}" | tr '[:upper:]_' '[:lower:]-')
job_id=$(gcloud dataflow flex-template run "${job_name}" \
--template-file-gcs-location="${template}" \
--region="${region}" --parameters=registryEnvironment="${test_env}" \
--project=${test_project} --format='value(job.id)')
echo "Test pipeline started as ${job_id}"
# Wait up to 30 minutes for the smoke test to finish. This 5X of a typical
# run.
for i in {1..30}
do
job_state=$(gcloud dataflow jobs describe "${job_id}" --region=${region} \
--format="value(currentState)" --project "${test_project}")
echo "Test pipeline state is ${job_state}"
if [[ "${job_state}" == "JOB_STATE_DONE" ]]; then
echo "Smoke test completed successfully."
exit 0
elif [[ "${job_state}" == "JOB_STATE_QUEUED" || \
"${job_state}" == "JOB_STATE_RUNNING" || \
"${job_state}" == "JOB_STATE_PENDING" ]]; then
echo "Sleeping for 60 seconds"
sleep 60
else
echo "Unexpected job state ${job_state}"
exit 1
fi
done
echo "Error: Smoke test did not complete in time."
exit 1