deskflow/src/test/integtests/net/NetworkTests.cpp

/*
 * synergy -- mouse and keyboard sharing utility
 * Copyright (C) 2013-2016 Symless Ltd.
 *
 * This package is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * found in the file LICENSE that should have accompanied this file.
 *
 * This package 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

// TODO: fix, tests failing intermittently on mac.
#ifndef WINAPI_CARBON

#define TEST_ENV

#include "base/Log.h"
#include "base/TMethodEventJob.h"
#include "base/TMethodJob.h"
#include "client/Client.h"
#include "common/stdexcept.h"
#include "mt/Thread.h"
#include "net/NetworkAddress.h"
#include "net/SocketMultiplexer.h"
#include "net/TCPSocketFactory.h"
#include "server/ClientListener.h"
#include "server/ClientProxy.h"
#include "server/Server.h"
#include "synergy/FileChunk.h"
#include "synergy/StreamChunker.h"
#include "test/mock/server/MockConfig.h"
#include "test/mock/server/MockInputFilter.h"
#include "test/mock/server/MockPrimaryClient.h"
#include "test/mock/synergy/MockScreen.h"
#include "test/shared/TestEventQueue.h"

#include <fstream>
#include <gtest/gtest.h>
#include <iostream>
#include <stdio.h>

using namespace std;
using ::testing::_;
using ::testing::Invoke;
using ::testing::NiceMock;
using ::testing::Return;

#define TEST_PORT 24803
#define TEST_HOST "localhost"

const size_t kMockDataSize = 1024 * 1024 * 10; // 10MB
const UInt16 kMockDataChunkIncrement = 1024;   // 1KB
const char *kMockFilename = "NetworkTests.mock";
const size_t kMockFileSize = 1024 * 1024 * 10; // 10MB

void getScreenShape(SInt32 &x, SInt32 &y, SInt32 &w, SInt32 &h);
void getCursorPos(SInt32 &x, SInt32 &y);
UInt8 *newMockData(size_t size);
void createFile(fstream &file, const char *filename, size_t size);

class NetworkTests : public ::testing::Test {
public:
  NetworkTests() : m_mockData(NULL), m_mockDataSize(0), m_mockFileSize(0) {
    m_mockData = newMockData(kMockDataSize);
    createFile(m_mockFile, kMockFilename, kMockFileSize);
  }

  ~NetworkTests() {
    remove(kMockFilename);
    delete[] m_mockData;
  }

  void sendMockData(void *eventTarget);

  void
  sendToClient_mockData_handleClientConnected(const Event &, void *vlistener);
  void sendToClient_mockData_fileRecieveCompleted(const Event &, void *);

  void
  sendToClient_mockFile_handleClientConnected(const Event &, void *vlistener);
  void sendToClient_mockFile_fileRecieveCompleted(const Event &event, void *);

  void
  sendToServer_mockData_handleClientConnected(const Event &, void *vlistener);
  void sendToServer_mockData_fileRecieveCompleted(const Event &event, void *);

  void
  sendToServer_mockFile_handleClientConnected(const Event &, void *vlistener);
  void sendToServer_mockFile_fileRecieveCompleted(const Event &event, void *);

public:
  TestEventQueue m_events;
  UInt8 *m_mockData;
  size_t m_mockDataSize;
  fstream m_mockFile;
  size_t m_mockFileSize;
};

TEST_F(NetworkTests, sendToClient_mockData) {
  // server and client
  NetworkAddress serverAddress(TEST_HOST, TEST_PORT);

  serverAddress.resolve();

  // server
  SocketMultiplexer serverSocketMultiplexer;
  TCPSocketFactory *serverSocketFactory =
      new TCPSocketFactory(&m_events, &serverSocketMultiplexer);
  ClientListener listener(serverAddress, serverSocketFactory, &m_events, false);
  NiceMock<MockScreen> serverScreen;
  NiceMock<MockPrimaryClient> primaryClient;
  NiceMock<MockConfig> serverConfig;
  NiceMock<MockInputFilter> serverInputFilter;

  m_events.adoptHandler(
      m_events.forClientListener().connected(), &listener,
      new TMethodEventJob<NetworkTests>(
          this, &NetworkTests::sendToClient_mockData_handleClientConnected,
          &listener));

  ON_CALL(serverConfig, isScreen(_)).WillByDefault(Return(true));
  ON_CALL(serverConfig, getInputFilter())
      .WillByDefault(Return(&serverInputFilter));

  lib::synergy::ServerArgs serverArgs;
  serverArgs.m_enableDragDrop = true;
  Server server(
      serverConfig, &primaryClient, &serverScreen, &m_events, serverArgs);
  server.m_mock = true;
  listener.setServer(&server);

  // client
  NiceMock<MockScreen> clientScreen;
  SocketMultiplexer clientSocketMultiplexer;
  TCPSocketFactory *clientSocketFactory =
      new TCPSocketFactory(&m_events, &clientSocketMultiplexer);

  ON_CALL(clientScreen, getShape(_, _, _, _))
      .WillByDefault(Invoke(getScreenShape));
  ON_CALL(clientScreen, getCursorPos(_, _)).WillByDefault(Invoke(getCursorPos));

  lib::synergy::ClientArgs clientArgs;
  clientArgs.m_enableDragDrop = true;
  clientArgs.m_enableCrypto = false;
  Client client(
      &m_events, "stub", serverAddress, clientSocketFactory, &clientScreen,
      clientArgs);

  m_events.adoptHandler(
      m_events.forFile().fileRecieveCompleted(), &client,
      new TMethodEventJob<NetworkTests>(
          this, &NetworkTests::sendToClient_mockData_fileRecieveCompleted));

  client.connect();

  m_events.initQuitTimeout(10);
  m_events.loop();
  m_events.removeHandler(m_events.forClientListener().connected(), &listener);
  m_events.removeHandler(m_events.forFile().fileRecieveCompleted(), &client);
  m_events.cleanupQuitTimeout();
}

TEST_F(NetworkTests, sendToClient_mockFile) {
  // server and client
  NetworkAddress serverAddress(TEST_HOST, TEST_PORT);

  serverAddress.resolve();

  // server
  SocketMultiplexer serverSocketMultiplexer;
  TCPSocketFactory *serverSocketFactory =
      new TCPSocketFactory(&m_events, &serverSocketMultiplexer);
  ClientListener listener(serverAddress, serverSocketFactory, &m_events, false);
  NiceMock<MockScreen> serverScreen;
  NiceMock<MockPrimaryClient> primaryClient;
  NiceMock<MockConfig> serverConfig;
  NiceMock<MockInputFilter> serverInputFilter;

  m_events.adoptHandler(
      m_events.forClientListener().connected(), &listener,
      new TMethodEventJob<NetworkTests>(
          this, &NetworkTests::sendToClient_mockFile_handleClientConnected,
          &listener));

  ON_CALL(serverConfig, isScreen(_)).WillByDefault(Return(true));
  ON_CALL(serverConfig, getInputFilter())
      .WillByDefault(Return(&serverInputFilter));

  lib::synergy::ServerArgs serverArgs;
  serverArgs.m_enableDragDrop = true;
  Server server(
      serverConfig, &primaryClient, &serverScreen, &m_events, serverArgs);
  server.m_mock = true;
  listener.setServer(&server);

  // client
  NiceMock<MockScreen> clientScreen;
  SocketMultiplexer clientSocketMultiplexer;
  TCPSocketFactory *clientSocketFactory =
      new TCPSocketFactory(&m_events, &clientSocketMultiplexer);

  ON_CALL(clientScreen, getShape(_, _, _, _))
      .WillByDefault(Invoke(getScreenShape));
  ON_CALL(clientScreen, getCursorPos(_, _)).WillByDefault(Invoke(getCursorPos));

  lib::synergy::ClientArgs clientArgs;
  clientArgs.m_enableDragDrop = true;
  clientArgs.m_enableCrypto = false;
  Client client(
      &m_events, "stub", serverAddress, clientSocketFactory, &clientScreen,
      clientArgs);

  m_events.adoptHandler(
      m_events.forFile().fileRecieveCompleted(), &client,
      new TMethodEventJob<NetworkTests>(
          this, &NetworkTests::sendToClient_mockFile_fileRecieveCompleted));

  client.connect();

  m_events.initQuitTimeout(10);
  m_events.loop();
  m_events.removeHandler(m_events.forClientListener().connected(), &listener);
  m_events.removeHandler(m_events.forFile().fileRecieveCompleted(), &client);
  m_events.cleanupQuitTimeout();
}

TEST_F(NetworkTests, sendToServer_mockData) {
  // server and client
  NetworkAddress serverAddress(TEST_HOST, TEST_PORT);
  serverAddress.resolve();

  // server
  SocketMultiplexer serverSocketMultiplexer;
  TCPSocketFactory *serverSocketFactory =
      new TCPSocketFactory(&m_events, &serverSocketMultiplexer);
  ClientListener listener(serverAddress, serverSocketFactory, &m_events, false);
  NiceMock<MockScreen> serverScreen;
  NiceMock<MockPrimaryClient> primaryClient;
  NiceMock<MockConfig> serverConfig;
  NiceMock<MockInputFilter> serverInputFilter;

  ON_CALL(serverConfig, isScreen(_)).WillByDefault(Return(true));
  ON_CALL(serverConfig, getInputFilter())
      .WillByDefault(Return(&serverInputFilter));

  lib::synergy::ServerArgs serverArgs;
  serverArgs.m_enableDragDrop = true;
  Server server(
      serverConfig, &primaryClient, &serverScreen, &m_events, serverArgs);
  server.m_mock = true;
  listener.setServer(&server);

  // client
  NiceMock<MockScreen> clientScreen;
  SocketMultiplexer clientSocketMultiplexer;
  TCPSocketFactory *clientSocketFactory =
      new TCPSocketFactory(&m_events, &clientSocketMultiplexer);

  ON_CALL(clientScreen, getShape(_, _, _, _))
      .WillByDefault(Invoke(getScreenShape));
  ON_CALL(clientScreen, getCursorPos(_, _)).WillByDefault(Invoke(getCursorPos));

  lib::synergy::ClientArgs clientArgs;
  clientArgs.m_enableDragDrop = true;
  clientArgs.m_enableCrypto = false;
  Client client(
      &m_events, "stub", serverAddress, clientSocketFactory, &clientScreen,
      clientArgs);

  m_events.adoptHandler(
      m_events.forClientListener().connected(), &listener,
      new TMethodEventJob<NetworkTests>(
          this, &NetworkTests::sendToServer_mockData_handleClientConnected,
          &client));

  m_events.adoptHandler(
      m_events.forFile().fileRecieveCompleted(), &server,
      new TMethodEventJob<NetworkTests>(
          this, &NetworkTests::sendToServer_mockData_fileRecieveCompleted));

  client.connect();

  m_events.initQuitTimeout(10);
  m_events.loop();
  m_events.removeHandler(m_events.forClientListener().connected(), &listener);
  m_events.removeHandler(m_events.forFile().fileRecieveCompleted(), &server);
  m_events.cleanupQuitTimeout();
}

TEST_F(NetworkTests, sendToServer_mockFile) {
  // server and client
  NetworkAddress serverAddress(TEST_HOST, TEST_PORT);

  serverAddress.resolve();

  // server
  SocketMultiplexer serverSocketMultiplexer;
  TCPSocketFactory *serverSocketFactory =
      new TCPSocketFactory(&m_events, &serverSocketMultiplexer);
  ClientListener listener(serverAddress, serverSocketFactory, &m_events, false);
  NiceMock<MockScreen> serverScreen;
  NiceMock<MockPrimaryClient> primaryClient;
  NiceMock<MockConfig> serverConfig;
  NiceMock<MockInputFilter> serverInputFilter;

  ON_CALL(serverConfig, isScreen(_)).WillByDefault(Return(true));
  ON_CALL(serverConfig, getInputFilter())
      .WillByDefault(Return(&serverInputFilter));

  lib::synergy::ServerArgs serverArgs;
  serverArgs.m_enableDragDrop = true;
  Server server(
      serverConfig, &primaryClient, &serverScreen, &m_events, serverArgs);
  server.m_mock = true;
  listener.setServer(&server);

  // client
  NiceMock<MockScreen> clientScreen;
  SocketMultiplexer clientSocketMultiplexer;
  TCPSocketFactory *clientSocketFactory =
      new TCPSocketFactory(&m_events, &clientSocketMultiplexer);

  ON_CALL(clientScreen, getShape(_, _, _, _))
      .WillByDefault(Invoke(getScreenShape));
  ON_CALL(clientScreen, getCursorPos(_, _)).WillByDefault(Invoke(getCursorPos));

  lib::synergy::ClientArgs clientArgs;
  clientArgs.m_enableDragDrop = true;
  clientArgs.m_enableCrypto = false;
  Client client(
      &m_events, "stub", serverAddress, clientSocketFactory, &clientScreen,
      clientArgs);

  m_events.adoptHandler(
      m_events.forClientListener().connected(), &listener,
      new TMethodEventJob<NetworkTests>(
          this, &NetworkTests::sendToServer_mockFile_handleClientConnected,
          &client));

  m_events.adoptHandler(
      m_events.forFile().fileRecieveCompleted(), &server,
      new TMethodEventJob<NetworkTests>(
          this, &NetworkTests::sendToServer_mockFile_fileRecieveCompleted));

  client.connect();

  m_events.initQuitTimeout(10);
  m_events.loop();
  m_events.removeHandler(m_events.forClientListener().connected(), &listener);
  m_events.removeHandler(m_events.forFile().fileRecieveCompleted(), &server);
  m_events.cleanupQuitTimeout();
}

void NetworkTests::sendToClient_mockData_handleClientConnected(
    const Event &, void *vlistener) {
  ClientListener *listener = static_cast<ClientListener *>(vlistener);
  Server *server = listener->getServer();

  ClientProxy *client = listener->getNextClient();
  if (client == NULL) {
    throw runtime_error("client is null");
  }

  BaseClientProxy *bcp = client;
  server->adoptClient(bcp);
  server->setActive(bcp);

  sendMockData(server);
}

void NetworkTests::sendToClient_mockData_fileRecieveCompleted(
    const Event &event, void *) {
  Client *client = static_cast<Client *>(event.getTarget());
  EXPECT_TRUE(client->isReceivedFileSizeValid());

  m_events.raiseQuitEvent();
}

void NetworkTests::sendToClient_mockFile_handleClientConnected(
    const Event &, void *vlistener) {
  ClientListener *listener = static_cast<ClientListener *>(vlistener);
  Server *server = listener->getServer();

  ClientProxy *client = listener->getNextClient();
  if (client == NULL) {
    throw runtime_error("client is null");
  }

  BaseClientProxy *bcp = client;
  server->adoptClient(bcp);
  server->setActive(bcp);

  server->sendFileToClient(kMockFilename);
}

void NetworkTests::sendToClient_mockFile_fileRecieveCompleted(
    const Event &event, void *) {
  Client *client = static_cast<Client *>(event.getTarget());
  EXPECT_TRUE(client->isReceivedFileSizeValid());

  m_events.raiseQuitEvent();
}

void NetworkTests::sendToServer_mockData_handleClientConnected(
    const Event &, void *vclient) {
  Client *client = static_cast<Client *>(vclient);
  sendMockData(client);
}

void NetworkTests::sendToServer_mockData_fileRecieveCompleted(
    const Event &event, void *) {
  Server *server = static_cast<Server *>(event.getTarget());
  EXPECT_TRUE(server->isReceivedFileSizeValid());

  m_events.raiseQuitEvent();
}

void NetworkTests::sendToServer_mockFile_handleClientConnected(
    const Event &, void *vclient) {
  Client *client = static_cast<Client *>(vclient);
  client->sendFileToServer(kMockFilename);
}

void NetworkTests::sendToServer_mockFile_fileRecieveCompleted(
    const Event &event, void *) {
  Server *server = static_cast<Server *>(event.getTarget());
  EXPECT_TRUE(server->isReceivedFileSizeValid());

  m_events.raiseQuitEvent();
}

void NetworkTests::sendMockData(void *eventTarget) {
  // send first message (file size)
  String size = synergy::string::sizeTypeToString(kMockDataSize);
  FileChunk *sizeMessage = FileChunk::start(size);

  m_events.addEvent(
      Event(m_events.forFile().fileChunkSending(), eventTarget, sizeMessage));

  // send chunk messages with incrementing chunk size
  size_t lastSize = 0;
  size_t sentLength = 0;
  while (true) {
    size_t dataSize = lastSize + kMockDataChunkIncrement;

    // make sure we don't read too much from the mock data.
    if (sentLength + dataSize > kMockDataSize) {
      dataSize = kMockDataSize - sentLength;
    }

    // first byte is the chunk mark, last is \0
    FileChunk *chunk = FileChunk::data(m_mockData, dataSize);
    m_events.addEvent(
        Event(m_events.forFile().fileChunkSending(), eventTarget, chunk));

    sentLength += dataSize;
    lastSize = dataSize;

    if (sentLength == kMockDataSize) {
      break;
    }
  }

  // send last message
  FileChunk *transferFinished = FileChunk::end();
  m_events.addEvent(Event(
      m_events.forFile().fileChunkSending(), eventTarget, transferFinished));
}

UInt8 *newMockData(size_t size) {
  UInt8 *buffer = new UInt8[size];

  UInt8 *data = buffer;
  const UInt8 head[] = "mock head... ";
  size_t headSize = sizeof(head) - 1;
  const UInt8 tail[] = "... mock tail";
  size_t tailSize = sizeof(tail) - 1;
  const UInt8 synergyRocks[] = "synergy\0 rocks! ";
  size_t synergyRocksSize = sizeof(synergyRocks) - 1;

  memcpy(data, head, headSize);
  data += headSize;

  size_t times = (size - headSize - tailSize) / synergyRocksSize;
  for (size_t i = 0; i < times; ++i) {
    memcpy(data, synergyRocks, synergyRocksSize);
    data += synergyRocksSize;
  }

  size_t remainder = (size - headSize - tailSize) % synergyRocksSize;
  if (remainder != 0) {
    memset(data, '.', remainder);
    data += remainder;
  }

  memcpy(data, tail, tailSize);
  return buffer;
}

void createFile(fstream &file, const char *filename, size_t size) {
  UInt8 *buffer = newMockData(size);

  file.open(filename, ios::out | ios::binary);
  if (!file.is_open()) {
    throw runtime_error("file not open");
  }

  file.write(reinterpret_cast<char *>(buffer), size);
  file.close();

  delete[] buffer;
}

void getScreenShape(SInt32 &x, SInt32 &y, SInt32 &w, SInt32 &h) {
  x = 0;
  y = 0;
  w = 1;
  h = 1;
}

void getCursorPos(SInt32 &x, SInt32 &y) {
  x = 0;
  y = 0;
}

#endif // WINAPI_CARBON