【单元测试】C++单元测试框架Google Test入门之六：运行参数

柔情只为你懂 2023-09-24 16:48 11阅读 0赞

#### 文章目录 ####

*  一、前言
 *  二、基本介绍
 *  三、参数列表
 *   *   *  3.1 测试案例集合
         *  3.2 测试案例输出
         *  3.3 对案例的异常处理
 *  四、XML报告输出格式
 *  五、总结

## 一、前言 ##

使用gtest编写的测试案例通常本身就是一个可执行文件，因此运行起来非常方便。同时，gtest也为我们提供了一系列的运行参数（环境变量、命令行参数或代码里指定），使得我们可以对案例的执行进行一些有效的控制。

## 二、基本介绍 ##

前面提到，对于运行参数，gtest提供了三种设置的途径：

1.  系统环境变量
2.  命令行参数
3.  代码中指定FLAG  
    因为提供了三种途径，就会有优先级的问题， 有一个原则是，最后设置的那个会生效。不过总结一下，通常情况下，比较理想的优先级为：  
    命令行参数 > 代码中指定FLAG > 系统环境变量

为什么我们编写的测试案例能够处理这些命令行参数呢？是因为我们在main函数中，将命令行参数交给了gtest，由gtest来搞定命令行参数的问题。

int _tmain(int argc, _TCHAR* argv[])
    {
        
        testing::InitGoogleTest(&argc, argv);
        return RUN_ALL_TESTS();
    }

这样，我们就拥有了接收和响应gtest命令行参数的能力。如果需要在代码中指定FLAG，可以使用testing::GTEST\_FLAG这个宏来设置。比如相对于命令行参数–gtest\_output，可以使用testing::GTEST\_FLAG(output) = “xml:”;来设置。注意到了，不需要加–gtest前缀了。同时，推荐将这句放置InitGoogleTest之前，这样就可以使得对于同样的参数，命令行参数优先级高于代码中指定。

int _tmain(int argc, _TCHAR* argv[])
    {
        
        testing::GTEST_FLAG(output) = "xml:";
        testing::InitGoogleTest(&argc, argv);
        return RUN_ALL_TESTS();
    }

最后再来说下第一种设置方式-系统环境变量。如果需要gtest的设置系统环境变量，必须注意的是：

1.  系统环境变量全大写，比如对于–gtest\_output，响应的系统环境变量为：GTEST\_OUTPUT
2.  有一个命令行参数例外，那就是–gtest\_list\_tests，它是不接受系统环境变量的。（只是用来罗列测试案例名称）

## 三、参数列表 ##

了解了上面的内容，我这里就直接将所有命令行参数总结和罗列一下。如果想要获得详细的命令行说明，直接运行你的案例，输入命令行参数：/? 或 --help 或 -help

#### 3.1 测试案例集合 ####

![在这里插入图片描述][5057e3b4b1b04f0b952c4536c3dff9f5.png]

#### 3.2 测试案例输出 ####

![在这里插入图片描述][b70034af0cd84e9d9a20a1023a55d50a.png]

#### 3.3 对案例的异常处理 ####

![在这里插入图片描述][1faea0241ddf407cbae2272abbc45d30.png]

## 四、XML报告输出格式 ##

<?xml version="1.0" encoding="UTF-8"?>
    <testsuites tests="3" failures="1" errors="0" time="35" name="AllTests">
      <testsuite name="MathTest" tests="2" failures="1"* errors="0" time="15">
        <testcase name="Addition" status="run" time="7" classname="">
          <failure message="Value of: add(1, 1)  Actual: 3 Expected: 2" type=""/>
          <failure message="Value of: add(1, -1)  Actual: 1 Expected: 0" type=""/>
        </testcase>
        <testcase name="Subtraction" status="run" time="5" classname="">
        </testcase>
      </testsuite>
      <testsuite name="LogicTest" tests="1" failures="0" errors="0" time="5">
        <testcase name="NonContradiction" status="run" time="5" classname="">
        </testcase>
      </testsuite>
    </testsuites>

从报告里可以看出，我们之前在TEST等宏中定义的测试案例名称(testcase\_name)在xml测试报告中其实是一个testsuite name，而宏中的测试名称(test\_name)在xml测试报告中是一个testcase name，概念上似乎有点混淆，就看你怎么看吧。

当检查点通过时，不会输出任何检查点的信息。当检查点失败时，会有详细的失败信息输出来failure节点。

在我使用过程中发现一个问题，当我同时设置了–gtest\_filter参数时，输出的xml报告中还是会包含所有测试案例的信息，只不过那些不被执行的测试案例的status值为“notrun”。而我之前认为的输出的xml报告应该只包含我需要运行的测试案例的信息。不知是否可提供一个只输出需要执行的测试案例的xml报告。因为当我需要在1000个案例中执行其中1个案例时，在报告中很难找到我运行的那个案例，虽然可以查找，但还是很麻烦。

## 五、总结 ##

本篇主要介绍了gtest案例执行时提供的一些参数的使用方法，这些参数都非常有用。在实际编写gtest测试案例时肯定会需要用到的时候。至少我现在比较常用的就是：

1.  –gtest\_filter
2.  –gtest\_output=xml\[:DIRECTORY\_PATH|:FILE\_PATH\]
3.  –gtest\_catch\_exceptions

最后再总结一下我使用过程中遇到的几个问题:

1.  同时使用–gtest\_filter和–gtest\_output=xml:时，在xml测试报告中能否只包含过滤后的测试案例的信息。
2.  有时，我在代码中设置 testing::GTEST\_FLAG(catch\_exceptions) = 1和我在命令行中使用–gtest\_catch\_exceptions结果稍有不同，在代码中设置FLAG方式有时候捕捉不了某些异常，但是通过命令行参数的方式一般都不会有问题。这是我曾经遇到过的一个问题，最后我的处理办法是既在代码中设置FLAG，又在命令行参数中传入–gtest\_catch\_exceptions。不知道是gtest在catch\_exceptions方面不够稳定，还是我自己测试案例的问题。

【系列链接】  
[【单元测试】C++单元测试框架Google Test入门之一 : 初识Gtest][C_Google Test_ _ _Gtest]  
[【单元测试】C++单元测试框架Google Test入门之二 : 断言][C_Google Test_ _]  
[【单元测试】C++单元测试框架Google Test入门之三 : 事件机制][C_Google Test_ _ 1]  
[【单元测试】C++单元测试框架Google Test入门之四 : 参数化][C_Google Test_ _ 2]  
[【单元测试】C++单元测试框架Google Test入门之五 : 死亡测试][C_Google Test_ _ 3]  
[【单元测试】C++单元测试框架Google Test入门之六 : 运行参数][C_Google Test_ _ 4]  
[【单元测试】C++单元测试框架Google Test入门之七 : 深入解析GTEST][C_Google Test_ _ _GTEST]  
[【单元测试】C++单元测试框架Google Test入门之八 : 打造自己的单元测试框架][C_Google Test_ _ 5]

[5057e3b4b1b04f0b952c4536c3dff9f5.png]: https://img-blog.csdnimg.cn/5057e3b4b1b04f0b952c4536c3dff9f5.png
[b70034af0cd84e9d9a20a1023a55d50a.png]: https://img-blog.csdnimg.cn/b70034af0cd84e9d9a20a1023a55d50a.png
[1faea0241ddf407cbae2272abbc45d30.png]: https://img-blog.csdnimg.cn/1faea0241ddf407cbae2272abbc45d30.png
[C_Google Test_ _ _Gtest]: https://blog.csdn.net/weixin_43717839/article/details/128862746?spm=1001.2014.3001.5502
[C_Google Test_ _]: https://blog.csdn.net/weixin_43717839/article/details/128863859?spm=1001.2014.3001.5502
[C_Google Test_ _ 1]: https://blog.csdn.net/weixin_43717839/article/details/128896226?spm=1001.2014.3001.5502
[C_Google Test_ _ 2]: https://blog.csdn.net/weixin_43717839/article/details/128896292?spm=1001.2014.3001.5502
[C_Google Test_ _ 3]: https://blog.csdn.net/weixin_43717839/article/details/128896679?spm=1001.2014.3001.5502
[C_Google Test_ _ 4]: https://blog.csdn.net/weixin_43717839/article/details/128896931?spm=1001.2014.3001.5502
[C_Google Test_ _ _GTEST]: https://blog.csdn.net/weixin_43717839/article/details/128897405?spm=1001.2014.3001.5502
[C_Google Test_ _ 5]: https://blog.csdn.net/weixin_43717839/article/details/128897801?spm=1001.2014.3001.5502