Go 中模擬 Kubernetes 客戶端進(jìn)行單元測(cè)試
是的，我們可以模仿 K8s Client太示！
編寫(xiě)單元測(cè)試一直是開(kāi)發(fā)人員的痛苦侥锦。這樣做的主要原因是，通常，單元測(cè)試（功能單元測(cè)試）不得使用應(yīng)用程序的任何物理組件/運(yùn)行實(shí)例平绩。例如圈匆，API 的 SDK 的單元測(cè)試不應(yīng)該有 API 的任何運(yùn)行實(shí)例。這就是為什么模擬應(yīng)用程序?qū)嵗兊弥陵P(guān)重要捏雌，這也是訣竅跃赚！
在本文中，我們將了解如何使用client-go 包中的 fake（偽造的） clientset （客戶端集）模擬 Kubernetes 客戶端性湿。讓我們開(kāi)始吧纬傲！
創(chuàng)建一個(gè)名為client和一個(gè)名為client.go它定義了一個(gè)名為Client持有 KubernetesClientset.
Kubernetes Clientset
- 包含組的客戶端（clients for groups）
- 是實(shí)現(xiàn)了 Kubernetes 接口
Interface的 struct -
NewForConfig()是 KubernetesInterface接口的構(gòu)造函數(shù)，返回 Clientset 對(duì)象
繼續(xù)肤频，讓我們?cè)?code>client.go中定義一個(gè)被稱作Client的 public struct
// Client is the struct to hold the Kubernetes Clientset
type Client struct {
Clientset kubernetes.Interface
}
創(chuàng)建一個(gè)名為 CreatePod 的方法叹括，該方法是 Client 結(jié)構(gòu)的方法，用來(lái)在給定的 namespace（名稱空間）中創(chuàng)建 pods宵荒，如同 Client.go 文件中所示：
// CreatePod method creates pod in the cluster referred by the Client
func (c Client) CreatePod(pod *v1.Pod) (*v1.Pod, error) {
pod, err := c.Clientset.CoreV1().Pods(pod.Namespace).Create(context.TODO(), pod, metav1.CreateOptions{})
if err != nil {
klog.Errorf("Error occured while creating pod %s: %s", pod.Name, err.Error())
return nil, err
}
klog.Infof("Pod %s is succesfully created", pod.Name)
return pod, nil
}
完整的client.go文件看起來(lái)像這樣：
package client
import (
"context"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/klog/v2"
)
type Client struct {
Clientset kubernetes.Interface
}
func (c Client) CreatePod(pod *v1.Pod) (*v1.Pod, error) {
pod, err := c.Clientset.CoreV1().Pods(pod.Namespace).Create(context.TODO(), pod, metav1.CreateOptions{})
if err != nil {
klog.Errorf("Error occured while creating pod %s: %s", pod.Name, err.Error())
return nil, err
}
klog.Infof("Pod %s is succesfully created", pod.Name)
return pod, nil
}
現(xiàn)在汁雷，讓我們實(shí)現(xiàn)一個(gè)main.go調(diào)用上述CreatePod方法。為此报咳，我們需要
- 建立
clientset
kubeconfig = "<path to kubeconfig file>"
config, err := clientcmd.BuildConfigFromFlags("", kubeconfig)
if err != nil {
panic(err.Error())
}
clientset, err := kubernetes.NewForConfig(config)
if err != nil {
panic(err.Error())
}
view raw
- 加載
Client結(jié)構(gòu)
client := client.Client{
Clientset: clientset,
}
- 定義一個(gè)
pod資源對(duì)象
pod := &v1.Pod{
TypeMeta: metav1.TypeMeta{
Kind: "Pod",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: "test-pod",
Namespace: "default",
},
Spec: v1.PodSpec{
Containers: []v1.Container{
{
Name: "nginx",
Image: "nginx",
ImagePullPolicy: "Always",
},
},
},
}
- 對(duì)
client對(duì)象的CreatePod方法進(jìn)行調(diào)用
pod, err = client.CreatePod(pod)
if err != nil {
fmt.Printf("%s", err)
}
klog.Infof("Pod %s has been successfully created", pod.Name)
完整的main.go文件看起來(lái)像這樣：
package main
import (
"fmt"
client "github.com/kubernetes-sdk-for-go-101/pkg/client"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/tools/clientcmd"
"k8s.io/klog/v2"
)
func main() {
kubeconfig := "<path to kubeconfig file>"
config, err := clientcmd.BuildConfigFromFlags("", kubeconfig)
if err != nil {
panic(err.Error())
}
clientset, err := kubernetes.NewForConfig(config)
if err != nil {
panic(err.Error())
}
client := client.Client{
Clientset: clientset,
}
pod := &v1.Pod{
TypeMeta: metav1.TypeMeta{
Kind: "Pod",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: "test-pod",
Namespace: "default",
},
Spec: v1.PodSpec{
Containers: []v1.Container{
{
Name: "nginx",
Image: "nginx",
ImagePullPolicy: "Always",
},
},
},
}
pod, err = client.CreatePod(pod)
if err != nil {
fmt.Printf("%s", err)
}
klog.Infof("Pod %s has been successfully created", pod.Name)
}
當(dāng)我們對(duì)一個(gè)正在運(yùn)行的集群運(yùn)行 main.go 文件時(shí)侠讯，我們最終會(huì)在默認(rèn)名稱空間中創(chuàng)建一個(gè)名為 test-pod 的 pod。
現(xiàn)在暑刃，讓我們使用 Go 的testing包編寫(xiě)一個(gè)單元測(cè)試厢漩。在這里，為了創(chuàng)建 Kubernetes Clientset稍走，我們使用 client-go/kubernetes包中的fake 包的NewSimpleClientSet()構(gòu)造函數(shù)袁翁，而不是NewForConfig()構(gòu)造函數(shù)。
有什么區(qū)別婿脸？
NewForConfig()構(gòu)造函數(shù)返回實(shí)際ClientSet它具有每個(gè) Kubernetes 組的客戶端并在實(shí)際集群上運(yùn)行粱胜。 然而，NewSimpleClientSet()構(gòu)造函數(shù)返回將使用提供的對(duì)象進(jìn)行響應(yīng)的客戶端集狐树。它由一個(gè)非常簡(jiǎn)單的對(duì)象跟蹤器支持焙压，該跟蹤器按原樣處理創(chuàng)建、更新和刪除抑钟，而不應(yīng)用任何驗(yàn)證和默認(rèn)值涯曲。
這里需要注意的是fake包中的Clientset 也實(shí)現(xiàn)了 Kubernetes 接口。旨在嵌入到結(jié)構(gòu)中以獲得默認(rèn)實(shí)現(xiàn)在塔。這使得僅偽造您想要測(cè)試的方法變得更加容易幻件。
我們main_test.go看起來(lái)像這樣：
package main
import (
"fmt"
"testing"
client "github.com/kubernetes-sdk-for-go-101/pkg/client"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
testclient "k8s.io/client-go/kubernetes/fake"
)
func TestCreatePod(t *testing.T) {
var client client.Client
client.Clientset = testclient.NewSimpleClientset()
pod := &v1.Pod{
TypeMeta: metav1.TypeMeta{
Kind: "Pod",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: "test-pod",
Namespace: "default",
},
Spec: v1.PodSpec{
Containers: []v1.Container{
{
Name: "nginx",
Image: "nginx",
ImagePullPolicy: "Always",
},
},
},
}
_, err := client.CreatePod(pod)
if err != nil {
fmt.Print(err.Error())
}
}
現(xiàn)在，如果我們使用 go test 命令運(yùn)行這個(gè)測(cè)試文件蛔溃，我們將成功地執(zhí)行 CreatePod()方法绰沥，即使沒(méi)有對(duì)任何正在運(yùn)行的 K8s 集群運(yùn)行這個(gè)方法篱蝇，并且通過(guò)模仿 Get () 調(diào)用返回作為參數(shù)發(fā)送給它的相同對(duì)象。輸出結(jié)果如圖所示
go test
I0520 00:02:03.789351 23893 pod.go:23] Pod test-pod is succesfully created
PASS
ok github.com/kubernetes-sdk-for-go-101 0.681s
您可以將本文作為參考徽曲，并以此為基礎(chǔ)零截，為您使用 Kubernetes client-go 的應(yīng)用程序構(gòu)建測(cè)試框架或單元測(cè)試包。
出處
Mocking the Kubernetes client in Go for Unit Testing
說(shuō)明
請(qǐng)關(guān)注 危 ? 工中號(hào)【進(jìn)擊云原生】秃臣，更有free資源供您學(xué)習(xí)
本文由mdnice多平臺(tái)發(fā)布
