test_database_helper.c

Go to the documentation of this file.

/**
 *
 * @copyright © 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * We kindly request you to use one or more of the following phrases to refer to
 * foxBMS in your hardware, software, documentation or advertising materials:
 *
 * - ″This product uses parts of foxBMS®″
 * - ″This product includes parts of foxBMS®″
 * - ″This product is derived from foxBMS®″
 *
 */
 
/**
 * @file    test_database_helper.c
 * @author  foxBMS Team
 * @date    2021-05-05 (date of creation)
 * @updated 2022-05-30 (date of last update)
 * @version v1.3.0
 * @ingroup UNIT_TEST_IMPLEMENTATION
 * @prefix  TEST
 *
 * @brief   Tests for the database helper functions
 *
 */
 
/*========== Includes =======================================================*/
#include "general.h"
 
#include "unity.h"
#include "Mockfassert.h"
#include "Mockmpu_prototypes.h"
#include "Mockos.h"
 
#include "database_cfg.h"
 
#include "database_helper.h"
#include "test_assert_helper.h"
 
/*========== Definitions and Implementations for Unit Test ==================*/
 
/*========== Setup and Teardown =============================================*/
void setUp(void) {
}
 
void tearDown(void) {
}
 
/*========== Test Cases =====================================================*/
/** This function tests various inputs for helper function
 *  #DATA_DatabaseEntryUpdatedAtLeastOnce */
void testDATA_DatabaseEntryUpdatedAtLeastOnce(void) {
    DATA_BLOCK_CELL_VOLTAGE_s databaseEntry = {.header.uniqueId = DATA_BLOCK_ID_CELL_VOLTAGE};
 
    /* Database entry has been updated once, after 10ms */
    databaseEntry.header.timestamp         = 10u;
    databaseEntry.header.previousTimestamp = 0u;
    TEST_ASSERT_TRUE(DATA_DatabaseEntryUpdatedAtLeastOnce(databaseEntry.header));
 
    /* Database entry has been updated twice, first after 10ms, then after 50ms */
    databaseEntry.header.timestamp         = 60u;
    databaseEntry.header.previousTimestamp = 10u;
    TEST_ASSERT_TRUE(DATA_DatabaseEntryUpdatedAtLeastOnce(databaseEntry.header));
 
    /* Database entry has been updated three times, first after 10ms, then after 50ms, then after 10ms */
    databaseEntry.header.timestamp         = 70u;
    databaseEntry.header.previousTimestamp = 60u;
    TEST_ASSERT_TRUE(DATA_DatabaseEntryUpdatedAtLeastOnce(databaseEntry.header));
 
    /* Database entry has never been updated */
    databaseEntry.header.timestamp         = 0u;
    databaseEntry.header.previousTimestamp = 0u;
    TEST_ASSERT_FALSE(DATA_DatabaseEntryUpdatedAtLeastOnce(databaseEntry.header));
}
 
/** This function tests various inputs for database helper function
 *  #DATA_EntryUpdatedWithinInterval */
void testDATA_EntryUpdatedWithinInterval(void) {
    DATA_BLOCK_CELL_VOLTAGE_s databaseEntry = {.header.uniqueId = DATA_BLOCK_ID_CELL_VOLTAGE};
 
    /* Always check always if database entry has been updated within the last 100ms */
    uint32_t timeDifference = 100u;
 
    /* Time difference: 50ms -> true */
    databaseEntry.header.timestamp = 50u;
    OS_GetTickCount_ExpectAndReturn(100u);
    TEST_ASSERT_TRUE(DATA_EntryUpdatedWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference: 100ms -> true, but never updated */
    databaseEntry.header.timestamp = 0u;
    OS_GetTickCount_ExpectAndReturn(100u);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference: 101ms -> false */
    databaseEntry.header.timestamp = 0u;
    OS_GetTickCount_ExpectAndReturn(101u);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference: 63ms -> true */
    databaseEntry.header.timestamp = 4937u;
    OS_GetTickCount_ExpectAndReturn(5000u);
    TEST_ASSERT_TRUE(DATA_EntryUpdatedWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference: 50ms -> true */
    databaseEntry.header.timestamp = UINT32_MAX;
    OS_GetTickCount_ExpectAndReturn(50u);
    TEST_ASSERT_TRUE(DATA_EntryUpdatedWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference: 100ms -> true */
    databaseEntry.header.timestamp = UINT32_MAX - 50u;
    OS_GetTickCount_ExpectAndReturn(49u);
    TEST_ASSERT_TRUE(DATA_EntryUpdatedWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference: 101ms -> false */
    databaseEntry.header.timestamp = UINT32_MAX - 50u;
    OS_GetTickCount_ExpectAndReturn(50u);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference: UINT32_MAX - 50 -> false */
    databaseEntry.header.timestamp = 50u;
    OS_GetTickCount_ExpectAndReturn(UINT32_MAX);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedWithinInterval(databaseEntry.header, timeDifference));
}
 
/** This function tests various inputs for database helper function
 *  #DATA_EntryUpdatedPeriodicallyWithinInterval */
void testDATA_EntryUpdatedPeriodicallyWithinInterval(void) {
    DATA_BLOCK_CELL_VOLTAGE_s databaseEntry = {.header.uniqueId = DATA_BLOCK_ID_CELL_VOLTAGE};
 
    /* Always check always if database entry has been periodically updated within the last 100ms */
    uint32_t timeDifference = 100u;
 
    /* Time difference timestamp - systick: 40ms -> true
     * Time difference timestamp - previous timestamp:  50ms -> true */
    databaseEntry.header.timestamp         = 60u;
    databaseEntry.header.previousTimestamp = 10u;
    OS_GetTickCount_ExpectAndReturn(100u);
    TEST_ASSERT_TRUE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Within time interval but never updated -> false */
    databaseEntry.header.timestamp         = 0u;
    databaseEntry.header.previousTimestamp = 0u;
    OS_GetTickCount_ExpectAndReturn(50u);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference timestamp - systick: 100ms -> true
     * Time difference timestamp - previous timestamp:  40ms -> true */
    databaseEntry.header.timestamp         = 80u;
    databaseEntry.header.previousTimestamp = 40u;
    OS_GetTickCount_ExpectAndReturn(180u);
    TEST_ASSERT_TRUE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference timestamp - systick: 101ms -> false
     * Time difference timestamp - previous timestamp:  40ms -> true */
    databaseEntry.header.timestamp         = 80u;
    databaseEntry.header.previousTimestamp = 40u;
    OS_GetTickCount_ExpectAndReturn(181);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference timestamp - systick: 50ms -> true
     * Time difference timestamp - previous timestamp:  110ms -> false */
    databaseEntry.header.timestamp         = 150u;
    databaseEntry.header.previousTimestamp = 40u;
    OS_GetTickCount_ExpectAndReturn(200u);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference timestamp - systick: 100ms -> true
     * Time difference timestamp - previous timestamp:  100ms -> true */
    databaseEntry.header.timestamp         = 150u;
    databaseEntry.header.previousTimestamp = 50u;
    OS_GetTickCount_ExpectAndReturn(250u);
    TEST_ASSERT_TRUE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference timestamp - systick: 100ms -> true
     * Time difference timestamp - previous timestamp:  100ms -> true */
    databaseEntry.header.timestamp         = UINT32_MAX - 50u;
    databaseEntry.header.previousTimestamp = UINT32_MAX - 150u;
    OS_GetTickCount_ExpectAndReturn(49u);
    TEST_ASSERT_TRUE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference timestamp - systick: 101ms -> false
     * Time difference timestamp - previous timestamp:  100ms -> true */
    databaseEntry.header.timestamp         = UINT32_MAX - 50u;
    databaseEntry.header.previousTimestamp = UINT32_MAX - 150u;
    OS_GetTickCount_ExpectAndReturn(50u);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference timestamp - systick: 100ms -> true
     * Time difference timestamp - previous timestamp:  100ms -> true */
    databaseEntry.header.timestamp         = 49u;
    databaseEntry.header.previousTimestamp = UINT32_MAX - 50u;
    OS_GetTickCount_ExpectAndReturn(150u);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference timestamp - systick: 100ms -> true
     * Time difference timestamp - previous timestamp:  101ms -> false */
    databaseEntry.header.timestamp         = UINT32_MAX - 50u;
    databaseEntry.header.previousTimestamp = UINT32_MAX - 151u;
    OS_GetTickCount_ExpectAndReturn(49u);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference timestamp - systick: 100ms -> true
     * Time difference timestamp - previous timestamp:  101ms -> false */
    databaseEntry.header.timestamp         = 50u;
    databaseEntry.header.previousTimestamp = UINT32_MAX - 50u;
    OS_GetTickCount_ExpectAndReturn(150u);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
 
    /* Time difference: UINT32_MAX - 50 -> false */
    databaseEntry.header.timestamp = 50u;
    OS_GetTickCount_ExpectAndReturn(UINT32_MAX);
    TEST_ASSERT_FALSE(DATA_EntryUpdatedPeriodicallyWithinInterval(databaseEntry.header, timeDifference));
}
 
/** This function tests various inputs for database helper function
 *  #DATA_GetStringNumberFromVoltageIndex */
void testDATA_GetStringNumberFromVoltageIndex(void) {
    /* Last cell in string 0 */
    uint16_t voltageIndex = (BS_NR_OF_CELL_BLOCKS_PER_MODULE * BS_NR_OF_MODULES_PER_STRING) - 1u;
    TEST_ASSERT_EQUAL(DATA_GetStringNumberFromVoltageIndex(voltageIndex), 0u);
 
    /* Last cell in last string */
    voltageIndex = (BS_NR_OF_CELL_BLOCKS_PER_MODULE * BS_NR_OF_MODULES_PER_STRING * BS_NR_OF_STRINGS) - 1u;
    TEST_ASSERT_EQUAL(DATA_GetStringNumberFromVoltageIndex(voltageIndex), BS_NR_OF_STRINGS - 1u);
 
    /* Test is function passes if index 0 is passed */
    TEST_ASSERT_PASS_ASSERT(DATA_GetStringNumberFromVoltageIndex(0u));
 
    /* Test is function asserts if invalid index is passed */
    TEST_ASSERT_FAIL_ASSERT(DATA_GetStringNumberFromVoltageIndex(
        BS_NR_OF_MODULES_PER_STRING * BS_NR_OF_CELL_BLOCKS_PER_MODULE * BS_NR_OF_STRINGS));
    TEST_ASSERT_FAIL_ASSERT(DATA_GetStringNumberFromVoltageIndex(UINT16_MAX));
}
 
/** This function tests various inputs for database helper function
 *  #DATA_GetModuleNumberFromVoltageIndex */
void testDATA_GetModuleNumberFromVoltageIndex(void) {
    uint16_t voltageIndex = (BS_NR_OF_CELL_BLOCKS_PER_MODULE * BS_NR_OF_MODULES_PER_STRING) - 1u;
    TEST_ASSERT_EQUAL(DATA_GetModuleNumberFromVoltageIndex(voltageIndex), BS_NR_OF_MODULES_PER_STRING - 1u);
 
    /* Test is function passes if index 0 is passed */
    TEST_ASSERT_PASS_ASSERT(DATA_GetModuleNumberFromVoltageIndex(0u));
 
    /* Test is function asserts if invalid index is passed */
    TEST_ASSERT_FAIL_ASSERT(DATA_GetModuleNumberFromVoltageIndex(
        BS_NR_OF_MODULES_PER_STRING * BS_NR_OF_CELL_BLOCKS_PER_MODULE * BS_NR_OF_STRINGS));
    TEST_ASSERT_FAIL_ASSERT(DATA_GetModuleNumberFromVoltageIndex(UINT16_MAX));
}
 
/** This function tests various inputs for database helper function
 *  #testDATA_GetCellNumberFromVoltageIndex */
void testDATA_GetCellNumberFromVoltageIndex(void) {
    for (uint8_t m = 0u; m < BS_NR_OF_MODULES_PER_STRING; m++) {
        for (uint8_t c = 0u; c < BS_NR_OF_CELL_BLOCKS_PER_MODULE; c++) {
            uint16_t voltageIndex = (m * BS_NR_OF_CELL_BLOCKS_PER_MODULE) + c;
            TEST_ASSERT_EQUAL(DATA_GetCellNumberFromVoltageIndex(voltageIndex), c);
        }
    }
 
    /* Test is function passes if index 0 is passed */
    TEST_ASSERT_PASS_ASSERT(DATA_GetCellNumberFromVoltageIndex(0u));
 
    /* Test is function asserts if invalid index is passed */
    TEST_ASSERT_FAIL_ASSERT(DATA_GetCellNumberFromVoltageIndex(
        BS_NR_OF_MODULES_PER_STRING * BS_NR_OF_CELL_BLOCKS_PER_MODULE * BS_NR_OF_STRINGS));
    TEST_ASSERT_FAIL_ASSERT(DATA_GetCellNumberFromVoltageIndex(UINT16_MAX));
}
 
/** This function tests various inputs for database helper function
 *  #DATA_GetStringNumberFromTemperatureIndex */
void testDATA_GetStringNumberFromTemperatureIndex(void) {
    /* last sensor in string 0 */
    uint16_t sensorIndex = (BS_NR_OF_TEMP_SENSORS_PER_MODULE * BS_NR_OF_MODULES_PER_STRING) - 1u;
    TEST_ASSERT_EQUAL(DATA_GetStringNumberFromTemperatureIndex(sensorIndex), 0u);
 
    /* last sensor in last string */
    sensorIndex = (BS_NR_OF_TEMP_SENSORS_PER_MODULE * BS_NR_OF_MODULES_PER_STRING * BS_NR_OF_STRINGS) - 1u;
    TEST_ASSERT_EQUAL(DATA_GetStringNumberFromTemperatureIndex(sensorIndex), BS_NR_OF_STRINGS - 1u);
 
    /* Test is function passes if index 0 is passed */
    TEST_ASSERT_PASS_ASSERT(DATA_GetStringNumberFromTemperatureIndex(0u));
 
    /* Test is function asserts if invalid index is passed */
    TEST_ASSERT_FAIL_ASSERT(DATA_GetStringNumberFromTemperatureIndex(
        BS_NR_OF_MODULES_PER_STRING * BS_NR_OF_TEMP_SENSORS_PER_MODULE * BS_NR_OF_STRINGS));
    TEST_ASSERT_FAIL_ASSERT(DATA_GetStringNumberFromTemperatureIndex(UINT16_MAX));
}
 
/** This function tests various inputs for database helper function
 *  #DATA_GetModuleNumberFromTemperatureIndex */
void testDATA_GetModuleNumberFromTemperatureIndex(void) {
    uint16_t sensorIndex = (BS_NR_OF_TEMP_SENSORS_PER_MODULE * BS_NR_OF_MODULES_PER_STRING) - 1u;
    TEST_ASSERT_EQUAL(DATA_GetModuleNumberFromTemperatureIndex(sensorIndex), BS_NR_OF_MODULES_PER_STRING - 1u);
 
    /* Test is function passes if index 0 is passed */
    TEST_ASSERT_PASS_ASSERT(DATA_GetModuleNumberFromTemperatureIndex(0u));
 
    /* Test is function asserts if invalid index is passed */
    TEST_ASSERT_FAIL_ASSERT(DATA_GetModuleNumberFromTemperatureIndex(
        BS_NR_OF_MODULES_PER_STRING * BS_NR_OF_TEMP_SENSORS_PER_MODULE * BS_NR_OF_STRINGS));
    TEST_ASSERT_FAIL_ASSERT(DATA_GetModuleNumberFromTemperatureIndex(UINT16_MAX));
}
 
/** This function tests various inputs for database helper function
 *  #DATA_GetSensorNumberFromTemperatureIndex */
void testDATA_GetSensorNumberFromTemperatureIndex(void) {
    for (uint8_t m = 0u; m < BS_NR_OF_MODULES_PER_STRING; m++) {
        for (uint8_t sensor = 0u; sensor < BS_NR_OF_TEMP_SENSORS_PER_MODULE; sensor++) {
            uint16_t sensorIndex = (m * BS_NR_OF_TEMP_SENSORS_PER_MODULE) + sensor;
            TEST_ASSERT_EQUAL(DATA_GetSensorNumberFromTemperatureIndex(sensorIndex), sensor);
        }
    }
 
    /* Test is function passes if index 0 is passed */
    TEST_ASSERT_PASS_ASSERT(DATA_GetSensorNumberFromTemperatureIndex(0u));
 
    /* Test is function asserts if invalid index is passed */
    TEST_ASSERT_FAIL_ASSERT(DATA_GetSensorNumberFromTemperatureIndex(
        BS_NR_OF_MODULES_PER_STRING * BS_NR_OF_TEMP_SENSORS_PER_MODULE * BS_NR_OF_STRINGS));
    TEST_ASSERT_FAIL_ASSERT(DATA_GetSensorNumberFromTemperatureIndex(UINT16_MAX));
}