如何在Go中Mock Kubernetes自定义资源以测试Client Read API？

问题场景 #

我有一个读取自定义资源（CR）的场景，示例代码如下：

type Image Struct {
    metav1.TypeMeta   `json:",inline"`
    metav1.ObjectMeta `json:"metadata,omitempty"`

    Spec   ImageSpec   `json:"spec,omitempty"`
    Status ImageStatus `json:"status,omitempty"`
}

list := v1alpha1.ImageList{}
err := srv.restClient.
    Get().
    Resource("images").
    Do(ctx).
    Into(&list)

我正在使用fake ClientSet创建模拟RestClient，查阅文档后尝试了多个接口，却找不到创建模拟CR的API，该如何Mock这些images资源来测试函数？

解决方案 #

1. 标准fake ClientSet的局限性 #

client-go/kubernetes/fake提供的ClientSet仅支持Kubernetes内置资源（如Pod、Deployment），不直接支持自定义资源。要Mock CR，必须使用针对你的CR生成的自定义fake客户端，而非通用的fake ClientSet。

2. 生成自定义fake客户端 #

借助code-generator工具为你的CR生成专属客户端（包含fake实现）：

• 确保你的CRD定义和Go结构体符合Kubernetes API规范
• 运行生成命令（示例）：

./generate-groups.sh all \
  github.com/your-org/your-repo/client \
  github.com/your-org/your-repo/api \
  "mygroup.example.com:v1alpha1"

替换命令中的API组、版本和代码路径后，生成的client/fake包中会包含针对Image资源的fake客户端。

3. 初始化fake客户端并注入测试数据 #

生成完成后，在测试中这样使用：

// 初始化自定义fake客户端
fakeClient := fake.NewSimpleClientset()

// 创建测试用的Image CR实例
testImage := &v1alpha1.Image{
    TypeMeta: metav1.TypeMeta{
        APIVersion: "mygroup.example.com/v1alpha1",
        Kind:       "Image",
    },
    ObjectMeta: metav1.ObjectMeta{
        Name:      "test-image",
        Namespace: "default",
    },
    Spec: ImageSpec{
        // 填充测试用的Spec字段
    },
}

// 将测试CR添加到fake客户端存储中
if err := fakeClient.Create(ctx, testImage); err != nil {
    t.Fatalf("创建测试Image失败: %v", err)
}

// 将fake客户端的RESTClient注入到待测试服务中
srv.restClient = fakeClient.RESTClient()

之后执行测试时，你的代码通过restClient读取的就是fake客户端中预存的测试CR数据。

4. 替代方案：直接Mock RESTClient调用链 #

如果不想生成自定义客户端，可以用testify/mock这类框架直接MockrestClient的调用过程：

type MockRestClient struct {
    mock.Mock
}

func (m *MockRestClient) Get() *rest.Request {
    args := m.Called()
    return args.Get(0).(*rest.Request)
}

func (m *MockRestClient) Resource(resource string) *rest.Request {
    args := m.Called(resource)
    return args.Get(0).(*rest.Request)
}

// 按需实现Do、Into等其他方法

// 测试中使用
mockRC := new(MockRestClient)
mockReq := &rest.Request{}

// 设置Mock预期
mockRC.On("Get").Return(mockReq)
mockRC.On("Resource", "images").Return(mockReq)
// 继续Mock Do、Into等方法的行为以返回预设的ImageList数据

srv.restClient = mockRC

这种方式需要Mock完整调用链，相对繁琐，优先推荐自定义fake客户端方案。

内容的提问来源于stack exchange，提问作者Nisarg Shah