org.apache.flink.tests.util.flink

Interface FlinkResource

All Superinterfaces:

ExternalResource, org.junit.rules.TestRule

All Known Implementing Classes:

LocalStandaloneFlinkResource

public interface FlinkResource
extends ExternalResource

Generic interface for interacting with Flink.

Method Summary

Modifier and Type	Method and Description
static FlinkResource	get() Returns the configured FlinkResource implementation, or a LocalStandaloneFlinkResource if none is configured.
static FlinkResource	get(FlinkResourceSetup setup) Returns the configured FlinkResource implementation, or a LocalStandaloneFlinkResource if none is configured.
java.util.stream.Stream<String>	searchAllLogs(Pattern pattern, java.util.function.Function<Matcher,String> matchProcessor) Searches the logs of all processes for the given pattern, and applies the given processor for every line for which Matcher.matches() returned true.
ClusterController	startCluster(int numTaskManagers) Starts a cluster.
GatewayController	startSqlGateway() Starts a sqlserver and returns the GatewayController which can be used to shut down the process.

Methods inherited from interface org.apache.flink.util.ExternalResource

afterTestFailure, afterTestSuccess, apply, before

Method Detail

startCluster

ClusterController startCluster(int numTaskManagers)
                        throws IOException

Starts a cluster.

The exact constellation of the cluster is undefined.

In the case of per-job clusters this method may not start any Flink processes, deferring this to ClusterController.submitJob(JobSubmission, Duration).

Parameters:

numTaskManagers - number of task managers

Returns:

controller for interacting with the cluster

Throws:

IOException

startSqlGateway

GatewayController startSqlGateway()
                           throws IOException

Starts a sqlserver and returns the GatewayController which can be used to shut down the process.

Returns:

controller for interacting with the cluster

Throws:

IOException

searchAllLogs

java.util.stream.Stream<String> searchAllLogs(Pattern pattern,
                                              java.util.function.Function<Matcher,String> matchProcessor)
                                       throws IOException

Searches the logs of all processes for the given pattern, and applies the given processor for every line for which Matcher.matches() returned true.

Parameters:

pattern - pattern to search for

matchProcessor - match processor

Returns:

stream of matched strings

Throws:

IOException

get

static FlinkResource get()

Returns the configured FlinkResource implementation, or a LocalStandaloneFlinkResource if none is configured.

Returns:

configured FlinkResource, or LocalStandaloneFlinkResource is none is configured

get

static FlinkResource get(FlinkResourceSetup setup)

Returns the configured FlinkResource implementation, or a LocalStandaloneFlinkResource if none is configured.

Parameters:

setup - setup instructions for the FlinkResource

Returns:

configured FlinkResource, or LocalStandaloneFlinkResource is none is configured