flipperzero-firmware/applications/debug/unit_tests/tests/expansion/expansion_test.c

#include "../test.h" // IWYU pragma: keep

#include <furi.h>
#include <furi_hal_random.h>

#include <expansion/expansion_protocol.h>

#define EXPANSION_TEST_GARBAGE_MAGIC      (0xB19AF)
#define EXPANSION_TEST_GARBAGE_BUF_SIZE   (0x100U)
#define EXPANSION_TEST_GARBAGE_ITERATIONS (100U)

MU_TEST(test_expansion_encoded_size) {
    ExpansionFrame frame = {};

    frame.header.type = ExpansionFrameTypeHeartbeat;
    mu_assert_int_eq(1, expansion_frame_get_encoded_size(&frame));

    frame.header.type = ExpansionFrameTypeStatus;
    mu_assert_int_eq(2, expansion_frame_get_encoded_size(&frame));

    frame.header.type = ExpansionFrameTypeBaudRate;
    mu_assert_int_eq(5, expansion_frame_get_encoded_size(&frame));

    frame.header.type = ExpansionFrameTypeControl;
    mu_assert_int_eq(2, expansion_frame_get_encoded_size(&frame));

    frame.header.type = ExpansionFrameTypeData;
    for(size_t i = 0; i <= EXPANSION_PROTOCOL_MAX_DATA_SIZE; ++i) {
        frame.content.data.size = i;
        mu_assert_int_eq(i + 2, expansion_frame_get_encoded_size(&frame));
    }
}

MU_TEST(test_expansion_remaining_size) {
    ExpansionFrame frame = {};

    size_t remaining_size;
    mu_check(expansion_frame_get_remaining_size(&frame, 0, &remaining_size));
    mu_assert_int_eq(1, remaining_size);

    frame.header.type = ExpansionFrameTypeHeartbeat;
    mu_check(expansion_frame_get_remaining_size(&frame, 0, &remaining_size));
    mu_assert_int_eq(1, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 1, &remaining_size));
    mu_assert_int_eq(0, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 100, &remaining_size));
    mu_assert_int_eq(0, remaining_size);

    frame.header.type = ExpansionFrameTypeStatus;
    mu_check(expansion_frame_get_remaining_size(&frame, 0, &remaining_size));
    mu_assert_int_eq(1, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 1, &remaining_size));
    mu_assert_int_eq(1, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 2, &remaining_size));
    mu_assert_int_eq(0, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 100, &remaining_size));
    mu_assert_int_eq(0, remaining_size);

    frame.header.type = ExpansionFrameTypeBaudRate;
    mu_check(expansion_frame_get_remaining_size(&frame, 0, &remaining_size));
    mu_assert_int_eq(1, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 1, &remaining_size));
    mu_assert_int_eq(4, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 5, &remaining_size));
    mu_assert_int_eq(0, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 100, &remaining_size));
    mu_assert_int_eq(0, remaining_size);

    frame.header.type = ExpansionFrameTypeControl;
    mu_check(expansion_frame_get_remaining_size(&frame, 0, &remaining_size));
    mu_assert_int_eq(1, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 1, &remaining_size));
    mu_assert_int_eq(1, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 2, &remaining_size));
    mu_assert_int_eq(0, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 100, &remaining_size));
    mu_assert_int_eq(0, remaining_size);

    frame.header.type = ExpansionFrameTypeData;
    frame.content.data.size = EXPANSION_PROTOCOL_MAX_DATA_SIZE;
    mu_check(expansion_frame_get_remaining_size(&frame, 0, &remaining_size));
    mu_assert_int_eq(1, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 1, &remaining_size));
    mu_assert_int_eq(1, remaining_size);
    mu_check(expansion_frame_get_remaining_size(&frame, 2, &remaining_size));
    mu_assert_int_eq(EXPANSION_PROTOCOL_MAX_DATA_SIZE, remaining_size);
    for(size_t i = 0; i <= EXPANSION_PROTOCOL_MAX_DATA_SIZE; ++i) {
        mu_check(expansion_frame_get_remaining_size(&frame, i + 2, &remaining_size));
        mu_assert_int_eq(EXPANSION_PROTOCOL_MAX_DATA_SIZE - i, remaining_size);
    }
    mu_check(expansion_frame_get_remaining_size(&frame, 100, &remaining_size));
    mu_assert_int_eq(0, remaining_size);
}

typedef struct {
    void* data_out;
    size_t size_available;
    size_t size_sent;
} TestExpansionSendStream;

static size_t test_expansion_send_callback(const uint8_t* data, size_t data_size, void* context) {
    TestExpansionSendStream* stream = context;
    const size_t size_sent = MIN(data_size, stream->size_available);

    memcpy(stream->data_out + stream->size_sent, data, size_sent);

    stream->size_available -= size_sent;
    stream->size_sent += size_sent;

    return size_sent;
}

typedef struct {
    const void* data_in;
    size_t size_available;
    size_t size_received;
} TestExpansionReceiveStream;

static size_t test_expansion_receive_callback(uint8_t* data, size_t data_size, void* context) {
    TestExpansionReceiveStream* stream = context;
    const size_t size_received = MIN(data_size, stream->size_available);

    memcpy(data, stream->data_in + stream->size_received, size_received);

    stream->size_available -= size_received;
    stream->size_received += size_received;

    return size_received;
}

MU_TEST(test_expansion_encode_decode_frame) {
    const ExpansionFrame frame_in = {
        .header.type = ExpansionFrameTypeData,
        .content.data.size = 8,
        .content.data.bytes = {0xde, 0xad, 0xbe, 0xef, 0xfe, 0xed, 0xca, 0xfe},
    };

    uint8_t encoded_data[sizeof(ExpansionFrame) + sizeof(ExpansionFrameChecksum)];
    memset(encoded_data, 0, sizeof(encoded_data));

    TestExpansionSendStream send_stream = {
        .data_out = &encoded_data,
        .size_available = sizeof(encoded_data),
        .size_sent = 0,
    };

    const size_t encoded_size = expansion_frame_get_encoded_size(&frame_in);

    mu_assert_int_eq(
        expansion_protocol_encode(&frame_in, test_expansion_send_callback, &send_stream),
        ExpansionProtocolStatusOk);
    mu_assert_int_eq(encoded_size + sizeof(ExpansionFrameChecksum), send_stream.size_sent);
    mu_assert_int_eq(
        expansion_protocol_get_checksum((const uint8_t*)&frame_in, encoded_size),
        encoded_data[encoded_size]);
    mu_assert_mem_eq(&frame_in, &encoded_data, encoded_size);

    TestExpansionReceiveStream stream = {
        .data_in = encoded_data,
        .size_available = send_stream.size_sent,
        .size_received = 0,
    };

    ExpansionFrame frame_out;

    mu_assert_int_eq(
        expansion_protocol_decode(&frame_out, test_expansion_receive_callback, &stream),
        ExpansionProtocolStatusOk);
    mu_assert_int_eq(encoded_size + sizeof(ExpansionFrameChecksum), stream.size_received);
    mu_assert_mem_eq(&frame_in, &frame_out, encoded_size);
}

MU_TEST(test_expansion_garbage_input) {
    uint8_t garbage_data[EXPANSION_TEST_GARBAGE_BUF_SIZE];
    for(uint32_t i = 0; i < EXPANSION_TEST_GARBAGE_ITERATIONS; ++i) {
        furi_hal_random_fill_buf(garbage_data, sizeof(garbage_data));
        size_t remaining_size = EXPANSION_TEST_GARBAGE_MAGIC;
        if(expansion_frame_get_remaining_size(
               (ExpansionFrame*)garbage_data, sizeof(garbage_data), &remaining_size)) {
            // If by chance the garbage data is a valid frame, then the result
            // must be 0 because the amount of data provided is more than enough
            mu_assert_int_eq(0, remaining_size);
        } else {
            // If the frame is invalid, the remaining_size parameter should be untouched
            mu_assert_int_eq(EXPANSION_TEST_GARBAGE_MAGIC, remaining_size);
        }
    }
}

MU_TEST_SUITE(test_expansion_suite) {
    MU_RUN_TEST(test_expansion_encoded_size);
    MU_RUN_TEST(test_expansion_remaining_size);
    MU_RUN_TEST(test_expansion_encode_decode_frame);
    MU_RUN_TEST(test_expansion_garbage_input);
}

int run_minunit_test_expansion(void) {
    MU_RUN_SUITE(test_expansion_suite);
    return MU_EXIT_CODE;
}

TEST_API_DEFINE(run_minunit_test_expansion)