Kubernetes client-go使用自定义客户端时如何编写单元测试

问题根因 #

你使用的是自定义CRD对应的专属客户端*v1alpha1.ExampleV1Alpha1Client，官方通用的fake.NewSimpleClientset()返回的是内置K8s资源的假客户端，没有实现你自定义的ComputeMons方法，因此类型不匹配无法直接传入。

方案1：使用CRD代码生成的专属假客户端（推荐） #

你在使用code-generator或者kubebuilder生成CRD的客户端代码时，工具会自动生成对应API组的假客户端，直接使用即可：

1. 确认你的项目中已经生成了自定义API组的假客户端，一般路径为pkg/generated/clientset/versioned/typed/acme.com/v1alpha1/fake
2. 测试代码示例：

import (
    "testing"
    "your-project/pkg/apis/acme.com/v1alpha1"
    fakeacme "your-project/pkg/generated/clientset/versioned/typed/acme.com/v1alpha1/fake"
    metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    "k8s.io/apimachinery/pkg/runtime"
)

func TestCRRead(t *testing.T) {
    // 构造测试用的假CR数据
    testCR := &v1alpha1.ComputeMon{
        ObjectMeta: metav1.ObjectMeta{
            Name:      "test-instance",
            Namespace: "default",
        },
        // 按需填充Spec字段
        Spec: v1alpha1.ComputeMonSpec{},
    }

    // 初始化自定义假客户端，注入测试数据
    fakeClient := &fakeacme.FakeExampleV1Alpha1{
        Fake: &runtime.Fake{
            Objects: []runtime.Object{testCR},
        },
    }

    // 调用待测试方法
    resp := GetComCR(fakeClient)
    // 此处添加断言，验证返回结果是否符合预期
}

方案2：接口抽象+Mock（灵活度更高） #

如果不想依赖生成的假客户端，可以先对业务代码做小改造，通过接口解耦后用Mock工具测试：

1. 首先定义抽象接口，ExampleV1Alpha1Client会自动实现该接口：

type ComputeMonGetter interface {
    ComputeMons(namespace string) v1alpha1.ComputeMonInterface
}

2. 修改GetComCR方法的入参类型为上述接口：

// 原方法签名：func GetComCR(kubeClient *v1alpha1.ExampleV1Alpha1Client) []byte
// 修改后：
func GetComCR(kubeClient ComputeMonGetter) []byte {
    // 原有逻辑完全不变
}

3. 用GoMock等工具Mock该接口，按需打桩ComputeMons方法的返回值即可完成测试，无需依赖K8s相关的假客户端实现。

内容的提问来源于stack exchange，提问作者OMKAR HINGMIRE