Skip to content

Commit 210464d

Browse files
lqiu96lqiu96
authored
ci: Test upper bound dependenices file in Github CI (#3877)
See b/436286826 for more information Example workflow run: https://github.com/googleapis/sdk-platform-java/actions/runs/16759125283/job/47449497271?pr=3877 ## Sample run with upper-bounds file Running locally: `./.github/scripts/test_dependency_compatibility.sh` ``` mvn verify -Penable-integration-tests -Dclirr.skip -Dcheckstyle.skip -Dfmt.skip -Denforcer.skip -Djavax.annotation-api.version=1.3.2 -Dgrpc.version=1.74.0 -Dgoogle.auth.version=1.37.1 -Dgoogle.http-client.version=1.47.1 -Dgson.version=2.13.1 -Dguava.version=33.4.8-jre -Dprotobuf.version=4.31.1 -Dopentelemetry.version=1.52.0 -Derrorprone.version=4.15.1 -Dj2objc-annotations.version=3.0.0 -Dthreetenbp.version=1.7.1 -Dslf4j.version=2.0.17 -Dgrpc-gcp.version=1.6.1 -Dgoogle.oauth-client.version=1.39.0 -Dgoogle.api-client.version=2.8.0 -Dthreeten-extra.version=1.8.0 -Dopencensus.version=0.31.0 -Dfindbugs.version=3.0.2 -Derrorprone.version=2.41.0 -Dcodec.version=1.19.0 -Dhttpcomponents.httpcore.version=4.4.16 -Dhttpcomponents.httpclient.version=4.5.14 -Dapache-httpclient-5.version=5.5 -Dapache-httpcore-5.version=5.3.4 -Dperfmark-api.version=0.27.0 -Dj2objc-annotations.version=3.0.0 -Dgoogle.cloud.opentelemetry.version=0.36.0 -Dopentelemetry-semconv.version=1.34.0 -Dflogger.version=0.9 -Darrow.version=18.3.0 -Ddev.cel.version=0.10.1 -Dcom.google.crypto.tink.version=1.18.0 -Dio.opentelemetry.contrib.opentelemetry-gcp-resources.version=1.48.0-alpha ``` ## Expected error when using an incompatible Deps version Running locally with Protobuf 4.26.0: `./.github/scripts/test_dependency_compatibility.sh -l protobuf=4.26.0` Results: ``` [ERROR] /Users/lawrenceqiu/IdeaProjects/sdk-platform-java/java-common-protos/proto-google-common-protos/src/main/java/com/google/api/OAuthRequirements.java:[65,42] cannot find symbol [ERROR] symbol: class UnusedPrivateParameter [ERROR] location: class com.google.api.OAuthRequirements [ERROR] /Users/lawrenceqiu/IdeaProjects/sdk-platform-java/java-common-protos/proto-google-common-protos/src/main/java/com/google/api/OAuthRequirements.java:[74,51] package com.google.protobuf.GeneratedMessageV3 does not exist ``` ## Future This does not cover binary or behavior compatibility issues. We plan on using downstream unit and integration tests to test those incompatibilities in a future date.
1 parent f392d90 commit 210464d

File tree

3 files changed

+214
-0
lines changed

3 files changed

+214
-0
lines changed

‎.github/scripts/test_dependency_compatibility.sh‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
#!/bin/bash
2+
3+
# This script generates a maven command to test unit and integration tests for
4+
# the repo. The outputted maven command will be in the rough following format
5+
# `mvn verify ... -D{dependency.name}.version={dependency.version]`. The variables
6+
# ${dependency.name} and ${dependency.version} are parsed from the input to the script.
7+
#
8+
# Default invocation ./.github/scripts/test_dependency_compatibility.sh will use the default
9+
# upper-bounds dependency file at the root of the repo.
10+
# There are two potential inputs to the script:
11+
# 1. -f {file}: Custom file/path for the upper-bound dependencies to test
12+
# 2. -l {deps_list}: Comma-separated list of dependencies to test (e.g. protobuf=4.31.0,guava=33.4.8-jre)
13+
# Note: Do not include the `-D` prefix or `.version` suffix. Those values will be appended when generating
14+
# the maven command.
15+
#
16+
# If both inputs are supplied, the deps_list input has precedence. For Github Actions workflow,
17+
# the default workflow will run with the upper-bounds file. A `workflow_dispatch` option takes in
18+
# an input for the deps_list to manually run a subset of dependencies.
19+
#
20+
# The default upper-bound dependencies file is `dependencies.txt` located in the root
21+
# of sdk-platform-java. The upper-bound dependencies file will be in the format of:
22+
# ${dependency.name}=${dependency.version}
23+
24+
set -ex
25+
26+
function print_help() {
27+
echo "Unexpected input argument for this script."
28+
echo "Use -f {file} for the directory of the upper-bound dependencies file."
29+
echo "Use -l {deps_list} for a comma-separated list of dependencies to test (Format: dep1=1.0,dep2=2.0)"
30+
}
31+
32+
# Function to parse a dependency string and append it to the Maven command
33+
function add_dependency_to_maven_command() {
34+
local dep_pair=$1
35+
if [[ ! "${dep_pair}" =~ .*=.* ]]; then
36+
echo "Malformed dependency string: ${dep_pair}. Expected format: dependency=version"
37+
exit 1
38+
fi
39+
local dependency=$(echo "${dep_pair}" | cut -d'=' -f1 | tr -d '[:space:]')
40+
local version=$(echo "${dep_pair}" | cut -d'=' -f2 | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
41+
MAVEN_COMMAND+=" -D${dependency}.version=${version}"
42+
}
43+
44+
# Default to the upper bounds file in the root of the repo
45+
file='dependencies.txt'
46+
dependency_list=''
47+
48+
# The colon (:) after the letter means that there is an input associated with the flag
49+
while getopts 'f:l:' flag; do
50+
case "${flag}" in
51+
f) file="${OPTARG}" ;;
52+
l) dependency_list="${OPTARG}" ;;
53+
*) print_help && exit 1
54+
esac
55+
done
56+
57+
# Error if both the file and deps_list inputs is empty
58+
if [[ -z "${file}" && -z "${dependency_list}" ]]; then
59+
print_help && exit 1
60+
fi
61+
62+
MAVEN_COMMAND="mvn verify -Penable-integration-tests -Dclirr.skip -Dcheckstyle.skip -Dfmt.skip -Denforcer.skip "
63+
64+
# Check if a list of dependencies was provided as an argument. If the list of dependency inputted
65+
# is empty, then run with the upper-bound dependencies file
66+
if [ -z "${dependency_list}" ]; then
67+
UPPER_BOUND_DEPENDENCY_FILE=$file
68+
69+
if [ ! -e "${UPPER_BOUND_DEPENDENCY_FILE}" ]; then
70+
echo "The inputted upper-bound dependency file '${UPPER_BOUND_DEPENDENCY_FILE}' cannot be found"
71+
exit 1
72+
fi
73+
74+
# Read the file line by line
75+
while IFS= read -r line; do
76+
# Ignore any comments and blank lines
77+
if [[ "${line}" =~ ^[[:space:]]*# ]] || [[ -z "${line}" ]]; then
78+
continue
79+
fi
80+
add_dependency_to_maven_command "${line}"
81+
done < "${UPPER_BOUND_DEPENDENCY_FILE}"
82+
else # This else block means that a list of dependencies was inputted
83+
# Set the Internal Field Separator (IFS) to a comma.
84+
# This tells 'read' to split the string by commas into an array named DEPS.
85+
# The 'read -ra' command reads the input into an array.
86+
IFS=',' read -ra DEPS <<< "${dependency_list}"
87+
88+
# Loop through each item in the DEPS array.
89+
for DEP_PAIR in "${DEPS[@]}"; do
90+
# Skip any empty items that might result from trailing commas.
91+
if [ -z "${DEP_PAIR}" ]; then
92+
continue
93+
fi
94+
add_dependency_to_maven_command "${DEP_PAIR}"
95+
done
96+
fi
97+
98+
# Run the generated maven command to test with the dependency versions
99+
$MAVEN_COMMAND

‎.github/workflows/dependency_compatibility_test.yaml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Dependency Compatibility Test
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- 'main'
7+
workflow_dispatch:
8+
inputs:
9+
dependencies-list:
10+
description: 'Comma-separated list of dependencies to test (Example format: protobuf=4.31.0,guava=33.4.8-jre).
11+
Do not include the `-D` prefix or `.version` suffix. Those values will be appended when generating
12+
the command. No input (default) will run the the upper-bound dependencies file.'
13+
required: false
14+
default: ''
15+
16+
jobs:
17+
dependency-compatibility-test:
18+
runs-on: ubuntu-latest
19+
permissions:
20+
contents: read
21+
steps:
22+
- name: Checkout sdk-platform-java
23+
uses: actions/checkout@v4
24+
- name: Set up JDK 21
25+
uses: actions/setup-java@v4
26+
with:
27+
java-version: '21'
28+
distribution: 'temurin'
29+
cache: maven
30+
# The workflow_dispatch event is for team members who want to manually test certain dependencies + version combos
31+
# The normal workflow is not from `workflow_dispatch` and will use the default upper-bounds dependencies file
32+
- name: Determine Inputted Dependencies List
33+
if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.dependencies-list != '' }}
34+
run: echo "DEPENDENCIES_LIST=${{ github.event.inputs.dependencies-list }}" >> $GITHUB_ENV
35+
36+
# Run in the root module which should test for everything except for showcase
37+
- name: Perform Dependency Compatibility Testing
38+
shell: bash
39+
run: |
40+
if [[ -n "${{ env.DEPENDENCIES_LIST }}" ]]; then
41+
./.github/scripts/test_dependency_compatibility.sh -l ${{ env.DEPENDENCIES_LIST }}
42+
else
43+
./.github/scripts/test_dependency_compatibility.sh
44+
fi
45+
# Set up local showcase server to run the showcase ITs
46+
- name: Parse showcase version
47+
working-directory: java-showcase/gapic-showcase
48+
run: echo "SHOWCASE_VERSION=$(mvn help:evaluate -Dexpression=gapic-showcase.version -q -DforceStdout)" >> "$GITHUB_ENV"
49+
- name: Install showcase server
50+
run: |
51+
sudo mkdir -p /usr/src/showcase
52+
sudo chown -R ${USER} /usr/src/
53+
curl --location https://github.com/googleapis/gapic-showcase/releases/download/v${{env.SHOWCASE_VERSION}}/gapic-showcase-${{env.SHOWCASE_VERSION}}-linux-amd64.tar.gz --output /usr/src/showcase/showcase-${{env.SHOWCASE_VERSION}}-linux-amd64.tar.gz
54+
cd /usr/src/showcase/
55+
tar -xf showcase-*
56+
./gapic-showcase run &
57+
cd -
58+
59+
# Install the modules for showcase (Shared-Deps is required to run showcase)
60+
- name: Install sdk-platform-java's modules
61+
# gapic-generator-java requires Java 8 and is irrelevant for this CI
62+
run: mvn -q -B -ntp install --projects '!gapic-generator-java' -Dcheckstyle.skip -Dfmt.skip -DskipTests -Dclirr.skip -T 1C
63+
# Run specifically for showcase
64+
- name: Perform Dependency Compatibility Testing (Showcase only)
65+
shell: bash
66+
# Need to cd out of the directory to get the scripts as this step is run inside the java-showcase directory
67+
run: |
68+
if [[ -n "${{ env.DEPENDENCIES_LIST }}" ]]; then
69+
../.github/scripts/test_dependency_compatibility.sh -l ${{ env.DEPENDENCIES_LIST }}
70+
else
71+
../.github/scripts/test_dependency_compatibility.sh -f ../dependencies.txt
72+
fi
73+
working-directory: java-showcase

‎dependencies.txt‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# This file contains a list of dependencies and their versions to be tested for compatibility.
2+
# The format is key=value, where the key is the dependency name and the value is the version.
3+
# "1P" refers to First-Party dependencies (owned by Google).
4+
# "3P" refers to Third-Party dependencies.
5+
6+
# Pom-Parent Dependencies (https://github.com/googleapis/sdk-platform-java/blob/main/gapic-generator-java-pom-parent/pom.xml)
7+
javax.annotation-api=1.3.2
8+
grpc=1.74.0
9+
google.auth=1.37.1
10+
google.http-client=1.47.1
11+
gson=2.13.1
12+
guava=33.4.8-jre
13+
protobuf=4.31.1
14+
opentelemetry=1.52.0
15+
errorprone=2.41.0
16+
j2objc-annotations=3.0.0
17+
threetenbp=1.7.1
18+
slf4j=2.0.17
19+
20+
# 1P Shared-Deps (https://github.com/googleapis/sdk-platform-java/blob/main/java-shared-dependencies/first-party-dependencies/pom.xml)
21+
grpc-gcp=1.6.1
22+
google.oauth-client=1.39.0
23+
google.api-client=2.8.0
24+
25+
# 3P Shared-Deps (https://github.com/googleapis/sdk-platform-java/blob/main/java-shared-dependencies/third-party-dependencies/pom.xml)
26+
threeten-extra=1.8.0
27+
opencensus=0.31.0
28+
findbugs=3.0.2
29+
jackson=2.19.2
30+
codec=1.19.0
31+
httpcomponents.httpcore=4.4.16
32+
httpcomponents.httpclient=4.5.14
33+
apache-httpclient-5=5.5
34+
apache-httpcore-5=5.3.4
35+
perfmark-api=0.27.0
36+
google.cloud.opentelemetry=0.36.0
37+
opentelemetry-semconv=1.34.0
38+
flogger=0.9
39+
arrow=18.3.0
40+
dev.cel=0.10.1
41+
com.google.crypto.tink=1.18.0
42+
io.opentelemetry.contrib.opentelemetry-gcp-resources=1.48.0-alpha

0 commit comments

Comments
 (0)