/*
* 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.flink.streaming.util;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.runtime.minicluster.LocalFlinkMiniCluster;
import org.apache.flink.test.util.AbstractTestBase;
import org.apache.flink.test.util.TestBaseUtils;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Base class for streaming unit tests that run multiple tests and want to reuse the same
* Flink cluster. This saves a significant amount of time, since the startup and
* shutdown of the Flink clusters (including actor systems, etc) usually dominates
* the execution of the actual tests.
*
* To write a unit test against this test base, simply extend it and add
* one or more regular test methods and retrieve the StreamExecutionEnvironment from
* the context:
*
* <pre>
* {@literal @}Test
* public void someTest() {
* StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
* // test code
* env.execute();
* }
*
* {@literal @}Test
* public void anotherTest() {
* StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
* // test code
* env.execute();
* }
*
* </pre>
*/
public class StreamingMultipleProgramsTestBase extends AbstractTestBase {
// ------------------------------------------------------------------------
// The mini cluster that is shared across tests
// ------------------------------------------------------------------------
protected static final int DEFAULT_PARALLELISM = 4;
protected static LocalFlinkMiniCluster cluster;
public StreamingMultipleProgramsTestBase() {
super(new Configuration());
}
protected static final Logger LOG = LoggerFactory.getLogger(StreamingMultipleProgramsTestBase.class);
// ------------------------------------------------------------------------
// Cluster setup & teardown
// ------------------------------------------------------------------------
@BeforeClass
public static void setup() throws Exception {
LOG.info("In StreamingMultipleProgramsTestBase: Starting FlinkMiniCluster ");
cluster = TestBaseUtils.startCluster(1, DEFAULT_PARALLELISM, false, false, true);
TestStreamEnvironment.setAsContext(cluster, DEFAULT_PARALLELISM);
}
@AfterClass
public static void teardown() throws Exception {
LOG.info("In StreamingMultipleProgramsTestBase: Closing FlinkMiniCluster ");
TestStreamEnvironment.unsetAsContext();
stopCluster(cluster, TestBaseUtils.DEFAULT_TIMEOUT);
}
}