foxBMS - Unit Tests  1.6.0
The foxBMS Unit Tests API Documentation
test_diag_cbs_aerosol-sensor.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_diag_cbs_aerosol-sensor.c
44  * @author foxBMS Team
45  * @date 2023-09-06 (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 current sensor diag handler implementation.
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "unity.h"
57 #include "Mockdiag_cfg.h"
58 
59 #include "diag_cbs.h"
60 #include "test_assert_helper.h"
61 
62 /*========== Unit Testing Framework Directives ==============================*/
63 TEST_SOURCE_FILE("diag_cbs_aerosol-sensor.c")
64 
65 TEST_INCLUDE_PATH("../../src/app/engine/diag/cbs")
66 
67 /*========== Definitions and Implementations for Unit Test ==================*/
68 /** local copy of the #DATA_BLOCK_ERROR_STATE_s table */
70 
71 /** local copy of the #DATA_BLOCK_MOL_FLAG_s table */
73 
74 /** local copy of the #DATA_BLOCK_RSL_FLAG_s table */
76 
77 /** local copy of the #DATA_BLOCK_MSL_FLAG_s table */
79 
82  .pTableMol = &test_tableMolFlags,
83  .pTableRsl = &test_tableRslFlags,
84  .pTableMsl = &test_tableMslFlags,
85 };
86 
87 /*========== Setup and Teardown =============================================*/
88 void setUp(void) {
89 }
90 
91 void tearDown(void) {
92 }
93 
94 /*========== Test Cases =====================================================*/
95 /**
96  * @brief Testing DIAG_AerosolAlert
97  * @details The following cases need to be tested:
98  * - Argument validation:
99  * - AT1/3: invalid diagnosis event ID for diagId -> assert
100  * - AT2/3: invalid event for event -> assert
101  * - AT3/3: NULL_PTR for kpkDiagShim -> assert
102  * - Routine validation:
103  * - RT1/4: Function keeps alter value on false
104  * - RT2/4: Function sets alert value in the struct to true
105  * - RT3/4: Function keeps alter value on true after an error
106  * occurred
107  * - RT4/4: Function resets alter value in the struct to from true
108  * to false
109  */
111  /* ======= Assertion tests ============================================= */
112  /* ======= AT1/3 ======= */
114  /* ======= AT2/3 ======= */
116  /* ======= AT3/3 ======= */
118 
119  /* ======= Routine tests =============================================== */
120  /* ======= RT1/4: Test implementation */
122  /* ======= RT1/4: call function under test */
124  /* ======= RT1/4: test output verification */
125  TEST_ASSERT_FALSE(diag_kpkDatabaseShim.pTableError->aerosolAlert);
126 
127  /* ======= RT2/4: Test implementation */
129  /* ======= RT2/4: call function under test */
131  /* ======= RT2/4: test output verification */
132  TEST_ASSERT_TRUE(diag_kpkDatabaseShim.pTableError->aerosolAlert);
133 
134  /* ======= RT3/4: Test implementation */
135  /* ======= RT3/4: call function under test */
137  /* ======= RT3/4: test output verification */
138  TEST_ASSERT_TRUE(diag_kpkDatabaseShim.pTableError->aerosolAlert);
139 
140  /* ======= RT4/4: Test implementation */
141  /* ======= RT4/4: call function under test */
143  /* ======= RT4/4: test output verification */
144  TEST_ASSERT_FALSE(diag_kpkDatabaseShim.pTableError->aerosolAlert);
145 }
@ DATA_BLOCK_ID_ERROR_STATE
Definition: database_cfg.h:95
@ DATA_BLOCK_ID_RSL_FLAG
Definition: database_cfg.h:106
@ DATA_BLOCK_ID_MSL_FLAG
Definition: database_cfg.h:102
@ DATA_BLOCK_ID_MOL_FLAG
Definition: database_cfg.h:100
static DIAG_DIAGNOSIS_STATE_s diag
Definition: diag.c:71
Diagnosis driver header.
void DIAG_AerosolAlert(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t data)
diagnosis callback function for aerosol alert
@ DIAG_EVENT_RESET
Definition: diag_cfg.h:269
@ DIAG_EVENT_NOT_OK
Definition: diag_cfg.h:268
@ DIAG_EVENT_OK
Definition: diag_cfg.h:267
@ DIAG_ID_MAX
Definition: diag_cfg.h:262
@ DIAG_ID_AEROSOL_ALERT
Definition: diag_cfg.h:261
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:77
DATA_BLOCK_HEADER_s header
Definition: database_cfg.h:337
DATA_BLOCK_ID_e uniqueId
Definition: database_cfg.h:125
DATA_BLOCK_HEADER_s header
Definition: database_cfg.h:497
DATA_BLOCK_HEADER_s header
Definition: database_cfg.h:455
DATA_BLOCK_HEADER_s header
Definition: database_cfg.h:477
DATA_BLOCK_ERROR_STATE_s * pTableError
Definition: diag_cfg.h:166
Helper for unit tests.
#define TEST_ASSERT_FAIL_ASSERT(_code_under_test)
assert whether assert macro has failed
const DIAG_DATABASE_SHIM_s diag_kpkDatabaseShim
void testDIAG_AerosolSensorIllegalInput(void)
Testing DIAG_AerosolAlert.
static DATA_BLOCK_RSL_FLAG_s test_tableRslFlags
static DATA_BLOCK_MOL_FLAG_s test_tableMolFlags
void setUp(void)
void tearDown(void)
static DATA_BLOCK_ERROR_STATE_s test_tableErrorFlags
static DATA_BLOCK_MSL_FLAG_s test_tableMslFlags