selftest/unittest/Define.mk

   1 ######################################################################
   2 # テストグループのディレクトリー
   3 ######################################################################
   4 # テストグループとテストの両方で使う変数を定義したファイル
   5 DEF_FILE := Define.mk
   6
   7 # テストのMakefileにインクルードするファイル
   8 TEST_MAKEFILE := Test.mk
   9
  10 ######################################################################
  11 # テストのディレクトリー
  12 ######################################################################
  13 # Makefile
  14 MAKEFILE := Makefile
  15
  16 # 現在の日時
  17 DATE = $(shell date +"%F %T")
  18
  19 # テストコマンドファイル
  20 CMD_FILE := cmd
  21
  22 # テスト説明ファイル
  23 DESC_FILE := desc.txt
  24
  25 # テスト想定結果ファイル
  26 TEST0_FILE := 0.txt
  27
  28 # テスト結果ファイル
  29 TEST1_FILE := 1.txt
  30
  31 # テストの、想定結果と結果の差分ファイル
  32 DIFF_FILE := diff.txt
  33
  34 # テストエラーファイル
  35 ERR_FILE := err.txt
  36
  37 # テストログファイル
  38 LOG_FILE := test.log
  39
  40 # 実行時間ファイル
  41 TIME_FILE := time.log
  42
  43 ######################################################################
  44 # コマンド
  45 ######################################################################
  46
  47 CP := cp
  48
  49 CAT := cat
  50
  51 MKDIR := mkdir
  52
  53 RM := rm -f
  54
  55 ECHO := echo
  56
  57 TIME := /usr/bin/time
  58
  59 DIFF := diff -c
  60
  61 DEV_NULL := /dev/null
  62
  63 CHMOD := chmod
  64
  65 ######################################################################
  66 # エラー
  67 ######################################################################
  68
  69 # chk_var_null: 変数がNULLの場合、エラー
  70 # 用例: $(call chk_var_null,var)
  71 define chk_var_null
  72     $(if $1,,$(error NULL argument))
  73 endef
  74
  75 # chk_file_ext: 変数で指定されたファイルが実在する場合、エラー
  76 # 用例: $(call chk_file_ext,var)
  77 define chk_file_ext
  78     $(if $(wildcard $1),$(error $(wildcard $1) exists))
  79 endef
  80
  81 ######################################################################
  82 # マクロ
  83 ######################################################################
  84
  85 # 指定したディレクトリーを作成
  86 # 用例: $(call create_testdir,name)
  87 define create_testdir
  88     $(call chk_var_null,$1)
  89     $(call chk_file_ext,$1)
  90     $(MKDIR) $1
  91 endef
  92
  93 # TESTディレクトリーのMakefileを作成
  94 # 用例: $(call create_testmakefile,file)
  95 define create_testmkfile
  96     $(RM) $1
  97     $(foreach mkfile,$(DEF_FILE) $(TEST_MAKEFILE),$(ECHO) "include ../$(mkfile)" >>$1; )
  98 endef
  99
 100 # リストで指定したディレクトリーでMakeを実行
 101 # 用例: $(call make_tests,list_dir,target)
 102 define make_tests
 103     $(foreach dir,$1,$(call make_test_each,$(dir),$2))
 104 endef
 105
 106 # 指定したディレクトリーでMakeを実行
 107 # 用例: $(call make_test_each,tests,target)
 108 define make_test_each
 109     $(MAKE) $2 -sC $1;
 110
 111 endef
 112
 113 # 引数のファイルをチェックし、内容がない場合は削除
 114 # 用例: $(call rm_null,file)
 115 define rm_null
 116     if test ! -s $1; then $(RM) $1; fi
 117 endef
 118
 119 # 説明ファイルの内容を、引数のファイルに出力。
 120 # 用例: $(call desc_log,file_out)
 121 define desc_log
 122     if test -s $(DESC_FILE); then $(CAT) $(DESC_FILE) >>$1; fi
 123 endef
 124
 125 # テスト実行の経過時間を、ファイルに出力して表示。
 126 # 引数は、テスト名、コマンドファイル、出力ファイル
 127 # 用例: $(call time_cmd,name,file_cmd,file_out)
 128 define time_cmd
 129     $(TIME) -f"$1: %E" -o $3 ./$2 >$(DEV_NULL)
 130 endef
 131
 132 # テスト実行コマンド。引数は、コマンドファイル、出力ファイル、エラーファイル
 133 # ファイルの内容と、CMD_FILE実行の標準出力を、出力ファイルに保存。
 134 # エラー発生時は、エラー出力を出力ファイルとエラーファイルに保存。
 135 # 用例: $(call exec_cmd,file_cmd,file_out,file_err)
 136 define exec_cmd
 137     $(CHMOD) u+x $1
 138     $(CAT) $1 >$2
 139     ./$1 >>$2 2>$3
 140     if test -s $3; then $(CAT) $3 >>$2; fi
 141     $(call rm_null,$3)
 142 endef
 143
 144 # 2つのファイルを比較し、差分ファイルを作成。
 145 # 引数は、ファイルのリスト（セパレーターは空白）、差分ファイル
 146 # 用例: $(call diff_files,files,file_out)
 147 define diff_files
 148     $(DIFF) $1 >$2 2>&1
 149     $(call rm_null,$2)
 150 endef
 151
 152 # 差分ファイルの内容をログファイルに出力。
 153 # 引数は、テスト名、差分ファイル、ログファイル
 154 # 用例: $(call test_log,name,file_diff,file_log)
 155 define test_log
 156     if test ! -s $2; then RES=Success; else RES=Failure; fi; $(ECHO) "$1: Test $$RES $(DATE)" >>$3
 157 endef
 158
 159 # テストごとのファイルをグループファイルに出力
 160 # 引数は、テストのリスト、グループファイル、テストファイル
 161 # 用例: $(call group_log,files_test_log,file_group_log)
 162 define group_log
 163     $(foreach target,$1,$(call group_log_each,$(target),$2))
 164 endef
 165
 166 # テストのログファイルをグループログファイルに出力。引数は、テスト、グループログファイル
 167 # 用例: $(call group_log_each,file_test_log,file_group_log)
 168 define group_log_each
 169     if test -s $1; then $(CAT) $1 >>$2; else $(ECHO) $(dir $1): no log >>$2; fi
 170     echo >>$2;
 171
 172 endef
 173
 174 # テストの結果を、グループログファイルを元にレポート。
 175 # 引数は、グループログファイル
 176 # 用例: $(call group_report,name,file_log_file_report)
 177 define group_report
 178     $(ECHO) "$1: $(SUCCESS_TEST) / $(ALL_TEST) tests passed. Details in $2" >$3;
 179     if test $(FAIL_TEST) -eq 0; then $(ECHO) "$1: All tests are succeded." >>$3; fi
 180 endef