set -xコマンドでシェルスクリプトをデバッグする方法｜set -e・set -uとの組み合わせも

この記事のポイント

・set -x を使うと実行コマンドがトレース表示されデバッグが容易になる
・set -e でスクリプトをエラー発生時に即終了させ被害を最小化できる
・set -u で未定義変数を早期検知し変数名ミスのバグを防げる
・3つを組み合わせた set -eux が現場のシェルスクリプト冒頭の定番形式

#!/bin/bash
# バグを含むスクリプトの例
cp /etc/hosts /tmp/hosts_backup
rm /tmp/hossts_backup    # hostsをhosstsとスペルミス
echo "バックアップ完了"

#!/bin/bash
set -x

BACKUP_DIR="/tmp/backup"
mkdir -p "$BACKUP_DIR"
cp /etc/hosts "$BACKUP_DIR/hosts"
echo "バックアップ完了"

$ bash debug_test.sh
+ BACKUP_DIR=/tmp/backup
+ mkdir -p /tmp/backup
+ cp /etc/hosts /tmp/backup/hosts
+ echo 'バックアップ完了'
バックアップ完了

# スクリプトを直接実行する場合
bash -x スクリプト名.sh

# shebangがある場合も同様
bash -x /usr/local/bin/backup.sh

#!/bin/bash

echo "ここはトレースしない"

set -x    # トレース開始
DB_HOST="db.example.com"
mysql -h "$DB_HOST" -u root -p"${DB_PASS}" mydb -e "SHOW TABLES;"
set +x    # トレース終了

echo "ここもトレースしない"

#!/bin/bash
set -e

mkdir /tmp/mydir
cp /etc/hosts /tmp/mydir/
# ここで cp が失敗すると、以降の処理は実行されない
echo "ファイルコピー完了"

#!/bin/bash
set -e

# grep が見つからなくても続行させたい場合
grep "WARN" /var/log/messages || true

# コマンドが失敗しても続けたい場合
rm -f /tmp/old_lock || true

echo "処理完了"

#!/bin/bash
set -e

# if の条件部はエラーでもスクリプトが終了しない
if grep -q "ERROR" /var/log/app.log; then
    echo "エラーを検知しました"
fi

#!/bin/bash
# 危険なスクリプトの例（set -u なし）
TARGET_DIR="$TARGETT_DIR"    # スペルミス：TARGETT_DIR は未定義

rm -rf "$TARGET_DIR/"    # 展開結果: rm -rf /  → 壊滅的被害

$ bash test.sh
test.sh: line 2: TARGETT_DIR: unbound variable

#!/bin/bash
set -u

# LOG_LEVEL が未設定の場合は "INFO" を使う
LOG_LEVEL="${LOG_LEVEL:-INFO}"

# BACKUP_DIR が未設定の場合は /tmp/backup を使う
BACKUP_DIR="${BACKUP_DIR:-/tmp/backup}"

echo "ログレベル: $LOG_LEVEL"
echo "バックアップ先: $BACKUP_DIR"

#!/bin/bash
set -eux

# e: エラーで即終了
# u: 未定義変数をエラー
# x: コマンドをトレース表示

DEPLOY_DIR="/var/www/html"
BACKUP_DIR="/var/www/backup"

mkdir -p "$BACKUP_DIR"
cp -r "$DEPLOY_DIR" "$BACKUP_DIR/$(date +%Y%m%d)"
echo "デプロイバックアップ完了"

#!/bin/bash
set -euxo pipefail

# パイプ途中の失敗も検知できる
grep "ERROR" /var/log/app.log | wc -l

#!/bin/bash

# トレース出力をファイルディスクリプタ3に割り当て
exec 3>/tmp/debug_trace.log
BASH_XTRACEFD=3

set -x

BACKUP_DIR="/tmp/backup"
mkdir -p "$BACKUP_DIR"
cp /etc/hosts "$BACKUP_DIR/"

set +x
exec 3>&-    # ファイルディスクリプタを閉じる

#!/bin/bash
# 行番号付きのトレース表示
export PS4='+(${BASH_SOURCE}:${LINENO}): '
set -x

echo "処理開始"
sleep 1
echo "処理終了"

# 実行結果
+(debug_test.sh:5): echo '処理開始'
処理開始
+(debug_test.sh:6): sleep 1
+(debug_test.sh:7): echo '処理終了'
処理終了

# エラー例
./script.sh: line 5: MY_VARR: unbound variable

# 対処：変数名を確認し、デフォルト値を設定する
MY_VAR="${MY_VAR:-default_value}"

#!/bin/bash
set -e

# grep が0件のとき終了コード1を返し、set -e でスクリプト終了してしまう
# 対処：|| true を付けて終了コードを無視する
WARN_COUNT=$(grep -c "WARN" /var/log/app.log || true)
echo "警告件数: $WARN_COUNT"

#!/bin/bash
set -euxo pipefail

# サブシェルで実行されるコマンドも set -e の対象
FILES=$(ls /nonexistent 2>/dev/null || echo "")
if [ -z "$FILES" ]; then
    echo "ファイルなし"
fi