• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2008 Google Inc.  All rights reserved.
3 // https://developers.google.com/protocol-buffers/
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 #include <google/protobuf/stubs/logging.h>
41 #include <gmock/gmock.h>
42 // Disable death tests if we use exceptions in CHECK().
43 #if !PROTOBUF_USE_EXCEPTIONS && defined(GTEST_HAS_DEATH_TEST) && \
44     !GTEST_OS_WINDOWS
45 #define PROTOBUF_HAS_DEATH_TEST
46 #endif
47 
48 namespace google {
49 namespace protobuf {
50 
51 // When running unittests, get the directory containing the source code.
52 string TestSourceDir();
53 
54 // When running unittests, get a directory where temporary files may be
55 // placed.
56 string TestTempDir();
57 
58 // Capture all text written to stdout or stderr.
59 void CaptureTestStdout();
60 void CaptureTestStderr();
61 
62 // Stop capturing stdout or stderr and return the text captured.
63 string GetCapturedTestStdout();
64 string GetCapturedTestStderr();
65 
66 // For use with ScopedMemoryLog::GetMessages().  Inside Google the LogLevel
67 // constants don't have the LOGLEVEL_ prefix, so the code that used
68 // ScopedMemoryLog refers to LOGLEVEL_ERROR as just ERROR.
69 #undef ERROR  // defend against promiscuous windows.h
70 static const LogLevel ERROR = LOGLEVEL_ERROR;
71 static const LogLevel WARNING = LOGLEVEL_WARNING;
72 
73 // Receives copies of all LOG(ERROR) messages while in scope.  Sample usage:
74 //   {
75 //     ScopedMemoryLog log;  // constructor registers object as a log sink
76 //     SomeRoutineThatMayLogMessages();
77 //     const vector<string>& warnings = log.GetMessages(ERROR);
78 //   }  // destructor unregisters object as a log sink
79 // This is a dummy implementation which covers only what is used by protocol
80 // buffer unit tests.
81 class ScopedMemoryLog {
82  public:
83   ScopedMemoryLog();
84   virtual ~ScopedMemoryLog();
85 
86   // Fetches all messages with the given severity level.
87   const std::vector<string>& GetMessages(LogLevel error);
88 
89  private:
90   std::map<LogLevel, std::vector<string> > messages_;
91   LogHandler* old_handler_;
92 
93   static void HandleLog(LogLevel level, const char* filename, int line,
94                         const string& message);
95 
96   static ScopedMemoryLog* active_log_;
97 
98   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ScopedMemoryLog);
99 };
100 
101 }  // namespace protobuf
102 }  // namespace google
103 
104 #endif  // GOOGLE_PROTOBUF_GOOGLETEST_H__
105