twill-yarn/src/test/java/org/apache/twill/yarn/ContainerSizeTestRun.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.twill.yarn;

import com.google.common.collect.ImmutableMap;
import org.apache.twill.api.AbstractTwillRunnable;
import org.apache.twill.api.Configs;
import org.apache.twill.api.ResourceReport;
import org.apache.twill.api.ResourceSpecification;
import org.apache.twill.api.TwillApplication;
import org.apache.twill.api.TwillController;
import org.apache.twill.api.TwillRunner;
import org.apache.twill.api.TwillSpecification;
import org.apache.twill.api.logging.PrinterLogHandler;
import org.apache.twill.discovery.ServiceDiscovered;
import org.junit.Assert;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.PrintWriter;
import java.util.Collections;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

/**
 * Tests related to different container sizes.
 */
public class ContainerSizeTestRun extends BaseYarnTest {

  /**
   * Test for requesting different container size in different order.
   * It specifically test for workaround for YARN-314.
   */
  @Test
  public void testContainerSize() throws InterruptedException, TimeoutException, ExecutionException {
    TwillRunner runner = getTwillRunner();
    TwillController controller = runner.prepare(new SleepApp())
      .addLogHandler(new PrinterLogHandler(new PrintWriter(System.out, true)))
      .start();

    try {
      ServiceDiscovered discovered = controller.discoverService("sleep");
      Assert.assertTrue(waitForSize(discovered, 2, 120));
    } finally {
      controller.terminate().get(120, TimeUnit.SECONDS);
    }
  }

  @Test
  public void testMaxHeapSize() throws InterruptedException, TimeoutException, ExecutionException {
    TwillRunner runner = getTwillRunner();
    TwillController controller = runner.prepare(new MaxHeapApp())
      // Alter the AM container size
      .withConfiguration(Collections.singletonMap(Configs.Keys.YARN_AM_MEMORY_MB, "256"))
      .addLogHandler(new PrinterLogHandler(new PrintWriter(System.out, true)))
      .start();

    try {
      ServiceDiscovered discovered = controller.discoverService("sleep");
      Assert.assertTrue(waitForSize(discovered, 1, 120));

      // Verify the AM container size
      ResourceReport resourceReport = controller.getResourceReport();
      Assert.assertNotNull(resourceReport);
      Assert.assertEquals(256, resourceReport.getAppMasterResources().getMemoryMB());
    } finally {
      controller.terminate().get(120, TimeUnit.SECONDS);
    }
  }

  /**
   * An application that has two runnables with different memory size.
   */
  public static final class SleepApp implements TwillApplication {

    @Override
    public TwillSpecification configure() {
      ResourceSpecification largeRes = ResourceSpecification.Builder.with()
        .setVirtualCores(1)
        .setMemory(1024, ResourceSpecification.SizeUnit.MEGA)
        .build();

      ResourceSpecification smallRes = ResourceSpecification.Builder.with()
        .setVirtualCores(1)
        .setMemory(512, ResourceSpecification.SizeUnit.MEGA)
        .build();

      return TwillSpecification.Builder.with()
        .setName("SleepApp")
        .withRunnable()
          .add("sleep1", new SleepRunnable(12345), largeRes).noLocalFiles()
          .add("sleep2", new SleepRunnable(12346), smallRes).noLocalFiles()
        .withOrder()
          .begin("sleep1")
          .nextWhenStarted("sleep2")
        .build();
    }
  }

  /**
   * A runnable that sleep for 120 seconds.
   */
  public static final class SleepRunnable extends AbstractTwillRunnable {

    private volatile Thread runThread;

    public SleepRunnable(int port) {
      super(ImmutableMap.of("port", Integer.toString(port)));
    }

    @Override
    public void run() {
      runThread = Thread.currentThread();
      getContext().announce("sleep", Integer.parseInt(getContext().getSpecification().getConfigs().get("port")));
      try {
        TimeUnit.SECONDS.sleep(120);
      } catch (InterruptedException e) {
        // Ignore.
      }
    }

    @Override
    public void stop() {
      if (runThread != null) {
        runThread.interrupt();
      }
    }
  }

  /**
   * An application for testing max heap size.
   */
  public static final class MaxHeapApp implements TwillApplication {

    @Override
    public TwillSpecification configure() {
      // Make the runnable request for container smaller than 128MB (the allocation minimum)
      ResourceSpecification res = ResourceSpecification.Builder.with()
        .setVirtualCores(1)
        .setMemory(16, ResourceSpecification.SizeUnit.MEGA)
        .build();

      return TwillSpecification.Builder.with()
        .setName("MaxHeapApp")
        .withRunnable()
        .add("sleep", new MaxHeapRunnable(12345), res).noLocalFiles()
        .anyOrder()
        .build();
    }
  }

  /**
   * The runnable for testing max heap size.
   */
  public static final class MaxHeapRunnable extends AbstractTwillRunnable {

    private static final Logger LOG = LoggerFactory.getLogger(MaxHeapRunnable.class);
    private volatile Thread runThread;

    public MaxHeapRunnable(int port) {
      super(ImmutableMap.of("port", Integer.toString(port)));
    }

    @Override
    public void run() {
      // This heap size should be > 16, since the min allocation size is 128mb
      if (Runtime.getRuntime().maxMemory() <= 16 * 1024 * 1024) {
        LOG.error("Memory size is too small: {}", Runtime.getRuntime().maxMemory());
        return;
      }

      runThread = Thread.currentThread();
      getContext().announce("sleep", Integer.parseInt(getContext().getSpecification().getConfigs().get("port")));
      try {
        TimeUnit.SECONDS.sleep(120);
      } catch (InterruptedException e) {
        // Ignore.
      }
    }

    @Override
    public void stop() {
      if (runThread != null) {
        runThread.interrupt();
      }
    }
  }
}