forked from grpc/grpc-java
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
core,grpclb: DnsNameResolver will use srv record by default if grpclb (…
- Loading branch information
Showing
9 changed files
with
225 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
core/src/main/java/io/grpc/internal/BaseDnsNameResolverProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /* | ||
| * Copyright 2019 The gRPC Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.grpc.internal; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.google.common.base.Preconditions; | ||
| import com.google.common.base.Stopwatch; | ||
| import io.grpc.InternalServiceProviders; | ||
| import io.grpc.NameResolver; | ||
| import io.grpc.NameResolverProvider; | ||
| import java.net.URI; | ||
|
|
||
| /** | ||
| * Base provider of name resolvers for name agnostic consumption. | ||
| */ | ||
| public abstract class BaseDnsNameResolverProvider extends NameResolverProvider { | ||
|
|
||
| private static final String SCHEME = "dns"; | ||
|
|
||
| @VisibleForTesting | ||
| public static final String ENABLE_GRPCLB_PROPERTY_NAME = | ||
| "io.grpc.internal.DnsNameResolverProvider.enable_grpclb"; | ||
|
|
||
| /** Returns boolean value of system property {@link #ENABLE_GRPCLB_PROPERTY_NAME}. */ | ||
| protected abstract boolean isSrvEnabled(); | ||
|
|
||
| @Override | ||
| public DnsNameResolver newNameResolver(URI targetUri, NameResolver.Args args) { | ||
| if (SCHEME.equals(targetUri.getScheme())) { | ||
| String targetPath = Preconditions.checkNotNull(targetUri.getPath(), "targetPath"); | ||
| Preconditions.checkArgument(targetPath.startsWith("/"), | ||
| "the path component (%s) of the target (%s) must start with '/'", targetPath, targetUri); | ||
| String name = targetPath.substring(1); | ||
| return new DnsNameResolver( | ||
| targetUri.getAuthority(), | ||
| name, | ||
| args, | ||
| GrpcUtil.SHARED_CHANNEL_EXECUTOR, | ||
| Stopwatch.createUnstarted(), | ||
| InternalServiceProviders.isAndroid(getClass().getClassLoader()), | ||
| isSrvEnabled()); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public String getDefaultScheme() { | ||
| return SCHEME; | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean isAvailable() { | ||
| return true; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 61 additions & 0 deletions
61
grpclb/src/main/java/io/grpc/grpclb/SecretGrpclbNameResolverProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| /* | ||
| * Copyright 2019 The gRPC Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.grpc.grpclb; | ||
|
|
||
| import io.grpc.internal.BaseDnsNameResolverProvider; | ||
|
|
||
| /** | ||
| * A provider for {@code io.grpc.internal.DnsNameResolver} for gRPC lb. | ||
| * | ||
| * <p>It resolves a target URI whose scheme is {@code "dns"}. The (optional) authority of the target | ||
| * URI is reserved for the address of alternative DNS server (not implemented yet). The path of the | ||
| * target URI, excluding the leading slash {@code '/'}, is treated as the host name and the optional | ||
| * port to be resolved by DNS. Example target URIs: | ||
| * | ||
| * <ul> | ||
| * <li>{@code "dns:///foo.googleapis.com:8080"} (using default DNS)</li> | ||
| * <li>{@code "dns://8.8.8.8/foo.googleapis.com:8080"} (using alternative DNS (not implemented | ||
| * yet))</li> | ||
| * <li>{@code "dns:///foo.googleapis.com"} (without port)</li> | ||
| * </ul> | ||
| * | ||
| * <p>Note: the main difference between {@code io.grpc.DnsNameResolver} is service record is enabled | ||
| * by default. | ||
| */ | ||
| // Make it package-private so that it cannot be directly referenced by users. Java service loader | ||
| // requires the provider to be public, but we can hide it under a package-private class. | ||
| final class SecretGrpclbNameResolverProvider { | ||
|
|
||
| private SecretGrpclbNameResolverProvider() {} | ||
|
|
||
| public static final class Provider extends BaseDnsNameResolverProvider { | ||
|
|
||
| private static final boolean SRV_ENABLED = | ||
| Boolean.parseBoolean(System.getProperty(ENABLE_GRPCLB_PROPERTY_NAME, "true")); | ||
|
|
||
| @Override | ||
| protected boolean isSrvEnabled() { | ||
| return SRV_ENABLED; | ||
| } | ||
|
|
||
| @Override | ||
| public int priority() { | ||
| // Must be higher than DnsNameResolverProvider#priority. | ||
| return 6; | ||
| } | ||
| } | ||
| } |
1 change: 1 addition & 0 deletions
1
grpclb/src/main/resources/META-INF/services/io.grpc.NameResolverProvider
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| io.grpc.grpclb.SecretGrpclbNameResolverProvider$Provider |
50 changes: 50 additions & 0 deletions
50
grpclb/src/test/java/io/grpc/grpclb/SecretGrpclbNameResolverProviderTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| * Copyright 2019 The gRPC Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.grpc.grpclb; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static io.grpc.internal.BaseDnsNameResolverProvider.ENABLE_GRPCLB_PROPERTY_NAME; | ||
| import static org.junit.Assume.assumeTrue; | ||
|
|
||
| import io.grpc.internal.DnsNameResolverProvider; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| @RunWith(JUnit4.class) | ||
| public class SecretGrpclbNameResolverProviderTest { | ||
|
|
||
| @Test | ||
| public void priority_shouldBeHigherThanDefaultDnsNameResolver() { | ||
| DnsNameResolverProvider defaultDnsNameResolver = new DnsNameResolverProvider(); | ||
| SecretGrpclbNameResolverProvider.Provider grpclbDnsNameResolver = | ||
| new SecretGrpclbNameResolverProvider.Provider(); | ||
|
|
||
| assertThat(defaultDnsNameResolver.priority()) | ||
| .isLessThan(grpclbDnsNameResolver.priority()); | ||
| } | ||
|
|
||
| @Test | ||
| public void isSrvEnabled_trueByDefault() { | ||
| assumeTrue(System.getProperty(ENABLE_GRPCLB_PROPERTY_NAME) == null); | ||
|
|
||
| SecretGrpclbNameResolverProvider.Provider grpclbDnsNameResolver = | ||
| new SecretGrpclbNameResolverProvider.Provider(); | ||
|
|
||
| assertThat(grpclbDnsNameResolver.isSrvEnabled()).isTrue(); | ||
| } | ||
| } |