flipperzero-firmware/applications/tests/rpc/rpc_test.c
Albert Kharisov 1db29eaea8
[FL-1946] RPC App launch (#758)
* RPC: Add App start, lock status
 - Add RPC commands Application start, lock status acquiring.
 - Write tests for RPC App system.
 - Replace Unit Tests application with CLI command. This is for CI needs and for tests that run application.
* Fix NDEBUG build
* Update PB submodule
* Fix RPC print (ENABLE DEBUG PRINT!)
* snprintf -> string_t
* Fix Hard Fault (early mutex free)
* printf -> string_t, format, enable tests
* Update submodule: protobuf
* Applications: rollback unit test naming scheme.

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2021-10-13 18:39:37 +03:00

1164 lines
40 KiB
C

#include "flipper.pb.h"
#include "furi-hal-delay.h"
#include "furi/check.h"
#include "furi/record.h"
#include "pb_decode.h"
#include "rpc/rpc_i.h"
#include "storage.pb.h"
#include "storage/storage.h"
#include <furi.h>
#include "../minunit.h"
#include <stdint.h>
#include <stream_buffer.h>
#include <pb.h>
#include <pb_encode.h>
#include <m-list.h>
#include <lib/toolbox/md5.h>
#include <cli/cli.h>
#include <loader/loader.h>
LIST_DEF(MsgList, PB_Main, M_POD_OPLIST)
#define M_OPL_MsgList_t() LIST_OPLIST(MsgList)
/* MinUnit test framework doesn't allow passing context into tests,
* so we have to use global variables
*/
static Rpc* rpc = NULL;
static RpcSession* session = NULL;
static StreamBufferHandle_t output_stream = NULL;
static uint32_t command_id = 0;
#define TEST_RPC_TAG "TEST_RPC"
#define MAX_RECEIVE_OUTPUT_TIMEOUT 3000
#define MAX_NAME_LENGTH 255
#define MAX_DATA_SIZE 512 // have to be exact as in rpc_storage.c
#define TEST_DIR TEST_DIR_NAME "/"
#define TEST_DIR_NAME "/ext/unit_tests_tmp"
#define MD5SUM_SIZE 16
#define PING_REQUEST 0
#define PING_RESPONSE 1
#define WRITE_REQUEST 0
#define READ_RESPONSE 1
#define DEBUG_PRINT 0
#define BYTES(x) (x), sizeof(x)
static void output_bytes_callback(void* ctx, uint8_t* got_bytes, size_t got_size);
static void clean_directory(Storage* fs_api, const char* clean_dir);
static void
test_rpc_add_empty_to_list(MsgList_t msg_list, PB_CommandStatus status, uint32_t command_id);
static void test_rpc_encode_and_feed(MsgList_t msg_list);
static void test_rpc_encode_and_feed_one(PB_Main* request);
static void test_rpc_compare_messages(PB_Main* result, PB_Main* expected);
static void test_rpc_decode_and_compare(MsgList_t expected_msg_list);
static void test_rpc_free_msg_list(MsgList_t msg_list);
static void test_rpc_storage_setup(void) {
furi_assert(!rpc);
furi_assert(!session);
furi_assert(!output_stream);
rpc = furi_record_open("rpc");
for(int i = 0; !session && (i < 10000); ++i) {
session = rpc_open_session(rpc);
delay(1);
}
furi_assert(session);
Storage* fs_api = furi_record_open("storage");
clean_directory(fs_api, TEST_DIR_NAME);
furi_record_close("storage");
output_stream = xStreamBufferCreate(1000, 1);
mu_assert(session, "failed to start session");
rpc_set_send_bytes_callback(session, output_bytes_callback, output_stream);
}
static void test_rpc_storage_teardown(void) {
Storage* fs_api = furi_record_open("storage");
clean_directory(fs_api, TEST_DIR_NAME);
furi_record_close("storage");
rpc_close_session(session);
furi_record_close("rpc");
vStreamBufferDelete(output_stream);
++command_id;
output_stream = NULL;
rpc = NULL;
session = NULL;
}
static void clean_directory(Storage* fs_api, const char* clean_dir) {
furi_assert(fs_api);
furi_assert(clean_dir);
File* dir = storage_file_alloc(fs_api);
if(storage_dir_open(dir, clean_dir)) {
FileInfo fileinfo;
char* name = furi_alloc(MAX_NAME_LENGTH + 1);
while(storage_dir_read(dir, &fileinfo, name, MAX_NAME_LENGTH)) {
char* fullname = furi_alloc(strlen(clean_dir) + strlen(name) + 1 + 1);
sprintf(fullname, "%s/%s", clean_dir, name);
if(fileinfo.flags & FSF_DIRECTORY) {
clean_directory(fs_api, fullname);
}
storage_common_remove(fs_api, fullname);
free(fullname);
}
free(name);
} else {
FS_Error error = storage_common_mkdir(fs_api, clean_dir);
(void)error;
furi_assert(error == FSE_OK);
}
storage_dir_close(dir);
storage_file_free(dir);
}
static void test_rpc_print_message_list(MsgList_t msg_list) {
#if DEBUG_PRINT
MsgList_reverse(msg_list);
for
M_EACH(msg, msg_list, MsgList_t) {
rpc_print_message(msg);
}
MsgList_reverse(msg_list);
#endif
}
static PB_CommandStatus test_rpc_storage_get_file_error(File* file) {
FS_Error fs_error = storage_file_get_error(file);
PB_CommandStatus pb_error;
switch(fs_error) {
case FSE_OK:
pb_error = PB_CommandStatus_OK;
break;
case FSE_INVALID_NAME:
pb_error = PB_CommandStatus_ERROR_STORAGE_INVALID_NAME;
break;
case FSE_INVALID_PARAMETER:
pb_error = PB_CommandStatus_ERROR_STORAGE_INVALID_PARAMETER;
break;
case FSE_INTERNAL:
pb_error = PB_CommandStatus_ERROR_STORAGE_INTERNAL;
break;
case FSE_ALREADY_OPEN:
pb_error = PB_CommandStatus_ERROR_STORAGE_ALREADY_OPEN;
break;
case FSE_DENIED:
pb_error = PB_CommandStatus_ERROR_STORAGE_DENIED;
break;
case FSE_EXIST:
pb_error = PB_CommandStatus_ERROR_STORAGE_EXIST;
break;
case FSE_NOT_EXIST:
pb_error = PB_CommandStatus_ERROR_STORAGE_NOT_EXIST;
break;
case FSE_NOT_READY:
pb_error = PB_CommandStatus_ERROR_STORAGE_NOT_READY;
break;
case FSE_NOT_IMPLEMENTED:
pb_error = PB_CommandStatus_ERROR_STORAGE_NOT_IMPLEMENTED;
break;
default:
pb_error = PB_CommandStatus_ERROR;
break;
}
return pb_error;
}
static void output_bytes_callback(void* ctx, uint8_t* got_bytes, size_t got_size) {
StreamBufferHandle_t stream_buffer = ctx;
size_t bytes_sent = xStreamBufferSend(stream_buffer, got_bytes, got_size, osWaitForever);
(void)bytes_sent;
furi_assert(bytes_sent == got_size);
}
static void test_rpc_add_ping_to_list(MsgList_t msg_list, bool request, uint32_t command_id) {
PB_Main* response = MsgList_push_new(msg_list);
response->command_id = command_id;
response->command_status = PB_CommandStatus_OK;
response->cb_content.funcs.encode = NULL;
response->has_next = false;
response->which_content = (request == PING_REQUEST) ? PB_Main_ping_request_tag :
PB_Main_ping_response_tag;
}
static void test_rpc_create_simple_message(
PB_Main* message,
uint16_t tag,
const char* str,
uint32_t command_id) {
furi_assert(message);
furi_assert(str);
char* str_copy = furi_alloc(strlen(str) + 1);
strcpy(str_copy, str);
message->command_id = command_id;
message->command_status = PB_CommandStatus_OK;
message->cb_content.funcs.encode = NULL;
message->which_content = tag;
message->has_next = false;
switch(tag) {
case PB_Main_storage_list_request_tag:
message->content.storage_list_request.path = str_copy;
break;
case PB_Main_storage_mkdir_request_tag:
message->content.storage_mkdir_request.path = str_copy;
break;
case PB_Main_storage_read_request_tag:
message->content.storage_read_request.path = str_copy;
break;
case PB_Main_storage_delete_request_tag:
message->content.storage_delete_request.path = str_copy;
break;
case PB_Main_storage_md5sum_request_tag:
message->content.storage_md5sum_request.path = str_copy;
break;
case PB_Main_storage_md5sum_response_tag: {
char* md5sum = message->content.storage_md5sum_response.md5sum;
size_t md5sum_size = sizeof(message->content.storage_md5sum_response.md5sum);
furi_assert((strlen(str) + 1) <= md5sum_size);
memcpy(md5sum, str_copy, md5sum_size);
free(str_copy);
break;
}
default:
furi_assert(0);
break;
}
}
static void test_rpc_add_read_or_write_to_list(
MsgList_t msg_list,
bool write,
const char* path,
const uint8_t* pattern,
size_t pattern_size,
size_t pattern_repeats,
uint32_t command_id) {
furi_assert(pattern_repeats > 0);
do {
PB_Main* request = MsgList_push_new(msg_list);
PB_Storage_File* msg_file = NULL;
request->command_id = command_id;
request->command_status = PB_CommandStatus_OK;
if(write == WRITE_REQUEST) {
size_t path_size = strlen(path) + 1;
request->content.storage_write_request.path = furi_alloc(path_size);
strncpy(request->content.storage_write_request.path, path, path_size);
request->which_content = PB_Main_storage_write_request_tag;
request->content.storage_write_request.has_file = true;
msg_file = &request->content.storage_write_request.file;
} else {
request->which_content = PB_Main_storage_read_response_tag;
request->content.storage_read_response.has_file = true;
msg_file = &request->content.storage_read_response.file;
}
msg_file->data = furi_alloc(PB_BYTES_ARRAY_T_ALLOCSIZE(pattern_size));
msg_file->data->size = pattern_size;
memcpy(msg_file->data->bytes, pattern, pattern_size);
--pattern_repeats;
request->has_next = (pattern_repeats > 0);
} while(pattern_repeats);
}
static void test_rpc_encode_and_feed_one(PB_Main* request) {
furi_assert(request);
pb_ostream_t ostream = PB_OSTREAM_SIZING;
bool result = pb_encode_ex(&ostream, &PB_Main_msg, request, PB_ENCODE_DELIMITED);
furi_check(result && ostream.bytes_written);
uint8_t* buffer = furi_alloc(ostream.bytes_written);
ostream = pb_ostream_from_buffer(buffer, ostream.bytes_written);
pb_encode_ex(&ostream, &PB_Main_msg, request, PB_ENCODE_DELIMITED);
size_t bytes_left = ostream.bytes_written;
uint8_t* buffer_ptr = buffer;
do {
size_t bytes_sent = rpc_feed_bytes(session, buffer_ptr, bytes_left, 1000);
mu_check(bytes_sent > 0);
bytes_left -= bytes_sent;
buffer_ptr += bytes_sent;
} while(bytes_left);
free(buffer);
pb_release(&PB_Main_msg, request);
}
static void test_rpc_encode_and_feed(MsgList_t msg_list) {
MsgList_reverse(msg_list);
for
M_EACH(request, msg_list, MsgList_t) {
test_rpc_encode_and_feed_one(request);
}
MsgList_reverse(msg_list);
}
static void
test_rpc_compare_file(PB_Storage_File* result_msg_file, PB_Storage_File* expected_msg_file) {
mu_check(!result_msg_file->name == !expected_msg_file->name);
if(result_msg_file->name) {
mu_check(!strcmp(result_msg_file->name, expected_msg_file->name));
}
mu_check(result_msg_file->size == expected_msg_file->size);
mu_check(result_msg_file->type == expected_msg_file->type);
mu_check(!result_msg_file->data == !expected_msg_file->data);
mu_check(result_msg_file->data->size == expected_msg_file->data->size);
for(int i = 0; i < result_msg_file->data->size; ++i) {
mu_check(result_msg_file->data->bytes[i] == expected_msg_file->data->bytes[i]);
}
}
static void test_rpc_compare_messages(PB_Main* result, PB_Main* expected) {
mu_check(result->command_id == expected->command_id);
mu_check(result->command_status == expected->command_status);
mu_check(result->has_next == expected->has_next);
mu_check(result->which_content == expected->which_content);
if(result->command_status != PB_CommandStatus_OK) {
mu_check(result->which_content == PB_Main_empty_tag);
}
switch(result->which_content) {
case PB_Main_empty_tag:
case PB_Main_ping_response_tag:
/* nothing to check */
break;
case PB_Main_ping_request_tag:
case PB_Main_storage_list_request_tag:
case PB_Main_storage_read_request_tag:
case PB_Main_storage_write_request_tag:
case PB_Main_storage_delete_request_tag:
case PB_Main_storage_mkdir_request_tag:
case PB_Main_storage_md5sum_request_tag:
/* rpc doesn't send it */
mu_check(0);
break;
case PB_Main_app_lock_status_response_tag: {
bool result_locked = result->content.app_lock_status_response.locked;
bool expected_locked = expected->content.app_lock_status_response.locked;
mu_check(result_locked == expected_locked);
break;
}
case PB_Main_storage_read_response_tag: {
bool result_has_msg_file = result->content.storage_read_response.has_file;
bool expected_has_msg_file = expected->content.storage_read_response.has_file;
mu_check(result_has_msg_file == expected_has_msg_file);
if(result_has_msg_file) {
PB_Storage_File* result_msg_file = &result->content.storage_read_response.file;
PB_Storage_File* expected_msg_file = &expected->content.storage_read_response.file;
test_rpc_compare_file(result_msg_file, expected_msg_file);
} else {
mu_check(0);
}
} break;
case PB_Main_storage_list_response_tag: {
size_t expected_msg_files = expected->content.storage_list_response.file_count;
size_t result_msg_files = result->content.storage_list_response.file_count;
mu_check(result_msg_files == expected_msg_files);
for(int i = 0; i < expected_msg_files; ++i) {
PB_Storage_File* result_msg_file = &result->content.storage_list_response.file[i];
PB_Storage_File* expected_msg_file = &expected->content.storage_list_response.file[i];
test_rpc_compare_file(result_msg_file, expected_msg_file);
}
break;
}
case PB_Main_storage_md5sum_response_tag: {
char* result_md5sum = result->content.storage_md5sum_response.md5sum;
char* expected_md5sum = expected->content.storage_md5sum_response.md5sum;
mu_check(!strcmp(result_md5sum, expected_md5sum));
break;
}
default:
furi_assert(0);
break;
}
}
static bool test_rpc_pb_stream_read(pb_istream_t* istream, pb_byte_t* buf, size_t count) {
StreamBufferHandle_t stream_buffer = istream->state;
size_t bytes_received = 0;
bytes_received = xStreamBufferReceive(stream_buffer, buf, count, MAX_RECEIVE_OUTPUT_TIMEOUT);
return (count == bytes_received);
}
static void test_rpc_storage_list_create_expected_list(
MsgList_t msg_list,
const char* path,
uint32_t command_id) {
Storage* fs_api = furi_record_open("storage");
File* dir = storage_file_alloc(fs_api);
PB_Main response = {
.command_id = command_id,
.has_next = false,
.which_content = PB_Main_storage_list_request_tag,
/* other fields (e.g. msg_files ptrs) explicitly initialized by 0 */
};
PB_Storage_ListResponse* list = &response.content.storage_list_response;
response.which_content = PB_Main_storage_list_response_tag;
bool finish = false;
int i = 0;
if(storage_dir_open(dir, path)) {
response.command_status = PB_CommandStatus_OK;
} else {
response.command_status = test_rpc_storage_get_file_error(dir);
response.which_content = PB_Main_empty_tag;
finish = true;
}
while(!finish) {
FileInfo fileinfo;
char* name = furi_alloc(MAX_NAME_LENGTH + 1);
if(storage_dir_read(dir, &fileinfo, name, MAX_NAME_LENGTH)) {
if(i == COUNT_OF(list->file)) {
list->file_count = i;
response.has_next = true;
MsgList_push_back(msg_list, response);
i = 0;
}
list->file[i].type = (fileinfo.flags & FSF_DIRECTORY) ? PB_Storage_File_FileType_DIR :
PB_Storage_File_FileType_FILE;
list->file[i].size = fileinfo.size;
list->file[i].data = NULL;
/* memory free inside rpc_encode_and_send() -> pb_release() */
list->file[i].name = name;
++i;
} else {
finish = true;
free(name);
}
}
list->file_count = i;
response.has_next = false;
MsgList_push_back(msg_list, response);
storage_dir_close(dir);
storage_file_free(dir);
furi_record_close("storage");
}
static void test_rpc_decode_and_compare(MsgList_t expected_msg_list) {
furi_assert(!MsgList_empty_p(expected_msg_list));
pb_istream_t istream = {
.callback = test_rpc_pb_stream_read,
.state = output_stream,
.errmsg = NULL,
.bytes_left = 0x7FFFFFFF,
};
/* other fields explicitly initialized by 0 */
PB_Main result = {.cb_content.funcs.decode = NULL};
/* mlib adds msg_files into start of list, so reverse it */
MsgList_reverse(expected_msg_list);
for
M_EACH(expected_msg, expected_msg_list, MsgList_t) {
if(!pb_decode_ex(&istream, &PB_Main_msg, &result, PB_DECODE_DELIMITED)) {
mu_assert(
0,
"not all expected messages decoded (maybe increase MAX_RECEIVE_OUTPUT_TIMEOUT)");
break;
}
test_rpc_compare_messages(&result, expected_msg);
pb_release(&PB_Main_msg, &result);
}
MsgList_reverse(expected_msg_list);
}
static void test_rpc_free_msg_list(MsgList_t msg_list) {
for
M_EACH(it, msg_list, MsgList_t) {
pb_release(&PB_Main_msg, it);
}
MsgList_clear(msg_list);
}
static void test_rpc_storage_list_run(const char* path, uint32_t command_id) {
PB_Main request;
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
test_rpc_create_simple_message(&request, PB_Main_storage_list_request_tag, path, command_id);
test_rpc_storage_list_create_expected_list(expected_msg_list, path, command_id);
test_rpc_encode_and_feed_one(&request);
test_rpc_decode_and_compare(expected_msg_list);
pb_release(&PB_Main_msg, &request);
test_rpc_free_msg_list(expected_msg_list);
}
MU_TEST(test_storage_list) {
test_rpc_storage_list_run("/ext/nfc", ++command_id);
test_rpc_storage_list_run("/int", ++command_id);
test_rpc_storage_list_run("/ext", ++command_id);
test_rpc_storage_list_run("/ext/irda", ++command_id);
test_rpc_storage_list_run("/ext/ibutton", ++command_id);
test_rpc_storage_list_run("/ext/lfrfid", ++command_id);
test_rpc_storage_list_run("error_path", ++command_id);
}
static void
test_rpc_add_empty_to_list(MsgList_t msg_list, PB_CommandStatus status, uint32_t command_id) {
PB_Main* response = MsgList_push_new(msg_list);
response->command_id = command_id;
response->command_status = status;
response->cb_content.funcs.encode = NULL;
response->has_next = false;
response->which_content = PB_Main_empty_tag;
}
static void test_rpc_add_read_to_list_by_reading_real_file(
MsgList_t msg_list,
const char* path,
uint32_t command_id) {
furi_assert(MsgList_empty_p(msg_list));
Storage* fs_api = furi_record_open("storage");
File* file = storage_file_alloc(fs_api);
bool result = false;
if(storage_file_open(file, path, FSAM_READ, FSOM_OPEN_EXISTING)) {
size_t size_left = storage_file_size(file);
do {
PB_Main* response = MsgList_push_new(msg_list);
response->command_id = command_id;
response->command_status = PB_CommandStatus_OK;
response->has_next = false;
response->which_content = PB_Main_storage_read_response_tag;
response->content.storage_read_response.has_file = true;
response->content.storage_read_response.file.data =
furi_alloc(PB_BYTES_ARRAY_T_ALLOCSIZE(MIN(size_left, MAX_DATA_SIZE)));
uint8_t* buffer = response->content.storage_read_response.file.data->bytes;
uint16_t* read_size_msg = &response->content.storage_read_response.file.data->size;
size_t read_size = MIN(size_left, MAX_DATA_SIZE);
*read_size_msg = storage_file_read(file, buffer, read_size);
size_left -= read_size;
result = (*read_size_msg == read_size);
if(result) {
response->has_next = (size_left > 0);
}
} while((size_left != 0) && result);
if(!result) {
test_rpc_add_empty_to_list(
msg_list, test_rpc_storage_get_file_error(file), command_id);
}
} else {
test_rpc_add_empty_to_list(msg_list, test_rpc_storage_get_file_error(file), command_id);
}
storage_file_close(file);
storage_file_free(file);
furi_record_close("storage");
}
static void test_storage_read_run(const char* path, uint32_t command_id) {
PB_Main request;
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
test_rpc_add_read_to_list_by_reading_real_file(expected_msg_list, path, command_id);
test_rpc_create_simple_message(&request, PB_Main_storage_read_request_tag, path, command_id);
test_rpc_encode_and_feed_one(&request);
test_rpc_decode_and_compare(expected_msg_list);
pb_release(&PB_Main_msg, &request);
test_rpc_free_msg_list(expected_msg_list);
}
static void test_create_dir(const char* path) {
Storage* fs_api = furi_record_open("storage");
FS_Error error = storage_common_mkdir(fs_api, path);
(void)error;
furi_assert((error == FSE_OK) || (error == FSE_EXIST));
furi_record_close("storage");
}
static void test_create_file(const char* path, size_t size) {
Storage* fs_api = furi_record_open("storage");
File* file = storage_file_alloc(fs_api);
if(storage_file_open(file, path, FSAM_WRITE, FSOM_CREATE_ALWAYS)) {
uint8_t buf[128] = {0};
for(int i = 0; i < sizeof(buf); ++i) {
buf[i] = '0' + (i % 10);
}
while(size) {
size_t written = storage_file_write(file, buf, MIN(size, sizeof(buf)));
furi_assert(written);
size -= written;
}
}
storage_file_close(file);
storage_file_free(file);
furi_record_close("storage");
}
MU_TEST(test_storage_read) {
test_create_file(TEST_DIR "empty.txt", 0);
test_create_file(TEST_DIR "file1.txt", 1);
test_create_file(TEST_DIR "file2.txt", MAX_DATA_SIZE);
test_create_file(TEST_DIR "file3.txt", MAX_DATA_SIZE + 1);
test_create_file(TEST_DIR "file4.txt", (MAX_DATA_SIZE * 2) + 1);
test_storage_read_run(TEST_DIR "empty.txt", ++command_id);
test_storage_read_run(TEST_DIR "file1.txt", ++command_id);
test_storage_read_run(TEST_DIR "file2.txt", ++command_id);
test_storage_read_run(TEST_DIR "file3.txt", ++command_id);
test_storage_read_run(TEST_DIR "file4.txt", ++command_id);
}
static void test_storage_write_run(
const char* path,
size_t write_size,
size_t write_count,
uint32_t command_id,
PB_CommandStatus status) {
MsgList_t input_msg_list;
MsgList_init(input_msg_list);
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
uint8_t* buf = furi_alloc(write_size);
for(int i = 0; i < write_size; ++i) {
buf[i] = '0' + (i % 10);
}
test_rpc_add_read_or_write_to_list(
input_msg_list, WRITE_REQUEST, path, buf, write_size, write_count, command_id);
test_rpc_add_empty_to_list(expected_msg_list, status, command_id);
test_rpc_encode_and_feed(input_msg_list);
test_rpc_decode_and_compare(expected_msg_list);
test_rpc_free_msg_list(input_msg_list);
test_rpc_free_msg_list(expected_msg_list);
free(buf);
}
static void test_storage_write_read_run(
const char* path,
const uint8_t* pattern,
size_t pattern_size,
size_t pattern_repeats,
uint32_t* command_id) {
MsgList_t input_msg_list;
MsgList_init(input_msg_list);
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
test_rpc_add_read_or_write_to_list(
input_msg_list, WRITE_REQUEST, path, pattern, pattern_size, pattern_repeats, ++*command_id);
test_rpc_add_empty_to_list(expected_msg_list, PB_CommandStatus_OK, *command_id);
test_rpc_create_simple_message(
MsgList_push_raw(input_msg_list), PB_Main_storage_read_request_tag, path, ++*command_id);
test_rpc_add_read_or_write_to_list(
expected_msg_list,
READ_RESPONSE,
path,
pattern,
pattern_size,
pattern_repeats,
*command_id);
test_rpc_print_message_list(input_msg_list);
test_rpc_print_message_list(expected_msg_list);
test_rpc_encode_and_feed(input_msg_list);
test_rpc_decode_and_compare(expected_msg_list);
test_rpc_free_msg_list(input_msg_list);
test_rpc_free_msg_list(expected_msg_list);
}
MU_TEST(test_storage_write_read) {
uint8_t pattern1[] = "abcdefgh";
test_storage_write_read_run(TEST_DIR "test1.txt", pattern1, sizeof(pattern1), 1, &command_id);
test_storage_write_read_run(TEST_DIR "test2.txt", pattern1, 1, 1, &command_id);
test_storage_write_read_run(TEST_DIR "test3.txt", pattern1, 0, 1, &command_id);
}
MU_TEST(test_storage_write) {
test_storage_write_run(
TEST_DIR "afaefo/aefaef/aef/aef/test1.txt",
1,
1,
++command_id,
PB_CommandStatus_ERROR_STORAGE_NOT_EXIST);
test_storage_write_run(TEST_DIR "test1.txt", 100, 1, ++command_id, PB_CommandStatus_OK);
test_storage_write_run(TEST_DIR "test2.txt", 100, 3, ++command_id, PB_CommandStatus_OK);
test_storage_write_run(TEST_DIR "test1.txt", 100, 3, ++command_id, PB_CommandStatus_OK);
test_storage_write_run(TEST_DIR "test2.txt", 100, 3, ++command_id, PB_CommandStatus_OK);
test_storage_write_run(
TEST_DIR "afaefo/aefaef/aef/aef/test1.txt",
1,
1,
++command_id,
PB_CommandStatus_ERROR_STORAGE_NOT_EXIST);
test_storage_write_run(TEST_DIR "test2.txt", 1, 50, ++command_id, PB_CommandStatus_OK);
test_storage_write_run(TEST_DIR "test2.txt", 512, 3, ++command_id, PB_CommandStatus_OK);
}
MU_TEST(test_storage_interrupt_continuous_same_system) {
MsgList_t input_msg_list;
MsgList_init(input_msg_list);
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
uint8_t pattern[16] = {0};
test_rpc_add_read_or_write_to_list(
input_msg_list,
WRITE_REQUEST,
TEST_DIR "test1.txt",
pattern,
sizeof(pattern),
3,
command_id);
/* replace last packet (has_next == false) with another command */
PB_Main message_to_remove;
MsgList_pop_back(&message_to_remove, input_msg_list);
pb_release(&PB_Main_msg, &message_to_remove);
test_rpc_create_simple_message(
MsgList_push_new(input_msg_list),
PB_Main_storage_mkdir_request_tag,
TEST_DIR "dir1",
command_id + 1);
test_rpc_add_read_or_write_to_list(
input_msg_list,
WRITE_REQUEST,
TEST_DIR "test2.txt",
pattern,
sizeof(pattern),
3,
command_id);
test_rpc_add_empty_to_list(
expected_msg_list, PB_CommandStatus_ERROR_CONTINUOUS_COMMAND_INTERRUPTED, command_id);
test_rpc_add_empty_to_list(expected_msg_list, PB_CommandStatus_OK, command_id + 1);
test_rpc_encode_and_feed(input_msg_list);
test_rpc_decode_and_compare(expected_msg_list);
test_rpc_free_msg_list(input_msg_list);
test_rpc_free_msg_list(expected_msg_list);
}
MU_TEST(test_storage_interrupt_continuous_another_system) {
MsgList_t input_msg_list;
MsgList_init(input_msg_list);
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
uint8_t pattern[16] = {0};
test_rpc_add_read_or_write_to_list(
input_msg_list,
WRITE_REQUEST,
TEST_DIR "test1.txt",
pattern,
sizeof(pattern),
3,
command_id);
PB_Main message = {
.command_id = command_id + 1,
.command_status = PB_CommandStatus_OK,
.cb_content.funcs.encode = NULL,
.has_next = false,
.which_content = PB_Main_ping_request_tag,
};
MsgList_it_t it;
MsgList_it(it, input_msg_list);
MsgList_next(it);
MsgList_insert(input_msg_list, it, message);
test_rpc_add_read_or_write_to_list(
input_msg_list,
WRITE_REQUEST,
TEST_DIR "test2.txt",
pattern,
sizeof(pattern),
3,
command_id + 2);
test_rpc_add_ping_to_list(expected_msg_list, PING_RESPONSE, command_id + 1);
test_rpc_add_empty_to_list(expected_msg_list, PB_CommandStatus_OK, command_id);
test_rpc_add_empty_to_list(expected_msg_list, PB_CommandStatus_OK, command_id + 2);
test_rpc_encode_and_feed(input_msg_list);
test_rpc_decode_and_compare(expected_msg_list);
test_rpc_free_msg_list(input_msg_list);
test_rpc_free_msg_list(expected_msg_list);
}
static void test_storage_delete_run(const char* path, size_t command_id, PB_CommandStatus status) {
PB_Main request;
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
test_rpc_create_simple_message(&request, PB_Main_storage_delete_request_tag, path, command_id);
test_rpc_add_empty_to_list(expected_msg_list, status, command_id);
test_rpc_encode_and_feed_one(&request);
test_rpc_decode_and_compare(expected_msg_list);
pb_release(&PB_Main_msg, &request);
test_rpc_free_msg_list(expected_msg_list);
}
MU_TEST(test_storage_delete) {
test_create_file(TEST_DIR "empty.txt", 0);
test_storage_delete_run(TEST_DIR "empty.txt", ++command_id, PB_CommandStatus_OK);
test_storage_delete_run(
TEST_DIR "empty.txt", ++command_id, PB_CommandStatus_ERROR_STORAGE_NOT_EXIST);
test_create_dir(TEST_DIR "dir1");
test_storage_delete_run(TEST_DIR "dir1", ++command_id, PB_CommandStatus_OK);
test_storage_delete_run(
TEST_DIR "dir1", ++command_id, PB_CommandStatus_ERROR_STORAGE_NOT_EXIST);
}
static void test_storage_mkdir_run(const char* path, size_t command_id, PB_CommandStatus status) {
PB_Main request;
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
test_rpc_create_simple_message(&request, PB_Main_storage_mkdir_request_tag, path, command_id);
test_rpc_add_empty_to_list(expected_msg_list, status, command_id);
test_rpc_encode_and_feed_one(&request);
test_rpc_decode_and_compare(expected_msg_list);
pb_release(&PB_Main_msg, &request);
test_rpc_free_msg_list(expected_msg_list);
}
MU_TEST(test_storage_mkdir) {
test_storage_mkdir_run(TEST_DIR "dir1", ++command_id, PB_CommandStatus_OK);
test_storage_mkdir_run(TEST_DIR "dir1", ++command_id, PB_CommandStatus_ERROR_STORAGE_EXIST);
test_create_dir(TEST_DIR "dir2");
test_storage_mkdir_run(TEST_DIR "dir2", ++command_id, PB_CommandStatus_ERROR_STORAGE_EXIST);
Storage* fs_api = furi_record_open("storage");
FS_Error error = storage_common_remove(fs_api, TEST_DIR "dir1");
(void)error;
furi_assert(error == FSE_OK);
furi_record_close("storage");
test_storage_mkdir_run(TEST_DIR "dir1", ++command_id, PB_CommandStatus_OK);
}
static void test_storage_calculate_md5sum(const char* path, char* md5sum) {
Storage* api = furi_record_open("storage");
File* file = storage_file_alloc(api);
if(storage_file_open(file, path, FSAM_READ, FSOM_OPEN_EXISTING)) {
const uint16_t once_read_size = 512;
const uint8_t hash_size = MD5SUM_SIZE;
uint8_t* data = malloc(once_read_size);
uint8_t* hash = malloc(sizeof(uint8_t) * hash_size);
md5_context* md5_ctx = malloc(sizeof(md5_context));
md5_starts(md5_ctx);
while(true) {
uint16_t read_size = storage_file_read(file, data, once_read_size);
if(read_size == 0) break;
md5_update(md5_ctx, data, read_size);
}
md5_finish(md5_ctx, hash);
free(md5_ctx);
for(uint8_t i = 0; i < hash_size; i++) {
md5sum += sprintf(md5sum, "%02x", hash[i]);
}
free(hash);
free(data);
} else {
furi_assert(0);
}
storage_file_close(file);
storage_file_free(file);
furi_record_close("storage");
}
static void test_storage_md5sum_run(
const char* path,
uint32_t command_id,
const char* md5sum,
PB_CommandStatus status) {
PB_Main request;
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
test_rpc_create_simple_message(&request, PB_Main_storage_md5sum_request_tag, path, command_id);
if(status == PB_CommandStatus_OK) {
PB_Main* response = MsgList_push_new(expected_msg_list);
test_rpc_create_simple_message(
response, PB_Main_storage_md5sum_response_tag, md5sum, command_id);
response->command_status = status;
} else {
test_rpc_add_empty_to_list(expected_msg_list, status, command_id);
}
test_rpc_encode_and_feed_one(&request);
test_rpc_decode_and_compare(expected_msg_list);
pb_release(&PB_Main_msg, &request);
test_rpc_free_msg_list(expected_msg_list);
}
MU_TEST(test_storage_md5sum) {
char md5sum1[MD5SUM_SIZE * 2 + 1] = {0};
char md5sum2[MD5SUM_SIZE * 2 + 1] = {0};
char md5sum3[MD5SUM_SIZE * 2 + 1] = {0};
test_storage_md5sum_run(
TEST_DIR "test1.txt", ++command_id, "", PB_CommandStatus_ERROR_STORAGE_NOT_EXIST);
test_create_file(TEST_DIR "file1.txt", 0);
test_create_file(TEST_DIR "file2.txt", 1);
test_create_file(TEST_DIR "file3.txt", 512);
test_storage_calculate_md5sum(TEST_DIR "file1.txt", md5sum1);
test_storage_calculate_md5sum(TEST_DIR "file2.txt", md5sum2);
test_storage_calculate_md5sum(TEST_DIR "file3.txt", md5sum3);
test_storage_md5sum_run(TEST_DIR "file1.txt", ++command_id, md5sum1, PB_CommandStatus_OK);
test_storage_md5sum_run(TEST_DIR "file1.txt", ++command_id, md5sum1, PB_CommandStatus_OK);
test_storage_md5sum_run(TEST_DIR "file2.txt", ++command_id, md5sum2, PB_CommandStatus_OK);
test_storage_md5sum_run(TEST_DIR "file2.txt", ++command_id, md5sum2, PB_CommandStatus_OK);
test_storage_md5sum_run(TEST_DIR "file3.txt", ++command_id, md5sum3, PB_CommandStatus_OK);
test_storage_md5sum_run(TEST_DIR "file3.txt", ++command_id, md5sum3, PB_CommandStatus_OK);
test_storage_md5sum_run(TEST_DIR "file2.txt", ++command_id, md5sum2, PB_CommandStatus_OK);
test_storage_md5sum_run(TEST_DIR "file3.txt", ++command_id, md5sum3, PB_CommandStatus_OK);
test_storage_md5sum_run(TEST_DIR "file1.txt", ++command_id, md5sum1, PB_CommandStatus_OK);
test_storage_md5sum_run(TEST_DIR "file2.txt", ++command_id, md5sum2, PB_CommandStatus_OK);
}
MU_TEST(test_ping) {
MsgList_t input_msg_list;
MsgList_init(input_msg_list);
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
test_rpc_add_ping_to_list(input_msg_list, PING_REQUEST, 0);
test_rpc_add_ping_to_list(input_msg_list, PING_REQUEST, 1);
test_rpc_add_ping_to_list(input_msg_list, PING_REQUEST, 0);
test_rpc_add_ping_to_list(input_msg_list, PING_REQUEST, 500);
test_rpc_add_ping_to_list(input_msg_list, PING_REQUEST, (uint32_t)-1);
test_rpc_add_ping_to_list(input_msg_list, PING_REQUEST, 700);
test_rpc_add_ping_to_list(input_msg_list, PING_REQUEST, 1);
test_rpc_add_ping_to_list(expected_msg_list, PING_RESPONSE, 0);
test_rpc_add_ping_to_list(expected_msg_list, PING_RESPONSE, 1);
test_rpc_add_ping_to_list(expected_msg_list, PING_RESPONSE, 0);
test_rpc_add_ping_to_list(expected_msg_list, PING_RESPONSE, 500);
test_rpc_add_ping_to_list(expected_msg_list, PING_RESPONSE, (uint32_t)-1);
test_rpc_add_ping_to_list(expected_msg_list, PING_RESPONSE, 700);
test_rpc_add_ping_to_list(expected_msg_list, PING_RESPONSE, 1);
test_rpc_encode_and_feed(input_msg_list);
test_rpc_decode_and_compare(expected_msg_list);
test_rpc_free_msg_list(input_msg_list);
test_rpc_free_msg_list(expected_msg_list);
}
// TODO: 1) test for rubbish data
// 2) test for unexpected end of packet
// 3) test for one push of several packets
// 4) test for fill buffer till end (great varint) and close connection
MU_TEST_SUITE(test_rpc_status) {
MU_SUITE_CONFIGURE(&test_rpc_storage_setup, &test_rpc_storage_teardown);
MU_RUN_TEST(test_ping);
}
MU_TEST_SUITE(test_rpc_storage) {
MU_SUITE_CONFIGURE(&test_rpc_storage_setup, &test_rpc_storage_teardown);
MU_RUN_TEST(test_storage_list);
MU_RUN_TEST(test_storage_read);
MU_RUN_TEST(test_storage_write_read);
MU_RUN_TEST(test_storage_write);
MU_RUN_TEST(test_storage_delete);
MU_RUN_TEST(test_storage_mkdir);
MU_RUN_TEST(test_storage_md5sum);
MU_RUN_TEST(test_storage_interrupt_continuous_same_system);
MU_RUN_TEST(test_storage_interrupt_continuous_another_system);
}
static void test_app_create_request(
PB_Main* request,
const char* app_name,
const char* app_args,
uint32_t command_id) {
request->command_id = command_id;
request->command_status = PB_CommandStatus_OK;
request->cb_content.funcs.encode = NULL;
request->which_content = PB_Main_app_start_tag;
request->has_next = false;
if(app_name) {
char* msg_app_name = furi_alloc(strlen(app_name) + 1);
strcpy(msg_app_name, app_name);
request->content.app_start.name = msg_app_name;
} else {
request->content.app_start.name = NULL;
}
if(app_args) {
char* msg_app_args = furi_alloc(strlen(app_args) + 1);
strcpy(msg_app_args, app_args);
request->content.app_start.args = msg_app_args;
} else {
request->content.app_start.args = NULL;
}
}
static void test_app_start_run(
const char* app_name,
const char* app_args,
PB_CommandStatus status,
uint32_t command_id) {
PB_Main request;
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
test_app_create_request(&request, app_name, app_args, command_id);
test_rpc_add_empty_to_list(expected_msg_list, status, command_id);
test_rpc_encode_and_feed_one(&request);
test_rpc_decode_and_compare(expected_msg_list);
pb_release(&PB_Main_msg, &request);
test_rpc_free_msg_list(expected_msg_list);
}
static void test_app_get_status_lock_run(bool locked_expected, uint32_t command_id) {
PB_Main request = {
.command_id = command_id,
.command_status = PB_CommandStatus_OK,
.which_content = PB_Main_app_lock_status_request_tag,
.has_next = false,
};
MsgList_t expected_msg_list;
MsgList_init(expected_msg_list);
PB_Main* response = MsgList_push_new(expected_msg_list);
response->command_id = command_id;
response->command_status = PB_CommandStatus_OK;
response->which_content = PB_Main_app_lock_status_response_tag;
response->has_next = false;
response->content.app_lock_status_response.locked = locked_expected;
test_rpc_encode_and_feed_one(&request);
test_rpc_decode_and_compare(expected_msg_list);
pb_release(&PB_Main_msg, &request);
test_rpc_free_msg_list(expected_msg_list);
}
MU_TEST(test_app_start_and_lock_status) {
test_app_get_status_lock_run(false, ++command_id);
test_app_start_run(NULL, "/ext/file", PB_CommandStatus_ERROR_INVALID_PARAMETERS, ++command_id);
test_app_start_run(NULL, NULL, PB_CommandStatus_ERROR_INVALID_PARAMETERS, ++command_id);
test_app_get_status_lock_run(false, ++command_id);
test_app_start_run(
"skynet_destroy_world_app", NULL, PB_CommandStatus_ERROR_INVALID_PARAMETERS, ++command_id);
test_app_get_status_lock_run(false, ++command_id);
test_app_start_run("Delay Test App", "0", PB_CommandStatus_OK, ++command_id);
delay(100);
test_app_get_status_lock_run(false, ++command_id);
test_app_start_run("Delay Test App", "200", PB_CommandStatus_OK, ++command_id);
test_app_get_status_lock_run(true, ++command_id);
delay(100);
test_app_get_status_lock_run(true, ++command_id);
test_app_start_run(
"Delay Test App", "0", PB_CommandStatus_ERROR_APP_SYSTEM_LOCKED, ++command_id);
delay(200);
test_app_get_status_lock_run(false, ++command_id);
test_app_start_run("Delay Test App", "500", PB_CommandStatus_OK, ++command_id);
delay(100);
test_app_get_status_lock_run(true, ++command_id);
test_app_start_run("Infrared", "0", PB_CommandStatus_ERROR_APP_SYSTEM_LOCKED, ++command_id);
delay(100);
test_app_get_status_lock_run(true, ++command_id);
test_app_start_run(
"2_girls_1_app", "0", PB_CommandStatus_ERROR_INVALID_PARAMETERS, ++command_id);
delay(100);
test_app_get_status_lock_run(true, ++command_id);
delay(500);
test_app_get_status_lock_run(false, ++command_id);
}
MU_TEST_SUITE(test_rpc_app) {
MU_SUITE_CONFIGURE(&test_rpc_storage_setup, &test_rpc_storage_teardown);
MU_RUN_TEST(test_app_start_and_lock_status);
}
int run_minunit_test_rpc() {
MU_RUN_SUITE(test_rpc_storage);
MU_RUN_SUITE(test_rpc_status);
MU_RUN_SUITE(test_rpc_app);
MU_REPORT();
return MU_EXIT_CODE;
}
int32_t delay_test_app(void* p) {
int timeout = atoi((const char*)p);
if(timeout > 0) {
delay(timeout);
}
return 0;
}