開発

Blog

開発

rsync で WordPress を本番へ送るスクリプトを作った(⁠差分を見せる・退避・確かめる)

WordPress のテーマや自作のプラグインを本番へ送るのに、rsync でスクリプトを作りました。送る前に差分を見せて確認を待ち、上書きするファイルを退避してから送り、送ったあとに差分がゼロか、公開ページが動いているかまで確かめます。この記事では、スクリプトの流れと工夫したところ、Mac とレンタルサーバー(お名前.com のレンタルサーバー RS)の組み合わせでつまずいたところをまとめます。

この記事でわかること
  • Git でコミット済みのものだけを、rsync で本番へ送る流れ
  • 本番だけで変わったファイルを、上書きする前に気づく方法
  • 送ったあとに、差分と公開ページを自動で確かめる方法
  • Mac の bash・rsync と、日本語の言語設定でつまずいたところ

作った理由

それまでは、本番へ送るたびに rsync のコマンドを手で組み立てて、上書きするファイルも手で退避していました。毎回同じことをしているのに、送る場所を間違えたり、退避を忘れたりしそうで、こわかったんです。

そこで、手でやっていたことをそのままスクリプトにしました。WordPress 本体やデータベースは送らず、送るのはテーマ・自作のプラグイン・共通の処理(mu-plugins)だけです。

スクリプトの流れ

コミット済みのものだけを出す

Git でコミット済みのもの(HEAD)だけを一時フォルダに出して、パーミッションをそろえます。

本番が前回送ったままか確かめる

本番だけで変わったファイルがあれば、上書きする前に知らせます。

送るファイル・消すファイルを見せる

一覧を見せて、確認を待ちます。

退避する

上書き・削除するファイルを、サーバーの中に tar.gz でまとめて退避します。

送る

共通の処理 → プラグイン → テーマ の順に送ります。

前回から消えたファイルを消す

Git で消したファイルだけを、本番からも消します。

確かめる

もう一度比べて差分がゼロか、公開ページが動いているかを確かめます。

使い方は3つだけです。

bin/deploy.sh --dry-run   # 差分を見せるだけ(送らない)
bin/deploy.sh             # 差分を見せて、確認してから送る
bin/deploy.sh --yes       # 確認せずに送る

案件ごとの値は、設定のファイルに分けています(値は例です)。スクリプトは同じものを、ほかの案件にもコピーして使います。

SITE=example                    # 退避ファイル・送った記録の名前
HOST=example-server             # ~/.ssh/config の Host
REMOTE=public_html/example.com  # 本番のサイトの場所(ホームから)
URL=https://example.com
BACKUP_DIR=backup

# 送るもの(wp-content から)。この順に送る
PATHS=(mu-plugins plugins/nari-blocks plugins/nari-form themes/example)

工夫したところ

コミット済みのものだけを送る

# 1. コミット済みのものを出す
mkdir -p "$T/new"
git archive HEAD "${PATHS[@]/#/$WP/}" | tar -x -C "$T/new"
find "$T/new" -type d -exec chmod 755 {} +
find "$T/new" -type f -exec chmod 644 {} +

作業中のフォルダから直接送ると、書きかけのファイルや、node_modules のような送らなくていいものまで送ってしまいます。git archive HEAD でコミット済みのものだけを一時フォルダに出して、そこから送っています。

もうひとつ理由があって、Mac に最初から入っている /usr/bin/rsync は openrsync という別の実装で、試したところ --exclude が効きませんでした。除外の指定に頼らず、送るものだけのフォルダを作るほうが確実です。

本番だけで変わったファイルに、上書きする前に気づく

送り終わったら、送ったコミットを本番のサーバーの ~/deploy-log/{SITE}.txt に記録しておきます。次に送るときは、まずその「前回送ったコミット」と本番を比べます。差分があれば、だれかが本番だけでファイルを直したということなので、上書きする前に知らせます。

if [ ${#drift[@]} -gt 0 ]; then
	echo
	echo "!! 本番だけで変わっている(または無くなっている)ファイルがあります。送ると上書きされます:"
	printf '   %s\n' "${drift[@]}"
	if [ "$MODE" = yes ]; then
		echo "!! --yes では止めます。中身を確かめてから、--yes を付けずに流してください" >&2
		exit 1
	fi
fi

--yes(確認なし)のときは、ここで止めます。本番だけの変更を、知らないうちに消してしまわないためです。

前回から消えたファイルだけを、本番から消す

delete=()
if [ -n "$LAST" ]; then
	while read -r f; do
		[ -n "$f" ] && delete+=("${f#$WP/}")
	done < <(comm -23 \
		<(git ls-tree -r --name-only "$LAST" -- "${PATHS[@]/#/$WP/}" | sort) \
		<(git ls-tree -r --name-only HEAD -- "${PATHS[@]/#/$WP/}" | sort))
fi

rsync の --delete を使うと、本番にだけあるファイルが全部消えます。本番には、Git で管理していないファイル(ビルドの道具など)が残っていることもあるので、--delete は使っていません。前回送ったコミットと今回のコミットのファイルの一覧を比べて、Git で消したファイルだけを消しています。

上書きする前に退避する

# 4. 退避(上書きするファイル・消すファイルのうち、本番にあるもの)
backup=$(printf '%s\n' ${send[@]+"${send[@]}"} ${delete[@]+"${delete[@]}"} | remote "cd '$RWP' && while read -r f; do [ -f \"\$f\" ] && echo \"\$f\"; done" || true)
if [ -n "$backup" ]; then
	file="$BACKUP_DIR/$SITE-deploy-$STAMP.tar.gz"
	echo "$backup" | remote "mkdir -p ~/$BACKUP_DIR && cd '$RWP' && tar -czf ~/$file -T -"
	echo "■ 退避:~/${file}($(echo "$backup" | wc -l | tr -d ' ') ファイル)"
fi

上書き・削除するファイルのうち、本番にあるものだけを、サーバーの中で tar.gz にまとめます。何かあっても、このファイルを展開すれば元に戻せます。

送ったあとに、差分と公開ページを確かめる

check() {
	local path=$1 expect=$2 sep='?'
	[[ "$path" == *\?* ]] && sep='&'
	local result
	result=$(curl -s -o /dev/null -w '%{http_code} %{redirect_url}' "$URL$path${sep}nc=$RANDOM$RANDOM")
	local code=${result%% *}
	if [[ "$code" =~ ^($expect)$ ]] && [[ "$result" != */author/* ]]; then
		echo "   OK  $path → $result"
	else
		echo "   NG  $path → ${result}(期待:${expect})"
		ng=1
	fi
}
check / 200
check /wp-json/wp/v2/users 401
check /wp-json/wp/v2/Users 401
check '/?author=1' '404|301|302'   # 404(NARI Base)か、トップへの転送(SiteGuard)。/author/ログイン名/ への転送は NG
check /xmlrpc.php '404|405'

送ったあとは、もう一度 rsync で比べて差分がゼロかを確かめ、公開ページのステータスコードを見ます。ユーザー一覧の REST API が 401 になっているかなど、セキュリティの設定が外れていないかもここで確かめます。

URL の後ろに ?nc= と乱数を付けているのは、サーバーの nginx のページキャッシュを避けるためです。付けないと、キャッシュされた古いページの結果を見てしまいます。

つまずいたところ

日本語の言語設定のターミナルで「SITE: unbound variable」

変数はちゃんと設定しているのに、日本語の言語設定のターミナルで流すと、SITE: unbound variable で止まりました。原因は、変数のすぐ後ろに全角のかっこを書いていたことです。

echo "■ $SITE($URL)に HEAD ..."

日本語の言語設定の bash は、全角文字の一部まで変数名として読んでしまうようで、$SITE ではない名前の変数として扱われていました。set -u(未定義の変数をエラーにする)を付けているので、そこで止まったわけです。変数を { } で囲めば直ります。

echo "■ ${SITE}(${URL})に HEAD ..."

Mac の bash 3.2 で、空の配列がエラーになる

Mac に最初から入っている bash は 3.2 と古く、set -u を付けていると、空の配列を "${arr[@]}" で展開しただけでエラーになります。送るファイルが0件のときなどに止まってしまうので、空でもエラーにならない書き方にしています。

printf '%s\n' ${send[@]+"${send[@]}"}

while read の中の ssh が、残りの一覧を吸い込む

ファイルの一覧を while read で1行ずつ読みながら、その中で ssh を使ってサーバーのファイルを読んでいたところ、一覧の途中から先が処理されていませんでした。ssh は標準入力を読むので、while read が読むはずだった残りの一覧まで、ssh が吸い込んでいたんです。ssh に何も読ませないように、標準入力を空にして直しました。

				# ssh は標準入力を読むので </dev/null を付ける(付けないと、このループで読んでいる残りの一覧まで吸い込む)
				if remote "cat '$RWP/$p/$f'" </dev/null 2>/dev/null | python3 -I -c '

流している最中にスクリプトが書き換わると、途中から新しい中身を読む

bash は、スクリプトを最初に全部読むのではなく、少しずつ読みながら動かします。なので、流している最中にスクリプトのファイルが書き換わると(ほかの案件からコピーし直したときなど)、途中から新しい中身を読んでしまいます。全体を { } で囲んで、最後まで読み込んでから動くようにしました。

# 全体を { } で囲み、最後まで読み込んでから動かす(bash はスクリプトを少しずつ読むので、
# 流している最中に sync-nari-plugins.sh などでファイルが書き換わると、途中から新しい中身を読んでしまうため)
{

サーバーへ接続するたびに、言語設定の警告が出る

Mac の ssh は、ターミナルの言語設定(LANG など)をサーバーへ送ります。お名前.com のレンタルサーバー RS にはその言語設定がなく、接続するたびに perl: warning: Setting locale failed が出ていました。ssh を呼ぶときだけ、言語設定の環境変数を外しています。

# サーバーへの接続
# - LogLevel=ERROR:接続のたびに出る警告を出さない
# - 言語設定の環境変数を外す:Mac の ssh はターミナルの言語設定(LANG=C.UTF-8 など)をサーバーへ送るが、
#   お名前.com RS にはその言語設定が無く、ログインのたびに「perl: warning: Setting locale failed」が出るため
RSH="env -u LANG -u LC_ALL -u LC_CTYPE -u LC_MESSAGES -u LC_COLLATE -u LC_NUMERIC -u LC_TIME -u LC_MONETARY ssh -o LogLevel=ERROR"
お名前.com のレンタルサーバー RS について

このサーバーには WP-CLI が入っていません。なので、データベースの操作が必要なとき(カスタムフィールドの設定を取り込むときなど)は、WordPress を読み込む PHP のスクリプトを ssh で流しています。このスクリプトは、ファイルを送るところまでを受け持っています。

おわりに

最初は「rsync を1行流すだけ」のつもりでしたが、安全に送ろうとすると、確かめることが意外と多くありました。今は差分を見て「y」を押すだけなので、本番へ送るのがこわくなくなりました。

つまずいたところは、どれも Mac とサーバーの組み合わせならではのものでした。同じ環境で困っている人の参考になればうれしいです。

お仕事のご相談

WordPress の開発・運用の仕組みづくりのような制作・改修のご相談も受け付けています。お気軽にどうぞ。

//サイト内を検索

制作実績・ブログ・お知らせから探します。キーワードはスペースで区切って複数入れられます。