TestVolumeLifecycle.java

/**
 * 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.hadoop.yarn.server.resourcemanager.volume.csi;

import org.apache.hadoop.test.GenericTestUtils;
import org.apache.hadoop.yarn.api.CsiAdaptorProtocol;
import org.apache.hadoop.yarn.api.protocolrecords.ValidateVolumeCapabilitiesRequest;
import org.apache.hadoop.yarn.api.protocolrecords.ValidateVolumeCapabilitiesResponse;
import org.apache.hadoop.yarn.exceptions.YarnException;
import org.apache.hadoop.yarn.server.resourcemanager.volume.csi.event.ControllerPublishVolumeEvent;
import org.apache.hadoop.yarn.server.resourcemanager.volume.csi.event.ValidateVolumeEvent;
import org.apache.hadoop.yarn.server.resourcemanager.volume.csi.lifecycle.VolumeImpl;
import org.apache.hadoop.yarn.server.resourcemanager.volume.csi.lifecycle.VolumeState;
import org.apache.hadoop.yarn.server.volume.csi.exception.VolumeException;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.util.concurrent.TimeoutException;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;

/**
 * Test cases for volume lifecycle management.
 */
public class TestVolumeLifecycle {

  @Test
  public void testValidation() throws YarnException, IOException {
    CsiAdaptorProtocol mockedClient = mock(CsiAdaptorProtocol.class);
    doReturn(ValidateVolumeCapabilitiesResponse.newInstance(true, ""))
        .when(mockedClient)
       .validateVolumeCapacity(any(ValidateVolumeCapabilitiesRequest.class));

    VolumeImpl volume = (VolumeImpl) VolumeBuilder.newBuilder()
        .volumeId("test_vol_00000001")
        .maxCapability(5L)
        .unit("Gi")
        .mountPoint("/path/to/mount")
        .driverName("test-driver-name")
        .build();
    volume.setClient(mockedClient);
    assertEquals(VolumeState.NEW, volume.getVolumeState());

    volume.handle(new ValidateVolumeEvent(volume));
    assertEquals(VolumeState.VALIDATED, volume.getVolumeState());
  }

  @Test
  public void testVolumeCapacityNotSupported() throws Exception {
    CsiAdaptorProtocol mockedClient = mock(CsiAdaptorProtocol.class);

    VolumeImpl volume = (VolumeImpl) VolumeBuilder
        .newBuilder().volumeId("test_vol_00000001").build();
    volume.setClient(mockedClient);

    // NEW -> UNAVAILABLE
    // Simulate a failed API call to the adaptor
    doReturn(ValidateVolumeCapabilitiesResponse.newInstance(false, ""))
        .when(mockedClient)
        .validateVolumeCapacity(any(ValidateVolumeCapabilitiesRequest.class));
    volume.handle(new ValidateVolumeEvent(volume));

    try {
      // Verify the countdown did not happen
      GenericTestUtils.waitFor(() ->
          volume.getVolumeState() == VolumeState.VALIDATED, 10, 50);
      fail("Validate state not reached,"
          + " it should keep waiting until timeout");
    } catch (Exception e) {
      assertTrue(e instanceof TimeoutException);
      assertEquals(VolumeState.UNAVAILABLE, volume.getVolumeState());
    }
  }

  @Test
  public void testValidationFailure() throws YarnException, IOException {
    CsiAdaptorProtocol mockedClient = mock(CsiAdaptorProtocol.class);
    doThrow(new VolumeException("fail"))
        .when(mockedClient)
        .validateVolumeCapacity(any(ValidateVolumeCapabilitiesRequest.class));

    VolumeImpl volume = (VolumeImpl) VolumeBuilder
        .newBuilder().volumeId("test_vol_00000001").build();
    volume.setClient(mockedClient);

    // NEW -> UNAVAILABLE
    // Simulate a failed API call to the adaptor
    doThrow(new VolumeException("failed"))
        .when(mockedClient)
        .validateVolumeCapacity(any(ValidateVolumeCapabilitiesRequest.class));
    volume.handle(new ValidateVolumeEvent(volume));
  }

  @Test
  public void testValidated() throws YarnException, IOException {
    VolumeImpl volume = (VolumeImpl) VolumeBuilder
        .newBuilder().volumeId("test_vol_00000001").build();
    CsiAdaptorProtocol mockedClient = mock(CsiAdaptorProtocol.class);
    // The client has a count to memorize how many times being called
    volume.setClient(mockedClient);

    // NEW -> VALIDATED
    doReturn(ValidateVolumeCapabilitiesResponse.newInstance(true, ""))
        .when(mockedClient)
        .validateVolumeCapacity(any(ValidateVolumeCapabilitiesRequest.class));
    assertEquals(VolumeState.NEW, volume.getVolumeState());
    volume.handle(new ValidateVolumeEvent(volume));
    assertEquals(VolumeState.VALIDATED, volume.getVolumeState());
    verify(mockedClient, times(1))
        .validateVolumeCapacity(any(ValidateVolumeCapabilitiesRequest.class));

    // VALIDATED -> VALIDATED
    volume.handle(new ValidateVolumeEvent(volume));
    assertEquals(VolumeState.VALIDATED, volume.getVolumeState());
    verify(mockedClient, times(1))
        .validateVolumeCapacity(any(ValidateVolumeCapabilitiesRequest.class));
  }

  @Test
  public void testUnavailableState() throws YarnException, IOException {
    VolumeImpl volume = (VolumeImpl) VolumeBuilder
        .newBuilder().volumeId("test_vol_00000001").build();
    CsiAdaptorProtocol mockedClient = mock(CsiAdaptorProtocol.class);
    volume.setClient(mockedClient);

    // NEW -> UNAVAILABLE
    doThrow(new VolumeException("failed"))
        .when(mockedClient)
        .validateVolumeCapacity(any(ValidateVolumeCapabilitiesRequest.class));
    assertEquals(VolumeState.NEW, volume.getVolumeState());
    volume.handle(new ValidateVolumeEvent(volume));
    assertEquals(VolumeState.UNAVAILABLE, volume.getVolumeState());

    // UNAVAILABLE -> UNAVAILABLE
    volume.handle(new ValidateVolumeEvent(volume));
    assertEquals(VolumeState.UNAVAILABLE, volume.getVolumeState());

    // UNAVAILABLE -> VALIDATED
    doReturn(ValidateVolumeCapabilitiesResponse.newInstance(true, ""))
        .when(mockedClient)
        .validateVolumeCapacity(any(ValidateVolumeCapabilitiesRequest.class));
    volume.setClient(mockedClient);
    volume.handle(new ValidateVolumeEvent(volume));
    assertEquals(VolumeState.VALIDATED, volume.getVolumeState());
  }

  @Test
  public void testPublishUnavailableVolume() throws YarnException, IOException {
    VolumeImpl volume = (VolumeImpl) VolumeBuilder
        .newBuilder().volumeId("test_vol_00000001").build();
    CsiAdaptorProtocol mockedClient = mock(CsiAdaptorProtocol.class);
    volume.setClient(mockedClient);

    // NEW -> UNAVAILABLE (on validateVolume)
    doThrow(new VolumeException("failed"))
        .when(mockedClient)
        .validateVolumeCapacity(any(ValidateVolumeCapabilitiesRequest.class));
    assertEquals(VolumeState.NEW, volume.getVolumeState());
    volume.handle(new ValidateVolumeEvent(volume));
    assertEquals(VolumeState.UNAVAILABLE, volume.getVolumeState());

    // UNAVAILABLE -> UNAVAILABLE (on publishVolume)
    volume.handle(new ControllerPublishVolumeEvent(volume));
    // controller publish is not called since the state is UNAVAILABLE
    // verify(mockedClient, times(0)).controllerPublishVolume();
    // state remains to UNAVAILABLE
    assertEquals(VolumeState.UNAVAILABLE, volume.getVolumeState());
  }
}