シェルスクリプトでset -eしているときに処理を中断せずエラーを扱う方法

シェルスクリプトで set -e (errexit) しておくと、スクリプト中に実行したコマンドの終了ステータスが「非0」だった場合、つまりコマンドが失敗したときにそこでスクリプトを中断してくれるようになります。(終了ステータスとは「Exit code」「Return status」などと呼ばれるものです。)

都度エラー判定を書かなくてもよくなるので便利なオプションですが、個別にエラーハンドリングをしたくなった時にも意図せずスクリプトが中断されてしまい困ったことになります。

例えば、以下の例は false コマンドの実行で失敗扱いとなり、そこでスクリプトが中断されるため「finish」が出力されることはありません。

set -e

# false コマンドは必ず終了ステータスに 1 (失敗) を返すコマンド
# エラーが起きたとみなされスクリプトは中断される
false

# このコマンドは実行されない
echo "finish"

-e オプションで困ってしまうケースの例

例えば、grep コマンドで検索結果が見つからなかった場合にエラーメッセージを出力したいケースがあったとしましょう。

grep は検索結果が何か見つかれば 0 (成功)、見つからなければ 1 (失敗) の終了ステータスを返す仕様ですが、以下の例では grep で見つからなかった場合、そこでスクリプトが中断されてしまうので、以降の if 文が実行されることはありません。

set -e
grep "apple" hoge.txt >/dev/null
ret=$?

if [[ $ret != 0 ]]; then
  # ここに入ってくることはない!
  echo "hoge.txt には Apple を含む行が見つかりませんでした。" 1>&2
  exit 1
fi

これについて対処法を4つメモしておきます。

対処法1: コロンコマンドを利用する (:コマンド)

コロンコマンド : は一つの built-in command で、何もせず常に 0 (成功) の終了ステータスを返す虚無的なコマンドです。

以下の例はスクリプトが中断されることはなく「Exit code: 1」が出力されます。

set -e

grep "unmatch pattern" hoge.txt && :
echo "Exit code: $?"

これは -e オプションにおける特殊な振る舞いを利用した方法です。

式の評価の流れ:

  • grep の終了ステータスが 0 (成功) だった場合、&& 演算子により右側も評価され : を実行。一連のコマンドの終了ステータスは 0 (成功)。
  • grep の終了ステータスが 1 (失敗) だった場合、&& 演算子によりそこで評価を終了。なので一連のコマンドの終了ステータスは 1 (失敗)。

更に set -e オプションには &&|| で連結されたコマンドリストの最後にある(一番右側の)コマンドが失敗だった場合のみスクリプトを中断するという特性があるため、そのままスクリプトを続行できます。$? にもちゃんと grep の終了ステータスが入っています。

そのためちょっと直感的ではないですが、以下のコマンドの出力は route1のみ となります。

set -e

false && false
echo "route1"

false
echo "route2"

対処法2: true コマンドを利用する

以下の例は「Exit code: 1」が出力されます。

set -e

grep "unmatch pattern" hoge.txt && true
echo "Exit code: $?"

これも対処法1と同じ理由です。true コマンドも : と同じく何もせず常に 0 (成功) を返すコマンドです。
実質的に対処法1と同じ方法と言えますが、こちらの方が他の人に意図は伝わりやすいかもしれません。

対処法3: 終了ステータスを取得せず if 文でそのまま判定する

set -e

# grep は検索結果が見つからなかった時に 1 (失敗) を返すコマンド
# --quiet は標準出力に何も書き出さないオプション
if ! cat hoge.txt | grep --quiet "Apple"; then
  echo "hoge.txt には Apple を含む行が見つかりませんでした。" 1>&2
  exit 1
fi

これは最も自然な解決方法だと思います。if 文の評価式として実行したコマンドに関しては失敗しても中断されないという特性があるため、スクリプトを続行できます。

対処法4: 一時的に set +e して -e オプションを解除する

以下の例は「Exit code: 1」が出力されます。

set +e
grep "unmatch pattern" hoge.txt
echo "Exit code: $?"
set -e

この方法が楽そうならこれで。最後に set -e で元に戻すのを忘れずに。

感想

対処法3のケースなど普段何気なく実現できていたことも、ちょっとした挙動の特性により実現出来ていたことが理解できました(^^)
個人的にはコロンコマンドを使用した方法がシンプルで好きですが、時と場合で使い分けたいと思います。

参考資料

編集履歴

  • 2018/11/22: 全体的に例や内容をブラッシュアップしました。

UbuntuにRedmine2.5をインストールする手順

Vagrant 上の Ubuntu 13.10 に Redmine をインストールしたので手順をメモしておきます。

redmine.org で紹介されているインストール方法を参考にしています。
RedmineInstall

導入バージョン

  • Ruby 1.9.3
  • Redmine 2.5 (Stable)
  • Rails 3.2
  • Apache 2.4.6
  • Passenger 4.0.46

更新可能な全パッケージを更新しておく

sudo apt-get update 
sudo apt-get upgrade

必要な関連パッケージをインストール

ImageMagick はガントチャートの表示やエクスポートで使用されます。

sudo apt-get install imagemagick libmagickwand-dev
sudo apt-get install subversion
sudo apt-get install git-core git
sudo apt-get install ruby1.9.3

MySQL もインストールされていなければしておきます。途中で root のパスワードを聞かれると思います。

sudo apt-get install mysql-server mysql-client

Redmine 用のデータベースとユーザの作成

MySQL にログインして作成します。

mysql -uroot -p

CREATE DATABASE redmine CHARACTER SET utf8;
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password';
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
FLUSH PRIVILEGES;

Redmine 本体のダウンロードと配置

今回は /var/www/redmine に展開します。

cd /var/www
wget http://www.redmine.org/releases/redmine-2.5.2.tar.gz
tar zxvf redmine-2.5.2.tar.gz
mv redmine-2.5.2 redmine
rm redmine-2.5.2.tar.gz

Redmine の動作に必要な関連パッケージをまとめてインストール

Bundler がインストールされていなければしておきます。

gem install bundler

Redmine を展開した先のアプリケーションルートディレクトリに Gemfile があるので、これを使って Bundler でまとめてインストールします。

cd /var/www/redmine
bundle install --without development test

色々インストールされていきます。

Fetching gem metadata from https://rubygems.org/.........
Fetching additional metadata from https://rubygems.org/..
Resolving dependencies...
Installing rake 10.1.1
Installing i18n 0.6.11
Installing multi_json 1.10.1
Installing activesupport 3.2.19
Installing builder 3.0.0
Installing activemodel 3.2.19
Installing erubis 2.7.0
Installing journey 1.0.4
Installing rack 1.4.5
Installing rack-cache 1.2
Installing rack-test 0.6.2
Installing hike 1.2.3
Installing tilt 1.4.1
Installing sprockets 2.2.2
Installing actionpack 3.2.19
Installing mime-types 1.25.1
Installing polyglot 0.3.5
Installing treetop 1.4.15
Installing mail 2.5.4
Installing actionmailer 3.2.19
Installing arel 3.0.3
Installing tzinfo 0.3.40
Installing activerecord 3.2.19
Installing activeresource 3.2.19
Installing awesome_nested_set 2.1.6
Using bundler 1.6.3
Installing coderay 1.1.0
Installing rack-ssl 1.3.4
Installing json 1.8.1
Installing rdoc 3.12.2
Installing thor 0.19.1
Installing railties 3.2.19
Installing jquery-rails 2.0.3
Installing mysql2 0.3.16
Installing net-ldap 0.3.1
Installing ruby-openid 2.3.0
Installing rack-openid 1.4.2
Installing rails 3.2.19
Installing redcarpet 2.3.0

データベースの接続先を設定

production の接続先設定を環境に合わせて設定します。

cp /var/www/redmine/config/database.yml.example /var/www/redmine/config/database.yml
vim /var/www/redmine/config/database.yml

セッションのシークレットトークンを生成

cd /var/www/redmine
rake generate_secret_token

初期テーブルを作成

テーブルを作成します。

cd /var/www/redmine
RAILS_ENV=production rake db:migrate

作成したテーブルに初期データをロードします。どの言語でデータをロードを聞かれると思います。

RAILS_ENV=production rake redmine:load_default_data

WebAP のファイルシステムのパーミッションを設定

chmod -R 777 files
chmod -R 777 log
chmod -R 777 tmp
chmod -R 777 public/plugin_assets

WEBrick で Redmine が正しくインストールされたか確認する

WeBrick を起動します。

ruby script/rails server webrick -e production

3000 ポートの URL にアクセスして Redmine が表示されることを確認します。

URLの例: http://localhost:3000/

ID は admin、パスワードも admin でログインできると思います。

Passenger をインストール

Rails を動作させるためのサーバの用意をしていきます。

gem install passenger

Passenger の Apache モジュールをインストール

次に Apache2 用の Passenger モジュールをインストールします。

passenger-install-apache2-module

上記コマンド実行後の最初の案内は enter で進みます。その次に「Which languages are you interested in?」ということを聞かれるのでそのまま enter で進みます。その後、インストールに必要なものが全てインストールされているかチェックされます。

Checking for required software...

  • Checking for C compiler... Found: yes Location: /usr/bin/cc
  • Checking for C++ compiler... Found: yes Location: /usr/bin/c++
  • Checking for Curl development headers with SSL support... Found: no Error: Cannot find the curl-config command.
  • Checking for OpenSSL development headers... Found: yes Location: /usr/include/openssl/ssl.h
  • Checking for Zlib development headers... Found: yes Location: /usr/include/zlib.h
  • Checking for Apache 2... Found: yes Location of httpd: /usr/sbin/apache2 Apache version: 2.4.6
  • Checking for Apache 2 development headers... Found: no
  • Checking for Rake (associated with /usr/bin/ruby1.9.1)... Found: yes Location: /usr/bin/ruby1.9.1 /usr/local/bin/rake
  • Checking for OpenSSL support for Ruby... Found: yes
  • Checking for RubyGems... Found: yes
  • Checking for Ruby development headers... Found: yes Location: /usr/include/ruby-1.9.1/ruby.h
  • Checking for rack... Found: yes
  • Checking for Apache Portable Runtime (APR) development headers... Found: no
  • Checking for Apache Portable Runtime Utility (APU) development headers... Found: no
Some required software is not installed. But don't worry, this installer will tell you how to install them. Press Enter to continue, or Ctrl-C to abort.

もし足りないものがあり「Some required software is not installed.」というようなことを言われたら案内に従って必要な物をインストールします。

環境によって違うと思いますが、今回は以下のパッケージが足りなかったのでインストールしました。

apt-get install libcurl4-openssl-dev
apt-get install apache2-threaded-dev
apt-get install libapr1-dev
apt-get install libaprutil1-dev

全て揃えたら再チャレンジします。

passenger-install-apache2-module

インストール成功後に表示される以下の部分をメモしておきます。後の Apache の設定で使用します。

Please edit your Apache configuration file, and add these lines:

LoadModule passenger_module /var/lib/gems/1.9.1/gems/passenger-4.0.46/buildout/apache2/mod_passenger.so
   
     PassengerRoot /var/lib/gems/1.9.1/gems/passenger-4.0.46
     PassengerDefaultRuby /usr/bin/ruby1.9.1
   

After you restart Apache, you are ready to deploy any number of web
applications on Apache, with a minimum amount of configuration!
Suppose you have a web application in /somewhere. Add a virtual host to your
Apache configuration file and set its DocumentRoot to /somewhere/public:


      ServerName www.yourhost.com
      # !!! Be sure to point DocumentRoot to 'public'!
      DocumentRoot /somewhere/public
      
         # This relaxes Apache security settings.
         AllowOverride all
         # MultiViews must be turned off.
         Options -MultiViews
         # Uncomment this if you're on Apache >= 2.4:
         #Require all granted
      
   

And that's it! You may also want to check the Users Guide for security and

Apache の設定をする

Passenger モジュールのロードを行う設定ファイルを追加します。

vim /etc/apache2/mods-available/passenger.load
LoadModule passenger_module /var/lib/gems/1.9.1/gems/passenger-4.0.46/buildout/apache2/mod_passenger.so

モジュールの設定を行う設定ファイルを追加します。

vim /etc/apache2/mods-available/passenger.conf

    PassengerRoot /var/lib/gems/1.9.1/gems/passenger-4.0.46
    PassengerDefaultRuby /usr/bin/ruby1.9.1

上記2つの設定ファイルを有効にします。

cd /etc/apache2/mods-enabled/
ln -s ../mods-available/passenger.conf passenger.conf
ln -s ../mods-available/passenger.load passenger.load

バーチャルホストの設定を行います。

vim /etc/apache2/sites-available/redmine.vagrant.conf

    ServerName redmine.vagrant
    DocumentRoot /var/www/html/redmine/public
    RailsBaseURI /redmine

バーチャルホストの設定を有効にします。

cd /etc/apache2/sites-enabled/
ln -s ../sites-available/redmine.vagrant.conf redmine.vagrant.conf

設定ファイルを読み込みます。

service apache2 graceful

ブラウザでアクセスして admin アカウントでログインできることを確認できれば完了です!
http://redmine.vagrant/

DBテーブルの差分を出力するMySQL::diffをインストールする

二つの MySQL データベースを比較し差分 ALTER SQL 文を出力してくれる perl 製ツール、MySQL::diffのインストール方法です。

このツールは、稼働中のデータベースのテーブルスキーマを最新に更新する場合など使えます。

Usage: mysqldiff [ options ] <database1> <database2>

今回はサーバデプロイ時のスキーマ更新作業を自動化するためにインストールしてみました。上手く使うと DDL のスマートなバージョン管理に一役買ってくれると思います。

コマンドラインツールなので GUI で分かりやすく差分を出力したい場合には不向きです。そういった場合はこのツールよりも MySQLWorkbench を使ったほうが便利でしょう。

MySQL::diff のインストール

MySQL::diff は mysqldiff – search.cpan.org で公開されています。

インストール先を /usr/local/mysqldiff にしました。

wget http://search.cpan.org/CPAN/authors/id/A/AS/ASPIERS/MySQL-Diff-0.43.tar.gz
tar xzvf MySQL-Diff-0.43.tar.gz
mv MySQL-Diff-0.43 /usr/local/mysqldiff

/usr/local/bin/mysqldiff にシンボリックリンクをはります。

ln -s /usr/local/mysqldiff/bin/mysqldiff /usr/local/bin/mysqldiff

これでインストール完了と言いたいところなのですが、このままだとパスが通っておらず以下のエラーが起こります。

Can't locate MySQL/Diff.pm in @INC (@INC contains: /usr/local/mysqldiff/bin /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux-thread-multi /usr/lib/perl5/site_perl/5.8.8 /usr/lib/perl5/site_perl /usr/lib64/perl5/vendor_perl/5.8.8/x86_64-linux-thread-multi /usr/lib/perl5/vendor_perl/5.8.8 /usr/lib/perl5/vendor_perl /usr/lib64/perl5/5.8.8/x86_64-linux-thread-multi /usr/lib/perl5/5.8.8 .) at /usr/local/bin/mysqldiff line 112.
BEGIN failed--compilation aborted at /usr/local/bin/mysqldiff line 112.

このエラーを修正するために、ソースコードの冒頭に use lib 文を一行追記します。

vi /usr/local/mysqldiff/bin/mysqldiff
#!/usr/bin/perl -w
use lib '/usr/local/mysqldiff/lib';

=head1 NAME

また、CentOS の場合では CPAN で File::Slurp をインストールする必要がありました。

cpan
cpan > install File::Slurp

mysqldiff コマンドを空打ちしてみて、usage が表示されれば無事にインストール完了です。