googletest.h revision fbaaef999ba563838ebd00874ed8a1c01fbf286d 
1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc.  All rights reserved.
3// http://code.google.com/p/protobuf/
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are
7// met:
8//
9//     * Redistributions of source code must retain the above copyright
10// notice, this list of conditions and the following disclaimer.
11//     * Redistributions in binary form must reproduce the above
12// copyright notice, this list of conditions and the following disclaimer
13// in the documentation and/or other materials provided with the
14// distribution.
15//     * Neither the name of Google Inc. nor the names of its
16// contributors may be used to endorse or promote products derived from
17// this software without specific prior written permission.
18//
19// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
31// Author: kenton@google.com (Kenton Varda)
32// emulates google3/testing/base/public/googletest.h
33
34#ifndef GOOGLE_PROTOBUF_GOOGLETEST_H__
35#define GOOGLE_PROTOBUF_GOOGLETEST_H__
36
37#include <vector>
38#include <google/protobuf/stubs/common.h>
39
40namespace google {
41namespace protobuf {
42
43// When running unittests, get the directory containing the source code.
44string TestSourceDir();
45
46// When running unittests, get a directory where temporary files may be
47// placed.
48string TestTempDir();
49
50// Capture all text written to stdout or stderr.
51void CaptureTestStdout();
52void CaptureTestStderr();
53
54// Stop capturing stdout or stderr and return the text captured.
55string GetCapturedTestStdout();
56string GetCapturedTestStderr();
57
58// For use with ScopedMemoryLog::GetMessages().  Inside Google the LogLevel
59// constants don't have the LOGLEVEL_ prefix, so the code that used
60// ScopedMemoryLog refers to LOGLEVEL_ERROR as just ERROR.
61#undef ERROR  // defend against promiscuous windows.h
62static const LogLevel ERROR = LOGLEVEL_ERROR;
63
64// Receives copies of all LOG(ERROR) messages while in scope.  Sample usage:
65//   {
66//     ScopedMemoryLog log;  // constructor registers object as a log sink
67//     SomeRoutineThatMayLogMessages();
68//     const vector<string>& warnings = log.GetMessages(ERROR);
69//   }  // destructor unregisters object as a log sink
70// This is a dummy implementation which covers only what is used by protocol
71// buffer unit tests.
72class ScopedMemoryLog {
73 public:
74  ScopedMemoryLog();
75  virtual ~ScopedMemoryLog();
76
77  // Fetches all messages logged.  The internal version of this class
78  // would only fetch messages at the given security level, but the protobuf
79  // open source version ignores the argument since we always pass ERROR
80  // anyway.
81  const vector<string>& GetMessages(LogLevel dummy) const;
82
83 private:
84  vector<string> messages_;
85  LogHandler* old_handler_;
86
87  static void HandleLog(LogLevel level, const char* filename, int line,
88                        const string& message);
89
90  static ScopedMemoryLog* active_log_;
91
92  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ScopedMemoryLog);
93};
94
95}  // namespace protobuf
96}  // namespace google
97
98#endif  // GOOGLE_PROTOBUF_GOOGLETEST_H__
99