EmbeddedProto/test/test_NestedMessage.cpp

/*
 *  Copyright (C) 2020 Embedded AMS B.V. - All Rights Reserved
 *
 *  This file is part of Embedded Proto.
 *
 *  Embedded Proto is open source software: you can redistribute it and/or 
 *  modify it under the terms of the GNU General Public License as published 
 *  by the Free Software Foundation, version 3 of the license.
 *
 *  Embedded Proto  is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Embedded Proto. If not, see <https://www.gnu.org/licenses/>.
 *
 *  For commercial and closed source application please visit:
 *  <https://EmbeddedProto.com/license/>.
 *
 *  Embedded AMS B.V.
 *  Info:
 *    info at EmbeddedProto dot com
 *
 *  Postal address:
 *    Johan Huizingalaan 763a
 *    1066 VH, Amsterdam
 *    the Netherlands
 */

#include "gtest/gtest.h"

#include <WireFormatter.h>
#include <ReadBufferMock.h>
#include <WriteBufferMock.h>
#include <Errors.h>

#include <cstdint>    
#include <limits> 

// EAMS message definitions
#include <nested_message.h>

using ::testing::_;
using ::testing::InSequence;
using ::testing::Return;
using ::testing::SetArgReferee;

namespace test_EmbeddedAMS_NestedMessage
{

constexpr uint32_t SIZE_MSG_A = 3;
constexpr uint32_t SIZE_MSG_D = 5;

TEST(NestedMessage, serialize_zero) 
{
  // Test if a unset message results in zero bytes in the buffer.

  ::demo::space::message_b<SIZE_MSG_A> msg;
  Mocks::WriteBufferMock buffer;
  EXPECT_CALL(buffer, push(_)).Times(0);
  EXPECT_CALL(buffer, push(_,_)).Times(0);
  EXPECT_CALL(buffer, get_available_size()).Times(1).WillOnce(Return(99));

  EXPECT_EQ(::EmbeddedProto::Error::NO_ERRORS, msg.serialize(buffer));

  EXPECT_EQ(0, msg.serialized_size());
}

TEST(NestedMessage, serialize_one) 
{
  InSequence s;

  ::demo::space::message_b<SIZE_MSG_A> msg;
  Mocks::WriteBufferMock buffer;
  ON_CALL(buffer, get_size()).WillByDefault(Return(25));


  // Test if a nested message can be serialized with values set to one.
  msg.set_u(1.0F);
  msg.mutable_nested_a().add_x(1);
  msg.mutable_nested_a().set_y(1.0F);
  msg.mutable_nested_a().set_z(1);
  msg.set_v(1);

  uint8_t expected_uv[] = {0x09, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xF0, 0x3F}; // u

  for(auto e : expected_uv) {
    EXPECT_CALL(buffer, push(e)).Times(1).WillOnce(Return(true));
  }

  // When called the buffer will have enough space for the message
  EXPECT_CALL(buffer, get_available_size()).Times(1).WillOnce(Return(11));

  // tag and size of nested a
  EXPECT_CALL(buffer, push(0x12)).Times(1).WillOnce(Return(true));
  EXPECT_CALL(buffer, push(0x0A)).Times(1).WillOnce(Return(true));

  // The next call is for the repeated field x.
  EXPECT_CALL(buffer, get_available_size()).Times(1).WillOnce(Return(9));

  uint8_t expected_a[] = {0x0A, 0x01, 0x01, // x
                          0x15, 0x00, 0x00, 0x80, 0x3f, // y
                          0x18, 0x02, // z
                          0x18, 0x01};// And back to the parent message with field v.

  for(auto e : expected_a) {
    EXPECT_CALL(buffer, push(e)).Times(1).WillOnce(Return(true));
  }


  EXPECT_EQ(::EmbeddedProto::Error::NO_ERRORS, msg.serialize(buffer));

  EXPECT_EQ(23, msg.serialized_size());
}

TEST(NestedMessage, serialize_max) 
{
  InSequence s;

  ::demo::space::message_b<SIZE_MSG_A> msg;
  Mocks::WriteBufferMock buffer;

  // Test if a nested message can be serialized with values set to one.
  msg.set_u(std::numeric_limits<double>::max());
  msg.mutable_nested_a().add_x(std::numeric_limits<int32_t>::max());
  msg.mutable_nested_a().set_y(std::numeric_limits<float>::max());
  msg.mutable_nested_a().set_z(std::numeric_limits<int64_t>::max());
  msg.set_v(std::numeric_limits<int32_t>::max());

  uint8_t expected_b[] = {0x09, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xEF, 0x7F}; // u


  for(auto e : expected_b) {
    EXPECT_CALL(buffer, push(e)).Times(1).WillOnce(Return(true));
  }

  // When called the buffer will have enough space for the message
  EXPECT_CALL(buffer, get_available_size()).Times(1).WillOnce(Return(31));

  // tag and size of nested a
  EXPECT_CALL(buffer, push(0x12)).Times(1).WillOnce(Return(true));
  EXPECT_CALL(buffer, push(0x17)).Times(1).WillOnce(Return(true));

  // The next call is for the repeated field x.
  EXPECT_CALL(buffer, get_available_size()).Times(1).WillOnce(Return(11));

  uint8_t expected_a[] = {0x0A, 0x05, 0xFF, 0xFF, 0xFF, 0xFF, 0x07, // x
                          0x15, 0xFF, 0xFF, 0x7F, 0x7F, // y
                          0x18, 0xFE, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x01, // z
                          // And back to the parent message with field v.
                          0x18, 0xFF, 0xFF, 0xFF, 0xFF, 0x07};

  for(auto e : expected_a) {
    EXPECT_CALL(buffer, push(e)).Times(1).WillOnce(Return(true));
  }

  EXPECT_EQ(::EmbeddedProto::Error::NO_ERRORS, msg.serialize(buffer));

  EXPECT_EQ(40, msg.serialized_size());
}

TEST(NestedMessage, serialize_nested_in_nested_max) 
{
  InSequence s;

  ::demo::space::message_c<SIZE_MSG_A, SIZE_MSG_D> msg;
  Mocks::WriteBufferMock buffer;

  // Test if a nested message in a nested message with some data works.
  msg.mutable_nested_b().set_u(std::numeric_limits<double>::max());
  msg.mutable_nested_b().mutable_nested_a().add_x(std::numeric_limits<int32_t>::max());
  msg.mutable_nested_b().mutable_nested_a().set_y(std::numeric_limits<float>::max());
  msg.mutable_nested_b().mutable_nested_a().set_z(std::numeric_limits<int64_t>::max());
  msg.mutable_nested_b().set_v(std::numeric_limits<int32_t>::max());

  EXPECT_CALL(buffer, get_available_size()).Times(1).WillOnce(Return(42));

  uint8_t expected_b[] = {0x0A, 0x28, // tag and size of nested b
                          0x09, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xEF, 0x7F}; // u

  for(auto e : expected_b) {
    EXPECT_CALL(buffer, push(e)).Times(1).WillOnce(Return(true));
  }

  // When called the buffer will have enough space for the message
  EXPECT_CALL(buffer, get_available_size()).Times(1).WillOnce(Return(31));

  // tag and size of nested a
  EXPECT_CALL(buffer, push(0x12)).Times(1).WillOnce(Return(true));
  EXPECT_CALL(buffer, push(0x17)).Times(1).WillOnce(Return(true));

  // The next call is for the repeated field x.
  EXPECT_CALL(buffer, get_available_size()).Times(1).WillOnce(Return(11));

  uint8_t expected_a[] = {0x0A, 0x05, 0xFF, 0xFF, 0xFF, 0xFF, 0x07, // x
                          0x15, 0xFF, 0xFF, 0x7F, 0x7F, // y
                          0x18, 0xFE, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x01, // z
                          // And back to the parent message with field v.
                          0x18, 0xFF, 0xFF, 0xFF, 0xFF, 0x07};

  for(auto e : expected_a) {
    EXPECT_CALL(buffer, push(e)).Times(1).WillOnce(Return(true));
  }

  // In serializing D, even if it is not set, we check the size of the buffer.
  EXPECT_CALL(buffer, get_available_size()).Times(1).WillOnce(Return(0));

  EXPECT_EQ(::EmbeddedProto::Error::NO_ERRORS, msg.serialize(buffer));
}

TEST(NestedMessage, deserialize_one) 
{
  InSequence s;

  ::demo::space::message_b<SIZE_MSG_A> msg;
  Mocks::ReadBufferMock buffer;


  static constexpr uint32_t SIZE = 23;

  ON_CALL(buffer, get_size()).WillByDefault(Return(SIZE));

  // Test if a nested message can be deserialized with values set to one.

  uint8_t referee[SIZE] = { 0x09, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xF0, 0x3F, // u
                            0x12, 0x0A, // tag and size of nested a
                            0x0A, 0x01, 0x01, // x
                            0x15, 0x00, 0x00, 0x80, 0x3F, // y
                            0x18, 0x02, // z
                            // And back to the parent message with field v.
                            0x18, 0x01};

  for(auto r: referee) {
    EXPECT_CALL(buffer, pop(_)).Times(1).WillOnce(DoAll(SetArgReferee<0>(r), Return(true)));
  }
  EXPECT_CALL(buffer, pop(_)).Times(1).WillOnce(Return(false));

  EXPECT_EQ(::EmbeddedProto::Error::NO_ERRORS, msg.deserialize(buffer));

  EXPECT_EQ(1.0F, msg.get_u());
  EXPECT_EQ(1, msg.get_nested_a().get_x().get_length());
  EXPECT_EQ(1, msg.get_nested_a().x(0));
  EXPECT_EQ(1.0F, msg.get_nested_a().get_y());
  EXPECT_EQ(1, msg.get_nested_a().get_z());
  EXPECT_EQ(1, msg.get_v());
}

TEST(NestedMessage, deserialize_nested_in_nested_max) 
{
  InSequence s;

  ::demo::space::message_c<SIZE_MSG_A, SIZE_MSG_D> msg;
  Mocks::ReadBufferMock buffer;


  static constexpr uint32_t SIZE = 42;

  ON_CALL(buffer, get_size()).WillByDefault(Return(SIZE));

  // Test if a double nested message can be deserialized with values set to maximum.

  uint8_t referee[SIZE] = { 0x0A, 0x28, // tag and size of nested b
                            0x09, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xEF, 0x7F, // u
                            0x12, 0x17, // tag and size of nested a
                            0x0A, 0x05, 0xFF, 0xFF, 0xFF, 0xFF, 0x07, // x
                            0x15, 0xFF, 0xFF, 0x7F, 0x7F, // y
                            0x18, 0xFE, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x01, // z
                            // And back to the parent message with field v.
                            0x18, 0xFF, 0xFF, 0xFF, 0xFF, 0x07};

  for(auto r: referee) {
    EXPECT_CALL(buffer, pop(_)).Times(1).WillOnce(DoAll(SetArgReferee<0>(r), Return(true)));
  }
  EXPECT_CALL(buffer, pop(_)).Times(1).WillOnce(Return(false));

  EXPECT_EQ(::EmbeddedProto::Error::NO_ERRORS, msg.deserialize(buffer));

  EXPECT_EQ(std::numeric_limits<double>::max(), msg.get_nested_b().get_u());
  EXPECT_EQ(1, msg.get_nested_b().get_nested_a().get_x().get_length());
  EXPECT_EQ(std::numeric_limits<int32_t>::max(), msg.get_nested_b().get_nested_a().x(0));
  EXPECT_EQ(std::numeric_limits<float>::max(), msg.get_nested_b().get_nested_a().get_y());
  EXPECT_EQ(std::numeric_limits<int64_t>::max(), msg.get_nested_b().get_nested_a().get_z());
  EXPECT_EQ(std::numeric_limits<int32_t>::max(), msg.get_nested_b().get_v());
}

} // End of namespace test_EmbeddedAMS_NestedMessage