alluxio-master-2.x/tests/src/test/java/alluxio/web/WebServerIntegrationTest.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.web;

import alluxio.client.rest.TestCase;
import alluxio.client.rest.TestCaseOptions;
import alluxio.conf.Configuration;
import alluxio.metrics.sink.MetricsServlet;
import alluxio.testutils.BaseIntegrationTest;
import alluxio.testutils.LocalAlluxioClusterResource;
import alluxio.util.network.NetworkAddressUtils;
import alluxio.util.network.NetworkAddressUtils.ServiceType;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.Multimap;
import org.junit.Assert;
import org.junit.Rule;
import org.junit.Test;

import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.InetSocketAddress;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Scanner;
import javax.ws.rs.HttpMethod;

/**
 * Tests the web server is up when Alluxio starts.
 */
public class WebServerIntegrationTest extends BaseIntegrationTest {

  // Web pages that will be verified.
  private static final Multimap<ServiceType, String> PAGES =
      new ImmutableListMultimap.Builder<ServiceType, String>().putAll(ServiceType.MASTER_WEB, "/")
          .putAll(ServiceType.WORKER_WEB, "/").build();

  @Rule
  public LocalAlluxioClusterResource mLocalAlluxioClusterResource =
      new LocalAlluxioClusterResource.Builder().build();

  /**
   * Tests whether the metrics json is being served.
   */
  @Test
  public void metricsJson() throws Exception {
    for (ServiceType serviceType : PAGES.keys()) {
      verifyMetricsJson(serviceType);
    }
  }

  private void verifyMetricsJson(ServiceType serviceType) throws Exception {
    InetSocketAddress address = getInetSocketAddresss(serviceType);
    Map<String, String> params = new HashMap<>();
    String result = new TestCase(
        address.getHostName(), address.getPort(), MetricsServlet.SERVLET_PATH,
        "", params, HttpMethod.GET,
        TestCaseOptions.defaults()).runAndGetResponse();

    TypeReference<HashMap<String, Object>> typeRef = new TypeReference<HashMap<String, Object>>() {
    };
    HashMap<String, Object> metrics = new ObjectMapper().readValue(result, typeRef);
    Assert.assertTrue(metrics.containsKey("version"));
    Assert.assertTrue(metrics.containsKey("counters"));
  }

  /**
   * Tests whether the master and worker web homepage is up.
   */
  @Test
  public void serverUp() throws Exception {
    for (Entry<ServiceType, String> entry : PAGES.entries()) {
      verifyWebService(entry.getKey(), entry.getValue());
    }
  }

  /**
   * Tests whether the web resources directory is created.
   */
  @Test
  public void tempDirectoryCreated() {
    Files.isDirectory(Paths.get(mLocalAlluxioClusterResource.get().getAlluxioHome(), "web"));
  }

  private void verifyWebService(ServiceType serviceType, String path) throws IOException {
    InetSocketAddress webAddr = getInetSocketAddresss(serviceType);

    HttpURLConnection webService = (HttpURLConnection) new URL(
        "http://" + webAddr.getAddress().getHostAddress() + ":" + webAddr.getPort() + path)
        .openConnection();
    webService.connect();

    Assert.assertEquals(200, webService.getResponseCode());

    Scanner pageScanner = null;
    boolean verified = false;

    try {
      pageScanner = new Scanner(webService.getInputStream());

      while (pageScanner.hasNextLine()) {
        String line = pageScanner.nextLine();
        if (line.contains("<title>Alluxio Master</title>") || line
            .contains("<title>Alluxio Worker</title>")) {
          verified = true;
          break;
        }
      }
    } finally {
      if (pageScanner != null) {
        pageScanner.close();
      }
      webService.disconnect();
    }

    Assert.assertTrue(String
            .format("%s was started but not successfully verified.", serviceType.getServiceName()),
        verified);
  }

  private InetSocketAddress getInetSocketAddresss(ServiceType serviceType) {
    int port;
    if (serviceType == ServiceType.MASTER_WEB) {
      port = mLocalAlluxioClusterResource.get().getLocalAlluxioMaster().getMasterProcess()
          .getWebAddress().getPort();
    } else {
      port = mLocalAlluxioClusterResource.get().getWorkerProcess().getWebLocalPort();
    }
    InetSocketAddress webAddr =
        new InetSocketAddress(NetworkAddressUtils.getConnectHost(serviceType,
            Configuration.global()), port);
    return webAddr;
  }
}
