cfcloudops/cf-smoke-tests

CF Smoke Tests

镜像概述和主要用途

CF Smoke Tests是一套针对Cloud Foundry的基础核心功能测试套件。它适用于新部署或更新后的初始测试，以揭示系统的基本问题。由于对系统负载极小且可配置为仅需普通用户访问权限，因此也可安全地定期在生产环境中运行，Cloud Foundry操作员可将其用作运行中部署的监控工具。

该测试套件不旨在测试Cloud Foundry的复杂功能或管理员操作。https://github.com/cloudfoundry/cf-acceptance-tests%E6%8F%90%E4%BE%9B%E6%9B%B4%E5%B9%BF%E6%B3%9B%E7%9A%84%E6%B5%8B%E8%AF%95%EF%BC%8C%E4%BD%86%E8%AE%BE%E8%AE%A1%E7%94%A8%E4%BA%8E%E5%BC%80%E5%8F%91%E6%B5%81%E6%B0%B4%E7%BA%BF%EF%BC%8C%E8%80%8C%E9%9D%9E%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83%E3%80%82

核心功能和特性

• 基础核心功能验证：测试Cloud Foundry的基本运行能力，确保核心功能正常工作
• 低系统负载：对生产环境影响小，适合定期运行而不干扰业务
• 普通用户权限：可配置为仅需普通用户访问权限，无需管理员权限
• 生产环境友好：安全用于生产环境监控，及时发现基础功能故障

使用场景和适用范围

使用场景

• 新部署Cloud Foundry后的初始功能验证
• Cloud Foundry更新或升级后的基础功能确认
• 生产环境定期健康检查，监控系统基础运行状态
• 快速检测系统基础功能故障（如应用部署、访问等）

适用范围

• Cloud Foundry系统操作员
• 需要验证CF基础功能的开发/运维团队
• 生产环境监控与维护人员

使用方法和配置说明

使用Docker镜像

构建镜像

bash
docker build .

运行测试

bash
docker run -e "CONFIG_CONTENT=$(cat ../runtime-config.json)" <image_id>

说明：<image_id>为构建的Docker镜像ID，../runtime-config.json为包含测试配置的JSON文件路径

设置Go环境（非Docker方式）

如需通过Go环境直接运行测试，需按以下步骤配置：

1. 按照golang.org安装Go开发环境
2. 安装必要的SCM工具：
   • git
   • mercurial
   • bazaar
3. 安装Go版本的cf CLI，参考https://github.com/cloudfoundry/cli
4. 确保系统已安装curl
5. 确保cf CLI在$PATH中可访问
6. 获取测试源码：

   bash
   go get -d github.com/cloudfoundry/cf-smoke-tests
   

   注：可能会收到"no buildable Go source files"警告，可忽略

7. 测试依赖已包含在cf-smoke-tests/Godeps目录，bin/test脚本会自动处理依赖

测试配置

运行测试需满足：

• 一个运行中的Cloud Foundry实例
• 环境变量$CONFIG指向包含配置的JSON文件

配置文件示例（integration_config.json）

json
{
  "suite_name": "CF_SMOKE_TESTS",
  "api": "api.bosh-lite.com",
  "apps_domain": "bosh-lite.com",
  "user": "admin",
  "password": "admin",
  "org": "CF-SMOKE-ORG",
  "space": "CF-SMOKE-SPACE",
  "cleanup": true,
  "use_existing_org": false,
  "use_existing_space": false,
  "logging_app": "",
  "runtime_app": "",
  "enable_windows_tests": false,
  "backend": "diego"
}

关键配置参数说明

测试执行

基本执行命令

bash
./bin/test

说明：内部使用https://github.com/onsi/ginkgo%E8%BF%90%E8%A1%8C%E6%B5%8B%E8%AF%95

传递参数给ginkgo

可将ginkgo参数直接传递给脚本，例如：

bash
# 并行运行2个进程
./bin/test -nodes=2

# 仅运行匹配特定焦点的测试
./bin/test -focus="应用部署"

查看详细输出

使用-v标志查看cf命令的详细输出：

bash
./bin/test -v

捕获CF CLI输出

在配置文件中设置artifacts_directory以存储跟踪日志：

json
"artifacts_directory": "/tmp/smoke-artifacts"

可能生成的文件包括：

CF-TRACE-Smoke-1.txt
CF-TRACE-Smoke-2.txt
junit-Applications-1.xml

更改冒烟测试

依赖管理

Smoke Tests使用https://github.com/tools/godep%E7%AE%A1%E7%90%86Go%E4%BE%9D%E8%B5%96%E3%80%82%E6%89%80%E6%9C%89%E5%BF%85%E8%A6%81%E7%9A%84Go%E5%8C%85%E5%9D%87%E5%B7%B2vendored%E5%88%B0%60cf-smoke-tests/Godeps%60%E7%9B%AE%E5%BD%95%E3%80%82

当引入新依赖时，应遵循https://github.com/tools/godep#add-a-dependency%E4%B8%AD%E7%9A%84%22Add or Update a Dependency"工作流。