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