# -*- rd -*-

Time-stamp: <2009/05/07 13:58:43 Shinya Abe>

= Cue::Tutorial.ja

例として足し算をする関数addをとりあげます。

テスト実行までの流れは次のようになります。

  1. ディレクトリをつくる
  2. ソースコードを書く
  3. テストコードを書く
  4. テスト実行

== ディレクトリをつくる

ディレクトリ構成は次のようにしてください。

  add/---+---src/
         |
         +---test/

add/はプロジェクトのトップディレクトリです。
src/にソースコードを置きます。

test/にテストコードを置きます。

== ソースコードを書く

まず，ヘッダファイルsrc/add.hとソースファイルsrc/add.cを書きます。

詳しくは"sample/src/{add.h,add.c}"を参照ください。

ここまでで，ファイル構成は次のようになりました。

  add/---+---src/---+---add.h
         |          |          
         |          +---add.c
         |
         +---test/

== テストコードを書く

次にテストコードを書きます。

add関数のテストtest_add.cは"sample/test/test_add.c"のようになります。

Cueを使うためにcue/cue.hをインクルードします。

CU_DEF（テスト名）でテストを定義します。

main関数では，まずCU_SETUPでCue実行環境を初期化します。

次にCU_REGISTERでCU_DEFで定義したテストを登録します。

最後にCU_RUNでテストを実行します。

ここまでで，ファイル構成は次のようになりました。

  add/---+---src/---+---add.h
         |          |          
         |          +---add.c
         |
         +---test/--+---test_add.c

== ビルド，実行

add/ディレクトリで以下のコマンドを実行してください。

テスト結果が出力されます。

  [add]% run-cue

== ちょっと進んだテスト

ここからはMakefileを知っている人を対象にしています。

テストの実行はrun-cueコマンドでできるのですが，

"src/"や"test/"が階層構造になっている場合はうまくいきません。

また，一部のコードだけを実行したいときもあります。

そんなときは自分でMakefileを書いてテストを実行します。

== Makefileを書く

add/ディレクトリにMakefileをつくります。

Makefileは以下のように書いておきます。

  include ${INSTDIR}/share/cue/Makefile.test

  CC = gcc
  SRC = src/add.c
  TESTSRC = test/test_add.c
  
${INSTDIR}はCueをインストールしたディレクトリに変更してください。

CCはコンパイルコマンドです。

SRCはソースコードを列挙したものです。

TESTSRCはテストコードを列挙したものです。

== Makeによるテストの実行

トップディレクトリで以下のコマンドを実行します。

  [add]% make run-cue
