alluxio-master-2.x/underfs/obs/src/test/java/alluxio/underfs/obs/OBSUnderFileSystemTest.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.underfs.obs;

import alluxio.AlluxioURI;
import alluxio.conf.Configuration;
import alluxio.underfs.UnderFileSystemConfiguration;
import alluxio.underfs.options.DeleteOptions;

import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.ListObjectsRequest;
import com.obs.services.model.ObjectMetadata;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentMatchers;
import org.mockito.Mockito;

import java.io.IOException;
import java.util.Date;

/**
 * Unit tests for the {@link OBSUnderFileSystem}.
 */
public class OBSUnderFileSystemTest {

  private OBSUnderFileSystem mOBSUnderFileSystem;
  private ObsClient mClient;

  private static final String PATH = "path";
  private static final String SRC = "src";
  private static final String DST = "dst";

  private static final String BUCKET_NAME = "bucket";
  private static final String BUCKET_TYPE = "obs";

  /**
   * Set up.
   */
  @Before
  public void before() throws InterruptedException, ObsException {
    mClient = Mockito.mock(ObsClient.class);
    mOBSUnderFileSystem = new OBSUnderFileSystem(new AlluxioURI(""), mClient, BUCKET_NAME,
        BUCKET_TYPE, UnderFileSystemConfiguration.defaults(Configuration.global()));
  }

  /**
   * Test case for {@link OBSUnderFileSystem#deleteDirectory(String, DeleteOptions)}.
   */
  @Test
  public void deleteNonRecursiveOnServiceException() throws IOException {
    Mockito.when(mClient.listObjects(ArgumentMatchers.any(ListObjectsRequest.class)))
        .thenThrow(ObsException.class);

    boolean result = mOBSUnderFileSystem.deleteDirectory(PATH,
        DeleteOptions.defaults().setRecursive(false));
    Assert.assertFalse(result);
  }

  /**
   * Test case for {@link OBSUnderFileSystem#deleteDirectory(String, DeleteOptions)}.
   */
  @Test
  public void deleteRecursiveOnServiceException() throws IOException {
    Mockito.when(mClient.listObjects(ArgumentMatchers.any(ListObjectsRequest.class)))
        .thenThrow(ObsException.class);

    boolean result = mOBSUnderFileSystem.deleteDirectory(PATH,
        DeleteOptions.defaults().setRecursive(true));
    System.out.println(result);
    Assert.assertFalse(result);
  }

  /**
   * Test case for {@link OBSUnderFileSystem#renameFile(String, String)}.
   */
  @Test
  public void renameOnServiceException() throws IOException {
    Mockito.when(mClient.listObjects(ArgumentMatchers.any(ListObjectsRequest.class)))
        .thenThrow(ObsException.class);

    boolean result = mOBSUnderFileSystem.renameFile(SRC, DST);
    Assert.assertFalse(result);
  }

  @Test
  public void judgeDirectoryInBucket() throws Exception {
    ObjectMetadata fileMeta = new ObjectMetadata();
    fileMeta.setLastModified(new Date());
    fileMeta.getMetadata().put("mode", 33152);
    fileMeta.setContentLength(10L);
    ObjectMetadata dirMeta = new ObjectMetadata();
    dirMeta.setLastModified(new Date());
    dirMeta.getMetadata().put("mode", 16877);
    dirMeta.setContentLength(0L);
    /**
     * /xx/file1/ ( File1 actually exists, which is a file) , there is / after file1 name.
     * When OBS, the path object meta is null.
     * When PFS, the path object meta is not null. The object meta is same as /xx/file1
     */
    Mockito.when(mClient.getObjectMetadata(BUCKET_NAME, "pfs_file1"))
        .thenReturn(fileMeta);
    Mockito.when(mClient.getObjectMetadata(BUCKET_NAME, "pfs_file1/"))
        .thenReturn(fileMeta);
    Mockito.when(mClient.getObjectMetadata(BUCKET_NAME, "obs_file1"))
        .thenReturn(fileMeta);
    Mockito.when(mClient.getObjectMetadata(BUCKET_NAME, "obs_file1/"))
        .thenReturn(null);
    Mockito.when(mClient.getObjectMetadata(BUCKET_NAME, "dir1"))
        .thenReturn(dirMeta);
    Mockito.when(mClient.getObjectMetadata(BUCKET_NAME, "dir1/"))
        .thenReturn(dirMeta);

    // PFS Bucket
    mOBSUnderFileSystem = new OBSUnderFileSystem(new AlluxioURI(""), mClient, BUCKET_NAME, "pfs",
        UnderFileSystemConfiguration.defaults(Configuration.global()));
    Assert.assertNotNull(mOBSUnderFileSystem.getObjectStatus("pfs_file1"));
    Assert.assertNull(mOBSUnderFileSystem.getObjectStatus("pfs_file1/"));
    Assert.assertNull(mOBSUnderFileSystem.getObjectStatus("dir1"));
    Assert.assertTrue(mOBSUnderFileSystem.isDirectory("dir1"));
    Assert.assertFalse(mOBSUnderFileSystem.isDirectory("pfs_file1"));

    // OBS Bucket
    mOBSUnderFileSystem = new OBSUnderFileSystem(new AlluxioURI(""), mClient, BUCKET_NAME, "obs",
        UnderFileSystemConfiguration.defaults(Configuration.global()));
    Mockito.when(mClient.getObjectMetadata(BUCKET_NAME, "dir1"))
        .thenReturn(null);
    Assert.assertNotNull(mOBSUnderFileSystem.getObjectStatus("obs_file1"));
    Assert.assertNull(mOBSUnderFileSystem.getObjectStatus("obs_file1/"));
    Assert.assertNull(mOBSUnderFileSystem.getObjectStatus("dir1"));
    Assert.assertTrue(mOBSUnderFileSystem.isDirectory("dir1"));
    Assert.assertFalse(mOBSUnderFileSystem.isDirectory("obs_file1"));
  }

  @Test
  public void nullObjectMetaTest() throws Exception {
    ObjectMetadata fileMeta = new ObjectMetadata();
    fileMeta.setContentLength(10L);
    ObjectMetadata dirMeta = new ObjectMetadata();
    dirMeta.setContentLength(0L);
    /**
     * /xx/file1/ ( File1 actually exists, which is a file) , there is / after file1 name.
     * When OBS, the path object meta is null.
     * When PFS, the path object meta is not null. The object meta is same as /xx/file1
     */
    Mockito.when(mClient.getObjectMetadata(BUCKET_NAME, "pfs_file1"))
        .thenReturn(fileMeta);
    Mockito.when(mClient.getObjectMetadata(BUCKET_NAME, "dir1"))
        .thenReturn(dirMeta);

    mOBSUnderFileSystem = new OBSUnderFileSystem(new AlluxioURI(""), mClient, BUCKET_NAME, "obs",
        UnderFileSystemConfiguration.defaults(Configuration.global()));
    Assert.assertNotNull(mOBSUnderFileSystem.getObjectStatus("pfs_file1"));
    Assert.assertNotNull(mOBSUnderFileSystem.getObjectStatus("dir1"));
  }
}
