Operator SDK 自定义 Scorecard 测试开发指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00500/article/details/148464124

Operator SDK 自定义 Scorecard 测试开发指南

operator-sdk Operator SDK是一个开源的Kubernetes Operator开发框架，用于简化Kubernetes应用程序的部署、管理和升级。 - 功能：Kubernetes Operator开发；应用程序管理；部署；升级。 - 特点：易于使用；支持多种编程语言；与Kubernetes集成；自动化部署和管理。项目地址: https://gitcode.com/gh_mirrors/op/operator-sdk

概述

本文将详细介绍如何在 Operator SDK 中开发自定义的 Scorecard 测试。Scorecard 是 Operator Framework 提供的一个测试框架，用于验证 Operator 是否符合最佳实践。通过自定义测试，开发者可以针对特定业务需求扩展测试能力。

核心概念

Scorecard 测试类型

基础测试：验证 Operator 的基本功能
OLM 测试：验证 Operator 的生命周期管理
自定义测试：开发者根据业务需求实现的特定测试

测试执行流程

Scorecard 创建测试 Pod
测试镜像运行并执行测试逻辑
测试结果以 JSON 格式返回

开发自定义测试

项目结构

典型的自定义测试项目包含以下关键目录和文件：

.
├── config/scorecard/          # 测试配置
│   ├── bases/config.yaml      # 基础配置
│   ├── patches/               # 测试补丁
│   └── kustomization.yaml     # Kustomize 配置
├── bundle/                    # 测试用 Bundle
├── images/                    # 测试镜像
│   └── custom-scorecard-tests/
│       ├── Dockerfile         # 镜像构建文件
│       └── cmd/test/main.go   # 测试入口
└── internal/tests/            # 测试实现
    └── tests.go

实现自定义测试

在 internal/tests/tests.go 文件中实现测试逻辑：

package tests

import (
  apimanifests "github.com/operator-framework/api/pkg/manifests"
  scapiv1alpha3 "github.com/operator-framework/api/pkg/apis/scorecard/v1alpha3"
)

const CustomTest1Name = "customtest1"

func CustomTest1(bundle *apimanifests.Bundle) scapiv1alpha3.TestStatus {
  r := scapiv1alpha3.TestResult{
    Name:        CustomTest1Name,
    State:       scapiv1alpha3.PassState,
    Errors:      []string{},
    Suggestions: []string{},
  }
  
  // 实现测试逻辑
  
  return wrapResult(r)
}

配置测试

在 config/scorecard/patches/ 下创建测试配置：

- op: add
  path: /stages/0/tests/-
  value:
    image: quay.io/<username>/custom-scorecard-tests:latest
    entrypoint:
    - custom-scorecard-tests
    - customtest1
    labels:
      suite: custom
      test: customtest1

更新 kustomization.yaml：

patchesJson6902:
- path: patches/customtest1.config.yaml
  target:
    group: scorecard.operatorframework.io
    version: v1alpha3
    kind: Configuration
    name: config

构建测试镜像

使用 Makefile 构建测试镜像：

image/custom-scorecard-tests:
  docker build -t quay.io/<username>/custom-scorecard-tests:latest \
    -f images/custom-scorecard-tests/Dockerfile .

运行自定义测试

执行测试命令：

operator-sdk scorecard <bundle_dir_or_image> \
  --selector=suite=custom \
  -o json \
  --wait-time=32s \
  --skip-cleanup=false

高级功能

调试技巧

使用 --skip-cleanup 保留测试 Pod 用于调试
查看 Pod 日志获取详细错误信息

测试输出存储

operator-sdk scorecard ./bundle --test-output=/mytestoutput

离线环境支持

operator-sdk scorecard ./bundle \
  --storage-image=my-busybox:latest \
  --untar-image=my-untar:latest

多测试结果返回

测试可以返回多个结果：

func ComplexTest(bundle *apimanifests.Bundle) scapiv1alpha3.TestStatus {
  status := scapiv1alpha3.TestStatus{}
  
  // 第一个测试结果
  result1 := scapiv1alpha3.TestResult{
    Name:  "subtest1",
    State: scapiv1alpha3.PassState,
  }
  
  // 第二个测试结果
  result2 := scapiv1alpha3.TestResult{
    Name:  "subtest2",
    State: scapiv1alpha3.FailState,
  }
  
  status.Results = append(status.Results, result1, result2)
  return status
}