reporter.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2005-2006 by Dr. Marc Boris Duerner
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * As a special exception, you may use this file as part of a free
10  * software library without restriction. Specifically, if other files
11  * instantiate templates or use macros or inline functions from this
12  * file, or you compile this file and link it with other files to
13  * produce an executable, this file does not by itself cause the
14  * resulting executable to be covered by the GNU General Public
15  * License. This exception does not however invalidate any other
16  * reasons why the executable file might be covered by the GNU Library
17  * General Public License.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  * Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27  */
28 #ifndef CXXTOOLS_UNIT_REPORTER_H
29 #define CXXTOOLS_UNIT_REPORTER_H
30 
33 #include <cxxtools/signal.h>
34 #include <iosfwd>
35 #include <stdexcept>
36 
37 namespace cxxtools
38 {
39 
40 namespace unit
41 {
42 
50 class Reporter
51 {
52  Reporter(const Reporter&) { }
53  Reporter& operator=(const Reporter&) { return *this; }
54 
55  public:
58  virtual ~Reporter()
59  { destroyed.send(*this);}
60 
68  virtual void reportStart(const TestContext& /*test*/)
69  { }
70 
78  virtual void reportFinish(const TestContext& /*test*/)
79  { }
80 
88  virtual void reportMessage(const std::string& /*msg*/)
89  { }
90 
97  virtual void reportSuccess(const TestContext& /*test*/)
98  { }
99 
107  virtual void reportAssertion(const TestContext& /*test*/, const Assertion& /*a*/)
108  { }
109 
118  virtual void reportException(const TestContext& /*test*/, const std::exception& /*ex*/)
119  { }
120 
128  virtual void reportError(const TestContext& /*test*/)
129  { }
130 
137  virtual void reportSkip(const TestContext& /*test*/)
138  { }
139 
140  Signal<Reporter&> destroyed;
141 
142  protected:
146  {}
147 };
148 
149 
150 class BriefReporter : public Reporter
151 {
152  public:
153  explicit BriefReporter(std::ostream* out = &std::cout);
154 
155  virtual ~BriefReporter();
156 
157  void setOutput(std::ostream& out);
158 
159  virtual void reportStart(const TestContext& test);
160 
161  virtual void reportFinish(const TestContext& test);
162 
163  virtual void reportMessage(const std::string& msg);
164 
165  virtual void reportSuccess(const TestContext& test);
166 
167  virtual void reportAssertion(const TestContext& test, const Assertion& a);
168 
169  virtual void reportException(const TestContext& test, const std::exception& ex);
170 
171  virtual void reportError(const TestContext& test);
172 
173  virtual void reportSkip(const TestContext& test);
174 
175  private:
178  std::ostream* _out;
179 };
180 
181 } // namespace unit
182 
183 } // namespace cxxtools
184 
185 #endif