在Rust中编写自动化测试

1.摘要

Rust中的测试函数是用来验证非测试代码是否是按照期望的方式运行的, 测试函数体通常需要执行三种操作:1.设置任何所需的数据或状态;2.运行需要测试的代码;3.断言其结果是我们所期望的。本篇文章主要探讨了Rust自动化测试的几种常见场景。

2.测试函数详解

在Rust项目工程中, 可以对任意函数进行自动化测试, 前提是需要在被测试函数上面加上#[test]注解, 然后运行cargo test命令进行函数自动化测试, Rust会查找所有被#[test]注解的函数并自动进行测试。

先看下面一段代码:

#[test]
fn add_calc() {let result = 1 + 2;assert_eq!(result, 3);
}

在上面的代码中, 我实现了一个加法计算的函数: add_calc(), 将加法结果保存到不可变变量result中, 并使用了assert_eq!宏来断言1+2的结果, assert!宏由标准库提供, 在希望确保测试过程中一些条件为true时非常有用。在函数上方加上了#[test]注解, 表示该函数将执行自动化测试, 运行: cargo test看下结果:

从测试结果中, 可以看到test add_calc ... ok 这行, 表示该函数测试通过了。

现在我修改下断言的结果, 将代码修改为:

#[test]
fn add_calc() {let result = 1 + 2;assert_eq!(result, 4);
}

再次运行cargo test命令, 返回结果如下:

可以看到, 计算的结果是3, 但断言相等的条件是等于4, 因此函数执行失败, add_calc()函数自动化测试不通过。

接下来我们再加入一个函数, 看看在具有多个函数的前提下, 同时具备成功和失败的情况, 代码如下:

#[test]
fn add_calc() {let result = 1 + 2;assert_eq!(result, 3);
}
​
#[test]
fn another_method() {panic!("执行失败,抛出一个异常!")
}

在上面的代码中, 增加了一个名为another_method()的函数, 该函数直接使用panic!抛出一个异常, 直接扮演了函数执行失败的角色, 而上面的add_calc()函数我讲assert_eq!宏修改正确, 将扮演执行成功的角色, 使用cargo test命令看下结果:

可以看到, add_calc()函数测试没问题, 后面用绿色ok表示, 而another_method()函数执行失败, 使用红色的FAILED标记。

3.自定义失败信息

在上面的案例中, 我使用了assert_eq!宏来断言结果, 同样, 也可以向宏传递一个可选的失败信息参数, 可以在测试失败时将自定义的失败信息一并打印出来, 使用自定义信息有个好处, 当测试失败时, 能更好的理解代码到底出了什么问题, 看一段下面的代码:

pub fn make_string(name: &str) -> String {format!("Hello,{}!", name)
}
​
#[test]
fn is_contain_name() {let result = make_string("cargo");assert!(result.contains("cargo"));
}

在这段代码中, 定义了一个函数make_string, 该函数接收一个字符串参数, 并在函数内部通过format!宏格式化字符串后返回, 在函数is_contain_name()中, 传入一个字符串"cargo", assert!会判断make_string()函数返回的字符串中是否会包含"cargo"字符串,如果包含就是成功的,否则就失败, 这里我们能预言结果应该是成功的, 测试一下看看:

结果跟我们预想的一样, 现在再加入一些更详细的变化信息看看, 代码如下:

pub fn make_string(name: &str) -> String {format!("Hello,{}!", name)
}
​
#[test]
fn is_contain_name() {let result = make_string("rustup");assert!(result.contains("cargo"), "make_string中不包含该字符串,值为:`{}`", result);
}

我在assert!宏中加入了变量打印, 假如make_string()函数没有返回预期的结果, 那结果到底是什么,这里我们将能看到失败原因, 测试结果如下:

从结果可以看到, 函数的确测试失败了, 但我们看到了关键信息, 失败的原因是因为make_string()函数返回的字符串内容为:Hello,rustup!,这个结果与断言中的result.contains("cargo")结果是不同的, “Hello,rustup!”字符串中并不包含"cargo"字符串,所以函数测试失败。

4.检查崩溃异常

除了使用断言宏之外, Rust还提供了一个should_panic用来检测程序中的panic,并且提供了一个名为expected的参数用来自定义消息,看一段下面的代码:

pub fn number_calc(value: i32) -> i32 {let ret_value = 40;if value < 0 {panic!("值必须大于0,传参的值为:{}", value)}return ret_value
}
​
#[test]
#[should_panic(expected = "传参不能小于0")]
fn is_contain_name() {let result = number_calc(-1);
}

在number_calc()函数中, 如果判断参数传入的值小于0, 会抛出一个panic, 为了监视是什么原因导致, 在函数is_contain_name()上面使用should_panic进行监控, 并使用expected参数指定自定义消息, 如果遇到传入的参数小于0, 将触发该消息打印, 使用cargo test运行一下看看结果:

从结果可以看到, 的确检测到了panic产生, panic打印了本身的消息, 最后一行shoud_panic也触发了消息, 并打印出失败的原因。

5.使用Result<T, E>测试

先看一段下面的代码:

pub fn number_calc(value: i32) -> i32 {let ret_value = 40;if value < 0 {return 30}return ret_value
}
​
#[test]
fn is_contain_name() -> Result<(), String>{if number_calc(2) == 40 {OK(())}else{Err(String::from("结果不等于40,请检查原因!"))}
}

在上面的代码中, is_contain_name()函数的返回类型现在变为:Result<(), String>, 在函数体中, 不同于调用assert_eq!,现在如果测试通过,将返回Ok(()), 在测试失败时, 返回带有String的Err错误。现在传入参数为2, 将显示正常的结果:

现在我们再传入一个小于0的负值看看,结果如下:

可以看到, 如果使用Result<(), String>接收结果, 当出来错误时, 将返回一个Error,并打印对应的自定义消息。

6.总结

在本篇文章中, 我们使用#[test]注解完成了对指定函数的自动化测试, 使用assert!宏对错误进行断言, 在断言中自定义错误显示消息用于查看更详细的错误原因。使用了should_panic对panci错误进行了监控, 最后使用Result<T, E>替代断言分别完成了代码测试和自定义错误消息打印, 在以后的实际应用中, 可能还会有一些组合测试的场景出现, 到时候再具体问题具体分析。