File: igtlSocketTest.cxx

package info (click to toggle)
openigtlink 3.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,080 kB
  • sloc: cpp: 20,076; ansic: 6,704; sh: 227; perl: 74; makefile: 46
file content (284 lines) | stat: -rw-r--r-- 10,463 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
/*=========================================================================
 
  Program:   OpenIGTLink Library
  Language:  C++
 
  Copyright (c) Insight Software Consortium. All rights reserved.
 
  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the above copyright notices for more information.
 
  =========================================================================*/

#include "igtlServerSocket.h"
#include "igtlSocket.h"
#include "igtlMessageHeader.h"
#include "igtlClientSocket.h"
#include "igtlMultiThreader.h"
#include "igtlQuaternionTrackingDataMessage.h"

#include "igtl_types.h"
#include "igtl_header.h"
#include "igtl_util.h"
#include "igtlOSUtil.h"
#include "igtlTestConfig.h"
#include "string.h"

using ::testing::_;
using ::testing::AtLeast;
using ::testing::Invoke;
using igtl::ServerSocket;
using igtl::ClientSocket;
using igtl::Socket;
using ::testing::IsNull;


class SocketMock {
public:
  SocketMock(Socket::Pointer pointer) {
    real_ = pointer;
    // By default, all calls are delegated to the real object.
    ON_CALL(*this, GetConnected())
      .WillByDefault(Invoke(real_.GetPointer(), &Socket::GetConnected));
    ON_CALL(*this, Send(_,_))
      .WillByDefault(Invoke(real_.GetPointer(), &Socket::Send));
    ON_CALL(*this, Receive(_,_,_))
      .WillByDefault(Invoke(real_.GetPointer(), &Socket::Receive));
    ON_CALL(*this, SetTimeout(_))
      .WillByDefault(Invoke(real_.GetPointer(), &Socket::SetTimeout));
    ON_CALL(*this, SetReceiveTimeout(_))
      .WillByDefault(Invoke(real_.GetPointer(), &Socket::SetReceiveTimeout));
    ON_CALL(*this, SetSendTimeout(_))
      .WillByDefault(Invoke(real_.GetPointer(), &Socket::SetSendTimeout));
    ON_CALL(*this, SetReceiveBlocking(_))
      .WillByDefault(Invoke(real_.GetPointer(), &Socket::SetReceiveBlocking));
    ON_CALL(*this, SetSendBlocking(_))
      .WillByDefault(Invoke(real_.GetPointer(), &Socket::SetSendBlocking));
    ON_CALL(*this, GetSocketAddressAndPort(_,_))
      .WillByDefault(Invoke(real_.GetPointer(), &Socket::GetSocketAddressAndPort));
    ON_CALL(*this, Skip(_,_))
      .WillByDefault(Invoke(real_.GetPointer(), &Socket::Skip));
  }
  ~SocketMock(){real_.~SmartPointer();};
  Socket::Pointer getPointer(){return real_;};
  
  MOCK_METHOD0(GetConnected, int());
  MOCK_METHOD1(SetTimeout, int(int timeout));
  MOCK_METHOD1(SetReceiveTimeout, int(int timeout));
  MOCK_METHOD1(SetSendTimeout, int(int timeout));
  MOCK_METHOD1(SetReceiveBlocking, int(int sw));
  MOCK_METHOD1(SetSendBlocking, int(int sw));
  MOCK_METHOD2(Send, int(const void* data, int length));
  MOCK_METHOD2(GetSocketAddressAndPort, int(std::string& address, int& port));
  MOCK_METHOD2(Skip, int(int length, int skipFully));
  MOCK_METHOD3(Receive, int(void* data, int length, int readFully));
  
private:
  Socket::Pointer real_;
  
};
void* TestThreadFunction(void* ptr);
int ReceiveQuaternionTrackingData(ClientSocket::Pointer socket, igtl::MessageHeader::Pointer& header);
void clientServerProcess();

long interval = 200;
int threadID;
int port = 18944;
bool threadrunning = false;
bool msgReceived = true;
TEST(SocketTest, GeneralTest)
{
  igtl::MultiThreader::Pointer threader = igtl::MultiThreader::New();
  threadID  = threader->SpawnThread((igtl::ThreadFunctionType) &TestThreadFunction, NULL);
  clientServerProcess();
  while(threadrunning)
    {
    igtl::Sleep(interval);
    };
}

void* TestThreadFunction(void* ptr)
{
  threadrunning = true;
  igtl::MutexLock::Pointer glock = igtl::MutexLock::New();
  int waitingTime = 3000;
  ServerSocket::Pointer serverSocket = ServerSocket::New();
  serverSocket->CreateServer(port);
  SocketMock socketMock(static_cast<Socket::Pointer>(serverSocket->WaitForConnection(10*waitingTime)));
  EXPECT_CALL(socketMock, GetConnected()).Times(1);
  //The send command is called 10 times, it keep on sending at an interval(200ms) until a stop command is received.
  EXPECT_CALL(socketMock, Send(_,_)).Times(10);
  // Receive function should be called three times, the start command header, the start command body, and the stop command
  EXPECT_CALL(socketMock, Receive(_,_,_)).Times(3);
  EXPECT_CALL(socketMock, SetTimeout(_)).Times(0);
  EXPECT_CALL(socketMock, SetSendTimeout(_)).Times(0);
  if (socketMock.getPointer().IsNotNull())
    {
    EXPECT_GT(socketMock.GetConnected(),0);
    igtl::MessageHeader::Pointer headerMsg;
    headerMsg = igtl::MessageHeader::New();
    for (;;)
      {
      headerMsg->InitPack();
      int rs = socketMock.Receive(headerMsg->GetPackPointer(), headerMsg->GetPackSize(), 0);
      if (rs != headerMsg->GetPackSize())
        {
        continue;
        }
      
      // Deserialize the header
      headerMsg->Unpack();
      if (strcmp(headerMsg->GetDeviceType(), "STT_QTDATA") == 0)
        {
        std::cerr << "Received a STT_QTDATA message." << std::endl;
        
        igtl::StartQuaternionTrackingDataMessage::Pointer startQuaternionTracking;
        startQuaternionTracking = igtl::StartQuaternionTrackingDataMessage::New();
        startQuaternionTracking->SetMessageHeader(headerMsg);
        startQuaternionTracking->AllocatePack();
        
        socketMock.Receive(startQuaternionTracking->GetPackBodyPointer(), startQuaternionTracking->GetPackBodySize(),0);
        int c = startQuaternionTracking->Unpack(1);
        if (c & igtl::MessageHeader::UNPACK_BODY) // if CRC check is OK
          {
          igtl::QuaternionTrackingDataMessage::Pointer quaternionTrackingMsg;
          quaternionTrackingMsg = igtl::QuaternionTrackingDataMessage::New();
          quaternionTrackingMsg->SetDeviceName("Tracker");
          igtl::QuaternionTrackingDataElement::Pointer quaternionTrackElement0;
          quaternionTrackElement0 = igtl::QuaternionTrackingDataElement::New();
          quaternionTrackElement0->SetName("Channel 0");
          quaternionTrackElement0->SetType(igtl::QuaternionTrackingDataElement::TYPE_TRACKER);
          quaternionTrackingMsg->AddQuaternionTrackingDataElement(quaternionTrackElement0);
          while(!(threadID==-1))
            {
            if(msgReceived)
              {
              glock->Lock();
              quaternionTrackingMsg->Pack();
              socketMock.Send(quaternionTrackingMsg->GetPackPointer(), quaternionTrackingMsg->GetPackSize());
              glock->Unlock();
              msgReceived = false;
              }
            igtl::Sleep(interval);
            }
          }
        }
      else if (strcmp(headerMsg->GetDeviceType(), "STP_QTDATA") == 0)
        {
        std::cerr << "Received a stop message." << std::endl;
        socketMock.getPointer()->CloseSocket();
        threadrunning = false;
        break;
        }
      }
    }
  else
    {
    EXPECT_TRUE(false) << "No client connected.";
    }
  return NULL;
}

void clientServerProcess()
{
  igtl::ClientSocket::Pointer clientSocket;
  clientSocket = igtl::ClientSocket::New();
  bool notConnected = true;
  while(notConnected)
    {
    int r = clientSocket->ConnectToServer("localhost", port);
    if(r!=0)
      {
      continue;
      }
    else
      {
      notConnected=false;
      }
    }
  //socketMock.setPointer(clientSocket);
  igtl::StartQuaternionTrackingDataMessage::Pointer startQuaternionTrackingMsg;
  startQuaternionTrackingMsg = igtl::StartQuaternionTrackingDataMessage::New();
  startQuaternionTrackingMsg->SetDeviceName("QTDataClient");
  startQuaternionTrackingMsg->SetResolution(interval);
  startQuaternionTrackingMsg->SetCoordinateName("Patient");
  startQuaternionTrackingMsg->Pack();
  clientSocket->Send(startQuaternionTrackingMsg->GetPackPointer(), startQuaternionTrackingMsg->GetPackSize());
  int loop = 0;
  while (1)
    {
    //------------------------------------------------------------
    // Wait for a reply
    igtl::Sleep(interval);
    igtl::MessageHeader::Pointer headerMsg;
    headerMsg = igtl::MessageHeader::New();
    headerMsg->InitPack();
    int rs = clientSocket->Receive(headerMsg->GetPackPointer(), headerMsg->GetPackSize(),0);
    if (rs == 0)
      {
      std::cerr << "Connection closed." << std::endl;
      clientSocket->CloseSocket();
      exit(0);
      }
    headerMsg->Unpack();
    if (strcmp(headerMsg->GetDeviceType(), "QTDATA") == 0)
      {
      ReceiveQuaternionTrackingData(clientSocket, headerMsg);
      msgReceived = true;
      }
    else
      {
      std::cerr << "Receiving : " << headerMsg->GetDeviceType() << std::endl;
      clientSocket->Skip(headerMsg->GetBodySizeToRead(), 0);
      }
    if (++loop >= 10) // if received 11 times
      {
      //------------------------------------------------------------
      // Ask the server to stop pushing quaternion tracking data
      std::cerr << "Sending STP_QTDATA message....." << std::endl;
      igtl::StopQuaternionTrackingDataMessage::Pointer stopQuaternionTrackingMsg;
      stopQuaternionTrackingMsg = igtl::StopQuaternionTrackingDataMessage::New();
      stopQuaternionTrackingMsg->SetDeviceName("QTDataClient");
      stopQuaternionTrackingMsg->Pack();
      clientSocket->Send(stopQuaternionTrackingMsg->GetPackPointer(), stopQuaternionTrackingMsg->GetPackSize());
      threadID = -1;
      break;
      }
    }
}

int ReceiveQuaternionTrackingData(ClientSocket::Pointer socket, igtl::MessageHeader::Pointer& header)
{
  std::cerr << "Receiving QTDATA data type." << std::endl;
  
  //------------------------------------------------------------
  // Allocate QuaternionTrackingData Message Class
  
  igtl::QuaternionTrackingDataMessage::Pointer quaternionTrackingData;
  quaternionTrackingData = igtl::QuaternionTrackingDataMessage::New();
  quaternionTrackingData->SetMessageHeader(header);
  quaternionTrackingData->AllocatePack();
  
  // Receive body from the socket
  socket->Receive(quaternionTrackingData->GetPackBodyPointer(), quaternionTrackingData->GetPackBodySize(),0);
  
  // Deserialize position and quaternion (orientation) data
  // If you want to skip CRC check, call Unpack() without argument.
  int c = quaternionTrackingData->Unpack(1);
  
  if (c & igtl::MessageHeader::UNPACK_BODY) // if CRC check is OK
    {
    int nElements = quaternionTrackingData->GetNumberOfQuaternionTrackingDataElements();
    EXPECT_EQ(nElements, 1);
    return 1;
    }
  return 0;
}

int main(int argc, char **argv)
{
  testing::InitGoogleTest(&argc, argv);
  return RUN_ALL_TESTS();
}