ウェブサイト検索

シェルスクリプトで構文チェックのデバッグモードを実行する方法


私たちは、さまざまなデバッグオプションとシェルスクリプトのデバッグモードを有効にする方法を説明することからシェルスクリプトデバッグシリーズを開始しました。

シェルスクリプトを書いた後は、出力を確認して正しく動作していることを確認するのではなく、実際にスクリプトの構文をチェックすることをお勧めします。

このシリーズのこの部分では、構文チェックデバッグモードの使用方法について説明します。シリーズの最初の部分でさまざまなデバッグオプションについて説明したことを思い出してください。ここでは、それらを使用してスクリプトのデバッグを行います。

冗長デバッグモードを有効にする

このガイドの主要な焦点に移る前に、冗長モードを簡単に説明しましょう。このモードは、シェルにスクリプトが読み込まれる際にすべての行を表示するよう指示する-vデバッグオプションによって有効になります。

これがどのように機能するかを示すために、以下はPNG画像をJPG形式にバッチ変換するためのサンプルシェルスクリプトです。

それをファイルに入力(またはコピー&ペースト)してください。

#!/bin/bash
#convert
for image in *.png; do
        convert  "$image"  "${image%.png}.jpg"
        echo "image $image converted to ${image%.png}.jpg"
done
exit 0

次に、ファイルを保存し、以下のコマンドを使用してスクリプトを実行可能にします:

$ chmod +x script.sh

スクリプトを呼び出し、シェルによって読み込まれるとおりにすべての行を表示することができます。

$ bash -v script.sh

シェルスクリプトで構文チェックデバッグモードを有効にする

私たちの強調のトピックに戻ると、-nは構文チェックモードを有効にします。これはシェルに基本的にすべてのコマンドを読み取るよう指示しますが、実行はしません。シェルは使用された構文だけを検査します。

シェルスクリプトにエラーがある場合、シェルは端末上にエラーを出力します。それ以外の場合は、何も表示されません。

構文チェックを有効にするための構文は次のとおりです:

$ bash -n script.sh

スクリプトの構文が正しいため、上記のコマンドは出力を表示しません。したがって、for ループを閉じる done という言葉を削除して、エラーが表示されるかどうか確認してみましょう:

以下は、バグが含まれているPNG画像をJPG形式にバッチ変換するための修正されたシェルスクリプトです。

#!/bin/bash
#script with a bug
#convert
for image in *.png; do
        convert  "$image"  "${image%.png}.jpg"
        echo "image $image converted to ${image%.png}.jpg"

exit 0

ファイルを保存してから、それを実行しながら構文チェックを行ってください:

$ bash -n script.sh

上記の出力から、私たちのスクリプトに構文の問題があることが分かります。for ループが閉じる done キーワードを欠いています。そして、シェルはファイルの終わりまでそれを探し、見つからなかったために (done)、シェルは構文エラーを出力しました。

script.sh: line 11: syntax error: unexpected end of file

冗長モードと構文チェックモードを一緒に組み合わせることもできます。

$ bash -vn script.sh

あるいは、次の例のようにスクリプトの最初の行を修正することで構文チェックを有効にできます。

#!/bin/bash -n
#altering the first line of a script to enable syntax checking

#convert
for image in *.png; do
    convert  "$image"  "${image%.png}.jpg"
    echo "image $image converted to ${image%.png}.jpg"

exit 0

以前と同様に、ファイルを保存して構文チェックを実行しながら実行してください。

$ ./script.sh

script.sh: line 12: syntax error: unexpected end of file

さらに、上記のスクリプトでデバッグモードを有効にするために、setシェル組み込みコマンドを使用できます。

以下の例では、スクリプト内のforループの構文のみをチェックしています。

#!/bin/bash
#using set shell built-in command to enable debugging
#convert

#enable debugging
set -n
for image in *.png; do
    convert  "$image"  "${image%.png}.jpg"
    echo "image $image converted to ${image%.png}.jpg"

#disable debugging
set +n
exit 0

もう一度、ファイルを保存してスクリプトを呼び出してください:

$ ./script.sh 

要約すると、シェルスクリプトを実行する前に、エラーを検出するために常に文法チェックを行うべきです。

このガイドに関する質問やフィードバックを送信するには、以下の回答フォームをご利用ください。このシリーズの第3部では、シェルトレースデバッグモードの説明と使用方法に進みます。

関連記事: