foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
test_contactor.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_contactor.c
44  * @author foxBMS Team
45  * @date 2020-03-31 (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 contactor.c module
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "unity.h"
57 #include "Mockcontactor_cfg.h"
58 #include "Mockfassert.h"
59 #include "Mockio.h"
60 #include "Mockmcu.h"
61 #include "Mocksps.h"
62 #include "Mocksps_cfg.h"
63 
64 #include "contactor.h"
65 #include "test_assert_helper.h"
66 
67 /*========== Definitions and Implementations for Unit Test ==================*/
70 };
71 
76 };
77 
78 /*========== Setup and Teardown =============================================*/
79 void setUp(void) {
80 }
81 
82 void tearDown(void) {
83 }
84 
85 /*========== Test Cases =====================================================*/
87  /* for the test we assume every contactor channel is correctly affiliated */
88  SPS_GetChannelAffiliation_IgnoreAndReturn(SPS_AFF_CONTACTOR);
90 }
91 
93  /* act as if a channel is wrongly affiliated */
94  SPS_GetChannelAffiliation_IgnoreAndReturn(SPS_AFF_GENERAL_IO);
96 }
98  /* check if the name of the first entry returns the first entry of the array */
99  CONT_CONTACTOR_INDEX index = 0u;
100  TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL(index, TEST_CONT_ResolveContactorName(cont_contactorStates[index].name)));
101 }
102 
104  /* check if the name of the last entry returns the last entry of the array */
106  TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL(index, TEST_CONT_ResolveContactorName(cont_contactorStates[index].name)));
107 }
108 
110  /* check if an invalid name asserts */
111  TEST_ASSERT_FAIL_ASSERT(TEST_ASSERT_EQUAL(0u, TEST_CONT_ResolveContactorName(84u)));
112 }
113 
115  SPS_RequestContactorState_Ignore();
116 
118 }
119 
121  SPS_RequestContactorState_Ignore();
122 
124 }
125 
127  /* Check that every contactor is requested off when undef is used */
128  for (uint8_t contactor = 0u; contactor < BS_NR_OF_CONTACTORS; contactor++) {
129  /* when undef is called, channels should not be touched normally */
130  SPS_RequestContactorState_Expect(contactor, SPS_CHANNEL_OFF);
132  }
133 
134  /* Check that every contactor is requested on */
135  for (uint8_t contactor = 0u; contactor < BS_NR_OF_CONTACTORS; contactor++) {
136  SPS_RequestContactorState_Expect(contactor, SPS_CHANNEL_ON);
137  TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL(STD_OK, CONT_SetContactorState(contactor, CONT_SWITCH_ON)));
138  }
139 
140  /* Check that every contactor is requested off when undef is used */
141  for (uint8_t contactor = 0u; contactor < BS_NR_OF_CONTACTORS; contactor++) {
142  /* when undef is called, channels should not be touched normally */
143  SPS_RequestContactorState_Expect(contactor, SPS_CHANNEL_ON);
145  }
146 
147  /* Check that every contactor is requested off */
148  for (uint8_t contactor = 0u; contactor < BS_NR_OF_CONTACTORS; contactor++) {
149  SPS_RequestContactorState_Expect(contactor, SPS_CHANNEL_OFF);
150  TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL(STD_OK, CONT_SetContactorState(contactor, CONT_SWITCH_OFF)));
151  }
152 }
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
BS_STRING_PRECHARGE_PRESENT_e
@ BS_STRING_WITH_PRECHARGE
#define BS_NR_OF_CONTACTORS
CONT_CONTACTOR_INDEX TEST_CONT_ResolveContactorName(const CONT_NAMES_e name)
Definition: contactor.c:311
void TEST_CONT_InitializationCheckOfContactorRegistry()
Definition: contactor.c:308
STD_RETURN_TYPE_e CONT_SetContactorState(const CONT_NAMES_e name, CONT_ELECTRICAL_STATE_TYPE_e requestedContactorState)
Sets the contactor state to its requested state, if the contactor is at that time not in the requeste...
Definition: contactor.c:193
Headers for the driver for the contactors.
@ CONT_FEEDBACK_THROUGH_CURRENT
Definition: contactor_cfg.h:92
uint8_t CONT_CONTACTOR_INDEX
@ CONT_SWITCH_ON
Definition: contactor_cfg.h:73
@ CONT_SWITCH_OFF
Definition: contactor_cfg.h:72
@ CONT_SWITCH_UNDEF
Definition: contactor_cfg.h:74
@ CONT_STRING0_MINUS
Definition: contactor_cfg.h:80
@ CONT_STRING1_PLUS
Definition: contactor_cfg.h:81
@ CONT_STRING0_PLUS
Definition: contactor_cfg.h:79
@ STD_NOT_OK
Definition: fstd_types.h:83
@ STD_OK
Definition: fstd_types.h:82
@ SPS_CHANNEL_ON
Definition: sps_cfg.h:175
@ SPS_CHANNEL_OFF
Definition: sps_cfg.h:174
@ SPS_AFF_CONTACTOR
Definition: sps_types.h:73
@ SPS_AFF_GENERAL_IO
Definition: sps_types.h:74
Helper for unit tests.
#define TEST_ASSERT_PASS_ASSERT(_code_under_test)
assert whether assert macro has passed
#define TEST_ASSERT_FAIL_ASSERT(_code_under_test)
assert whether assert macro has failed
void testCONT_InitializationCheckOfContactorRegistry(void)
BS_STRING_PRECHARGE_PRESENT_e bs_stringsWithPrecharge[BS_NR_OF_STRINGS]
void testCONT_ResolveContactorNameExistingNamesLast(void)
void testCONT_SetContactorStateInvalidState(void)
void testCONT_ResolveContactorNameExistingNamesFirst(void)
void testCONT_SetContactorStateCopyStates(void)
void testCONT_SetContactorStateInvalidContactorNumber(void)
void testCONT_InitializationCheckOfContactorRegistryWrongAffiliation(void)
void setUp(void)
void tearDown(void)
void testCONT_ResolveContactorNameInvalidName(void)
CONT_CONTACTOR_STATE_s cont_contactorStates[BS_NR_OF_CONTACTORS]