Go 中模擬 Kubernetes 客戶端進(jìn)行單元測試

Go 中模擬 Kubernetes 客戶端進(jìn)行單元測試

是的，我們可以模仿 K8s Client！

編寫單元測試一直是開發(fā)人員的痛苦。這樣做的主要原因是，通常，單元測試（功能單元測試）不得使用應(yīng)用程序的任何物理組件/運行實例。例如，API 的 SDK 的單元測試不應(yīng)該有 API 的任何運行實例。這就是為什么模擬應(yīng)用程序?qū)嵗兊弥陵P(guān)重要，這也是訣竅！

在本文中，我們將了解如何使用client-go 包中的 fake（偽造的） clientset （客戶端集）模擬 Kubernetes 客戶端。讓我們開始吧！

創(chuàng)建一個名為client和一個名為client.go它定義了一個名為Client持有 KubernetesClientset.

Kubernetes Clientset

  • 包含組的客戶端（clients for groups）
  • 是實現(xiàn)了 Kubernetes 接口Interface的 struct
  • NewForConfig()是 Kubernetes Interface 接口的構(gòu)造函數(shù)，返回 Clientset 對象

繼續(xù)，讓我們在client.go中定義一個被稱作Client的 public struct

// Client is the struct to hold the Kubernetes Clientset
type Client struct {
    Clientset kubernetes.Interface
}

創(chuàng)建一個名為 CreatePod 的方法，該方法是 Client 結(jié)構(gòu)的方法，用來在給定的 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文件看起來像這樣：

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)在，讓我們實現(xiàn)一個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,
}
  • 定義一個pod資源對象
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",
                },
            },
        },
    }
  • 對client對象的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文件看起來像這樣：

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)我們對一個正在運行的集群運行 main.go 文件時，我們最終會在默認(rèn)名稱空間中創(chuàng)建一個名為 test-pod 的 pod。

現(xiàn)在，讓我們使用 Go 的testing包編寫一個單元測試。在這里，為了創(chuàng)建 Kubernetes Clientset，我們使用 client-go/kubernetes包中的fake 包的NewSimpleClientSet()構(gòu)造函數(shù)，而不是NewForConfig()構(gòu)造函數(shù)。

有什么區(qū)別？

NewForConfig()構(gòu)造函數(shù)返回實際ClientSet它具有每個 Kubernetes 組的客戶端并在實際集群上運行。 然而，NewSimpleClientSet()構(gòu)造函數(shù)返回將使用提供的對象進(jìn)行響應(yīng)的客戶端集。它由一個非常簡單的對象跟蹤器支持，該跟蹤器按原樣處理創(chuàng)建、更新和刪除，而不應(yīng)用任何驗證和默認(rèn)值。

這里需要注意的是fake包中的Clientset 也實現(xiàn)了 Kubernetes 接口。旨在嵌入到結(jié)構(gòu)中以獲得默認(rèn)實現(xiàn)。這使得僅偽造您想要測試的方法變得更加容易。

我們main_test.go看起來像這樣：

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 命令運行這個測試文件，我們將成功地執(zhí)行 CreatePod()方法，即使沒有對任何正在運行的 K8s 集群運行這個方法，并且通過模仿 Get () 調(diào)用返回作為參數(shù)發(fā)送給它的相同對象。輸出結(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)建測試框架或單元測試包。

出處

Mocking the Kubernetes client in Go for Unit Testing

說明

請關(guān)注 危 ? 工中號【進(jìn)擊云原生】，更有free資源供您學(xué)習(xí)

本文由mdnice多平臺發(fā)布

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容