org.apache.heron.integration_test.common.AbstractTestTopology.java Source code

Introduction

Here is the source code for org.apache.heron.integration_test.common.AbstractTestTopology.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.heron.integration_test.common;

import java.net.MalformedURLException;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.heron.api.Config;
import org.apache.heron.api.HeronSubmitter;
import org.apache.heron.api.exception.AlreadyAliveException;
import org.apache.heron.api.exception.InvalidTopologyException;
import org.apache.heron.integration_test.core.TestTopologyBuilder;

/**
 * Class to abstract out the common parts of the test framework for submitting topologies.
 * Subclasses can implement {@code buildTopology} and call {@code submit}.
 */
public abstract class AbstractTestTopology {
    private static final String TOPOLOGY_OPTION = "topology_name";
    private static final String RESULTS_URL_OPTION = "results_url";
    private static final String STATE_URL_OPTION = "test_state_url";
    private static final String STATE_UPDATE_TOKEN = "state_server_update_token";
    private static final String SPOUT_WRAPPER_TOKEN = "spout_wrapper_token";

    private final CommandLine cmd;
    private final String httpServerResultsUrl;
    private final String httpServerStateUrl;
    private final String topologyName;
    private final String stateUpdateToken;
    private final TestTopologyBuilder.SpoutWrapperType spoutWrapperType;

    protected AbstractTestTopology(String[] args) throws MalformedURLException {
        CommandLineParser parser = new DefaultParser();
        HelpFormatter formatter = new HelpFormatter();
        Options options = getArgOptions();

        try {
            cmd = parser.parse(options, args);
        } catch (ParseException e) {
            formatter.setWidth(120);
            formatter.printHelp("java " + getClass().getCanonicalName(), options, true);
            throw new RuntimeException(e);
        }

        this.topologyName = cmd.getOptionValue(TOPOLOGY_OPTION);
        this.httpServerResultsUrl = pathAppend(cmd.getOptionValue(RESULTS_URL_OPTION), this.topologyName);
        this.httpServerStateUrl = pathAppend(cmd.getOptionValue(STATE_URL_OPTION), this.topologyName);
        this.stateUpdateToken = cmd.getOptionValue(STATE_UPDATE_TOKEN);
        if (cmd.getOptionValue(SPOUT_WRAPPER_TOKEN) != null) {
            this.spoutWrapperType = TestTopologyBuilder.SpoutWrapperType
                    .valueOf(cmd.getOptionValue(SPOUT_WRAPPER_TOKEN).toUpperCase());
        } else {
            this.spoutWrapperType = TestTopologyBuilder.SpoutWrapperType.DEFAULT;
        }
    }

    protected abstract TestTopologyBuilder buildTopology(TestTopologyBuilder builder);

    protected Config buildConfig(Config config) {
        return config;
    }

    protected CommandLine getCommandLine() {
        return this.cmd;
    }

    protected Options getArgOptions() {
        Options options = new Options();

        Option topologyNameOption = new Option("t", TOPOLOGY_OPTION, true, "topology name");
        topologyNameOption.setRequired(true);
        options.addOption(topologyNameOption);

        Option resultsUrlOption = new Option("r", RESULTS_URL_OPTION, true, "url to post and get test data");
        resultsUrlOption.setRequired(true);
        options.addOption(resultsUrlOption);

        Option stateUrlOption = new Option("s", STATE_URL_OPTION, true, "url to post and get test state info");
        stateUrlOption.setRequired(true);
        options.addOption(stateUrlOption);

        Option stateTokenOption = new Option("u", STATE_UPDATE_TOKEN, true,
                "state server token to use for spout http condition triggers");
        stateTokenOption.setRequired(false);
        options.addOption(stateTokenOption);

        Option spoutWrapperOption = new Option("S", SPOUT_WRAPPER_TOKEN, true, "What type of spout wrapper to use");
        spoutWrapperOption.setType(TestTopologyBuilder.SpoutWrapperType.class);
        spoutWrapperOption.setRequired(false);
        options.addOption(spoutWrapperOption);

        return options;
    }

    public final void submit() throws AlreadyAliveException, InvalidTopologyException {
        this.submit(null);
    }

    public final void submit(Config userConf) throws AlreadyAliveException, InvalidTopologyException {
        TestTopologyBuilder builder = new TestTopologyBuilder(httpServerResultsUrl, httpServerStateUrl,
                stateUpdateToken, spoutWrapperType);

        Config conf = buildConfig(new BasicConfig());
        if (userConf != null) {
            conf.putAll(userConf);
        }
        HeronSubmitter.submitTopology(topologyName, conf, buildTopology(builder).createTopology());
    }

    private static String pathAppend(String url, String path) {
        return String.format("%s/%s", url, path);
    }
}