Bash เขียนสคริปต์ให้ทนทาน (robust)



สคริปต์ที่รันครั้งแรกได้ ต่างจากสคริปต์ที่รันได้ทุกครั้ง — แม้เน็ตหลุดกลางคัน แม้รันซ้ำ แม้ input แปลก บทนี้รวมเทคนิคที่ทำให้สคริปต์เชื่อถือได้จริง

idempotency — รันซ้ำได้ผลเดิม

สคริปต์ควรรันกี่ครั้งก็ได้ผลลัพธ์เหมือนเดิม ไม่พัง ไม่ทำซ้ำ

# ไม่ idempotent
mkdir /opt/myapp                        # รันซ้ำ → error "File exists"
useradd myapp                           # รันซ้ำ → error
echo "export PATH=..." >> ~/.bashrc     # รันซ้ำ → เพิ่มซ้ำทุกครั้ง
ln -s /opt/myapp/bin /usr/local/bin/myapp   # รันซ้ำ → error

# idempotent
mkdir -p /opt/myapp                     # -p: ไม่บ่นถ้ามีอยู่
id myapp &>/dev/null || useradd myapp   # สร้างเฉพาะถ้ายังไม่มี
grep -qxF 'export PATH=...' ~/.bashrc || echo 'export PATH=...' >> ~/.bashrc
ln -sfn /opt/myapp/bin /usr/local/bin/myapp   # -f: เขียนทับ, -n: ไม่ตามเข้า dir

# ตั้งค่าไฟล์ config (บทที่ 35)
grep -q '^max_conn' "$conf" \
    && sed -i 's/^max_conn.*/max_conn = 200/' "$conf" \
    || echo 'max_conn = 200' >> "$conf"

ทดสอบ: รันสคริปต์ 2–3 ครั้งติดกัน ต้องไม่มี error และผลลัพธ์เหมือนกัน

logging function

readonly SCRIPT_NAME=${0##*/}
LOG_LEVEL=${LOG_LEVEL:-INFO}            # DEBUG < INFO < WARN < ERROR

_log() {
    local level=$1; shift
    local -A prio=([DEBUG]=0 [INFO]=1 [WARN]=2 [ERROR]=3)
    (( prio[$level] < prio[$LOG_LEVEL] )) && return 0

    local color reset=""
    if [[ -t 2 ]]; then
        case $level in
            DEBUG) color=$'\e[90m' ;;
            INFO)  color=$'\e[36m' ;;
            WARN)  color=$'\e[33m' ;;
            ERROR) color=$'\e[31m' ;;
        esac
        reset=$'\e[0m'
    fi

    printf '%s%s [%s] %-5s %s%s\n' \
        "$color" "$(date '+%F %T')" "$SCRIPT_NAME" "$level" "$*" "$reset" >&2
}

log_debug() { _log DEBUG "$@"; }
log_info()  { _log INFO  "$@"; }
log_warn()  { _log WARN  "$@"; }
log_error() { _log ERROR "$@"; }
die()       { _log ERROR "$@"; exit 1; }
log_info "เริ่มประมวลผล $count รายการ"
log_warn "ข้าม $skipped รายการที่ไม่ถูกต้อง"
die "เชื่อมต่อฐานข้อมูลไม่ได้"
  • log ไป stderr เสมอ (>&2) — เพื่อไม่ปน output จริงของสคริปต์
  • มี timestamp + ระดับ — กรอง/ค้นย้อนหลังได้
  • สีเฉพาะเมื่อ [[ -t 2 ]] (บทที่ 34)
  • LOG_LEVEL=DEBUG ./script.sh เปิด verbose ได้โดยไม่แก้โค้ด

dry-run — แสดงว่าจะทำอะไร ไม่ทำจริง

DRY_RUN=${DRY_RUN:-0}

run() {
    if (( DRY_RUN )); then
        printf '[DRY-RUN] จะรัน: '
        printf '%q ' "$@"
        printf '\n'
    else
        log_debug "รัน: $*"
        "$@"
    fi
}

# ใช้ run() ห่อทุกคำสั่งที่เปลี่ยนแปลงระบบ
run rm -rf "$old_release"
run systemctl restart "$service"
run rsync -a "$src/" "$dst/"
run tee /etc/myapp.conf <<< "$config"      # ← ระวัง: pipe/redirect ไม่ผ่าน run()
DRY_RUN=1 ./deploy.sh
[DRY-RUN] จะรัน: rm -rf /opt/app/releases/v1.2.0
[DRY-RUN] จะรัน: systemctl restart myapp

printf '%q' แสดงคำสั่งแบบ escape ให้ก๊อปกลับไปรันได้ ข้อจำกัด: run() ห่อได้เฉพาะคำสั่งเดี่ยว — redirect/pipe ต้องจัดการแยก

retry with backoff

retry() {
    local max=$1 delay=$2; shift 2
    local attempt=1

    until "$@"; do
        local rc=$?
        if (( attempt >= max )); then
            log_error "ล้มเหลวหลังลอง $max ครั้ง: $*"
            return "$rc"
        fi
        log_warn "ครั้งที่ $attempt ล้มเหลว (rc=$rc) — รอ ${delay}s แล้วลองใหม่"
        sleep "$delay"
        (( attempt++ ))
        (( delay *= 2 ))                   # exponential: 2, 4, 8, 16
    done

    (( attempt > 1 )) && log_info "สำเร็จในครั้งที่ $attempt"
    return 0
}

retry 5 2 curl -fsS "$api_url" -o "$out"
retry 3 5 ssh "$host" 'systemctl is-active nginx'
retry 10 1 pg_isready -h "$db_host"

ใช้กับงานที่ล้มเหลว ชั่วคราว ได้ (network, บริการกำลัง start) — ไม่ใช่งานที่ผิดถาวร (auth ผิด, ไฟล์ไม่มี)

เช็ก precondition

check_preconditions() {
    (( BASH_VERSINFO[0] >= 4 )) || die "ต้อง bash 4+"

    [[ $EUID -eq 0 ]] || die "ต้องรันด้วย sudo"
    # หรือกลับกัน:
    # [[ $EUID -ne 0 ]] || die "อย่ารันเป็น root"

    require curl jq systemctl

    [[ -f "$CONFIG_FILE" ]] || die "ไม่พบ $CONFIG_FILE"
    [[ -w "$DEPLOY_DIR" ]] || die "เขียน $DEPLOY_DIR ไม่ได้"

    local free_kb
    free_kb=$(df --output=avail -k "$DEPLOY_DIR" | tail -1)
    (( free_kb > 1048576 )) || die "พื้นที่ดิสก์เหลือน้อยกว่า 1GB"

    ping -c1 -W2 "$REMOTE_HOST" &>/dev/null || die "$REMOTE_HOST ไม่ตอบ"
}

ตรวจทุกอย่างที่จำเป็น ก่อน เริ่มเปลี่ยนแปลงระบบ — ล้มเหลวตั้งแต่ยังไม่ทำอะไรดีกว่าล้มกลางคัน

safe rm

safe_rm() {
    local target=$1

    [[ -n "$target" ]]          || { log_error "safe_rm: เป้าหมายว่าง"; return 1; }
    [[ "$target" != "/" ]]      || { log_error "safe_rm: ปฏิเสธการลบ /"; return 1; }
    [[ "$target" != "$HOME" ]]  || { log_error "safe_rm: ปฏิเสธการลบ \$HOME"; return 1; }
    [[ "$target" == /* ]]       || { log_error "safe_rm: ต้องเป็น absolute path"; return 1; }

    case $target in
        /opt/myapp/* | /var/cache/myapp/* | /tmp/myapp.*)
            run rm -rf -- "$target"
            ;;
        *)
            log_error "safe_rm: $target อยู่นอกพื้นที่ที่อนุญาต"
            return 1
            ;;
    esac
}

จำกัด rm -rf ให้ทำงานเฉพาะใต้ path ที่กำหนด — กันบั๊ก/ตัวแปรว่างทำลายระบบ

รวมเป็นโครง

#!/usr/bin/env bash
set -Eeuo pipefail
IFS=$'\n\t'

# ... constants, log/die/run/retry/require ...

cleanup() {
    local rc=$?
    [[ -n "${TMPDIR_:-}" ]] && rm -rf "$TMPDIR_"
    (( rc != 0 )) && log_error "สคริปต์จบด้วย rc=$rc"
    exit "$rc"
}
trap cleanup EXIT
trap 'log_error "ข้อผิดพลาดที่บรรทัด $LINENO: $BASH_COMMAND"' ERR

main() {
    parse_args "$@"
    check_preconditions
    TMPDIR_=$(mktemp -d)

    log_info "เริ่ม (dry-run=${DRY_RUN})"
    retry 3 2 download_artifacts
    run deploy_release
    verify_health || die "health check ไม่ผ่าน — rollback"
    log_info "เสร็จสมบูรณ์"
}

main "$@"

เรื่องที่คนมักพลาด

  • สคริปต์ไม่ idempotent — mkdir ไม่มี -p, useradd ไม่เช็กก่อน, >> config ซ้ำ ทดสอบด้วยการรัน 3 ครั้ง
  • log ไป stdout — ปน output จริง log ไป >&2
  • run() ห่อ pipe/redirect — run cmd > file ทำ redirect ทันที ไม่ผ่าน dry-run จัดการแยก
  • retry งานที่ผิดถาวร — auth ผิด/ไฟล์ไม่มี retry ไปก็เท่านั้น เสียเวลา
  • เช็ก precondition หลังเริ่มทำงาน — ตรวจก่อนแตะระบบ
  • rm -rf "$var" ไม่มี guard — ตัวแปรว่าง = ลบผิดที่ ใช้ safe_rm หรือ ${var:?}
  • ไม่มี dry-run ในสคริปต์ที่ทำเรื่องอันตราย — deploy/cleanup ควรมี DRY_RUN=1 เสมอ

สรุป

  • idempotent: mkdir -p, id x || useradd x, grep -qxF ... || echo >> ..., ln -sfn — รัน 3 ครั้งต้องได้ผลเดิม
  • log_info/warn/error ไป stderr + timestamp + ระดับ + สีเมื่อ [[ -t 2 ]] — คุมด้วย LOG_LEVEL
  • run() ห่อคำสั่งที่เปลี่ยนระบบ — DRY_RUN=1 แสดงแทนทำ (printf '%q')
  • retry max delay cmd — exponential backoff สำหรับงานล้มเหลวชั่วคราว (ไม่ใช่ผิดถาวร)
  • check_preconditions — bash version, สิทธิ์, คำสั่งที่ต้องมี, ดิสก์, network — ก่อน แตะระบบ
  • safe_rm — จำกัด rm -rf ให้ทำงานเฉพาะใต้ path ที่ whitelist + guard ตัวแปรว่าง
  • โครง: set -Eeuo pipefail + trap cleanup EXIT + trap ... ERR + main "$@"

บทถัดไปว่าด้วยประสิทธิภาพ — เมื่อสคริปต์ช้า ทำไม และเมื่อไหร่ควรเลิกใช้ bash