content: /*
   * Licensed to the Apache Software Foundation (ASF) under one
   * or more contributor license agreements.  See the NOTICE file
   * distributed with this work for additional information
   * regarding copyright ownership.  The ASF licenses this file
   * to you 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 org.apache.cassandra.sidecar.routes.tokenrange;
  
  import java.math.BigInteger;
  import java.util.Arrays;
  import java.util.Collection;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  import java.util.concurrent.Callable;
  import java.util.concurrent.CountDownLatch;
  import java.util.concurrent.TimeUnit;
  
  import com.google.common.collect.Range;
  import org.junit.jupiter.api.Tag;
  import org.junit.jupiter.api.extension.ExtendWith;
  
  import io.vertx.junit5.VertxExtension;
  import io.vertx.junit5.VertxTestContext;
  import net.bytebuddy.implementation.bind.annotation.SuperCall;
  import org.apache.cassandra.sidecar.testing.BootstrapBBUtils;
  import org.apache.cassandra.testing.CassandraIntegrationTest;
  import org.apache.cassandra.testing.ConfigurableCassandraTestContext;
  
  /**
   * Cluster expansion scenarios integration tests for token range replica mapping endpoint with the in-jvm
   * dtest framework.
   *
   * <p>Note: Some related test classes are broken down to have a single test case to parallelize test execution and
   * therefore limit the instance size required to run the tests from CircleCI as the in-jvm-dtests tests are memory bound
   */
  @Tag("heavy")
  @ExtendWith(VertxExtension.class)
  public class JoiningMultipleNodesTest extends JoiningBaseTest
  {
      @CassandraIntegrationTest(nodesPerDc = 3, newNodesPerDc = 2, network = true, buildCluster = false)
      void retrieveMappingWithMultipleJoiningNodes(VertxTestContext context,
                                                   ConfigurableCassandraTestContext cassandraTestContext)
      throws Exception
      {
          BBHelperMultipleJoiningNodes.reset();
          runJoiningTestScenario(context,
                                 cassandraTestContext,
                                 BBHelperMultipleJoiningNodes::install,
                                 BBHelperMultipleJoiningNodes.transientStateStart,
                                 BBHelperMultipleJoiningNodes.transientStateEnd,
                                 generateExpectedRangeMappingMultipleJoiningNodes());
      }
  
      /**
       * Generates expected token range and replica mappings specific to the test case involving a 3 node cluster
       * with the 2 more nodes joining the cluster
       * <p>
       * Expected ranges are generated by adding RF replicas per range in increasing order. The replica-sets in subsequent
       * ranges cascade with the next range excluding the first replica, and including the next replica from the nodes.
       * eg.
       * Range 1 - A, B, C
       * Range 2 - B, C, D
       * <p>
       * We generate the expected ranges by using
       * 1) the initial token allocations to nodes (prior to adding nodes) shown under "Initial Ranges"
       * (in the comment block below),
       * 2)the "pending node ranges" and
       * 3) the final token allocations per node.
       * <p>
       * Step 1: Prepare ranges starting from partitioner min-token, ending at partitioner max-token using (3) above
       * Step 2: Create the cascading list of replica-sets based on the RF (3) for each range using the initial node list
       * Step 3: Add replicas to ranges based on (1) and (2) above
       */
      private HashMap<String, Map<Range<BigInteger>, List<String>>> generateExpectedRangeMappingMultipleJoiningNodes()
      {
          /*
           * All ranges previously had replicas 1, 2, 3, since this was a 3 node cluster with RF = 3
           *
           * Initial Ranges:
           * [-9223372036854775808, -4611686018427387905]:["127.0.0.3","127.0.0.2","127.0.0.1"]
           * [-4611686018427387905, -3]:["127.0.0.3","127.0.0.2","127.0.0.1"]
           * [-3, 4611686018427387899]:["127.0.0.3","127.0.0.2","127.0.0.1"]
           * [4611686018427387899, 9223372036854775807]:["127.0.0.3","127.0.0.2","127.0.0.1"]
           *
           * Pending ranges:
           * [-3, 4611686018427387899]=[127.0.0.4:62469]
           * [-4611686018427387905, -3]=[127.0.0.5:62472]
           * [-4611686018427387905, -2305843009213693954]=[127.0.0.4:62469]
           * [4611686018427387899, -4611686018427387905]=[127.0.0.4:62469, 127.0.0.5:62472] (wrap-around)
           * [-3, 2305843009213693948]=[127.0.0.5:62472]
           *
           * Token assignment for new nodes:
           * 127.0.0.4 - [-2305843009213693954]
           * 127.0.0.5 - [2305843009213693948]
           *
           * Based on the pending ranges, we add the expected replicas to the ranges they intersect below
           */
          List<Range<BigInteger>> expectedRanges = generateExpectedRanges();
          Map<Range<BigInteger>, List<String>> mapping = new HashMap<>();
          // [-9223372036854775808, -4611686018427387905]
          mapping.put(expectedRanges.get(0), Arrays.asList("127.0.0.1", "127.0.0.2", "127.0.0.3", "127.0.0.4",
                                                           "127.0.0.5"));
          // [-4611686018427387905, -2305843009213693954]
          mapping.put(expectedRanges.get(1), Arrays.asList("127.0.0.2", "127.0.0.3", "127.0.0.1", "127.0.0.4",
                                                           "127.0.0.5"));
          // [-2305843009213693954, -3]
          mapping.put(expectedRanges.get(2), Arrays.asList("127.0.0.3", "127.0.0.1", "127.0.0.2", "127.0.0.5"));
          // [-3, 2305843009213693948]
          mapping.put(expectedRanges.get(3), Arrays.asList("127.0.0.1", "127.0.0.2", "127.0.0.3", "127.0.0.4",
                                                           "127.0.0.5"));
          // [2305843009213693948, 4611686018427387899]
          mapping.put(expectedRanges.get(4), Arrays.asList("127.0.0.4", "127.0.0.1", "127.0.0.2", "127.0.0.3"));
          // [4611686018427387899, 9223372036854775807]
          mapping.put(expectedRanges.get(5), Arrays.asList("127.0.0.1", "127.0.0.2", "127.0.0.3", "127.0.0.4",
                                                           "127.0.0.5"));
          return new HashMap<String, Map<Range<BigInteger>, List<String>>>()
          {
              {
                  put("datacenter1", mapping);
              }
          };
      }
  
      /**
       * ByteBuddy helper for multiple joining nodes
       */
      public static class BBHelperMultipleJoiningNodes
      {
          static CountDownLatch transientStateStart = new CountDownLatch(2);
          static CountDownLatch transientStateEnd = new CountDownLatch(2);
  
          public static void install(ClassLoader cl, Integer nodeNumber)
          {
              // Test case involves 3 node cluster with a 2 joining nodes
              // We intercept the joining of nodes (4, 5) to validate token ranges
              if (nodeNumber > 3)
              {
                  BootstrapBBUtils.installFinishJoiningRingInterceptor(cl, BBHelperMultipleJoiningNodes.class);
              }
          }
  
          public static void finishJoiningRing(boolean didBootstrap, Collection<?> tokens, @SuperCall Callable<Void> orig) throws Exception
          {
              // trigger bootstrap start and wait until bootstrap is ready from test
              transientStateStart.countDown();
              awaitLatchOrTimeout(transientStateEnd, 2, TimeUnit.MINUTES, "transientStateEnd");
              orig.call();
          }
  
          public static void reset()
          {
              transientStateStart = new CountDownLatch(2);
              transientStateEnd = new CountDownLatch(2);
          }
      }
  }
  