foxBMS - Unit Tests  1.6.0
The foxBMS Unit Tests API Documentation
test_algorithm_cfg.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_algorithm_cfg.c
44  * @author foxBMS Team
45  * @date 2020-06-30 (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 Test of the algorithm config module
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "unity.h"
57 #include "Mockdatabase.h"
58 #include "Mockmoving_average.h"
59 #include "Mockos.h"
60 
61 #include "algorithm_cfg.h"
62 
63 #include "test_assert_helper.h"
64 
65 /*========== Unit Testing Framework Directives ==============================*/
66 TEST_INCLUDE_PATH("../../src/app/application/algorithm/config")
67 TEST_INCLUDE_PATH("../../src/app/application/algorithm/moving_average")
68 
69 /*========== Definitions and Implementations for Unit Test ==================*/
70 
71 /*========== Setup and Teardown =============================================*/
72 void setUp(void) {
73 }
74 
75 void tearDown(void) {
76 }
77 
78 /*========== Test Cases =====================================================*/
80  OS_EnterTaskCritical_Ignore();
81  OS_ExitTaskCritical_Ignore();
83 }
84 
86  OS_EnterTaskCritical_Ignore();
87  OS_ExitTaskCritical_Ignore();
89  ALGO_MarkAsDone(0);
90  TEST_ASSERT_EQUAL(ALGO_READY, algo_algorithms[0].state);
91 }
92 
94  OS_EnterTaskCritical_Ignore();
95  OS_ExitTaskCritical_Ignore();
97  ALGO_MarkAsDone(0);
98  TEST_ASSERT_EQUAL(ALGO_BLOCKED, algo_algorithms[0].state);
99 }
100 
102  OS_EnterTaskCritical_Ignore();
103  OS_ExitTaskCritical_Ignore();
105 }
106 
108  OS_EnterTaskCritical_Ignore();
109  OS_ExitTaskCritical_Ignore();
112  TEST_ASSERT_EQUAL(ALGO_REINIT_REQUESTED, algo_algorithms[0].state);
113 }
void ALGO_MarkAsReinit(uint32_t algorithmIndex)
mark a algorithm as requiring a reinitialization.
Definition: algorithm_cfg.c:93
ALGO_TASKS_s algo_algorithms[]
Definition: algorithm_cfg.c:70
void ALGO_MarkAsDone(uint32_t algorithmIndex)
Mark the current algorithm as done (will reset to ALGO_READY if possible)
Definition: algorithm_cfg.c:82
Headers for the configuration of the algorithm module.
@ ALGO_REINIT_REQUESTED
Definition: algorithm_cfg.h:90
@ ALGO_RUNNING
Definition: algorithm_cfg.h:86
@ ALGO_READY
Definition: algorithm_cfg.h:85
@ ALGO_BLOCKED
Definition: algorithm_cfg.h:88
ALGO_STATE_e state
Definition: algorithm_cfg.h:95
void testIllegalAccessInMarkAsReinit(void)
void testResetToReadyFromBlocked(void)
void testReinitFromRunning(void)
void testResetToReadyFromRunning(void)
void setUp(void)
void tearDown(void)
void testIllegalAccessInMarkAsDone(void)
Helper for unit tests.
#define TEST_ASSERT_FAIL_ASSERT(_code_under_test)
assert whether assert macro has failed