ソースコードの推敲
[YACASL2.git] / test / Template / Test.mk
1 # autotest.mk > test_template > Test.mk
2 # 自動テスト用のMakefile
3 #
4 # 要: Define.mk
5 #
6 # オペレーター
7 # make         : CMDの標準出力をTEST1_FILEに保存したあと、TEST0_FILEとの差分を比較し、結果をLOG_FILEに出力
8 # make check   : ↓
9 # make set     : CMDの標準出力をTEST0_FILEに保存。TEST0_FILEが存在する場合は実行しない
10 # make reset   : CMDの標準出力をTEST0_FILEに保存。TEST0_FILEが存在する場合は上書き
11 # make time    : CMDの実行にかかった時間をTIME_FILEに保存し、出力
12 # make time-clean: "make time" で作成されたファイルをクリア
13 # make valgrind: valgrind CMDの標準出力をVARGRIND_FILEに保存
14 # make clean   : "make" で作成されたファイルをクリア
15 # make all-clean: "make" と "make set" で作成されたファイルをクリア
16
17 ######################################################################
18 # マクロ
19 ######################################################################
20 # 指定されたファイルをチェックし、空の場合は削除
21 # 引数は、対象ファイル
22 # 用例: $(call rm_null,file_target)
23 define rm_null
24     if test ! -s $1; then $(RM) $1; fi
25 endef
26
27 # 説明ファイルの内容を、指定されたファイルに出力
28 # 引数は、出力ファイル
29 # 用例: $(call desc_log,file_out)
30 define desc_log
31     if test -s $(DESC_FILE); then $(CAT) $(DESC_FILE) >>$1; fi
32 endef
33
34 # テスト実行の経過時間を、指定されたファイルに出力して表示
35 # 引数は、テスト名、コマンドファイル、出力ファイル
36 # 用例: $(call time_cmd,file_cmd,file_out)
37 define time_cmd
38     if test ! -x $1; then $(CHMOD) u+x $1; fi
39     ($(TIME) ./$1 1>$(DEV_NULL) 2>$(DEV_NULL)) 2>&1 | $(GREP) '^real' >$2
40 endef
41
42 # valgrindによるメモリーチェック結果を、指定されたファイルに出力して表示
43 # 引数は、テスト名、コマンドファイル、出力ファイル
44 # 用例: $(call valgrind_cmd,file_cmd,file_out)
45 define valgrind_cmd
46     -$(VALGRIND) $(VALGRINDFLAG) $(strip $(shell tail -1 $(CMD_FILE))) 1>/dev/null 2>&1
47 endef
48
49 # テスト実行コマンド。
50 # コマンドファイルを実行し、標準出力を指定されたファイルに保存。
51 # エラー発生時は、エラー出力を出力ファイルとエラーファイルに保存。
52 # 引数は、コマンドファイル、出力ファイル、エラーファイル
53 # 用例: $(call exec_cmd,file_cmd,file_out,file_err)
54 define exec_cmd
55     if test ! -x $1; then $(CHMOD) u+x $1; fi
56     ./$1 >>$2 2>$3
57     if test -s $3; then $(CAT) $3 >>$2; fi
58     $(MV) $2 $2.tmp && $(SED) -e "s%$(CURDIR)%\$$PWD%g" $2.tmp >$2 && $(RM) $2.tmp
59     $(call rm_null,$3)
60 endef
61
62 # 2つのファイルを比較し、差分ファイルを作成
63 # 引数は、2ファイルのリスト、差分ファイル
64 # 用例: $(call diff_files,files,file_out)
65 define diff_files
66     $(DIFF) $1 >$2 2>&1
67     $(call rm_null,$2)
68 endef
69
70 # 差分ファイルの内容をログファイルに出力
71 # 引数は、テスト名、差分ファイル、ログファイル
72 # 用例: $(call test_log,name,file_diff,file_log)
73 define test_log
74     $(call desc_log,$3)
75     if test ! -s $2; then RES=Success; else RES=Failure; fi; $(ECHO) "$1: Test $$RES $(DATE)" >>$3
76     $(ECHO) "Details in $(CURDIR)/$(DETAIL_FILE)" >>$3
77 endef
78
79 # NODISPが設定されていない時は、ログファイルを表示
80 # 引数は、ログファイル
81 # 用例: $(call disp_test_log,file_log)
82 define disp_test_log
83     $(if $(NODISP),,$(CAT) $1)
84 endef
85
86 # ファイル群から、ファイル名とファイルの内容を指定されたファイルに出力
87 # 引数は、対象ファイル群、出力ファイル
88 # 用例: $(call report_files,list_file_target,file_out)
89 define report_files
90     $(foreach tfile,$1,$(call report_file,$(tfile),$2))
91 endef
92
93 # ファイル名とファイルの内容を指定されたファイルに出力
94 # 引数は、対象ファイル、出力ファイル
95 # 用例: $(call report_file,file_target,file_out)
96 define report_file
97     $(call chk_var_null,$1)
98     if test -s $1; then $(ECHO) "== $1 ==" >>$2; $(call echo_hr,$2); cat $1 >>$2; $(call echo_hr,$2); $(ECHO) >>$2; fi
99 endef
100
101 define echo_hr
102     $(ECHO) "----------------------------------------------------------------------" >>$1
103 endef
104
105 # テスト名。カレントディレクトリー名から取得
106 TEST = $(notdir $(CURDIR))
107
108 # コマンドファイルのソース
109 CMDSRC_FILE ?= $(CMD_FILE)
110
111 .PHONY: check set reset clean all-clean time time-clean valgrind valgrind-clean
112
113 check: clean $(DETAIL_FILE)
114         @$(call disp_test_log,$(LOG_FILE))
115
116 checkall: clean $(DETAIL_FILE) $(TIME_FILE)
117         @$(CAT) $(TIME_FILE) >>$(LOG_FILE)
118         @$(call disp_test_log,$(LOG_FILE))
119
120 set: $(CMD_FILE)
121         @$(call chk_file_ext,$(TEST0_FILE))
122         @-$(call exec_cmd,$(CMD_FILE),$(TEST0_FILE),$(ERR_FILE))
123         @$(CAT) $(TEST0_FILE)
124
125 reset: all-clean $(CMD_FILE)
126         @-$(call exec_cmd,$(CMD_FILE),$(TEST0_FILE),$(ERR_FILE))
127         @$(CAT) $(TEST0_FILE)
128
129 clean:
130         @$(RM) $(TEST_RES_FILES) $(TIME_FILE) $(VALGRIND_FILE) core
131
132 all-clean: clean
133         @$(RM) $(TEST0_FILE)
134
135 time: time-clean $(TIME_FILE)
136         @$(CAT) $(TIME_FILE)
137
138 time-clean:
139         @$(RM) $(TIME_FILE)
140
141 valgrind: valgrind-clean $(VALGRIND_FILE)
142         if test -s $(VALGRIND_FILE); then $(ECHO) $(CURDIR) && $(CAT) $(VALGRIND_FILE); else $(RM) $(VALGRIND_FILE); fi
143
144 valgrind-clean:
145         @$(RM) $(VALGRIND_FILE)
146
147 $(TEST1_FILE): $(CMD_FILE)
148         @-$(call exec_cmd,$^,$@,$(ERR_FILE))
149
150 $(DIFF_FILE): $(TEST0_FILE) $(TEST1_FILE)
151         @-$(call diff_files,$^,$@)
152
153 $(LOG_FILE): $(DIFF_FILE)
154         @$(call test_log,$(TEST),$^,$@)
155
156 $(DETAIL_FILE): $(LOG_FILE)
157         @$(call report_files,$(LOG_FILE) $(CMDSRC_FILE) $(TEST0_FILE) $(ERR_FILE) $(DIFF_FILE) $(TEST1_FILE),$@)
158
159 $(TIME_FILE): $(CMD_FILE)
160         @$(call time_cmd,$^,$@)
161
162 $(VALGRIND_FILE): $(CMD_FILE)
163         $(call valgrind_cmd,$^,$@)