brunty/cigar

Cigar Docker镜像

镜像概述和主要用途

Cigar是一个受https://github.com/symm/vape%E5%90%AF%E5%8F%91%E7%9A%84%E7%83%9F%E9%9B%BE%E6%B5%8B%E8%AF%95%E5%B7%A5%E5%85%B7%EF%BC%8C%E7%94%A8%E4%BA%8E%E9%AA%8C%E8%AF%81URL%E6%98%AF%E5%90%A6%E8%BF%94%E5%9B%9E%E9%A2%84%E6%9C%9F%E7%9A%84%E7%8A%B6%E6%80%81%E7%A0%81%E3%80%81%E5%86%85%E5%AE%B9%E5%8F%8A%E5%86%85%E5%AE%B9%E7%B1%BB%E5%9E%8B%E3%80%82%E7%B1%BB%E4%BC%BC%E5%B7%A5%E5%85%B7%E5%8C%85%E6%8B%AChttps://github.com/blackfireio/player%E3%80%82%E6%9C%ACDocker%E9%95%9C%E5%83%8F%E6%8F%90%E4%BE%9B%E4%BE%BF%E6%8D%B7%E7%9A%84Cigar%E5%B7%A5%E5%85%B7%E9%83%A8%E7%BD%B2%E6%96%B9%E5%BC%8F%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8E%E5%BC%80%E5%8F%91%E5%92%8C%E6%B5%8B%E8%AF%95%E7%8E%AF%E5%A2%83%E4%B8%AD%E7%9A%84%E7%BD%91%E7%AB%99%E6%88%96API%E7%83%9F%E9%9B%BE%E6%B5%8B%E8%AF%95%E3%80%82

核心功能和特性

• 验证URL的HTTP状态码是否符合预期
• 检查响应内容是否包含指定文本
• 验证响应的Content-Type是否符合预期
• 支持自定义配置文件
• 可指定基础URL，支持相对路径
• 支持禁用SSL证书验证（仅必要时使用）
• 可添加Authorization头和自定义HTTP头
• 提供安静模式，抑制输出
• 命令行帮助和版本信息查询

使用场景和适用范围

• 网站部署后的基础可用性测试
• API接口的状态码和响应内容验证
• 持续集成/持续部署(CI/CD)流程中的冒烟测试
• 开发环境中快速验证URL响应是否符合预期

使用方法和配置说明

拉取镜像

bash
docker pull brunty/cigar

创建配置文件

创建.cigar.json文件，包含测试URL配置数组。每个配置对象字段说明：

• url (必填): 测试URL（绝对URL或相对路径）
• status (必填): 预期HTTP状态码
• content (可选): 预期响应中包含的文本
• content-type (可选): 预期响应的Content-Type

示例配置文件：

json
[
  {
    "url": "http://httpbin.org/status/418",
    "status": 418,
    "content": "teapot"
  },
  {
    "url": "http://httpbin.org/status/200",
    "status": 200,
    "content-type": "text/html"
  },
  {
    "url": "http://httpbin.org/status/304",
    "status": 304
  },
  {
    "url": "http://httpbin.org/status/500",
    "status": 500
  }
]

运行容器

在配置文件所在目录执行：

bash
docker run -v $(pwd):/app --rm brunty/cigar

输出格式

每行输出格式：

pass/fail url [expected_code:actual_code] [optional_expected_content-type:optional_actual_content-type] optional_text

示例输出：

✓ http://httpbin.org/status/418 [418:418] teapot
✓ http://httpbin.org/status/200 [200:200] [text/html:text/html] 
✓ http://httpbin.org/status/304 [304:304] 
✓ http://httpbin.org/status/500 [500:500] 

返回码说明：所有测试通过返回0；任何测试未达预期返回1。

命令行选项

安静测试模式

抑制输出，仅返回状态码：

bash
docker run -v $(pwd):/app --rm brunty/cigar --quiet

替代配置文件

指定非默认配置文件：

bash
# 短选项
docker run -v $(pwd):/app --rm brunty/cigar -c custom-config.json
# 长选项
docker run -v $(pwd):/app --rm brunty/cigar --config=custom-config.json

指定基础URL

测试相对路径时指定基础URL：

bash
# 短选项
docker run -v $(pwd):/app --rm brunty/cigar -u http://httpbin.org
# 长选项
docker run -v $(pwd):/app --rm brunty/cigar --url=http://httpbin.org

配置文件中可使用相对路径（带或不带前导斜杠）：

json
[
  {
    "url": "/status/418",
    "status": 418,
    "content": "teapot"
  },
  {
    "url": "status/418",
    "status": 418,
    "content": "teapot"
  }
]

禁用SSL证书验证

仅必要时使用，跳过SSL证书检查：

bash
# 短选项
docker run -v $(pwd):/app --rm brunty/cigar -i
# 长选项
docker run -v $(pwd):/app --rm brunty/cigar --insecure

添加Authorization头

传递Authorization头：

bash
# 短选项
docker run -v $(pwd):/app --rm brunty/cigar -a "Basic dXNyOnBzd2Q="
# 长选项
docker run -v $(pwd):/app --rm brunty/cigar --auth="Basic dXNyOnBzd2Q="

添加自定义头

添加一个或多个自定义HTTP头：

bash
# 短选项
docker run -v $(pwd):/app --rm brunty/cigar -h "Cache-control: no-cache"
# 长选项
docker run -v $(pwd):/app --rm brunty/cigar --header="Cache-control: no-cache"

查看帮助和版本

查看所有选项：

bash
docker run --rm brunty/cigar --help

查看版本信息：

bash
docker run --rm brunty/cigar --version