# autotest.mk > template > Group.mk
# テストグループのMakefile
#
# オペレーター
# make          : すべてのテストを実行し、結果をログファイルに出力
# make check    : ↓
# make checkall : すべてのテストを実行し、結果と実行時間をログファイルに出力
# make time     : すべてのテストを実行し、実行時間をログファイルに出力
# make create   : TESTNAMEで指定されたテストを新規に作成
# make clean    : すべてのテストで、"make" で生成されたファイルをクリア
# make time-clean: すべてのテストで、実行時間のログファイルをクリア
# make valgrind: すべてのテストで、valgrindによるメモリリークチェックを実行する
# make valgrind-clean: すべてのテストで、valgrindのログファイルをクリア

include Define.mk

verbose ?= 1

######################################################################
# テストグループのディレクトリー
######################################################################

# グループディレクトリー
GROUP_DIR := $(CURDIR)

# グループ名。ディレクトリ名から取得
GROUP := $(notdir $(GROUP_DIR))

# テスト名。カレントディレクトリー内の、名前が大文字または.以外で始まるディレクトリー
TESTS := $(notdir $(shell $(FIND) . -maxdepth 1 -name "[^A-Z.]*" -type d))

# テストグループログファイル
GROUP_LOG_FILE := $(shell $(ECHO) $(GROUP) | $(TR) '[a-z]' '[A-Z]').log

# テストグループレポートファイル
GROUP_REPORT_FILE := Summary.log

# テストグループ実行時間ファイル
GROUP_TIME_FILE := $(shell echo $(GROUP) | $(TR) '[a-z]' '[A-Z]')_time.log

# テストグループvalgrindファイル
GROUP_VALGRIND_FILE := $(shell echo $(GROUP) | $(TR) '[a-z]' '[A-Z]')_valgrind.log

# グループで、テスト結果として作成されるファイル群
GROUP_RES_FILES := $(GROUP_LOG_FILE) $(GROUP_REPORT_FILE) $(GROUP_TIME_FILE) $(GROUP_VALGRIND_FILE)

# テストごとのログファイル
TEST_LOG_FILES := $(foreach test,$(TESTS),$(test)/$(LOG_FILE))

######################################################################
# テストグループのマクロ
######################################################################

# テストごとのファイルをグループファイルに出力
# 引数は、テストのリスト、グループファイル、テストファイル
# 用例: $(call group_log,files_test_log,file_group_log)
define group_log
    $(if $(filter 1,$(verbose)),$(ECHO) '$(CURDIR) - $(words $1) tests')
    $(foreach target,$1,$(call group_log_each,$(target),$2))
endef

# テストのログファイルをグループログファイルに出力。引数は、テスト、グループログファイル
# 用例: $(call group_log_each,file_test_log,file_group_log)
define group_log_each
    $(ECHO) $(dir $1) >>$2;
    if $(TEST) -s $1; then $(CAT) $1 >>$2; else $(ECHO) $(dir $1)": no log" >>$2; fi
    $(ECHO) >>$2;
endef

# 成功したテストの数。テストグループログファイルから取得
SUCCESS_TEST = $(shell $(GREP) "^[^A-Z.].*: Test Success" $(GROUP_LOG_FILE) | $(LINECOUNT))

# 失敗したテストの数。テストグループログファイルから取得
FAIL_TEST = $(shell $(GREP) "^[^A-Z.].*: Test Failure" $(GROUP_LOG_FILE) | $(LINECOUNT))

# すべてのテストの数
ALL_TEST = $(shell $(EXPR) $(SUCCESS_TEST) + $(FAIL_TEST))

# テストごとの実行時間ファイル
TEST_TIME_FILES := $(foreach test,$(TESTS),$(test)/$(TIME_FILE))

# テストごとのvalgrindファイル
TEST_VALGRIND_FILES := $(foreach test,$(TESTS),$(test)/$(VALGRIND_FILE))

# テストの結果を、グループログファイルを元にレポート。
# 引数は、グループ名、グループログファイル、グループレポートファイル
# 用例: $(call group_report,name,file_log,file_report)
define group_report
    $(ECHO) '$1: $(SUCCESS_TEST) / $(ALL_TEST) tests passed. Details in $(GROUP_DIR)/$2' >$3
    if $(TEST) $(FAIL_TEST) -eq 0; then $(ECHO) "$1: All tests are succeded." >>$3; fi
endef

# リストで指定したディレクトリーでmakeを実行
# 用例: $(call make_targets,list_dir,target)
define make_targets
    $(if $(filter 1,$(verbose)),$(ECHO) '$(CURDIR) - $2';)
    $(foreach dir,$1,$(call make_target_each,$(dir),$2))
endef

# 指定したディレクトリーでmakeを実行
# 用例: $(call make_target_each,tests,target)
define make_target_each
    $(MAKE) $2 -sC $1;
endef

.PHONY: check checkall time valgrind create clean time-clean valgrind-clean

check checkall: clean $(GROUP_REPORT_FILE)
	@$(CAT) $(GROUP_REPORT_FILE)
	@(if $(TEST) $(FAIL_TEST) -gt 0; then $(GREP) 'Failure' $(GROUP_LOG_FILE); fi)
	@exit $(FAIL_TEST)

time: time-clean $(GROUP_TIME_FILE)
	@$(CAT) $(GROUP_TIME_FILE)

create:
	@$(call create_dir,$(TEST))
	@$(call create_makefile,$(TEST)/$(MAKEFILE),$(MAKEFILES))

clean:
	@$(call make_targets,$(TESTS),$@)
	@$(RM) $(GROUP_RES_FILES);

time-clean:
	@$(call make_targets,$(TESTS),$@)
	@$(RM) $(GROUP_TIME_FILE);

valgrind:
	@$(call make_targets,$(TESTS),$@)
	@$(RM) $(GROUP_RES_FILES);

valgrind-clean:
	@$(call make_targets,$(TESTS),$@)
	@$(RM) $(GROUP_VALGRIND_FILE);

$(GROUP_REPORT_FILE): $(GROUP_LOG_FILE)
	@$(call group_report,$(GROUP),$^,$@)

$(GROUP_LOG_FILE): $(TEST_LOG_FILES)
	@$(call group_log,$^,$@)

$(TEST_LOG_FILES):
	@$(MAKE) $(MAKECMDGOALS) -sC $(dir $@) NODISP=1

$(GROUP_TIME_FILE): $(TEST_TIME_FILES)
	@$(call group_log,$^,$@)

$(TEST_TIME_FILES):
	@$(MAKE) time -sC $(dir $@)

$(GROUP_VALGRIND_FILE): $(TEST_VALGRIND_FILES)
	@$(call group_log,$^,$@)

$(TEST_VALGRIND_FILES):
	@$(MAKE) time -sC $(dir $@)