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.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.Disabled;
  
  import io.vertx.junit5.VertxTestContext;
  import net.bytebuddy.ByteBuddy;
  import net.bytebuddy.description.type.TypeDescription;
  import net.bytebuddy.dynamic.ClassFileLocator;
  import net.bytebuddy.dynamic.TypeResolutionStrategy;
  import net.bytebuddy.dynamic.loading.ClassLoadingStrategy;
  import net.bytebuddy.implementation.MethodDelegation;
  import net.bytebuddy.implementation.bind.annotation.SuperCall;
  import net.bytebuddy.pool.TypePool;
  import org.apache.cassandra.distributed.api.IInstance;
  import org.apache.cassandra.testing.ConfigurableCassandraTestContext;
  import org.apache.cassandra.testing.IClusterExtension;
  
  import static net.bytebuddy.matcher.ElementMatchers.named;
  
  /**
   * Multi-DC Cluster shrink scenarios integration tests for token range replica mapping endpoint with the in-jvm
   * dtest framework.
   *
   * 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
   */
  // TODO: the test needs rework; disable it for now
  //@Tag("heavy")
  //@ExtendWith(VertxExtension.class)
  @Disabled("This test currently shinks the cluster without any replica-safe awareness " +
            "causing problems when nodes are streaming data to other nodes that have already started leaving")
  class LeavingTestMultiDCHalveCluster extends LeavingBaseTest
  {
  //    @CassandraIntegrationTest(nodesPerDc = 6, numDcs = 2, network = true, buildCluster = false)
      void retrieveMappingMultiDCHalveClusterSize(VertxTestContext context,
                                                  ConfigurableCassandraTestContext cassandraTestContext) throws Exception
      {
          BBHelperHalveClusterMultiDC.reset();
          int leavingNodesPerDC = 3;
          IClusterExtension<? extends IInstance> cluster = getMultiDCCluster(BBHelperHalveClusterMultiDC::install, cassandraTestContext);
  
          Map<String, Map<Range<BigInteger>, List<String>>> expectedRangeMappings
          = generateExpectedRangeHalveClusterSizeMultiDC();
          runLeavingTestScenario(context,
                                 leavingNodesPerDC,
                                 BBHelperHalveClusterMultiDC.transientStateStart,
                                 BBHelperHalveClusterMultiDC.transientStateEnd,
                                 cluster,
                                 expectedRangeMappings);
      }
  
      /**
       * Generates expected token range and replica mappings specific to the test case involving a 12 node cluster
       * across 2 DCs with the last 6 nodes leaving the cluster (3 per DC)
       * <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>
       * In a multi-DC scenario, a single range will have nodes from both DCs. The replicas are grouped by DC here
       * to allow per-DC validation as returned from the sidecar endpoint.
       * <p>
       * Ranges that including leaving node replicas will have [RF + no. leaving nodes in replica-set] replicas with
       * the new replicas being the existing nodes in ring-order.
       * <p>
       * eg.
       * Range 1 - A, B, C
       * Range 2 - B, C, D (with D being the leaving node)
       * Expected Range 2 - B, C, D, A (With A taking over the range of the leaving node)
       */
      private Map<String, Map<Range<BigInteger>, List<String>>> generateExpectedRangeHalveClusterSizeMultiDC()
      {
          List<Range<BigInteger>> expectedRanges = generateExpectedRanges();
          Map<Range<BigInteger>, List<String>> dc1Mapping = new HashMap<>();
          Map<Range<BigInteger>, List<String>> dc2Mapping = new HashMap<>();
  
          dc1Mapping.put(expectedRanges.get(0), Arrays.asList("127.0.0.1", "127.0.0.3", "127.0.0.5"));
          dc2Mapping.put(expectedRanges.get(0), Arrays.asList("127.0.0.2", "127.0.0.4", "127.0.0.6"));
  
          dc1Mapping.put(expectedRanges.get(1),
                         Arrays.asList("127.0.0.3", "127.0.0.5", "127.0.0.7", "127.0.0.1"));
          dc2Mapping.put(expectedRanges.get(1), Arrays.asList("127.0.0.2", "127.0.0.4", "127.0.0.6"));
  
          dc1Mapping.put(expectedRanges.get(2),
                         Arrays.asList("127.0.0.3", "127.0.0.5", "127.0.0.7", "127.0.0.1"));
          dc2Mapping.put(expectedRanges.get(2),
                         Arrays.asList("127.0.0.4", "127.0.0.6", "127.0.0.8", "127.0.0.2"));
  
          dc1Mapping.put(
          expectedRanges.get(3),
          Arrays.asList("127.0.0.5", "127.0.0.7", "127.0.0.9", "127.0.0.1", "127.0.0.3"));
          dc2Mapping.put(expectedRanges.get(3),
                         Arrays.asList("127.0.0.4", "127.0.0.6", "127.0.0.8", "127.0.0.2"));
  
          dc1Mapping.put(
          expectedRanges.get(4),
          Arrays.asList("127.0.0.5", "127.0.0.7", "127.0.0.9", "127.0.0.1", "127.0.0.3"));
          dc2Mapping.put(
          expectedRanges.get(4),
          Arrays.asList("127.0.0.6", "127.0.0.8", "127.0.0.10", "127.0.0.2", "127.0.0.4"));
  
          dc1Mapping.put(
          expectedRanges.get(5),
          Arrays.asList("127.0.0.7", "127.0.0.9", "127.0.0.11", "127.0.0.1", "127.0.0.3",
                        "127.0.0.5"));
          dc2Mapping.put(
          expectedRanges.get(5),
          Arrays.asList("127.0.0.6", "127.0.0.8", "127.0.0.10", "127.0.0.2", "127.0.0.4"));
  
          dc1Mapping.put(
          expectedRanges.get(6),
          Arrays.asList("127.0.0.7", "127.0.0.9", "127.0.0.11", "127.0.0.1", "127.0.0.3",
                        "127.0.0.5"));
          dc2Mapping.put(
          expectedRanges.get(6),
          Arrays.asList("127.0.0.8", "127.0.0.10", "127.0.0.12", "127.0.0.2", "127.0.0.4",
                        "127.0.0.6"));
  
          dc1Mapping.put(
          expectedRanges.get(7),
          Arrays.asList("127.0.0.9", "127.0.0.11", "127.0.0.1", "127.0.0.3", "127.0.0.5"));
          dc2Mapping.put(
          expectedRanges.get(7),
          Arrays.asList("127.0.0.8", "127.0.0.10", "127.0.0.12", "127.0.0.2", "127.0.0.4",
                        "127.0.0.6"));
  
          dc1Mapping.put(
          expectedRanges.get(8),
          Arrays.asList("127.0.0.9", "127.0.0.11", "127.0.0.1", "127.0.0.3", "127.0.0.5"));
          dc2Mapping.put(
          expectedRanges.get(8),
          Arrays.asList("127.0.0.10", "127.0.0.12", "127.0.0.2", "127.0.0.4", "127.0.0.6"));
  
          dc1Mapping.put(expectedRanges.get(9),
                         Arrays.asList("127.0.0.11", "127.0.0.1", "127.0.0.3", "127.0.0.5"));
          dc2Mapping.put(
          expectedRanges.get(9),
          Arrays.asList("127.0.0.10", "127.0.0.12", "127.0.0.2", "127.0.0.4", "127.0.0.6"));
  
          dc1Mapping.put(expectedRanges.get(10),
                         Arrays.asList("127.0.0.11", "127.0.0.1", "127.0.0.3", "127.0.0.5"));
          dc2Mapping.put(expectedRanges.get(10),
                         Arrays.asList("127.0.0.12", "127.0.0.2", "127.0.0.4", "127.0.0.6"));
  
          dc1Mapping.put(expectedRanges.get(11), Arrays.asList("127.0.0.1", "127.0.0.3", "127.0.0.5"));
          dc2Mapping.put(expectedRanges.get(11),
                         Arrays.asList("127.0.0.12", "127.0.0.2", "127.0.0.4", "127.0.0.6"));
  
          dc1Mapping.put(expectedRanges.get(12), Arrays.asList("127.0.0.1", "127.0.0.3", "127.0.0.5"));
          dc2Mapping.put(expectedRanges.get(12), Arrays.asList("127.0.0.2", "127.0.0.4", "127.0.0.6"));
  
          return new HashMap<String, Map<Range<BigInteger>, List<String>>>()
          {
              {
                  put("datacenter1", dc1Mapping);
                  put("datacenter2", dc2Mapping);
              }
          };
      }
  
      /**
       * ByteBuddy helper for halve cluster size with multi-DC
       */
      public static class BBHelperHalveClusterMultiDC
      {
          static CountDownLatch transientStateStart = new CountDownLatch(6);
          static CountDownLatch transientStateEnd = new CountDownLatch(6);
  
          public static void install(ClassLoader cl, Integer nodeNumber)
          {
              // Test case involves halving the size of a 12 node cluster (6 per DC)
              // We intercept the shutdown of the removed nodes (7-12) to validate token ranges
              if (nodeNumber > 6)
              {
                  TypePool typePool = TypePool.Default.of(cl);
                  TypeDescription description = typePool.describe("org.apache.cassandra.service.StorageService")
                                                        .resolve();
                  new ByteBuddy().rebase(description, ClassFileLocator.ForClassLoader.of(cl))
                                 .method(named("unbootstrap"))
                                 .intercept(MethodDelegation.to(BBHelperHalveClusterMultiDC.class))
                                 // Defer class loading until all dependencies are loaded
                                 .make(TypeResolutionStrategy.Lazy.INSTANCE, typePool)
                                 .load(cl, ClassLoadingStrategy.Default.INJECTION);
              }
          }
  
          @SuppressWarnings("unused")
          public static void unbootstrap(@SuperCall Callable<?> orig) throws Exception
          {
              transientStateStart.countDown();
              awaitLatchOrTimeout(transientStateEnd, 2, TimeUnit.MINUTES, "transientStateEnd");
              orig.call();
          }
  
          public static void reset()
          {
              transientStateStart = new CountDownLatch(6);
              transientStateEnd = new CountDownLatch(6);
          }
      }
  }
  