foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
test_assert_helper.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
38  * - ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file test_assert_helper.h
44  * @author foxBMS Team
45  * @date 2020-07-22 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup UNIT_TEST_IMPLEMENTATION
49  * @prefix TEST
50  *
51  * @brief Helper for unit tests
52  * @details Assert helper macros after http://www.electronvector.com/blog/unit-testing-with-asserts
53  *
54  */
55 
56 #ifndef FOXBMS__TEST_ASSERT_HELPER_H_
57 #define FOXBMS__TEST_ASSERT_HELPER_H_
58 
59 /*========== Includes =======================================================*/
60 #include "unity.h"
61 
62 #include "CException.h"
63 
64 /*========== Macros and Definitions =========================================*/
65 
66 /**
67  * @brief assert whether assert macro has failed
68  * @details This macro allows to check during unit tests whether
69  * our #FAS_ASSERT() macro has failed.
70  */
71 #define TEST_ASSERT_FAIL_ASSERT(_code_under_test) \
72  { \
73  CEXCEPTION_T e; \
74  Try { \
75  _code_under_test; \
76  TEST_FAIL_MESSAGE("Code under test did not assert"); \
77  } \
78  Catch(e) {} \
79  }
80 
81 /**
82  * @brief assert whether assert macro has passed
83  * @details This macro allows to check during unit tests whether
84  * our #FAS_ASSERT() macro has passed.
85  * Using this macro is not mandatory. In the case that an
86  * assertion fails "unknowingly", the unit test will failed
87  * because of an unhandled exception.
88  */
89 #define TEST_ASSERT_PASS_ASSERT(_code_under_test) \
90  { \
91  CEXCEPTION_T e; \
92  Try { _code_under_test; } \
93  Catch(e) { TEST_FAIL_MESSAGE("Code under test failed an assertion"); } \
94  }
95 
96 #endif /* FOXBMS__TEST_ASSERT_HELPER_H_ */