org.apache.twill.yarn.TwillTester.java Source code

Java tutorial

Introduction

Here is the source code for org.apache.twill.yarn.TwillTester.java

Source

/*
 * 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.util.concurrent.Service;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hdfs.HdfsConfiguration;
import org.apache.hadoop.hdfs.MiniDFSCluster;
import org.apache.hadoop.yarn.api.records.NodeReport;
import org.apache.hadoop.yarn.conf.YarnConfiguration;
import org.apache.hadoop.yarn.server.MiniYARNCluster;
import org.apache.twill.api.TwillRunner;
import org.apache.twill.api.TwillRunnerService;
import org.apache.twill.internal.yarn.VersionDetectYarnAppClientFactory;
import org.apache.twill.internal.yarn.YarnAppClient;
import org.apache.twill.internal.yarn.YarnUtils;
import org.apache.twill.internal.zookeeper.InMemoryZKServer;
import org.junit.rules.ExternalResource;
import org.junit.rules.TemporaryFolder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.IOException;
import java.util.List;

/**
 * A TwillTester rule allows creation of mini Yarn cluster and {@link TwillRunner} used for testing that is
 * guaranteed to be teared down when tests are done.
 *
 * <pre>
 *   public class TwillTest {
 *     &#064;ClassRule
 *     public static final TwillTester TWILL_TESTER = new TwillTester();
 *
 *     &#064;Test
 *     public void test() {
 *       TwillRunner twillRunner = TWILL_TESTER.getTwillRunner();
 *       twillRunner.prepare(...).start();
 *     }
 *   }
 * </pre>
 */
public class TwillTester extends ExternalResource {

    private static final Logger LOG = LoggerFactory.getLogger(TwillTester.class);

    private final TemporaryFolder tmpFolder = new TemporaryFolder();
    private InMemoryZKServer zkServer;
    private MiniDFSCluster dfsCluster;
    private MiniYARNCluster cluster;
    private YarnConfiguration config;
    private TwillRunnerService twillRunner;
    private YarnAppClient yarnAppClient;

    @Override
    protected void before() throws Throwable {
        tmpFolder.create();

        // Starts Zookeeper
        zkServer = InMemoryZKServer.builder().setDataDir(tmpFolder.newFolder()).build();
        zkServer.startAndWait();

        // Start YARN mini cluster
        File miniDFSDir = tmpFolder.newFolder();
        LOG.info("Starting Mini DFS on path {}", miniDFSDir);
        Configuration fsConf = new HdfsConfiguration(new Configuration());
        fsConf.set(MiniDFSCluster.HDFS_MINIDFS_BASEDIR, miniDFSDir.getAbsolutePath());
        dfsCluster = new MiniDFSCluster.Builder(fsConf).numDataNodes(1).build();

        Configuration conf = new YarnConfiguration(dfsCluster.getFileSystem().getConf());

        if (YarnUtils.getHadoopVersion().equals(YarnUtils.HadoopVersions.HADOOP_20)) {
            conf.set("yarn.resourcemanager.scheduler.class",
                    "org.apache.hadoop.yarn.server.resourcemanager.scheduler.fifo.FifoScheduler");
        } else {
            conf.set("yarn.resourcemanager.scheduler.class",
                    "org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CapacityScheduler");
            conf.set("yarn.scheduler.capacity.resource-calculator",
                    "org.apache.hadoop.yarn.util.resource.DominantResourceCalculator");
            conf.setBoolean("yarn.scheduler.include-port-in-node-name", true);
        }
        conf.set("yarn.nodemanager.vmem-pmem-ratio", "20.1");
        conf.set("yarn.nodemanager.vmem-check-enabled", "false");
        conf.set("yarn.scheduler.minimum-allocation-mb", "128");
        conf.set("yarn.nodemanager.delete.debug-delay-sec", "3600");

        cluster = new MiniYARNCluster("test-cluster", 3, 1, 1);
        cluster.init(conf);
        cluster.start();

        this.config = new YarnConfiguration(cluster.getConfig());

        twillRunner = createTwillRunnerService();
        twillRunner.start();

        yarnAppClient = new VersionDetectYarnAppClientFactory().create(conf);
        yarnAppClient.startAndWait();
    }

    @Override
    protected void after() {
        stopQuietly(yarnAppClient);
        try {
            twillRunner.stop();
        } catch (Exception e) {
            LOG.warn("Failed to stop TwillRunner", e);
        }
        try {
            cluster.stop();
        } catch (Exception e) {
            LOG.warn("Failed to stop mini Yarn cluster", e);
        }
        try {
            dfsCluster.shutdown();
        } catch (Exception e) {
            LOG.warn("Failed to stop mini dfs cluster", e);
        }
        stopQuietly(zkServer);

        tmpFolder.delete();
    }

    /**
     * Creates an unstarted instance of {@link org.apache.twill.api.TwillRunnerService}.
     */
    public TwillRunnerService createTwillRunnerService() throws IOException {
        YarnTwillRunnerService runner = new YarnTwillRunnerService(config, zkServer.getConnectionStr() + "/twill");
        // disable tests stealing focus
        runner.setJVMOptions("-Djava.awt.headless=true");
        return runner;
    }

    /**
     * Returns a {@link TwillRunner} that interact with the mini Yarn cluster.
     */
    public TwillRunner getTwillRunner() {
        return twillRunner;
    }

    /**
     * Returns a list of {@link NodeReport} about the mini yarn cluster.
     */
    public List<NodeReport> getNodeReports() throws Exception {
        return yarnAppClient.getNodeReports();
    }

    public String getZKConnectionString() {
        return zkServer.getConnectionStr();
    }

    private void stopQuietly(Service service) {
        try {
            service.stopAndWait();
        } catch (Exception e) {
            LOG.warn("Failed to stop service {}.", service, e);
        }
    }
}