テストユーティリティ

テストユーティリティ — テストをもっと簡単に書くためのユーティリティ。

概要

void *              cut_take                            (void *object,
                                                         CutDestroyFunction destroy_function);
const void *        cut_take_memory                     (void *memory);
const char *        cut_take_string                     (char *string);
const char *        cut_take_strdup                     (const char *string);
const char *        cut_take_strndup                    (const char *string,
                                                         size_t size);
const void *        cut_take_memdup                     (const void *memory,
                                                         size_t size);
const char *        cut_take_printf                     (const char *format,
                                                         ...);
char **             cut_take_string_array               (char **strings);
const char *        cut_take_diff                       (const char *from,
                                                         const char *to);
const char *        cut_append_diff                     (const char *message,
                                                         const char *from,
                                                         const char *to);
const char *        cut_inspect_string_array            (const char **strings);
void                cut_set_fixture_data_dir            (const char *path,
                                                         ...);
char *              cut_build_fixture_data_path         (const char *path,
                                                         ...);
const char *        cut_get_fixture_data_string         (const char *path,
                                                         ...);
void                cut_remove_path                     (const char *path,
                                                         ...);
cut_boolean         cut_equal_string                    (const char *string1,
                                                         const char *string2);
cut_boolean         cut_equal_double                    (double double1,
                                                         double double2,
                                                         double error);

説明

テストを書くためには、テスト環境を前処理・後処理するコードや、検証する結果を準備するコードなどたくさんのコードを書く必要があります。Cutterはもっと簡単にテストを書くためにユーティリティを提供します。

このユーティリティはGLibサポート無しでも使えます。

詳細

cut_take ()

void *              cut_take                            (void *object,
                                                         CutDestroyFunction destroy_function);

objectの所有権をCutterに渡し、object自身を返します。objectdestroy_funcを用いて破棄されます。

object :

Cutterが所有権をもつことになるオブジェクト。

destroy_function :

オブジェクト用の破棄関数。

戻り値 :

Cutterが所有するobject。解放しないで下さい。

1.0.5から


cut_take_memory ()

const void *        cut_take_memory                     (void *memory);

memoryの所有権をCutterに渡し、memory自身を返します。memoryfree()で破棄されます。

memory :

Cutterが所有権を持つことになるメモリ。

戻り値 :

Cutterが所有するmemory。解放しないで下さい。

1.0.5から


cut_take_string ()

const char *        cut_take_string                     (char *string);

stringの所有権をCutterに渡し、stringそれ自身を返します。

string :

Cutterが所有権を持つことになる文字列。

戻り値 :

Cutterが所有するstring。解放しないで下さい。

cut_take_strdup ()

const char *        cut_take_strdup                     (const char *string);

stringを複製し、その所有権をCutterに渡し、複製されたメモリを返します。

string :

複製される文字列。

戻り値 :

Cutterが所有する複製された文字列。解放しないで下さい。

1.0.5から


cut_take_strndup ()

const char *        cut_take_strndup                    (const char *string,
                                                         size_t size);

stringの先頭sizeバイトを複製し、その所有権ををCutterに渡し、複製された文字列を返します。複製された文字列は常にNULL終端しています。

string :

複製される文字列。

size :

複製するバイト数。

戻り値 :

Cutterが所有する複製された文字列。解放しないで下さい。

1.0.5から


cut_take_memdup ()

const void *        cut_take_memdup                     (const void *memory,
                                                         size_t size);

memorysizeバイトを複製し、その所有権をCutterに渡し、複製されたメモリを返します。

memory :

複製されるメモリ。

size :

複製するバイト数。

戻り値 :

Cutterが所有する複製されたメモリ。解放しないで下さい。

1.0.5から


cut_take_printf ()

const char *        cut_take_printf                     (const char *format,
                                                         ...);

printf()のように文字列を整形しますが、整形された文字列はCutterが所有します。

format :

整形文字列。printf()のドキュメントを見てください。

... :

整形文字列に挿入されるパラメータ。

戻り値 :

Cutterが所有する整形された文字列。解放しないで下さい。

cut_take_string_array ()

char **             cut_take_string_array               (char **strings);

配列の所有権をCutterに渡し、stringsそれ自身を返します。

strings :

Cutterが所有権を持つことになる文字列の配列。

戻り値 :

Cutterが所有するstrings。解放しないで下さい。

cut_take_diff ()

const char *        cut_take_diff                       (const char *from,
                                                         const char *to);

fromtoのdiffを計算します。diffの所有者はCutterです。

from :

元の文字列。

to :

修正された文字列。

戻り値 :

Cutterが所有するfromtoのdiff。開放しないでください。

cut_append_diff ()

const char *        cut_append_diff                     (const char *message,
                                                         const char *from,
                                                         const char *to);

Warning

cut_append_diffはバージョン1.0.9から非推奨になりました。新しく書くコードでは使わないでください。代わりにcut_set_expected()cut_set_actual()を使ってください。

fromtoのdiffを計算し、そのdiffをmessageに追加します。戻り値の文字列の所有者はCutterです。

message :

diffが追加される文字列。

from :

元の文字列。

to :

修正された文字列。

戻り値 :

fromto間のdiff付きのmessage。必要なさそうなdiffであればmessageと同じ。開放しないでください。

1.0.3から


cut_inspect_string_array ()

const char *        cut_inspect_string_array            (const char **strings);

stringsを人が読みやすい文字列に整形します。整形された文字列の所有者はCutterです。

strings :

整形される文字列の配列。

戻り値 :

Cutterが所有する整形された文字列。解放しないで下さい。

cut_set_fixture_data_dir ()

void                cut_set_fixture_data_dir            (const char *path,
                                                         ...);

cut_get_fixture_data_string()などで使われるフィクスチャデータのディレクトリを指定します。

path :

フィクスチャデータディレクトリのパスの最初の要素。

... :

パスの残りの要素。1.0.7からNULL終端が必須となりました。

1.0.2から


cut_build_fixture_data_path ()

char *              cut_build_fixture_data_path         (const char *path,
                                                         ...);

フィクスチャデータへのパスを生成します。もし、pathが相対パスなら、パスはcut_set_fixture_data_dir()で指定したディレクトリか、現在のディレクトリからの相対パスとして処理されます。

path :

フィクスチャデータのパスの最初の要素。

... :

パスの残りの要素。1.0.7からNULL終端が必須となりました。

戻り値 :

フィクスチャデータのパス。返された文字列が必要なくなったときは開放してください。

1.0.2から


cut_get_fixture_data_string ()

const char *        cut_get_fixture_data_string         (const char *path,
                                                         ...);

"path/..."にあるフィクスチャデータを読み込み、文字列として返します。文字列はCutterが所持します。cut_build_fixture_data_path()の説明にはフィクスチャデータのパスがどのように決定されるかが書かれています。

path :

フィクスチャデータのパスの最初の要素。

... :

パスの残りの要素。1.0.7からNULL終端が必須となりました。

戻り値 :

フィクスチャデータの内容。開放しないください。

1.0.2から


cut_remove_path ()

void                cut_remove_path                     (const char *path,
                                                         ...);

pathと、その下にあるパスを再帰的に削除します。いかなるエラーも報告しません。

path :

削除するパスの最初の要素。

... :

パスの残りの要素。1.0.7からNULL終端が必須となりました。

1.0.2から


cut_equal_string ()

cut_boolean         cut_equal_string                    (const char *string1,
                                                         const char *string2);

string1string2を比較します。string1あるいはstring2、または両方がNULLでもかまいません。

string1 :

文字列。

string2 :

文字列。

戻り値 :

string1string2が両方NULL、あるいは同じ内容の場合はCUT_TRUE、そうでない場合はCUT_FALSE

1.0.5から


cut_equal_double ()

cut_boolean         cut_equal_double                    (double double1,
                                                         double double2,
                                                         double error);

double1double2を誤差範囲errorで比較します。

double1 :

浮動小数点値。

double2 :

浮動小数点値。

error :

誤差範囲を示す浮動小数点数。

戻り値 :

|double1 - double2| <= errorならCUT_TRUE、そうでなければCUT_FALSE

1.0.5から