miko/waitforit

waitforit

镜像概述

waitforit是一款轻量级工具，用于在应用程序启动前等待依赖的服务地址（如HTTP接口、TCP端口等）变为可用状态，或验证其返回的JSON响应是否符合预期。它广泛应用于微服务架构、容器化部署场景，帮助避免因依赖服务未就绪导致的启动失败问题。

核心功能

• 支持HTTP(S)、TCP、SSH等多种协议
• 可验证目标地址的响应状态码（如200）
• 支持检查返回的JSON响应是否匹配预期内容
• 允许自定义HTTP请求头（如Authorization）
• 支持通过JSON配置文件批量设置等待规则
• 可在地址就绪后执行后续命令
• 提供调试模式及详细日志输出

使用场景

1. 微服务启动时，等待数据库、消息队列或其他依赖服务就绪
2. CI/CD流水线中，等待测试环境的服务启动完成后再执行测试
3. Docker容器编排（如Docker Compose）中，确保依赖容器先启动并可用

配置说明

命令行选项

• -address: 指定目标地址（格式示例：[***]
• -proto: 连接使用的协议
• -host: 目标主机
• -port: 目标端口（默认值：80）
• -status: 预期的响应状态码（如200）
• -timeout: 等待超时时间（单位：秒）
• -retry: 重试间隔（单位：毫秒，默认值：500）
• -insecure: 允许不安全的SSL连接
• -debug: 启用调试模式
• -v: 显示当前版本
• -file: JSON配置文件路径
• -header: HTTP请求头（可多次使用，如-header "Authorization: Basic ..."）
• --: 地址就绪后执行的命令（如-- printf "服务可用！"）
• -body: 打印响应体
• -expected_json: 预期的JSON响应内容（需配合-body使用）
• -jq: 使用jq路径提取响应体子集（需配合-expected_json使用）

使用示例

命令行运行

bash
# 等待google.com:90端口20秒，开启调试
waitforit -host=google.com -port=90 -timeout=20 -debug

# 通过address参数指定TCP地址
waitforit -address=tcp://google.com:90 -timeout=20 -debug

# 等待HTTP地址就绪后执行命令
waitforit -address=http://google.com -timeout=20 -debug -- printf "Google服务可用！"

# 带自定义请求头的HTTP等待
waitforit -address=http://google.com -header "Authorization: Basic Zm9vOmJhcg==" -header "X-ID: 111" -debug

# 验证JSON响应是否符合预期
waitforit -address https://jsonplaceholder.typicode.com/todos/1 -body -expected_json '{"userId":1}'

使用配置文件

创建JSON配置文件（如config.json）：

json
{
  "configs": [
    {
      "host": "google.com",
      "port": 80,
      "timeout": 20,
      "retry": 500,
      "headers": {
        "Authorization": "Basic Zm9vOmJhcg==",
        "X-ID": "111"
      }
    },
    {
      "address": "http://google.com:80",
      "timeout": 40
    }
  ]
}

运行命令：

bash
waitforit -file=./config.json

Dockerfile安装示例

使用curl

dockerfile
FROM node:6.5.0

ENV WAITFORIT_VERSION="v2.4.1"
RUN curl -o /usr/local/bin/waitforit -sSL https://github.com/maxcnunes/waitforit/releases/download/$WAITFORIT_VERSION/waitforit-linux_amd64 && \
    chmod +x /usr/local/bin/waitforit

使用wget

dockerfile
FROM node:6.5.0

ENV WAITFORIT_VERSION="v2.4.1"
RUN wget -q -O /usr/local/bin/waitforit https://github.com/maxcnunes/waitforit/releases/download/$WAITFORIT_VERSION/waitforit-linux_amd64 \
    && chmod +x /usr/local/bin/waitforit