Skip to content

feat: decoder.h can pick 1st available response anywhere in the buffe… #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

feat: decoder.h can pick 1st available response anywhere in the buffe… #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions examples/decoder_tests/decoder_tester.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,40 @@ class DecoderTester {

DecoderTester(RpcDecoder<>& _d): decoder(_d){}

void first_response_info() {
if (!decoder.response_queued()) {
Serial.println("No response queued");
return;
}
Serial.println("-- First response info --");
Serial.print("RESP OFFSET: ");
Serial.println(static_cast<int>(decoder._response_offset));
Serial.print("RESP SIZE: ");
Serial.println(static_cast<int>(decoder._response_size));
}

size_t get_response_size() {
return decoder._response_size;
}

size_t get_response_offset() {
return decoder._response_offset;
}

template<typename RType>
bool get_response(const uint32_t msg_id, RType& result, RpcError& error) {
return decoder.get_response(msg_id, result, error);
}

void crop_bytes(size_t size, size_t offset){
decoder.consume(size, offset);
}

void pop_first() {
uint8_t temp_buffer[512];
decoder.pop_packet(temp_buffer, 512);
}

void print_raw_buf(){

Serial.print("Decoder raw buffer content: ");
Expand Down
230 changes: 227 additions & 3 deletions examples/decoder_tests/decoder_tests.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ void runDecoderTest(const char* label) {
Serial.println("-- Done --\n");
}

void runDecoderConsumeTest(const char* label, size_t second_packet_sz) {
void runDecoderConsumeTest(const char* label, size_t expected_2nd_pack_size) {
Serial.println(label);

print_buf();
Expand All @@ -63,20 +63,184 @@ void runDecoderConsumeTest(const char* label, size_t second_packet_sz) {
delay(50);
}

dt.first_response_info();

while (!decoder.response_queued()) {
Serial.println("1st response not ready");
decoder.decode();
delay(50);
}

size_t pack_size = decoder.get_packet_size();
Serial.print("1st Packet size: ");
Serial.println(pack_size);

dt.first_response_info();

if ((dt.get_response_offset()!=pack_size)||(dt.get_response_size()!=expected_2nd_pack_size)) {
Serial.println("ERROR parsing 1st response\n");
return;
}

Serial.print("Consuming 2nd packet of given size: ");
Serial.println(dt.get_response_size());

dt.crop_bytes(dt.get_response_size(), dt.get_response_offset());

dt.print_raw_buf();

Serial.println("-- Done --\n");
}

void runDecoderPopFirstTest(const char* label, size_t expected_2nd_pack_size) {
Serial.println(label);

print_buf();
DummyTransport dummy_transport(packer.data(), packer.size());
RpcDecoder<> decoder(dummy_transport);

DecoderTester dt(decoder);

while (!decoder.packet_incoming()) {
Serial.println("Packet not ready");
decoder.decode();
delay(50);
}

while (!decoder.response_queued()) {
Serial.println("1st response not ready");
decoder.decode();
delay(50);
}

dt.first_response_info();

size_t pack_size = decoder.get_packet_size();
Serial.print("Consuming 1st Packet of size: ");
Serial.println(pack_size);
dt.pop_first();
dt.print_raw_buf();

dt.first_response_info();

if ((dt.get_response_offset()!=0)||(dt.get_response_size()!=expected_2nd_pack_size)) {
Serial.println("ERROR moving 1st response\n");
return;
}

Serial.print("Consuming 2nd packet of given size: ");
Serial.println(second_packet_sz);
Serial.println(dt.get_response_size());

dt.crop_bytes(dt.get_response_size(), dt.get_response_offset());

dt.print_raw_buf();
dt.first_response_info();

Serial.println("-- Done --\n");
}

void runDecoderGetResponseTest(const char* label, size_t expected_2nd_pack_size, int _id) {
Serial.println(label);

print_buf();
DummyTransport dummy_transport(packer.data(), packer.size());
RpcDecoder<> decoder(dummy_transport);

DecoderTester dt(decoder);

while (!decoder.packet_incoming()) {
Serial.println("Packet not ready");
decoder.decode();
delay(50);
}

dt.first_response_info();

while (!decoder.response_queued()) {
Serial.println("1st response not ready");
decoder.decode();
delay(50);
}

size_t pack_size = decoder.get_packet_size();
Serial.print("1st Packet size: ");
Serial.println(pack_size);

dt.first_response_info();

if ((dt.get_response_offset()!=pack_size)||(dt.get_response_size()!=expected_2nd_pack_size)) {
Serial.println("ERROR parsing 1st response\n");
return;
}

Serial.print("Getting response (2nd packet) size: ");
Serial.println(dt.get_response_size());

int res;
RpcError _err;
dt.get_response(_id, res, _err);

Serial.print("Result: ");
Serial.println(res);

dt.print_raw_buf();

Serial.println("-- Done --\n");
}


void runDecoderGetTopResponseTest(const char* label, size_t expected_size, int _id) {
Serial.println(label);

print_buf();
DummyTransport dummy_transport(packer.data(), packer.size());
RpcDecoder<> decoder(dummy_transport);

DecoderTester dt(decoder);

while (!decoder.packet_incoming()) {
Serial.println("Packet not ready");
decoder.decode();
delay(50);
}

dt.crop_bytes(second_packet_sz, pack_size);
dt.first_response_info();

while (!decoder.response_queued()) {
Serial.println("1st response not ready");
decoder.decode();
delay(50);
}

size_t pack_size = decoder.get_packet_size();
Serial.print("1st Packet size: ");
Serial.println(pack_size);

dt.first_response_info();

if ((dt.get_response_offset()!=0)||(dt.get_response_size()!=expected_size)) {
Serial.println("ERROR parsing 1st response\n");
return;
}

Serial.print("Getting response size: ");
Serial.println(dt.get_response_size());

int res;
RpcError _err;
dt.get_response(_id, res, _err);

Serial.print("Result: ");
Serial.println(res);

dt.print_raw_buf();

dt.first_response_info();

Serial.println("-- Done --\n");
}


void testNestedArrayRequest() {
packer.clear();
MsgPack::arr_size_t outer_arr(3);
Expand Down Expand Up @@ -166,6 +330,63 @@ void testMultipleRpcPackets() {

}

// Multiple RPCs in one buffer. Pop the 1st request and then the 2nd response
void testPopRpcPackets() {
packer.clear();
MsgPack::arr_size_t req_sz(4);
MsgPack::arr_size_t par_sz(2);
MsgPack::arr_size_t resp_sz(4);
MsgPack::object::nil_t nil;

// 1st request
packer.serialize(req_sz, 0, 1, "sum", par_sz, 10, 20);
// 2nd response
packer.serialize(resp_sz, 1, 1, nil, 42);
// 3rd request
packer.serialize(req_sz, 0, 2, "echo", par_sz, "Hello", true);

runDecoderPopFirstTest("== Test: Pop-first packet ==", 5);

}

// Multiple RPCs in one buffer. Get the response in the buffer
void testGetResponsePacket() {
packer.clear();
MsgPack::arr_size_t req_sz(4);
MsgPack::arr_size_t par_sz(2);
MsgPack::arr_size_t resp_sz(4);
MsgPack::object::nil_t nil;

// 1st request
packer.serialize(req_sz, 0, 1, "sum", par_sz, 10, 20);
// 2nd response
packer.serialize(resp_sz, 1, 1, nil, 101);
// 3rd request
packer.serialize(req_sz, 0, 2, "echo", par_sz, "Hello", true);

runDecoderGetResponseTest("== Test: Get response packet ==", 5, 1);

}

// Multiple RPCs in one buffer. The response is top of the buffer
void testGetTopResponsePacket() {
packer.clear();
MsgPack::arr_size_t req_sz(4);
MsgPack::arr_size_t par_sz(2);
MsgPack::arr_size_t resp_sz(4);
MsgPack::object::nil_t nil;

// 1st response
packer.serialize(resp_sz, 1, 1, nil, 101);
// 2nd request
packer.serialize(req_sz, 0, 2, "echo", par_sz, "Hello", true);
// 3rd request
packer.serialize(req_sz, 0, 1, "sum", par_sz, 30, 30);

runDecoderGetTopResponseTest("== Test: Get top response packet ==", 5, 1);

}

// Binary parameter (e.g., binary blob)
void testBinaryParam() {
packer.clear();
Expand Down Expand Up @@ -225,6 +446,9 @@ void setup() {
testDeepNestedStructure();
testArrayOfMapsResponse();
testMultipleRpcPackets();
testPopRpcPackets();
testGetResponsePacket();
testGetTopResponsePacket();
testBinaryParam();
testExtensionParam();
testCombinedComplexBuffer();
Expand Down
Loading