/* * Copyright 2020 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; import static com.google.common.truth.Truth.assertThat; import static org.junit.Assert.fail; import com.google.common.collect.ImmutableSet; import java.net.InetSocketAddress; import java.net.SocketAddress; import java.net.URI; import java.util.Collection; import java.util.Collections; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; /** Unit tests for {@link ManagedChannelRegistry}. */ @RunWith(JUnit4.class) public class ManagedChannelRegistryTest { private String target = "testing123"; private ChannelCredentials creds = new ChannelCredentials() { @Override public ChannelCredentials withoutBearerTokens() { throw new UnsupportedOperationException(); } }; @Test public void register_unavailableProviderThrows() { ManagedChannelRegistry reg = new ManagedChannelRegistry(); try { reg.register(new BaseProvider(false, 5)); fail("Should throw"); } catch (IllegalArgumentException e) { assertThat(e).hasMessageThat().contains("isAvailable() returned false"); } assertThat(reg.providers()).isEmpty(); } @Test public void deregister() { ManagedChannelRegistry reg = new ManagedChannelRegistry(); ManagedChannelProvider p1 = new BaseProvider(true, 5); ManagedChannelProvider p2 = new BaseProvider(true, 5); ManagedChannelProvider p3 = new BaseProvider(true, 5); reg.register(p1); reg.register(p2); reg.register(p3); assertThat(reg.providers()).containsExactly(p1, p2, p3).inOrder(); reg.deregister(p2); assertThat(reg.providers()).containsExactly(p1, p3).inOrder(); } @Test public void provider_sorted() { ManagedChannelRegistry reg = new ManagedChannelRegistry(); ManagedChannelProvider p1 = new BaseProvider(true, 5); ManagedChannelProvider p2 = new BaseProvider(true, 3); ManagedChannelProvider p3 = new BaseProvider(true, 8); ManagedChannelProvider p4 = new BaseProvider(true, 3); ManagedChannelProvider p5 = new BaseProvider(true, 8); reg.register(p1); reg.register(p2); reg.register(p3); reg.register(p4); reg.register(p5); assertThat(reg.providers()).containsExactly(p3, p5, p1, p2, p4).inOrder(); } @Test public void getProvider_noProvider() { assertThat(new ManagedChannelRegistry().provider()).isNull(); } @Test public void newChannelBuilder_providerReturnsError() { final String errorString = "brisking"; class ErrorProvider extends BaseProvider { ErrorProvider() { super(true, 5); } @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { assertThat(passedTarget).isSameInstanceAs(target); assertThat(passedCreds).isSameInstanceAs(creds); return NewChannelBuilderResult.error(errorString); } } ManagedChannelRegistry registry = new ManagedChannelRegistry(); registry.register(new ErrorProvider()); try { registry.newChannelBuilder(target, creds); fail("expected exception"); } catch (ManagedChannelRegistry.ProviderNotFoundException ex) { assertThat(ex).hasMessageThat().contains(errorString); assertThat(ex).hasMessageThat().contains(ErrorProvider.class.getName()); } } @Test public void newChannelBuilder_providerReturnsNonNull() { ManagedChannelRegistry registry = new ManagedChannelRegistry(); registry.register(new BaseProvider(true, 5) { @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { return NewChannelBuilderResult.error("dodging"); } }); class MockChannelBuilder extends ForwardingChannelBuilder { @Override public ManagedChannelBuilder delegate() { throw new UnsupportedOperationException(); } } final ManagedChannelBuilder mcb = new MockChannelBuilder(); registry.register(new BaseProvider(true, 4) { @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { return NewChannelBuilderResult.channelBuilder(mcb); } }); registry.register(new BaseProvider(true, 3) { @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { fail("Should not be called"); throw new AssertionError(); } }); assertThat(registry.newChannelBuilder(target, creds)).isSameInstanceAs(mcb); } @Test public void newChannelBuilder_noProvider() { ManagedChannelRegistry registry = new ManagedChannelRegistry(); try { registry.newChannelBuilder(target, creds); fail("expected exception"); } catch (ManagedChannelRegistry.ProviderNotFoundException ex) { assertThat(ex).hasMessageThat().contains("No functional channel service provider found"); assertThat(ex).hasMessageThat().contains("grpc-netty"); } } @Test public void newChannelBuilder_usesScheme() { NameResolverRegistry nameResolverRegistry = new NameResolverRegistry(); class SocketAddress1 extends SocketAddress { } class SocketAddress2 extends SocketAddress { } nameResolverRegistry.register(new BaseNameResolverProvider(true, 5, "sc1") { @Override protected Collection> getProducedSocketAddressTypes() { return Collections.singleton(SocketAddress1.class); } }); nameResolverRegistry.register(new BaseNameResolverProvider(true, 6, "sc2") { @Override protected Collection> getProducedSocketAddressTypes() { fail("Should not be called"); throw new AssertionError(); } }); ManagedChannelRegistry registry = new ManagedChannelRegistry(); registry.register(new BaseProvider(true, 5) { @Override protected Collection> getSupportedSocketAddressTypes() { return Collections.singleton(SocketAddress2.class); } @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { fail("Should not be called"); throw new AssertionError(); } }); class MockChannelBuilder extends ForwardingChannelBuilder { @Override public ManagedChannelBuilder delegate() { throw new UnsupportedOperationException(); } } final ManagedChannelBuilder mcb = new MockChannelBuilder(); registry.register(new BaseProvider(true, 4) { @Override protected Collection> getSupportedSocketAddressTypes() { return Collections.singleton(SocketAddress1.class); } @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { return NewChannelBuilderResult.channelBuilder(mcb); } }); assertThat( registry.newChannelBuilder(nameResolverRegistry, "sc1:" + target, creds)).isSameInstanceAs( mcb); } @Test public void newChannelBuilder_unsupportedSocketAddressTypes() { NameResolverRegistry nameResolverRegistry = new NameResolverRegistry(); class SocketAddress1 extends SocketAddress { } class SocketAddress2 extends SocketAddress { } nameResolverRegistry.register(new BaseNameResolverProvider(true, 5, "sc1") { @Override protected Collection> getProducedSocketAddressTypes() { return ImmutableSet.of(SocketAddress1.class, SocketAddress2.class); } }); ManagedChannelRegistry registry = new ManagedChannelRegistry(); registry.register(new BaseProvider(true, 5) { @Override protected Collection> getSupportedSocketAddressTypes() { return Collections.singleton(SocketAddress2.class); } @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { fail("Should not be called"); throw new AssertionError(); } }); registry.register(new BaseProvider(true, 4) { @Override protected Collection> getSupportedSocketAddressTypes() { return Collections.singleton(SocketAddress1.class); } @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { fail("Should not be called"); throw new AssertionError(); } }); try { registry.newChannelBuilder(nameResolverRegistry, "sc1:" + target, creds); fail("expected exception"); } catch (ManagedChannelRegistry.ProviderNotFoundException ex) { assertThat(ex).hasMessageThat().contains("does not support 1 or more of"); assertThat(ex).hasMessageThat().contains("SocketAddress1"); assertThat(ex).hasMessageThat().contains("SocketAddress2"); } } @Test public void newChannelBuilder_emptySet_asDefault() { NameResolverRegistry nameResolverRegistry = new NameResolverRegistry(); ManagedChannelRegistry registry = new ManagedChannelRegistry(); class MockChannelBuilder extends ForwardingChannelBuilder { @Override public ManagedChannelBuilder delegate() { throw new UnsupportedOperationException(); } } final ManagedChannelBuilder mcb = new MockChannelBuilder(); registry.register(new BaseProvider(true, 4) { @Override protected Collection> getSupportedSocketAddressTypes() { return Collections.emptySet(); } @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { return NewChannelBuilderResult.channelBuilder(mcb); } }); assertThat( registry.newChannelBuilder(nameResolverRegistry, "sc1:" + target, creds)).isSameInstanceAs( mcb); } @Test public void newChannelBuilder_noSchemeUsesDefaultScheme() { NameResolverRegistry nameResolverRegistry = new NameResolverRegistry(); class SocketAddress1 extends SocketAddress { } nameResolverRegistry.register(new BaseNameResolverProvider(true, 5, "sc1") { @Override protected Collection> getProducedSocketAddressTypes() { return Collections.singleton(SocketAddress1.class); } }); ManagedChannelRegistry registry = new ManagedChannelRegistry(); class MockChannelBuilder extends ForwardingChannelBuilder { @Override public ManagedChannelBuilder delegate() { throw new UnsupportedOperationException(); } } final ManagedChannelBuilder mcb = new MockChannelBuilder(); registry.register(new BaseProvider(true, 4) { @Override protected Collection> getSupportedSocketAddressTypes() { return Collections.singleton(SocketAddress1.class); } @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { return NewChannelBuilderResult.channelBuilder(mcb); } }); assertThat(registry.newChannelBuilder(nameResolverRegistry, target, creds)).isSameInstanceAs( mcb); } @Test public void newChannelBuilder_badUri() { NameResolverRegistry nameResolverRegistry = new NameResolverRegistry(); class SocketAddress1 extends SocketAddress { } ManagedChannelRegistry registry = new ManagedChannelRegistry(); class MockChannelBuilder extends ForwardingChannelBuilder { @Override public ManagedChannelBuilder delegate() { throw new UnsupportedOperationException(); } } final ManagedChannelBuilder mcb = new MockChannelBuilder(); registry.register(new BaseProvider(true, 4) { @Override protected Collection> getSupportedSocketAddressTypes() { return Collections.singleton(SocketAddress1.class); } @Override public NewChannelBuilderResult newChannelBuilder( String passedTarget, ChannelCredentials passedCreds) { return NewChannelBuilderResult.channelBuilder(mcb); } }); assertThat( registry.newChannelBuilder(nameResolverRegistry, ":testing123", creds)).isSameInstanceAs( mcb); } private static class BaseNameResolverProvider extends NameResolverProvider { private final boolean isAvailable; private final int priority; private final String defaultScheme; public BaseNameResolverProvider(boolean isAvailable, int priority, String defaultScheme) { this.isAvailable = isAvailable; this.priority = priority; this.defaultScheme = defaultScheme; } @Override public NameResolver newNameResolver(URI targetUri, NameResolver.Args args) { return null; } @Override public String getDefaultScheme() { return defaultScheme; } @Override protected boolean isAvailable() { return isAvailable; } @Override protected int priority() { return priority; } } private static class BaseProvider extends ManagedChannelProvider { private final boolean isAvailable; private final int priority; public BaseProvider(boolean isAvailable, int priority) { this.isAvailable = isAvailable; this.priority = priority; } @Override protected boolean isAvailable() { return isAvailable; } @Override protected int priority() { return priority; } @Override protected ManagedChannelBuilder builderForAddress(String name, int port) { throw new UnsupportedOperationException(); } @Override protected ManagedChannelBuilder builderForTarget(String target) { throw new UnsupportedOperationException(); } @Override protected Collection> getSupportedSocketAddressTypes() { return Collections.singleton(InetSocketAddress.class); } } }