hadoop-ozone/ozonefs/src/test/java/org/apache/hadoop/fs/ozone/TestOzoneFileSystemWithMocks.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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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.fs.ozone;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;

import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.hdds.conf.ConfigurationSource;
import org.apache.hadoop.hdds.conf.OzoneConfiguration;
import org.apache.hadoop.ozone.OmUtils;
import org.apache.hadoop.ozone.OzoneConfigKeys;
import org.apache.hadoop.ozone.client.ObjectStore;
import org.apache.hadoop.ozone.client.OzoneBucket;
import org.apache.hadoop.ozone.client.OzoneClient;
import org.apache.hadoop.ozone.client.OzoneClientFactory;
import org.apache.hadoop.ozone.client.OzoneVolume;
import org.apache.hadoop.security.UserGroupInformation;

import static org.junit.Assert.assertEquals;
import org.junit.Test;
import org.junit.runner.RunWith;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PowerMockIgnore;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.PowerMockRunner;

/**
 * Ozone File system tests that are light weight and use mocks.
 */
@RunWith(PowerMockRunner.class)
@PrepareForTest({ OzoneClientFactory.class, UserGroupInformation.class })
@PowerMockIgnore("javax.management.*")
public class TestOzoneFileSystemWithMocks {

  @Test
  public void testFSUriWithHostPortOverrides() throws Exception {
    OzoneConfiguration conf = new OzoneConfiguration();
    mockClientFactory(conf, 5899);
    mockUser();

    URI uri = new URI("o3fs://bucket1.volume1.local.host:5899");
    FileSystem fileSystem = FileSystem.get(uri, conf);
    OzoneFileSystem ozfs = (OzoneFileSystem) fileSystem;

    assertEquals("bucket1.volume1.local.host:5899",
        ozfs.getUri().getAuthority());
    PowerMockito.verifyStatic();
    OzoneClientFactory.getRpcClient("local.host", 5899, conf);
  }

  @Test
  public void testFSUriWithHostPortUnspecified() throws Exception {
    OzoneConfiguration conf = new OzoneConfiguration();
    final int omPort = OmUtils.getOmRpcPort(conf);
    mockClientFactory(conf, omPort);
    mockUser();

    URI uri = new URI("o3fs://bucket1.volume1.local.host");
    FileSystem fileSystem = FileSystem.get(uri, conf);
    OzoneFileSystem ozfs = (OzoneFileSystem) fileSystem;

    assertEquals("bucket1.volume1.local.host", ozfs.getUri().getHost());
    // The URI doesn't contain a port number, expect -1 from getPort()
    assertEquals(ozfs.getUri().getPort(), -1);
    PowerMockito.verifyStatic();
    // Check the actual port number in use
    OzoneClientFactory.getRpcClient("local.host", omPort, conf);
  }

  @Test
  public void testFSUriHostVersionDefault() throws Exception {
    OzoneConfiguration conf = new OzoneConfiguration();
    mockClientFactory(conf);
    mockUser();

    URI uri = new URI("o3fs://bucket1.volume1/key");
    FileSystem fileSystem = FileSystem.get(uri, conf);
    OzoneFileSystem ozfs = (OzoneFileSystem) fileSystem;

    assertEquals("bucket1.volume1", ozfs.getUri().getAuthority());
    PowerMockito.verifyStatic();
    OzoneClientFactory.getRpcClient(conf);
  }

  @Test
  public void testReplicationDefaultValue()
      throws IOException, URISyntaxException {
    OzoneConfiguration conf = new OzoneConfiguration();
    int defaultValue = conf.getInt(OzoneConfigKeys.OZONE_REPLICATION, 3);
    mockClientFactory(conf);
    mockUser();

    URI uri = new URI("o3fs://bucket1.volume1/key");
    FileSystem fs = FileSystem.get(uri, conf);

    assertEquals(defaultValue, fs.getDefaultReplication(new Path("/any")));
  }

  @Test
  public void testReplicationCustomValue()
      throws IOException, URISyntaxException {
    OzoneConfiguration conf = new OzoneConfiguration();
    short configured = 1;
    conf.setInt(OzoneConfigKeys.OZONE_REPLICATION, configured);
    mockClientFactory(conf);
    mockUser();

    URI uri = new URI("o3fs://bucket1.volume1/key");
    FileSystem fs = FileSystem.get(uri, conf);

    assertEquals(configured, fs.getDefaultReplication(new Path("/any")));
  }

  private OzoneClient mockClient() throws IOException {
    OzoneClient ozoneClient = mock(OzoneClient.class);
    ObjectStore objectStore = mock(ObjectStore.class);
    OzoneVolume volume = mock(OzoneVolume.class);
    OzoneBucket bucket = mock(OzoneBucket.class);

    when(ozoneClient.getObjectStore()).thenReturn(objectStore);
    when(objectStore.getVolume(eq("volume1"))).thenReturn(volume);
    when(volume.getBucket("bucket1")).thenReturn(bucket);
    return ozoneClient;
  }

  private void mockClientFactory(ConfigurationSource conf, int omPort)
      throws IOException {
    OzoneClient ozoneClient = mockClient();

    PowerMockito.mockStatic(OzoneClientFactory.class);
    PowerMockito.when(OzoneClientFactory.getRpcClient(eq("local.host"),
        eq(omPort), any())).thenReturn(ozoneClient);
  }

  private void mockClientFactory(ConfigurationSource conf) throws IOException {
    OzoneClient ozoneClient = mockClient();

    PowerMockito.mockStatic(OzoneClientFactory.class);
    PowerMockito.when(OzoneClientFactory.getRpcClient(any()))
        .thenReturn(ozoneClient);
  }

  private void mockUser() throws IOException {
    UserGroupInformation ugi = mock(UserGroupInformation.class);
    PowerMockito.mockStatic(UserGroupInformation.class);
    PowerMockito.when(UserGroupInformation.getCurrentUser()).thenReturn(ugi);
    when(ugi.getShortUserName()).thenReturn("user1");
  }
}