doc/autotest_mk.info

   1 This is autotest_mk.info, produced by makeinfo version 4.13 from
   2 autotest_mk.texi.
   3
   4 Copyright (C) 2010 j8takagi
   5
   6 INFO-DIR-SECTION Basics
   7 START-INFO-DIR-ENTRY
   8 * Autotest.mk: (autotest_mk).
   9 END-INFO-DIR-ENTRY
  10
  11 \1f
  12 File: autotest_mk.info,  Node: Top,  Next: About,  Prev: (dir),  Up: (dir)
  13
  14 * Menu:
  15
  16 * About::
  17 * Install::
  18 * Tutorial::
  19 * Manual::
  20
  21  --- The Detailed Node Listing ---
  22
  23 Autotest.mkのインストール
  24
  25 * Download::
  26 * Verify::
  27 * Expand::
  28
  29 Autotest.mkチュートリアル
  30
  31 * Preapre::
  32 * Create Group::
  33
  34 \1f
  35 File: autotest_mk.info,  Node: About,  Next: Install,  Prev: Top,  Up: Top
  36
  37 1 Autotest.mkの概要
  38 **********************
  39
  40 Autotest.mkは、GNU
  41 Makeを利用したテスト自動化ツールです。何回か`make'コマンドを実行し、プログラムのテスト結果を表す実行ファイルを作成すれば、テストの準備は完了です。あとは`make'コマンドを1回実行すれば、いつでもテストを実行できます。テストの実行結果は、ログに出力されます。
  42
  43  Autotest.mkでは、次の3つの概念を使います。
  44
  45 `テンプレート'
  46      テストグループとテストのテンプレートです。
  47
  48 `テストグループ'
  49      複数のテストを含むグループです。
  50
  51 `テスト'
  52      テスト個々の内容と結果を表します。
  53
  54 要件
  55 ======
  56
  57 Autotest.mkは、LinuxやMac OS
  58 Xなどで動作します。現在動作を確認しているのは、次のディストリビューションです。
  59
  60    * Ubuntu Linux 10.10
  61
  62    * Mac OS X バージョン 10.6.5
  63
  64  Mac OS Xでは、GNU Findutils
  65 (http://www.gnu.org/software/findutils/)をインストールしてください。
  66
  67 \1f
  68 File: autotest_mk.info,  Node: Install,  Next: Tutorial,  Prev: About,  Up: Top
  69
  70 2 Autotest.mkのインストール
  71 **********************************
  72
  73 * Menu:
  74
  75 * Download::
  76 * Verify::
  77 * Expand::
  78
  79  Autotest.mkをインストールするには、次の作業をします。
  80
  81   1. Autotest.mkファイルのダウンロード
  82
  83   2. Autotest.mkファイルの検証
  84
  85   3. Autotest.mkファイルの展開
  86
  87 \1f
  88 File: autotest_mk.info,  Node: Download,  Next: Verify,  Prev: Install,  Up: Install
  89
  90 2.1 ダウンロード
  91 ======================
  92
  93 GitHub/j8takagi/autotest_mk
  94 (http://github.com/j8takagi/autotest_mk)のダウンロードページ
  95 (http://github.com/j8takagi/autotest_mk/downloads)から最新版のtgzファイルをダウンロードします。
  96
  97  続けて、対応する`md5sum'フィルをダウンロードします。
  98
  99 \1f
 100 File: autotest_mk.info,  Node: Verify,  Next: Expand,  Prev: Download,  Up: Install
 101
 102 2.2 ファイルの検証
 103 =========================
 104
 105 ダウンロードが完了したら、`md5sum'と`diff'で正しくファイルがダウンロードができているかを検証します。
 106
 107   $ md5sum autotest_mk.tar.gz | diff -s autotest_mk.tar.gz.md5sum -
 108   Files autotest_mk.tar.gz.md5sum and - are identical
 109
 110 \1f
 111 File: autotest_mk.info,  Node: Expand,  Prev: Verify,  Up: Install
 112
 113 2.3 ファイルの展開
 114 =========================
 115
 116 `autotest_mk'ファイルをダウンロードしたら、次のコマンドで展開します。
 117
 118   $ tar xvzf autotest_mk.tar.gz
 119
 120  展開したら、Autotest.mkは使える状態です。多くのプログラムをインストールするときに必要なコンパイルやビルド、システムディレクトリーへのインストール（`./configure'や`make'、`make
 121 install'）は必要ありません。
 122
 123 \1f
 124 File: autotest_mk.info,  Node: Tutorial,  Next: Manual,  Prev: Install,  Up: Top
 125
 126 3 Autotest.mkチュートリアル
 127 **********************************
 128
 129 Autotest.mkを使ったテストの手順は、次のとおりです。
 130
 131   1. グループディレクトリーの作成
 132
 133   2. テストディレクトリーの作成
 134
 135   3. テスト用コマンドファイルの作成
 136
 137   4. テスト想定結果の作成と検証
 138
 139   5. テストの実行とログの確認
 140
 141  ここでは、簡易電卓プログラムcalcをテストする手順を取り上げます。
 142
 143 * Menu:
 144
 145 * Preapre::
 146 * Create Group::
 147 * Create Test::
 148 * Edit cmd::
 149 * Test Set::
 150 * Test Execute::
 151
 152 \1f
 153 File: autotest_mk.info,  Node: Preapre,  Next: Create Group,  Prev: Tutorial,  Up: Tutorial
 154
 155 3.1 サンプルプログラムの準備
 156 ========================================
 157
 158 まず、Autotest.mkのパッケージに含まれている`sample/calc'を任意のフォルダーへコピーします。
 159
 160   $ cd ~/autotest.mk
 161   $ cp ~r ~/sample/calc ~/calc
 162
 163 \1f
 164 File: autotest_mk.info,  Node: Create Group,  Next: Create Test,  Prev: Preapre,  Up: Tutorial
 165
 166 3.2 グループディレクトリーの作成
 167 ==============================================
 168
 169 テンプレートディレクトリーで、`make'を実行します。このとき、テストグループのディレクトリーを変数`GROUPDIR'で指定します。
 170
 171  指定したディレクトリーが作成されます。
 172
 173   $ cd ~/autotest.mk/template
 174   $ make GROUPDIR=~/calc/calc_test
 175
 176  次のコマンドでグループディレクトリーに移動し、その中を確認します。
 177
 178  テストを実行するためのMakefileが作成されます。
 179
 180   $ cd ~/autotest.mk/template
 181   $ make GROUPDIR=~/calc/calc_test
 182
 183 \1f
 184 File: autotest_mk.info,  Node: Create Test,  Next: Edit cmd,  Prev: Create Group,  Up: Tutorial
 185
 186 3.3 テストディレクトリーの作成
 187 ===========================================
 188
 189 \1f
 190 File: autotest_mk.info,  Node: Edit cmd,  Next: Test Set,  Prev: Create Test,  Up: Tutorial
 191
 192 3.4 テスト用コマンドファイルの作成
 193 =================================================
 194
 195 \1f
 196 File: autotest_mk.info,  Node: Test Set,  Next: Test Execute,  Prev: Edit cmd,  Up: Tutorial
 197
 198 3.5 テスト想定結果の作成と検証
 199 ===========================================
 200
 201 \1f
 202 File: autotest_mk.info,  Node: Test Execute,  Prev: Test Set,  Up: Tutorial
 203
 204 3.6 テストの実行とログの確認
 205 ========================================
 206
 207 \1f
 208 File: autotest_mk.info,  Node: Manual,  Prev: Tutorial,  Up: Top
 209
 210 4 Autotest.mkマニュアル
 211 ****************************
 212
 213 * Menu:
 214
 215 * Template Dir::
 216 * Group Dir::
 217 * Test Dir::
 218
 219 \1f
 220 File: autotest_mk.info,  Node: Template Dir,  Next: Group Dir,  Prev: Manual,  Up: Manual
 221
 222 4.1 テンプレートディレクトリー
 223 ===========================================
 224
 225 テンプレートディレクトリーは、Autotest.mkをインストールするときに展開により作成された`template'ディレクトリーです。このディレクトリーに移動すると次の操作ができます。
 226
 227 * Menu:
 228
 229 * make group::
 230 * Template Files::
 231
 232 \1f
 233 File: autotest_mk.info,  Node: make group,  Next: Template Files,  Prev: Template Dir,  Up: Template Dir
 234
 235 4.1.1 `make'または`make group' グループの作成
 236 -------------------------------------------------------
 237
 238 変数`GROUPDIR'で指定されたディレクトリーをテストグループディレクトリーとして作成し、必要な次のファイルをコピーします。
 239
 240 \1f
 241 File: autotest_mk.info,  Node: Template Files,  Prev: make group,  Up: Template Dir
 242
 243 4.1.2 テンプレートのファイル
 244 ---------------------------------------
 245
 246 \1f
 247 File: autotest_mk.info,  Node: Group Dir,  Next: Test Dir,  Prev: Template Dir,  Up: Manual
 248
 249 4.2 グループディレクトリー
 250 =====================================
 251
 252 * Menu:
 253
 254 * make create::
 255 * Rename::
 256 * Delete::
 257 * make check at group::
 258 * make checkall::
 259 * make clean at group::
 260 * make time at group::
 261 * make cleantime at group::
 262 * Group Files::
 263
 264 \1f
 265 File: autotest_mk.info,  Node: make create,  Next: Rename,  Prev: Group Dir,  Up: Group Dir
 266
 267 4.2.1 `make create' テストの作成
 268 --------------------------------------
 269
 270 \1f
 271 File: autotest_mk.info,  Node: Rename,  Next: Delete,  Prev: make create,  Up: Group Dir
 272
 273 4.2.2 テスト名の変更
 274 ---------------------------
 275
 276 \1f
 277 File: autotest_mk.info,  Node: Delete,  Next: make check at group,  Prev: Rename,  Up: Group Dir
 278
 279 4.2.3 テストの削除
 280 ------------------------
 281
 282 \1f
 283 File: autotest_mk.info,  Node: make check at group,  Next: make checkall,  Prev: Delete,  Up: Group Dir
 284
 285 4.2.4 `make'または`make check' グループ内にあるすべてのテストの実行
 286 ----------------------------------------------------------------------------------------
 287
 288 \1f
 289 File: autotest_mk.info,  Node: make checkall,  Next: make clean at group,  Prev: make check at group,  Up: Group Dir
 290
 291 4.2.5 `make checkall' グループ内にあるすべてのテストの実行、計時
 292 -------------------------------------------------------------------------------------
 293
 294 \1f
 295 File: autotest_mk.info,  Node: make clean at group,  Next: make time at group,  Prev: make checkall,  Up: Group Dir
 296
 297 4.2.6 `make clean' グループ内にあるすべてのテストで、実行結果をクリア
 298 ----------------------------------------------------------------------------------------------
 299
 300 \1f
 301 File: autotest_mk.info,  Node: make time at group,  Next: make cleantime at group,  Prev: make clean at group,  Up: Group Dir
 302
 303 4.2.7 `make time' グループ内にあるすべてのテストを計時
 304 ------------------------------------------------------------------------
 305
 306 \1f
 307 File: autotest_mk.info,  Node: make cleantime at group,  Next: Group Files,  Prev: make time at group,  Up: Group Dir
 308
 309 4.2.8 `make cleantime' グループ内にあるすべてのテストで、計時結果をクリア
 310 --------------------------------------------------------------------------------------------------
 311
 312 \1f
 313 File: autotest_mk.info,  Node: Group Files,  Prev: make cleantime at group,  Up: Group Dir
 314
 315 4.2.9 グループのファイル
 316 ---------------------------------
 317
 318 \1f
 319 File: autotest_mk.info,  Node: Test Dir,  Prev: Group Dir,  Up: Manual
 320
 321 4.3 テストディレクトリー
 322 ==================================
 323
 324 * Menu:
 325
 326 * make set::
 327 * make reset::
 328 * make check at test::
 329 * make time at test::
 330 * make cleantime at test::
 331 * make clean at test::
 332 * make cleanall at test::
 333 * Test Files::
 334
 335 \1f
 336 File: autotest_mk.info,  Node: make set,  Next: make reset,  Prev: Test Dir,  Up: Test Dir
 337
 338 4.3.1 `make set' テスト想定の作成
 339 -----------------------------------------
 340
 341 \1f
 342 File: autotest_mk.info,  Node: make reset,  Next: make check at test,  Prev: make set,  Up: Test Dir
 343
 344 4.3.2 `make set' テスト想定の再作成
 345 --------------------------------------------
 346
 347 \1f
 348 File: autotest_mk.info,  Node: make check at test,  Next: make time at test,  Prev: make reset,  Up: Test Dir
 349
 350 4.3.3 `make'または`make check' テストの実行
 351 ----------------------------------------------------
 352
 353 \1f
 354 File: autotest_mk.info,  Node: make time at test,  Next: make cleantime at test,  Prev: make check at test,  Up: Test Dir
 355
 356 4.3.4 `make time' テストの計時
 357 ------------------------------------
 358
 359 \1f
 360 File: autotest_mk.info,  Node: make cleantime at test,  Next: make clean at test,  Prev: make time at test,  Up: Test Dir
 361
 362 4.3.5 `make cleantime' テスト計時結果のクリア
 363 --------------------------------------------------------
 364
 365 \1f
 366 File: autotest_mk.info,  Node: make clean at test,  Next: make cleanall at test,  Prev: make cleantime at test,  Up: Test Dir
 367
 368 4.3.6 `make cleantime' テスト結果のクリア
 369 --------------------------------------------------
 370
 371 \1f
 372 File: autotest_mk.info,  Node: make cleanall at test,  Next: Test Files,  Prev: make clean at test,  Up: Test Dir
 373
 374 4.3.7 `make cleanall' テストの想定と結果をクリア
 375 -------------------------------------------------------------
 376
 377 \1f
 378 File: autotest_mk.info,  Node: Test Files,  Prev: make cleanall at test,  Up: Test Dir
 379
 380 4.3.8 テストのファイル
 381 ------------------------------
 382
 383
 384 \1f
 385 Tag Table:
 386 Node: Top\7f208
 387 Node: About\7f512
 388 Node: Install\7f1677
 389 Node: Download\7f2082
 390 Node: Verify\7f2511
 391 Node: Expand\7f2919
 392 Node: Tutorial\7f3461
 393 Node: Preapre\7f4120
 394 Node: Create Group\7f4476
 395 Node: Create Test\7f5205
 396 Node: Edit cmd\7f5393
 397 Node: Test Set\7f5589
 398 Node: Test Execute\7f5774
 399 Node: Manual\7f5936
 400 Node: Template Dir\7f6117
 401 Node: make group\7f6582
 402 Node: Template Files\7f6977
 403 Node: Group Dir\7f7145
 404 Node: make create\7f7498
 405 Node: Rename\7f7672
 406 Node: Delete\7f7821
 407 Node: make check at group\7f7972
 408 Node: make checkall\7f8258
 409 Node: make clean at group\7f8551
 410 Node: make time at group\7f8861
 411 Node: make cleantime at group\7f9137
 412 Node: Group Files\7f9457
 413 Node: Test Dir\7f9620
 414 Node: make set\7f9939
 415 Node: make reset\7f10118
 416 Node: make check at test\7f10313
 417 Node: make time at test\7f10533
 418 Node: make cleantime at test\7f10733
 419 Node: make clean at test\7f10973
 420 Node: make cleanall at test\7f11205
 421 Node: Test Files\7f11447
 422 \1f
 423 End Tag Table
 424
 425 \1f
 426 Local Variables:
 427 coding: utf-8
 428 End: