zip によるプロジェクトバックアップの作成・検証・復元
ZIP バックアップに現在のプロジェクトを反映するには、実行のたびに新しいアーカイブを作成します。既存のアーカイブに対して zip -r を実行すると、エントリーが追加・更新されますが、元のファイルから削除したものが残ることがあります。この動作は Info-ZIP マニュアルに記載されています。以下の Bash スクリプトでは、新しいアーカイブを作成して検証し、その後にだけ以前のバックアップを置き換えます。
この手順は、Bash、Info-ZIP Zip 3.0、UnZip 6.0、GNU coreutils、findutils、diffutils を備えた Linux を対象としています。Info-ZIP のバージョンは zip -v と unzip -v で確認してください。スクリプトは GNU mv -T を使用するため、macOS では修正が必要です。Make の使用は任意です。
アーカイブを作成する前に、ビルドなど、プロジェクトに書き込むプロセスを停止してください。この結果は、実行中に変更されないディレクトリーを表すものであり、zip はファイルシステムのスナップショットを取得しません。名前に制御文字を含まない通常のファイル、ディレクトリー、シンボリックリンクを使用してください。
小さなプロジェクトの準備
次のブロックを Bash で実行してください。使い捨てのプロジェクトを作成し、既存の zip-demo ディレクトリーの再利用は拒否します。括弧で囲んでいるため、シェルの作業ディレクトリーは元のままです。
(
set -euo pipefail
mkdir zip-demo
cd zip-demo
mkdir -p project_directory/src project_directory/node_modules project_directory/dist
printf 'version one\n' > project_directory/src/app.txt
printf 'project notes\n' > 'project_directory/read me.txt'
printf 'dependency\n' > project_directory/node_modules/omit.txt
printf 'generated\n' > project_directory/dist/omit.txt
)
実行のたびに新しいアーカイブを作成
このスクリプトを zip-demo/backup.sh として保存してください。作業ディレクトリーからの相対パスで project_directory をアーカイブします。スクリプト、一時アーカイブ、最終アーカイブは、ソースツリーの外側で、プロジェクトと同じ階層に置いてください。
#!/usr/bin/env bash
set -euo pipefail
umask 077
unset ZIPOPT UNZIP UNZIPOPT
source_dir=project_directory
backup_date=$(date +%Y-%m-%d)
archive_name="project_backup_$backup_date.zip"
if [[ ! -d "$source_dir" || -L "$source_dir" ]]; then
printf 'Source must be a real directory: %s\n' "$source_dir" >&2
exit 1
fi
if [[ -L "$archive_name" || ( -e "$archive_name" && ! -f "$archive_name" ) ]]; then
printf 'Destination must be a regular file or absent: %s\n' "$archive_name" >&2
exit 1
fi
find "$source_dir" -type d -print > /dev/null
work_dir=$(mktemp -d './.zip-backup.XXXXXXXX')
trap 'rm -rf -- "$work_dir"' EXIT
trap 'exit 130' INT
trap 'exit 143' TERM
zip -q -6 -r -MM -y "$work_dir/archive.zip" "$source_dir" \
-x '*/.git' '*/.git/*' \
'*/node_modules' '*/node_modules/*' \
'*/dist' '*/dist/*' \
'*.tmp' '*.tmp/*' '*.temp' '*.temp/*' \
'*/.DS_Store' '*/.DS_Store/*'
unzip -tq "$work_dir/archive.zip"
mv -fT -- "$work_dir/archive.zip" "$archive_name"
printf 'Backup created: %s\n' "$archive_name"
zip-demo を作成したディレクトリーから実行します。
(cd zip-demo && bash backup.sh)
成功すると、最後の行にマシンのローカル日付を使った project_backup_YYYY-MM-DD.zip の名前が表示されます。同じ日に再実行して成功すると、確認なしでそのファイルを置き換えます。追加したファイルは含まれ、変更したファイルは再読み込みされ、削除したファイルは除かれます。変更前後でファイルサイズと更新日時が変わらない場合も同様です。入力が変わらなければ復元後の内容は同じですが、アーカイブのバイト列の一致は保証しません。
出力先を置き換えるのは、圧縮と検証の両方に成功した後だけです。ソースが存在しない場合、ファイルを読み取れない場合、検証に失敗した場合は、成功メッセージを表示せずにゼロ以外の終了ステータスを返し、以前のバックアップを残します。出力先がディレクトリーまたはシンボリックリンクの場合は拒否します。管理下にあるディレクトリーで、バックアップは一度に一つずつ実行してください。
最初の find は、除外対象のディレクトリーも含め、ソースツリー全体を走査できることを確認します。これは、zip が -MM を指定していても、読み取れないディレクトリーを通知なしにスキップすることがあるため重要です。各オプションの役割は異なります。-r はディレクトリーを走査し、-MM は入力ファイルが存在しない場合や読み取れない場合を致命的エラーとし、-y はリンク先ではなくシンボリックリンク自体を保存します。除外パターンを引用符で囲むことで、照合を zip に任せます。これらは Info-ZIP のオプションです。スクリプトは継承した ZIP/UnZip のオプションをクリアし、シェルのデフォルト設定によって動作が知らないうちに変わることを防ぎます。GNU mv -fT は、出力先を移動先ディレクトリーではなくファイルパスとして扱い、そのファイルを置き換えます。
除外対象の選択
この例では、どの階層にあっても .git、node_modules、dist を除外します。また、名前が .tmp または
.temp で終わるものと、.DS_Store も除外します。これらの名前を持つディレクトリーとその内容も照合対象です。たとえば、*/node_modules/* は project_directory/node_modules/omit.txt と、ネストしたパッケージの依存関係の両方に一致します。
これらの除外設定は、依存関係とビルド出力を再作成できるソースの引き渡しに適しています。復元に必要なファイルであれば、除外設定から外してください。それ以外のドットファイルは含まれるため、共有前にアーカイブを確認してください。このリストは機密情報を検出するものではありません。リストを変更した場合は、後述の比較用の除外設定も変更してください。
Make から同じスクリプトを実行
必要に応じて、次の内容を zip-demo/Makefile として保存し、bash の前にタブを入れてください。親ディレクトリーから make -C zip-demo archive を実行します。phony ターゲットは毎回実行され、スクリプトが失敗すると Make はターゲットの失敗として報告します。
.PHONY: archive
archive:
bash backup.sh
ファイルの復元と比較
バックアップと同じ日に、zip-demo の親ディレクトリーから次のブロックを実行してください。以前のバックアップの場合は、日付の式を実際のファイル名に置き換えてください。信頼できるアーカイブだけを復元してください。
(
set -euo pipefail
cd zip-demo
unset UNZIP UNZIPOPT ZIPINFO ZIPINFOOPT
archive_name="project_backup_$(date +%Y-%m-%d).zip"
unzip -tq "$archive_name"
unzip -Z1 "$archive_name"
mkdir restored
unzip -q "$archive_name" -d restored
diff -r --no-dereference \
-x .git -x node_modules -x dist -x '*.tmp' -x '*.temp' -x .DS_Store \
project_directory restored/project_directory
)
メンバー一覧には、src/app.txt と read me.txt が
project_directory/ の下に表示され、依存関係と生成ファイルは含まれないはずです。復元後のツリーでも、この最上位ディレクトリーは維持されます。diff は、対象ファイルの内容、ディレクトリー構造、シンボリックリンクのリンク先が一致すると、何も出力せずにゼロで終了します。所有者、アクセス権、タイムスタンプは比較しません。
mkdir restored は、出力先がすでに存在する場合、展開処理がそこに触れる前に意図的に失敗します。再度復元するには、展開コマンドと比較コマンドの両方で新しいディレクトリー名を指定してください。展開が途中で失敗した場合は、部分的に展開されたディレクトリーを別に残し、新しいディレクトリーに再試行してください。
UnZip マニュアルによると、-t はエントリーを展開し、保存された CRC を検証します。これによりデータの破損は検出できますが、正しいファイルを含めたことの証明にはなりません。バックアップ後にソースが変更されていなければ、別途行う復元と比較でその点を確認できます。
圧縮レベルの選択
レベルを比較するには、スクリプトの -6 を変更してください。
| オプション | 目的 |
|---|---|
-0 | 圧縮せずにファイルを格納 |
-1 | 圧縮速度を優先 |
-6 | Info-ZIP のデフォルト圧縮レベルを使用 |
-9 | より小さく圧縮するために時間をかける |
圧縮レベルのオプションは、圧縮にかける処理量を制御します。一定の削減率が得られるわけではなく、レベルを上げてもアーカイブが大幅に小さくなるとは限りません。実際のプロジェクトで経過時間とアーカイブサイズを比較し、それぞれの候補を復元してください。このスクリプトは同じ日の出力を置き換えるため、候補を残すには個別に保存してください。
必要に応じた別工程での暗号化
このアーカイブは暗号化されていません。Info-ZIP の zip -e は脆弱な従来の ZIP 暗号化を使用し、Info-ZIP FAQでもその制限について警告しています。機密性の高いデータには、受信者の鍵とパスフレーズに対応する
age など、別の暗号化ワークフローを選んでください。そのワークフローに頼る前に、受信者が復号して復元できることを確認してください。また、暗号化しても、元の暗号化されていない ZIP は、そのコピーを別途管理しない限りディスク上に残ります。
失敗への対処と制限
実行が失敗した場合は、診断メッセージと終了ステータスを確認してください。出力先に以前の ZIP があっても、今日の試行が成功した証拠にはなりません。以前のアーカイブと新しいアーカイブを同時に保持できるだけの空き容量を確保してください。通常の失敗では終了時のトラップが一時ディレクトリーを削除しますが、強制終了や電源断では残ることがあります。
この例は、Linux 上でプロジェクトのファイル内容とパスを検証します。ACL、拡張属性、特殊ファイル、ハードリンクの関係まで扱う、完全なシステムバックアップ形式を確立するものではありません。大きなアーカイブでは、受信者の展開ツールに Zip64 対応が必要になることがあります。保持要件に応じて過去に成功したバックアップを残し、実際に使用するツールで復元をテストしてください。
