Bats Testing Patterns

作者 wshobson46891e7e60da無授權條款收錄於 2026年10月8日更新於 2026年10月8日

Master Bash Automated Testing System (Bats) for comprehensive shell script testing. Use when writing tests for shell scripts, CI/CD pipelines, or requiring test-driven development of shell utilities.

僅含說明Software Development

AI 產生的概覽

指導使用 Bats 為 shell 指令碼撰寫單元測試，涵蓋測試模式、測試資料與 CI/CD 整合。

功能: 此技能提供使用 Bats（Bash 自動化測試系統）為 shell 指令碼撰寫單元測試的指引。內容涵蓋錯誤情況測試、相依性檢查、bash、sh 與 dash 的 shell 相容性測試、平行執行、測試輔助函式，以及 GitHub Actions 和 Makefile 的 CI/CD 整合範例。它也列出維護可維護 shell 測試套件的最佳實務，詳細模式文件另見獨立檔案。
適用情境: 適用於為 shell 指令碼撰寫測試、對 shell 工具進行測試驅動開發，或在 CI/CD 流程中建置自動化 shell 測試。也適合測試邊界情況、錯誤情況以及不同 shell 環境下的行為。
執行需求: 執行其描述的測試需要 Bats 測試工具；範例中提及 jq、dash、npm 和 GitHub Actions 等選用工具。此技能不附帶指令碼，僅包含說明文件與一份參考文件。

Bats Testing Patterns

Comprehensive guidance for writing comprehensive unit tests for shell scripts using Bats (Bash Automated Testing System), including test patterns, fixtures, and best practices for production-grade shell testing.

When to Use This Skill

Writing unit tests for shell scripts
Implementing test-driven development (TDD) for scripts
Setting up automated testing in CI/CD pipelines
Testing edge cases and error conditions
Validating behavior across different shell environments
Building maintainable test suites for scripts
Creating fixtures for complex test scenarios
Testing multiple shell dialects (bash, sh, dash)

Detailed patterns and worked examples

Detailed pattern documentation lives in references/details.md. Read that file when the navigation tier above is insufficient.

Testing Error Conditions

bash

#!/usr/bin/env bats
@test "Function fails with missing file" {    run my_function "/nonexistent/file.txt"    [ "$status" -ne 0 ]    [[ "$output" == *"not found"* ]]}
@test "Function fails with invalid input" {    run my_function ""    [ "$status" -ne 0 ]}
@test "Function fails with permission denied" {    touch "$TMPDIR/readonly.txt"    chmod 000 "$TMPDIR/readonly.txt"    run my_function "$TMPDIR/readonly.txt"    [ "$status" -ne 0 ]    chmod 644 "$TMPDIR/readonly.txt"  # Cleanup}
@test "Function provides helpful error message" {    run my_function --invalid-option    [ "$status" -ne 0 ]    [[ "$output" == *"Usage:"* ]]}

#!/usr/bin/env bats
@test "Function fails with missing file" {    run my_function "/nonexistent/file.txt"    [ "$status" -ne 0 ]    [[ "$output" == *"not found"* ]]}
@test "Function fails with invalid input" {    run my_function ""    [ "$status" -ne 0 ]}
@test "Function fails with permission denied" {    touch "$TMPDIR/readonly.txt"    chmod 000 "$TMPDIR/readonly.txt"    run my_function "$TMPDIR/readonly.txt"    [ "$status" -ne 0 ]    chmod 644 "$TMPDIR/readonly.txt"  # Cleanup}
@test "Function provides helpful error message" {    run my_function --invalid-option    [ "$status" -ne 0 ]    [[ "$output" == *"Usage:"* ]]}

Testing with Dependencies

bash

#!/usr/bin/env bats
setup() {    # Check for required tools    if ! command -v jq &>/dev/null; then        skip "jq is not installed"    fi
    export SCRIPT="${BATS_TEST_DIRNAME}/../bin/script.sh"}
@test "JSON parsing works" {    skip_if ! command -v jq &>/dev/null    run my_json_parser '{"key": "value"}'    [ "$status" -eq 0 ]}

#!/usr/bin/env bats
setup() {    # Check for required tools    if ! command -v jq &>/dev/null; then        skip "jq is not installed"    fi
    export SCRIPT="${BATS_TEST_DIRNAME}/../bin/script.sh"}
@test "JSON parsing works" {    skip_if ! command -v jq &>/dev/null    run my_json_parser '{"key": "value"}'    [ "$status" -eq 0 ]}

Testing Shell Compatibility

bash

#!/usr/bin/env bats
@test "Script works in bash" {    bash "${BATS_TEST_DIRNAME}/../bin/script.sh" arg1}
@test "Script works in sh (POSIX)" {    sh "${BATS_TEST_DIRNAME}/../bin/script.sh" arg1}
@test "Script works in dash" {    if command -v dash &>/dev/null; then        dash "${BATS_TEST_DIRNAME}/../bin/script.sh" arg1    else        skip "dash not installed"    fi}

#!/usr/bin/env bats
@test "Script works in bash" {    bash "${BATS_TEST_DIRNAME}/../bin/script.sh" arg1}
@test "Script works in sh (POSIX)" {    sh "${BATS_TEST_DIRNAME}/../bin/script.sh" arg1}
@test "Script works in dash" {    if command -v dash &>/dev/null; then        dash "${BATS_TEST_DIRNAME}/../bin/script.sh" arg1    else        skip "dash not installed"    fi}

Parallel Execution

bash

#!/usr/bin/env bats
@test "Multiple independent operations" {    run bash -c 'for i in {1..10}; do        my_operation "$i" &    done    wait'    [ "$status" -eq 0 ]}
@test "Concurrent file operations" {    for i in {1..5}; do        my_function "$TMPDIR/file$i" &    done    wait    [ -f "$TMPDIR/file1" ]    [ -f "$TMPDIR/file5" ]}

#!/usr/bin/env bats
@test "Multiple independent operations" {    run bash -c 'for i in {1..10}; do        my_operation "$i" &    done    wait'    [ "$status" -eq 0 ]}
@test "Concurrent file operations" {    for i in {1..5}; do        my_function "$TMPDIR/file$i" &    done    wait    [ -f "$TMPDIR/file1" ]    [ -f "$TMPDIR/file5" ]}

Test Helper Pattern

test_helper.sh

bash

#!/usr/bin/env bash
# Source script under testexport SCRIPT_DIR="${BATS_TEST_DIRNAME%/*}/bin"
# Common test utilitiesassert_file_exists() {    if [ ! -f "$1" ]; then        echo "Expected file to exist: $1"        return 1    fi}
assert_file_equals() {    local file="$1"    local expected="$2"
    if [ ! -f "$file" ]; then        echo "File does not exist: $file"        return 1    fi
    local actual=$(cat "$file")    if [ "$actual" != "$expected" ]; then        echo "File contents do not match"        echo "Expected: $expected"        echo "Actual: $actual"        return 1    fi}
# Create temporary test directorysetup_test_dir() {    export TEST_DIR=$(mktemp -d)}
cleanup_test_dir() {    rm -rf "$TEST_DIR"}

#!/usr/bin/env bash
# Source script under testexport SCRIPT_DIR="${BATS_TEST_DIRNAME%/*}/bin"
# Common test utilitiesassert_file_exists() {    if [ ! -f "$1" ]; then        echo "Expected file to exist: $1"        return 1    fi}
assert_file_equals() {    local file="$1"    local expected="$2"
    if [ ! -f "$file" ]; then        echo "File does not exist: $file"        return 1    fi
    local actual=$(cat "$file")    if [ "$actual" != "$expected" ]; then        echo "File contents do not match"        echo "Expected: $expected"        echo "Actual: $actual"        return 1    fi}
# Create temporary test directorysetup_test_dir() {    export TEST_DIR=$(mktemp -d)}
cleanup_test_dir() {    rm -rf "$TEST_DIR"}

Integration with CI/CD

GitHub Actions Workflow

yaml

name: Tests
on: [push, pull_request]
jobs:  test:    runs-on: ubuntu-latest
    steps:      - uses: actions/checkout@v3
      - name: Install Bats        run: |          npm install --global bats
      - name: Run Tests        run: |          bats tests/*.bats
      - name: Run Tests with Tap Reporter        run: |          bats tests/*.bats --tap | tee test_output.tap

name: Tests
on: [push, pull_request]
jobs:  test:    runs-on: ubuntu-latest
    steps:      - uses: actions/checkout@v3
      - name: Install Bats        run: |          npm install --global bats
      - name: Run Tests        run: |          bats tests/*.bats
      - name: Run Tests with Tap Reporter        run: |          bats tests/*.bats --tap | tee test_output.tap

Makefile Integration

makefile

.PHONY: test test-verbose test-tap
test:	bats tests/*.bats
test-verbose:	bats tests/*.bats --verbose
test-tap:	bats tests/*.bats --tap
test-parallel:	bats tests/*.bats --parallel 4
coverage: test	# Optional: Generate coverage reports

.PHONY: test test-verbose test-tap
test:	bats tests/*.bats
test-verbose:	bats tests/*.bats --verbose
test-tap:	bats tests/*.bats --tap
test-parallel:	bats tests/*.bats --parallel 4
coverage: test	# Optional: Generate coverage reports

Best Practices

Test one thing per test - Single responsibility principle
Use descriptive test names - Clearly states what is being tested
Clean up after tests - Always remove temporary files in teardown
Test both success and failure paths - Don't just test happy path
Mock external dependencies - Isolate unit under test
Use fixtures for complex data - Makes tests more readable
Run tests in CI/CD - Catch regressions early
Test across shell dialects - Ensure portability
Keep tests fast - Run in parallel when possible
Document complex test setup - Explain unusual patterns

來源與署名

來源：wshobson/agents位於plugins/shell-scripting/skills/bats-testing-patterns提交46891e7

授權條款：無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架

Bats Testing Patterns

Bats Testing Patterns

When to Use This Skill

Detailed patterns and worked examples

Testing Error Conditions

Testing with Dependencies

Testing Shell Compatibility

Parallel Execution

Test Helper Pattern

test_helper.sh

Integration with CI/CD

GitHub Actions Workflow

Makefile Integration

Best Practices

來源與署名

更多來自 wshobson/agents 的技能

Uv Package Manager

Web Component Design

Python Type Safety

Visual Design Foundations

Responsive Design

Python Resource Management

更多Software Development技能

Playground

M5 Onboard

Cardputer Buddy

Dpop Adoption

Gemini Live Api

Gemini Api