unit_test.c File Reference

Unit test module for the production console. More...

#include "unit_test.h"
#include "interface/logging/meshx_log.h"
#include "interface/utils/meshx_shell.h"
#include "gpio_test_registry.h"

Macros
#define	UT_CMD_MIN_ARGS   4

Functions
static int	ut_command_handler (int argc, char **argv)
	Handles unit test commands by invoking the appropriate callback based on the module ID.
meshx_err_t	register_ut_command ()
	Registers the unit test (ut) command with the MeshX shell.
meshx_err_t	init_unit_test_console ()
	Initializes the unit test console using the platform shell.
meshx_err_t	register_unit_test (module_id_t module_id, module_callback_t callback)
	Register a unit test for a specific module.

Variables
static unit_test_callback_t	callback_list [MODULE_ID_MAX]

Detailed Description

Unit test module for the production console.

Copyright © 2024 - 2025 MeshX

This file contains the implementation of the unit test module for the production console. It provides functions to register unit test commands and initialize the console for production use.

Macro Definition Documentation

UT_CMD_MIN_ARGS

#define UT_CMD_MIN_ARGS   4

Function Documentation

init_unit_test_console()

meshx_err_t init_unit_test_console

(

void

)

Initializes the unit test console using the platform shell.

Initialize the unit test console.

Returns

• MESHX_SUCCESS: Success
• Other error codes: Failure

                                     {
    meshx_err_t err = meshx_shell_init();
    if (err != MESHX_SUCCESS) {
        return err;
    }
 
    err = register_ut_command();
    if (err != MESHX_SUCCESS) {
        return err;
    }
 
    // Register all GPIO subsystem tests
    err = register_all_gpio_tests();
    if (err != MESHX_SUCCESS) {
        return err;
    }
 
    return meshx_shell_start();
}

register_unit_test()

meshx_err_t register_unit_test	(	module_id_t	module_id,
		module_callback_t	callback )

Register a unit test for a specific module.

This function registers a unit test callback for the given module ID.

Parameters

[in]	module_id	The ID of the module for which the unit test is being registered.
[in]	callback	The callback function to be called for the unit test.

Returns

• MESHX_SUCCESS: Success
• MESHX_INVALID_ARG: Invalid arguments
• MESHX_FAIL: Failed to register the unit test

                                                                                  {
    if(module_id >= MODULE_ID_MAX)
        return MESHX_INVALID_ARG;
 
    callback_list[module_id].callback = callback;
    return MESHX_SUCCESS;
}

register_ut_command()

meshx_err_t register_ut_command

(

)

Registers the unit test (ut) command with the MeshX shell.

This function creates a new console command "ut" which is used for running unit tests.

Returns

• MESHX_SUCCESS: Success
• Other error codes: Failure

                                  {
    const meshx_shell_cmd_t cmd = {
        .command = "ut",
        .help = "Run unit tests",
        .hint = NULL,
        .func = ut_command_handler,
    };
    return meshx_shell_register_command(&cmd);
}

ut_command_handler()

int ut_command_handler ( int argc, char ** argv )

static

Handles unit test commands by invoking the appropriate callback based on the module ID.

This function processes unit test commands by parsing the provided arguments and invoking the corresponding callback function registered for the specified module ID.

Parameters

argc	The number of arguments passed to the command.
argv	An array of strings representing the arguments.

Returns

• MESHX_SUCCESS: If the unit test callback was successfully invoked.
• MESHX_INVALID_ARG: If the number of arguments is insufficient.
• MESHX_NOT_FOUND: If no unit test is registered for the specified module ID.

                                                     {
    for (int i = 0; i < argc; i++) {
        MESHX_LOGD(MODULE_ID_COMMON, "Raw argv[%d]: %s", i, argv[i]);
    }
 
    if (argc < UT_CMD_MIN_ARGS) {
        MESHX_LOGE(MODULE_ID_COMMON, "Insufficient arguments");
        return MESHX_INVALID_ARG;
    }
 
    int cmd_id = UT_GET_ARG(2, uint16_t, argv);
    int parsed_argc = UT_GET_ARG(3, uint16_t, argv);
    module_id_t module_id = UT_GET_ARG(1, uint16_t, argv);
    MESHX_LOGD(MODULE_ID_COMMON, "Unit Test: Params -> argc: %d, Module: %d, cmd_id: %d", parsed_argc, module_id , cmd_id);
    if (parsed_argc > (argc - UT_CMD_MIN_ARGS))
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Insufficient module arguments");
        return MESHX_INVALID_ARG;
    }
 
    for (size_t i = 0; i < parsed_argc; i++)
    {
        MESHX_LOGD(MODULE_ID_COMMON, "argv[%d]: %s", i, argv[i + UT_CMD_MIN_ARGS]);
    }
 
    if (module_id >= MODULE_ID_MAX) {
        MESHX_LOGE(MODULE_ID_COMMON, "Module ID %d unknown", module_id);
        return MESHX_INVALID_ARG;
    }
 
    if(NULL != callback_list[module_id].callback)
    {
        return callback_list[module_id].callback(cmd_id, parsed_argc, (argv + UT_CMD_MIN_ARGS));
    }
 
    MESHX_LOGE(MODULE_ID_COMMON, "No unit test registered for module ID %d", module_id);
    return MESHX_NOT_FOUND;
}

Variable Documentation

callback_list

unit_test_callback_t callback_list[MODULE_ID_MAX]

static