foxBMS - Unit Tests  1.1.0
The foxBMS Unit Tests API Documentation
test_algorithm_stubs.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, 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_stubs.h
44  * @author foxBMS Team
45  * @date 2020-12-09 (date of creation)
46  * @updated 2020-12-09 (date of last update)
47  * @ingroup UNIT_TEST_IMPLEMENTATION
48  * @prefix TEST
49  *
50  * @brief Stubs for testing the algorithm module
51  * @details We can create mocks from these stubs that we can supply as pointer
52  * in the test_algorithm.c
53  *
54  */
55 
56 #ifndef FOXBMS__TEST_ALGORITHM_STUBS_H_
57 #define FOXBMS__TEST_ALGORITHM_STUBS_H_
58 
59 /*========== Includes =======================================================*/
60 #include "general.h"
61 
62 #include "unity.h"
63 
64 /*========== Macros and Definitions =========================================*/
65 /** a compute function for mocking for the algorithm module */
66 extern void TEST_AlgorithmComputeFunction(void);
67 
68 /** an initialization function for mocking for the algorithm module */
69 extern STD_RETURN_TYPE_e TEST_AlgorithmInitializationFunction(void);
70 
71 #endif /* FOXBMS__TEST_ALGORITHM_STUBS_H_ */
STD_RETURN_TYPE_e
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
general.h
General macros and definitions for the whole platform.
TEST_AlgorithmInitializationFunction
STD_RETURN_TYPE_e TEST_AlgorithmInitializationFunction(void)
TEST_AlgorithmComputeFunction
void TEST_AlgorithmComputeFunction(void)