LinuxBashスクリプトを実行する前に構文を検証する方法
公開: 2022-06-16
Linux Bashスクリプトのバグやタイプミスは、スクリプトの実行時に悲惨なことをする可能性があります。 スクリプトを実行する前に、スクリプトの構文を確認する方法をいくつか紹介します。
それらの厄介なバグ
コードを書くのは難しいです。 もっと正確に言うと、バグのない重要なコードを書くのは難しいです。 また、プログラムまたはスクリプトに含まれるコード行が多いほど、バグが発生する可能性が高くなります。
あなたがプログラムする言語はこれに直接関係しています。 アセンブリでのプログラミングはCでのプログラミングよりもはるかに困難であり、CでのプログラミングはPythonでのプログラミングよりも困難です。 プログラミングしている言語のレベルが低いほど、自分でやらなければならない作業が増えます。 Pythonは組み込みのガベージコレクションルーチンを楽しむかもしれませんが、Cとアセンブリは確かにそうではありません。
Linuxシェルスクリプトの作成には、独自の課題があります。 Cのようなコンパイル言語では、コンパイラと呼ばれるプログラムがソースコード（テキストファイルに入力する人間が読める形式の命令）を読み取り、それをバイナリ実行可能ファイルに変換します。 バイナリファイルには、コンピュータが理解して実行できるマシンコード命令が含まれています。
コンパイラは、読み取りおよび解析しているソースコードが言語の構文およびその他の規則に従っている場合にのみ、バイナリファイルを生成します。 予約語（言語のコマンドワードの1つ）または変数名のスペルを間違えると、コンパイラーはエラーをスローします。
たとえば、変数を使用する前に変数を宣言するように要求する言語もあれば、それほど面倒ではない言語もあります。 使用している言語で変数を宣言する必要があるが、それを忘れた場合、コンパイラーは別のエラーメッセージをスローします。 これらのコンパイル時のエラーは厄介ですが、多くの問題をキャッチし、それらに対処するように強制します。 ただし、構文上のバグがないプログラムを使用している場合でも、バグがないことを意味するわけではありません。 それからは程遠い。
論理的な欠陥が原因であるバグは、通常、見つけるのがはるかに困難です。 プログラムに2と3を追加するように指示したが、本当に2と2を追加したい場合は、期待した答えが得られません。 しかし、プログラムはそれが行うように書かれていることを行っています。 プログラムの構成や構文に問題はありません。 問題はあなたです。 あなたはあなたが望んでいたことをしない整形式のプログラムを書きました。
テストは難しい
単純なプログラムであっても、プログラムを徹底的にテストするには時間がかかります。 数回実行するだけでは不十分です。 コードのすべての部分が検証されるように、コード内のすべての実行パスを実際にテストする必要があります。 プログラムが入力を要求する場合は、許容できない入力を含むすべての条件をテストするために、十分な範囲の入力値を提供する必要があります。
高水準言語の場合、単体テストと自動テストは、徹底的なテストを管理しやすい演習にするのに役立ちます。 問題は、バグのないBashシェルスクリプトを作成するために使用できるツールはあるかということです。
答えは「はい」です。Bashシェル自体も含まれます。
Bashを使用してスクリプト構文をチェックする
Bash -n （noexec）オプションは、スクリプトを実行せずに、スクリプトを読み取り、構文エラーがないかどうかを確認するようにBashに指示します。 スクリプトの目的によっては、スクリプトを実行して問題を探すよりもはるかに安全な場合があります。
これがチェックするスクリプトです。 複雑ではありません。主にifステートメントのセットです。 月を表す数値の入力を求め、受け入れます。 スクリプトは、その月がどの季節に属するかを決定します。 明らかに、ユーザーがまったく入力を提供しない場合、またはユーザーが数字ではなく文字のように無効な入力を提供する場合、これは機能しません。
＃！ / bin / bash read -p "月を入力してください（1から12）："月 ＃彼らは何かを入力しましたか？ if [-z "$ month"] それから echo"月を表す数字を入力する必要があります。" 出口1 fi ＃有効な月ですか？ if（（ "$ month" <1 || "$ month"> 12））; それから echo"月は1から12までの数字でなければなりません。" 出口0 fi ＃春の月ですか？ if（（ "$ month"> = 3 && "$ month" <6））; それから echo「それは春の月です。」 出口0 fi ＃夏の月ですか？ if（（ "$ month"> = 6 && "$ month" <9））; それから echo「それは夏の月です。」 出口0 fi ＃秋の月ですか？ if（（ "$ month"> = 9 && "$ month" <12））; それから echo「それは秋の月です。」 出口0 fi ＃それは冬の月でなければなりません echo「それは冬の月です。」 出口0
このセクションでは、ユーザーが何かを入力したかどうかを確認します。 $month変数が設定されていないかどうかをテストします。
if [-z "$ month"] それから echo"月を表す数字を入力する必要があります。" 出口1 fi
このセクションでは、1〜12の数字が入力されているかどうかを確認します。文字や句読記号は数値に変換されないため、数字ではない無効な入力もトラップします。
＃有効な月ですか？ if（（ "$ month" <1 || "$ month"> 12））; それから echo"月は1から12までの数字でなければなりません。" 出口0 fi
他のすべてのIf句は、 $month変数の値が2つの値の間にあるかどうかをチェックします。 もしそうなら、その月はその季節に属します。 たとえば、ユーザーが入力した月が6、7、または8の場合、それは夏の月です。
＃夏の月ですか？ if（（ "$ month"> = 6 && "$ month" <9））; それから echo「それは夏の月です。」 出口0 fi
例を実行する場合は、スクリプトのテキストをコピーしてエディターに貼り付け、「seasons.sh」として保存します。 次に、 chmodコマンドを使用してスクリプトを実行可能にします。
chmod + xseasons.sh
スクリプトをテストするには、
- 入力をまったく提供しません。
- 数値以外の入力を提供します。
- 1から12の範囲外の数値を提供します。
- 1から12の範囲内の数値を提供します。
いずれの場合も、同じコマンドでスクリプトを開始します。 唯一の違いは、スクリプトによってプロモートされたときにユーザーが提供する入力です。
./seasons.sh
それは期待どおりに機能しているようです。 Bashにスクリプトの構文をチェックさせましょう。 これを行うには、 -n （noexec）オプションを呼び出し、スクリプトの名前を渡します。
bash -n ./seasons.sh
これは「ニュースがないことは良いニュースである」という場合です。 サイレントにコマンドプロンプトに戻るのは、すべてが問題ないように見えるというBashの言い方です。 スクリプトを妨害してエラーを導入しましょう。
最初のif句からthenを削除します。
＃有効な月ですか？ if（（ "$ month" <1 || "$ month"> 12））; ＃「then」は削除されました echo"月は1から12までの数字でなければなりません。" 出口0 fi
それでは、最初にユーザーからの入力なしで、次にユーザーからの入力ありで、スクリプトを実行してみましょう。
./seasons.sh
スクリプトを初めて実行するとき、ユーザーは値を入力しないため、スクリプトは終了します。 私たちが妨害したセクションに到達することはありません。 スクリプトは、Bashからのエラーメッセージなしで終了します。
2回目のスクリプトの実行時に、ユーザーは入力値を提供し、最初のif句が実行されて、ユーザーの入力の健全性がチェックされます。 これにより、Bashからのエラーメッセージがトリガーされます。
Bashは、スクリプトのロジックを気にしないため、その句の構文（およびコードの他のすべての行）をチェックすることに注意してください。 スクリプトが実行されていないため、Bashがスクリプトをチェックするときに、ユーザーは番号の入力を求められません。
スクリプトのさまざまな実行パスは、Bashが構文をチェックする方法に影響を与えません。 Bashは、スクリプトの上部から下部に向かって単純かつ系統的に機能し、すべての行の構文をチェックします。
ShellCheckユーティリティ
リンター（Unixの全盛期のCソースコードチェックツールにちなんで名付けられました）は、プログラミングエラー、スタイルエラー、および言語の疑わしいまたは疑わしい使用を検出するために使用されるコード分析ツールです。 リンターは多くのプログラミング言語で利用可能であり、衒学者として有名です。 リンターが見つけたものすべてがそれ自体がバグであるとは限りませんが、リンターが気付くものはすべて注目に値するでしょう。
ShellCheckは、シェルスクリプト用のコード分析ツールです。 Bashのリンターのように動作します。
欠落していthen予約語をスクリプトに戻し、別のことを試してみましょう。 最初のif句から開き角かっこ「[」を削除します。
＃彼らは何かを入力しましたか？ if -z "$ month"]＃開き角かっこ"["が削除されました それから echo"月を表す数字を入力する必要があります。" 出口1 fi
Bashを使用してスクリプトをチェックしても、問題は見つかりません。
bash -nseasons.sh
./seasons.sh
しかし、スクリプトを実行しようとすると、エラーメッセージが表示されます。 また、エラーメッセージが表示されても、スクリプトは実行を続けます。 これが、いくつかのバグが非常に危険である理由です。 スクリプトでさらに実行されるアクションがユーザーからの有効な入力に依存している場合、スクリプトの動作は予測できません。 データを危険にさらす可能性があります。
Bash -n （noexec）オプションがスクリプトでエラーを検出しない理由は、開き角かっこ「[」が[と呼ばれる外部プログラムであるためです。 それはBashの一部ではありません。 これは、 testコマンドを使用する簡単な方法です。
Bashは、スクリプトを検証しているときに外部プログラムの使用をチェックしません。
ShellCheckのインストール
ShellCheckをインストールする必要があります。 Ubuntuにインストールするには、次のように入力します。
sudo apt install shellcheck
ShellCheckをFedoraにインストールするには、このコマンドを使用します。 パッケージ名は大文字と小文字が混在していることに注意してください。ただし、ターミナルウィンドウでコマンドを発行すると、すべて小文字になります。
sudo dnf install ShellCheck
Manjaroおよび同様のArchベースのディストリビューションでは、 pacmanを使用します。
sudopacman-Sシェルチェック
ShellCheckの使用
スクリプトでShellCheckを実行してみましょう。
shellcheckseasons.sh
ShellCheckは問題を検出して報告し、詳細情報への一連のリンクを提供します。 リンクを右クリックして、表示されるコンテキストメニューから[リンクを開く]を選択すると、そのリンクがブラウザで開きます。
ShellCheckは、それほど深刻ではない別の問題も検出します。 緑色のテキストで報告されます。 これは、これが警告であり、徹底的なエラーではないことを示しています。
エラーを修正して、欠落している「[」を置き換えましょう。 バグ修正戦略の1つは、優先度の最も高い問題を最初に修正し、後で警告などの優先度の低い問題に取り組むことです。
欠落している「[」を置き換えて、ShellCheckをもう一度実行しました。
shellcheckseasons.sh
ShellCheckからの唯一の出力は、以前の警告を参照しているので、それは良いことです。 修正が必要な優先度の高い問題はありません。
警告は、 -r （そのまま読み取る）オプションを指定せずにreadコマンドを使用すると、入力の円記号がエスケープ文字として扱われることを示しています。 これは、リンターが生成できるペダンティック出力のタイプの良い例です。 この場合、ユーザーはとにかく円記号を入力するべきではありません。数字を入力する必要があります。
このような警告には、プログラマー側の判断を求める必要があります。 それを修正する努力をしますか、それともそのままにしますか？ これは単純な2秒の修正です。 また、ShellCheckの出力を乱雑にする警告を停止するので、アドバイスを受けることもできます。 readコマンドのフラグを選択するために「r」を追加し、スクリプトを保存します。
read -pr "月を入力してください（1から12）："月
ShellCheckをもう一度実行すると、クリーンな状態が得られます。
ShellCheckはあなたの友達です
ShellCheckは、さまざまな問題を検出、報告、およびアドバイスできます。 検出できる問題の種類がいくつあるかを示す、不良コードのギャラリーを確認してください。
それは無料で高速であり、シェルスクリプトを書くことから多くの苦痛を取り除きます。 嫌いなものは何ですか？