ClientXdsClientV3Test.java

/*
 * 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.xds;

import static com.google.common.truth.Truth.assertThat;
import static org.mockito.ArgumentMatchers.argThat;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;

import com.google.common.collect.ImmutableList;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.Any;
import com.google.protobuf.Message;
import com.google.protobuf.UInt32Value;
import com.google.protobuf.UInt64Value;
import com.google.protobuf.util.Durations;
import com.google.rpc.Code;
import io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers;
import io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers.Thresholds;
import io.envoyproxy.envoy.config.cluster.v3.Cluster;
import io.envoyproxy.envoy.config.cluster.v3.Cluster.CustomClusterType;
import io.envoyproxy.envoy.config.cluster.v3.Cluster.DiscoveryType;
import io.envoyproxy.envoy.config.cluster.v3.Cluster.EdsClusterConfig;
import io.envoyproxy.envoy.config.cluster.v3.Cluster.LbPolicy;
import io.envoyproxy.envoy.config.cluster.v3.Cluster.LeastRequestLbConfig;
import io.envoyproxy.envoy.config.cluster.v3.Cluster.RingHashLbConfig;
import io.envoyproxy.envoy.config.cluster.v3.Cluster.RingHashLbConfig.HashFunction;
import io.envoyproxy.envoy.config.core.v3.Address;
import io.envoyproxy.envoy.config.core.v3.AggregatedConfigSource;
import io.envoyproxy.envoy.config.core.v3.ConfigSource;
import io.envoyproxy.envoy.config.core.v3.HealthStatus;
import io.envoyproxy.envoy.config.core.v3.Locality;
import io.envoyproxy.envoy.config.core.v3.Node;
import io.envoyproxy.envoy.config.core.v3.RoutingPriority;
import io.envoyproxy.envoy.config.core.v3.SelfConfigSource;
import io.envoyproxy.envoy.config.core.v3.SocketAddress;
import io.envoyproxy.envoy.config.core.v3.TrafficDirection;
import io.envoyproxy.envoy.config.core.v3.TransportSocket;
import io.envoyproxy.envoy.config.endpoint.v3.ClusterLoadAssignment;
import io.envoyproxy.envoy.config.endpoint.v3.ClusterLoadAssignment.Policy;
import io.envoyproxy.envoy.config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload;
import io.envoyproxy.envoy.config.endpoint.v3.ClusterStats;
import io.envoyproxy.envoy.config.endpoint.v3.Endpoint;
import io.envoyproxy.envoy.config.endpoint.v3.LbEndpoint;
import io.envoyproxy.envoy.config.endpoint.v3.LocalityLbEndpoints;
import io.envoyproxy.envoy.config.listener.v3.ApiListener;
import io.envoyproxy.envoy.config.listener.v3.Filter;
import io.envoyproxy.envoy.config.listener.v3.FilterChain;
import io.envoyproxy.envoy.config.listener.v3.FilterChainMatch;
import io.envoyproxy.envoy.config.listener.v3.Listener;
import io.envoyproxy.envoy.config.route.v3.Route;
import io.envoyproxy.envoy.config.route.v3.RouteAction;
import io.envoyproxy.envoy.config.route.v3.RouteConfiguration;
import io.envoyproxy.envoy.config.route.v3.RouteMatch;
import io.envoyproxy.envoy.config.route.v3.VirtualHost;
import io.envoyproxy.envoy.extensions.clusters.aggregate.v3.ClusterConfig;
import io.envoyproxy.envoy.extensions.filters.common.fault.v3.FaultDelay;
import io.envoyproxy.envoy.extensions.filters.common.fault.v3.FaultDelay.HeaderDelay;
import io.envoyproxy.envoy.extensions.filters.http.fault.v3.FaultAbort;
import io.envoyproxy.envoy.extensions.filters.http.fault.v3.FaultAbort.HeaderAbort;
import io.envoyproxy.envoy.extensions.filters.http.fault.v3.HTTPFault;
import io.envoyproxy.envoy.extensions.filters.http.router.v3.Router;
import io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager;
import io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter;
import io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.Rds;
import io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.CertificateProviderPluginInstance;
import io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.CertificateValidationContext;
import io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.CommonTlsContext;
import io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext;
import io.envoyproxy.envoy.service.discovery.v3.AggregatedDiscoveryServiceGrpc.AggregatedDiscoveryServiceImplBase;
import io.envoyproxy.envoy.service.discovery.v3.DiscoveryRequest;
import io.envoyproxy.envoy.service.discovery.v3.DiscoveryResponse;
import io.envoyproxy.envoy.service.discovery.v3.Resource;
import io.envoyproxy.envoy.service.load_stats.v3.LoadReportingServiceGrpc.LoadReportingServiceImplBase;
import io.envoyproxy.envoy.service.load_stats.v3.LoadStatsRequest;
import io.envoyproxy.envoy.service.load_stats.v3.LoadStatsResponse;
import io.envoyproxy.envoy.type.matcher.v3.RegexMatcher;
import io.envoyproxy.envoy.type.v3.FractionalPercent;
import io.envoyproxy.envoy.type.v3.FractionalPercent.DenominatorType;
import io.grpc.BindableService;
import io.grpc.Context;
import io.grpc.Context.CancellationListener;
import io.grpc.Status;
import io.grpc.stub.StreamObserver;
import io.grpc.xds.AbstractXdsClient.ResourceType;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nullable;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.ArgumentMatcher;
import org.mockito.InOrder;

/**
 * Tests for {@link ClientXdsClient} with protocol version v3.
 */
@RunWith(JUnit4.class)
public class ClientXdsClientV3Test extends ClientXdsClientTestBase {

  @Override
  protected BindableService createAdsService() {
    return new AggregatedDiscoveryServiceImplBase() {
      @Override
      public StreamObserver<DiscoveryRequest> streamAggregatedResources(
          final StreamObserver<DiscoveryResponse> responseObserver) {
        assertThat(adsEnded.get()).isTrue();  // ensure previous call was ended
        adsEnded.set(false);
        @SuppressWarnings("unchecked")
        StreamObserver<DiscoveryRequest> requestObserver = mock(StreamObserver.class);
        DiscoveryRpcCall call = new DiscoveryRpcCallV3(requestObserver, responseObserver);
        resourceDiscoveryCalls.offer(call);
        Context.current().addListener(
            new CancellationListener() {
              @Override
              public void cancelled(Context context) {
                adsEnded.set(true);
              }
            }, MoreExecutors.directExecutor());
        return requestObserver;
      }
    };
  }

  @Override
  protected BindableService createLrsService() {
    return new LoadReportingServiceImplBase() {
      @Override
      public StreamObserver<LoadStatsRequest> streamLoadStats(
          StreamObserver<LoadStatsResponse> responseObserver) {
        assertThat(lrsEnded.get()).isTrue();
        lrsEnded.set(false);
        @SuppressWarnings("unchecked")
        StreamObserver<LoadStatsRequest> requestObserver = mock(StreamObserver.class);
        LrsRpcCall call = new LrsRpcCallV3(requestObserver, responseObserver);
        Context.current().addListener(
            new CancellationListener() {
              @Override
              public void cancelled(Context context) {
                lrsEnded.set(true);
              }
            }, MoreExecutors.directExecutor());
        loadReportCalls.offer(call);
        return requestObserver;
      }
    };
  }

  @Override
  protected MessageFactory createMessageFactory() {
    return new MessageFactoryV3();
  }

  @Override
  protected boolean useProtocolV3() {
    return true;
  }

  private static class DiscoveryRpcCallV3 extends DiscoveryRpcCall {
    StreamObserver<DiscoveryRequest> requestObserver;
    StreamObserver<DiscoveryResponse> responseObserver;

    private DiscoveryRpcCallV3(StreamObserver<DiscoveryRequest> requestObserver,
        StreamObserver<DiscoveryResponse> responseObserver) {
      this.requestObserver = requestObserver;
      this.responseObserver = responseObserver;
    }

    @Override
    protected void verifyRequest(
        ResourceType type, List<String> resources, String versionInfo, String nonce,
        EnvoyProtoData.Node node) {
      verify(requestObserver).onNext(argThat(new DiscoveryRequestMatcher(
          node.toEnvoyProtoNode(), versionInfo, resources, type.typeUrl(), nonce, null, null)));
    }

    @Override
    protected void verifyRequestNack(
        ResourceType type, List<String> resources, String versionInfo, String nonce,
        EnvoyProtoData.Node node, List<String> errorMessages) {
      verify(requestObserver).onNext(argThat(new DiscoveryRequestMatcher(
          node.toEnvoyProtoNode(), versionInfo, resources, type.typeUrl(), nonce,
          Code.INVALID_ARGUMENT_VALUE, errorMessages)));
    }

    @Override
    protected void verifyNoMoreRequest() {
      verifyNoMoreInteractions(requestObserver);
    }

    @Override
    protected void sendResponse(
        ResourceType type, List<Any> resources, String versionInfo, String nonce) {
      DiscoveryResponse response =
          DiscoveryResponse.newBuilder()
              .setVersionInfo(versionInfo)
              .addAllResources(resources)
              .setTypeUrl(type.typeUrl())
              .setNonce(nonce)
              .build();
      responseObserver.onNext(response);
    }

    @Override
    protected void sendError(Throwable t) {
      responseObserver.onError(t);
    }

    @Override
    protected void sendCompleted() {
      responseObserver.onCompleted();
    }
  }

  private static class LrsRpcCallV3 extends LrsRpcCall {
    private final StreamObserver<LoadStatsRequest> requestObserver;
    private final StreamObserver<LoadStatsResponse> responseObserver;
    private final InOrder inOrder;

    private LrsRpcCallV3(StreamObserver<LoadStatsRequest> requestObserver,
        StreamObserver<LoadStatsResponse> responseObserver) {
      this.requestObserver = requestObserver;
      this.responseObserver = responseObserver;
      inOrder = inOrder(requestObserver);
    }

    @Override
    protected void verifyNextReportClusters(List<String[]> clusters) {
      inOrder.verify(requestObserver).onNext(argThat(new LrsRequestMatcher(clusters)));
    }

    @Override
    protected void sendResponse(List<String> clusters, long loadReportIntervalNano) {
      LoadStatsResponse response =
          LoadStatsResponse.newBuilder()
              .addAllClusters(clusters)
              .setLoadReportingInterval(Durations.fromNanos(loadReportIntervalNano))
              .build();
      responseObserver.onNext(response);
    }
  }

  private static class MessageFactoryV3 extends MessageFactory {

    @Override
    protected Any buildWrappedResource(Any originalResource) {
      return Any.pack(Resource.newBuilder()
          .setResource(originalResource)
          .build());
    }

    @SuppressWarnings("unchecked")
    @Override
    protected Message buildListenerWithApiListener(
        String name, Message routeConfiguration, List<? extends Message> httpFilters) {
      return Listener.newBuilder()
          .setName(name)
          .setAddress(Address.getDefaultInstance())
          .addFilterChains(FilterChain.getDefaultInstance())
          .setApiListener(
              ApiListener.newBuilder().setApiListener(Any.pack(
                  HttpConnectionManager.newBuilder()
                      .setRouteConfig((RouteConfiguration) routeConfiguration)
                      .addAllHttpFilters((List<HttpFilter>) httpFilters)
                      .build())))
          .build();
    }

    @Override
    protected Message buildListenerWithApiListener(String name, Message routeConfiguration) {
      return buildListenerWithApiListener(name, routeConfiguration, Arrays.asList(
              HttpFilter.newBuilder()
                      .setName("terminal")
                      .setTypedConfig(Any.pack(Router.newBuilder().build())).build()
      ));
    }

    @Override
    protected Message buildListenerWithApiListenerForRds(String name, String rdsResourceName) {
      return Listener.newBuilder()
          .setName(name)
          .setAddress(Address.getDefaultInstance())
          .addFilterChains(FilterChain.getDefaultInstance())
          .setApiListener(
              ApiListener.newBuilder().setApiListener(Any.pack(
                  HttpConnectionManager.newBuilder()
                      .setRds(
                          Rds.newBuilder()
                              .setRouteConfigName(rdsResourceName)
                              .setConfigSource(
                                  ConfigSource.newBuilder()
                                      .setAds(AggregatedConfigSource.getDefaultInstance())))
                      .addHttpFilters(
                          HttpFilter.newBuilder()
                               .setName("terminal")
                               .setTypedConfig(Any.pack(Router.newBuilder().build())))
                      .build())))
          .build();
    }

    @Override
    protected Message buildListenerWithApiListenerInvalid(String name) {
      return Listener.newBuilder()
          .setName(name)
          .setAddress(Address.getDefaultInstance())
          .setApiListener(ApiListener.newBuilder().setApiListener(FAILING_ANY))
          .build();
    }

    @Override
    protected Message buildHttpFilter(String name, @Nullable Any typedConfig, boolean isOptional) {
      HttpFilter.Builder builder = HttpFilter.newBuilder().setName(name).setIsOptional(isOptional);
      if (typedConfig != null) {
        builder.setTypedConfig(typedConfig);
      }
      return builder.build();
    }

    @Override
    protected Any buildHttpFaultTypedConfig(
        @Nullable Long delayNanos, @Nullable Integer delayRate, String upstreamCluster,
        List<String> downstreamNodes, @Nullable Integer maxActiveFaults, @Nullable Status status,
        @Nullable Integer httpCode, @Nullable Integer abortRate) {
      HTTPFault.Builder builder = HTTPFault.newBuilder();
      if (delayRate != null) {
        FaultDelay.Builder delayBuilder = FaultDelay.newBuilder();
        delayBuilder.setPercentage(
            FractionalPercent.newBuilder()
                .setNumerator(delayRate).setDenominator(DenominatorType.MILLION));
        if (delayNanos != null) {
          delayBuilder.setFixedDelay(Durations.fromNanos(delayNanos));
        } else {
          delayBuilder.setHeaderDelay(HeaderDelay.newBuilder());
        }
        builder.setDelay(delayBuilder);
      }
      if (abortRate != null) {
        FaultAbort.Builder abortBuilder = FaultAbort.newBuilder();
        abortBuilder.setPercentage(
            FractionalPercent.newBuilder()
                .setNumerator(abortRate).setDenominator(DenominatorType.MILLION));
        if (status != null) {
          abortBuilder.setGrpcStatus(status.getCode().value());
        } else if (httpCode != null) {
          abortBuilder.setHttpStatus(httpCode);
        } else {
          abortBuilder.setHeaderAbort(HeaderAbort.newBuilder());
        }
        builder.setAbort(abortBuilder);
      }
      builder.setUpstreamCluster(upstreamCluster);
      builder.addAllDownstreamNodes(downstreamNodes);
      if (maxActiveFaults != null) {
        builder.setMaxActiveFaults(UInt32Value.of(maxActiveFaults));
      }
      return Any.pack(builder.build());
    }

    @Override
    protected Message buildRouteConfiguration(String name, List<Message> virtualHostList) {
      RouteConfiguration.Builder builder = RouteConfiguration.newBuilder();
      builder.setName(name);
      for (Message virtualHost : virtualHostList) {
        builder.addVirtualHosts((VirtualHost) virtualHost);
      }
      return builder.build();
    }

    @Override
    protected Message buildRouteConfigurationInvalid(String name) {
      // Invalid Path matcher: Pattern.compile() will throw PatternSyntaxException
      // when attempting to process SAFE_REGEX RouteMatch malformed safe regex pattern.
      // I wish there was a simpler way.
      return RouteConfiguration.newBuilder()
          .setName(name)
          .addVirtualHosts(
              VirtualHost.newBuilder()
                  .setName("do not care")
                  .addDomains("do not care")
                  .addRoutes(
                      Route.newBuilder()
                          .setRoute(RouteAction.newBuilder().setCluster("do not care"))
                          .setMatch(RouteMatch.newBuilder()
                              .setSafeRegex(RegexMatcher.newBuilder().setRegex("[z-a]")))))
          .build();
    }

    @Override
    protected List<Message> buildOpaqueVirtualHosts(int num) {
      List<Message> virtualHosts = new ArrayList<>(num);
      for (int i = 0; i < num; i++) {
        VirtualHost virtualHost =
            VirtualHost.newBuilder()
                .setName(num + ": do not care")
                .addDomains("do not care")
                .addRoutes(
                    Route.newBuilder()
                        .setRoute(RouteAction.newBuilder().setCluster("do not care"))
                        .setMatch(RouteMatch.newBuilder().setPrefix("do not care")))
                .build();
        virtualHosts.add(virtualHost);
      }
      return virtualHosts;
    }

    @SuppressWarnings("unchecked")
    @Override
    protected Message buildVirtualHost(
        List<? extends Message> routes, Map<String, Any> typedConfigMap) {
      return VirtualHost.newBuilder()
          .setName("do not care")
          .addDomains("do not care")
          .addAllRoutes((List<Route>) routes)
          .putAllTypedPerFilterConfig(typedConfigMap)
          .build();
    }

    @Override
    protected List<? extends Message> buildOpaqueRoutes(int num) {
      List<Route> routes = new ArrayList<>(num);
      for (int i = 0; i < num; i++) {
        Route route =
            Route.newBuilder()
                .setRoute(RouteAction.newBuilder().setCluster("do not care"))
                .setMatch(RouteMatch.newBuilder().setPrefix("do not care"))
                .build();
        routes.add(route);
      }
      return routes;
    }

    @Override
    protected Message buildClusterInvalid(String name) {
      // Unspecified cluster discovery type
      return Cluster.newBuilder().setName(name).build();
    }

    @Override
    protected Message buildEdsCluster(String clusterName, @Nullable String edsServiceName,
        String lbPolicy, @Nullable Message ringHashLbConfig,
        @Nullable Message leastRequestLbConfig, boolean enableLrs,
        @Nullable Message upstreamTlsContext, String transportSocketName,
        @Nullable Message circuitBreakers) {
      Cluster.Builder builder = initClusterBuilder(
          clusterName, lbPolicy, ringHashLbConfig, leastRequestLbConfig,
          enableLrs, upstreamTlsContext, transportSocketName, circuitBreakers);
      builder.setType(DiscoveryType.EDS);
      EdsClusterConfig.Builder edsClusterConfigBuilder = EdsClusterConfig.newBuilder();
      edsClusterConfigBuilder.setEdsConfig(
          ConfigSource.newBuilder().setAds(AggregatedConfigSource.getDefaultInstance()));  // ADS
      if (edsServiceName != null) {
        edsClusterConfigBuilder.setServiceName(edsServiceName);
      }
      builder.setEdsClusterConfig(edsClusterConfigBuilder);
      return builder.build();
    }

    @Override
    protected Message buildLogicalDnsCluster(String clusterName, String dnsHostAddr,
        int dnsHostPort, String lbPolicy, @Nullable Message ringHashLbConfig,
        @Nullable Message leastRequestLbConfig, boolean enableLrs,
        @Nullable Message upstreamTlsContext, @Nullable Message circuitBreakers) {
      Cluster.Builder builder = initClusterBuilder(
          clusterName, lbPolicy, ringHashLbConfig, leastRequestLbConfig,
          enableLrs, upstreamTlsContext, "envoy.transport_sockets.tls", circuitBreakers);
      builder.setType(DiscoveryType.LOGICAL_DNS);
      builder.setLoadAssignment(
          ClusterLoadAssignment.newBuilder().addEndpoints(
              LocalityLbEndpoints.newBuilder().addLbEndpoints(
                  LbEndpoint.newBuilder().setEndpoint(
                      Endpoint.newBuilder().setAddress(
                          Address.newBuilder().setSocketAddress(
                              SocketAddress.newBuilder()
                                  .setAddress(dnsHostAddr).setPortValue(dnsHostPort)))))).build());
      return builder.build();
    }

    @Override
    protected Message buildAggregateCluster(String clusterName, String lbPolicy,
        @Nullable Message ringHashLbConfig, @Nullable Message leastRequestLbConfig,
        List<String> clusters) {
      ClusterConfig clusterConfig = ClusterConfig.newBuilder().addAllClusters(clusters).build();
      CustomClusterType type =
          CustomClusterType.newBuilder()
              .setName(ClientXdsClient.AGGREGATE_CLUSTER_TYPE_NAME)
              .setTypedConfig(Any.pack(clusterConfig))
              .build();
      Cluster.Builder builder = Cluster.newBuilder().setName(clusterName).setClusterType(type);
      if (lbPolicy.equals("round_robin")) {
        builder.setLbPolicy(LbPolicy.ROUND_ROBIN);
      } else if (lbPolicy.equals("ring_hash_experimental")) {
        builder.setLbPolicy(LbPolicy.RING_HASH);
        builder.setRingHashLbConfig((RingHashLbConfig) ringHashLbConfig);
      } else if (lbPolicy.equals("least_request_experimental")) {
        builder.setLbPolicy(LbPolicy.LEAST_REQUEST);
        builder.setLeastRequestLbConfig((LeastRequestLbConfig) leastRequestLbConfig);
      } else {
        throw new AssertionError("Invalid LB policy");
      }
      return builder.build();
    }

    private Cluster.Builder initClusterBuilder(String clusterName, String lbPolicy,
        @Nullable Message ringHashLbConfig, @Nullable Message leastRequestLbConfig,
        boolean enableLrs, @Nullable Message upstreamTlsContext, String transportSocketName,
        @Nullable Message circuitBreakers) {
      Cluster.Builder builder = Cluster.newBuilder();
      builder.setName(clusterName);
      if (lbPolicy.equals("round_robin")) {
        builder.setLbPolicy(LbPolicy.ROUND_ROBIN);
      } else if (lbPolicy.equals("ring_hash_experimental")) {
        builder.setLbPolicy(LbPolicy.RING_HASH);
        builder.setRingHashLbConfig((RingHashLbConfig) ringHashLbConfig);
      } else if (lbPolicy.equals("least_request_experimental")) {
        builder.setLbPolicy(LbPolicy.LEAST_REQUEST);
        builder.setLeastRequestLbConfig((LeastRequestLbConfig) leastRequestLbConfig);
      } else {
        throw new AssertionError("Invalid LB policy");
      }
      if (enableLrs) {
        builder.setLrsServer(
            ConfigSource.newBuilder()
                .setSelf(SelfConfigSource.getDefaultInstance()));
      }
      if (upstreamTlsContext != null) {
        builder.setTransportSocket(
            TransportSocket.newBuilder()
                .setName(transportSocketName)
                .setTypedConfig(Any.pack(upstreamTlsContext)));
      }
      if (circuitBreakers != null) {
        builder.setCircuitBreakers((CircuitBreakers) circuitBreakers);
      }
      return builder;
    }

    @Override
    protected Message buildRingHashLbConfig(String hashFunction, long minRingSize,
        long maxRingSize) {
      RingHashLbConfig.Builder builder = RingHashLbConfig.newBuilder();
      if (hashFunction.equals("xx_hash")) {
        builder.setHashFunction(HashFunction.XX_HASH);
      } else if (hashFunction.equals("murmur_hash_2")) {
        builder.setHashFunction(HashFunction.MURMUR_HASH_2);
      } else {
        throw new AssertionError("Invalid hash function");
      }
      builder.setMinimumRingSize(UInt64Value.newBuilder().setValue(minRingSize).build());
      builder.setMaximumRingSize(UInt64Value.newBuilder().setValue(maxRingSize).build());
      return builder.build();
    }

    @Override
    protected Message buildLeastRequestLbConfig(int choiceCount) {
      LeastRequestLbConfig.Builder builder = LeastRequestLbConfig.newBuilder();
      builder.setChoiceCount(UInt32Value.newBuilder().setValue(choiceCount));
      return builder.build();
    }

    @Override
    @SuppressWarnings("deprecation")
    protected Message buildUpstreamTlsContext(String instanceName, String certName) {
      CommonTlsContext.Builder commonTlsContextBuilder = CommonTlsContext.newBuilder();
      if (instanceName != null && certName != null) {
        CommonTlsContext.CertificateProviderInstance providerInstance =
            CommonTlsContext.CertificateProviderInstance.newBuilder()
                .setInstanceName(instanceName)
                .setCertificateName(certName)
                .build();
        CommonTlsContext.CombinedCertificateValidationContext combined =
            CommonTlsContext.CombinedCertificateValidationContext.newBuilder()
                .setValidationContextCertificateProviderInstance(providerInstance)
                .build();
        commonTlsContextBuilder.setCombinedValidationContext(combined);
      }
      return UpstreamTlsContext.newBuilder()
          .setCommonTlsContext(commonTlsContextBuilder)
          .build();
    }

    @Override
    protected Message buildNewUpstreamTlsContext(String instanceName, String certName) {
      CommonTlsContext.Builder commonTlsContextBuilder = CommonTlsContext.newBuilder();
      if (instanceName != null && certName != null) {
        commonTlsContextBuilder.setValidationContext(CertificateValidationContext.newBuilder()
            .setCaCertificateProviderInstance(
                CertificateProviderPluginInstance.newBuilder().setInstanceName(instanceName)
                    .setCertificateName(certName).build()));
      }
      return UpstreamTlsContext.newBuilder()
          .setCommonTlsContext(commonTlsContextBuilder)
          .build();
    }

    @Override
    protected Message buildCircuitBreakers(int highPriorityMaxRequests,
        int defaultPriorityMaxRequests) {
      return CircuitBreakers.newBuilder()
          .addThresholds(
              Thresholds.newBuilder()
                  .setPriority(RoutingPriority.HIGH)
                  .setMaxRequests(UInt32Value.newBuilder().setValue(highPriorityMaxRequests)))
          .addThresholds(
              Thresholds.newBuilder()
                  .setPriority(RoutingPriority.DEFAULT)
                  .setMaxRequests(UInt32Value.newBuilder().setValue(defaultPriorityMaxRequests)))
          .build();
    }

    @Override
    protected Message buildClusterLoadAssignment(String cluster,
        List<Message> localityLbEndpointsList, List<Message> dropOverloadList) {
      ClusterLoadAssignment.Builder builder = ClusterLoadAssignment.newBuilder();
      builder.setClusterName(cluster);
      for (Message localityLbEndpoints : localityLbEndpointsList) {
        builder.addEndpoints((LocalityLbEndpoints) localityLbEndpoints);
      }
      Policy.Builder policyBuilder = Policy.newBuilder();
      for (Message dropOverload : dropOverloadList) {
        policyBuilder.addDropOverloads((DropOverload) dropOverload);
      }
      builder.setPolicy(policyBuilder);
      return builder.build();
    }

    @Override
    protected Message buildClusterLoadAssignmentInvalid(String cluster) {
      // Negative priority LocalityLbEndpoint.
      return ClusterLoadAssignment.newBuilder()
          .setClusterName(cluster)
          .addEndpoints(LocalityLbEndpoints.newBuilder()
              .setPriority(-1)
              .setLoadBalancingWeight(UInt32Value.newBuilder().setValue(1)))
          .build();
    }

    @Override
    protected Message buildLocalityLbEndpoints(String region, String zone, String subZone,
        List<Message> lbEndpointList, int loadBalancingWeight, int priority) {
      LocalityLbEndpoints.Builder builder = LocalityLbEndpoints.newBuilder();
      builder.setLocality(
          Locality.newBuilder().setRegion(region).setZone(zone).setSubZone(subZone));
      for (Message lbEndpoint : lbEndpointList) {
        builder.addLbEndpoints((LbEndpoint) lbEndpoint);
      }
      builder.setLoadBalancingWeight(UInt32Value.of(loadBalancingWeight));
      builder.setPriority(priority);
      return builder.build();
    }

    @Override
    protected Message buildLbEndpoint(String address, int port, String healthStatus,
        int lbWeight) {
      HealthStatus status;
      switch (healthStatus) {
        case "unknown":
          status = HealthStatus.UNKNOWN;
          break;
        case "healthy":
          status = HealthStatus.HEALTHY;
          break;
        case "unhealthy":
          status = HealthStatus.UNHEALTHY;
          break;
        case "draining":
          status = HealthStatus.DRAINING;
          break;
        case "timeout":
          status = HealthStatus.TIMEOUT;
          break;
        case "degraded":
          status = HealthStatus.DEGRADED;
          break;
        default:
          status = HealthStatus.UNRECOGNIZED;
      }
      return LbEndpoint.newBuilder()
          .setEndpoint(
              Endpoint.newBuilder().setAddress(
                  Address.newBuilder().setSocketAddress(
                      SocketAddress.newBuilder().setAddress(address).setPortValue(port))))
          .setHealthStatus(status)
          .setLoadBalancingWeight(UInt32Value.of(lbWeight))
          .build();
    }

    @Override
    protected Message buildDropOverload(String category, int dropPerMillion) {
      return DropOverload.newBuilder()
          .setCategory(category)
          .setDropPercentage(
              FractionalPercent.newBuilder()
                  .setNumerator(dropPerMillion)
                  .setDenominator(DenominatorType.MILLION))
          .build();
    }

    @SuppressWarnings("deprecation")
    @Override
    protected FilterChain buildFilterChain(
        List<String> alpn, Message tlsContext, String transportSocketName,
        Message... filters) {
      FilterChainMatch filterChainMatch =
          FilterChainMatch.newBuilder().addAllApplicationProtocols(alpn).build();
      Filter[] filterArray = new Filter[filters.length];
      for (int i = 0; i < filters.length; i++) {
        filterArray[i] = (Filter) filters[i];
      }
      return FilterChain.newBuilder()
          .setFilterChainMatch(filterChainMatch)
          .setTransportSocket(
              tlsContext == null
                  ? TransportSocket.getDefaultInstance()
                  : TransportSocket.newBuilder()
                      .setName(transportSocketName)
                      .setTypedConfig(Any.pack(tlsContext))
                      .build())
          .addAllFilters(Arrays.asList(filterArray))
          .build();
    }

    @Override
    protected Listener buildListenerWithFilterChain(
        String name, int portValue, String address, Message... filterChains) {
      io.envoyproxy.envoy.config.core.v3.Address listenerAddress =
          io.envoyproxy.envoy.config.core.v3.Address.newBuilder()
              .setSocketAddress(
                  SocketAddress.newBuilder().setPortValue(portValue).setAddress(address))
              .build();
      FilterChain[] filterChainsArray = new FilterChain[filterChains.length];
      for (int i = 0; i < filterChains.length; i++) {
        filterChainsArray[i] = (FilterChain) filterChains[i];
      }
      return Listener.newBuilder()
          .setName(name)
          .setAddress(listenerAddress)
          .addAllFilterChains(Arrays.asList(filterChainsArray))
          .setTrafficDirection(TrafficDirection.INBOUND)
          .build();
    }

    @Override
    protected Message buildHttpConnectionManagerFilter(
        @Nullable String rdsName, @Nullable Message routeConfig, List<Message> httpFilters) {
      HttpConnectionManager.Builder hcmBuilder = HttpConnectionManager.newBuilder();
      if (rdsName != null) {
        hcmBuilder.setRds(
            Rds.newBuilder()
                .setRouteConfigName(rdsName)
                .setConfigSource(
                    ConfigSource.newBuilder()
                        .setAds(AggregatedConfigSource.getDefaultInstance())));
      }
      if (routeConfig != null) {
        hcmBuilder.setRouteConfig((RouteConfiguration) routeConfig);
      }
      for (Message httpFilter : httpFilters) {
        hcmBuilder.addHttpFilters((HttpFilter) httpFilter);
      }
      return Filter.newBuilder()
          .setName("envoy.http_connection_manager")
          .setTypedConfig(
              Any.pack(hcmBuilder.build(), "type.googleapis.com"))
          .build();
    }

    @Override
    protected Message buildTerminalFilter() {
      return HttpFilter.newBuilder()
          .setName("terminal")
          .setTypedConfig(Any.pack(Router.newBuilder().build())).build();
    }
  }

  /**
   * Matches a {@link DiscoveryRequest} with the same node metadata, versionInfo, typeUrl,
   * response nonce and collection of resource names regardless of order.
   */
  private static class DiscoveryRequestMatcher implements ArgumentMatcher<DiscoveryRequest> {
    private final Node node;
    private final String versionInfo;
    private final String typeUrl;
    private final Set<String> resources;
    private final String responseNonce;
    @Nullable private final Integer errorCode;
    private final List<String> errorMessages;

    private DiscoveryRequestMatcher(
        Node node, String versionInfo, List<String> resources,
        String typeUrl, String responseNonce, @Nullable Integer errorCode,
        @Nullable List<String> errorMessages) {
      this.node = node;
      this.versionInfo = versionInfo;
      this.resources = new HashSet<>(resources);
      this.typeUrl = typeUrl;
      this.responseNonce = responseNonce;
      this.errorCode = errorCode;
      this.errorMessages = errorMessages != null ? errorMessages : ImmutableList.<String>of();
    }

    @Override
    public boolean matches(DiscoveryRequest argument) {
      if (!typeUrl.equals(argument.getTypeUrl())) {
        return false;
      }
      if (!versionInfo.equals(argument.getVersionInfo())) {
        return false;
      }
      if (!responseNonce.equals(argument.getResponseNonce())) {
        return false;
      }
      if (!resources.equals(new HashSet<>(argument.getResourceNamesList()))) {
        return false;
      }
      if (errorCode == null && argument.hasErrorDetail()) {
        return false;
      }
      if (errorCode != null
          && !matchErrorDetail(argument.getErrorDetail(), errorCode, errorMessages)) {
        return false;
      }
      return node.equals(argument.getNode());
    }
  }

  /**
   * Matches a {@link LoadStatsRequest} containing a collection of {@link ClusterStats} with
   * the same list of clusterName:clusterServiceName pair.
   */
  private static class LrsRequestMatcher implements ArgumentMatcher<LoadStatsRequest> {
    private final List<String> expected;

    private LrsRequestMatcher(List<String[]> clusterNames) {
      expected = new ArrayList<>();
      for (String[] pair : clusterNames) {
        expected.add(pair[0] + ":" + (pair[1] == null ? "" : pair[1]));
      }
      Collections.sort(expected);
    }

    @Override
    public boolean matches(LoadStatsRequest argument) {
      List<String> actual = new ArrayList<>();
      for (ClusterStats clusterStats : argument.getClusterStatsList()) {
        actual.add(clusterStats.getClusterName() + ":" + clusterStats.getClusterServiceName());
      }
      Collections.sort(actual);
      return actual.equals(expected);
    }
  }
}