3 * Copyright 2004--2011, Google Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #ifndef TALK_BASE_TESTUTILS_H__
29 #define TALK_BASE_TESTUTILS_H__
31 // Utilities for testing talk_base infrastructure in unittests
35 #include <X11/extensions/Xrandr.h>
37 // X defines a few macros that stomp on types that gunit.h uses.
44 #include "talk/base/asyncsocket.h"
45 #include "talk/base/common.h"
46 #include "talk/base/gunit.h"
47 #include "talk/base/nethelpers.h"
48 #include "talk/base/stream.h"
49 #include "talk/base/stringencode.h"
50 #include "talk/base/stringutils.h"
51 #include "talk/base/thread.h"
55 using namespace talk_base;
57 ///////////////////////////////////////////////////////////////////////////////
58 // StreamSink - Monitor asynchronously signalled events from StreamInterface
59 // or AsyncSocket (which should probably be a StreamInterface.
60 ///////////////////////////////////////////////////////////////////////////////
62 // Note: Any event that is an error is treaded as SSE_ERROR instead of that
65 enum StreamSinkEvent {
73 class StreamSink : public sigslot::has_slots<> {
75 void Monitor(StreamInterface* stream) {
76 stream->SignalEvent.connect(this, &StreamSink::OnEvent);
77 events_.erase(stream);
79 void Unmonitor(StreamInterface* stream) {
80 stream->SignalEvent.disconnect(this);
81 // In case you forgot to unmonitor a previous object with this address
82 events_.erase(stream);
84 bool Check(StreamInterface* stream, StreamSinkEvent event, bool reset = true) {
85 return DoCheck(stream, event, reset);
87 int Events(StreamInterface* stream, bool reset = true) {
88 return DoEvents(stream, reset);
91 void Monitor(AsyncSocket* socket) {
92 socket->SignalConnectEvent.connect(this, &StreamSink::OnConnectEvent);
93 socket->SignalReadEvent.connect(this, &StreamSink::OnReadEvent);
94 socket->SignalWriteEvent.connect(this, &StreamSink::OnWriteEvent);
95 socket->SignalCloseEvent.connect(this, &StreamSink::OnCloseEvent);
96 // In case you forgot to unmonitor a previous object with this address
97 events_.erase(socket);
99 void Unmonitor(AsyncSocket* socket) {
100 socket->SignalConnectEvent.disconnect(this);
101 socket->SignalReadEvent.disconnect(this);
102 socket->SignalWriteEvent.disconnect(this);
103 socket->SignalCloseEvent.disconnect(this);
104 events_.erase(socket);
106 bool Check(AsyncSocket* socket, StreamSinkEvent event, bool reset = true) {
107 return DoCheck(socket, event, reset);
109 int Events(AsyncSocket* socket, bool reset = true) {
110 return DoEvents(socket, reset);
114 typedef std::map<void*,int> EventMap;
116 void OnEvent(StreamInterface* stream, int events, int error) {
120 AddEvents(stream, events);
122 void OnConnectEvent(AsyncSocket* socket) {
123 AddEvents(socket, SSE_OPEN);
125 void OnReadEvent(AsyncSocket* socket) {
126 AddEvents(socket, SSE_READ);
128 void OnWriteEvent(AsyncSocket* socket) {
129 AddEvents(socket, SSE_WRITE);
131 void OnCloseEvent(AsyncSocket* socket, int error) {
132 AddEvents(socket, (0 == error) ? SSE_CLOSE : SSE_ERROR);
135 void AddEvents(void* obj, int events) {
136 EventMap::iterator it = events_.find(obj);
137 if (events_.end() == it) {
138 events_.insert(EventMap::value_type(obj, events));
140 it->second |= events;
143 bool DoCheck(void* obj, StreamSinkEvent event, bool reset) {
144 EventMap::iterator it = events_.find(obj);
145 if ((events_.end() == it) || (0 == (it->second & event))) {
149 it->second &= ~event;
153 int DoEvents(void* obj, bool reset) {
154 EventMap::iterator it = events_.find(obj);
155 if (events_.end() == it)
157 int events = it->second;
167 ///////////////////////////////////////////////////////////////////////////////
168 // StreamSource - Implements stream interface and simulates asynchronous
169 // events on the stream, without a network. Also buffers written data.
170 ///////////////////////////////////////////////////////////////////////////////
172 class StreamSource : public StreamInterface {
179 readable_data_.clear();
180 written_data_.clear();
183 write_block_ = SIZE_UNKNOWN;
185 void QueueString(const char* data) {
186 QueueData(data, strlen(data));
188 void QueueStringF(const char* format, ...) {
190 va_start(args, format);
192 size_t len = vsprintfn(buffer, sizeof(buffer), format, args);
193 ASSERT(len < sizeof(buffer) - 1);
195 QueueData(buffer, len);
197 void QueueData(const char* data, size_t len) {
198 readable_data_.insert(readable_data_.end(), data, data + len);
199 if ((SS_OPEN == state_) && (readable_data_.size() == len)) {
200 SignalEvent(this, SE_READ, 0);
203 std::string ReadData() {
205 // avoid accessing written_data_[0] if it is undefined
206 if (written_data_.size() > 0) {
207 data.insert(0, &written_data_[0], written_data_.size());
209 written_data_.clear();
212 void SetState(StreamState state) {
214 if ((SS_OPENING == state_) && (SS_OPEN == state)) {
216 if (!readable_data_.empty()) {
219 } else if ((SS_CLOSED != state_) && (SS_CLOSED == state)) {
224 SignalEvent(this, events, 0);
227 // Will cause Read to block when there are pos bytes in the read queue.
228 void SetReadBlock(size_t pos) { read_block_ = pos; }
229 // Will cause Write to block when there are pos bytes in the write queue.
230 void SetWriteBlock(size_t pos) { write_block_ = pos; }
232 virtual StreamState GetState() const { return state_; }
233 virtual StreamResult Read(void* buffer, size_t buffer_len,
234 size_t* read, int* error) {
235 if (SS_CLOSED == state_) {
236 if (error) *error = -1;
239 if ((SS_OPENING == state_) || (readable_data_.size() <= read_block_)) {
242 size_t count = _min(buffer_len, readable_data_.size() - read_block_);
243 memcpy(buffer, &readable_data_[0], count);
244 size_t new_size = readable_data_.size() - count;
245 // Avoid undefined access beyond the last element of the vector.
246 // This only happens when new_size is 0.
247 if (count < readable_data_.size()) {
248 memmove(&readable_data_[0], &readable_data_[count], new_size);
250 readable_data_.resize(new_size);
251 if (read) *read = count;
254 virtual StreamResult Write(const void* data, size_t data_len,
255 size_t* written, int* error) {
256 if (SS_CLOSED == state_) {
257 if (error) *error = -1;
260 if (SS_OPENING == state_) {
263 if (SIZE_UNKNOWN != write_block_) {
264 if (written_data_.size() >= write_block_) {
267 if (data_len > (write_block_ - written_data_.size())) {
268 data_len = write_block_ - written_data_.size();
271 if (written) *written = data_len;
272 const char* cdata = static_cast<const char*>(data);
273 written_data_.insert(written_data_.end(), cdata, cdata + data_len);
276 virtual void Close() { state_ = SS_CLOSED; }
279 typedef std::vector<char> Buffer;
280 Buffer readable_data_, written_data_;
282 size_t read_block_, write_block_;
285 ///////////////////////////////////////////////////////////////////////////////
287 // Creates a simulated client for testing. Works on real and virtual networks.
288 ///////////////////////////////////////////////////////////////////////////////
290 class SocketTestClient : public sigslot::has_slots<> {
295 SocketTestClient(AsyncSocket* socket) {
296 Init(socket, socket->GetLocalAddress().family());
298 SocketTestClient(const SocketAddress& address) {
299 Init(NULL, address.family());
300 socket_->Connect(address);
303 AsyncSocket* socket() { return socket_.get(); }
305 void QueueString(const char* data) {
306 QueueData(data, strlen(data));
308 void QueueStringF(const char* format, ...) {
310 va_start(args, format);
312 size_t len = vsprintfn(buffer, sizeof(buffer), format, args);
313 ASSERT(len < sizeof(buffer) - 1);
315 QueueData(buffer, len);
317 void QueueData(const char* data, size_t len) {
318 send_buffer_.insert(send_buffer_.end(), data, data + len);
319 if (Socket::CS_CONNECTED == socket_->GetState()) {
323 std::string ReadData() {
324 std::string data(&recv_buffer_[0], recv_buffer_.size());
325 recv_buffer_.clear();
329 bool IsConnected() const {
330 return (Socket::CS_CONNECTED == socket_->GetState());
332 bool IsClosed() const {
333 return (Socket::CS_CLOSED == socket_->GetState());
337 typedef std::vector<char> Buffer;
339 void Init(AsyncSocket* socket, int family) {
341 socket = Thread::Current()->socketserver()
342 ->CreateAsyncSocket(family, SOCK_STREAM);
344 socket_.reset(socket);
345 socket_->SignalConnectEvent.connect(this,
346 &SocketTestClient::OnConnectEvent);
347 socket_->SignalReadEvent.connect(this, &SocketTestClient::OnReadEvent);
348 socket_->SignalWriteEvent.connect(this, &SocketTestClient::OnWriteEvent);
349 socket_->SignalCloseEvent.connect(this, &SocketTestClient::OnCloseEvent);
354 while (sent < send_buffer_.size()) {
355 int result = socket_->Send(&send_buffer_[sent],
356 send_buffer_.size() - sent);
363 size_t new_size = send_buffer_.size() - sent;
364 memmove(&send_buffer_[0], &send_buffer_[sent], new_size);
365 send_buffer_.resize(new_size);
368 void OnConnectEvent(AsyncSocket* socket) {
369 if (!send_buffer_.empty()) {
373 void OnReadEvent(AsyncSocket* socket) {
374 char data[64 * 1024];
375 int result = socket_->Recv(data, ARRAY_SIZE(data));
377 recv_buffer_.insert(recv_buffer_.end(), data, data + result);
380 void OnWriteEvent(AsyncSocket* socket) {
381 if (!send_buffer_.empty()) {
385 void OnCloseEvent(AsyncSocket* socket, int error) {
388 scoped_ptr<AsyncSocket> socket_;
389 Buffer send_buffer_, recv_buffer_;
392 ///////////////////////////////////////////////////////////////////////////////
394 // Creates a simulated server for testing. Works on real and virtual networks.
395 ///////////////////////////////////////////////////////////////////////////////
397 class SocketTestServer : public sigslot::has_slots<> {
399 SocketTestServer(const SocketAddress& address)
400 : socket_(Thread::Current()->socketserver()
401 ->CreateAsyncSocket(address.family(), SOCK_STREAM))
403 socket_->SignalReadEvent.connect(this, &SocketTestServer::OnReadEvent);
404 socket_->Bind(address);
407 virtual ~SocketTestServer() {
411 size_t size() const { return clients_.size(); }
412 SocketTestClient* client(size_t index) const { return clients_[index]; }
413 SocketTestClient* operator[](size_t index) const { return client(index); }
416 for (size_t i=0; i<clients_.size(); ++i) {
423 void OnReadEvent(AsyncSocket* socket) {
424 AsyncSocket* accepted =
425 static_cast<AsyncSocket*>(socket_->Accept(NULL));
428 clients_.push_back(new SocketTestClient(accepted));
431 scoped_ptr<AsyncSocket> socket_;
432 std::vector<SocketTestClient*> clients_;
435 ///////////////////////////////////////////////////////////////////////////////
437 ///////////////////////////////////////////////////////////////////////////////
439 inline bool ReadFile(const char* filename, std::string* contents) {
440 FILE* fp = fopen(filename, "rb");
443 char buffer[1024*64];
446 while ((read = fread(buffer, 1, sizeof(buffer), fp))) {
447 contents->append(buffer, read);
449 bool success = (0 != feof(fp));
454 ///////////////////////////////////////////////////////////////////////////////
455 // Unittest predicates which are similar to STREQ, but for raw memory
456 ///////////////////////////////////////////////////////////////////////////////
458 inline AssertionResult CmpHelperMemEq(const char* expected_expression,
459 const char* expected_length_expression,
460 const char* actual_expression,
461 const char* actual_length_expression,
462 const void* expected,
463 size_t expected_length,
465 size_t actual_length)
467 if ((expected_length == actual_length)
468 && (0 == memcmp(expected, actual, expected_length))) {
469 return AssertionSuccess();
473 msg << "Value of: " << actual_expression
474 << " [" << actual_length_expression << "]";
475 if (true) { //!actual_value.Equals(actual_expression)) {
476 size_t buffer_size = actual_length * 2 + 1;
477 char* buffer = STACK_ARRAY(char, buffer_size);
478 hex_encode(buffer, buffer_size,
479 reinterpret_cast<const char*>(actual), actual_length);
480 msg << "\n Actual: " << buffer << " [" << actual_length << "]";
483 msg << "\nExpected: " << expected_expression
484 << " [" << expected_length_expression << "]";
485 if (true) { //!expected_value.Equals(expected_expression)) {
486 size_t buffer_size = expected_length * 2 + 1;
487 char* buffer = STACK_ARRAY(char, buffer_size);
488 hex_encode(buffer, buffer_size,
489 reinterpret_cast<const char*>(expected), expected_length);
490 msg << "\nWhich is: " << buffer << " [" << expected_length << "]";
493 return AssertionFailure(msg);
496 inline AssertionResult CmpHelperFileEq(const char* expected_expression,
497 const char* expected_length_expression,
498 const char* actual_filename,
499 const void* expected,
500 size_t expected_length,
501 const char* filename)
503 std::string contents;
504 if (!ReadFile(filename, &contents)) {
506 msg << "File '" << filename << "' could not be read.";
507 return AssertionFailure(msg);
509 return CmpHelperMemEq(expected_expression, expected_length_expression,
511 expected, expected_length,
512 contents.c_str(), contents.size());
515 #define EXPECT_MEMEQ(expected, expected_length, actual, actual_length) \
516 EXPECT_PRED_FORMAT4(::testing::CmpHelperMemEq, expected, expected_length, \
517 actual, actual_length)
519 #define ASSERT_MEMEQ(expected, expected_length, actual, actual_length) \
520 ASSERT_PRED_FORMAT4(::testing::CmpHelperMemEq, expected, expected_length, \
521 actual, actual_length)
523 #define EXPECT_FILEEQ(expected, expected_length, filename) \
524 EXPECT_PRED_FORMAT3(::testing::CmpHelperFileEq, expected, expected_length, \
527 #define ASSERT_FILEEQ(expected, expected_length, filename) \
528 ASSERT_PRED_FORMAT3(::testing::CmpHelperFileEq, expected, expected_length, \
531 ///////////////////////////////////////////////////////////////////////////////
532 // Helpers for initializing constant memory with integers in a particular byte
534 ///////////////////////////////////////////////////////////////////////////////
536 #define BYTE_CAST(x) static_cast<uint8>((x) & 0xFF)
538 // Declare a N-bit integer as a little-endian sequence of bytes
539 #define LE16(x) BYTE_CAST(((uint16)x) >> 0), BYTE_CAST(((uint16)x) >> 8)
541 #define LE32(x) BYTE_CAST(((uint32)x) >> 0), BYTE_CAST(((uint32)x) >> 8), \
542 BYTE_CAST(((uint32)x) >> 16), BYTE_CAST(((uint32)x) >> 24)
544 #define LE64(x) BYTE_CAST(((uint64)x) >> 0), BYTE_CAST(((uint64)x) >> 8), \
545 BYTE_CAST(((uint64)x) >> 16), BYTE_CAST(((uint64)x) >> 24), \
546 BYTE_CAST(((uint64)x) >> 32), BYTE_CAST(((uint64)x) >> 40), \
547 BYTE_CAST(((uint64)x) >> 48), BYTE_CAST(((uint64)x) >> 56)
549 // Declare a N-bit integer as a big-endian (Internet) sequence of bytes
550 #define BE16(x) BYTE_CAST(((uint16)x) >> 8), BYTE_CAST(((uint16)x) >> 0)
552 #define BE32(x) BYTE_CAST(((uint32)x) >> 24), BYTE_CAST(((uint32)x) >> 16), \
553 BYTE_CAST(((uint32)x) >> 8), BYTE_CAST(((uint32)x) >> 0)
555 #define BE64(x) BYTE_CAST(((uint64)x) >> 56), BYTE_CAST(((uint64)x) >> 48), \
556 BYTE_CAST(((uint64)x) >> 40), BYTE_CAST(((uint64)x) >> 32), \
557 BYTE_CAST(((uint64)x) >> 24), BYTE_CAST(((uint64)x) >> 16), \
558 BYTE_CAST(((uint64)x) >> 8), BYTE_CAST(((uint64)x) >> 0)
560 // Declare a N-bit integer as a this-endian (local machine) sequence of bytes
573 #endif // !BIG_ENDIAN
575 ///////////////////////////////////////////////////////////////////////////////
577 // Helpers for determining if X/screencasting is available (on linux).
579 #define MAYBE_SKIP_SCREENCAST_TEST() \
580 if (!testing::IsScreencastingAvailable()) { \
581 LOG(LS_WARNING) << "Skipping test, since it doesn't have the requisite " \
582 << "X environment for screen capture."; \
588 XDisplay() : display_(XOpenDisplay(NULL)) { }
589 ~XDisplay() { if (display_) XCloseDisplay(display_); }
590 bool IsValid() const { return display_ != NULL; }
591 operator Display*() { return display_; }
597 // Returns true if screencasting is available. When false, anything that uses
598 // screencasting features may fail.
599 inline bool IsScreencastingAvailable() {
602 if (!display.IsValid()) {
603 LOG(LS_WARNING) << "No X Display available.";
606 int ignored_int, major_version, minor_version;
607 if (!XRRQueryExtension(display, &ignored_int, &ignored_int) ||
608 !XRRQueryVersion(display, &major_version, &minor_version) ||
610 (major_version < 2 && minor_version < 3)) {
611 LOG(LS_WARNING) << "XRandr version: " << major_version << "."
613 LOG(LS_WARNING) << "XRandr is not supported or is too old (pre 1.3).";
619 } // namespace testing
621 #endif // TALK_BASE_TESTUTILS_H__