test: setup showcase testing for codegen modules #1957

emmileaf · 2023-06-15T14:16:38Z

This PR contains a MVP setup for testing spring-cloud-generator using showcase (context):

setup-showcase.sh: script to generate starter module for gapic-showcase: showcase-spring-starter
- Two options: verify (default, used by the gh actions workflow) and update (-u flag, for updating “golden” showcase module in development of spring generator)
EchoAutoConfigurationTests: handwritten unit tests to migrate/replace existing coverage in LanguageAutoConfigurationTests (currently living alongside spring-cloud-previews/google-cloud-language-starter)
showcaseTests.yaml: new CI workflow to run showcase verification (generation diff from goldens, compile with handwritten unit tests) for spring-cloud-generator - example presubmit run

First iteration todos:

Troubleshoot outstanding errors in migrated handwritten unit tests
Script refactoring for generation/post-processing steps
- Verify this doesn't break actual generation workflow (test run)
Add readme (comment)
Replace hardcoded gapic-showcase client library version (comment)

…odule

…ng-starter

...ing-starter/src/test/java/com/google/showcase/v1beta1/spring/EchoAutoConfigurationTests.java

spring-cloud-generator/scripts/generate-showcase.sh

emmileaf · 2023-06-16T23:03:09Z

~~The two handwritten unit tests noted above still need more troubleshooting~~ (EDIT: resolved), but marking this PR as ready for an initial review on the setup / approach for adopting showcase in testing spring-cloud-generator (example presubmit workflow run here).

meltsufin

Maybe this is for another PR, but can you add a short readme under /spring-cloud-generator on how to run the Showcase tests locally? Also, will it be feasible in the future to add integration tests using showcase for the Spring CodeGen starters?

.github/workflows/showcaseTests.yaml

meltsufin · 2023-06-29T14:32:26Z

.github/workflows/showcaseTests.yaml

+          go install github.com/bazelbuild/buildtools/buildozer@latest
+          export PATH=$PATH:$(go env GOPATH)/bin
+          buildozer --version
+      - name: Mvn install


Can you clarify what is being built and installed? Is it just the generator or also the showcase?

Here it is the spring-cloud-gcp project from root (local snapshot version, for the generator and dependencies such as spring-cloud-gcp-core). It does not include the showcase client (or showcase spring starters) which are installed through the script. I'll add a comment to clarify.

meltsufin · 2023-06-29T14:39:09Z

spring-cloud-generator/scripts/generate-showcase.sh

+  git clone https://github.com/googleapis/sdk-platform-java.git
+  git checkout "v${GAPIC_GENERATOR_JAVA_VERSION}"
+
+  # Alternative considered: if showcase client library is available on Maven Central,


@blakeli0 Can we just make showcase available in Maven Central?
@emmileaf I'm surprised how complicated this shell script is. Is it because we have to rebuild Showcase from scratch or because we're not able to reuse the Spring CodeGen scripts?

Yes, @burkedavison and I discussed this briefly in the past, both of us think it's a good idea. It will make the local developer experience better, but may not simplify this script a lot, probably just this one line
cd sdk-platform-java && mvn clean install -B -ntp -DskipTests -Dclirr.skip -Dcheckstyle.skip that installs showcase to local Maven repo.

Is it because we have to rebuild Showcase from scratch or because we're not able to reuse the Spring CodeGen scripts?

@meltsufin it's because of the latter (+1 to @blakeli0's comment above).

There are a number of nuances in bazel workspace modifications from the Spring Codegen scripts that rely on googleapis structure, and lines 68-115 is a working attempt to achieve the sdk-platform-java/showcase equivalent for generating the spring starters). Now that #1956 is in, I'll take a look at refactoring this script on top (#1957 (comment)).

discussed this briefly in the past, both of us think it's a good idea.

It could be a good idea given the right use case. The previous use case was binary compatibility testing, but we've now implemented a local version of this check without needing a maven central artifact.

This codegen use case would still require that we checkout the sdk-platform-java repo -- so I'm not sure publishing to maven central buys us anything significant.

For a bit more context: currently the setup here checks out sdk-platform-java for two reasons:

To locally install the generated showcase client library (not available on Maven Central)

For leaning on bazel generation setup (sdk-platform-java/WORKSPACE, sdk-platform-java/showcase/BUILD.bazel, and protos) instead of writing one from scratch

If having showcase available in Maven Central eliminates the step in 1, a feasible alternative to 2 (to avoid cloning sdk-platform-java) is to lean on googleapis’s bazel generation setup (which the Spring Codegen workflow for actual client libraries use) and follow something similar to these steps - copy protos from gapic-showcase, write a short BUILD.bazel, and make corresponding modifications to googleapis/WORKSPACE.

This is probably not worth the effort if the end goal is just to simplify this script, but could be more relevant if there is preference to avoid cloning sdk-platform-java altogether and reduce the number of repos that Spring Codegen locally depends on.

This PR refactors spring-cloud-generator scripts, with the following goals: * Small fix for pattern-matching when sorting README table entries (follow-up on [1529-comment](#1529 (comment))) * Post-migration follow-up: simplify amount of script processing and files - Different piecewise scripts (e.g. `generate-one.sh`, `setup-build-rule.sh`, ...) consolidated into functions living in `generate-steps.sh` - Main script of `generate.sh` contains end-to-end workflow that invokes the various functions defined above - This also sets up pieces of the generation generation steps for potential reuse / reducing duplication in the showcase testing generation script ([#1957](#1957)), though related changes are not made in this PR to keep the refactoring incremental.

spring-cloud-generator/scripts/generate-showcase.sh

This reverts commit 0387703.

emmileaf · 2023-07-05T17:10:46Z

Maybe this is for another PR, but can you add a short readme under /spring-cloud-generator on how to run the Showcase tests locally?

Ah yeah a readme is a good idea - will add one as part of this PR.

Also, will it be feasible in the future to add integration tests using showcase for the Spring CodeGen starters?

I believe this is doable with adding something like this github action step to install the showcase server, but didn’t scope it into this initial setup PR - I can try getting a PoC started in a separate one.

emmileaf · 2023-07-06T14:17:03Z

spring-cloud-generator/scripts/generate.sh

@@ -19,6 +19,7 @@ fi
 SPRING_ROOT_DIR=${SPRING_GENERATOR_DIR}/..

 # Reset target folder for generated code
+cd ${SPRING_GENERATOR_DIR}


Addressing a previous suggestion in #1956 (comment): this PR contains small changes to generate.sh and generate_steps.sh to remove assumption that the SPRING_GENERATOR_DIR variable is set in individual helper functions

emmileaf · 2023-07-06T14:20:04Z

spring-cloud-generator/scripts/generate-steps.sh

-  xmllint --debug --nsclean --xpath  "//*[local-name()='module']/text()" $1 \
-    | sort | uniq | grep -q $2 || module_list_is_empty=1
+function add_module_to_aggregator_pom() {
+  path_to_pom=$1


Addressing a previous suggestion in #1956 (comment): updated helper functions to consistently declare descriptive variable names for the arguments they expect ($1, $2, ...)

emmileaf · 2023-07-06T14:33:12Z

spring-cloud-generator/scripts/generate.sh

@@ -57,8 +59,6 @@ echo "Library list path: ${LIBRARY_LIST_PATH}"

 cd ${SPRING_GENERATOR_DIR}

-echo "executing install_spring_generator"
-install_spring_generator


Removed since locally installing spring-cloud-gcp from root (in action) already includes the generator module: #1957 (comment)

spring-cloud-generator/showcase/showcase-spring-starter/pom.xml

sonarqubecloud · 2023-07-07T16:21:29Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

emmileaf added 6 commits May 23, 2023 18:01

WIP: exploring setup for showcase client library generation

df4d2b9

WIP: rough script for generating compilable showcase-spring-starter m…

cf66f81

…odule

WIP: adapt existing unit tests for language client to echo client

8cf3668

Merge branch 'main' into codegen-showcase-explore

66487d8

chore: update setup script

9af0fad

test: updated generated showcase starter

2090650

emmileaf added the codegen label Jun 15, 2023

emmileaf mentioned this pull request Jun 15, 2023

chore: spring-cloud-generator script refactor #1956

Merged

1 task

emmileaf added 8 commits June 16, 2023 15:32

test: add script options for update and verification of showcase-spri…

aa0a91c

…ng-starter

chore: pom fix and add workflow for showcase testing

53694ec

chore: fix gh workflow

33ddbb4

chore: fix gh workflow

d885c42

chore: fixes for script and actions workflow

6630103

chore: add buildozer setup to workflow

31eac77

chore: add buildozer setup to workflow

07089a8

temp: comment out tests that require additional troubleshooting

3fb10a6

emmileaf commented Jun 16, 2023

View reviewed changes

...ing-starter/src/test/java/com/google/showcase/v1beta1/spring/EchoAutoConfigurationTests.java Outdated Show resolved Hide resolved

emmileaf commented Jun 16, 2023

View reviewed changes

...ing-starter/src/test/java/com/google/showcase/v1beta1/spring/EchoAutoConfigurationTests.java Outdated Show resolved Hide resolved

emmileaf added 2 commits June 16, 2023 18:14

chore: cleanup and rename script

e5d08fd

Merge branch 'main' into codegen-showcase-explore

c08f26d

emmileaf commented Jun 16, 2023

View reviewed changes

spring-cloud-generator/scripts/generate-showcase.sh Outdated Show resolved Hide resolved

chore: update parent version after pulling changes from main

57db136

emmileaf marked this pull request as ready for review June 16, 2023 23:04

emmileaf requested a review from a team as a code owner June 16, 2023 23:04

emmileaf requested review from blakeli0, meltsufin and burkedavison June 16, 2023 23:05

meltsufin requested changes Jun 29, 2023

View reviewed changes

emmileaf and others added 3 commits July 4, 2023 18:52

test: fix formatting

389e4ac

chore: additional script cleanup from refactoring

d03a0bd

chore: update starter modules in spring-cloud-previews

0387703

burkedavison reviewed Jul 5, 2023

View reviewed changes

spring-cloud-generator/scripts/generate-showcase.sh Outdated Show resolved Hide resolved

Revert "chore: update starter modules in spring-cloud-previews"

47e236d

This reverts commit 0387703.

emmileaf added 6 commits July 5, 2023 14:30

Merge branch 'main' into codegen-showcase-explore

0214728

chore: dynamically evaluate version of showcase client library

2b6a070

chore: small comment fix

f06032c

chore: add README.md for spring-cloud-generator

36d5df5

chore: consistently declare descriptive variables for bash function args

fe2d6e8

chore: add comments to actions steps

99a4769

emmileaf commented Jul 6, 2023

View reviewed changes

emmileaf requested review from meltsufin, burkedavison and diegomarquezp July 6, 2023 14:55

chore: update README.md

a5b8daa

meltsufin approved these changes Jul 6, 2023

View reviewed changes

spring-cloud-generator/showcase/showcase-spring-starter/pom.xml Outdated Show resolved Hide resolved

emmileaf mentioned this pull request Jul 7, 2023

chore: fix starter pom indentation in generator #2009

Merged

emmileaf added 2 commits July 7, 2023 10:52

Merge branch 'main' into codegen-showcase-explore

b687ed4

chore: update showcase-spring-starter golden pom

6871078

burkedavison approved these changes Jul 7, 2023

View reviewed changes

emmileaf merged commit ceff216 into main Jul 7, 2023

emmileaf deleted the codegen-showcase-explore branch July 7, 2023 19:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: setup showcase testing for codegen modules #1957

test: setup showcase testing for codegen modules #1957

emmileaf commented Jun 15, 2023 •

edited

Loading

emmileaf commented Jun 16, 2023 •

edited

Loading

meltsufin left a comment

meltsufin Jun 29, 2023

emmileaf Jul 4, 2023

meltsufin Jun 29, 2023

blakeli0 Jun 29, 2023

emmileaf Jul 4, 2023 •

edited

Loading

burkedavison Jul 5, 2023 •

edited

Loading

emmileaf Jul 5, 2023

emmileaf commented Jul 5, 2023

emmileaf Jul 6, 2023

emmileaf Jul 6, 2023

emmileaf Jul 6, 2023

sonarqubecloud bot commented Jul 7, 2023

test: setup showcase testing for codegen modules #1957

test: setup showcase testing for codegen modules #1957

Conversation

emmileaf commented Jun 15, 2023 • edited Loading

emmileaf commented Jun 16, 2023 • edited Loading

meltsufin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emmileaf Jul 4, 2023 • edited Loading

Choose a reason for hiding this comment

burkedavison Jul 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emmileaf commented Jul 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jul 7, 2023

emmileaf commented Jun 15, 2023 •

edited

Loading

emmileaf commented Jun 16, 2023 •

edited

Loading

emmileaf Jul 4, 2023 •

edited

Loading

burkedavison Jul 5, 2023 •

edited

Loading