史上最轻量​!阿里新型单元测试 Mock 工具开源

汇总阿里 Mock 工具正式开源,干掉市面上所有 Mock 工具! 最近栈长注意到阿里开源了自家的 Mock 工具:TestableMock,该工具号称最轻量、简单、舒适的 Mock 测试工具,功能十分强大,媲美 PowerMock,用法比 Mockito 还要简洁,还不挑框架,指哪换哪,一个 @MockMethod 注解打天下。。。 这么强大的么?栈长赶紧来体验一翻! TestableMock 简介 TestableMock 开源地址: https://github.com/alibaba/testable-mock TestableMock 在 2020 年 12 月开 阅读详情

点击上方“芋道源码”,选择“设为星标”

管她前浪,还是后浪?

能浪的浪,才是好浪!

每天 8:55 更新文章,每天掉亿点点头发...

源码精品专栏

 

来源:gitee.com/mirrors/TestableMock


TestableMock是基于源码和字节码增强的Java单元测试辅助工具,包含以下功能:

  • 访问被测类私有成员:使单元测试能直接调用和访问被测类的私有成员,解决私有成员初始化和私有方法测试的问题

  • 快速Mock任意调用:使被测类的任意方法调用快速替换为Mock方法,实现"指哪换哪",解决传统Mock工具使用繁琐的问题

  • 辅助测试void方法:利用Mock校验器对方法的内部逻辑进行检查,解决无返回值方法难以实施单元测试的问题

访问私有成员字段和方法

如今关于私有方法是否应该做单元测试的争论正逐渐消停,开发者的普遍实践已经给出事实答案。通过公有方法间接测私有方法在很多情况下难以进行,开发者们更愿意通过修改方法可见性的办法来让原本私有的方法在测试用例中变得可测。

此外,在单元测试中时常会需要对被测对象进行特定的成员字段初始化,但有时由于被测类的构造方法限制,使得无法便捷的对这些字段进行赋值。那么,能否在不破坏被测类型封装的情况下,允许单元测试用例内的代码直接访问被测类的私有方法和成员字段呢?TestableMock提供了两种简单的解决方案。

方法一:使用@EnablePrivateAccess注解

只需为测试类添加@EnablePrivateAccess注解,即可在测试用例中获得以下增强能力:

  • 调用被测类的私有方法(包括静态方法)

  • 读取被测类的私有字段(包括静态字段)

  • 修改被测类的私有字段(包括静态字段)

  • 修改被测类的常量字段(使用final修饰的字段,包括静态字段)

访问和修改私有、常量成员时,IDE可能会提示语法有误,但编译器将能够正常运行测试。(使用编译期代码增强,目前仅实现了Java语言的适配)

效果见java-demo示例项目DemoPrivateAccessTest测试类中的用例。

方法二:使用PrivateAccessor工具类

若不希望看到IDE的语法错误提醒,或是在非Java语言的JVM工程(譬如Kotlin语言)里,也可以借助PrivateAccessor工具类来直接访问私有成员。

这个类提供了6个静态方法:

  • PrivateAccessor.get(被测对象, "私有字段名") ➜ 读取被测类的私有字段

  • PrivateAccessor.set(被测对象, "私有字段名", 新的值) ➜ 修改被测类的私有字段(或常量字段)

  • PrivateAccessor.invoke(被测对象, "私有方法名", 调用参数..) ➜ 调用被测类的私有方法

  • PrivateAccessor.getStatic(被测类型, "私有静态字段名") ➜ 读取被测类的静态 私有字段

  • PrivateAccessor.setStatic(被测类型, "私有静态字段名", 新的值)➜ 修改被测类的静态 私有字段(或静态 常量字段)

  • PrivateAccessor.invokeStatic(被测类型, "私有静态方法名", 调用参数..) ➜ 调用被测类的静态 私有方法

快速Mock被测类的任意方法调用

相比以往Mock工具以类为粒度的Mock方式,TestableMock允许用户直接定义需要Mock的单个方法,并遵循约定优于配置的原则,按照规则自动在测试运行时替换被测方法中的指定方法调用。

归纳起来就两条:

  • Mock非构造方法,拷贝原方法定义到测试类,增加一个与调用者类型相同的参数,加@MockMethod注解

  • Mock构造方法,拷贝原方法定义到测试类,返回值换成构造的类型,方法名随意,加@MockContructor注解

具体的Mock方法定义约定如下:

1. 覆写任意类的方法调用

在测试类里定义一个有@MockMethod注解的普通方法,使它与需覆写的方法名称、参数、返回值类型完全一致,然后在其参数列表首位再增加一个类型为该方法原本所属对象类型的参数。

此时被测类中所有对该需覆写方法的调用,将在单元测试运行时,将自动被替换为对上述自定义Mock方法的调用。

注意 :当遇到待覆写方法有重名时,可以将需覆写的方法名写到@MockMethod注解的targetMethod参数里,这样Mock方法自身就可以随意命名了。

例如,被测类中有一处"anything".substring(1, 2)调用,我们希望在运行测试的时候将它换成一个固定字符串,则只需在测试类定义如下方法:

// 原方法签名为`String substring(int, int)`
// 调用此方法的对象`"anything"`类型为`String`
// 则Mock方法签名在其参数列表首位增加一个类型为`String`的参数(名字随意)
// 此参数可用于获得当时的实际调用者的值和上下文
@MockMethod
private String substring(String self, int i, int j) {
    return "sub_string";
}

下面这个例子展示了targetMethod参数的用法,其效果与上述示例相同:

// 使用`targetMethod`指定需Mock的方法名
// 此方法本身现在可以随意命名,但方法参数依然需要遵循相同的匹配规则
@MockMethod(targetMethod = "substring")
private String use_any_mock_method_name(String self, int i, int j) {
    return "sub_string";
}

完整代码示例见java-demo和kotlin-demo示例项目中的should_able_to_mock_common_method()测试用例。(由于Kotlin对String类型进行了魔改,故Kotlin示例中将被测方法在BlackBox类里加了一层封装)

2. 覆写被测类自身的成员方法

有时候,在对某些方法进行测试时,希望将被测类自身的另外一些成员方法Mock掉。

操作方法与前一种情况相同,Mock方法的第一个参数类型需与被测类相同,即可实现对被测类自身(不论是公有或私有)成员方法的覆写。

例如,被测类中有一个签名为String innerFunc(String)的私有方法,我们希望在测试的时候将它替换掉,则只需在测试类定义如下方法:

// 被测类型是`DemoMock`
// 因此在定义Mock方法时,在目标方法参数首位加一个类型为`DemoMock`的参数(名字随意)
@MockMethod
private String innerFunc(DemoMock self, String text) {
    return "mock_" + text;
}

3. 覆写任意类的静态方法

对于静态方法的Mock与普通方法相同。但需要注意的是,静态方法的Mock方法被调用时,传入的第一个参数实际值始终是null。

例如,在被测类中调用了BlackBox类型中的静态方法secretBox(),改方法签名为BlackBox secretBox(),则Mock方法如下:

// 目标静态方法定义在`BlackBox`类型中
// 在定义Mock方法时,在目标方法参数首位加一个类型为`BlackBox`的参数(名字随意)
// 此参数仅用于标识目标类型,实际传入值将始终为`null`
@MockMethod
private BlackBox secretBox(BlackBox ignore) {
    return new BlackBox("not_secret_box");
}

完整代码示例见java-demo和kotlin-demo示例项目中的should_able_to_mock_static_method()测试用例。

测试无返回值的方法

如何对void类型的方法进行测试一直是许多单元测试框架在悄悄回避的话题,由于以往的单元测试手段主要是对被测单元的返回结果进行校验,当遇到方法没有返回值时就会变得无从下手。

从功能的角度来说,虽然void方法不返回任何值,但它的执行一定会对外界产生某些潜在影响,我们将其称为方法的"副作用",比如:

  1. 初始化某些外部变量(私有成员变量或者全局静态变量)

  2. 在方法体内对外部对象实例进行赋值

  3. 输出了日志

  4. 调用了其他外部方法

  5. … …

不返回任何值也不产生任何"副作用"的方法没有存在的意义。

这些"副作用"的本质归纳来说可分为两类:修改外部变量 和调用外部方法 。

通过TestableMock的私有字段访问和Mock校验器可以很方便的实现对"副作用"的结果检查。

1. 修改外部变量的void方法

例如,下面这个方法会根据输入修改私有成员变量hashCache:

class Demo {
    private Map<String, Integer> hashCache = mapOf();

    public void updateCache(String domain, String key) {
        String cacheKey = domain + "::" + key;
        Integer num = hashCache.get(cacheKey);
        hashCache.put(cacheKey, count == null ? initHash(key) : nextHash(num, key));
    }

    ... // 其他方法省略
}

若要测试此方法,可以利用TestableMock直接读取私有成员变量的值,对结果进行校验:

@EnablePrivateAccess  // 启用TestableMock的私有成员访问功能
class DemoTest {
    private Demo demo = new Demo();

    @Test
    public void testSaveToCache() {
        Integer firstVal = demo.initHash("hello"); // 访问私有方法
        Integer nextVal = demo.nextHash(firstVal, "hello"); // 访问私有方法
        demo.saveToCache("demo", "hello");
        assertEquals(firstVal, demo.hashCache.get("demo::hello")); // 读取私有变量
        demo.saveToCache("demo", "hello");
        assertEquals(nextVal, demo.hashCache.get("demo::hello")); // 读取私有变量
    }
}

2. 调用外部方法的void方法

例如,下面这个方法会根据输入打印信息到控制台:

class Demo {
    public void recordAction(Action action) {
        SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss ");
        String timeStamp = df.format(new Date());
        System.out.println(timeStamp + "[" + action.getType() + "] " + action.getTarget());
    }
}

若要测试此方法,可以利用TestableMock快速Mock掉System.out.println方法。在Mock方法体里可以继续执行原调用(相当于并不影响本来方法功能,仅用于做调用记录),也可以直接留空(相当于去除了原方法的副作用)。

在执行完被测的void类型方法以后,用InvokeVerifier.verify()校验传入的打印内容是否符合预期:

class DemoTest {
    private Demo demo = new Demo();

    // 拦截`System.out.println`调用
    @MockMethod
    public void println(PrintStream ps, String msg) {
        // 执行原调用
        ps.println(msg);
    }

    @Test
    public void testRecordAction() {
        Action action = new Action("click", ":download");
        demo.recordAction();
        // 验证Mock方法`println`被调用,且传入参数符合预期
        verify("println").with(matches("\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2} \\[click\\] :download"));
    }
}

项目地址

开源地址:https://gitee.com/mirrors/TestableMock

关注「芋道源码」公 众 号,回复 "mock" ,查看该 mock 工具介绍使用文档

二维码


欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢:

已在知识星球更新源码解析如下:

最近更新《芋道 SpringBoot 2.X 入门》系列,已经 20 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。

提供近 3W 行代码的 SpringBoot 示例,以及超 4W 行代码的电商微服务项目。

获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。

兄弟,艿一口,点个赞!????

告别繁琐Mock配置:阿里TestableMock如何用注解重构单元测试 本文深入解析阿里开源的TestableMock如何通过注解简化单元测试流程,显著提升开发效率。通过@EnablePrivateAccess、@MockMethod等核心注解,开发者无需复杂配置即可轻松测试私有方法、Mock静态方法和构造方法,相比传统Mock工具减少80%代码量。TestableMock与JUnit、Spring Boot等主流框架完美兼容,是Java单元测试领域的革命性工具。 阅读详情

相关推荐

基于ProXmoX VE的虚拟化家庭服务器(篇一)—ProXmoX VE 安装及基础配置

ProxmoxVE是一款套开源的虚拟化管理软件,用户可通过网页的方式来管理服务器上使用kvm以及lxc技术运行的虚拟机。同时提供了一些先进功能的支持,如集群、HA等。PVE虽然是开源,却是由一个商业公司在运营、更新以及维护。...

隔壁老瓦的专栏 6323

Spring源码深度解析(郝佳)-学习-字符串值解析-parseStringValue

在Spring中有一个这样的工具方法,比如在xml 中的EL 表达式解析,资源加载,@Value注解内容解析,等都用到了一个重要的工具类方法 parseStringValue() 我们先来写一个main方法测试一下 import org.springframework.util.PropertyPlaceholderHelper; import org.springframework.util.StringUtils; import java.util.HashMap; import java.util.

黄裳博客 1101

高通Camx架构调试不求人:手把手教你开UMD/KMD Log与Dump图像(附离线Log合成脚本)

本文详细介绍了高通Camx架构的调试方法,包括UMD/KMD Log的精准配置与图像Dump技术,帮助工程师快速定位移动影像系统中的问题。通过实战案例和自动化脚本,提升调试效率,适用于图像色彩异常、帧率波动等常见问题的诊断与解决。

weixin_30516243的博客 254

Spring配置文件对于占位符 ${} 的解析源码分析

1. 前言 由于公司新项目的搭建,而且选择了 spring boot,对于 spring boot 其中的好处就是我们无需在为其配置大量的 XML,完全可以基于注解的方式来进行配置,但也没有完全采用 java config 配置,至少在我们项目中是结合起来用的,比如 dubbo 的配置等等。 1.1 第一阶段:xml配置 在spring 1.x时代,使用spring开发满眼都是xml配置的bean,随着项目的扩大,我们需要把xml配置文件分放到不同的配置文件中,那时候需要频繁地在开发的类和配置文件间切换。

个人站点:javatv.net 6978

【TI毫米波雷达】IWR6843AOPEVM-G与DCA1000EVM实战:从硬件连接到数据流解析

本文详细解析了TI毫米波雷达开发套件IWR6843AOPEVM-G与DCA1000EVM的硬件连接、模式配置及数据流处理全流程。针对官方手册中的常见配置错误,提供了避坑指南和实测验证的正确设置方法,包括开关配置、网络参数等关键步骤。通过mmWave Studio软件配置雷达参数,并深入解析数据采集与处理流程,帮助开发者高效实现毫米波雷达应用开发。

weixin_30653023的博客 368

ANSYS 12.1避坑全记录:当Win7+VMware14遇到FLEXlm报错时的自救指南

本文详细介绍了在Windows 7和VMware14环境下安装和运行ANSYS 12.1时遇到的FLEXlm报错问题及其解决方案。通过虚拟机技术隔离时间同步问题,提供从环境配置到许可证管理的完整指南,帮助用户稳定运行这一老旧版本的工程仿真软件。

tt34567的博客 648

Spring 中 @Value 注解使用和源码分析

先配置本地可以看到最终在 Apple 中可以获取到配置文件中的值,那么 Spring 是怎样解析获取到该值的呢?下面开始分析下。

龚小帅的博客 2934

GEPA_AIME教程:使用GEPA优化数学问题求解的完整指南

本教程展示了如何使用DSPy框架中的GEPA(Generative Evolutionary Prompt Adaptation)优化器来提升大语言模型在数学竞赛问题(AIME)上的表现。# 创建基础的链式思考程序"""带有详细反馈的评估指标,为GEPA提供学习信号"""try:# 处理解析错误feedback_text = f"最终答案必须是一个有效的整数。你回答了'

步子哥的博客 1388

spring之PropertySourcesPlaceholdersResolver

Spring Boot 占位符解析原理分析

CangLangJiangHu的博客 917

【DRAM存储器二】Sense Amplifier

详述DRAM颗粒中感应放大器功能、电路结构、工作原理和操作波形

highman110的博客 7212

Yocto开发讲解系列 - 总目录

Yocto开发讲解系列总纲Yocto开发专栏前言

fulinux的博客 3万+

Spring源码(五):PropertySourcesPropertyResolver属性源属性解析器

在使用spring时,为了方便对某些参数值进行修改,会将参数以键值对的形式写在配置文件中,在Java代码中通过key来获取配置文件中的value。那么,spring是如何知道哪些参数的值需要从配置文件获取并进行替换的呢?答案就是使用占位符。例如:使用${key}作为占位符时,当spring在解析属性时碰到${key},就会用占位符中的key,获取对应的value,并将${key}替换为value。

weixin_44843569的博客 1455

Devexpress16.2.6破解工具

Devexpress16.2.6破解工具Devexpress16.2.6破解工具Devexpress16.2.6破解工具Devexpress16.2.6破解工具

史上最轻量​!阿里新型单元测试Mock工具开源了

简介:为了探索更轻量易用的Mock测试手段,阿里云云效团队尝试给工具减负,在主流Mock工具的基础上让Mock的定义和置换干净利落,最终设计了一款极简风格的测试辅助工具TestableMock,无需初始化,不挑测试框架,无论要换的是私有方法、静态方法、构造方法还是其他任何类的任何方法,也无需关注要换的对象是怎么创建的,只要写好Mock定义,加个@MockMethod注解,就能统统搞定。本文分享TestableMock的实现原理。最简单舒适的Mock测试应该是怎样的?指着源文件调用了外部依赖的那行代码说:“你

阿里云开发者 4952

数学建模模型总结

这是本人在两年内准备参加数学建模竞赛搜集到的模型资料,已经经过了本人的筛选和整理,希望能够对准备参加数学建模竞赛的学弟学妹们提供一些帮助!

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面,电脑运行连游戏界面都一样大小,很怀旧,很真实,(英文版)强烈推荐,很小的文件,很难才找到的。

史上最轻量​!阿里新型单元测试Mock工具开源了(深度好文)

最简单舒适的Mock测试应该是怎样的? 指着源文件调用了外部依赖的那行代码说: “你,在测试的时候,换成这个假的调用!” 结束。 甭管他是私有方法、静态方法,还是别的类的方法,直接换掉,不要有任何多余动作。 一 Mock测试八股文 Java的Mock工具伴随着单元测试技术不断迭代发展,可谓前仆后继、历久弥新,虽然原理各不相同,但核心的使用模式却几乎没发生过多少变化。不论是当下流行的Mockito和PowerMock,或是曾经著名的JMockit、EasyMock、MockRunner等等,基本使用套路都

测试萌萌 867

IMSL CNL 7.0.0 (x86-64)Crack

IMSL CNL 7.0.0 (x86-64)Crack intel的算法库破解文件,这是C++版本的破解文件

测试私有方法_史上最轻量!阿里开源了新型单元测试Mock工具

点击上方蓝色字体,选择“设为星标”回复”666“获取面试宝典TestableMock是基于源码和字节码增强的Java单元测试辅助工具,包含以下功能:访问被测类私有成员:使单元测试能直接调用和访问被测类的私有成员,解决私有成员初始化和私有方法测试的问题快速Mock任意调用:使被测类的任意方法调用快速替换为Mock方法,实现"指哪换哪",解决传统Mock工具使用繁琐的问题辅助测试void方法...

weixin_39760967的博客 504

阿里TestableMock正式开源,最容易上手的 Mock 工具。

最近栈长注意到阿里开源了自家的 Mock 工具:TestableMock,该工具号称最轻量、简单、舒适的 Mock 测试工具,功能十分强大,媲美 PowerMock,用法比 Mockito 还要简洁,还不挑框架,指哪换哪,一个 @MockMethod 注解打天下。。。 这么强大的么?栈长赶紧来体验一翻! TestableMock 简介 TestableMock 开源地址: https://github.com/alibaba/testable-mock TestableMock 在 202

lisheng19870305的专栏 4487

阿里 Mock 工具正式开源,干掉市面上所有 Mock 工具!

最近栈长注意到阿里开源了自家的 Mock 工具:TestableMock,该工具号称最轻量、简单、舒适的 Mock 测试工具,功能十分强大,媲美 PowerMock,用法比 Mockito 还要简洁,还不挑框架,指哪换哪,一个 @MockMethod 注解打天下。。。 这么强大的么?栈长赶紧来体验一翻! TestableMock 简介 TestableMock 开源地址: https://github.com/alibaba/testable-mock TestableMock 在 2020 年 12

Java技术栈,分享最主流的Java技术 1763

史上最轻量​!阿里强推的新型单元测试工具

点击上方蓝色字体,选择“标星公众号”优质文章,第一时间送达关注公众号后台回复pay或mall获取实战项目资料+视频整理:芋道源码开源地址:https://gitee.com/mirror...

公众号-老炮说Java 353

阿里Mock工具正式开源,轻松干掉市面上所有Mock工具

最近栈长注意到阿里开源了自家的 Mock 工具:TestableMock,该工具号称最轻量、简单、舒适的 Mock 测试工具,功能十分强大,媲美 PowerMock,用法比 Mockito 还要简洁,还不挑框架,指哪换哪,一个 @MockMethod 注解打天下。。。 这么强大的么?栈长赶紧来体验一翻! TestableMock 简介 TestableMock 开源地址: https://github.com/alibaba/testable-mock TestableMock 在 .

QAQFyl的博客 1692

开源单元测试 Mock工具

Spring Boot 单元测试 Test 入门

zhaoyang10的专栏 899

【单元测试工具/框架】

Venus 是一个 JavaScript (JS) 的测试工具,可以简化运行单元测试。当你在 JS 开发一个基于浏览器的项目时,你想创建单元测试并频繁地运行它们。通常,你会用一些库比如 Mocha 或 Jasmine,写一个单元测试,这些库可以让你定义测试用例,并提供 API 来编写判断。我们通过创建一个工具,可以让你更轻松地与现有的库一起工作。一下是 Venus 的主要好处:在你的测试使用来指定你要使用的测试库,你要测试的文件,其它文件依赖,以及测试工具模板。

j8267643的博客 1757

TestableMock多场景应用:从基础Mock到复杂业务逻辑测试

TestableMock是一款特立独行的轻量Mock工具,换种思路写Mock,让单元测试更简单。它不仅提供了便捷的Mock功能,还能解决Java开发者在日常单元测试中经常遇到的痛点,如外部依赖Mock繁琐、私有方法难测试、无返回值方法难测试、复杂参数难构造等问题。 ## 一、TestableMock简介 ### 1.1 什么是TestableMock TestableMock的核心开发团队来

gitblog_00009的博客 441
上一篇: 我终于决定要放弃 Postman,选择了牛逼的神仙工具 IDEA HTTP Client !贼爽
下一篇: 万字详解本地缓存之王 Caffeine,SpringBoot2.X 官方推荐~
公众号-芋道源码
博客等级 码龄10年 1640粉丝 377原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值