シェルスクリプトの入力バリデーション設計｜型・形式チェック関数をライブラリ化して複数スクリプトで再利用する方法

この記事のポイント

・バリデーション不在のスクリプトは引数ミスで本番データを破壊するリスクがある
・整数チェックは [[ $val =~ ^[0-9]+$ ]] の1行で実装できる
・チェック関数を lib/validate.sh にまとめると複数スクリプトで source 再利用できる
・usage 関数と exit 1 をセットにしてスクリプト自身が使い方を提示する設計が鉄則

#!/bin/bash
set -euo pipefail

usage() {
    cat >&2 <<'EOF'
Usage: SCRIPT_NAME   

  src_dir        : バックアップ元ディレクトリ（例: /var/data）
  dst_dir        : バックアップ先ディレクトリ（例: /mnt/backup）
  retention_days : 世代保持日数（1以上の整数）

Example:
  SCRIPT_NAME /var/data /mnt/backup 30
EOF
    exit 1
}

# 引数が3つ以外のとき即座にusageを表示して終了
[ $# -eq 3 ] || usage

src_dir=$1
dst_dir=$2
retention_days=$3

# 引数の空チェック関数
check_nonempty() {
    local name=$1
    local val=${2:-}
    if [[ -z $val ]]; then
        echo "ERROR: $name が空文字です" >&2
        exit 1
    fi
}

# 使用例
check_nonempty "src_dir" "$src_dir"
check_nonempty "dst_dir" "$dst_dir"
check_nonempty "retention_days" "$retention_days"

# 整数チェック（負の整数も許可する場合）
is_integer() {
    [[ ${1:-} =~ ^-?[0-9]+$ ]]
}

# 正の整数のみ許可（0は除く）
is_positive_int() {
    [[ ${1:-} =~ ^[1-9][0-9]*$ ]]
}

# 使用例：世代保持日数は正の整数でなければならない
if ! is_positive_int "$retention_days"; then
    echo "ERROR: retention_days は1以上の整数で指定してください（指定値: $retention_days）" >&2
    exit 1
fi

# 整数の範囲チェック（min以上max以下）
is_in_range() {
    local val=$1 min=$2 max=$3
    is_integer "$val" || return 1
    (( val >= min && val <= max ))
}

# 使用例：保持日数は1以上365以下
if ! is_in_range "$retention_days" 1 365; then
    echo "ERROR: retention_days は 1 以上 365 以下で指定してください（指定値: $retention_days）" >&2
    exit 1
fi

# 小数点を含む数値チェック
is_number() {
    [[ ${1:-} =~ ^-?[0-9]+(\.[0-9]+)?$ ]]
}

# 文字列長チェック（min_len 以上 max_len 以下）
check_str_length() {
    local name=$1 val=$2 min=$3 max=$4
    local len=${#val}
    if (( len < min || len > max )); then
        echo "ERROR: $name の長さは ${min}以上${max}以下にしてください（現在: ${len}文字）" >&2
        exit 1
    fi
}

is_ipv4() {
    local re='^([0-9]{1,3}\.){3}[0-9]{1,3}$'
    [[ ${1:-} =~ $re ]] || return 1
    # 各オクテットが 0 以上 255 以下かチェック
    local IFS='.' arr
    read -r -a arr <<< "$1"
    local o
    for o in "${arr[@]}"; do
        (( o >= 0 && o <= 255 )) || return 1
    done
}

# 使用例
server_ip="192.168.10.256"
if ! is_ipv4 "$server_ip"; then
    echo "ERROR: $server_ip は正しいIPv4アドレスではありません" >&2
    exit 1
fi

# Rocky Linux 9.4 での動作確認
$ is_ipv4 "192.168.1.100" && echo OK || echo NG
OK
$ is_ipv4 "192.168.10.256" && echo OK || echo NG
NG
$ is_ipv4 "not-an-ip" && echo OK || echo NG
NG

is_date_ymd() {
    local re='^[0-9]{4}-[0-1][0-9]-[0-3][0-9]$'
    [[ ${1:-} =~ $re ]] || return 1
    # dateコマンドで実在する日付か確認（GNU date 必須）
    date -d "$1" >/dev/null 2>&1
}

# 使用例
start_date="2024-02-30"   # 2月30日は存在しない
if ! is_date_ymd "$start_date"; then
    echo "ERROR: $start_date は正しい日付（YYYY-MM-DD形式）ではありません" >&2
    exit 1
fi

# ディレクトリの存在と読み取り権限チェック
check_dir_readable() {
    local name=$1 path=$2
    if [[ ! -d $path ]]; then
        echo "ERROR: $name ($path) が存在しないかディレクトリではありません" >&2
        exit 1
    fi
    if [[ ! -r $path ]]; then
        echo "ERROR: $name ($path) に読み取り権限がありません" >&2
        exit 1
    fi
}

# ディレクトリの書き込み権限チェック
check_dir_writable() {
    local name=$1 path=$2
    if [[ ! -d $path ]]; then
        echo "ERROR: $name ($path) が存在しません" >&2
        exit 1
    fi
    if [[ ! -w $path ]]; then
        echo "ERROR: $name ($path) に書き込み権限がありません" >&2
        exit 1
    fi
}

# ファイルの存在と読み取り権限チェック
check_file_readable() {
    local name=$1 path=$2
    if [[ ! -f $path ]]; then
        echo "ERROR: $name ($path) が存在しないかファイルではありません" >&2
        exit 1
    fi
    if [[ ! -r $path ]]; then
        echo "ERROR: $name ($path) に読み取り権限がありません" >&2
        exit 1
    fi
}

is_one_of() {
    local val=$1
    shift
    local choice
    for choice in "$@"; do
        [[ $val == "$choice" ]] && return 0
    done
    return 1
}

# 使用例：環境はdev/staging/prodのいずれか
env_name="$1"
if ! is_one_of "$env_name" dev staging prod; then
    echo "ERROR: 環境は dev / staging / prod のいずれかで指定してください（指定値: $env_name）" >&2
    exit 1
fi

project/
├── lib/
│   └── validate.sh    # バリデーション関数ライブラリ
├── backup.sh          # バックアップスクリプト
├── deploy.sh          # デプロイスクリプト
└── cleanup.sh         # 古いファイル削除スクリプト

#!/bin/bash
# lib/validate.sh — シェルスクリプト共通バリデーションライブラリ

# 二重source防止ガード（同じライブラリを複数回sourceしても安全にする）
[[ -n ${_VALIDATE_SH:-} ]] && return 0
_VALIDATE_SH=1

# ----- 文字列系 -----
check_nonempty() {
    local name=$1 val=${2:-}
    [[ -n $val ]] && return 0
    echo "ERROR: $name が空文字です" >&2; exit 1
}

check_str_length() {
    local name=$1 val=$2 min=$3 max=$4
    local len=${#val}
    (( len >= min && len <= max )) && return 0
    echo "ERROR: $name の文字数は ${min}以上${max}以下にしてください（現在: ${len}文字）" >&2; exit 1
}

# ----- 数値系 -----
is_integer()      { [[ ${1:-} =~ ^-?[0-9]+$ ]]; }
is_positive_int() { [[ ${1:-} =~ ^[1-9][0-9]*$ ]]; }
is_number()       { [[ ${1:-} =~ ^-?[0-9]+(\.[0-9]+)?$ ]]; }

is_in_range() {
    local val=$1 min=$2 max=$3
    is_integer "$val" || return 1
    (( val >= min && val <= max ))
}

# ----- 形式系 -----
is_ipv4() {
    local re='^([0-9]{1,3}\.){3}[0-9]{1,3}$'
    [[ ${1:-} =~ $re ]] || return 1
    local IFS='.' arr
    read -r -a arr <<< "$1"
    local o; for o in "${arr[@]}"; do (( o >= 0 && o <= 255 )) || return 1; done
}

is_date_ymd() {
    local re='^[0-9]{4}-[0-1][0-9]-[0-3][0-9]$'
    [[ ${1:-} =~ $re ]] || return 1
    date -d "$1" >/dev/null 2>&1
}

is_one_of() {
    local val=$1; shift
    local c; for c in "$@"; do [[ $val == "$c" ]] && return 0; done; return 1
}

# ----- ファイル・ディレクトリ系 -----
check_dir_readable() {
    local name=$1 path=$2
    [[ -d $path ]] || { echo "ERROR: $name ($path) がディレクトリではありません" >&2; exit 1; }
    [[ -r $path ]] || { echo "ERROR: $name ($path) に読み取り権限がありません" >&2; exit 1; }
}

check_dir_writable() {
    local name=$1 path=$2
    [[ -d $path ]] || { echo "ERROR: $name ($path) が存在しません" >&2; exit 1; }
    [[ -w $path ]] || { echo "ERROR: $name ($path) に書き込み権限がありません" >&2; exit 1; }
}

check_file_readable() {
    local name=$1 path=$2
    [[ -f $path ]] || { echo "ERROR: $name ($path) がファイルではありません" >&2; exit 1; }
    [[ -r $path ]] || { echo "ERROR: $name ($path) に読み取り権限がありません" >&2; exit 1; }
}

#!/bin/bash
set -euo pipefail

# スクリプト自身の場所から相対パスでlib/を解決する
SCRIPT_DIR=$(cd "$(dirname "$0")" && pwd)
# shellcheck source=./lib/validate.sh
source "$SCRIPT_DIR/lib/validate.sh"

# 以後は validate.sh の関数がそのまま使える
is_positive_int "$1" || { echo "ERROR: 第1引数は正の整数で指定してください" >&2; exit 1; }

#!/bin/bash
# backup.sh — バリデーション付きrsyncバックアップスクリプト
set -euo pipefail

SCRIPT_DIR=$(cd "$(dirname "$0")" && pwd)
source "$SCRIPT_DIR/lib/validate.sh"

usage() {
    cat >&2 <<'EOF'
Usage: backup.sh   

  src_dir        : バックアップ元ディレクトリ
  dst_dir        : バックアップ先ディレクトリ（書き込み権限が必要）
  retention_days : 世代保持日数（1以上365以下の整数）

Example:
  backup.sh /var/data /mnt/backup 30
EOF
    exit 1
}

# ---- 引数チェック ----
[ $# -eq 3 ] || usage

src_dir=$1
dst_dir=$2
retention_days=$3

# 各引数のバリデーション（本処理より前に全部済ませる）
check_nonempty "src_dir" "$src_dir"
check_dir_readable "src_dir" "$src_dir"

check_nonempty "dst_dir" "$dst_dir"
check_dir_writable "dst_dir" "$dst_dir"

if ! is_in_range "$retention_days" 1 365; then
    echo "ERROR: retention_days は 1 以上 365 以下の整数で指定してください（指定値: $retention_days）" >&2
    exit 1
fi

# ---- バリデーション通過後に本処理を書く ----
timestamp=$(date +%Y%m%d_%H%M%S)
backup_dir="$dst_dir/$timestamp"

echo "[INFO] バックアップ開始: $src_dir → $backup_dir"
rsync -av --link-dest="$dst_dir/latest" "$src_dir/" "$backup_dir/"
ln -snf "$backup_dir" "$dst_dir/latest"

echo "[INFO] ${retention_days}日超の古いバックアップを削除します"
find "$dst_dir" -maxdepth 1 -type d -mtime +"$retention_days" -exec rm -rf {} +

echo "[INFO] バックアップ完了"

# 世代保持日数に不正値を渡した場合
$ ./backup.sh /var/data /mnt/backup abc
ERROR: retention_days は 1 以上 365 以下の整数で指定してください（指定値: abc）
$ echo $?
1

# バックアップ元が存在しない場合
$ ./backup.sh /nonexistent /mnt/backup 30
ERROR: src_dir (/nonexistent) がディレクトリではありません
$ echo $?
1

# 引数が不足している場合
$ ./backup.sh /var/data /mnt/backup
Usage: backup.sh   

  src_dir        : バックアップ元ディレクトリ
  dst_dir        : バックアップ先ディレクトリ（書き込み権限が必要）
  retention_days : 世代保持日数（1以上365以下の整数）

Example:
  backup.sh /var/data /mnt/backup 30

# エラー例
/path/to/backup.sh: line 7: /path/to/backup.sh/../lib/validate.sh: No such file or directory