commit | 4462899f085519f445351cbd98a0516b8f48ce2b | [log] [tgz] |
---|---|---|
author | Sergii Tkachenko <sergiitk@google.com> | Mon May 06 16:11:31 2024 -0700 |
committer | GitHub <noreply@github.com> | Mon May 06 16:11:31 2024 -0700 |
tree | e7e7790d0296ec16e8c50e5720e77619aaa1cd62 | |
parent | e6d3411397a7d6e3e8fa04ec1f40e3b282fb4547 [diff] |
buildscripts: simplify PSM interop Kokoro buildscripts (#11121) (#11167) Integrates the new features of the the Kokoro PSM Interop install library introduced in grpc/psm-interop#73. Nearly all common functionality was moved from per-language/per-branch PSM Interop build scripts to [psm_interop_kokoro_lib.sh](https://github.com/grpc/psm-interop/blob/main/.kokoro/psm_interop_kokoro_lib.sh): 1. The list of tests in the each test suite 2. Per-test-suite flag customization 3. `run_test` methods 4. `build_docker_images_if_needed` methods 5. Generic `build_test_app_docker_images` methods (simple docker build + docker push + docker tag). grpc-java is one exception, as it doesn't run docker directly, but a cloudbuild flow. Now all PSM Interop jobs share the same buildscripts by all test suites: 1. buildscript that invokes the test: `psm-interop-test-{language}.sh` (configured as `build_file` in the build cfg) 2. buildscript that builds the xDS test client/server and publishes them as a Docker image: `psm-interop-build-{language}.sh` (conventional name called from `psm_interop_kokoro_lib.sh`) `psm-interop-test-{language}.sh`: 1. Sets `GRPC_LANGUAGE`, `BUILD_SCRIPT_DIR` environment variables. 2. Downloads the shared `psm_interop_kokoro_lib.sh` from the main branch of the psm-interop repo. 3. Sources `psm-interop-build-{language}.sh` 4. Calls `psm::run "${PSM_TEST_SUITE}"` (`PSM_TEST_SUITE` configured in the cfg file). `psm-interop-build-{language}.sh`: 1. Defines `psm::lang::build_docker_images` which is called from `psm_interop_kokoro_lib.sh`. 2. Invokes any repo-specific logic. 3. May use `psm::build::docker_images_generic` for generic Docker build, tag, push, or provide implement its own build/publish method. References: - b/288578634 - See the full list of the new features at grpc/psm-interop#73. - Additional fixes to the shared lib: grpc/psm-interop#78, grpc/psm-interop#79
gRPC-Java supports Java 8 and later. Android minSdkVersion 19 (KitKat) and later are supported with Java 8 language desugaring.
TLS usage on Android typically requires Play Services Dynamic Security Provider. Please see the Security Readme.
Older Java versions are not directly supported, but a branch remains available for fixes and releases. See gRFC P5 JDK Version Support Policy.
Java version | gRPC Branch |
---|---|
7 | 1.41.x |
For a guided tour, take a look at the quick start guide or the more explanatory gRPC basics.
The examples and the Android example are standalone projects that showcase the usage of gRPC.
Download the JARs. Or for Maven with non-Android, add to your pom.xml
:
<dependency> <groupId>io.grpc</groupId> <artifactId>grpc-netty-shaded</artifactId> <version>1.55.3</version> <scope>runtime</scope> </dependency> <dependency> <groupId>io.grpc</groupId> <artifactId>grpc-protobuf</artifactId> <version>1.55.3</version> </dependency> <dependency> <groupId>io.grpc</groupId> <artifactId>grpc-stub</artifactId> <version>1.55.3</version> </dependency> <dependency> <!-- necessary for Java 9+ --> <groupId>org.apache.tomcat</groupId> <artifactId>annotations-api</artifactId> <version>6.0.53</version> <scope>provided</scope> </dependency>
Or for Gradle with non-Android, add to your dependencies:
runtimeOnly 'io.grpc:grpc-netty-shaded:1.55.3' implementation 'io.grpc:grpc-protobuf:1.55.3' implementation 'io.grpc:grpc-stub:1.55.3' compileOnly 'org.apache.tomcat:annotations-api:6.0.53' // necessary for Java 9+
For Android client, use grpc-okhttp
instead of grpc-netty-shaded
and grpc-protobuf-lite
instead of grpc-protobuf
:
implementation 'io.grpc:grpc-okhttp:1.55.3' implementation 'io.grpc:grpc-protobuf-lite:1.55.3' implementation 'io.grpc:grpc-stub:1.55.3' compileOnly 'org.apache.tomcat:annotations-api:6.0.53' // necessary for Java 9+
Development snapshots are available in Sonatypes's snapshot repository.
For protobuf-based codegen, you can put your proto files in the src/main/proto
and src/test/proto
directories along with an appropriate plugin.
For protobuf-based codegen integrated with the Maven build system, you can use protobuf-maven-plugin (Eclipse and NetBeans users should also look at os-maven-plugin
's IDE documentation):
<build> <extensions> <extension> <groupId>kr.motd.maven</groupId> <artifactId>os-maven-plugin</artifactId> <version>1.7.1</version> </extension> </extensions> <plugins> <plugin> <groupId>org.xolstice.maven.plugins</groupId> <artifactId>protobuf-maven-plugin</artifactId> <version>0.6.1</version> <configuration> <protocArtifact>com.google.protobuf:protoc:3.22.3:exe:${os.detected.classifier}</protocArtifact> <pluginId>grpc-java</pluginId> <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.55.3:exe:${os.detected.classifier}</pluginArtifact> </configuration> <executions> <execution> <goals> <goal>compile</goal> <goal>compile-custom</goal> </goals> </execution> </executions> </plugin> </plugins> </build>
For non-Android protobuf-based codegen integrated with the Gradle build system, you can use protobuf-gradle-plugin:
plugins { id 'com.google.protobuf' version '0.9.1' } protobuf { protoc { artifact = "com.google.protobuf:protoc:3.22.3" } plugins { grpc { artifact = 'io.grpc:protoc-gen-grpc-java:1.55.3' } } generateProtoTasks { all()*.plugins { grpc {} } } }
The prebuilt protoc-gen-grpc-java binary uses glibc on Linux. If you are compiling on Alpine Linux, you may want to use the Alpine grpc-java package which uses musl instead.
For Android protobuf-based codegen integrated with the Gradle build system, also use protobuf-gradle-plugin but specify the ‘lite’ options:
plugins { id 'com.google.protobuf' version '0.9.1' } protobuf { protoc { artifact = "com.google.protobuf:protoc:3.22.3" } plugins { grpc { artifact = 'io.grpc:protoc-gen-grpc-java:1.55.3' } } generateProtoTasks { all().each { task -> task.builtins { java { option 'lite' } } task.plugins { grpc { option 'lite' } } } } }
APIs annotated with @Internal
are for internal use by the gRPC library and should not be used by gRPC users. APIs annotated with @ExperimentalApi
are subject to change in future releases, and library code that other projects may depend on should not use these APIs.
We recommend using the grpc-java-api-checker (an Error Prone plugin) to check for usages of @ExperimentalApi
and @Internal
in any library code that depends on gRPC. It may also be used to check for @Internal
usage or unintended @ExperimentalApi
consumption in non-library code.
If you are making changes to gRPC-Java, see the compiling instructions.
At a high level there are three distinct layers to the library: Stub, Channel, and Transport.
The Stub layer is what is exposed to most developers and provides type-safe bindings to whatever datamodel/IDL/interface you are adapting. gRPC comes with a plugin to the protocol-buffers compiler that generates Stub interfaces out of .proto
files, but bindings to other datamodel/IDL are easy and encouraged.
The Channel layer is an abstraction over Transport handling that is suitable for interception/decoration and exposes more behavior to the application than the Stub layer. It is intended to be easy for application frameworks to use this layer to address cross-cutting concerns such as logging, monitoring, auth, etc.
The Transport layer does the heavy lifting of putting and taking bytes off the wire. The interfaces to it are abstract just enough to allow plugging in of different implementations. Note the transport layer API is considered internal to gRPC and has weaker API guarantees than the core API under package io.grpc
.
gRPC comes with multiple Transport implementations: