Project Icon

rapidcheck

C++属性测试框架助力代码质量提升

RapidCheck是一款C++属性测试框架,通过生成随机测试数据验证代码正确性。它能自动缩小失败案例,支持STL类型和高级组合器,并可与Boost Test、Google Test等框架集成。该工具为开发者提供了编写命令式属性测试的能力,有助于提高C++项目的代码质量和可靠性。

RapidCheck 构建状态 构建状态

RapidCheck 是一个受 QuickCheck 和其他类似框架启发的 C++ 基于属性测试框架。在基于属性的测试中,你陈述关于你的代码的事实,这些事实在给定某些前提条件下应该始终为真。RapidCheck 然后生成随机测试数据,试图找到一个使属性不成立的情况。如果找到这样的情况,RapidCheck 会尝试找到最小的情况(根据某种最小的定义),使属性仍然为假,然后将其显示为反例。例如,如果输入是一个整数,RapidCheck 会尝试找到使属性为假的最小整数。

听起来很有趣?不妨阅读**用户指南**来了解更多!

为什么选择 RapidCheck?

已经存在一些基于属性测试的实现,但我发现的那些要么(在我看来)有点笨拙,要么缺少一些重要功能,比如测试用例缩小。

让我们列举一些特性:

  • 以 C++ 的命令式方式编写属性
  • 测试用例缩小
  • 对 STL 类型的出色支持,包括 map 和 set
  • 用于创建自己的生成器的高级组合器
  • 基于 Erlang QuickCheck 风格的命令的状态测试
  • 与流行的测试框架集成,如 Boost Test、Google Test 和 Google Mock

先决条件和安装

RapidCheck 大量使用 C++11,因此需要兼容的编译器。RapidCheck 持续集成使用 Clang 3.5、GCC 4.9 和 Visual Studio 2015 构建,所以任何更新的版本也应该可以工作。

RapidCheck 使用 CMake,构建方式与其他 CMake 项目相同。如果你自己的项目使用 CMake,你可以简单地将 RapidCheck 作为子目录,并在你的 CMakeLists.txt 中添加以下内容:

add_subdirectory("path/to/rapidcheck")
target_link_libraries(my_target rapidcheck)

这将为你提供链接和包含目录。

快速入门

一个常见的第一个例子是测试反转函数。对于这样的函数,双重反转应该总是得到原始列表。在这个例子中,我们将使用标准 C++ 的 std::reverse 函数:

#include <rapidcheck.h>

#include <vector>
#include <algorithm>

int main() {
  rc::check("双重反转得到原始值",
            [](const std::vector<int> &l0) {
              auto l1 = l0;
              std::reverse(begin(l1), end(l1));
              std::reverse(begin(l1), end(l1));
              RC_ASSERT(l0 == l1);
            });

  return 0;
}

check 函数用于检查属性。第一个参数是一个可选的字符串,描述该属性。第二个参数是实现属性的可调用对象,在这个例子中是一个 lambda。可调用对象的任何参数(在我们的例子中是 l0 参数)都将被随机生成。RC_ASSERT 宏的工作原理与其他 assert 宏相同。如果给定的条件为假,则该属性被证伪。

上面的属性也构成了反转函数规范的一部分:"对于任何整数列表 A,反转然后再次反转应该得到 A"。

如果我们运行这个,RapidCheck 会(希望)输出以下内容:

使用配置:seed=9928307433081493900

- 双重反转得到原始值
OK,通过了 100 次测试

在这里,RapidCheck 告诉我们它运行了 100 个测试用例,所有测试都通过了。它还告诉我们使用的配置,特别是随机种子。如果 std::reverse 的实现中存在 bug,我们可能会得到以下输出:

在 12 次测试和 10 次缩小后可证伪

std::tuple<std::vector<int>>:
([1, 0, 0, 0, 0, 0, 0, 0, 0, 0])

main.cpp:17:
RC_ASSERT(l0 == l1)

展开为:
[1, 0, 0, 0, 0, 0, 0, 0, 0, 0] == [0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

这里 RapidCheck 告诉我们,在运行 12 次测试后,它发现了一个使属性不成立的情况。当发现这个情况时,它进行了 10 次缩小,得到了输出中的反例。反例包含了用于失败情况的每个输入值及其类型。由于 RapidCheck 将属性参数视为元组,因此这里显示的类型是 std::tuple<std::vector<int>>

你能猜出 bug 是什么吗?恰好有 10 个项目这一事实应该给出一些线索。在这种情况下,bug 是当 l0.size() >= 10 时,实现将第一个元素设置为 0。这也是初始 0 的原因,当所有元素都为零时,问题不会出现。这个 bug 是怎么发生的?谁知道呢!

致谢

非常感谢我的雇主 Spotify,让我能够花费工作时间来改进 RapidCheck。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号