Skip to content

docs(showcase): Add developer guide for local server testing and dynamic cert rotation - #14042

Open
macastelaz wants to merge 1 commit into
mainfrom
doc/showcase-local-server-testing
Open

docs(showcase): Add developer guide for local server testing and dynamic cert rotation#14042
macastelaz wants to merge 1 commit into
mainfrom
doc/showcase-local-server-testing

Conversation

@macastelaz

@macastelaz macastelaz commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a comprehensive developer guide (docs/showcase_local_server_testing_guide.md) detailing how to programmatically configure Java client libraries (EchoClient, IdentityClient, etc.) in unit and integration tests against a local gapic-showcase server.

Highlights

  • Documents gRPC Plaintext (ManagedChannelBuilder::usePlaintext) and HTTP/REST (doNotValidateCertificate) local server setups using NoCredentialsProvider.
  • Details transport lifecycle & resilience verification examples, including gRPC ChannelPool / HTTP RefreshingHttpJsonChannel dynamic certificate rotation testing and transparent retry verification.
  • References existing java-showcase/README.md for server binary download and CLI startup to avoid documentation duplication.
  • Includes a copy-pasteable JUnit 5 integration test recipe and a common troubleshooting matrix.

Fixes / Addresses: https://b.corp.google.com/issues/515074892

@macastelaz
macastelaz requested review from a team as code owners August 11, 2026 16:36

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a comprehensive developer guide for using the Java Showcase Library for local server testing, along with a reference to it in the main README. The feedback highlights two improvements in the guide's code examples: correcting a non-standard class usage that would cause compilation errors when configuring OpenTelemetry, and refactoring a JUnit 5 exception assertion to use the idiomatic assertThrows instead of a try-catch block with fail().

Comment thread docs/showcase_local_server_testing_guide.md Outdated
Comment thread docs/showcase_local_server_testing_guide.md Outdated
…mic cert rotation

* Add docs/showcase_local_server_testing_guide.md detailing programmatic
  local Showcase server testing for gRPC plaintext and HTTP/REST configurations.
* Document infrastructure verification patterns, including OpenTelemetry
  tracer configuration and dynamic mTLS certificate rotation with
  ChannelPool and RefreshingHttpJsonChannel refreshes.
* Cross-reference java-showcase/README.md as authoritative for server CLI installation
  and startup to avoid redundancy.
* Include full JUnit 5 integration test recipe with assertThrows error injection
  verification and troubleshooting matrix.

Fixes / Addresses: https://b.corp.google.com/issues/515074892
@macastelaz
macastelaz force-pushed the doc/showcase-local-server-testing branch from a451dab to e99057f Compare August 11, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants