シェルスクリプトの二重起動防止を機能させたい。

Question

解決したいこと

動作確認時、フルパスでシェルスクリプトを実行した場合は二重起動防止が働くが、
（sh /usr/local/test/20_test.sh）
カレントディレクトリを省略してシェルスクリプトを実行すると二重起動防止が働かない。
（sh 20_test.sh）
（./20_test.sh）
※どちらも"cd /usr/local/test/"で対象シェルのカレントディレクトリに移動済み。

背景

◆対象シェルスクリプトに二重起動防止を追加し、二重起動防止が機能しているか動作確認で以下のテストを行った。
（環境はTeraterm）

1. 対象のシェルスクリプトを手動で実行後、5秒後にまた手動で実行する。
2. 対象のシェルスクリプトをcronで実行後、5秒後に手動で実行する。
3. 対象のシェルスクリプトを手動で実行後、5秒後にcronで実行する。

◆各テスト結果の確認は以下を判断にした。

1. エラーログが吐き出され、タイムスタンプが実行時であること。

　$ 2021/06/18 13:30:01 既に実行中です。
2. 実行ログのタイムスタンプが実行時であり、実行完了までログがダブってないこと。
$ 2021/06/18 13:29:55 【実行開始】
・
・
・
$ 2021/06/18 13:30:09 【実行終了】

対象のシェルスクリプトは以下になる。

#!/bin/bash

# 自シェルのパスを取得
export BASE_DIR=$(cd $(dirname $0); pwd)

#環境情報読み込み
source ${BASE_DIR}/conf/environment.conf

[ ! -d ${LOG_DIR} ] && mkdir ${LOG_DIR}
[ ! -d ${TEMP_DIR} ] && mkdir ${TEMP_DIR}

#二重で起動していないかチェックする(動作確認用にエラー時ログを吐き出す)
if [ $$ != `pgrep -fo $0` ] ; then
  echo `date '+%Y/%m/%d %H:%M:%S'`" 既に実行中です。" | tee /usr/local/test/error.log
  exit 1
fi

# 実行内容

echo "teratail用に変えたけど実際は色々動いてるよ。"

cronでの設定内容は以下になる。設定している時間はテスト用。

#二重起動防止_動作テスト用
30 13 * * * /usr/local/test/20_test.sh

手動実行時、フルパスでシェルスクリプトを実行する分には二重起動防止の機能が働くことは証明できたが、実際に運用する作業員がシェルスクリプト実行時に"./20_test.sh"で実行するのでなるべく作業員の意に沿って実装したいのでお力をお貸し下さい。

Answer 1

二重起動防止ならflockコマンドを使うのが良いかと思います。
簡単には、実行したいスクリプトをを呼び出すスクリプトを作る。

if flock --timeout=0 $0 実際に実行したいコマンド
then echo 実行できました
else echo 他の人が実行中でした
fi

実行中なら、$?が1で終了する。

Comments

[710LOVER]

ご回答ありがとうございます。
flockコマンド面白そうですね、試してみます！

Answer 2

参考までに…
二重起動防止というと実行中を意味するファイルを作成する方法もありますね。
(終了時に消します)
touch で作るサイズ 0 のだと負荷はあまり気にしなくていいし
実行開始したタイミングとか分かりますしね。
途中で終了したらゴミとして残るので、そのへんのケアは必要ですけど。
まあ、要件によってはこういう方法もあるってことで…

Comments

[otn]

任意のタイミングで実行されるコマンドの場合、ファイルを作るのでは排他制御は出来ないです。
ファイルが無いことを判断してから、ファイルを作るまでの間に、他のプロセスが同じ事をやると駄目。
mkdirだと、作る事と、それまでに無かったことのチェックが同時に出来るので、昔はmkdirでロックしてました。

[takasima20]

なるほどです。アドバイスありがとうございます。

[otn]

trap "rmdir $LOCKDIR 2>/dev/null" 0 1 2 3 ・・・シグナルを並べる

if mkdir $LOCKDIR 2>/dev/null
then echo ロックが取れた
else echo ロックが取れなかった
fi

[takasima20]

あー、trap でフォローしてるんスねえ。そこまで厳密にはやったことないですわ(汗

Answer 3

うまく再現できないので、ただの思いつきを書きますが、こうしてみたらどうですか？

fullpath=`readlink -f $0`
if [ $$ != `pgrep -fo $fullpath` ] ; then

---

あと、質問者さんが言っている「シェル」は「シェルスクリプト」のことですよね。
「シェルスクリプト」を「シェル」と呼んではなかなか伝わりませんので気をつけてください。

Comments

[710LOVER]

ご回答ありがとうございます。
「シェル」は「シェルスクリプト」に修正しました。

いったん原文のまま張り替えてシェルスクリプト単体の動作確認しましたが、二重起動防止が働いて動作しませんでした。

readlinkを選んだのはシンボリックリンクのリンク先とプロセスIDが同一セットかどうか判断させるのが狙いでしょうか？

[itagagaki]

問題なのは、最初に実行したシェルスクリプトがフルパスでない場合なのでしょうか？
それとも二重に実行したシェルスクリプトがフルパスでない場合なのでしょうか？

後者なのかなと思って、$0を常にフルパスに置き換えたらどうなのかなと思い、その手段として
readlinkを使ってみました。
まあreadlinkの本来の用途とは違いますけどね。

以下が私のUbuntu 20.04でのテスト結果です。参考になれば幸いです。

~$ cat test.sh
#!/bin/bash -x
echo $$
echo $0
fullpath=`readlink -f $0`
echo $fullpath
pgrep -f $0
pgrep -f $fullpath
~$ sh -x ./test.sh
+ echo 483
483
+ echo ./test.sh
./test.sh
+ readlink -f ./test.sh
+ fullpath=/home/ita/test.sh
+ echo /home/ita/test.sh
/home/ita/test.sh
+ pgrep -f ./test.sh
483
+ pgrep -f /home/ita/test.sh
~$ sh -x /home/ita/test.sh
+ echo 487
487
+ echo /home/ita/test.sh
/home/ita/test.sh
+ readlink -f /home/ita/test.sh
+ fullpath=/home/ita/test.sh
+ echo /home/ita/test.sh
/home/ita/test.sh
+ pgrep -f /home/ita/test.sh
487
+ pgrep -f /home/ita/test.sh
487
~$ ./test.sh
+ echo 491
491
+ echo ./test.sh
./test.sh
++ readlink -f ./test.sh
+ fullpath=/home/ita/test.sh
+ echo /home/ita/test.sh
/home/ita/test.sh
+ pgrep -f ./test.sh
491
+ pgrep -f /home/ita/test.sh
~$ /home/ita/test.sh
+ echo 495
495
+ echo /home/ita/test.sh
/home/ita/test.sh
++ readlink -f /home/ita/test.sh
+ fullpath=/home/ita/test.sh
+ echo /home/ita/test.sh
/home/ita/test.sh
+ pgrep -f /home/ita/test.sh
495
+ pgrep -f /home/ita/test.sh
495

[710LOVER]

問題なのは、最初に実行したシェルスクリプトがフルパスでない場合なのでしょうか？
それとも二重に実行したシェルスクリプトがフルパスでない場合なのでしょうか？
→両方です。

提示していただいたテスト結果をみるに、同じシェルスクリプトでも実行の仕方によってプロセスIDが異なってしまうのですね。

Answer 4

起動の仕方によってpgrep -fの対象の文字列が違ってくるので、考えられる全パターンにマッチする正規表現を書かなければならないわけですね。

これでどうでしょう。

if [ $$ != `pgrep -fo '([a-z/]*sh )?20_test.sh'` ] ; then

Comments

[710LOVER]

フルパスの有無に関わらず、動作確認ができました！
発想力が富んでて、とても学びになりました。

お時間いただきありがとうございます！