bash入門：trapについて

よっしー

こんにちは。よっしーです(^^)

今日は、bashにおけるtrapについてご紹介します。

背景
実行環境について
概要
1. 作成ファイル一覧
2. 08_trap.sh
動作確認
解説
1. 08_trap.sh
2. trapコマンドについて
おわりに

背景

bashにおけるtrapについて調査する機会があったので、そのときの内容を備忘として残しました。

この記事のソースは下記のサイトにアップしています。

GitHub - Gate-Yossi/Musica: 読み方：ムジカ

読み方：ムジカ. Contribute to Gate-Yossi/Musica development by creating an account on GitHub.

実行環境について

実行環境は下記の記事を参考にお願いします。

概要

本記事のtrapは、エラーが発生した箇所を標準出力します。

作成ファイル一覧

下記のファイルを作成しました。

        new file:   local/work/08_trap/08_trap.sh

08_trap.sh

#!/usr/bin/env bash

set -euCo pipefail

readonly LOG_OUT=./stdout.log
readonly LOG_ERR=./stderr.log

exec 1> >(tee -a "$LOG_OUT")
exec 2> >(tee -a "$LOG_ERR")

function trap_err() {
    error_status=$?
    echo "エラー発生 \$?=${error_status} ${BASH_SOURCE[0]} ${FUNCNAME[1]}:${BASH_LINENO[0]}"
}

trap trap_err ERR

function log() {
    echo "[$(date '+%Y/%m/%d %H:%M:%S.%3N')] $*"
}

log "$(which bash)"

log "$(bash --version)"

# 標準エラーへの出力確認用
ls dummy.txt

echo "ここは表示されない"

動作確認

下記のコマンドを実行します。

make build

make up

make login

cd 08_trap

chmod +x 08_trap.sh

./08_trap.sh

strout.logにも同様のエラー文言が出力されている想定です。

[2023/12/10 07:46:17.340] /usr/bin/bash
[2023/12/10 07:46:17.347] GNU bash, version 5.2.15(1)-release (aarch64-unknown-linux-gnu)
Copyright (C) 2022 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
ls: cannot access 'dummy.txt': No such file or directory
エラー発生 $?=2 ./08_trap.sh main:27

解説

08_trap.sh

このスクリプトは、エラーが発生した際にエラーハンドリングを行う Bash スクリプトです。以下に各部分の解説を示します。

#!/usr/bin/env bash: スクリプトが Bash シェルで実行されることを指定しています。
set -euCo pipefail: スクリプトの設定を変更しています。

-e: エラーが発生したら即座にスクリプトを終了します。
-u: 未定義の変数を使用しようとするとエラーを発生させます。
-C: コマンドの返り値が0以外の場合、そのコマンドが非零であることを示します。
-o pipefail: パイプの途中でエラーが発生した場合、パイプ全体をエラーとして扱います。

readonly LOG_OUT=./stdout.log: 標準出力を記録するログファイルのパスを指定します。
readonly LOG_ERR=./stderr.log: 標準エラーを記録するログファイルのパスを指定します。
exec 1> >(tee -a "$LOG_OUT"): 標準出力をファイルにリダイレクトし、同時にその内容を標準出力にも表示します。リダイレクト先は $LOG_OUT となります。
exec 2> >(tee -a "$LOG_ERR"): 標準エラーをファイルにリダイレクトし、同時にその内容を標準エラーにも表示します。リダイレクト先は $LOG_ERR となります。
function trap_err() { ... }: trap_errという関数を定義しています。この関数は、trapコマンドを使用してエラーが発生した際に呼び出されるように設定されます。エラーが発生した場合、エラーの発生箇所とエラーのステータスを表示します。
trap trap_err ERR: trapコマンドを使用して、ERR（エラーが発生した際）に対してtrap_err関数が呼び出されるように設定しています。
function log() { ... }: logという関数を定義しています。この関数は、指定されたメッセージを日付とともにログとして表示します。
log "$(which bash)": インストールされている Bash の実行ファイルのパスをログに記録します。
log "$(bash --version)": Bash のバージョン情報をログに記録します。
ls dummy.txt: 標準エラーへの出力確認用に、存在しないファイル dummy.txt を ls コマンドでリストします。この部分でエラーが発生し、trap_err関数が呼び出され、エラーの発生箇所とエラーのステータスが表示されます。
echo "ここは表示されない": 上記の ls dummy.txt でエラーが発生した場合、この行は実行されません。スクリプトはエラーが発生した時点で終了するため、この行は実行されません。

このスクリプトはエラーハンドリングの例であり、エラーが発生した場合にそれを適切に処理する仕組みが組み込まれています。

trapコマンドについて

trapは、シェルスクリプト内でシグナル（信号）やイベントを捕捉し、それに対して特定の処理を実行するためのコマンドです。主にエラーハンドリングやシグナルの処理に使用されます。trapの基本構文は以下の通りです：

trap 'コマンド' シグナル

'コマンド': シグナルが発生したときに実行するコマンドやシェルスクリプトを指定します。シグナルが発生すると、このコマンドが実行されます。
シグナル: trapが設定されるシグナルを指定します。例えば、ERRはエラーが発生したとき、EXITはスクリプトが終了するときなどです。

以下によく使用されるtrapの用途をいくつか紹介します：

エラーハンドリング: trap 'echo "エラーが発生しました"' ERR この例では、スクリプト内でエラーが発生した際に、”エラーが発生しました”と表示するようになります。
スクリプト終了時の処理: trap 'echo "スクリプトが終了しました"' EXIT スクリプトが終了するときに、”スクリプトが終了しました”と表示するようになります。
特定のシグナルの無視: trap '' HUP HUPシグナル（ハングアップシグナル）を無視するように設定します。
トラップを解除: trap - ERR ERRシグナルに設定されたトラップを解除します。