Go Convey测试框架入门(go convey gomonkey)

Go Convey测试框架入门

介绍

GoConvey是一款针对Golang的测试框架，可以管理和运行测试用例，同时提供了丰富的断言函数，并支持很多 Web 界面特性。
Golang虽然自带了单元测试功能，并且在GoConvey框架诞生之前也出现了许多第三方测试框架，但没有一个测试框架像GoConvey一样能够让程序员如此简洁优雅的编写测试代码。

官网：http://smartystreets.github.io/goconvey/

安装

go get 方式安装(go path时代，关闭go mod)

//下载源码并执行go build
//源码下载到$GOPATH/src目录
//go build之后的结果到$GOPATH/bin
go get github.com/smartystreets/goconvey

在$GOPATH/src目录下新增了github.com子目录，该子目录里包含了GoConvey框架的库代码 在$GOPATH/bin目录下新增了GoConvey框架的可执行程序goconvey

go install方式(开启go mod)

在gomod时代一般不需要先显式安装（gomod机制会自动从goproxy拉取依赖到本地cache），只需要go.mod中引入，然后go mod tidy即可。除非要使用GoConvey的web界面，这时需要提前安装GoConvey的二进制，命令为go install github.com/smartystreets/goconvey@latest。

go.mod：

module ziyi.convey.comgo 1.19require github.com/smartystreets/goconvey v1.8.1require (github.com/gopherjs/gopherjs v1.17.2 // indirectgithub.com/jtolds/gls v4.20.0+incompatible // indirectgithub.com/smarty/assertions v1.15.0 // indirect
)

//我后面要演示web页面，因此这里显示安装一下
//安装之后，依然会将编译好的二进制放在$GOPATH/bin
go install github.com/smartystreets/goconvey@latest

我的GOPATH为E:\Go\GoPro：
在这里插入图片描述

使用

注意事项

  1. import goconvey包时，前面加点号"."，以减少冗余的代码。凡是在测试代码中看到Convey和So两个方法，肯定是convey包的。我们需要注意不要在产品代码中定义相同的函数名
  2. 测试函数的名字必须以Test开头，而且参数类型必须为*testing.T
  3. 每个测试用例必须使用Convey函数包裹起来，它的第一个参数为string类型的测试描述，第二个参数为测试函数的入参（类型为*testing.T），第三个参数为不接收任何参数也不返回任何值的函数（习惯使用闭包）
  4. Convey函数的第三个参数闭包的实现中通过So函数完成断言判断，它的第一个参数为实际值，第二个参数为断言函数变量，第三个参数或者没有（当第二个参数为类ShouldBeTrue形式的函数变量）或者有（当第二个函数为类ShouldEqual形式的函数变量）

案例一：1个测试用例1个Convey

c_test.go：

package mainimport (. "github.com/smartystreets/goconvey/convey""testing"
)func TestEqualWithSingleTestCase(t *testing.T) {// test name：用例名称// t：需要传入*testing.T// func(){} 测试函数Convey("test name", t, func() {//1+1：断言//ShouldEqual：convey内置的断言//2：期望结果So(1+1, ShouldEqual, 2)})
}

在这里插入图片描述

案例二：多个Convey多个测试用例

①平铺写法

func TestEqualWithMultipleTestCase(t *testing.T) {Convey("test add case", t, func() {So(1+1, ShouldEqual, 2)})Convey("test sub case", t, func() {So(1-1, ShouldEqual, 0)})Convey("test multi case", t, func() {So(1*1, ShouldNotEqual, -1)})
}

②Convey嵌套写法

只需要最外层的Convey传t *testing.T即可

func TestEqualWithMultipleTestCaseAndNested(t *testing.T) {Convey("test case", t, func() {Convey("test add case", func() {So(1+1, ShouldEqual, 2)})Convey("test sub case", func() {So(1-1, ShouldEqual, 0)})Convey("test multi case", func() {So(1*1, ShouldNotEqual, -1)})})
}

案例三："函数式"断言(assert传入函数)

// 案例三：函数式断言
func TestFunctionalAssertion(t *testing.T) {Convey("test case", t, func() {So(add(1, 1), ShouldEqual, 2)})
}func add(a, b int) int {return a + b
}

案例四：忽略部分Convey断言

针对想忽略但又不想删掉或注释掉某些断言操作，GoConvey提供了Convey/So的Skip方法：

  • SkipConvey函数表明相应的闭包函数将不被执行
  • SkipSo函数表明相应的断言将不被执行

当存在SkipConvey或SkipSo时，测试日志中会显式打上"skipped"形式的标记：

当测试代码中存在SkipConvey时，相应闭包函数中不管是否为SkipSo，都将被忽略。
不管存在SkipConvey还是SkipSo时，测试日志中都有字符串"{n} total assertions (one or more sections skipped)"，其中{n}表示测试中实际已运行的断言语句数

// 案例四：忽略Convey断言
//忽略所有断言
func TestCaseSkipConvey(t *testing.T) {SkipConvey("test case", t, func() {So(add(1, 1), ShouldEqual, 2)})
}//忽略某些断言（SkipSo的断言将被忽略）
func TestCaseSkipSo(t *testing.T) {Convey("test case", t, func() {SkipSo(add(1, 1), ShouldEqual, 2)So(1-1, ShouldEqual, 0)})
}

比如我执行TestCaseSkipSo函数：
在这里插入图片描述

案例五：定制断言函数

①原理分析

  1. 查看So源码
func So(actual interface{}, assert Assertion, expected ...any)

在这里插入图片描述
2. 点击查看Assertion结构体

type Assertion func(actual any, expected ...any) string

当Assertion的变量的返回值为""时表示断言成功，否则表示失败：

const assertionSuccess = ""

在这里插入图片描述
3. 结论
因此我们只需要按照结构，实现func，最后返回空串代表断言成功，否则失败

②实际操作

从上面的分析我们可以知道，当Assertion最后返回""代表断言成功，反之失败

// 案例五：定制断言
func TestCustomAssertion(t *testing.T) {Convey("test custom assert", t, func() {So(1+1, CustomAssertionWithRaiseMoney, 2)})
}func CustomAssertionWithRaiseMoney(actual any, expected ...any) string {if actual == expected[0] {return ""} else {return "doesn't raise money"}
}

案例六：访问web页面

如果要访问web页面，需要有goconvey.exe程序并运行，同时需要将xxx_test.go文件放在与exe同目录，否则无法识别到

  • go get “github.com/smartystreets/goconvey”
  • go install “github.com/smartystreets/goconvey” (如果开启了go mod，则用该方式)

默认安装到$GOPATH/bin目录下

执行exe后，访问本地localhost:8080端口即可看到web页面，页面展示的了单测的通过情况等。
在这里插入图片描述

拓展：gomonkey（打桩工具）

如果在被测函数中调用了其他函数（比如其他业务方的），可以使用以下方法，gomonkey打桩工具

  • 官网：https://github.com/agiledragon/gomonkey
//安装依赖
go get "github.com/agiledragon/gomonkey"

给全局变量打桩

使用 gomonkey 可以方便地模拟函数的行为


// 拓展：配合monkey打桩
var num = 10 //全局变量func TestApplyGlobalVar(t *testing.T) {Convey("TestApplyGlobalVar", t, func() {Convey("change", func() {//模拟函数行为，给全局变量复制，在函数结束后直接通过reset恢复全局变量值patches := gomonkey.ApplyGlobalVar(&num, 150)defer patches.Reset()So(num, ShouldEqual, 150)})Convey("recover", func() {So(num, ShouldEqual, 10)})})
}

给函数打桩

//对函数进行打桩
func TestFunc(t *testing.T) {// mock 了 networkCompute()，返回了计算结果2patches := gomonkey.ApplyFunc(networkCompute, func(a, b int) (int, error) {return 2, nil})defer patches.Reset()sum, err := Compute(1, 2)println("expected %v, got %v", 2, sum)if sum != 2 || err != nil {t.Errorf("expected %v, got %v", 2, sum)}
}func networkCompute(a, b int) (int, error) {// do something in remote computerc := a + breturn c, nil
}func Compute(a, b int) (int, error) {sum, err := networkCompute(a, b)return sum, err
}

全部代码:

欢迎大家star在这里插入图片描述

  • Github：https://github.com/ziyifast/ziyifast-code_instruction/tree/main/go-demo/go-convey
    在这里插入图片描述

c_test.go:

package mainimport ("github.com/agiledragon/gomonkey"_ "github.com/agiledragon/gomonkey". "github.com/smartystreets/goconvey/convey""testing"
)// 案例一：一个Convey，一个用例
func TestEqualWithSingleTestCase(t *testing.T) {// test name：用例名称// t：需要传入*testing.T// func(){} 测试函数Convey("test name", t, func() {//1+1：断言//ShouldEqual：convey内置的断言//2：期望结果So(1+1, ShouldEqual, 2)})
}// 案例二：多个Convey，多个用例（平铺写法）
func TestEqualWithMultipleTestCase(t *testing.T) {Convey("test add case", t, func() {So(1+1, ShouldEqual, 2)})Convey("test sub case", t, func() {So(1-1, ShouldEqual, 0)})Convey("test multi case", t, func() {So(1*1, ShouldNotEqual, -1)})
}// 案例二：多个Convey，多个用例（嵌套写法）
func TestEqualWithMultipleTestCaseAndNested(t *testing.T) {Convey("test case", t, func() {Convey("test add case", func() {So(1+1, ShouldEqual, 2)})Convey("test sub case", func() {So(1-1, ShouldEqual, 0)})Convey("test multi case", func() {So(1*1, ShouldNotEqual, -1)})})
}// 案例三：函数式断言
func TestFunctionalAssertion(t *testing.T) {Convey("test case", t, func() {So(add(1, 1), ShouldEqual, 2)})
}func add(a, b int) int {return a + b
}// 案例四：忽略Convey断言
// 忽略所有断言
func TestCaseSkipConvey(t *testing.T) {SkipConvey("test case", t, func() {So(add(1, 1), ShouldEqual, 2)})
}// 忽略某些断言（SkipSo的断言将被忽略）
func TestCaseSkipSo(t *testing.T) {Convey("test case", t, func() {SkipSo(add(1, 1), ShouldEqual, 2)So(1-1, ShouldEqual, 0)})
}// 案例五：定制断言
func TestCustomAssertion(t *testing.T) {Convey("test custom assert", t, func() {So(1+1, CustomAssertionWithRaiseMoney, 2)})
}func CustomAssertionWithRaiseMoney(actual any, expected ...any) string {if actual == expected[0] {return ""} else {return "doesn't raise money"}
}// 拓展：配合monkey打桩
var num = 10 //全局变量func TestApplyGlobalVar(t *testing.T) {Convey("TestApplyGlobalVar", t, func() {Convey("change", func() {//模拟函数行为，给全局变量复制，在函数结束后直接通过reset恢复全局变量值patches := gomonkey.ApplyGlobalVar(&num, 150)defer patches.Reset()So(num, ShouldEqual, 150)})Convey("recover", func() {So(num, ShouldEqual, 10)})})
}// 对函数进行打桩
func TestFunc(t *testing.T) {// mock 了 networkCompute()，返回了计算结果2patches := gomonkey.ApplyFunc(networkCompute, func(a, b int) (int, error) {return 2, nil})defer patches.Reset()sum, err := Compute(1, 2)println("expected %v, got %v", 2, sum)if sum != 2 || err != nil {t.Errorf("expected %v, got %v", 2, sum)}
}func networkCompute(a, b int) (int, error) {// do something in remote computerc := a + breturn c, nil
}func Compute(a, b int) (int, error) {sum, err := networkCompute(a, b)return sum, err
}

go.mod:

module ziyi.convey.comgo 1.19require (github.com/agiledragon/gomonkey v2.0.2+incompatiblegithub.com/smartystreets/goconvey v1.8.1
)require (github.com/gopherjs/gopherjs v1.17.2 // indirectgithub.com/jtolds/gls v4.20.0+incompatible // indirectgithub.com/smarty/assertions v1.15.0 // indirect
)

参考文章：
http://smartystreets.github.io/goconvey/
https://www.jianshu.com/p/e3b2b1194830

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/bicheng/52380.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

OSPF路由原理详解与关键点

OSPF路由原理详解与关键点

目录 一. OSPF简介: 二. OSPF原理描述: 三. OSPF的核心内容: 四. OSPF的邻居关系和邻接 五. LSA在各区域中传播的支持情况 一. OSPF简介: 开放式最短路径优先OSPF（Open Shortest Path First）是IETF组织开发的一个基于链路状态的内部网关协议&…
阅读更多...
技术债务已接管经济

技术债务已接管经济

“技术债务”一词通常指软件开发过程中的捷径或次优方法。它表现为设计不良的代码、缺乏文档和过时的组件。虽然正确编写的代码和文档是永恒的，但组件和方法却不是。随着时间的推移，软件及其组件可能会成为技术债务。自 40 年前的 20 世纪 80 年代软件行…
阅读更多...
【嵌入式开发之网络编程】TCP端口和UDP端口

【嵌入式开发之网络编程】TCP端口和UDP端口

目录 网络端口的定义及作用 运输层的作用 运输层的两个主要协议 用户数据报协议UDP (User Datagram Protocol) 传输控制协议TCP (Transmission Control Protocol) 运输层的端口及分类 按照端口号分类 按照协议类型分类 BSD端口 网络端口的定义及作用 在网络技术中…
阅读更多...
《通义千问AI落地—下》：WebSocket详解

《通义千问AI落地—下》：WebSocket详解

一、前言 文本源自 微博客 且已获授权,请尊重版权。 《通义千问AI落地——下篇》如约而至。Websocket在这一类引用中，起到前后端通信的作用。因此，本文将介绍websocket在这类应用场景下的配置、使用、注意事项以及ws连接升级为wss连接等；如下图，本站已经使用了wss连接…
阅读更多...
iphone异常问题常用修复方法

iphone异常问题常用修复方法

作为智能手机的领军者，iPhone凭借其卓越的性能和稳定的系统赢得了全球用户的青睐。然而，就像任何电子设备一样，iPhone在使用过程中也难免会遇到各种异常问题，如卡顿、无法充电、应用闪退等。这些问题虽然令人头疼，但大…
阅读更多...
防范小程序隐私合规风险，筑牢用户信任防线

防范小程序隐私合规风险，筑牢用户信任防线

随着国内APP软件生态的成熟，依托于头部APP的小程序逐渐成为零售、娱乐、出行等行业必选的获客渠道之一。较低的开发成本和成熟的用户营销功能，令小程序的数量在过去几年呈指数级增长。截止2023年，头部APP内集成的小程序总量已超千万。然而&am…
阅读更多...
C语言 之 memcpy函数的内存重叠问题 及解决该问题的思路

C语言 之 memcpy函数的内存重叠问题 及解决该问题的思路

文章目录 函数原型：例子： 解决方式整体思路如下： 内存重叠问题主要是使用函数memcpy的时候会发生的 函数原型： void * memcpy ( void * destination, const void * source, size_t num);这个函数能够在source指向的空间中拷贝nu…
阅读更多...
嘉立创EDA个人学习笔记2（设计流程及绘制元件）

嘉立创EDA个人学习笔记2（设计流程及绘制元件）

前言 本篇文章属于嘉立创EDA的学习笔记，来源于B站教学视频。下面是这位up主的视频链接。本文为个人学习笔记，只能做参考，细节方面建议观看视频，肯定受益匪浅。 【教程】零基础入门PCB设计-国一学长带你学立创EDA专业版 全程保姆…
阅读更多...
黑神话：悟空-配置推荐

黑神话：悟空-配置推荐

显卡推荐（按类别整理） 1. GTX 10系列、GTX 16系列： 如果希望体验光线追踪，建议根据预算升级到RTX 40系列显卡。对于1080p分辨率，至少需要RTX 4060才能流畅运行。 2. RTX 20系列： RTX 2060、RTX 2070&#…
阅读更多...
-Wl,-rpath= 编译器链接器指定动态库路径 与 LD_LIBRARY_PATH

-Wl,-rpath= 编译器链接器指定动态库路径 与 LD_LIBRARY_PATH

实例先行， 1，情景 三互相依赖的小项目： （1）libbottom.so，无特别依赖，除系统文件 （2）libtop.so，依赖libbottom.so （3）app 可执行程…
阅读更多...
buuctf [HDCTF2019]Maze

buuctf [HDCTF2019]Maze

前言：做题笔记。 常规 下载 解压 查壳 脱壳后用32IDA Pro打开。 得，迷宫类型的题目。(字符串有说。) 咳，此前思路对半分不行了。。。 合理猜测步数为：14。 那可以看看7 * 10的迷宫类型。(手动猜测的时候去取倍数如：0 2…
阅读更多...
冷硬缓存——利用缓存滥用绕过 RPC 接口安全

冷硬缓存——利用缓存滥用绕过 RPC 接口安全

介绍 MS-RPC 是 Windows 操作系统的基石之一。早在 20 世纪 90 年代发布，它就已扎根于系统的大部分部分。服务管理器？RPC。Lsass？RPC。COM？RPC。甚至一些针对域控制器的域操作也使用 RPC。鉴于 MS-RPC 已经变得如此普遍，您可以预料到它已经受到严格的审查、记录和研究。 …
阅读更多...
【Redis】有序集合(Zset)详解及实际应用场景分析：从命令操作到内部编码

【Redis】有序集合(Zset)详解及实际应用场景分析：从命令操作到内部编码

目录 Zset 有序集合普通命令集合间操作命令⼩结内部编码使⽤场景 Zset 有序集合 有序集合相对于字符串、列表、哈希、集合来说会有⼀些陌⽣。它保留了集合不能有重复成员的特点，但与集合不同的是，有序集合中的每个元素都有⼀个唯⼀的浮点类型的分数&…
阅读更多...
Qt 0821作业

Qt 0821作业

一、思维导图 二、优化聊天室代码 服务器 头文件 #ifndef WIDGET_H #define WIDGET_H#include <QWidget> #include <QTcpServer> #include <QMessageBox> #include <QTcpSocket> #include <QList> #include <QNetworkInterface>QT_BEGIN_…
阅读更多...
系统编程-lvgl

系统编程-lvgl

带界面的MP3播放器 -- lvgl 目录 带界面的MP3播放器 -- lvgl 一、什么是lvgl&#xff1f; 二、简单使用lvgl 在工程中编写代码 实现带界面的mp3播放器 main.c events_init.c events_init.h 补充1&#xff1a;glob函数 补充2&#xff1a;atexit函数 一、什么是lvgl&a…
阅读更多...
通过C# 读取PDF页面大小、方向、旋转角度

通过C# 读取PDF页面大小、方向、旋转角度

在处理PDF文件时&#xff0c;了解页面的大小、方向和旋转角度等信息对于PDF的显示、打印和布局设计至关重要。本文将介绍如何使用免费.NET 库通过C#来读取PDF页面的这些属性。 文章目录 C# 读取PDF页面大小&#xff08;宽度、高度&#xff09;C# 判断PDF页面方向C# 检测PDF页面…
阅读更多...
31套科技风PPT模版免费下载

31套科技风PPT模版免费下载

目录 资源名称&#xff1a;31套科技风PPT模板合集资源简介&#xff1a;部分展示&#xff1a;适用人群&#xff1a;资源内容&#xff1a;使用指南&#xff1a;资源下载链接&#xff08;免费&#xff0c;已设置0个积分下载&#xff09; 资源名称&#xff1a;31套科技风PPT模板合集…
阅读更多...
Spring + Boot + Cloud + JDK8 + Elasticsearch 单节点 模式下实现全文检索高亮-分页显示 快速入门案例

Spring + Boot + Cloud + JDK8 + Elasticsearch 单节点 模式下实现全文检索高亮-分页显示 快速入门案例

1. 安装elasticsearchik分词器插件 sudo wget https://release.infinilabs.com/analysis-ik/stable/elasticsearch-analysis-ik-8.13.4.zip sudo mkdir -p ./es_plugins/analysis-ik sudo mkdir ./es_data sudo unzip elasticsearch-analysis-ik-8.13.4.zip -d ./es_plugins/a…
阅读更多...
WIFI 频段及信道简介

WIFI 频段及信道简介

一、WiFi 三频AP规划信道时&#xff0c;建议分别采用2.4G、5.2G、5.8G频段可用信道。 2.4G频段&#xff1b;5.2G频段&#xff1b;5.8G频段。 1、中国5G WiFi频段 5.8GHz频段&#xff0c;中国开放只有149、153、157、161、165这5个信道&#xff1b; 其中可支持一组80MHz信道…
阅读更多...
【ACM出版，高录用EI快检索】第七届计算机信息科学与人工智能国际学术会议(CISAI 2024，9月6-8)

【ACM出版，高录用EI快检索】第七届计算机信息科学与人工智能国际学术会议(CISAI 2024，9月6-8)

第七届计算机信息科学与人工智能国际学术会议(CISAI 2024) 将于2024年09月6-8日在中国浙江-绍兴举行。 计算机信息科学与人工智能国际学术会议的主题主要围绕“信息科学”与“人工智能”的最新研究展开&#xff0c;旨在荟聚世界各地该领域的专家、学者、研究人员及相关从业人员…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023