实践 Fake ClientSet 单元测试

简介: 在 Kubernetes 相关的开发中,client-go 是最常用的,对于 client-go 相关的代码我们可以通过 fake ClientSet 来编写单元测试,本文将实践利用 fake ClientSet

目录

什么是 ClientSet

实践环节


什么是 ClientSet

ClientSet顾名思义,就是一堆 Client 的集合。

在 client-go 中,ClientSet 声明了对于 Kubernetes 内置资源的操作接口的集合,代码位于 kubernetes/client-go


Fake ClientSet 顾名思义就是 “假” 的 Client 集合,实现了 ClientSet的接口,可以对 client-go 的代码进行模拟操作,可直接用于业务代码的单元测试,代码在 kubneretes/client-go 中。


实践环节

接下来我们将实际操作一下常见的几种 fake clientset 的用法


我们构造一个简单的场景,比如我们在业务逻辑中需要对 Node 进行更新标签的操作,逻辑如下:

import (
"context"metav1"k8s.io/apimachinery/pkg/apis/meta/v1""k8s.io/client-go/kubernetes")
funcLabelNode(ctxcontext.Context, cskubernetes.Interface, nodeNamestring, labelsmap[string]string) error {
node, err :=cs.CoreV1().Nodes().Get(ctx, nodeName, metav1.GetOptions{})
iferr!=nil {
returnerr    }
for_, l :=rangelabels {
node.Labels[l] =labels[l]
    }
_, err=cs.CoreV1().Nodes().Update(ctx, node, metav1.UpdateOptions{})
iferr!=nil {
returnerr    }
returnnil}


其中 kubernetes.Interface 就是 ClientSet实现的标准接口,比如常见的通过 ~/.kube/config加载 restConfig 再创建 ClientSet,得到的ClientSet就实现了 kubernetes.Interface

rc, err :=clientcmd.BuildConfigFromFlags("", "~/.kube/config")
iferr!=nil {
panic(err)
}
cs, err :=kubernetes.NewForConfig(rc)
iferr!=nil {
panic(err)
}


接下来我们编写上述逻辑的单元测试,首先我们先来看一下完整的代码

提示:

这里只做简单单元测试的演示,并不涉及到单元测试结构的合理性

packagenodesimport (
"testing""reflect""context"corev1"k8s.io/api/core/v1"metav1"k8s.io/apimachinery/pkg/apis/meta/v1"fakeclientset"k8s.io/client-go/kubernetes/fake")
funcTest_LabelNode(t*testing.T) {
cs :=fakeclientset.NewSimpleClientset(&corev1.Node{
ObjectMeta: metav1.ObjectMeta{
Name: "fake-node-1",
Labels: map[string]string{
"fake.label.kubernetes.io": "fake",
   },
    },
 })
newLabels :=map[string]string{
"fake.label.kubernetes.io": "new-value",
 }
err :=LabelNode(context.Background(), cs, "fake-node-1", newLabels)
iferr!=nil {
t.Error(err)
return }
got, err :=cs.CoreV1().Nodes().Get(context.Background(), "fake-node-1", metav1.GetOptions{})
iferr!=nil {
t.Error(err)
return }
if!reflect.DeepEqual(got.Labels, newLabels) {
t.Error(err)
return }
}


可以通过 NewSimpleClientset来生成 fake clientSet,这里的入参是 objects ...runtime.Object,其中 runtime.Object接口是 Kubernetes 资源都会实现的接口,也就是我们需要传入期望可以进行 CRUD 的假资源对象列表。


提示:

这里 runtime.Object不仅限于内置资源外,自定义资源也可以

cs :=fakeclientset.NewSimpleClientset(&corev1.Node{
ObjectMeta: metav1.ObjectMeta{
Name: "fake-node-1",
Labels: map[string]string{
"fake.label.kubernetes.io": "fake",
        },
    },
})


获取到 ClientSet后,我们可以将 Client 作为入参传入到逻辑中,并且按照业务逻辑传入需要更新的 Labels

newLabels :=map[string]string{
"fake.label.kubernetes.io": "new-value",
}
err :=LabelNode(context.Background(), cs, "fake-node-1", newLabels)
iferr!=nil {
t.Error(err)
return}

此时我们再通过这个 ClientSet去调用,获取的资源就是经过逻辑处理后的了,通过 reflect.DeepEqual 进行比较。

同样的,如果我们在处理逻辑中对初始化时传入的资源进行了 Delete等操作,资源同样会被销毁掉。


在我们对 Kubernetes 资源的操作中,fakeClient 有些逻辑操作是无法实现的,比如对于 fieldSelector 的筛选,是不支持的,详细可以参考这个 isuue:https://github.com/kubernetes/kubernetes/issues/78824


如下逻辑中,如果对 DeploymentList 通过 fakeClient 进行过滤,无法生效, labelSelector 是可以的。

// parse field selectordefaultSelector := []string{
fmt.Sprintf("metadata.namespace!=%s", metav1.NamespaceDefault),
fmt.Sprintf("metadata.namespace!=%s", metav1.NamespaceSystem),
}
fieldSelector, err :=fields.ParseSelector(strings.Join(defaultSelector, ","))
iferr!=nil {
returnnil, nil, err}
options.FieldSelector=fieldSelector.String()
deployList, err :=d.cs.AppsV1().Deployments(metav1.NamespaceNone).List(context.Background(), options)
iferr!=nil {
returnnil, nil, err}


除了上述我们提到的NewSimpleClientset,快速创建一个 FakeClient,还可以通过添加 AddReactor 来对 action 进行判断,增加更详细的判断逻辑, 比如如下案例:

cs :=&fakeclientset.Clientset{}
cs.AddReactor("*", "deployments", func(actionclientgotesting.Action) (handledbool, retruntime.Object, errerror) {
returntrue, &appsv1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name:      name,
Namespace: namespace,
        },
Spec: appsv1.DeploymentSpec{
Selector: &metav1.LabelSelector{
MatchLabels: map[string]string{
"app": "busybox",
                },
            },
Template: corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Labels: map[string]string{
"app": "busybox",
                    },
                },
Spec: corev1.PodSpec{
Containers: []corev1.Container{
                        {
Name:  "container-1",
Image: "busybox",
                        },
                    },
                },
            },
        },
    }, nil})


相关链接:

相关实践学习
通过Ingress进行灰度发布
本场景您将运行一个简单的应用,部署一个新的应用用于新的发布,并通过Ingress能力实现灰度发布。
容器应用与集群管理
欢迎来到《容器应用与集群管理》课程,本课程是“云原生容器Clouder认证“系列中的第二阶段。课程将向您介绍与容器集群相关的概念和技术,这些概念和技术可以帮助您了解阿里云容器服务ACK/ACK Serverless的使用。同时,本课程也会向您介绍可以采取的工具、方法和可操作步骤,以帮助您了解如何基于容器服务ACK Serverless构建和管理企业级应用。 学习完本课程后,您将能够: 掌握容器集群、容器编排的基本概念 掌握Kubernetes的基础概念及核心思想 掌握阿里云容器服务ACK/ACK Serverless概念及使用方法 基于容器服务ACK Serverless搭建和管理企业级网站应用
目录
相关文章
|
7月前
|
数据采集 监控 机器人
浅谈网页端IM技术及相关测试方法实践(包括WebSocket性能测试)
最开始转转的客服系统体系如IM、工单以及机器人等都是使用第三方的产品。但第三方产品对于转转的业务,以及客服的效率等都产生了诸多限制,所以我们决定自研替换第三方系统。下面主要分享一下网页端IM技术及相关测试方法,我们先从了解IM系统和WebSocket开始。
146 4
|
2月前
|
缓存 测试技术 API
RESTful接口设计与测试实践
通过理解和实践上述原则和步骤,你就可以设计和测试你的RESTful接口了。最后,它可能会变成你为优化系统性能和用户体验所使用的重要工具,因为好的接口设计可以使得从服务器端到客户端的通信更加直接和有效,同时提升产品的使用体验和满意度。如此一来,写一个好的RESTful接口就变成一种享受。
127 18
|
3月前
|
监控 测试技术 数据库连接
利用 RunnerGo 深度探索 API 性能测试:从理论到实践
API性能测试是保障应用稳定性和用户体验的关键环节。本文详细探讨了如何使用RunnerGo全栈测试平台进行高效API性能测试,涵盖测试计划创建、场景设计、参数配置到执行与分析全过程。通过电商平台促销活动案例,展示了高并发下的测试策略与优化措施,如代码与数据库查询优化、数据库连接池扩容、服务器资源配置调整及缓存策略实施等。最终显著提升系统性能,满足高并发需求。API性能测试需持续关注与优化,以适应业务发展和用户需求变化。
144 33
|
7月前
|
人工智能 JavaScript 前端开发
自动化测试框架的演进与实践###
本文深入探讨了自动化测试框架从诞生至今的发展历程,重点分析了当前主流框架的优势与局限性,并结合实际案例,阐述了如何根据项目需求选择合适的自动化测试策略。文章还展望了未来自动化测试领域的技术趋势,为读者提供了宝贵的实践经验和前瞻性思考。 ###
120 11
|
5月前
|
JSON 前端开发 API
以项目登录接口为例-大前端之开发postman请求接口带token的请求测试-前端开发必学之一-如果要学会联调接口而不是纯写静态前端页面-这个是必学-本文以优雅草蜻蜓Q系统API为实践来演示我们如何带token请求接口-优雅草卓伊凡
以项目登录接口为例-大前端之开发postman请求接口带token的请求测试-前端开发必学之一-如果要学会联调接口而不是纯写静态前端页面-这个是必学-本文以优雅草蜻蜓Q系统API为实践来演示我们如何带token请求接口-优雅草卓伊凡
188 5
以项目登录接口为例-大前端之开发postman请求接口带token的请求测试-前端开发必学之一-如果要学会联调接口而不是纯写静态前端页面-这个是必学-本文以优雅草蜻蜓Q系统API为实践来演示我们如何带token请求接口-优雅草卓伊凡
|
4月前
|
数据可视化 JavaScript 前端开发
利用Postman和Apipost进行API测试的实践与优化-动态参数
在API测试中,Postman和Apipost是常用的工具。Postman内置变量功能有限,面对复杂场景时需编写JavaScript脚本,增加了维护成本。而Apipost提供丰富的内置变量、可视化动态值配置和低代码操作,支持生成真实随机数据,如邮箱、手机号等,显著提升测试效率和灵活性。对于复杂测试场景,Apipost是更好的选择,能有效降低开发与维护成本,提高测试工作的便捷性和可维护性。
|
7月前
|
测试技术 Python
探索软件测试的深度与广度:从理论到实践
在数字化时代,软件已成为我们生活中不可或缺的一部分。随着技术的不断进步和用户需求的多样化,确保软件质量变得尤为重要。本文将深入浅出地介绍软件测试的核心概念、类型及其在软件开发生命周期中的重要性。我们将通过实际案例,展示如何实施有效的测试策略,并探讨自动化测试的未来趋势,旨在为读者提供一套完整的软件测试知识体系,帮助提升软件质量和开发效率。
|
7月前
|
jenkins 测试技术 持续交付
自动化测试框架的搭建与实践
在软件开发领域,自动化测试是提升开发效率、确保软件质量的关键手段。本文将引导读者理解自动化测试的重要性,并介绍如何搭建一个基本的自动化测试框架。通过具体示例和步骤,我们将探索如何有效实施自动化测试策略,以实现软件开发流程的优化。
227 7
|
7月前
|
测试技术 Python
探索软件测试的奥秘:从理论到实践
在软件开发的宇宙中,软件测试犹如一颗璀璨的星辰,指引着质量的方向。本文将带你穿梭于软件测试的理论与实践之间,揭示其内在的逻辑和魅力。从测试的重要性出发,我们将探讨不同类型的测试方法,并通过实际案例分析,深入理解测试用例的设计和应用。最后,我们将通过一个代码示例,展示如何将理论知识转化为实际操作,确保软件质量的同时,也提升你的测试技能。让我们一起踏上这段探索之旅,发现软件测试的无限可能。
|
7月前
|
测试技术
探索软件测试的奥秘:从理论到实践
本文深入探讨了软件测试的基本概念、重要性、主要类型以及实施策略。通过分析不同测试阶段和相应的测试方法,文章旨在为读者提供一套完整的软件测试知识体系,帮助他们更好地理解和应用测试技术,确保软件产品的质量和可靠性。
119 4