kafka flink sql flink hive flink 单元测试 flink 实时计算 50、Flink的单元测试介绍及示例

Flink 系列文章

一、Flink 专栏

Flink 专栏系统介绍某一知识点，并辅以具体的示例进行说明。

1、Flink 部署系列 本部分介绍Flink的部署、配置相关基础内容。 2、Flink基础系列 本部分介绍Flink 的基础部分，比如术语、架构、编程模型、编程指南、基本的datastream api用法、四大基石等内容。 3、Flik Table API和SQL基础系列 本部分介绍Flink Table Api和SQL的基本用法，比如Table API和SQL创建库、表用法、查询、窗口函数、catalog等等内容。 4、Flik Table API和SQL提高与应用系列 本部分是table api 和sql的应用部分，和实际的生产应用联系更为密切，以及有一定开发难度的内容。 5、Flink 监控系列 本部分和实际的运维、监控工作相关。

二、Flink 示例专栏

Flink 示例专栏是 Flink 专栏的辅助说明，一般不会介绍知识点的信息，更多的是提供一个一个可以具体使用的示例。本专栏不再分目录，通过链接即可看出介绍的内容。

两专栏的所有文章入口点击：Flink 系列文章汇总索引

文章目录

Flink 系列文章一、Flink测试概述二、测试用户自定义函数1、单元测试无状态、无时间限制的 UDF1）、示例-mapFunction2）、示例-flatMapFunction

2、对有状态或及时 UDF 和自定义算子进行单元测试1）、DataStream API 测试依赖2）、Table API 测试依赖3）、flatmap function 单元测试4）、Process Function 单元测试

三、测试 Flink 作业1、JUnit 规则 MiniClusterWithClientResource

本文详细的介绍了Flink的单元测试，分为有状态、无状态以及作业的测试，特别是针对无状态的单元测试给出了常见的使用示例。

如果需要了解更多内容，可以在本人Flink 专栏中了解更新系统的内容。

本文除了maven依赖外，没有其他依赖。

一、Flink测试概述

Apache Flink 同样提供了在测试金字塔的多个级别上测试应用程序代码的工具。 本文示例的maven依赖

UTF-8

UTF-8

1.8

1.8

1.8

2.12

1.17.0

org.apache.flink

flink-clients

${flink.version}

provided

org.apache.flink

flink-java

${flink.version}

provided

org.apache.flink

flink-streaming-java

${flink.version}

provided

org.apache.flink

flink-csv

${flink.version}

provided

org.apache.flink

flink-json

${flink.version}

provided

junit

junit

4.13

org.mockito

mockito-core

4.0.0

test

二、测试用户自定义函数

可以假设 Flink 在用户自定义函数之外产生了正确的结果。因此，建议尽可能多的用单元测试来测试那些包含主要业务逻辑的类。

1、单元测试无状态、无时间限制的 UDF

1）、示例-mapFunction

以下无状态的 MapFunction 为例

public class IncrementMapFunction implements MapFunction {

@Override

public Long map(Long record) throws Exception {

return record + 1;

}

}

通过传递合适地参数并验证输出，可以很容易的使用你喜欢的测试框架对这样的函数进行单元测试。

import static org.junit.Assert.assertEquals;

import org.apache.flink.api.common.functions.MapFunction;

import org.junit.Test;

/**

* @author alanchan

*

*/

public class TestDemo {

public class IncrementMapFunction implements MapFunction {

@Override

public Long map(Long record) throws Exception {

return record + 1;

}

}

@Test

public void testIncrement() throws Exception {

IncrementMapFunction incrementer = new IncrementMapFunction();

assertEquals((Long) 3L, incrementer.map(2L));

}

}

2）、示例-flatMapFunction

对于使用 org.apache.flink.util.Collector 的用户自定义函数（例如FlatMapFunction 或者 ProcessFunction），可以通过提供模拟对象而不是真正的 collector 来轻松测试。具有与 IncrementMapFunction 相同功能的 FlatMapFunction 可以按照以下方式进行单元测试。

import static org.mockito.Mockito.mock;

import static org.mockito.Mockito.times;

import org.apache.flink.api.common.functions.FlatMapFunction;

import org.apache.flink.util.Collector;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.mockito.Mockito;

import org.mockito.junit.MockitoJUnitRunner;

/**

* @author alanchan

*

*/

@RunWith(MockitoJUnitRunner.class)

public class TestDemo2 {

public static class IncrementFlatMapFunction implements FlatMapFunction {

@Override

public void flatMap(String value, Collector out) throws Exception {

Long sum = 0L;

for (String num : value.split(",")) {

sum += Long.valueOf(num);

}

out.collect(sum);

}

}

@Test

public void testSum() throws Exception {

IncrementFlatMapFunction incrementer = new IncrementFlatMapFunction();

Collector collector = mock(Collector.class);

incrementer.flatMap("1,2,3,4,5", collector);

Mockito.verify(collector, times(1)).collect(15L);

}

}

2、对有状态或及时 UDF 和自定义算子进行单元测试

对使用管理状态或定时器的用户自定义函数的功能测试会更加困难，因为它涉及到测试用户代码和 Flink 运行时的交互。 为此，Flink 提供了一组所谓的测试工具，可用于测试用户自定义函数和自定义算子：

OneInputStreamOperatorTestHarness (适用于 DataStream 上的算子)KeyedOneInputStreamOperatorTestHarness (适用于 KeyedStream 上的算子)TwoInputStreamOperatorTestHarness (f适用于两个 DataStream 的 ConnectedStreams 算子)KeyedTwoInputStreamOperatorTestHarness (适用于两个 KeyedStream 上的 ConnectedStreams 算子)

要使用测试工具，还需要一组其他的依赖项，比如DataStream和TableAPI的依赖。

1）、DataStream API 测试依赖

如果要为使用 DataStream API 构建的作业开发测试用例，则需要添加以下依赖项：

org.apache.flink

flink-test-utils

1.17.2

test

在各种测试实用程序中，该模块提供了 MiniCluster （一个可配置的轻量级 Flink 集群，能在 JUnit 测试中运行），可以直接执行作业。

2）、Table API 测试依赖

如果您想在您的 IDE 中本地测试 Table API 和 SQL 程序，除了前述提到的 flink-test-utils 之外，您还要添加以下依赖项：

org.apache.flink

flink-table-test-utils

1.17.2

test

这将自动引入查询计划器和运行时，分别用于计划和执行查询。

flink-table-test-utils 模块已在 Flink 1.15 中引入，截至Flink 1.17版本被认为是实验性的。

3）、flatmap function 单元测试

现在，可以使用测试工具将记录和 watermark 推送到用户自定义函数或自定义算子中，控制处理时间，最后对算子的输出（包括旁路输出）进行校验。

示例如下

/*

* @Author: alanchan

* @LastEditors: alanchan

* @Description: 单元测试flatmap，如果是偶数则存储原值及平方数

*/

import java.util.concurrent.ConcurrentLinkedQueue;

import org.apache.flink.api.common.functions.FlatMapFunction;

import org.apache.flink.streaming.api.operators.StreamFlatMap;

import org.apache.flink.streaming.api.watermark.Watermark;

import org.apache.flink.streaming.runtime.streamrecord.StreamRecord;

import org.apache.flink.streaming.util.OneInputStreamOperatorTestHarness;

import org.apache.flink.streaming.util.TestHarnessUtil;

import org.apache.flink.util.Collector;

import org.junit.Before;

import org.junit.Test;

public class TestStatefulFlatMapDemo3 {

static class AlanFlatMapFunction implements FlatMapFunction {

@Override

public void flatMap(Integer value, Collector out) throws Exception {

if (value % 2 == 0) {

out.collect(value);

out.collect(value * value);

}

}

}

OneInputStreamOperatorTestHarness testHarness;

@Before

public void setupTestHarness() throws Exception {

StreamFlatMap operator = new StreamFlatMap(new AlanFlatMapFunction());

testHarness = new OneInputStreamOperatorTestHarness(operator);

testHarness.open();

}

@Test

public void testFlatMap2() throws Exception {

long initialTime = 0L;

ConcurrentLinkedQueue