test_contactor.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_contactor.c
 * @author  foxBMS Team
 * @date    2020-03-31 (date of creation)
 * @updated 2022-07-28 (date of last update)
 * @version v1.4.0
 * @ingroup UNIT_TEST_IMPLEMENTATION
 * @prefix  TEST
 *
 * @brief   Test of the contactor.c module
 *
 */
 
/*========== Includes =======================================================*/
#include "unity.h"
#include "Mockcontactor_cfg.h"
#include "Mockfassert.h"
#include "Mockio.h"
#include "Mockmcu.h"
#include "Mocksps.h"
#include "Mocksps_cfg.h"
 
#include "contactor.h"
#include "test_assert_helper.h"
 
/*========== Definitions and Implementations for Unit Test ==================*/
BS_STRING_PRECHARGE_PRESENT_e bs_stringsWithPrecharge[BS_NR_OF_STRINGS] = {
    BS_STRING_WITH_PRECHARGE,
};
 
CONT_CONTACTOR_STATE_s cont_contactorStates[BS_NR_OF_CONTACTORS] = {
    {CONT_SWITCH_OFF, CONT_SWITCH_OFF, CONT_FEEDBACK_THROUGH_CURRENT, 0u, CONT_STRING0_PLUS},
    {CONT_SWITCH_OFF, CONT_SWITCH_OFF, CONT_FEEDBACK_THROUGH_CURRENT, 1u, CONT_STRING0_MINUS},
    {CONT_SWITCH_OFF, CONT_SWITCH_OFF, CONT_FEEDBACK_THROUGH_CURRENT, 2u, CONT_STRING1_PLUS},
};
 
/*========== Setup and Teardown =============================================*/
void setUp(void) {
}
 
void tearDown(void) {
}
 
/*========== Test Cases =====================================================*/
void testCONT_InitializationCheckOfContactorRegistry(void) {
    /* for the test we assume every contactor channel is correctly affiliated */
    SPS_GetChannelAffiliation_IgnoreAndReturn(SPS_AFF_CONTACTOR);
    TEST_ASSERT_PASS_ASSERT(TEST_CONT_InitializationCheckOfContactorRegistry());
}
 
void testCONT_InitializationCheckOfContactorRegistryWrongAffiliation(void) {
    /* act as if a channel is wrongly affiliated */
    SPS_GetChannelAffiliation_IgnoreAndReturn(SPS_AFF_GENERAL_IO);
    TEST_ASSERT_FAIL_ASSERT(TEST_CONT_InitializationCheckOfContactorRegistry());
}
void testCONT_ResolveContactorNameExistingNamesFirst(void) {
    /* check if the name of the first entry returns the first entry of the array */
    CONT_CONTACTOR_INDEX index = 0u;
    TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL(index, TEST_CONT_ResolveContactorName(cont_contactorStates[index].name)));
}
 
void testCONT_ResolveContactorNameExistingNamesLast(void) {
    /* check if the name of the last entry returns the last entry of the array */
    CONT_CONTACTOR_INDEX index = BS_NR_OF_CONTACTORS - 1u;
    TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL(index, TEST_CONT_ResolveContactorName(cont_contactorStates[index].name)));
}
 
void testCONT_ResolveContactorNameInvalidName(void) {
    /* check if an invalid name asserts */
    TEST_ASSERT_FAIL_ASSERT(TEST_ASSERT_EQUAL(0u, TEST_CONT_ResolveContactorName(84u)));
}
 
void testCONT_SetContactorStateInvalidState(void) {
    SPS_RequestContactorState_Ignore();
 
    TEST_ASSERT_FAIL_ASSERT(CONT_SetContactorState(0u, 42u));
}
 
void testCONT_SetContactorStateInvalidContactorNumber(void) {
    SPS_RequestContactorState_Ignore();
 
    TEST_ASSERT_FAIL_ASSERT(CONT_SetContactorState(42u, CONT_SWITCH_OFF));
}
 
void testCONT_SetContactorStateCopyStates(void) {
    /* Check that every contactor is requested off when undef is used */
    for (uint8_t contactor = 0u; contactor < BS_NR_OF_CONTACTORS; contactor++) {
        /* when undef is called, channels should not be touched normally */
        SPS_RequestContactorState_Expect(contactor, SPS_CHANNEL_OFF);
        TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL(STD_NOT_OK, CONT_SetContactorState(contactor, CONT_SWITCH_UNDEF)));
    }
 
    /* Check that every contactor is requested on */
    for (uint8_t contactor = 0u; contactor < BS_NR_OF_CONTACTORS; contactor++) {
        SPS_RequestContactorState_Expect(contactor, SPS_CHANNEL_ON);
        TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL(STD_OK, CONT_SetContactorState(contactor, CONT_SWITCH_ON)));
    }
 
    /* Check that every contactor is requested off when undef is used */
    for (uint8_t contactor = 0u; contactor < BS_NR_OF_CONTACTORS; contactor++) {
        /* when undef is called, channels should not be touched normally */
        SPS_RequestContactorState_Expect(contactor, SPS_CHANNEL_ON);
        TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL(STD_NOT_OK, CONT_SetContactorState(contactor, CONT_SWITCH_UNDEF)));
    }
 
    /* Check that every contactor is requested off */
    for (uint8_t contactor = 0u; contactor < BS_NR_OF_CONTACTORS; contactor++) {
        SPS_RequestContactorState_Expect(contactor, SPS_CHANNEL_OFF);
        TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL(STD_OK, CONT_SetContactorState(contactor, CONT_SWITCH_OFF)));
    }
}