foxBMS - Unit Tests  1.6.0
The foxBMS Unit Tests API Documentation
test_sbc.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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_sbc.c
44  * @author foxBMS Team
45  * @date 2020-07-15 (date of creation)
46  * @updated 2023-10-12 (date of last update)
47  * @version v1.6.0
48  * @ingroup UNIT_TEST_IMPLEMENTATION
49  * @prefix SBC
50  *
51  * @brief Tests for the sbc module
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "unity.h"
57 #include "Mockdma.h"
58 #include "Mockio.h"
59 #include "Mockmcu.h"
60 #include "Mocknxpfs85xx.h"
61 #include "Mockos.h"
62 #include "Mockportmacro.h"
63 #include "Mocksbc_fs8x.h"
64 #include "Mocksbc_fs8x_communication.h"
65 #include "Mockspi.h"
66 
67 #include "sbc.h"
68 
69 /*========== Unit Testing Framework Directives ==============================*/
70 TEST_SOURCE_FILE("sbc.c")
71 
72 TEST_INCLUDE_PATH("../../src/app/driver/config")
73 TEST_INCLUDE_PATH("../../src/app/driver/dma")
74 TEST_INCLUDE_PATH("../../src/app/driver/io")
75 TEST_INCLUDE_PATH("../../src/app/driver/sbc")
76 TEST_INCLUDE_PATH("../../src/app/driver/sbc/fs8x_driver")
77 TEST_INCLUDE_PATH("../../src/app/driver/spi")
78 TEST_INCLUDE_PATH("../../src/app/task/config")
79 
80 /*========== Definitions and Implementations for Unit Test ==================*/
81 
83 
84 /*========== Setup and Teardown =============================================*/
85 void setUp(void) {
86 }
87 
88 void tearDown(void) {
89 }
90 
91 /*========== Test Cases =====================================================*/
92 
93 void testSBC_Trigger(void) {
94 }
95 
99  /* decrement so we are going to see a trigger event */
100  for (int i = 0; i < sbc_stateMcuSupervisor.watchdogPeriod_10ms - 1; i++) {
102  }
103  /* timer has elapsed now, we should see a trigger event */
104  FS85_TriggerWatchdog_IgnoreAndReturn(STD_OK);
107 
108  /* elapse timer and fail to run watchdog trigger */
110  FS85_TriggerWatchdog_IgnoreAndReturn(STD_NOT_OK);
112 }
@ STD_NOT_OK
Definition: fstd_types.h:84
@ STD_OK
Definition: fstd_types.h:83
bool TEST_SBC_TriggerWatchdogIfRequired(SBC_STATE_s *pInstance)
Definition: sbc.c:431
SBC_STATE_s sbc_stateMcuSupervisor
Definition: sbc.c:78
Header for the driver for the SBC module.
uint16_t watchdogTrigger
Definition: sbc.h:158
uint16_t watchdogPeriod_10ms
Definition: sbc.h:170
FS85_STATE_s fs85xx_mcuSupervisor
Definition: test_sbc.c:82
void testSBC_Trigger(void)
Definition: test_sbc.c:93
void setUp(void)
Definition: test_sbc.c:85
void tearDown(void)
Definition: test_sbc.c:88
void testSBC_TriggerWatchdogIfRequired(void)
Definition: test_sbc.c:96