alluxio-master-2.x/core/client/fs/src/test/java/alluxio/client/block/policy/DeterministicHashPolicyTest.java
/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.client.block.policy;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;

import alluxio.Constants;
import alluxio.client.block.BlockWorkerInfo;
import alluxio.client.block.policy.options.GetWorkerOptions;
import alluxio.conf.Configuration;
import alluxio.conf.InstancedConfiguration;
import alluxio.conf.PropertyKey;
import alluxio.wire.BlockInfo;
import alluxio.wire.WorkerNetAddress;

import org.junit.Before;
import org.junit.Test;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * Tests {@link DeterministicHashPolicy}.
 */
public final class DeterministicHashPolicyTest {
  private static final int PORT = 1;

  private final List<BlockWorkerInfo> mWorkerInfos = new ArrayList<>();
  private static InstancedConfiguration sConf = Configuration.copyGlobal();

  @Before
  public void before() {
    mWorkerInfos.clear();
    mWorkerInfos.add(new BlockWorkerInfo(
        new WorkerNetAddress().setHost("worker1").setRpcPort(PORT).setDataPort(PORT)
            .setWebPort(PORT), Constants.GB, 0));
    mWorkerInfos.add(new BlockWorkerInfo(
        new WorkerNetAddress().setHost("worker2").setRpcPort(PORT).setDataPort(PORT)
            .setWebPort(PORT), 2 * (long) Constants.GB, 0));
    mWorkerInfos.add(new BlockWorkerInfo(
        new WorkerNetAddress().setHost("worker3").setRpcPort(PORT).setDataPort(PORT)
            .setWebPort(PORT), 3 * (long) Constants.GB, 0));
    mWorkerInfos.add(new BlockWorkerInfo(
        new WorkerNetAddress().setHost("worker4").setRpcPort(PORT).setDataPort(PORT)
            .setWebPort(PORT), 3 * (long) Constants.GB, 0));
  }

  @Test
  public void getWorkerDeterministically() {
    DeterministicHashPolicy policy = (DeterministicHashPolicy) BlockLocationPolicy.Factory.create(
        DeterministicHashPolicy.class, sConf);
    String host = policy.getWorker(GetWorkerOptions.defaults().setBlockWorkerInfos(mWorkerInfos)
        .setBlockInfo(new BlockInfo().setBlockId(1).setLength(2 * (long) Constants.GB)))
        .orElseThrow(() -> new IllegalStateException("Expected worker")).getHost();
    for (int i = 0; i < 10; i++) {
      DeterministicHashPolicy p = (DeterministicHashPolicy) BlockLocationPolicy.Factory.create(
          DeterministicHashPolicy.class,
          sConf);
      // For the same block, always return the same worker.
      assertEquals(host, p.getWorker(
          GetWorkerOptions.defaults().setBlockWorkerInfos(mWorkerInfos)
              .setBlockInfo(new BlockInfo().setBlockId(1).setLength(2 * (long) Constants.GB)))
          .orElseThrow(() -> new IllegalStateException("Expected worker")).getHost());
      assertEquals(host, p.getWorker(
          GetWorkerOptions.defaults().setBlockWorkerInfos(mWorkerInfos)
              .setBlockInfo(new BlockInfo().setBlockId(1).setLength(2 * (long) Constants.GB)))
          .orElseThrow(() -> new IllegalStateException("Expected worker")).getHost());
    }
  }

  @Test
  public void getWorkerEnoughCapacity() {
    DeterministicHashPolicy policy = (DeterministicHashPolicy) BlockLocationPolicy.Factory.create(
        DeterministicHashPolicy.class, sConf);
    for (long blockId = 0; blockId < 100; blockId++) {
      // worker1 does not have enough capacity. It should never be picked.
      assertNotEquals("worker1", policy.getWorker(
          GetWorkerOptions.defaults().setBlockWorkerInfos(mWorkerInfos)
              .setBlockInfo(new BlockInfo().setBlockId(blockId)
                  .setLength(2 * (long) Constants.GB)))
          .orElseThrow(() -> new IllegalStateException("Expected worker")).getHost());
    }
  }

  @Test
  public void getWorkerMultipleShards() {
    sConf.set(PropertyKey.USER_UFS_BLOCK_READ_LOCATION_POLICY_DETERMINISTIC_HASH_SHARDS, 2);
    DeterministicHashPolicy policy2 = (DeterministicHashPolicy) BlockLocationPolicy.Factory.create(
        DeterministicHashPolicy.class, sConf);
    Set<String> addresses1 = new HashSet<>();
    Set<String> addresses2 = new HashSet<>();
    for (int i = 0; i < 100; i++) {
      addresses1.add(policy2.getWorker(
          GetWorkerOptions.defaults().setBlockWorkerInfos(mWorkerInfos)
              .setBlockInfo(new BlockInfo().setBlockId(1)
                  .setLength(2 * (long) Constants.GB)))
          .orElseThrow(() -> new IllegalStateException("Expected worker")).getHost());
      addresses2.add(policy2.getWorker(
              GetWorkerOptions.defaults().setBlockWorkerInfos(mWorkerInfos)
              .setBlockInfo(new BlockInfo().setBlockId(1)
                  .setLength(2 * (long) Constants.GB)))
          .orElseThrow(() -> new IllegalStateException("Expected worker")).getHost());
    }
    // With sufficient traffic, 2 (= #shards) workers should be picked to serve the block.
    assertEquals(2, addresses1.size());
    assertEquals(2, addresses2.size());
    assertEquals(addresses1, addresses2);
  }
}
