Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_UnitTestRepository.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef TEUCHOS_UNIT_TEST_REPOSITORY_HPP
43 #define TEUCHOS_UNIT_TEST_REPOSITORY_HPP
44 
45 
51 #include "Teuchos_FancyOStream.hpp"
53 #include "Teuchos_Ptr.hpp"
54 
55 
56 namespace Teuchos {
57 
58 
59 class UnitTestBase;
60 
61 
62 class CommandLineProcessor;
63 
64 
73 class TEUCHOSCORE_LIB_DLL_EXPORT UnitTestRepository {
74 public:
75 
77  static CommandLineProcessor& getCLP();
78 
80  static void setGloballyReduceTestResult(const bool globallyReduceUnitTestResult);
81 
83  static bool getGloballyReduceTestResult();
84 
86  static bool runUnitTests(FancyOStream &out);
87 
92  static int runUnitTestsFromMain(int argc, char* argv[]);
93 
98  static void addUnitTest(UnitTestBase *unitTest, const std::string groupName,
99  const std::string testName);
100 
108  static bool verboseUnitTests();
109 
110 private:
111 
113 
114  static void setUpCLP(const Ptr<CommandLineProcessor>& clp);
115 
116  class InstanceData;
117 
118  static InstanceData& getData();
119 
120  static bool runUnitTestImpl(const UnitTestBase &unitTest, FancyOStream &out);
121 
122 };
123 
124 
125 } // namespace Teuchos
126 
127 
128 #endif // TEUCHOS_UNIT_TEST_REPOSITORY_HPP
Macro that adds &lt;&lt;std member=&quot;&quot; comp&gt;=&quot;&quot;&gt;&gt; members as attribute members for any class.
std::ostream subclass that performs the magic of indenting data sent to an std::ostream object among ...
Singleton unit testing repository.
Unit test base class.
Class that helps parse command line input arguments from (argc,argv[]) and set options.
Simple wrapper class for raw pointers to single objects where no persisting relationship exists...