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 <map>
38#include <vector>
39#include <google/protobuf/stubs/common.h>
40
41namespace google {
42namespace protobuf {
43
44// When running unittests, get the directory containing the source code.
45string TestSourceDir();
46
47// When running unittests, get a directory where temporary files may be
48// placed.
49string TestTempDir();
50
51// Capture all text written to stdout or stderr.
52void CaptureTestStdout();
53void CaptureTestStderr();
54
55// Stop capturing stdout or stderr and return the text captured.
56string GetCapturedTestStdout();
57string GetCapturedTestStderr();
58
59// For use with ScopedMemoryLog::GetMessages().  Inside Google the LogLevel
60// constants don't have the LOGLEVEL_ prefix, so the code that used
61// ScopedMemoryLog refers to LOGLEVEL_ERROR as just ERROR.
62#undef ERROR  // defend against promiscuous windows.h
63static const LogLevel ERROR = LOGLEVEL_ERROR;
64static const LogLevel WARNING = LOGLEVEL_WARNING;
65
66// Receives copies of all LOG(ERROR) messages while in scope.  Sample usage:
67//   {
68//     ScopedMemoryLog log;  // constructor registers object as a log sink
69//     SomeRoutineThatMayLogMessages();
70//     const vector<string>& warnings = log.GetMessages(ERROR);
71//   }  // destructor unregisters object as a log sink
72// This is a dummy implementation which covers only what is used by protocol
73// buffer unit tests.
74class ScopedMemoryLog {
75 public:
76  ScopedMemoryLog();
77  virtual ~ScopedMemoryLog();
78
79  // Fetches all messages with the given severity level.
80  const vector<string>& GetMessages(LogLevel error);
81
82 private:
83  map<LogLevel, vector<string> > messages_;
84  LogHandler* old_handler_;
85
86  static void HandleLog(LogLevel level, const char* filename, int line,
87                        const string& message);
88
89  static ScopedMemoryLog* active_log_;
90
91  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ScopedMemoryLog);
92};
93
94}  // namespace protobuf
95}  // namespace google
96
97#endif  // GOOGLE_PROTOBUF_GOOGLETEST_H__
98