DockerやPythonの実行にMakefileを使うと便利（Makefileの書き方）

リポジトリのセットアップや、docker composeを使った開発環境のローカル起動などに
シェルスクリプトを使う人は多いだろう。

ただ、以下のような悩みは無いだろうか？

Makefileはこの悩みを全て解消する。

Makefileとは

本来「C言語のコンパイルから実行までをコマンド一つで実行しよう」というものである。

しかし、特徴として「ショートカットコマンドを量産できる」ので
1つのコマンドが長くなりがちな
DockerコマンドやPython（仮想環境）の実行コマンドに相性が良い。

シェルスクリプトと比較したときのメリデメは以下の通りだ。

見て分かる通り、デメリットはほぼ無いに等しいのでMakefile推しである。

書き方や実行のルールが決まっているので、他の人も読みやすい（Makefileそのものがドキュメントとして機能する）
- 例： start.shとかstop.shなど複数ファイル用意することなく、全てMakefileファイルで完結
実行時に必要なファイルをチェックしてくれるので、バリデーション処理を自前で書かなくて良い
- 例：実行前に.envファイルの存在チェックをしたい
コマンド間の依存関係を定義することができる
- 例：「ビルドしてから実行する」

コマンド名: 実行に必要なファイル
	実際に実行するコマンド

ポイントは３つ

Makefile

hello:
	echo "hello"

実行結果

$ make hello
echo "hello"
hello

シンプルなショートカットコマンドの定義だけであれば、上記の説明で困ることはない。
ここからは少し複雑なコマンドを定義したいときに必要なことを解説する。

Makefile

hello1:
	echo "hello1"
hello2:
	echo "hello2"

実行結果

# 「make コマンド１ コマンド2 ...」というふうに続けて実行可能
$ make hello1 hello2
echo "hello1"
hello1
echo "hello2"
hello2

連続して実行することができるので、定義するコマンドは最小単位にしておくとスマート。

Makefile

build: Dockerfile test.txt
	docker build -t python-sample:1.0 .

ディレクトリにDockerfileは存在するが、test.txtは存在しない場合、以下のようにエラーが発生する。

$ make build
make: *** No rule to make target `test.txt', needed by `build'.  Stop.

定義するときは「変数名 = 値」
利用するときは「$(変数名)」で使うことができる。

Makefile

MESSAGE = "hello, world."

hello:
	echo $(MESSAGE)

実行結果

$ make hello
echo "hello, world."
hello, world.

先述した基本コマンドの「必要なファイル」という部分は
実はファイルに限らず、他のmakeコマンドも定義することができる。

これにより、「コマンドAを実行するためにはコマンドBを実行しておく必要がある。だからコマンドB実行→コマンドA実行という流れで実行しよう。」という定義を行うことができる。

Makefile

# 実行するためには、ビルドの手順が必要だと定義する
run: build
	echo "実行します"

build:
	echo "ビルドします"

実行結果

# 実行用のrunコマンドを実行する
$ make run
echo "ビルドします"
ビルドします
echo "実行します"
実行します

run前にはbuildが必要なため、buildを自動で実行し、その後にrunを実行するようになる。