quantum/serial_link/tests/frame_router_tests.cpp

   1 /*
   2 The MIT License (MIT)
   3
   4 Copyright (c) 2016 Fred Sundvik
   5
   6 Permission is hereby granted, free of charge, to any person obtaining a copy
   7 of this software and associated documentation files (the "Software"), to deal
   8 in the Software without restriction, including without limitation the rights
   9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 copies of the Software, and to permit persons to whom the Software is
  11 furnished to do so, subject to the following conditions:
  12
  13 The above copyright notice and this permission notice shall be included in all
  14 copies or substantial portions of the Software.
  15
  16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22 SOFTWARE.
  23 */
  24
  25 #include "gtest/gtest.h"
  26 #include "gmock/gmock.h"
  27 #include <array>
  28 extern "C" {
  29     #include "serial_link/protocol/transport.h"
  30     #include "serial_link/protocol/byte_stuffer.h"
  31     #include "serial_link/protocol/frame_router.h"
  32 }
  33
  34 using testing::_;
  35 using testing::ElementsAreArray;
  36 using testing::Args;
  37
  38 class FrameRouter : public testing::Test {
  39 public:
  40     FrameRouter() :
  41         current_router_buffer(nullptr)
  42     {
  43         Instance = this;
  44         init_byte_stuffer();
  45     }
  46
  47     ~FrameRouter() {
  48         Instance = nullptr;
  49     }
  50
  51     void send_data(uint8_t link, const uint8_t* data, uint16_t size) {
  52         auto& buffer = current_router_buffer->send_buffers[link];
  53         std::copy(data, data + size, std::back_inserter(buffer));
  54     }
  55
  56     void receive_data(uint8_t link, uint8_t* data, uint16_t size) {
  57         int i;
  58         for(i=0;i<size;i++) {
  59             byte_stuffer_recv_byte(link, data[i]);
  60         }
  61     }
  62
  63     void activate_router(uint8_t num) {
  64         current_router_buffer = router_buffers + num;
  65         router_set_master(num==0);
  66     }
  67
  68     void simulate_transport(uint8_t from, uint8_t to) {
  69        activate_router(to);
  70        if (from > to) {
  71            receive_data(DOWN_LINK,
  72                    router_buffers[from].send_buffers[UP_LINK].data(),
  73                    router_buffers[from].send_buffers[UP_LINK].size());
  74        }
  75        else if(to > from) {
  76            receive_data(UP_LINK,
  77                    router_buffers[from].send_buffers[DOWN_LINK].data(),
  78                    router_buffers[from].send_buffers[DOWN_LINK].size());
  79        }
  80     }
  81
  82     MOCK_METHOD3(transport_recv_frame, void (uint8_t from, uint8_t* data, uint16_t size));
  83
  84     std::vector<uint8_t> received_data;
  85
  86     struct router_buffer {
  87         std::vector<uint8_t> send_buffers[2];
  88     };
  89
  90     router_buffer router_buffers[8];
  91     router_buffer* current_router_buffer;
  92
  93     static FrameRouter* Instance;
  94 };
  95
  96 FrameRouter* FrameRouter::Instance = nullptr;
  97
  98
  99 typedef struct {
 100     std::array<uint8_t, 4> data;
 101     uint8_t extra[16];
 102 } frame_buffer_t;
 103
 104
 105 extern "C" {
 106     void send_data(uint8_t link, const uint8_t* data, uint16_t size) {
 107         FrameRouter::Instance->send_data(link, data, size);
 108     }
 109
 110
 111     void transport_recv_frame(uint8_t from, uint8_t* data, uint16_t size) {
 112         FrameRouter::Instance->transport_recv_frame(from, data, size);
 113     }
 114 }
 115
 116 TEST_F(FrameRouter, master_broadcast_is_received_by_everyone) {
 117     frame_buffer_t data;
 118     data.data = {0xAB, 0x70, 0x55, 0xBB};
 119     activate_router(0);
 120     router_send_frame(0xFF, (uint8_t*)&data, 4);
 121     EXPECT_GT(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
 122     EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
 123     EXPECT_CALL(*this, transport_recv_frame(0, _, _))
 124         .With(Args<1, 2>(ElementsAreArray(data.data)));
 125     simulate_transport(0, 1);
 126     EXPECT_GT(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
 127     EXPECT_EQ(router_buffers[1].send_buffers[UP_LINK].size(), 0);
 128
 129     EXPECT_CALL(*this, transport_recv_frame(0, _, _))
 130         .With(Args<1, 2>(ElementsAreArray(data.data)));
 131     simulate_transport(1, 2);
 132     EXPECT_GT(router_buffers[2].send_buffers[DOWN_LINK].size(), 0);
 133     EXPECT_EQ(router_buffers[2].send_buffers[UP_LINK].size(), 0);
 134 }
 135
 136 TEST_F(FrameRouter, master_send_is_received_by_targets) {
 137     frame_buffer_t data;
 138     data.data = {0xAB, 0x70, 0x55, 0xBB};
 139     activate_router(0);
 140     router_send_frame((1 << 1) | (1 << 2), (uint8_t*)&data, 4);
 141     EXPECT_GT(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
 142     EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
 143
 144     simulate_transport(0, 1);
 145     EXPECT_GT(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
 146     EXPECT_EQ(router_buffers[1].send_buffers[UP_LINK].size(), 0);
 147
 148     EXPECT_CALL(*this, transport_recv_frame(0, _, _))
 149         .With(Args<1, 2>(ElementsAreArray(data.data)));
 150     simulate_transport(1, 2);
 151     EXPECT_GT(router_buffers[2].send_buffers[DOWN_LINK].size(), 0);
 152     EXPECT_EQ(router_buffers[2].send_buffers[UP_LINK].size(), 0);
 153
 154     EXPECT_CALL(*this, transport_recv_frame(0, _, _))
 155         .With(Args<1, 2>(ElementsAreArray(data.data)));
 156     simulate_transport(2, 3);
 157     EXPECT_GT(router_buffers[3].send_buffers[DOWN_LINK].size(), 0);
 158     EXPECT_EQ(router_buffers[3].send_buffers[UP_LINK].size(), 0);
 159 }
 160
 161 TEST_F(FrameRouter, first_link_sends_to_master) {
 162     frame_buffer_t data;
 163     data.data = {0xAB, 0x70, 0x55, 0xBB};
 164     activate_router(1);
 165     router_send_frame(0, (uint8_t*)&data, 4);
 166     EXPECT_GT(router_buffers[1].send_buffers[UP_LINK].size(), 0);
 167     EXPECT_EQ(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
 168
 169     EXPECT_CALL(*this, transport_recv_frame(1, _, _))
 170         .With(Args<1, 2>(ElementsAreArray(data.data)));
 171     simulate_transport(1, 0);
 172     EXPECT_EQ(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
 173     EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
 174 }
 175
 176 TEST_F(FrameRouter, second_link_sends_to_master) {
 177     frame_buffer_t data;
 178     data.data = {0xAB, 0x70, 0x55, 0xBB};
 179     activate_router(2);
 180     router_send_frame(0, (uint8_t*)&data, 4);
 181     EXPECT_GT(router_buffers[2].send_buffers[UP_LINK].size(), 0);
 182     EXPECT_EQ(router_buffers[2].send_buffers[DOWN_LINK].size(), 0);
 183
 184     simulate_transport(2, 1);
 185     EXPECT_GT(router_buffers[1].send_buffers[UP_LINK].size(), 0);
 186     EXPECT_EQ(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
 187
 188     EXPECT_CALL(*this, transport_recv_frame(2, _, _))
 189         .With(Args<1, 2>(ElementsAreArray(data.data)));
 190     simulate_transport(1, 0);
 191     EXPECT_EQ(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
 192     EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
 193 }
 194
 195 TEST_F(FrameRouter, master_sends_to_master_does_nothing) {
 196     frame_buffer_t data;
 197     data.data = {0xAB, 0x70, 0x55, 0xBB};
 198     activate_router(0);
 199     router_send_frame(0, (uint8_t*)&data, 4);
 200     EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
 201     EXPECT_EQ(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
 202 }
 203
 204 TEST_F(FrameRouter, link_sends_to_other_link_does_nothing) {
 205     frame_buffer_t data;
 206     data.data = {0xAB, 0x70, 0x55, 0xBB};
 207     activate_router(1);
 208     router_send_frame(2, (uint8_t*)&data, 4);
 209     EXPECT_EQ(router_buffers[1].send_buffers[UP_LINK].size(), 0);
 210     EXPECT_EQ(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
 211 }
 212
 213 TEST_F(FrameRouter, master_receives_on_uplink_does_nothing) {
 214     frame_buffer_t data;
 215     data.data = {0xAB, 0x70, 0x55, 0xBB};
 216     activate_router(1);
 217     router_send_frame(0, (uint8_t*)&data, 4);
 218     EXPECT_GT(router_buffers[1].send_buffers[UP_LINK].size(), 0);
 219     EXPECT_EQ(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
 220
 221     EXPECT_CALL(*this, transport_recv_frame(_, _, _))
 222         .Times(0);
 223     activate_router(0);
 224     receive_data(UP_LINK,
 225         router_buffers[1].send_buffers[UP_LINK].data(),
 226         router_buffers[1].send_buffers[UP_LINK].size());
 227     EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
 228     EXPECT_EQ(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
 229 }