ibmcom/bats-ppc64le

Bats Docker镜像文档

镜像概述

Bats Docker镜像是基于Bats（Bash Automated Testing System）构建的预配置测试环境，提供Bash脚本的自动化测试能力。Bats作为轻量级Bash测试框架，通过简单的语法和断言机制，帮助开发者验证Bash脚本的功能正确性，减少手动测试成本。

支持的标签

• 0.4.0: Bats 0.4.0稳定版本镜像
• latest: 最新稳定版本镜像（默认指向最新发布版）

核心功能与特性

Bats框架核心功能

• 简洁测试语法：采用类Bash脚本的语法编写测试用例，易于上手
• 断言支持：内置assert、refute等断言函数，验证命令输出、退出码及文件状态
• 测试隔离：每个测试用例在独立子Shell中执行，避免环境变量污染
• 报告生成：输出清晰的测试结果，显示通过/失败用例及详细错误信息

Docker镜像特性

• 即开即用：预配置Bats运行环境，无需手动安装依赖（如Bash、核心工具链）
• 多版本兼容：提供稳定版本标签（0.4.0）与最新版本标签（latest），满足不同场景需求
• 轻量级设计：基于精简基础镜像构建，降低资源占用，加速容器启动

使用场景与适用范围

• Bash脚本开发：开发者本地验证脚本逻辑，快速定位语法错误和功能缺陷
• CI/CD流水线：集成到自动化构建流程（如GitHub Actions、GitLab CI），确保脚本提交质量
• 系统运维：系统管理员验证部署脚本、配置脚本的可靠性，减少生产环境风险
• 教学实践：作为Bash测试教学的标准化环境，统一实践平台

使用方法与配置说明

前提条件

• 已安装Docker引擎（推荐版本1.13.0及以上）
• 本地测试文件以.bats为扩展名（Bats标准命名规范）

拉取镜像

bash
# 拉取最新版本
docker pull docker.xuanyuan.run/dduportal/bats:latest

# 拉取指定版本（推荐生产环境使用）
docker pull docker.xuanyuan.run/dduportal/bats:0.4.0

基本测试流程

1. 创建测试文件

编写Bats测试用例（如example_test.bats）：

bash
#!/usr/bin/env bats

@test "验证脚本退出码为0" {
  run ./demo_script.sh
  [ "$status" -eq 0 ]  # 断言命令成功执行
}

@test "验证脚本输出内容" {
  run ./demo_script.sh "hello"
  [ "$output" = "Hello, World!" ]  # 断言输出符合预期
}

2. 运行测试容器

通过挂载本地目录将测试文件传入容器并执行：

bash
docker run --rm \
  -v "$(pwd):/tests" \  # 挂载当前目录到容器内/tests路径
  dduportal/bats:latest \
  /tests/example_test.bats  # 指定容器内测试文件路径

参数说明

• --rm：测试完成后自动清理容器，避免残留
• -v <本地路径>:<容器路径>：挂载本地测试文件目录，确保容器可访问测试用例
• 最后一个参数为容器内测试文件的绝对路径

CI/CD集成示例（GitHub Actions）

在项目.github/workflows/test.yml中添加测试步骤：

yaml
jobs:
  bash-test:
    runs-on: ubuntu-latest
    steps:
      - name: 拉取代码
        uses: actions/checkout@v4

      - name: 运行Bats测试
        run: |
          # 确保测试文件可执行
          chmod +x *.bats
          # 启动容器执行测试
          docker run --rm -v "$(pwd):/tests" docker.xuanyuan.run/dduportal/bats:0.4.0 /tests/example_test.bats

镜像构建信息

镜像基于GitHub仓库源码构建，构建过程透明可追溯：
https://github.com/dduportal-dockerfiles/bats

注意事项

• 测试文件需确保可执行权限，或在容器内通过chmod +x /tests/*.bats手动授权
• 挂载路径中避免包含中文或特殊字符，防止容器路径解析异常
• 不同版本标签功能可能存在差异，建议在CI配置中固定版本标签（如0.4.0）以确保稳定性