foxBMS - Unit Tests  1.6.0
The foxBMS Unit Tests API Documentation
test_led.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_led.c
44  * @author foxBMS Team
45  * @date 2020-10-05 (date of creation)
46  * @updated 2023-10-12 (date of last update)
47  * @version v1.6.0
48  * @ingroup UNIT_TEST_IMPLEMENTATION
49  * @prefix TEST
50  *
51  * @brief Tests for the led module
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "unity.h"
57 #include "Mockio.h"
58 #include "Mockos.h"
59 
60 #include "led.h"
61 #include "test_assert_helper.h"
62 
63 /*========== Unit Testing Framework Directives ==============================*/
64 TEST_SOURCE_FILE("led.c")
65 
66 TEST_INCLUDE_PATH("../../src/app/driver/io")
67 TEST_INCLUDE_PATH("../../src/app/driver/led")
68 TEST_INCLUDE_PATH("../../src/app/task/config")
69 
70 /*========== Definitions and Implementations for Unit Test ==================*/
71 
72 /*========== Setup and Teardown =============================================*/
73 void setUp(void) {
74 }
75 
76 void tearDown(void) {
77 }
78 
79 /*========== Test Cases =====================================================*/
80 
81 void testLED_SetDebugLed(void) {
82  IO_PinSet_Ignore();
84 }
85 
86 void testLED_Trigger(void) {
87  OS_EnterTaskCritical_Expect();
88  OS_ExitTaskCritical_Expect();
91 
93  OS_EnterTaskCritical_Expect();
94  OS_ExitTaskCritical_Expect();
95  IO_PinGet_IgnoreAndReturn(STD_PIN_HIGH);
96  IO_PinReset_Ignore();
97  LED_Trigger();
98 
99  for (uint8_t i = 0; i < 9u; i++) {
100  OS_EnterTaskCritical_Expect();
101  OS_ExitTaskCritical_Expect();
102  LED_Trigger();
103  }
104 
105  OS_EnterTaskCritical_Expect();
106  OS_ExitTaskCritical_Expect();
107  IO_PinGet_IgnoreAndReturn(STD_PIN_LOW);
108  IO_PinSet_Ignore();
109  LED_Trigger();
110 }
111 
115 
116  TEST_LED_SetOnOffTime(0u); /* re-initialize on-off time */
118  TEST_ASSERT_EQUAL(100u, TEST_LED_GetOnOffTime());
119 
121  TEST_ASSERT_EQUAL(200u, TEST_LED_GetOnOffTime());
122 }
@ STD_PIN_LOW
Definition: fstd_types.h:89
@ STD_PIN_HIGH
Definition: fstd_types.h:90
void LED_SetToggleTime(uint32_t onOffTime_ms)
Set debug LED with defined frequency.
Definition: led.c:114
void TEST_LED_SetOnOffTime(uint32_t val)
Definition: led.c:125
void LED_SetDebugLed(void)
Turn debug LED on.
Definition: led.c:87
void LED_Trigger(void)
Trigger function to periodically toggle debug LED. Frequency can be set via function LED_SetToggleTim...
Definition: led.c:91
uint32_t TEST_LED_GetOnOffTime(void)
Definition: led.c:122
Header file of the debug LED driver.
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 testLED_SetDebugLed(void)
Definition: test_led.c:81
void setUp(void)
Definition: test_led.c:73
void testLED_SetToggleTime(void)
Definition: test_led.c:112
void tearDown(void)
Definition: test_led.c:76
void testLED_Trigger(void)
Definition: test_led.c:86