Rust入坑指南:步步为营

俗话说:“测试写得好,奖金少不了。”

有经验的开发人员通常会通过单元测试来保证代码基本逻辑的正确性。如果你是一名新手开发者,并且还没体会到单元测试的好处,那么建议你先读一下我之前的一篇文章代码洁癖系列(七):单元测试的地位

写单元测试一般需要三个步骤:

  1. 准备测试用例,测试用例要能覆盖尽可能多的代码
  2. 执行需要测试的代码
  3. 判断结果,是否是你希望得到的结果

了解了这些以后,我们就来看看在Rust中应该怎么写单元测试。

首先我们建立一个library项目

$ cargo new adder --lib
     Created library `adder` project

然后在src/lib.rs文件中开始写测试代码

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
}

此时在命令行运行cargo test就会得到测试结果

可以看到,结果显示,Rust运行了一项测试并且测试通过。后面的Doc-tests我们先放下,以后再聊。

当然,这并不是我们常见的测试,在日常开发中,我们通常是先写我们的业务代码然后再对各个函数进行单元测试,最后还会对某个模块进行集成测试。那么我们就来模拟一下日常开发过程中应该如何来写测试。

单元测试

我们仍然是用上面的项目,先来在src/lib.rs中写一段“业务代码”

pub fn add_two(a: i32) -> i32 {
    internal_adder(a, 2)
}

fn internal_adder(a: i32, b: i32) -> i32 {
    a + b
}

这是一段非常简单的代码,对外暴露的函数只是一个加2的功能,内部调用了一个两数相加的函数。现在我们就对这个内部函数做一个单元测试。

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn internal() {
        assert_eq!(4, internal_adder(2, 2));
    }
}

在测试模块中,如果想要使用我们业务代码中的函数,就需要通过use super::*;将其引入可用范围。接着,还是执行cargo test,测试结果与刚才类似。

测了半天全是通过的没什么意思,单元测试真正的作用是要发现代码中的问题,所以我们来尝试一个错误的试一下。假设我们希望2+2等于5。

这里我们的assert_eq!左右不相等,引起了线程恐慌,因此导致测试失败。结果中给出了失败的原因,引起失败的位置,并且有一句提示:note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace. 我们按照这个提示,设置变量RUST_BACKTRACE=1,此时再执行cargo test

Rust就会将错误栈打印出来,根据结果提示,这并不是完整的错误栈,我们还可以将RUST_BACKTRACE设置为full来查看更加详细的信息。这里我就不做演示了。

集成测试

接下来我们再演示一下集成测试。我们通常将集成测试单独放到一个目录中,在lib.rs文件中,rust识别测试mod的名称是tests,同样的,我们在src下创建tests目录。tests目录下就是我们的所有集成测试代码。

如图,integration_test是我们测试代码的文件,common目录下的mod.rs文件中是一些集成测试必要的配置。这里我们只是放了一个空的setup函数。

在集成测试中,我们就要像正常他人使用我们的代码时那样来进行测试,首先需要将我们的mod引入到可用范围,当然还需要加上common的mod。

use adder;

mod common;

#[tests]
fn it_adds_two() {
    common::setup();
    assert_eq!(4, adder::add_two(2));
}

接着就可以测试我们对外暴露的函数了。

ok,集成测试的方法我们也掌握了。现在来看看一直被我们忽略的Doc-tests吧。

文档测试

我们已经知道,Rust中的注释是双斜线//,像我们刚刚写的library代码,如果想要把它发布到crate.io上让别人使用,那么我们就需要增加相应的文档,这里文档的每行都应该是三斜线///开头,而文档中也应该放一些例子供他人参考。

/// Adds two to the number given.
///
/// # Examples
///
/// ```
/// let arg = 5;
/// let answer = adder::add_two(arg);
///
/// assert_eq!(7, answer);
/// ```
pub fn add_two(a: i32) -> i32 {
    internal_adder(a, 2)
}

现在我给add_two函数加上了文档,我们再次执行cargo test命令。

现在我们就明白了,Doc-tests测试就是运行我们文档中的例子。

常用特性

到目前为止,我们已经知道了在Rust中如何写测试代码了。接下来我们再来了解几个比较常用的特性。

运行指定的测试代码

我们在开发过程中肯定不会每次都去跑全量的单元测试,那样太浪费时间了。通常是我们开发完一个功能之后,编写对应的单元测试,然后单独跑这个测试。那么Rust中能不能单独跑一个单元测试呢?答案是肯定的。

相信细心的同学已经发现了,Rust测试结果中,是针对每个测试单独统计结果,并且每个测试都有自己的名字,像我们前面写的it_worksinternal。假设我们的代码中同时存在这两个函数,如果你想要单独跑internal这一个测试,就可以使用cargo test internal命令。

你也可以使用这种方法来执行多个名称类似的测试,假如我们有名称为internal_a的测试,那么执行cargo test internal命令时它也会被执行。

忽略某个测试

当我们有一个测试执行时间非常长的时候,我们一般不会轻易去执行,这时如果你想要执行多个测试,除了用我们上面提到的方法,去指定不同的名称列表以外。还可以把这个测试忽略掉。

现在我不想执行internal测试了,只需要对代码进行如下改动:

#[test]
#[ignore]
fn internal() {
  assert_eq!(4, internal_adder(2, 2));
}

这时再来运行测试,结果如图所示。

我们发现此时internal测试已经被忽略了。

测试异常情况

除了测试代码逻辑正常的情况,我们有时还需要测试一些异常情况,比如接收到非法参数时程序能否返回我们希望看到的异常。

我们首先来看一下如何测试程序返回异常信息。

Rust为我们提供了一个叫做should_panic的注解。我们可以使用它来测试程序是否返回异常:

pub fn add_two(a: i32) -> i32 {
    internal_adder(a, 2)
}

fn internal_adder(a: i32, b: i32) -> i32 {
    if a < 0 {
        panic!("a should bigger than 0");
    }
    a + b
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    #[should_panic]
    fn internal() {
        assert_eq!(4, internal_adder(-2, 2));
    }
}

此时我们运行测试时就会发现internal测试通过,因为它发生了线程恐慌,这是我们希望看到的结果。

另外,我们还可以再指定我们具体期望的异常,那么就可以在should_panic后面加上expected参数。

#[test]
#[should_panic(expected = "a should be positive")]
fn internal() {
  assert_eq!(4, internal_adder(-2, 2));
}

大家可以自行运行一下这段测试代码看看效果。

总结

文中我向大家介绍了在Rust中如何进行单元测试、集成测试,还有比较特殊的文档测试。最后还介绍了3种常见的测试特性。

最后想友情提醒大家一下,在开发过程中,不要写完一堆功能后再开始写单元测试,这时你很有可能会因为测试代码过于繁琐而放弃。建议大家每写一个功能,随即开始进行单元测试,这样也能立即看到自己的代码的执行效果,提高成就感。这就是所谓的“步步为营”。

原文地址:https://www.cnblogs.com/Jackeyzhe/p/12343652.html

时间: 2024-11-14 12:55:07

Rust入坑指南:步步为营的相关文章

Rust入坑指南:亡羊补牢

如果你已经开始学习Rust,相信你已经体会过Rust编译器的强大.它可以帮助你避免程序中的大部分错误,但是编译器也不是万能的,如果程序写的不恰当,还是会发生错误,让程序崩溃.所以今天我们就来聊一聊Rust中如何处理程序错误,也就是所谓的"亡羊补牢". 基础概念 在编程中遇到的非正常情况通常可以分为三类:失败.错误.异常. Rust中用两种方式来消除失败:强大的类型系统和断言. 对于类型系统,熟悉Java的同学应该比较清楚.例如我们给一个接收参数为int的函数传入了字符串类型的变量.这是

Rust入坑指南:坑主驾到

欢迎大家和我一起入坑Rust,以后我就是坑主,我主要负责在前面挖坑,各位可以在上面看,有手痒的也可以和我一起挖.这个坑到底有多深?我也不知道,我是抱着有多深就挖多深的心态来的,下面我先跳了,各位请随意. Rust简介 众所周知,在编程语言中,更易读的高级语言和控制底层资源的低级语言是一对矛盾体.Rust想要挑战这一现状,它尝试为开发者提供更好的体验的同时给予开发者控制底层细节的权限(比如内存使用). 低级语言在开发过程中很容易出现各种细微的错误,它们难以发现但是可能影响巨大.其他大部分低级语言只

Rust入坑指南:海纳百川

今天来聊Rust中两个重要的概念:泛型和trait.很多编程语言都支持泛型,Rust也不例外,相信大家对泛型也都比较熟悉,它可以表示任意一种数据类型.trait同样不是Rust所特有的特性,它借鉴于Haskell中的Typeclass.简单来讲,Rust中的trait就是对类型行为的抽象,你可以把它理解为Java中的接口. 泛型 在前面的文章中,我们其实已经提及了一些泛型类型.例如Option.Vec和Result<T, E>.泛型可以在函数.数据结构.Enum和方法中进行定义.在Rust中,

Rust入坑指南:齐头并进(下)

前文中我们聊了Rust如何管理线程以及如何利用Rust中的锁进行编程.今天我们继续学习并发编程, 原子类型 许多编程语言都会提供原子类型,Rust也不例外,在前文中我们聊了Rust中锁的使用,有了锁,就要小心死锁的问题,Rust虽然声称是安全并发,但是仍然无法帮助我们解决死锁的问题.原子类型就是编程语言为我们提供的无锁并发编程的最佳手段.熟悉Java的同学应该知道,Java的编译器并不能保证代码的执行顺序,编译器会对我们的代码的执行顺序进行优化,这一操作成为指令重排.而Rust的多线程内存模型不

C语言入坑指南-被遗忘的初始化

前言 什么是初始化?为什么要初始化?静态变量和局部变量的初始化又有什么区别?实际应用中应该怎么做?本文将一一回答这些问题. 什么是初始化 初始化指的是对数据对象或者变量赋予初始值.例如: int value = 8; //声明整型变量并初始化为8int arr[] = {1,2,3}; //声明整型数组arr,并初始化其值为1,2,3 为什么要初始化 我们来看一个示例程序.test0.c程序清单如下: #include <stdio.h>#include <stdlib.h>int

eclipse中导入外部包却无法查看对应源码或Javadoc的 入坑指南

eclipse中导入外部包却无法查看对应源码或Javadoc的 入坑指南 出现这个错误的原因是,你虽然导入了.jar包,但没有配置对应的Javadoc或源码路径,所以在编辑器中无法查看源 码和对应API.接下来我们一起解决这个问题... 在项目名称上右击→ 新建→ 文件夹→ 文件名写lib→ 点击完成 然后把你下载的jar包,复制黏贴到这个lib文件夹 右击lib中的源码包→ 构建路径→ 添加至构建路径,自动生成一个"引用的库" 右击 "引用的库" 中的jar包→

猿说摄影(上)--入坑指南

最近师弟师妹们以及复读的童鞋临近毕业,有的想买相机拍拍毕业照,记录一下旅行毕业游之类的.五一放假,咱就先不聊技术,聊一下摄影,不过摄影也是一个技术活,而且烧钱.摄影穷三代,单反毁一生.相机贵吗?贵,但贵的不只是相机,还有镜头.为什么这么说呢?大家也知道,单反和微单都是可以更换镜头的.一旦入坑,除了买相机同时买的套头(标准变焦镜头)之外,你很可能会接下来陆陆续续地买其它镜头→_→想拍漂亮的人物,你需要大光圈的定焦镜头:想拍壮阔的风景,你需要广角镜头:想拍飞禽走兽,你需要长焦镜头:你可能还要拍点小花

Docker入坑指南之RUN

总有一些场景,我们需要自己制作一个镜像,可以快速还原环境,又不想被其他因素干扰镜像的纯净,这个时候,就可以选择Docker了,启动便捷,镜像还原很快捷,除了上手不容易. 最近入坑研究了一番,小有心得,故写一篇杂文,记录自己的踩坑经历. 安装Docker的过程可以参考其他前辈的文章,不再赘述,从实战角度说,如何构建一个自用的Docker镜像. 首选说一下Docker的几个名词,仓库是管理镜像的,容器是镜像启动后的,镜像就是最干净的环境,镜像启动之后变成容器. docker的run是启动镜像的介质,

Kotlin快速入坑指南(干货型文档)

<p style="text-align:center;color:#42A5F5;font-size:2em;font-weight: bold;">前言 即使每天10点下班,其实需求很多,我也要用这腐朽的声带喊出:我要学习,我要写文章!! 又是一篇Kotlin的文章,为啥...还不是因为工作需要.毫无疑问,最好的学习方式是通过官方文档去学习.不过个人觉得官方文档多多少少有一些不够高效. 中文官方文档 因此这篇是从我学习的个人视角以文档的形式去输出Kotlin语言基础的学