シェルスクリプトの終了コード設計｜exit codeを体系化して呼び出し元がエラー原因を判別できる仕組み

この記事のポイント

・exit 0が成功、1が汎用エラー、2が引数誤りという慣例を守ると呼び出し元で正確に分岐できる
・126・127・128+nはシェル予約コードなので、スクリプト独自の番号と重複させてはいけない
・関数内ではreturnで返し、呼び出し側が$?で受け取る設計が安全な伝播パターン
・local宣言と代入を同じ行に書くとexit codeが消える落とし穴があり、必ず分離する

# スクリプトを実行してexit codeを確認する
./backup.sh
echo "終了コード: $?"

# 出力例（成功時）
# 終了コード: 0

# 出力例（失敗時）
# 終了コード: 1

#!/bin/bash
# ========================================
# exit code 定義（3～125 の範囲を使う）
# ========================================
readonly E_SUCCESS=0       # 正常終了
readonly E_GENERAL=1       # 汎用エラー
readonly E_USAGE=2         # 引数・使い方の誤り
readonly E_FILE_NOT_FOUND=3  # 必要なファイルが存在しない
readonly E_PERMISSION=4    # 権限エラー
readonly E_CONNECTION=5    # 接続エラー（DB・API・外部サービス）
readonly E_TIMEOUT=6       # タイムアウト

# 引数チェック（足りなければ usage エラーで終了）
if [[ $# -lt 2 ]]; then
  echo "Usage: $0  " >&2
  exit ${E_USAGE}
fi

#!/bin/bash
readonly E_SUCCESS=0
readonly E_CONNECTION=5

# DB接続チェック関数
check_db_connection() {
  local host="$1"
  if ! ping -c 1 -W 2 "${host}" &>/dev/null; then
    echo "[ERROR] DBホスト ${host} に到達できません" >&2
    return ${E_CONNECTION}   # exit ではなく return で返す
  fi
  echo "[INFO] DB接続確認OK: ${host}"
  return ${E_SUCCESS}
}

# 呼び出し元で $? を受け取る
check_db_connection "db.example.com"
if [[ $? -ne 0 ]]; then
  echo "[FATAL] DB接続失敗。処理を中断します。" >&2
  exit ${E_CONNECTION}
fi

echo "以降の処理を継続..."

#!/bin/bash

# NG: local 宣言と代入を同時に書くと $? が local の終了コード（0）になる
bad_example() {
  local result=$(false)   # false は exit 1 を返すが...
  echo "終了コード: $?"   # 常に 0 が出力される（local が成功しているため）
}

# OK: 宣言と代入を分離する
good_example() {
  local result
  result=$(false)         # false は exit 1 を返す
  local code=$?
  echo "終了コード: ${code}"   # 正しく 1 が出力される
  return ${code}
}

bad_example
good_example

# /etc/cron.d/daily-backup
MAILTO=admin@example.com
PATH=/usr/local/bin:/usr/bin:/bin

# スクリプトが exit 0 以外を返した場合にメールが届く
0 3 * * * root /opt/scripts/daily-backup.sh >> /var/log/daily-backup.log 2>&1

#!/bin/bash
# 親スクリプト: 複数の処理を順番に実行する

run_step() {
  local step_name="$1"
  local script="$2"
  echo "[INFO] ${step_name} 開始..."
  "${script}"
  local code=$?
  if [[ ${code} -ne 0 ]]; then
    echo "[ERROR] ${step_name} が失敗しました（exit code: ${code}）" >&2
    return ${code}
  fi
  echo "[INFO] ${step_name} 完了"
  return 0
}

# || exit $? でexit codeをそのまま親に返す
run_step "DBバックアップ" /opt/scripts/db-backup.sh  || exit $?
run_step "ファイル同期"    /opt/scripts/file-sync.sh   || exit $?
run_step "レポート生成"    /opt/scripts/report.sh      || exit $?

echo "[INFO] 全ステップ正常完了"
exit 0

# GitHub Actions の step 例
steps:
  - name: デプロイスクリプト実行
    run: ./deploy.sh
    # exit code 3（ファイル未存在）が返ると steps.*.outcome が failure になる

  - name: デプロイ失敗時のロールバック
    if: failure()   # 前ステップが失敗したときだけ実行
    run: ./rollback.sh

#!/bin/bash
set -e

# if 文の中では set -e が効かない（安全）
if ! some_command; then
  echo "失敗しました" >&2
  exit 1
fi

# || の右辺も set -e の対象外（安全）
some_command || { echo "失敗しました" >&2; exit 1; }

# 関数をそのまま呼ぶ場合は set -e が有効（失敗で即終了）
some_command  # 失敗すると次の行に進まずスクリプトが終了する

some_command
exit_code=$?         # 直後に変数へ退避する
echo "処理を記録"     # この時点で $? は 0（echo の終了コード）に上書きされる
if [[ ${exit_code} -ne 0 ]]; then
  exit ${exit_code}
fi