foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
test_bal.c
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_bal.c
44  * @author foxBMS Team
45  * @date 2020-08-05 (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 Test of the API of the balancing module
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "unity.h"
57 #include "Mockdatabase.h"
58 #include "Mockos.h"
59 
60 #include "database_cfg.h"
61 
62 #include "bal.h"
63 
64 #include <stdio.h>
65 
66 /*========== Definitions and Implementations for Unit Test ==================*/
68 
69 /*========== Setup and Teardown =============================================*/
70 void setUp(void) {
71  initState.timer = 0;
80  initState.active = false;
84 }
85 
86 void tearDown(void) {
87 }
88 
89 /*========== Test Cases =====================================================*/
90 void testNoStateChanged(void) {
93  TEST_ASSERT_EQUAL(initState.state, BAL_STATEMACH_UNINITIALIZED);
94  TEST_ASSERT_EQUAL(initState.lastSubstate, BAL_ENTRY);
95  TEST_ASSERT_EQUAL(initState.substate, BAL_ENTRY);
96 }
97 
98 void testStateChanged(void) {
103  TEST_ASSERT_EQUAL(initState.state, BAL_STATEMACH_INITIALIZATION);
104  TEST_ASSERT_EQUAL(initState.lastSubstate, BAL_ENTRY);
105  TEST_ASSERT_EQUAL(initState.substate, BAL_ENTRY);
106 }
107 
112  TEST_ASSERT_EQUAL(initState.lastState, BAL_STATEMACH_UNINITIALIZED);
113  TEST_ASSERT_EQUAL(initState.state, BAL_STATEMACH_UNINITIALIZED);
114  TEST_ASSERT_EQUAL(initState.lastSubstate, BAL_CHECK_IMBALANCES);
115  TEST_ASSERT_EQUAL(initState.substate, BAL_CHECK_IMBALANCES);
116 }
117 
119  OS_EnterTaskCritical_Expect();
120  OS_ExitTaskCritical_Expect();
121  uint8_t returnValue = 0;
122  returnValue = BAL_CheckReEntrance(&initState);
123  TEST_ASSERT_EQUAL(returnValue, 0);
124  OS_EnterTaskCritical_Expect();
125  OS_ExitTaskCritical_Expect();
126  returnValue = BAL_CheckReEntrance(&initState);
127  TEST_ASSERT_EQUAL(returnValue, 0xFF);
128 }
129 
131  OS_EnterTaskCritical_Expect();
132  OS_ExitTaskCritical_Expect();
135  returnValue = BAL_TransferStateRequest(&initState);
136  TEST_ASSERT_EQUAL(returnValue, BAL_STATE_ERROR_REQUEST);
137  TEST_ASSERT_EQUAL(initState.stateRequest, BAL_STATE_NO_REQUEST);
138 }
139 
141  BAL_RETURN_TYPE_e returnValue = BAL_OK;
142 
144  TEST_ASSERT_EQUAL(returnValue, BAL_OK);
145 }
147  BAL_RETURN_TYPE_e returnValue = BAL_OK;
150  TEST_ASSERT_EQUAL(initState.balancingGlobalAllowed, true);
151  TEST_ASSERT_EQUAL(returnValue, BAL_OK);
152 }
154  BAL_RETURN_TYPE_e returnValue = BAL_OK;
157  TEST_ASSERT_EQUAL(initState.balancingGlobalAllowed, false);
158  TEST_ASSERT_EQUAL(returnValue, BAL_OK);
159 }
161  BAL_RETURN_TYPE_e returnValue = BAL_OK;
163  TEST_ASSERT_EQUAL(returnValue, BAL_OK);
164 }
166  BAL_RETURN_TYPE_e returnValue = BAL_OK;
168  TEST_ASSERT_EQUAL(returnValue, BAL_OK);
169 }
171  BAL_RETURN_TYPE_e returnValue = BAL_OK;
174  TEST_ASSERT_EQUAL(returnValue, BAL_OK);
175 }
176 
178  BAL_RETURN_TYPE_e returnValue = BAL_OK;
181  TEST_ASSERT_EQUAL(returnValue, BAL_ALREADY_INITIALIZED);
182 }
183 
185  /* illegal request */
186  BAL_RETURN_TYPE_e returnValue = BAL_OK;
189  TEST_ASSERT_EQUAL(returnValue, BAL_ILLEGAL_REQUEST);
190 }
191 
194  TEST_ASSERT_EQUAL(initState.timer, BAL_STATEMACH_SHORTTIME_100ms);
195  TEST_ASSERT_EQUAL(initState.state, BAL_STATEMACH_INITIALIZATION);
196  TEST_ASSERT_EQUAL(initState.substate, BAL_ENTRY);
197 }
198 
201 }
202 
206  TEST_ASSERT_EQUAL(initState.errorRequestCounter, 0xFF);
207 }
208 
211  TEST_ASSERT_EQUAL(initState.timer, BAL_STATEMACH_SHORTTIME_100ms);
212  TEST_ASSERT_EQUAL(initState.state, BAL_STATEMACH_INITIALIZED);
213  TEST_ASSERT_EQUAL(initState.substate, BAL_ENTRY);
214 }
215 
218  TEST_ASSERT_EQUAL(initState.initializationFinished, STD_OK);
219  TEST_ASSERT_EQUAL(initState.timer, BAL_STATEMACH_SHORTTIME_100ms);
220  TEST_ASSERT_EQUAL(initState.state, BAL_STATEMACH_CHECK_BALANCING);
221  TEST_ASSERT_EQUAL(initState.substate, BAL_ENTRY);
222 }
void BAL_SaveLastStates(BAL_STATE_s *pBalancingState)
Saves the last state and the last substate.
Definition: bal.c:70
void BAL_ProcessStateInitialization(BAL_STATE_s *currentState)
State machine subfunction to initialize the balancing state machine.
Definition: bal.c:171
void BAL_ProcessStateUninitalized(BAL_STATE_s *pCurrentState, BAL_STATE_REQUEST_e stateRequest)
Substate handling function for BAL_Trigger()
Definition: bal.c:157
BAL_STATE_REQUEST_e BAL_TransferStateRequest(BAL_STATE_s *currentState)
transfers the current state request to the state machine.
Definition: bal.c:100
void BAL_ProcessStateInitialized(BAL_STATE_s *currentState)
State machine subfunction to transfer from an initalized state to "running" states of th state machin...
Definition: bal.c:179
uint8_t BAL_CheckReEntrance(BAL_STATE_s *currentState)
re-entrance check of BAL state machine trigger function
Definition: bal.c:84
BAL_RETURN_TYPE_e BAL_CheckStateRequest(BAL_STATE_s *pCurrentState, BAL_STATE_REQUEST_e stateRequest)
checks the state requests that are made.
Definition: bal.c:113
Header for the driver for balancing.
BAL_RETURN_TYPE_e
Definition: bal.h:113
@ BAL_ALREADY_INITIALIZED
Definition: bal.h:121
@ BAL_OK
Definition: bal.h:114
@ BAL_ILLEGAL_REQUEST
Definition: bal.h:117
BAL_STATE_REQUEST_e
Definition: bal.h:100
@ BAL_STATE_GLOBAL_ENABLE_REQUEST
Definition: bal.h:106
@ BAL_STATE_ERROR_REQUEST
Definition: bal.h:102
@ BAL_STATE_NO_REQUEST
Definition: bal.h:107
@ BAL_STATE_ALLOWBALANCING_REQUEST
Definition: bal.h:104
@ BAL_STATE_NO_BALANCING_REQUEST
Definition: bal.h:103
@ BAL_STATE_INIT_REQUEST
Definition: bal.h:101
@ BAL_STATE_GLOBAL_DISABLE_REQUEST
Definition: bal.h:105
@ BAL_STATEMACH_UNINITIALIZED
Definition: bal.h:71
@ BAL_STATEMACH_INITIALIZATION
Definition: bal.h:72
@ BAL_STATEMACH_INITIALIZED
Definition: bal.h:73
@ BAL_STATEMACH_CHECK_BALANCING
Definition: bal.h:74
@ BAL_CHECK_IMBALANCES
Definition: bal.h:90
@ BAL_ENTRY
Definition: bal.h:89
#define BAL_STATEMACH_SHORTTIME_100ms
Definition: bal_cfg.h:64
Database configuration header.
@ STD_NOT_OK
Definition: fstd_types.h:83
@ STD_OK
Definition: fstd_types.h:82
uint32_t errorRequestCounter
Definition: bal.h:137
int32_t balancingThreshold
Definition: bal.h:140
BAL_STATE_REQUEST_e stateRequest
Definition: bal.h:131
STD_RETURN_TYPE_e initializationFinished
Definition: bal.h:138
uint8_t lastSubstate
Definition: bal.h:135
uint8_t triggerEntry
Definition: bal.h:136
BAL_STATEMACH_e lastState
Definition: bal.h:134
bool active
Definition: bal.h:139
bool balancingGlobalAllowed
Definition: bal.h:142
BAL_STATEMACH_SUB_e substate
Definition: bal.h:133
bool balancingAllowed
Definition: bal.h:141
uint16_t timer
Definition: bal.h:130
BAL_STATEMACH_e state
Definition: bal.h:132
void testFiniteStateMachineCheckStateRequestFunction6(void)
Definition: test_bal.c:177
void testProcessStateInitialized(void)
Definition: test_bal.c:216
void testProcessStateUninitalized1(void)
Definition: test_bal.c:199
void testProcessStateUninitalized2(void)
Definition: test_bal.c:203
void testStateChanged(void)
Definition: test_bal.c:98
void testFiniteStateMachineCheckStateRequestFunction3(void)
Definition: test_bal.c:160
void testFiniteStateMachineCheckStateRequestFunction4(void)
Definition: test_bal.c:165
void testFiniteStateMachineCheckStateRequestFunction7(void)
Definition: test_bal.c:184
void setUp(void)
Definition: test_bal.c:70
void testProcessStateInitialization(void)
Definition: test_bal.c:209
void tearDown(void)
Definition: test_bal.c:86
void testFiniteStateMachineCheckStateRequestFunction5(void)
Definition: test_bal.c:170
void testFiniteStateMachineCheckStateRequestFunction0(void)
Definition: test_bal.c:140
void testProcessStateUninitalized0(void)
Definition: test_bal.c:192
void testSubstateChanged(void)
Definition: test_bal.c:108
void testNoStateChanged(void)
Definition: test_bal.c:90
void testFiniteStateMachineTransferStateRequestFunction(void)
Definition: test_bal.c:130
void testFiniteStateMachineCheckStateRequestFunction1(void)
Definition: test_bal.c:146
void testFiniteStateMachineCheckReEntranceFunction(void)
Definition: test_bal.c:118
BAL_STATE_s initState
Definition: test_bal.c:67
void testFiniteStateMachineCheckStateRequestFunction2(void)
Definition: test_bal.c:153