unittest.h

Go to the documentation of this file.

/* Copyright 2012-2014, Peter A. Bigot
 *
 * 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 software 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.
 */

#ifndef BSP430_UTILITY_UNITTEST_H
#define BSP430_UTILITY_UNITTEST_H

#include <bsp430/core.h>
#include <string.h>
#include <inttypes.h>

#ifndef configBSP430_UNITTEST
#define configBSP430_UNITTEST 0
#endif /* configBSP430_UNITTEST */

#define BSP430_UNITTEST (configBSP430_UNITTEST - 0)

#if defined(BSP430_DOXYGEN) || (defined(BSP430_LED_GREEN) && defined(BSP430_LED_RED))

#define BSP430_UNITTEST_LED_FAILED BSP430_LED_RED

#define BSP430_UNITTEST_LED_PASSED BSP430_LED_GREEN
#else
#define BSP430_UNITTEST_LED_FAILED 0
#define BSP430_UNITTEST_LED_PASSED 1
#endif

#ifndef configBSP430_UNITTEST_FAILFAST
#define configBSP430_UNITTEST_FAILFAST 0
#endif /* configBSP430_UNITTEST_FAILFAST */

void vBSP430unittestInitialize (void);

void vBSP430unittestResult_ (int line,
                             int passp,
                             const char * format,
                             ...);

void vBSP430unittestFinalize (void);

#define BSP430_UNITTEST_FAIL(msg_) do {         \
    vBSP430unittestResult_(__LINE__, 0, msg_);  \
  } while (0)

#define BSP430_UNITTEST_ASSERT_TRUE(expr_) do {                 \
    static const char * expr_str_ = #expr_;                     \
    vBSP430unittestResult_(__LINE__, !!(expr_), expr_str_);     \
  } while (0)

#define BSP430_UNITTEST_ASSERT_FALSE(expr_) do {                        \
    static const char * expr_str_ = #expr_;                             \
    vBSP430unittestResult_(__LINE__, !(expr_), "NOT %s", expr_str_);    \
  } while (0)

#define BSP430_UNITTEST_ASSERT_EQUAL(v1_,v2_) do {                      \
    static const char * expr_str_ = #v1_ "==" #v2_;                     \
    vBSP430unittestResult_(__LINE__, (v1_) == (v2_), expr_str_);        \
  } while (0)

#define BSP430_UNITTEST_ASSERT_EQUAL_ASCIIZ(v1_,v2_) do {               \
    static const char * expr_str_ = #v1_ "==" #v2_;                     \
    const char * v1v_ = (v1_);                                          \
    const char * v2v_ = (v2_);                                          \
    vBSP430unittestResult_(__LINE__, 0 == strcmp(v1v_, v2v_), expr_str_); \
  } while (0)

#define BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,type_,pri_) do {      \
    static const char * expr_str_ = #v1_ "==" #v2_;                     \
    type_ v1v_ = (v1_);                                                 \
    type_ v2v_ = (v2_);                                                 \
    if (v1v_ == v2v_) {                                                 \
      vBSP430unittestResult_(__LINE__, 1, "%s", expr_str_);           \
    } else {                                                            \
      vBSP430unittestResult_(__LINE__, 0, "%s: " pri_ " != " pri_, expr_str_, v1v_, v2v_); \
    }                                                                   \
  } while (0)


#define BSP430_UNITTEST_ASSERT_EQUAL_FMTd(v1_,v2_) \
  BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,int,"%" PRId16)

#define BSP430_UNITTEST_ASSERT_EQUAL_FMTu(v1_,v2_) \
  BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,unsigned int,"%" PRIu16)

#define BSP430_UNITTEST_ASSERT_EQUAL_FMTx(v1_,v2_) \
  BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,unsigned int,"%#" PRIx16)

#define BSP430_UNITTEST_ASSERT_EQUAL_FMTld(v1_,v2_) \
  BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,long,"%" PRId32)

#ifdef PRId64

#define BSP430_UNITTEST_ASSERT_EQUAL_FMTlld(v1_,v2_) \
  BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,long long,"%" PRId64)
#endif /* PRId64 */

#define BSP430_UNITTEST_ASSERT_EQUAL_FMTlu(v1_,v2_) \
  BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,unsigned long,"%" PRIu32)

#ifdef PRIu64

#define BSP430_UNITTEST_ASSERT_EQUAL_FMTllu(v1_,v2_) \
  BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,unsigned long long,"%" PRIu64)
#endif /* PRIu64 */

#define BSP430_UNITTEST_ASSERT_EQUAL_FMTlx(v1_,v2_) \
  BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,unsigned long, "%#" PRIx32)

#ifdef PRIx64

#define BSP430_UNITTEST_ASSERT_EQUAL_FMTllx(v1_,v2_) \
  BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,unsigned long long, "%#" PRIx64)
#endif /* PRIx64 */

#define BSP430_UNITTEST_ASSERT_EQUAL_FMTp(v1_,v2_) \
  BSP430_UNITTEST_ASSERT_EQUAL_FMT_(v1_,v2_,const void *,"%p")

#endif /* BSP430_UTILITY_UNITTEST_H */