测试 Go 中封装多个客户端的方法的优雅方式是什么?
来源:stackoverflow
时间:2024-03-13 15:39:29 286浏览 收藏
哈喽!今天心血来潮给大家带来了《测试 Go 中封装多个客户端的方法的优雅方式是什么?》,想必大家应该对Golang都不陌生吧,那么阅读本文就都不会很困难,以下内容主要涉及到,若是你正在学习Golang,千万别错过这篇文章~希望能帮助到你!
我有一个 client
结构,它包装了多个客户端(etcd 和 libvirt)。像这样的东西:
type client struct { etcd *clientv3 libvirt *libvirt.connect }
一旦我的库的客户端想要关闭其句柄,我就想关闭这两个句柄。所以我有:
func (c *Client) Close() error { c.etcd.Close() c.libvirt.Close() // Error handling excluded for brevity }
测试这个的优雅方法是什么?我当前最好的选择是创建两个接口,一个用于两个包装的客户端中的每一个。这些接口将包括我的库使用的两个客户端的每一个方法。这应该使得传递某种模拟而不是真正的客户变得相对容易。这可能是前进的方向,但感觉很尴尬。
我还有哪些其他选择?
解决方案
受到 powar 的评论的鼓励,我的想法很好,我继续这样做:
我更改了 client
结构以使用 libvirt 和 etcd 连接的接口:
type etcdclient interface { } type libvirtclient interface { } type client struct { etcd etcdclient libvirt libvirtclient }
当我尝试编译该包时,我收到一条类似如下的错误消息:
./main.go:17:18: c.etcd.close undefined (type etcdclient is interface with no methods) ./main.go:21:24: c.libvirt.close undefined (type libvirtclient is interface with no methods)
不足为奇。然后,我向接口添加了最简单的 close() 方法:
type etcdclient interface { close() } type libvirtclient interface { close() }
再次编译给了我:
./main.go:56:10: cannot use etcd (type *clientv3.client) as type etcdclient in assignment: *clientv3.client does not implement etcdclient (wrong type for close method) have close() error want close() ./main.go:62:13: cannot use lv (type *libvirt.connect) as type libvirtclient in assignment: *libvirt.connect does not implement libvirtclient (wrong type for close method) have close() (int, error) want close()
然后我用它来填写接口定义:
type etcdclient interface { close() error } type libvirtclient interface { close() (int, error) }
当然,close
非常简单,我不必经历这个,但正如我之前提到的,我在这些接口上调用许多方法,这样就可以让编译器帮助我变得非常简单填写接口定义。
对于测试,我可以制作假货(模拟?存根?我总是忘记其中的区别)。这是完整的测试文件:
package main import ( "errors" "testing" ) type fakeetcdclient struct { wasclosed bool failtoclose bool } func (f *fakeetcdclient) close() error { if f.failtoclose { return errors.new("fake etcd failed to close") } f.wasclosed = true return nil } type fakelibvirtclient struct { wasclosed bool failtoclose bool } func (f *fakelibvirtclient) close() (int, error) { if f.failtoclose { return 0, errors.new("fake libvirt failed to close") } f.wasclosed = true return 0, nil } func testclient_close(t *testing.t) { type fields struct { etcd etcdclient libvirt libvirtclient } tests := []struct { name string fields fields wanterr bool }{ {"happy path", fields{&fakeetcdclient{}, &fakelibvirtclient{}}, false}, {"etcd fails", fields{&fakeetcdclient{failtoclose: true}, &fakelibvirtclient{}}, true}, {"libvirt fails", fields{&fakeetcdclient{}, &fakelibvirtclient{failtoclose: true}}, true}, } for _, tt := range tests { t.run(tt.name, func(t *testing.t) { c := &client{ etcd: tt.fields.etcd, libvirt: tt.fields.libvirt, } if err := c.close(); (err != nil) != tt.wanterr { t.errorf("client.close() error = %v, wanterr %v", err, tt.wanterr) } else { if !tt.wanterr { // we only check if the clients have been closed if // client.close() returns successfully. if !c.etcd.(*fakeetcdclient).wasclosed { t.error("etcd connection was not closed") } if !c.libvirt.(*fakelibvirtclient).wasclosed { t.error("libvirt connection was not closed") } } } }) } }
正如我在评论中提到的,您可以创建一个 closableclient
,如下所示。由于您的每个客户端都有 close
方法,因此您可以执行此操作。在您的测试文件中,您可以创建只需要实现 close
方法的模拟客户端。您不需要让接口实现所有方法。在代码中,您可以使用类型断言将 closableclient
转换为特定客户端以访问其功能。 Here 是类型断言的一个很好的例子。
我添加了代码片段来展示如何使用类型断言来获取底层结构。测试文件中的模拟客户端不需要实现 foo 和 bar 方法,因为接口 closableclient
只需要 close
方法。
type ClosableClient interface { Close() } type Etcd struct{} func (e *Etcd) Close() { fmt.Println("etcd closing") } func (e *Etcd) Foo() { fmt.Println("etcd foo") } type Libvirt struct{} func (l *Libvirt) Close() { fmt.Println("libvirt closing") } func (l *Libvirt) Bar() { fmt.Println("libvirt bar") } type Client struct { etcd ClosableClient libvirt ClosableClient } func (c *Client) Close() { c.etcd.Close() c.libvirt.Close() } func (c *Client) FooBar() { etcd, ok := c.etcd.(*Etcd) if !ok { panic("etcd is of incorrect type") } etcd.Foo() libvirt, ok := c.etcd.(*Libvirt) if !ok { panic("libvirt is of incorrect type") } libvirt.Bar() }
今天带大家了解了的相关知识,希望对你有所帮助;关于Golang的技术知识我们会一点点深入介绍,欢迎大家关注golang学习网公众号,一起学习编程~
-
502 收藏
-
502 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
139 收藏
-
204 收藏
-
325 收藏
-
477 收藏
-
486 收藏
-
439 收藏
-
357 收藏
-
352 收藏
-
101 收藏
-
440 收藏
-
212 收藏
-
143 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 542次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 508次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 497次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 484次学习