unit_test.h File Reference

Header file for the production console unit test functionality. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "meshx_config_internal.h"
#include "argtable3/argtable3.h"
#include "module_id.h"
#include "meshx_err.h"

Go to the source code of this file.

Data Structures
struct	callback_node
	Structure to hold the unit test callback function. More...

Macros
#define	UT_GET_ARG(_x, _type, _argv)
	Macro to extract an argument from the argument list.

Typedefs
typedef meshx_err_t(*	module_callback_t) (int cmd_id, int argc, char **argv)
	Callback function for unit test modules.
typedef struct callback_node	unit_test_callback_t
	Structure to hold the unit test callback function.

Functions
meshx_err_t	register_ut_command ()
	Registers the unit test (ut) command with the MeshX shell.
meshx_err_t	init_unit_test_console (void)
	Initialize the unit test console.
meshx_err_t	register_unit_test (module_id_t module_id, module_callback_t callback)
	Register a unit test for a specific module.

Detailed Description

Header file for the production console unit test functionality.

Copyright © 2024 - 2025 MeshX

This file contains the declarations and definitions for initializing the production console and registering unit test callbacks for different modules.

Macro Definition Documentation

UT_GET_ARG

#define UT_GET_ARG	(		_x,
			_type,
			_argv )

Value:

(_type) atoi( _argv [_x] )

Macro to extract an argument from the argument list.

Typedef Documentation

module_callback_t

typedef meshx_err_t(* module_callback_t) (int cmd_id, int argc, char **argv)

Callback function for unit test modules.

This function is used to define the callback function signature for unit test modules. The callback function is invoked when a unit test command is received by the production console.

Parameters

cmd_id	The command ID to be processed.
argc	The number of arguments provided.
argv	The array of arguments.

Returns

• MESHX_SUCCESS: Success
• MESHX_INVALID_ARG: Invalid arguments
• Other error codes depending on the implementation

unit_test_callback_t

typedef struct callback_node unit_test_callback_t

Structure to hold the unit test callback function.

Function Documentation

init_unit_test_console()

meshx_err_t init_unit_test_console

(

void

)

Initialize the unit test console.

This function initializes the unit test console for the application using the underlying shell.

Returns

• MESHX_SUCCESS: Success
• MESHX_FAIL: Initialization failed

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 shell command "ut" which is used for running unit tests.

Returns

• MESHX_SUCCESS: Success
• Other error codes: Failure

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);
}