# IUTEST

Iris Unit Test Framework : 2020 / 01 / 02

## はじめに

iutest は、include するだけで使うことができる C++ テスティングフレームワーク です。
"iutest/include" をインクルードパスに追加し、

      #include "iutest.hpp"

とするだけ使用できます。

## アサーション/マクロ

iutest のテスト用マクロは、 IUTEST_ から始まります。
IUTEST_ASSERT_ から始まるマクロは致命的なアサーション。
IUTEST_EXPECT_ から始まるマクロは致命的ではないアサーションになります。
また、警告アサーションとして IUTEST_INFORM_
前提条件アサーションとして IUTEST_ASSUME_ も用意しています。
詳細は、ヘッダーファイルもしくは付属の Doxygen ドキュメント をご確認ください。

## テストを書く

最も簡単なテストの記述を以下に示します。

    IUTEST(CaseName, TestName)
    {
        int x = 0;
        IUTEST_ASSERT_EQ(0, x);
    }

IUTEST マクロからテストの記述を開始します。
あとは、アサーションマクロを使用してあなたのコードをテストするだけです。
テストには、この他に パラメータテスト、型付けテスト、型パラメータテストなどがあります。

## main を書く

iutest を実行するには、初期化と実行のマクロを記述するだけです。

    int main(int argc, char** argv)
    {
        IUTEST_INIT(&argc, argv);
        return IUTEST_RUN_ALL_TESTS();
    }

## Google Test のインターフェイスを使う

iutest は Google Test との切り替えヘッダを提供しています。
Google Test の記法（ASSERT_EQなど）で書きつつ、iutest の実装を使用したり、
iutest の記法(IUTEST_ASSERT_EQなど)で書きつつ、 Google Test の実装を使用できます。

# LICENSE

This software is released under the New(3-clause) BSD License.

      BSD 3-Clause License

      Copyright (c) 2011-2020, Takazumi Shirayanagi
      All rights reserved.

      Redistribution and use in source and binary forms, with or without
      modification, are permitted provided that the following conditions are met:

      * Redistributions of source code must retain the above copyright notice, this
        list of conditions and the following disclaimer.

      * Redistributions in binary form must reproduce the above copyright notice,
        this list of conditions and the following disclaimer in the documentation
        and/or other materials provided with the distribution.

      * Neither the name of the copyright holder nor the names of its
        contributors may be used to endorse or promote products derived from
        this software without specific prior written permission.

      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
      IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
      DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
      FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
      DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
      SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
      CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
      OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright (c) 2011-2020, Takazumi-Shirayanagi, All rights reserved.