Skip to content

Commit

Permalink
test: restore showcase autogen IT (#2895)
Browse files Browse the repository at this point in the history 
* chore: adapt `generate-showcase.sh` to hermetic build scripts

* fix permission issues

* add jar with dependencies and wrapper

* remove unnecessary comments in pom

* final fixes to showcase script

* reformate

* update showcase module

* restore clean install

* restore workflow

* fix yaml syntax

* simplify showcase ci

* chore(main): release 5.3.0 (#2888)

* chore(main): release 5.3.0

* chore(main): release 5.3.0

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

* add default endpoint to autoconfig composer

* update goldens

* update showcase

* update comments

* fix showcase tests

* ignore vim swap files

* fix `popd` comment

* fix comment

* transfer utility functions

* ignore vim swap files

* partial transfer of util functions

* add sparse_clone function

* use variable as argument to remove output folder

* remove unnecessary inputs to get_gapic_opts

* remove include_samples

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
  • Loading branch information
@diegomarquezp @release-please
diegomarquezp and release-please[bot] committed Jun 21, 2024
1 parent 01e44ca commit f76b6a0
Show file tree
Hide file tree
Showing 26 changed files with 415 additions and 119 deletions.
22 changes: 7 additions & 15 deletions .github/workflows/showcaseTests.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,30 +1,24 @@
name: Generator - Showcase Tests

on:
# Disable auto-triggering until this issue is fixed
# https://github.com/GoogleCloudPlatform/spring-cloud-gcp/issues/2214
# push:
# branches:
# - main
# pull_request:
# paths:
# - 'spring-cloud-generator/**'
push:
branches:
- main
pull_request:
paths:
- 'spring-cloud-generator/**'
workflow_dispatch:

jobs:
showcaseTests:

runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- name: Setup Java 17
uses: actions/setup-java@v1
with:
java-version: 17
- name: Install buildozer
run: |
go install github.com/bazelbuild/buildtools/buildozer@latest
export PATH=$PATH:$(go env GOPATH)/bin
buildozer --version
- name: Install spring-cloud-gcp
# Installs spring-cloud-gcp from root,
# including spring-cloud-generator module
Expand All @@ -44,8 +38,6 @@ jobs:
run: |
set -x
set -e
export PATH=$PATH:$(go env GOPATH)/bin
buildozer --version
bash scripts/generate-showcase.sh
- name: Unit tests for showcase-spring-starter
# Runs showcase-spring-starter unit tests
Expand Down
76 changes: 39 additions & 37 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,37 +1,39 @@
# Ignore folders
target/
bin/
/config
/.idea
/out

# Do not ignore them
!.idea/copyright
!.idea/inspectionProfiles
!.idea/scopes
!.idea/codeStyleSettings.xml
!.idea/vcs.xml

# Ignore files
access.properties
mail.properties
*.iml
*.ipr
*.iws
.project
.classpath
.settings/
.sts4-cache/

# Ignore to avoid pushing maven wrapper jar as binary artifact
.mvn/wrapper/maven-wrapper.jar

# Because re-configuring the directory in the share plugin leads to side effect we ignore the file
dependency-reduced-pom.xml
.factorypath

# Ignore OSX autogenerated files
.DS_Store

.flattened-pom.xml
*.versionsBackup
# Ignore folders
target/
bin/
/config
/.idea
/out

# Do not ignore them
!.idea/copyright
!.idea/inspectionProfiles
!.idea/scopes
!.idea/codeStyleSettings.xml
!.idea/vcs.xml

# Ignore files
access.properties
mail.properties
*.iml
*.ipr
*.iws
*.swp
*.swo
.project
.classpath
.settings/
.sts4-cache/

# Ignore to avoid pushing maven wrapper jar as binary artifact
.mvn/wrapper/maven-wrapper.jar

# Because re-configuring the directory in the share plugin leads to side effect we ignore the file
dependency-reduced-pom.xml
.factorypath

# Ignore OSX autogenerated files
.DS_Store

.flattened-pom.xml
*.versionsBackup
23 changes: 22 additions & 1 deletion spring-cloud-generator/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,28 @@
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<archive>
<manifest>
<mainClass>com.google.cloud.generator.spring.Main</mainClass>
</manifest>
</archive>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

</project>
160 changes: 160 additions & 0 deletions spring-cloud-generator/scripts/generate-showcase-utilities.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
#!/usr/bin/env bash

set -eo pipefail
utilities_script_dir=$(dirname "$(realpath "${BASH_SOURCE[0]}")")

# gets the output folder where all sources and dependencies will be located.
get_output_folder() {
if [[ $(basename $(pwd)) != "output" ]]; then
echo "$(pwd)/output"
else
echo $(pwd)
fi
}

get_protoc_version() {
local gapic_generator_version=$1
local protoc_version
pushd "${output_folder}" > /dev/null
# get protobuf version from gapic-generator-java-pom-parent/pom.xml
download_gapic_generator_pom_parent "${gapic_generator_version}"
protoc_version=$(grep protobuf.version "gapic-generator-java-pom-parent-${gapic_generator_version}.pom" | sed 's/<protobuf\.version>\(.*\)<\/protobuf\.version>/\1/' | sed 's/^[[:space:]]*//;s/[[:space:]]*$//' | cut -d "." -f2-)
popd > /dev/null
echo "${protoc_version}"
}

detect_os_architecture() {
local os_type
local os_architecture
os_type=$(uname -sm)
case "${os_type}" in
*"Linux x86_64"*)
os_architecture="linux-x86_64"
;;
*"Darwin x86_64"*)
os_architecture="osx-x86_64"
;;
"MINGW64"*)
os_architecture="win64"
;;
*)
os_architecture="osx-aarch_64"
;;
esac
echo "${os_architecture}"
}

download_protoc() {
local protoc_version=$1
local os_architecture=$2
if [ ! -d "protoc-${protoc_version}" ]; then
# pull proto files and protoc from protobuf repository as maven central
# doesn't have proto files
download_from \
"https://github.com/protocolbuffers/protobuf/releases/download/v${protoc_version}/protoc-${protoc_version}-${os_architecture}.zip" \
"protoc-${protoc_version}.zip" \
"GitHub"
unzip -o -q "protoc-${protoc_version}.zip" -d "protoc-${protoc_version}"
cp -r "protoc-${protoc_version}/include/google" .
rm "protoc-${protoc_version}.zip"
fi

protoc_path="${output_folder}/protoc-${protoc_version}/bin"
}

# get gapic options from .yaml and .json files from proto_path.
get_gapic_opts() {
local transport=$1
local rest_numeric_enums=$2
local gapic_yaml=$3
local service_config=$4
local service_yaml=$5
if [ "${rest_numeric_enums}" == "true" ]; then
rest_numeric_enums="rest-numeric-enums"
else
rest_numeric_enums=""
fi
# If any of the gapic options is empty (default value), try to search for
# it in proto_path.
if [[ "${gapic_yaml}" == "" ]]; then
gapic_yaml=$(find "${proto_path}" -type f -name "*gapic.yaml")
fi

if [[ "${service_config}" == "" ]]; then
service_config=$(find "${proto_path}" -type f -name "*service_config.json")
fi

if [[ "${service_yaml}" == "" ]]; then
service_yaml=$(find "${proto_path}" -maxdepth 1 -type f \( -name "*.yaml" ! -name "*gapic*.yaml" \))
fi
echo "transport=${transport},${rest_numeric_enums},grpc-service-config=${service_config},gapic-config=${gapic_yaml},api-service-config=${service_yaml}"
}

download_from() {
local url=$1
local save_as=$2
local repo=$3
# fail-fast, 30 seconds at most, retry 2 times
curl -LJ -o "${save_as}" --fail -m 30 --retry 2 "$url" || download_fail "${save_as}" "${repo}"
}

download_gapic_generator_pom_parent() {
local gapic_generator_version=$1
download_generator_artifact "${gapic_generator_version}" "gapic-generator-java-pom-parent-${gapic_generator_version}.pom" "gapic-generator-java-pom-parent"
}

download_generator_artifact() {
local gapic_generator_version=$1
local artifact=$2
local project=${3:-"gapic-generator-java"}
if [ ! -f "${artifact}" ]; then
# first, try to fetch the generator locally
local local_fetch_successful
local_fetch_successful=$(copy_from "$HOME/.m2/repository/com/google/api/${project}/${gapic_generator_version}/${artifact}" \
"${artifact}")
if [[ "${local_fetch_successful}" == "false" ]];then
# download gapic-generator-java artifact from Google maven central mirror if not
# found locally
>&2 echo "${artifact} not found locally. Attempting a download from Maven Central"
download_from \
"https://maven-central.storage-download.googleapis.com/maven2/com/google/api/${project}/${gapic_generator_version}/${artifact}" \
"${artifact}"
>&2 echo "${artifact} found and downloaded from Maven Central"
else
>&2 echo "${artifact} found copied from local repository (~/.m2)"
fi
fi
}

download_fail() {
local artifact=$1
local repo=${2:-"maven central mirror"}
>&2 echo "Fail to download ${artifact} from ${repo} repository. Please install ${artifact} first if you want to use a non-published artifact."
exit 1
}

# copies the specified file in $1 to $2
# will return "true" if the copy was successful
copy_from() {
local local_repo=$1
local save_as=$2
copy_successful=$(cp "${local_repo}" "${save_as}" && echo "true" || echo "false")
echo "${copy_successful}"
}

# Convenience function to clone only the necessary folders from a git repository
sparse_clone() {
repo_url=$1
paths=$2
commitish=$3
clone_dir=$(basename "${repo_url%.*}")
rm -rf "${clone_dir}"
git clone -n --depth=1 --no-single-branch --filter=tree:0 "${repo_url}"
pushd "${clone_dir}"
if [ -n "${commitish}" ]; then
git checkout "${commitish}"
fi
git sparse-checkout set --no-cone ${paths}
git checkout
popd
}
Loading

0 comments on commit f76b6a0

Please sign in to comment.