root/chrome/browser/extensions/api/serial/serial_apitest.cc

DEFINITIONS

1. RunImpl
2. opened_
3. Open
4. Configure
5. Close
6. Receive
7. Send
8. GetControlSignals
9. GetInfo
10. CreateSerialConnection
11. FakeSerialGetDevicesFunctionFactory
12. FakeSerialConnectFunctionFactory
13. IN_PROC_BROWSER_TEST_F
14. IN_PROC_BROWSER_TEST_F

// Copyright 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <deque>
#include <string>
#include <vector>

#include "base/memory/scoped_ptr.h"
#include "chrome/browser/extensions/api/serial/serial_api.h"
#include "chrome/browser/extensions/api/serial/serial_connection.h"
#include "chrome/browser/extensions/extension_apitest.h"
#include "chrome/browser/extensions/extension_function_test_utils.h"
#include "chrome/browser/extensions/extension_test_message_listener.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/common/extensions/api/serial.h"
#include "content/public/browser/browser_thread.h"
#include "extensions/browser/extension_function.h"
#include "testing/gmock/include/gmock/gmock.h"

using testing::_;
using testing::Return;

using content::BrowserThread;

namespace {

class SerialApiTest : public ExtensionApiTest {
 public:
  SerialApiTest() {}
};

}  // namespace

namespace extensions {

class FakeSerialGetDevicesFunction : public AsyncExtensionFunction {
 public:
  virtual bool RunImpl() OVERRIDE {
    base::ListValue* devices = new base::ListValue();
    base::DictionaryValue* device0 = new base::DictionaryValue();
    device0->SetString("path", "/dev/fakeserial");
    base::DictionaryValue* device1 = new base::DictionaryValue();
    device1->SetString("path", "\\\\COM800\\");
    devices->Append(device0);
    devices->Append(device1);
    SetResult(devices);
    SendResponse(true);
    return true;
  }
 protected:
  virtual ~FakeSerialGetDevicesFunction() {}
};

class FakeEchoSerialConnection : public SerialConnection {
 public:
  explicit FakeEchoSerialConnection(
      const std::string& port,
      const std::string& owner_extension_id)
      : SerialConnection(port, owner_extension_id),
        opened_(false) {
  }

  virtual ~FakeEchoSerialConnection() {
  }

  virtual void Open(const OpenCompleteCallback& callback) {
    DCHECK(!opened_);
    opened_ = true;
    callback.Run(true);
  }

  virtual bool Configure(const api::serial::ConnectionOptions& options) {
    return true;
  }

  virtual void Close() {
    DCHECK(opened_);
  }

  virtual bool Receive(const ReceiveCompleteCallback& callback) {
    read_callback_ = callback;
    return true;
  }

  virtual bool Send(const std::string& data,
                    const SendCompleteCallback& callback) {
    callback.Run(data.length(), api::serial::SEND_ERROR_NONE);
    if (!read_callback_.is_null()) {
      read_callback_.Run(data, api::serial::RECEIVE_ERROR_NONE);
    }
    return true;
  }

  virtual bool GetControlSignals(api::serial::DeviceControlSignals* signals)
      const {
    signals->dcd = true;
    signals->cts = true;
    signals->ri = true;
    signals->dsr = true;
    return true;
  }

  virtual bool GetInfo(api::serial::ConnectionInfo* info) const {
    info->paused = false;
    info->persistent = false;
    info->buffer_size = 4096;
    info->receive_timeout = 0;
    info->send_timeout = 0;
    info->bitrate.reset(new int(9600));
    info->data_bits = api::serial::DATA_BITS_EIGHT;
    info->parity_bit = api::serial::PARITY_BIT_NO;
    info->stop_bits = api::serial::STOP_BITS_ONE;
    info->cts_flow_control.reset(new bool(false));
    return true;
  }

  MOCK_METHOD1(SetControlSignals, bool(const api::serial::HostControlSignals&));

 private:
  bool opened_;
  ReceiveCompleteCallback read_callback_;

  DISALLOW_COPY_AND_ASSIGN(FakeEchoSerialConnection);
};

class FakeSerialConnectFunction : public api::SerialConnectFunction {
 protected:
  virtual SerialConnection* CreateSerialConnection(
      const std::string& port,
      const std::string& owner_extension_id) const OVERRIDE {
    FakeEchoSerialConnection* serial_connection =
        new FakeEchoSerialConnection(port, owner_extension_id);
    EXPECT_CALL(*serial_connection, SetControlSignals(_)).
        Times(1).WillOnce(Return(true));
    return serial_connection;
  }

 protected:
  virtual ~FakeSerialConnectFunction() {}
};

}  // namespace extensions

ExtensionFunction* FakeSerialGetDevicesFunctionFactory() {
  return new extensions::FakeSerialGetDevicesFunction();
}

ExtensionFunction* FakeSerialConnectFunctionFactory() {
  return new extensions::FakeSerialConnectFunction();
}

// Disable SIMULATE_SERIAL_PORTS only if all the following are true:
//
// 1. You have an Arduino or compatible board attached to your machine and
// properly appearing as the first virtual serial port ("first" is very loosely
// defined as whichever port shows up in serial.getPorts). We've tested only
// the Atmega32u4 Breakout Board and Arduino Leonardo; note that both these
// boards are based on the Atmel ATmega32u4, rather than the more common
// Arduino '328p with either FTDI or '8/16u2 USB interfaces. TODO: test more
// widely.
//
// 2. Your user has permission to read/write the port. For example, this might
// mean that your user is in the "tty" or "uucp" group on Ubuntu flavors of
// Linux, or else that the port's path (e.g., /dev/ttyACM0) has global
// read/write permissions.
//
// 3. You have uploaded a program to the board that does a byte-for-byte echo
// on the virtual serial port at 57600 bps. An example is at
// chrome/test/data/extensions/api_test/serial/api/serial_arduino_test.ino.
//
#define SIMULATE_SERIAL_PORTS (1)
IN_PROC_BROWSER_TEST_F(SerialApiTest, SerialFakeHardware) {
  ResultCatcher catcher;
  catcher.RestrictToProfile(browser()->profile());

#if SIMULATE_SERIAL_PORTS
  ASSERT_TRUE(extensions::ExtensionFunctionDispatcher::OverrideFunction(
      "serial.getDevices", FakeSerialGetDevicesFunctionFactory));
  ASSERT_TRUE(extensions::ExtensionFunctionDispatcher::OverrideFunction(
      "serial.connect", FakeSerialConnectFunctionFactory));
#endif

  ASSERT_TRUE(RunExtensionTest("serial/api")) << message_;
}

IN_PROC_BROWSER_TEST_F(SerialApiTest, SerialRealHardware) {
  ResultCatcher catcher;
  catcher.RestrictToProfile(browser()->profile());

  ASSERT_TRUE(RunExtensionTest("serial/real_hardware")) << message_;
}