Linuxシェルスクリプトでのエラー処理の実践と応用例

#!/usr/bin/env bash
# 引数で指定した場所を作成。練習用の空ディレクトリ内で実行する。
dir=${1:-"./work dir"}
if mkdir -- "$dir"; then
  printf '作成しました: %s\n' "$dir"
else
  status=$?
  printf 'ディレクトリ作成に失敗: %s (status=%d)\n' "$dir" "$status" >&2
  exit "$status"
fi

#!/usr/bin/env bash
set -e
if false; then
  printf 'ここには入りません\n'
fi
false || printf 'この失敗は明示的に処理しました\n'
printf 'ここまでは続行します\n'
false
printf 'ここは実行されません\n'

#!/usr/bin/env bash
file=${1:-"./input file.txt"}
printf '読み取り対象: %s\n' "$file"
if cat -- "$file"; then
  :
else
  status=$?
  printf '読み取りに失敗: %s (status=%d)\n' "$file" "$status" >&2
  exit "$status"
fi

#!/usr/bin/env bash
file=${1:-"./input file.txt"}
if [[ ! -f "$file" || ! -r "$file" ]]; then
  printf '読み取り可能な通常ファイルではありません: %s\n' "$file" >&2
  exit 1
fi
if cat -- "$file"; then
  :
else
  status=$?
  printf 'ファイルの読み取り中に失敗しました\n' >&2
  exit "$status"
fi

#!/usr/bin/env bash
dir=${1:-"./output dir"}
if mkdir -p -- "$dir"; then
  printf 'ディレクトリを利用できます: %s\n' "$dir"
else
  status=$?
  printf 'ディレクトリを準備できません: %s\n' "$dir" >&2
  exit "$status"
fi

#!/usr/bin/env bash
src=${1:?コピー元ファイルを指定してください}
dst=${2:?練習用の新しい保存先ファイルを指定してください}
if cp -- "$src" "$dst"; then
  printf 'コピー完了: %s\n' "$dst"
else
  status=$?
  printf 'コピーに失敗: %s → %s (status=%d)\n' "$src" "$dst" "$status" >&2
  exit "$status"
fi

#!/usr/bin/env bash
printf '選択: (1)開始 (2)停止 (3)ステータス\n' >&2
if IFS= read -r option; then
  case "$option" in
    1) printf '開始を選択しました（デモ）\n' ;;
    2) printf '停止を選択しました（デモ）\n' ;;
    3) printf 'ステータスを選択しました（デモ）\n' ;;
    *) printf '無効な選択です\n' >&2; exit 2 ;;
  esac
else
  printf '入力を読み取れませんでした\n' >&2
  exit 1
fi

#!/usr/bin/env bash
file=${1:?ファイル名を指定してください}
case "$file" in
  *.txt) printf 'テキスト用の処理へ渡します\n' ;;
  *.jpg|*.png) printf '画像用の処理へ渡します\n' ;;
  *) printf '未対応の拡張子です: %s\n' "$file" >&2; exit 2 ;;
esac

#!/usr/bin/env bash
file=${1:?検索対象ファイルを指定してください}
pattern=${2:-ERROR}
if grep -F -- "$pattern" "$file" >/dev/null; then
  status=0
else
  status=$?
fi
case "$status" in
  0) printf '一致する行があります\n' ;;
  1) printf '一致する行はありません\n' ;;
  *) printf '検索に失敗しました (status=%d)\n' "$status" >&2
     exit "$status" ;;
esac

#!/usr/bin/env bash
set -o pipefail
producer() {
  printf '途中まで生成したデータ\n'
  return 7
}
if producer | cat >/dev/null; then
  printf '生成処理は成功しました\n'
else
  status=$?
  printf 'パイプラインが失敗しました (status=%d)\n' "$status" >&2
  exit "$status"
fi

#!/usr/bin/env bash
trap 'printf "中断されました\n" >&2; exit 130' INT
trap 'printf "終了要求を受けました\n" >&2; exit 143' TERM
printf '30秒待機します。Ctrl+Cで中断できます。\n'
sleep 30

#!/usr/bin/env bash
umask 077
work=$(mktemp -d) || exit 1
cleanup() {
  status=$?
  trap - EXIT
  if rm -rf -- "$work"; then
    :
  else
    printf '一時ディレクトリの削除に失敗: %s\n' "$work" >&2
    # 主処理が成功していた場合だけ、後片付け失敗を終了値にする。
    if [[ "$status" -eq 0 ]]; then status=1; fi
  fi
  exit "$status"
}
trap cleanup EXIT
trap 'exit 129' HUP
trap 'exit 130' INT
trap 'exit 143' TERM

if printf 'テスト用データ\n' >"$work/input.txt"; then
  :
else
  status=$?
  exit "$status"
fi
if cat -- "$work/input.txt"; then
  :
else
  status=$?
  exit "$status"
fi
# bash example.sh 7 なら、片付け後も終了ステータスは7。
exit "${1:-0}"

#!/usr/bin/env bash
log_error() {
  printf 'ERROR: %s\n' "$1" >&2
}
check_file() {
  if [[ -f "$1" && -r "$1" ]]; then
    return 0
  else
    log_error "読み取り対象を確認してください: $1"
    return 1
  fi
}
file=${1:-"./input.txt"}
if check_file "$file"; then
  printf '事前チェックを通過しました（実際の読み取り結果も要確認）\n'
else
  status=$?
  exit "$status"
fi

#!/usr/bin/env bash
copy_file() {
  local status
  if cp -- "$1" "$2"; then
    return 0
  else
    status=$?
    printf 'コピー失敗 (status=%d): %s\n' "$status" "$1" >&2
    return "$status"
  fi
}
src=${1:?コピー元を指定してください}
dst=${2:?練習用の新しい保存先を指定してください}
if copy_file "$src" "$dst"; then
  printf 'コピー完了\n'
else
  status=$?
  exit "$status"
fi

#!/usr/bin/env bash
set -Ee
report_error() {
  local status=$1
  local line=$2
  printf '予期しない失敗: line=%s status=%d\n' "$line" "$status" >&2
  exit "$status"
}
trap 'report_error "$?" "$LINENO"' ERR
unexpected_failure() {
  return 7
}
unexpected_failure
printf 'ここは実行されません\n'

#!/usr/bin/env bash
umask 077
work=$(mktemp -d) || exit 1
cleanup() {
  status=$?
  trap - EXIT
  if rm -rf -- "$work"; then
    :
  else
    printf '練習データを削除できません: %s\n' "$work" >&2
    if [[ "$status" -eq 0 ]]; then status=1; fi
  fi
  exit "$status"
}
trap cleanup EXIT
trap 'exit 129' HUP
trap 'exit 130' INT
trap 'exit 143' TERM

source_dir="$work/source"
mkdir -- "$source_dir" || exit "$?"
printf '通常ファイル\n' >"$source_dir/note.txt" || exit "$?"
printf '隠しファイル\n' >"$source_dir/.settings" || exit "$?"
backup_dir=$(mktemp -d -- "$work/backup.XXXXXXXXXX") || exit 1

if cp -a -- "$source_dir/." "$backup_dir/"; then
  # この小さな練習データについて内容を照合する。
  cmp -- "$source_dir/note.txt" "$backup_dir/note.txt" || exit "$?"
  cmp -- "$source_dir/.settings" "$backup_dir/.settings" || exit "$?"
  printf '通常ファイルと隠しファイルのコピーを確認しました\n'
else
  status=$?
  printf 'コピーに失敗しました (status=%d)\n' "$status" >&2
  exit "$status"
fi

#!/usr/bin/env bash
username=${1:?照会するユーザー名を指定してください}
if id -- "$username"; then
  printf '照会できました。アカウントの変更は行いません。\n'
else
  status=$?
  printf 'ユーザー情報を照会できません (status=%d)。作成は行いません。\n' "$status" >&2
  exit "$status"
fi

#!/usr/bin/env bash
url=${1:?信頼できるHTTPSダウンロードURLを指定してください}
umask 077
outdir=$(mktemp -d -- "./download.XXXXXXXXXX") || exit 1
cleanup() {
  status=$?
  trap - EXIT
  if [[ "$status" -ne 0 ]]; then
    if ! rm -rf -- "$outdir"; then
      printf '未完了データの削除に失敗: %s\n' "$outdir" >&2
    fi
  fi
  exit "$status"
}
trap cleanup EXIT
trap 'exit 129' HUP
trap 'exit 130' INT
trap 'exit 143' TERM

if http_status=$(curl -q --fail --silent --show-error --location \
    --max-redirs 5 --proto '=https' --proto-redir '=https' \
    --connect-timeout 10 --max-time 60 \
    --output "$outdir/file.part" --write-out '%{http_code}' -- "$url"); then
  :
else
  status=$?
  printf '取得に失敗しました (curl status=%d)\n' "$status" >&2
  exit "$status"
fi
if [[ "$http_status" != 200 ]]; then
  printf '想定外のHTTPステータス: %s\n' "$http_status" >&2
  exit 1
fi
# 必要な署名・ハッシュ・形式の検証は、完成名へ移す前に追加する。
if mv -- "$outdir/file.part" "$outdir/file.bin"; then
  printf '取得完了: %s/file.bin\n' "$outdir"
else
  status=$?
  printf '完成ファイル名への変更に失敗しました\n' >&2
  exit "$status"
fi

#!/usr/bin/env bash
umask 077
log_file=$(mktemp -- "./error-log.XXXXXXXXXX") || exit 1
log_error() {
  local timestamp
  timestamp=$(date -u '+%Y-%m-%dT%H:%M:%SZ') || return "$?"
  printf '%s ERROR %s\n' "$timestamp" "$1" >>"$log_file"
}
# 終了値7の失敗を模擬する。
simulate_error() { return 7; }
if simulate_error; then
  :
else
  status=$?
  if ! log_error "処理が失敗しました (status=$status)"; then
    printf 'ログにも書き込めませんでした\n' >&2
  fi
  printf '処理失敗。ログ: %s\n' "$log_file" >&2
  exit "$status"
fi

bash -n example.sh
shellcheck -s bash example.sh

# 管理者が内容を確認して設置する設定例
/var/log/myscript.log {
    daily
    missingok
    rotate 7
    compress
    notifempty
    create 0600 root root
}

#!/usr/bin/env bash
retry() {
  local attempt status
  if [[ "$#" -eq 0 ]]; then
    printf '再試行するコマンドを指定してください\n' >&2
    return 2
  fi
  for attempt in 1 2 3; do
    if "$@"; then
      return 0
    else
      status=$?
    fi
    # この例の契約では75だけが一時エラー。
    if [[ "$status" -ne 75 || "$attempt" -eq 3 ]]; then
      return "$status"
    fi
    printf '一時エラー。1秒後に再試行します (%d/3)\n' "$attempt" >&2
    sleep 1 || return "$?"
  done
}

# 外部状態を変更しないテスト用関数。3回目だけ成功する。
attempts=0
mock_operation() {
  attempts=$((attempts + 1))
  if [[ "$attempts" -lt 3 ]]; then return 75; fi
  printf '3回目で成功しました\n'
}
if retry mock_operation; then
  printf '処理完了\n'
else
  status=$?
  printf '再試行を終了しました (status=%d)\n' "$status" >&2
  exit "$status"
fi