48f103df0f60cfb6a8e58dbe2032d465dd79a55e
[autotest_mk.git] / template / Define.mk
1 # autotest.mk > test_template > Define.mk
2 # 自動テスト用の変数、マクロ定義
3
4 ifndef DEFINE_INCLUDED
5 DEFINE_INCLUDED = 1
6
7 # シェルコマンドをデバッグするときは、DEBUGSH変数を設定してmakeを実行する
8 # 例: DEBUGSH=1 make
9 ifdef DEBUGSH
10   SHELL := /bin/sh -x
11 endif
12
13 # 現在の日時
14 DATE = $(shell date +"%F %T")
15
16 # Makefile
17 MAKEFILE := Makefile
18
19 ######################################################################
20 # コマンド
21 ######################################################################
22
23 CAT := cat
24 CHMOD := chmod
25 CP := cp
26 DEV_NULL := /dev/null
27 DIFF := diff -c
28 ECHO := echo
29 EXPR := expr
30 FILE := file -b -e ascii
31 FIND := find
32 GREP := grep
33 LINECOUNT := wc -l
34 LN := ln -s
35 MKDIR := mkdir -p
36 MV := mv
37 PRINTF := printf
38 REALPATH := realpath
39 SED := sed
40 TEST := test
41 TIME := time
42 TR := tr
43 VALGRIND := valgrind
44 VALGRINDFLAG :=  -q --leak-check=full --show-leak-kinds=all --log-file=valgrind.log
45
46 ######################################################################
47 # テストグループとテストでの共通マクロ
48 ######################################################################
49
50 # chk_var_null: 引数がNULLの場合、エラー
51 # 用例: $(call chk_var_null,var)
52 define chk_var_null
53     $(if $1,,$(error NULL argument))
54 endef
55
56 # chk_file_ext: 指定されたファイルが実在する場合、エラー
57 # 用例: $(call chk_file_ext,file)
58 define chk_file_ext
59     $(if $(wildcard $1),$(error $1 exists in $(CURDIR)))
60 endef
61
62 # 指定したディレクトリーを作成
63 # 引数は、ディレクトリー名
64 # 用例: $(call create_dir,name)
65 define create_dir
66     $(call chk_var_null,$1)
67     $(call chk_file_ext,$1)
68     $(MKDIR) $1
69 endef
70
71 # ファイル1からファイル2への相対パス
72 # 引数は、ファイル名1、ファイル名2
73 # 用例: $(call rel_to,file1,file2)
74 define rel_to
75     $(strip $(shell $(REALPATH) --relative-to=$1 $2))
76 endef
77
78 # テストディレクトリーのMakefileを作成
79 # 引数は、Makefile名、依存ファイル群
80 # 用例: $(call create_makefile,file,list_include_file)
81 define create_makefile
82     $(RM) $1
83     $(foreach infile,$2,$(ECHO) "include ../$(infile)" >>$1; )
84     $(if $(filter $(SRC),c),$(call puts_cmd_c,$1))
85 endef
86
87 # C言語の関数をテストするための設定を、指定されたファイルに出力
88 # 引数は、ファイル名
89 # 用例: $(call puts_cmd_c,file)
90 define puts_cmd_c
91     $(ECHO) >>$1
92     $(ECHO) "CC := gcc" >>$1
93     $(ECHO) "CFLAGS := -Wall" >>$1
94     $(ECHO) >>$1
95     $(ECHO) ".INTERMEDIATE:" "$$""(CMD_FILE)" >>$1
96     $(ECHO) >>$1
97     $(ECHO) "CMDSRC_FILE := cmd.c" >>$1
98     $(ECHO) "TESTTARGET_FILES :=       # Set test target files" >>$1
99     $(ECHO) >>$1
100     $(ECHO) "$$""(CMD_FILE):" "$$""(CMDSRC_FILE)" "$$""(TESTTARGET_FILES)" >>$1
101     $(ECHO) "   ""$$""(CC)" "$$""(CFLAGS)" "-o" "$$""@" "$$""^" >>$1
102 endef
103
104 ######################################################################
105 # テストグループのディレクトリー
106 ######################################################################
107
108 # テストグループとテストの変数を定義したMakefile
109 DEFINE_FILE := Define.mk
110
111 # テストのターゲットを定義したMakefile
112 TEST_MAKEFILE := Test.mk
113
114 # テストグループのMakefileとしてコピーされるファイル
115 GROUP_MAKEFILE := Group.mk
116
117 # DEFINE_FILEの相対パス
118 DEFINE_FILE_REL = $(call rel_to,$(GROUPDIR),$(DEFINE_FILE))
119
120 # TEST_MAKEFILEの相対パス
121 TEST_MAKEFILE_REL = $(call rel_to,$(GROUPDIR),$(TEST_MAKEFILE))
122
123 # GROUP_MAKEFILEの相対パス
124 GROUP_MAKEFILE_REL = $(call rel_to,$(GROUPDIR),$(GROUP_MAKEFILE))
125
126 ######################################################################
127 # テストのディレクトリー
128 ######################################################################
129
130 # テストコマンドファイル
131 CMD_FILE := cmd
132
133 # テスト説明ファイル
134 DESC_FILE := desc.txt
135
136 # テスト想定ファイル
137 TEST0_FILE := 0.txt
138
139 # テスト結果ファイル
140 TEST1_FILE := 1.txt
141
142 # テストの、想定結果と結果の差分ファイル
143 DIFF_FILE := diff.log
144
145 # テストエラーファイル
146 ERR_FILE := err.log
147
148 # テストログファイル
149 LOG_FILE := summary.log
150
151 # 実行時間ファイル
152 TIME_FILE := time.log
153
154 # valgrindによるメモリーチェックファイル
155 VALGRIND_FILE := valgrind.log
156
157 # テスト詳細レポートファイル
158 DETAIL_FILE := detail.log
159
160 # テストの結果として作成されるファイル群
161 TEST_RES_FILES := $(TEST1_FILE) $(DIFF_FILE) $(ERR_FILE) $(LOG_FILE) $(DETAIL_FILE) $(TIME_FILE)
162
163 endif