現場で壊れないシェルスクリプト設計｜エラー処理とtrapで安定運用する書き方

この記事のポイント

・set -e と set -u でコマンド失敗・未定義変数を即検知できる
・trap でシグナル受信時・スクリプト終了時の後処理を自動実行できる
・EXIT トラップを使えばスクリプトがどう終了しても後始末が確実に実行される
・ROLLBACK_STACK 配列に取り消し関数を積めばステップ単位のロールバックが実現できる
・ERR トラップ＋$LINENO でコマンド失敗の行番号を正確に記録できる
・SIGKILL やサブシェル内では trap が効かない落とし穴も解説する

#!/bin/bash
# 危険なスクリプト例（エラー処理なし）

mkdir /tmp/backup_work
cp /var/data/*.sql /tmp/backup_work/
gzip /tmp/backup_work/*.sql
scp /tmp/backup_work/*.gz user@backup-server:/backups/
rm -rf /tmp/backup_work

#!/bin/bash
set -e    # コマンドが0以外の終了ステータスを返したら即終了
set -u    # 未定義変数を参照しようとしたらエラーにする
set -o pipefail   # パイプライン内のいずれかのコマンドが失敗したら失敗扱いにする

# grep で「見つからない」は正常扱いにしたい場合
grep "pattern" /var/log/app.log || true

# コマンドの失敗を if で明示的に制御する場合
if ! cp /var/data/*.sql /tmp/backup_work/; then
    echo "ERROR: ファイルのコピーに失敗しました" >&2
    exit 1
fi

# 未定義の場合にデフォルト値を使う
BACKUP_DIR="${BACKUP_DIR:-/tmp/backup_work}"

# 未定義の場合にエラーメッセージを出して終了する
BACKUP_DIR="${BACKUP_DIR:?'BACKUP_DIR が設定されていません'}"

# 書式
trap '実行するコマンドまたは関数' シグナル名

# EXIT シグナル: スクリプトが終了するとき（正常・異常問わず）
trap 'cleanup' EXIT

# INT シグナル: Ctrl+C による割り込み
trap 'echo "中断されました"; cleanup' INT

# TERM シグナル: kill コマンドによる終了シグナル
trap 'echo "TERM シグナルを受信"; cleanup' TERM

# ERR シグナル: コマンドがエラー終了したとき（set -e と組み合わせて使う）
trap 'error_handler' ERR

# 現在の trap 設定を確認する
trap -p

# trap を解除してデフォルト動作に戻す
trap - SIGINT

# シグナルを無視する（空文字列を設定）
trap '' SIGINT

#!/bin/bash
set -euo pipefail

# 一時ディレクトリ（スクリプト冒頭で定義）
WORK_DIR=""

# cleanup 関数: 正常終了・異常終了どちらでも実行される
cleanup() {
    local exit_code=$?
    echo "$(date '+%Y-%m-%d %H:%M:%S') cleanup 開始 (exit_code=${exit_code})" >&2

    # 一時ディレクトリが存在する場合のみ削除
    if [[ -n "${WORK_DIR}" && -d "${WORK_DIR}" ]]; then
        rm -rf "${WORK_DIR}"
        echo "$(date '+%Y-%m-%d %H:%M:%S') 一時ディレクトリを削除: ${WORK_DIR}" >&2
    fi

    exit "${exit_code}"
}

trap cleanup EXIT

# 一時ディレクトリを作成
WORK_DIR=$(mktemp -d)
echo "作業ディレクトリ: ${WORK_DIR}"

# ここから処理

error_handler() {
    local exit_code=$?
    local line_number=$1
    echo "$(date '+%Y-%m-%d %H:%M:%S') ERROR: スクリプトが失敗しました" >&2
    echo "  終了ステータス: ${exit_code}" >&2
    echo "  失敗した行: ${line_number}" >&2
}

# ERR トラップで行番号を渡す
trap 'error_handler $LINENO' ERR

#!/bin/bash
set -euo pipefail

EXIT_REASON="normal"

on_sigint() {
    EXIT_REASON="interrupted"
    echo "[WARN] Ctrl+C を受信しました — graceful shutdown 中..." >&2
    exit 130   # 128 + 2（SIGINT の番号）が慣例
}

on_sigterm() {
    EXIT_REASON="terminated"
    echo "[WARN] SIGTERM を受信しました — graceful shutdown 中..." >&2
    exit 143   # 128 + 15（SIGTERM の番号）が慣例
}

cleanup() {
    case "${EXIT_REASON}" in
        interrupted) echo "[INFO] ユーザー割り込みによる後処理を実行します。" ;;
        terminated)  echo "[INFO] SIGTERM 受信後の後処理を実行します。" ;;
        *)           echo "[INFO] 通常後処理を実行します。" ;;
    esac
    rm -f "/tmp/work_file.$$"
}

trap on_sigint  SIGINT
trap on_sigterm SIGTERM
trap cleanup    EXIT

# 本処理
echo "[INFO] 処理開始 (PID: $$)"
for i in $(seq 1 10); do
    echo "[INFO] ステップ ${i}/10..."
    sleep 1
done
echo "[INFO] 処理完了"

$ bash graceful_shutdown.sh
[INFO] 処理開始 (PID: 14827)
[INFO] ステップ 1/10...
[INFO] ステップ 2/10...
^C
[WARN] Ctrl+C を受信しました — graceful shutdown 中...
[INFO] ユーザー割り込みによる後処理を実行します。

$ echo $?
130

#!/bin/bash
set -euo pipefail

# ロールバック関数のスタック
ROLLBACK_STACK=()
SCRIPT_STATUS="failed"

# ロールバック関数を登録する
register_rollback() {
    ROLLBACK_STACK+=("$1")
}

# スタックを逆順に実行する
do_rollback() {
    trap - ERR  # ロールバック中の ERR 再帰呼び出しを防ぐ
    [[ ${#ROLLBACK_STACK[@]} -eq 0 ]] && return 0
    echo "[ROLLBACK] ${#ROLLBACK_STACK[@]}ステップをロールバックします" >&2
    local i
    for (( i=${#ROLLBACK_STACK[@]}-1; i>=0; i-- )); do
        echo "[ROLLBACK] 実行: ${ROLLBACK_STACK[$i]}" >&2
        "${ROLLBACK_STACK[$i]}" || echo "[ROLLBACK] 警告: ${ROLLBACK_STACK[$i]} が失敗しました" >&2
    done
    echo "[ROLLBACK] 完了" >&2
}

# 正常終了・異常終了を統合管理する EXIT ハンドラ
on_exit() {
    if [[ "${SCRIPT_STATUS}" == "failed" ]]; then
        do_rollback
        echo "[ERROR] スクリプトが失敗しました" >&2
    else
        echo "[INFO] スクリプトが正常に完了しました"
    fi
}

# エラー発生時に行番号を記録する ERR ハンドラ
on_error() {
    local exit_code=$?
    local line_num=$1
    echo "[ERROR] ${line_num}行目でエラーが発生しました（終了コード: ${exit_code}）" >&2
}

trap 'on_exit'          EXIT
trap 'on_error $LINENO' ERR

# ===== メイン処理（ここからステップを書く）=====

# ステップ1: 作業ディレクトリを作成する
WORK_DIR="/tmp/myapp-setup-$$"
mkdir -p "${WORK_DIR}"
rollback_step1() { rm -rf "${WORK_DIR}"; }
register_rollback rollback_step1
echo "[STEP1] 作業ディレクトリを作成しました: ${WORK_DIR}"

# ステップ2: 設定ファイルをコピーする
cp /etc/hosts "${WORK_DIR}/hosts.bak"
rollback_step2() { rm -f "${WORK_DIR}/hosts.bak"; }
register_rollback rollback_step2
echo "[STEP2] 設定ファイルをコピーしました"

# ステップ3: 存在しないファイルをコピー（わざと失敗させるテスト）
cp /tmp/not-exist.conf "${WORK_DIR}/myapp.conf"
rollback_step3() { rm -f "${WORK_DIR}/myapp.conf"; }
register_rollback rollback_step3
echo "[STEP3] この行は実行されない"

# 全ステップ成功
SCRIPT_STATUS="success"
trap - ERR

$ bash rollback-demo.sh
[STEP1] 作業ディレクトリを作成しました: /tmp/myapp-setup-12345
[STEP2] 設定ファイルをコピーしました
cp: cannot stat '/tmp/not-exist.conf': No such file or directory
[ERROR] 42行目でエラーが発生しました（終了コード: 1）
[ROLLBACK] 2ステップをロールバックします
[ROLLBACK] 実行: rollback_step2
[ROLLBACK] 実行: rollback_step1
[ROLLBACK] 完了
[ERROR] スクリプトが失敗しました

# ステップ1で作ったディレクトリが削除されているか確認
$ ls /tmp/myapp-setup-12345
ls: cannot access '/tmp/myapp-setup-12345': No such file or directory

#!/bin/bash
# backup_db.sh — MySQL ダンプをリモートサーバーへ転送するバックアップスクリプト
# 作成: 2024-01-10 / bash 5.1 以上

set -euo pipefail

# ===== 設定 =====
DB_NAME="${DB_NAME:?'DB_NAME が設定されていません'}"
DB_USER="${DB_USER:-root}"
REMOTE_HOST="${REMOTE_HOST:?'REMOTE_HOST が設定されていません'}"
REMOTE_PATH="${REMOTE_PATH:-/backups}"
LOG_FILE="/var/log/backup_db.log"
LOCK_FILE="/var/run/backup_db.lock"

# ===== 変数初期化 =====
WORK_DIR=""
TIMESTAMP=$(date '+%Y%m%d_%H%M%S')
DUMP_FILE="${DB_NAME}_${TIMESTAMP}.sql.gz"

# ===== ログ出力関数 =====
log() {
    echo "$(date '+%Y-%m-%d %H:%M:%S') $1" | tee -a "${LOG_FILE}"
}

log_error() {
    echo "$(date '+%Y-%m-%d %H:%M:%S') ERROR: $1" | tee -a "${LOG_FILE}" >&2
}

# ===== エラーハンドラ =====
error_handler() {
    local exit_code=$?
    local line_number=$1
    log_error "スクリプトが失敗しました (line: ${line_number}, exit_code: ${exit_code})"
}

# ===== クリーンアップ関数 =====
cleanup() {
    local exit_code=$?

    # 一時ディレクトリを削除
    if [[ -n "${WORK_DIR}" && -d "${WORK_DIR}" ]]; then
        rm -rf "${WORK_DIR}"
        log "一時ディレクトリを削除: ${WORK_DIR}"
    fi

    # ロックファイルを削除
    if [[ -f "${LOCK_FILE}" ]]; then
        rm -f "${LOCK_FILE}"
        log "ロックファイルを削除: ${LOCK_FILE}"
    fi

    if [[ "${exit_code}" -eq 0 ]]; then
        log "バックアップ正常完了"
    else
        log_error "バックアップ異常終了 (exit_code=${exit_code})"
    fi

    exit "${exit_code}"
}

# ===== trap 設定 =====
trap 'error_handler $LINENO' ERR
trap cleanup EXIT
trap 'log "シグナルを受信しました (INT/TERM) — 中断処理中..."; exit 130' INT TERM

# ===== 二重起動防止 =====
if [[ -f "${LOCK_FILE}" ]]; then
    log_error "前回の処理がまだ実行中か、異常終了しました。${LOCK_FILE} を確認してください"
    exit 1
fi
touch "${LOCK_FILE}"

# ===== メイン処理 =====
log "バックアップ開始: DB=${DB_NAME}"

# 一時ディレクトリを作成
WORK_DIR=$(mktemp -d)
log "作業ディレクトリ: ${WORK_DIR}"

# MySQL ダンプ
log "mysqldump 実行中..."
mysqldump -u "${DB_USER}" "${DB_NAME}" | gzip > "${WORK_DIR}/${DUMP_FILE}"
log "ダンプ完了: ${DUMP_FILE} ($(du -sh "${WORK_DIR}/${DUMP_FILE}" | cut -f1))"

# リモートへ転送
log "SCP 転送開始: ${REMOTE_HOST}:${REMOTE_PATH}/"
scp "${WORK_DIR}/${DUMP_FILE}" "${REMOTE_HOST}:${REMOTE_PATH}/"
log "SCP 転送完了"

# 正常終了時のログ例（/var/log/backup_db.log）
2024-01-15 03:00:01 バックアップ開始: DB=production_db
2024-01-15 03:00:01 作業ディレクトリ: /tmp/tmp.aB3xK9
2024-01-15 03:00:01 mysqldump 実行中...
2024-01-15 03:00:08 ダンプ完了: production_db_20240115_030001.sql.gz (42M)
2024-01-15 03:00:08 SCP 転送開始: backup-server.example.com:/backups/
2024-01-15 03:00:23 SCP 転送完了
2024-01-15 03:00:23 一時ディレクトリを削除: /tmp/tmp.aB3xK9
2024-01-15 03:00:23 ロックファイルを削除: /var/run/backup_db.lock
2024-01-15 03:00:23 バックアップ正常完了

# mysqldump が失敗したときのログ例
2024-01-15 03:00:01 バックアップ開始: DB=production_db
2024-01-15 03:00:01 作業ディレクトリ: /tmp/tmp.mN7pQ2
2024-01-15 03:00:01 mysqldump 実行中...
2024-01-15 03:00:02 ERROR: スクリプトが失敗しました (line: 62, exit_code: 1)
2024-01-15 03:00:02 一時ディレクトリを削除: /tmp/tmp.mN7pQ2
2024-01-15 03:00:02 ロックファイルを削除: /var/run/backup_db.lock
2024-01-15 03:00:02 ERROR: バックアップ異常終了 (exit_code=1)

on_error() {
    local exit_code=$?
    local line_number=$1
    local host
    host=$(hostname)
    local subject="[ERROR] ${host}: スクリプトが失敗しました (line: ${line_number})"
    local body
    body="Script: $0
Line   : ${line_number}
Exit   : ${exit_code}
Time   : $(date '+%Y-%m-%d %H:%M:%S')"
    echo "${body}" | mail -s "${subject}" admin@example.com
    echo "[ERROR] アラートを送信しました" >&2
}
trap 'on_error $LINENO' ERR

# cleanup 関数内のエラー時通知部分
cleanup() {
    local exit_code=$?

    # ...（一時ファイル削除等）...

    # 異常終了時のみメール送信
    if [[ "${exit_code}" -ne 0 ]]; then
        local subject="[ERROR] バックアップ失敗: ${DB_NAME} ($(hostname))"
        local body
        body=$(tail -20 "${LOG_FILE}")
        echo "${body}" | mail -s "${subject}" admin@example.com
    fi

    exit "${exit_code}"
}

# スクリプトの先頭（set -euo pipefail の直後）で設定
exec 2>>"${LOG_FILE}"

# または、stdout と stderr の両方をログファイルと端末に出力する
exec 1> >(tee -a "${LOG_FILE}")
exec 2>&1

# /etc/cron.d/backup_db
MAILTO=""

# 環境変数はここで設定する（スクリプト内で ${VAR:?} を使う場合に必要）
DB_NAME=production_db
DB_USER=dbbackup
REMOTE_HOST=backup-server.example.com

# 毎日 03:00 に実行
0 3 * * * root /usr/local/sbin/backup_db.sh

# サブシェル内でのみ有効（親シェルには影響しない）
(
    trap 'echo [INFO] subshell cleanup' EXIT
    echo "inside subshell"
)
# 出力: inside subshell
# 出力: [INFO] subshell cleanup  ← サブシェル終了時に実行される

# 親シェルの EXIT trap は未設定のまま
trap -p EXIT   # 出力なし（親シェルには設定されていない）

# 以下はエラーになる（bash が拒否する）
# trap 'echo caught' SIGKILL
# bash: trap: KILL: invalid signal specification

# 対処法: SIGTERM で graceful shutdown を実装しておき、
# kill -9 は最終手段とする運用ルールを定める

# NG: || を使うと ERR trap が発火しない
cp /nonexistent /tmp/dest || echo "コピー失敗、スキップします"

# OK: 失敗を許容する場合は明示的に条件分岐する
if cp /nonexistent /tmp/dest; then
    echo "[INFO] コピー成功"
else
    echo "[WARN] コピー失敗。スキップします"
fi

# 対策: 二重実行防止フラグを do_rollback 内に入れる
ROLLBACK_DONE=false

do_rollback() {
    if [[ "${ROLLBACK_DONE}" == "true" ]]; then
        return 0  # 2回目の呼び出しは何もしない
    fi
    ROLLBACK_DONE=true
    trap - ERR  # ロールバック中の再帰を防ぐ
    # ...ロールバック処理...
}

# do_rollback の冒頭で ERR トラップを解除するのが鉄則
do_rollback() {
    trap - ERR  # これを最初に書く
    [[ ${#ROLLBACK_STACK[@]} -eq 0 ]] && return 0
    local i
    for (( i=${#ROLLBACK_STACK[@]}-1; i>=0; i-- )); do
        # || true は書かない（警告は残す）
        "${ROLLBACK_STACK[$i]}" || echo "[ROLLBACK] 警告: ${ROLLBACK_STACK[$i]} が失敗しました" >&2
    done
}