From d17a2db4bd33e2b43b539bd2360fd00c5e1b4ec6 Mon Sep 17 00:00:00 2001 From: Eric Anderson Date: Thu, 5 Jan 2023 12:35:57 -0800 Subject: [PATCH] Upgrade to Checkstyle 8.28 Trying to upgrade Gradle to 7.6 improved the checkstyle plugin such that it appears to have been running in new occasions. That in turn exposed us to https://github.com/checkstyle/checkstyle/issues/5088. That bug was fixed in 8.28, which also fixed lots of other bugs. So now we have better checking and some existing volations needed fixing. Since the code style fixes generated a lot of noise, this is a pre-fix to reduce the size of a Gradle upgrade. I did not upgrade past 8.28 because at some point some other bugs were introduced, in particular with the Indentation module. I chose the oldest version that had the particular bug impacting me fixed. Upgrading to this old-but-newer version still makes it easier to upgrade to a newer version in the future. --- .../java/io/grpc/alts/AltsContextUtil.java | 2 +- .../grpc/alts/internal/AltsTsiHandshaker.java | 2 +- .../alts/internal/NettyTsiHandshaker.java | 2 +- .../io/grpc/alts/internal/TsiHandshaker.java | 2 +- api/src/main/java/io/grpc/Metadata.java | 2 +- api/src/main/java/io/grpc/NameResolver.java | 2 + api/src/main/java/io/grpc/Status.java | 2 + .../grpc/authz/AuthorizationEnd2EndTest.java | 1 - .../grpc/benchmarks/TransportBenchmark.java | 15 ++-- .../benchmarks/driver/LoadWorkerTest.java | 2 +- buildscripts/checkstyle.xml | 18 ++--- .../census/InternalCensusTracingAccessor.java | 3 +- context/src/main/java/io/grpc/Context.java | 4 +- context/src/main/java/io/grpc/Deadline.java | 9 +-- .../inprocess/InProcessSocketAddress.java | 13 ++-- .../io/grpc/internal/DnsNameResolver.java | 1 + .../main/java/io/grpc/internal/GrpcUtil.java | 2 +- .../grpc/internal/LogExceptionRunnable.java | 1 - .../io/grpc/internal/ManagedChannelImpl.java | 2 +- .../internal/ManagedChannelImplBuilder.java | 4 +- .../io/grpc/internal/ProxyDetectorImpl.java | 2 + .../io/grpc/internal/ServiceConfigState.java | 2 + .../util/ForwardingLoadBalancerHelper.java | 2 +- .../io/grpc/util/MutableHandlerRegistry.java | 2 +- .../io/grpc/internal/MessageDeframerTest.java | 2 + .../io/grpc/internal/MessageFramerTest.java | 2 + .../InternalLoggingServerInterceptor.java | 1 - .../ObservabilityConfigImplTest.java | 1 - gradle/libs.versions.toml | 2 +- .../integration/AbstractInteropTest.java | 10 +-- .../io/grpc/netty/shaded/ShadingTest.java | 1 - .../grpc/netty/InboundHeadersBenchmark.java | 70 +++++++++---------- .../java/io/grpc/netty/GrpcSslContexts.java | 6 +- .../java/io/grpc/netty/AdvancedTlsTest.java | 1 - .../io/grpc/okhttp/OkHttpClientTransport.java | 2 +- .../protobuf/services/HealthServiceImpl.java | 2 +- .../java/io/grpc/services/BinaryLogs.java | 2 + .../services/HealthStatusManagerTest.java | 2 +- .../java/io/grpc/stub/AbstractAsyncStub.java | 2 +- .../io/grpc/stub/annotations/RpcMethod.java | 2 +- .../FileWatcherCertificateProvider.java | 1 - ...rChainMatchingProtocolNegotiatorsTest.java | 1 - .../io/grpc/xds/XdsClientImplTestBase.java | 8 +-- .../XdsClientWrapperForServerSdsTestMisc.java | 1 - .../engine/GrpcAuthorizationEngineTest.java | 1 - 45 files changed, 108 insertions(+), 109 deletions(-) diff --git a/alts/src/main/java/io/grpc/alts/AltsContextUtil.java b/alts/src/main/java/io/grpc/alts/AltsContextUtil.java index a5d7c0e3ff..91b06756dc 100644 --- a/alts/src/main/java/io/grpc/alts/AltsContextUtil.java +++ b/alts/src/main/java/io/grpc/alts/AltsContextUtil.java @@ -26,7 +26,7 @@ import io.grpc.alts.internal.AltsProtocolNegotiator; @ExperimentalApi("https://github.com/grpc/grpc-java/issues/7864") public final class AltsContextUtil { - private AltsContextUtil(){} + private AltsContextUtil() {} /** * Creates a {@link AltsContext} from ALTS context information in the {@link ServerCall}. diff --git a/alts/src/main/java/io/grpc/alts/internal/AltsTsiHandshaker.java b/alts/src/main/java/io/grpc/alts/internal/AltsTsiHandshaker.java index 2269f0a0fa..007db9e1ee 100644 --- a/alts/src/main/java/io/grpc/alts/internal/AltsTsiHandshaker.java +++ b/alts/src/main/java/io/grpc/alts/internal/AltsTsiHandshaker.java @@ -169,7 +169,7 @@ public final class AltsTsiHandshaker implements TsiHandshaker { } /** - * Returns true if and only if the handshake is still in progress + * Returns true if and only if the handshake is still in progress. * * @return true, if the handshake is still in progress, false otherwise. */ diff --git a/alts/src/main/java/io/grpc/alts/internal/NettyTsiHandshaker.java b/alts/src/main/java/io/grpc/alts/internal/NettyTsiHandshaker.java index 5087123ab0..b91cfdad08 100644 --- a/alts/src/main/java/io/grpc/alts/internal/NettyTsiHandshaker.java +++ b/alts/src/main/java/io/grpc/alts/internal/NettyTsiHandshaker.java @@ -99,7 +99,7 @@ public final class NettyTsiHandshaker { } /** - * Returns true if and only if the handshake is still in progress + * Returns true if and only if the handshake is still in progress. * * @return true, if the handshake is still in progress, false otherwise. */ diff --git a/alts/src/main/java/io/grpc/alts/internal/TsiHandshaker.java b/alts/src/main/java/io/grpc/alts/internal/TsiHandshaker.java index c6da647168..6580a4433c 100644 --- a/alts/src/main/java/io/grpc/alts/internal/TsiHandshaker.java +++ b/alts/src/main/java/io/grpc/alts/internal/TsiHandshaker.java @@ -68,7 +68,7 @@ public interface TsiHandshaker { boolean processBytesFromPeer(ByteBuffer bytes) throws GeneralSecurityException; /** - * Returns true if and only if the handshake is still in progress + * Returns true if and only if the handshake is still in progress. * * @return true, if the handshake is still in progress, false otherwise. */ diff --git a/api/src/main/java/io/grpc/Metadata.java b/api/src/main/java/io/grpc/Metadata.java index 6311762601..8ea16ccb4e 100644 --- a/api/src/main/java/io/grpc/Metadata.java +++ b/api/src/main/java/io/grpc/Metadata.java @@ -834,7 +834,7 @@ public final class Metadata { abstract T parseBytes(byte[] serialized); /** - * @return whether this key will be serialized to bytes lazily. + * Returns whether this key will be serialized to bytes lazily. */ boolean serializesToStreams() { return false; diff --git a/api/src/main/java/io/grpc/NameResolver.java b/api/src/main/java/io/grpc/NameResolver.java index cfe2e934c0..48f835f994 100644 --- a/api/src/main/java/io/grpc/NameResolver.java +++ b/api/src/main/java/io/grpc/NameResolver.java @@ -205,6 +205,8 @@ public abstract class NameResolver { @ExperimentalApi("https://github.com/grpc/grpc-java/issues/1770") public abstract static class Listener2 implements Listener { /** + * Handles updates on resolved addresses and attributes. + * * @deprecated This will be removed in 1.22.0 */ @Override diff --git a/api/src/main/java/io/grpc/Status.java b/api/src/main/java/io/grpc/Status.java index f6e88eab8d..7382cd03ee 100644 --- a/api/src/main/java/io/grpc/Status.java +++ b/api/src/main/java/io/grpc/Status.java @@ -599,6 +599,8 @@ public final class Status { } /** + * Percent encode bytes to make them ASCII. + * * @param valueBytes the UTF-8 bytes * @param ri The reader index, pointed at the first byte that needs escaping. */ diff --git a/authz/src/test/java/io/grpc/authz/AuthorizationEnd2EndTest.java b/authz/src/test/java/io/grpc/authz/AuthorizationEnd2EndTest.java index 423c27bee5..28c17718d1 100644 --- a/authz/src/test/java/io/grpc/authz/AuthorizationEnd2EndTest.java +++ b/authz/src/test/java/io/grpc/authz/AuthorizationEnd2EndTest.java @@ -35,7 +35,6 @@ import io.grpc.stub.StreamObserver; import io.grpc.testing.protobuf.SimpleRequest; import io.grpc.testing.protobuf.SimpleResponse; import io.grpc.testing.protobuf.SimpleServiceGrpc; - import java.io.File; import org.junit.After; import org.junit.Test; diff --git a/benchmarks/src/jmh/java/io/grpc/benchmarks/TransportBenchmark.java b/benchmarks/src/jmh/java/io/grpc/benchmarks/TransportBenchmark.java index 1af821be83..21f6195075 100644 --- a/benchmarks/src/jmh/java/io/grpc/benchmarks/TransportBenchmark.java +++ b/benchmarks/src/jmh/java/io/grpc/benchmarks/TransportBenchmark.java @@ -87,23 +87,20 @@ public class TransportBenchmark { ServerBuilder serverBuilder; ManagedChannelBuilder channelBuilder; switch (transport) { - case INPROCESS: - { + case INPROCESS: { String name = "bench" + Math.random(); serverBuilder = InProcessServerBuilder.forName(name); channelBuilder = InProcessChannelBuilder.forName(name); break; } - case NETTY: - { + case NETTY: { InetSocketAddress address = new InetSocketAddress("localhost", pickUnusedPort()); serverBuilder = NettyServerBuilder.forAddress(address, serverCreds); channelBuilder = NettyChannelBuilder.forAddress(address) .negotiationType(NegotiationType.PLAINTEXT); break; } - case NETTY_LOCAL: - { + case NETTY_LOCAL: { String name = "bench" + Math.random(); LocalAddress address = new LocalAddress(name); EventLoopGroup group = new DefaultEventLoopGroup(); @@ -118,8 +115,7 @@ public class TransportBenchmark { groupToShutdown = group; break; } - case NETTY_EPOLL: - { + case NETTY_EPOLL: { InetSocketAddress address = new InetSocketAddress("localhost", pickUnusedPort()); // Reflection used since they are only available on linux. @@ -143,8 +139,7 @@ public class TransportBenchmark { groupToShutdown = group; break; } - case OKHTTP: - { + case OKHTTP: { int port = pickUnusedPort(); InetSocketAddress address = new InetSocketAddress("localhost", port); serverBuilder = NettyServerBuilder.forAddress(address, serverCreds); diff --git a/benchmarks/src/test/java/io/grpc/benchmarks/driver/LoadWorkerTest.java b/benchmarks/src/test/java/io/grpc/benchmarks/driver/LoadWorkerTest.java index 827c514df8..64e2f2694e 100644 --- a/benchmarks/src/test/java/io/grpc/benchmarks/driver/LoadWorkerTest.java +++ b/benchmarks/src/test/java/io/grpc/benchmarks/driver/LoadWorkerTest.java @@ -36,7 +36,7 @@ import org.junit.runner.RunWith; import org.junit.runners.JUnit4; /** - * Basic tests for {@link io.grpc.benchmarks.driver.LoadWorker} + * Basic tests for {@link io.grpc.benchmarks.driver.LoadWorker}. */ @RunWith(JUnit4.class) public class LoadWorkerTest { diff --git a/buildscripts/checkstyle.xml b/buildscripts/checkstyle.xml index 52b564201c..a5aded93a8 100644 --- a/buildscripts/checkstyle.xml +++ b/buildscripts/checkstyle.xml @@ -33,6 +33,11 @@ + + + + + @@ -45,10 +50,6 @@ - - - - @@ -59,12 +60,8 @@ - - - - + - @@ -204,13 +201,10 @@ - - - diff --git a/census/src/main/java/io/grpc/census/InternalCensusTracingAccessor.java b/census/src/main/java/io/grpc/census/InternalCensusTracingAccessor.java index 5709d3a6e4..d04d10739e 100644 --- a/census/src/main/java/io/grpc/census/InternalCensusTracingAccessor.java +++ b/census/src/main/java/io/grpc/census/InternalCensusTracingAccessor.java @@ -40,8 +40,9 @@ public final class InternalCensusTracingAccessor { } /** - * @param addMessageEvents add message events to Spans + * Returns the client interceptor that facilitates Census-based stats reporting. * + * @param addMessageEvents add message events to Spans * @return a {@link ClientInterceptor} with default tracing implementation. */ public static ClientInterceptor getClientInterceptor( diff --git a/context/src/main/java/io/grpc/Context.java b/context/src/main/java/io/grpc/Context.java index 41d3a5c94a..f63f021216 100644 --- a/context/src/main/java/io/grpc/Context.java +++ b/context/src/main/java/io/grpc/Context.java @@ -1000,6 +1000,8 @@ public class Context { */ public abstract static class Storage { /** + * Unused. + * * @deprecated This is an old API that is no longer used. */ @Deprecated @@ -1029,7 +1031,7 @@ public class Context { } /** - * Implements {@link io.grpc.Context#detach} + * Implements {@link io.grpc.Context#detach}. * * @param toDetach the context to be detached. Should be, or be equivalent to, the current * context of the current scope diff --git a/context/src/main/java/io/grpc/Deadline.java b/context/src/main/java/io/grpc/Deadline.java index 73c8760595..62b803267a 100644 --- a/context/src/main/java/io/grpc/Deadline.java +++ b/context/src/main/java/io/grpc/Deadline.java @@ -45,7 +45,7 @@ public final class Deadline implements Comparable { * *

This is EXPERIMENTAL API and may subject to change. If you'd like it to be * stabilized or have any feedback, please - * let us know. + * let us know. * * @since 1.24.0 */ @@ -81,7 +81,7 @@ public final class Deadline implements Comparable { * *

This is EXPERIMENTAL API and may subject to change. If you'd like it to be * stabilized or have any feedback, please - * let us know. + * let us know. * * @param duration A non-negative duration. * @param units The time unit for the duration. @@ -113,7 +113,8 @@ public final class Deadline implements Comparable { } /** - * Has this deadline expired + * Returns whether this has deadline expired. + * * @return {@code true} if it has, otherwise {@code false}. */ public boolean isExpired() { @@ -266,7 +267,7 @@ public final class Deadline implements Comparable { * *

This is EXPERIMENTAL API and may subject to change. If you'd like it to be * stabilized or have any feedback, please - * let us know. + * let us know. * *

In general implementations should be thread-safe, unless it's implemented and used in a * localized environment (like unit tests) where you are sure the usages are synchronized. diff --git a/core/src/main/java/io/grpc/inprocess/InProcessSocketAddress.java b/core/src/main/java/io/grpc/inprocess/InProcessSocketAddress.java index e5f0515f1d..98ecf7e1a5 100644 --- a/core/src/main/java/io/grpc/inprocess/InProcessSocketAddress.java +++ b/core/src/main/java/io/grpc/inprocess/InProcessSocketAddress.java @@ -29,7 +29,9 @@ public final class InProcessSocketAddress extends SocketAddress { private final String name; /** - * @param name - The name of the inprocess channel or server. + * Construct an address for a server identified by name. + * + * @param name The name of the inprocess server. * @since 1.0.0 */ public InProcessSocketAddress(String name) { @@ -37,7 +39,7 @@ public final class InProcessSocketAddress extends SocketAddress { } /** - * Gets the name of the inprocess channel or server. + * Gets the name of the inprocess server. * * @since 1.0.0 */ @@ -46,6 +48,8 @@ public final class InProcessSocketAddress extends SocketAddress { } /** + * Returns {@link #getName}. + * * @since 1.14.0 */ @Override @@ -53,15 +57,14 @@ public final class InProcessSocketAddress extends SocketAddress { return name; } - /** - * @since 1.15.0 - */ @Override public int hashCode() { return name.hashCode(); } /** + * Returns {@code true} if the object is of the same type and server names match. + * * @since 1.15.0 */ @Override diff --git a/core/src/main/java/io/grpc/internal/DnsNameResolver.java b/core/src/main/java/io/grpc/internal/DnsNameResolver.java index 5418a0bd32..5ef6dd863c 100644 --- a/core/src/main/java/io/grpc/internal/DnsNameResolver.java +++ b/core/src/main/java/io/grpc/internal/DnsNameResolver.java @@ -411,6 +411,7 @@ public class DnsNameResolver extends NameResolver { } /** + * Parse TXT service config records as JSON. * * @throws IOException if one of the txt records contains improperly formatted JSON. */ diff --git a/core/src/main/java/io/grpc/internal/GrpcUtil.java b/core/src/main/java/io/grpc/internal/GrpcUtil.java index d1952565df..85353a08df 100644 --- a/core/src/main/java/io/grpc/internal/GrpcUtil.java +++ b/core/src/main/java/io/grpc/internal/GrpcUtil.java @@ -650,7 +650,7 @@ public final class GrpcUtil { /** * Marshals a nanoseconds representation of the timeout to and from a string representation, * consisting of an ASCII decimal representation of a number with at most 8 digits, followed by a - * unit: + * unit. Available units: * n = nanoseconds * u = microseconds * m = milliseconds diff --git a/core/src/main/java/io/grpc/internal/LogExceptionRunnable.java b/core/src/main/java/io/grpc/internal/LogExceptionRunnable.java index 546e72911c..f4c6f2fc8e 100644 --- a/core/src/main/java/io/grpc/internal/LogExceptionRunnable.java +++ b/core/src/main/java/io/grpc/internal/LogExceptionRunnable.java @@ -19,7 +19,6 @@ package io.grpc.internal; import static com.google.common.base.Preconditions.checkNotNull; import com.google.common.base.Throwables; - import java.util.logging.Level; import java.util.logging.Logger; diff --git a/core/src/main/java/io/grpc/internal/ManagedChannelImpl.java b/core/src/main/java/io/grpc/internal/ManagedChannelImpl.java index 0311a6d2e3..a1bf039820 100644 --- a/core/src/main/java/io/grpc/internal/ManagedChannelImpl.java +++ b/core/src/main/java/io/grpc/internal/ManagedChannelImpl.java @@ -2287,7 +2287,7 @@ final class ManagedChannelImpl extends ManagedChannel implements @Override public T invokeAny(Collection> tasks, long timeout, TimeUnit unit) - throws InterruptedException, ExecutionException, TimeoutException { + throws InterruptedException, ExecutionException, TimeoutException { return delegate.invokeAny(tasks, timeout, unit); } diff --git a/core/src/main/java/io/grpc/internal/ManagedChannelImplBuilder.java b/core/src/main/java/io/grpc/internal/ManagedChannelImplBuilder.java index 53d5302e92..536216b20a 100644 --- a/core/src/main/java/io/grpc/internal/ManagedChannelImplBuilder.java +++ b/core/src/main/java/io/grpc/internal/ManagedChannelImplBuilder.java @@ -281,8 +281,8 @@ public final class ManagedChannelImplBuilder public ManagedChannelImplBuilder(SocketAddress directServerAddress, String authority, ClientTransportFactoryBuilder clientTransportFactoryBuilder, @Nullable ChannelBuilderDefaultPortProvider channelBuilderDefaultPortProvider) { - this(directServerAddress, authority, null, null, clientTransportFactoryBuilder, - channelBuilderDefaultPortProvider); + this(directServerAddress, authority, null, null, clientTransportFactoryBuilder, + channelBuilderDefaultPortProvider); } /** diff --git a/core/src/main/java/io/grpc/internal/ProxyDetectorImpl.java b/core/src/main/java/io/grpc/internal/ProxyDetectorImpl.java index f66dbff13a..c69ee25ef3 100644 --- a/core/src/main/java/io/grpc/internal/ProxyDetectorImpl.java +++ b/core/src/main/java/io/grpc/internal/ProxyDetectorImpl.java @@ -150,6 +150,8 @@ class ProxyDetectorImpl implements ProxyDetector { }; /** + * Experimental environment variable name for enabling proxy support. + * * @deprecated Use the standard Java proxy configuration instead with flags such as: * -Dhttps.proxyHost=HOST -Dhttps.proxyPort=PORT */ diff --git a/core/src/main/java/io/grpc/internal/ServiceConfigState.java b/core/src/main/java/io/grpc/internal/ServiceConfigState.java index 73486bb0bd..d916c2d0e9 100644 --- a/core/src/main/java/io/grpc/internal/ServiceConfigState.java +++ b/core/src/main/java/io/grpc/internal/ServiceConfigState.java @@ -35,6 +35,8 @@ final class ServiceConfigState { private boolean updated; /** + * Construct new instance. + * * @param defaultServiceConfig The initial service config, or {@code null} if absent. * @param lookUpServiceConfig {@code true} if service config updates might occur. */ diff --git a/core/src/main/java/io/grpc/util/ForwardingLoadBalancerHelper.java b/core/src/main/java/io/grpc/util/ForwardingLoadBalancerHelper.java index f8e901205e..c684051f0b 100644 --- a/core/src/main/java/io/grpc/util/ForwardingLoadBalancerHelper.java +++ b/core/src/main/java/io/grpc/util/ForwardingLoadBalancerHelper.java @@ -22,10 +22,10 @@ import io.grpc.ChannelLogger; import io.grpc.ConnectivityState; import io.grpc.EquivalentAddressGroup; import io.grpc.ExperimentalApi; +import io.grpc.LoadBalancer; import io.grpc.LoadBalancer.CreateSubchannelArgs; import io.grpc.LoadBalancer.Subchannel; import io.grpc.LoadBalancer.SubchannelPicker; -import io.grpc.LoadBalancer; import io.grpc.ManagedChannel; import io.grpc.ManagedChannelBuilder; import io.grpc.NameResolver; diff --git a/core/src/main/java/io/grpc/util/MutableHandlerRegistry.java b/core/src/main/java/io/grpc/util/MutableHandlerRegistry.java index 1e92341892..c31102f421 100644 --- a/core/src/main/java/io/grpc/util/MutableHandlerRegistry.java +++ b/core/src/main/java/io/grpc/util/MutableHandlerRegistry.java @@ -65,7 +65,7 @@ public final class MutableHandlerRegistry extends HandlerRegistry { } /** - * Removes a registered service + * Removes a registered service. * * @return true if the service was found to be removed. */ diff --git a/core/src/test/java/io/grpc/internal/MessageDeframerTest.java b/core/src/test/java/io/grpc/internal/MessageDeframerTest.java index 6d2c27d6b1..98ed069145 100644 --- a/core/src/test/java/io/grpc/internal/MessageDeframerTest.java +++ b/core/src/test/java/io/grpc/internal/MessageDeframerTest.java @@ -495,6 +495,8 @@ public class MessageDeframerTest { } /** + * Verify stats were published through the tracer. + * * @param transportStats the transport level stats counters * @param clock the fakeClock to verify timestamp * @param sizes in the format {wire0, uncompressed0, wire1, uncompressed1, ...} diff --git a/core/src/test/java/io/grpc/internal/MessageFramerTest.java b/core/src/test/java/io/grpc/internal/MessageFramerTest.java index 752efad2dc..07f717cb81 100644 --- a/core/src/test/java/io/grpc/internal/MessageFramerTest.java +++ b/core/src/test/java/io/grpc/internal/MessageFramerTest.java @@ -373,6 +373,8 @@ public class MessageFramerTest { } /** + * Verify stats were published through the tracer. + * * @param sizes in the format {wire0, uncompressed0, wire1, uncompressed1, ...} */ private void checkStats(long... sizes) { diff --git a/gcp-observability/src/main/java/io/grpc/gcp/observability/interceptors/InternalLoggingServerInterceptor.java b/gcp-observability/src/main/java/io/grpc/gcp/observability/interceptors/InternalLoggingServerInterceptor.java index fe98fbdc6d..acb8df2916 100644 --- a/gcp-observability/src/main/java/io/grpc/gcp/observability/interceptors/InternalLoggingServerInterceptor.java +++ b/gcp-observability/src/main/java/io/grpc/gcp/observability/interceptors/InternalLoggingServerInterceptor.java @@ -28,7 +28,6 @@ import io.grpc.ServerCall; import io.grpc.ServerCallHandler; import io.grpc.ServerInterceptor; import io.grpc.Status; - import io.grpc.gcp.observability.interceptors.ConfigFilterHelper.FilterParams; import io.grpc.observabilitylog.v1.GrpcLogRecord.EventLogger; import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType; diff --git a/gcp-observability/src/test/java/io/grpc/gcp/observability/ObservabilityConfigImplTest.java b/gcp-observability/src/test/java/io/grpc/gcp/observability/ObservabilityConfigImplTest.java index d305583d53..d6f23fbcc9 100644 --- a/gcp-observability/src/test/java/io/grpc/gcp/observability/ObservabilityConfigImplTest.java +++ b/gcp-observability/src/test/java/io/grpc/gcp/observability/ObservabilityConfigImplTest.java @@ -33,7 +33,6 @@ import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Map; - import java.util.Set; import java.util.stream.Collectors; import java.util.stream.Stream; diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 37d443cd47..8bad06b577 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -2,7 +2,7 @@ # Breaks on upgrade: https://github.com/mojohaus/animal-sniffer/issues/131 animalsniffer = "1.18" autovalue = "1.9" -checkstyle = "6.17" +checkstyle = "8.28" googleauth = "1.4.0" guava = "31.1-android" netty = '4.1.79.Final' diff --git a/interop-testing/src/main/java/io/grpc/testing/integration/AbstractInteropTest.java b/interop-testing/src/main/java/io/grpc/testing/integration/AbstractInteropTest.java index d04873c5a9..b7298cec20 100644 --- a/interop-testing/src/main/java/io/grpc/testing/integration/AbstractInteropTest.java +++ b/interop-testing/src/main/java/io/grpc/testing/integration/AbstractInteropTest.java @@ -2126,7 +2126,7 @@ public abstract class AbstractInteropTest { } } - /** Helper for getting remote address from {@link io.grpc.ServerCall#getAttributes()} */ + /** Helper for getting remote address from {@link io.grpc.ServerCall#getAttributes()}. */ protected SocketAddress obtainRemoteClientAddr() { TestServiceGrpc.TestServiceBlockingStub stub = blockingStub.withDeadlineAfter(5, TimeUnit.SECONDS); @@ -2136,7 +2136,7 @@ public abstract class AbstractInteropTest { return serverCallCapture.get().getAttributes().get(Grpc.TRANSPORT_ATTR_REMOTE_ADDR); } - /** Helper for getting remote address from {@link io.grpc.ClientCall#getAttributes()} */ + /** Helper for getting remote address from {@link io.grpc.ClientCall#getAttributes()}. */ protected SocketAddress obtainRemoteServerAddr() { TestServiceGrpc.TestServiceBlockingStub stub = blockingStub .withInterceptors(recordClientCallInterceptor(clientCallCapture)) @@ -2147,7 +2147,7 @@ public abstract class AbstractInteropTest { return clientCallCapture.get().getAttributes().get(Grpc.TRANSPORT_ATTR_REMOTE_ADDR); } - /** Helper for getting local address from {@link io.grpc.ServerCall#getAttributes()} */ + /** Helper for getting local address from {@link io.grpc.ServerCall#getAttributes()}. */ protected SocketAddress obtainLocalServerAddr() { TestServiceGrpc.TestServiceBlockingStub stub = blockingStub.withDeadlineAfter(5, TimeUnit.SECONDS); @@ -2157,7 +2157,7 @@ public abstract class AbstractInteropTest { return serverCallCapture.get().getAttributes().get(Grpc.TRANSPORT_ATTR_LOCAL_ADDR); } - /** Helper for getting local address from {@link io.grpc.ClientCall#getAttributes()} */ + /** Helper for getting local address from {@link io.grpc.ClientCall#getAttributes()}. */ protected SocketAddress obtainLocalClientAddr() { TestServiceGrpc.TestServiceBlockingStub stub = blockingStub .withInterceptors(recordClientCallInterceptor(clientCallCapture)) @@ -2168,7 +2168,7 @@ public abstract class AbstractInteropTest { return clientCallCapture.get().getAttributes().get(Grpc.TRANSPORT_ATTR_LOCAL_ADDR); } - /** Helper for asserting TLS info in SSLSession {@link io.grpc.ServerCall#getAttributes()} */ + /** Helper for asserting TLS info in SSLSession {@link io.grpc.ServerCall#getAttributes()}. */ protected void assertX500SubjectDn(String tlsInfo) { TestServiceGrpc.TestServiceBlockingStub stub = blockingStub.withDeadlineAfter(5, TimeUnit.SECONDS); diff --git a/netty/shaded/src/testShadow/java/io/grpc/netty/shaded/ShadingTest.java b/netty/shaded/src/testShadow/java/io/grpc/netty/shaded/ShadingTest.java index 5c2ff317cc..e1f46720e0 100644 --- a/netty/shaded/src/testShadow/java/io/grpc/netty/shaded/ShadingTest.java +++ b/netty/shaded/src/testShadow/java/io/grpc/netty/shaded/ShadingTest.java @@ -39,7 +39,6 @@ import io.grpc.testing.protobuf.SimpleResponse; import io.grpc.testing.protobuf.SimpleServiceGrpc; import io.grpc.testing.protobuf.SimpleServiceGrpc.SimpleServiceBlockingStub; import io.grpc.testing.protobuf.SimpleServiceGrpc.SimpleServiceImplBase; - import java.io.IOException; import java.io.InputStream; import java.nio.charset.StandardCharsets; diff --git a/netty/src/jmh/java/io/grpc/netty/InboundHeadersBenchmark.java b/netty/src/jmh/java/io/grpc/netty/InboundHeadersBenchmark.java index aef75a1a26..504f4ec27d 100644 --- a/netty/src/jmh/java/io/grpc/netty/InboundHeadersBenchmark.java +++ b/netty/src/jmh/java/io/grpc/netty/InboundHeadersBenchmark.java @@ -147,39 +147,39 @@ public class InboundHeadersBenchmark { bh.consume(Utils.convertHeaders(headers)); } -// /** -// * Prints the size of the header objects in bytes. Needs JOL (Java Object Layout) as a -// * dependency. -// */ -// public static void main(String... args) { -// Http2Headers grpcRequestHeaders = new GrpcHttp2RequestHeaders(4); -// Http2Headers defaultRequestHeaders = new DefaultHttp2Headers(true, 9); -// for (int i = 0; i < requestHeaders.length; i += 2) { -// grpcRequestHeaders.add(requestHeaders[i], requestHeaders[i + 1]); -// defaultRequestHeaders.add(requestHeaders[i], requestHeaders[i + 1]); -// } -// long c = 10L; -// int m = ((int) c) / 20; -// -// long grpcRequestHeadersBytes = GraphLayout.parseInstance(grpcRequestHeaders).totalSize(); -// long defaultRequestHeadersBytes = -// GraphLayout.parseInstance(defaultRequestHeaders).totalSize(); -// -// System.out.printf("gRPC Request Headers: %d bytes%nNetty Request Headers: %d bytes%n", -// grpcRequestHeadersBytes, defaultRequestHeadersBytes); -// -// Http2Headers grpcResponseHeaders = new GrpcHttp2RequestHeaders(4); -// Http2Headers defaultResponseHeaders = new DefaultHttp2Headers(true, 9); -// for (int i = 0; i < responseHeaders.length; i += 2) { -// grpcResponseHeaders.add(responseHeaders[i], responseHeaders[i + 1]); -// defaultResponseHeaders.add(responseHeaders[i], responseHeaders[i + 1]); -// } -// -// long grpcResponseHeadersBytes = GraphLayout.parseInstance(grpcResponseHeaders).totalSize(); -// long defaultResponseHeadersBytes = -// GraphLayout.parseInstance(defaultResponseHeaders).totalSize(); -// -// System.out.printf("gRPC Response Headers: %d bytes%nNetty Response Headers: %d bytes%n", -// grpcResponseHeadersBytes, defaultResponseHeadersBytes); -// } + ///** + // * Prints the size of the header objects in bytes. Needs JOL (Java Object Layout) as a + // * dependency. + // */ + //public static void main(String... args) { + // Http2Headers grpcRequestHeaders = new GrpcHttp2RequestHeaders(4); + // Http2Headers defaultRequestHeaders = new DefaultHttp2Headers(true, 9); + // for (int i = 0; i < requestHeaders.length; i += 2) { + // grpcRequestHeaders.add(requestHeaders[i], requestHeaders[i + 1]); + // defaultRequestHeaders.add(requestHeaders[i], requestHeaders[i + 1]); + // } + // long c = 10L; + // int m = ((int) c) / 20; + + // long grpcRequestHeadersBytes = GraphLayout.parseInstance(grpcRequestHeaders).totalSize(); + // long defaultRequestHeadersBytes = + // GraphLayout.parseInstance(defaultRequestHeaders).totalSize(); + + // System.out.printf("gRPC Request Headers: %d bytes%nNetty Request Headers: %d bytes%n", + // grpcRequestHeadersBytes, defaultRequestHeadersBytes); + + // Http2Headers grpcResponseHeaders = new GrpcHttp2RequestHeaders(4); + // Http2Headers defaultResponseHeaders = new DefaultHttp2Headers(true, 9); + // for (int i = 0; i < responseHeaders.length; i += 2) { + // grpcResponseHeaders.add(responseHeaders[i], responseHeaders[i + 1]); + // defaultResponseHeaders.add(responseHeaders[i], responseHeaders[i + 1]); + // } + + // long grpcResponseHeadersBytes = GraphLayout.parseInstance(grpcResponseHeaders).totalSize(); + // long defaultResponseHeadersBytes = + // GraphLayout.parseInstance(defaultResponseHeaders).totalSize(); + + // System.out.printf("gRPC Response Headers: %d bytes%nNetty Response Headers: %d bytes%n", + // grpcResponseHeadersBytes, defaultResponseHeadersBytes); + //} } diff --git a/netty/src/main/java/io/grpc/netty/GrpcSslContexts.java b/netty/src/main/java/io/grpc/netty/GrpcSslContexts.java index d89c1647e5..04a290165d 100644 --- a/netty/src/main/java/io/grpc/netty/GrpcSslContexts.java +++ b/netty/src/main/java/io/grpc/netty/GrpcSslContexts.java @@ -154,8 +154,7 @@ public class GrpcSslContexts { @CanIgnoreReturnValue public static SslContextBuilder configure(SslContextBuilder builder, SslProvider provider) { switch (provider) { - case JDK: - { + case JDK: { Provider jdkProvider = findJdkProvider(); if (jdkProvider == null) { throw new IllegalArgumentException( @@ -163,8 +162,7 @@ public class GrpcSslContexts { } return configure(builder, jdkProvider); } - case OPENSSL: - { + case OPENSSL: { ApplicationProtocolConfig apc; if (OpenSsl.isAlpnSupported()) { apc = NPN_AND_ALPN; diff --git a/netty/src/test/java/io/grpc/netty/AdvancedTlsTest.java b/netty/src/test/java/io/grpc/netty/AdvancedTlsTest.java index 6b5a96b45a..98bb4ea81e 100644 --- a/netty/src/test/java/io/grpc/netty/AdvancedTlsTest.java +++ b/netty/src/test/java/io/grpc/netty/AdvancedTlsTest.java @@ -40,7 +40,6 @@ import io.grpc.util.AdvancedTlsX509TrustManager; import io.grpc.util.AdvancedTlsX509TrustManager.SslSocketAndEnginePeerVerifier; import io.grpc.util.AdvancedTlsX509TrustManager.Verification; import io.grpc.util.CertificateUtils; - import java.io.Closeable; import java.io.File; import java.io.IOException; diff --git a/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java b/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java index 02b1c3254f..6eaaf832a6 100644 --- a/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java +++ b/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java @@ -914,7 +914,7 @@ class OkHttpClientTransport implements ConnectionClientTransport, TransportExcep } /** - * Called when a stream is closed, we do things like: + * Called when a stream is closed. We do things like: *

    *
  • Removing the stream from the map. *
  • Optionally reporting the status. diff --git a/services/src/main/java/io/grpc/protobuf/services/HealthServiceImpl.java b/services/src/main/java/io/grpc/protobuf/services/HealthServiceImpl.java index a1933c632f..6ce602b929 100644 --- a/services/src/main/java/io/grpc/protobuf/services/HealthServiceImpl.java +++ b/services/src/main/java/io/grpc/protobuf/services/HealthServiceImpl.java @@ -18,8 +18,8 @@ package io.grpc.protobuf.services; import com.google.common.annotations.VisibleForTesting; import com.google.common.util.concurrent.MoreExecutors; -import io.grpc.Context.CancellationListener; import io.grpc.Context; +import io.grpc.Context.CancellationListener; import io.grpc.Status; import io.grpc.StatusException; import io.grpc.health.v1.HealthCheckRequest; diff --git a/services/src/main/java/io/grpc/services/BinaryLogs.java b/services/src/main/java/io/grpc/services/BinaryLogs.java index e4831dc5bf..ad8a27c329 100644 --- a/services/src/main/java/io/grpc/services/BinaryLogs.java +++ b/services/src/main/java/io/grpc/services/BinaryLogs.java @@ -22,6 +22,8 @@ import io.grpc.protobuf.services.BinaryLogSink; import java.io.IOException; /** + * Utility class to create BinaryLog instances. + * * @deprecated Use {@link io.grpc.protobuf.services.BinaryLogs} instead. */ @Deprecated diff --git a/services/src/test/java/io/grpc/protobuf/services/HealthStatusManagerTest.java b/services/src/test/java/io/grpc/protobuf/services/HealthStatusManagerTest.java index 5c5b30f336..87d4ac29be 100644 --- a/services/src/test/java/io/grpc/protobuf/services/HealthStatusManagerTest.java +++ b/services/src/test/java/io/grpc/protobuf/services/HealthStatusManagerTest.java @@ -20,8 +20,8 @@ import static com.google.common.truth.Truth.assertThat; import static org.junit.Assert.fail; import io.grpc.BindableService; -import io.grpc.Context.CancellableContext; import io.grpc.Context; +import io.grpc.Context.CancellableContext; import io.grpc.Status; import io.grpc.StatusRuntimeException; import io.grpc.health.v1.HealthCheckRequest; diff --git a/stub/src/main/java/io/grpc/stub/AbstractAsyncStub.java b/stub/src/main/java/io/grpc/stub/AbstractAsyncStub.java index 3c09035747..c6f912cb3a 100644 --- a/stub/src/main/java/io/grpc/stub/AbstractAsyncStub.java +++ b/stub/src/main/java/io/grpc/stub/AbstractAsyncStub.java @@ -35,7 +35,7 @@ import javax.annotation.concurrent.ThreadSafe; public abstract class AbstractAsyncStub> extends AbstractStub { protected AbstractAsyncStub(Channel channel, CallOptions callOptions) { - super(channel, callOptions); + super(channel, callOptions); } /** diff --git a/stub/src/main/java/io/grpc/stub/annotations/RpcMethod.java b/stub/src/main/java/io/grpc/stub/annotations/RpcMethod.java index fbf46baed8..3615eddfa7 100644 --- a/stub/src/main/java/io/grpc/stub/annotations/RpcMethod.java +++ b/stub/src/main/java/io/grpc/stub/annotations/RpcMethod.java @@ -25,7 +25,7 @@ import java.lang.annotation.Target; /** * {@link RpcMethod} contains a limited subset of information about the RPC to assist * - * Java Annotation Processors. + * Java Annotation Processors. * *

    * This annotation is used by the gRPC stub compiler to annotate {@link MethodDescriptor} diff --git a/xds/src/main/java/io/grpc/xds/internal/security/certprovider/FileWatcherCertificateProvider.java b/xds/src/main/java/io/grpc/xds/internal/security/certprovider/FileWatcherCertificateProvider.java index e5855f55b0..dd945ce850 100644 --- a/xds/src/main/java/io/grpc/xds/internal/security/certprovider/FileWatcherCertificateProvider.java +++ b/xds/src/main/java/io/grpc/xds/internal/security/certprovider/FileWatcherCertificateProvider.java @@ -22,7 +22,6 @@ import com.google.common.annotations.VisibleForTesting; import io.grpc.Status; import io.grpc.internal.TimeProvider; import io.grpc.xds.internal.security.trust.CertificateUtils; - import java.io.ByteArrayInputStream; import java.nio.file.Files; import java.nio.file.Path; diff --git a/xds/src/test/java/io/grpc/xds/FilterChainMatchingProtocolNegotiatorsTest.java b/xds/src/test/java/io/grpc/xds/FilterChainMatchingProtocolNegotiatorsTest.java index 3b129e99be..685102477c 100644 --- a/xds/src/test/java/io/grpc/xds/FilterChainMatchingProtocolNegotiatorsTest.java +++ b/xds/src/test/java/io/grpc/xds/FilterChainMatchingProtocolNegotiatorsTest.java @@ -64,7 +64,6 @@ import java.util.Collections; import java.util.HashMap; import java.util.Map; import java.util.concurrent.atomic.AtomicReference; - import org.junit.After; import org.junit.Rule; import org.junit.Test; diff --git a/xds/src/test/java/io/grpc/xds/XdsClientImplTestBase.java b/xds/src/test/java/io/grpc/xds/XdsClientImplTestBase.java index 391845ad10..138ab4f589 100644 --- a/xds/src/test/java/io/grpc/xds/XdsClientImplTestBase.java +++ b/xds/src/test/java/io/grpc/xds/XdsClientImplTestBase.java @@ -693,7 +693,7 @@ public abstract class XdsClientImplTestBase { * Tests a subscribed LDS resource transitioned to and from the invalid state. * * @see - * A40-csds-support.md. + * A40-csds-support.md */ @Test public void ldsResponseErrorHandling_subscribedResourceInvalid() { @@ -1430,7 +1430,7 @@ public abstract class XdsClientImplTestBase { * Tests a subscribed RDS resource transitioned to and from the invalid state. * * @see - * A40-csds-support.md. + * A40-csds-support.md */ @Test public void rdsResponseErrorHandling_subscribedResourceInvalid() { @@ -1803,7 +1803,7 @@ public abstract class XdsClientImplTestBase { * Tests a subscribed CDS resource transitioned to and from the invalid state. * * @see - * A40-csds-support.md. + * A40-csds-support.md */ @Test public void cdsResponseErrorHandling_subscribedResourceInvalid() { @@ -2813,7 +2813,7 @@ public abstract class XdsClientImplTestBase { * Tests a subscribed EDS resource transitioned to and from the invalid state. * * @see - * A40-csds-support.md. + * A40-csds-support.md */ @Test public void edsResponseErrorHandling_subscribedResourceInvalid() { diff --git a/xds/src/test/java/io/grpc/xds/XdsClientWrapperForServerSdsTestMisc.java b/xds/src/test/java/io/grpc/xds/XdsClientWrapperForServerSdsTestMisc.java index 5099178118..f40a28158f 100644 --- a/xds/src/test/java/io/grpc/xds/XdsClientWrapperForServerSdsTestMisc.java +++ b/xds/src/test/java/io/grpc/xds/XdsClientWrapperForServerSdsTestMisc.java @@ -71,7 +71,6 @@ import java.net.SocketAddress; import java.util.concurrent.Executors; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; - import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; diff --git a/xds/src/test/java/io/grpc/xds/internal/rbac/engine/GrpcAuthorizationEngineTest.java b/xds/src/test/java/io/grpc/xds/internal/rbac/engine/GrpcAuthorizationEngineTest.java index 410ffb1b46..44b3407ba0 100644 --- a/xds/src/test/java/io/grpc/xds/internal/rbac/engine/GrpcAuthorizationEngineTest.java +++ b/xds/src/test/java/io/grpc/xds/internal/rbac/engine/GrpcAuthorizationEngineTest.java @@ -49,7 +49,6 @@ import io.grpc.xds.internal.rbac.engine.GrpcAuthorizationEngine.OrMatcher; import io.grpc.xds.internal.rbac.engine.GrpcAuthorizationEngine.PathMatcher; import io.grpc.xds.internal.rbac.engine.GrpcAuthorizationEngine.PolicyMatcher; import io.grpc.xds.internal.rbac.engine.GrpcAuthorizationEngine.SourceIpMatcher; - import java.net.InetAddress; import java.net.InetSocketAddress; import java.security.Principal;