/usr/include/trilinos/Teuchos_UnitTestRepository.hpp is in libtrilinos-teuchos-dev 12.4.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | // @HEADER
// ***********************************************************************
//
// Teuchos: Common Tools Package
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef TEUCHOS_UNIT_TEST_REPOSITORY_HPP
#define TEUCHOS_UNIT_TEST_REPOSITORY_HPP
/*! \file Teuchos_UnitTestRepository.hpp
\brief Unit testing support.
*/
#include "Teuchos_FancyOStream.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"
#include "Teuchos_Ptr.hpp"
namespace Teuchos {
class UnitTestBase;
class CommandLineProcessor;
/** \brief Singleton unit testing repository.
*
* This class is the universal driver for unit testing. This class should be
* almost completely invisible to a user of the test harness. The main
* interaction is through command-line arguments set and processed by calling
* runUnitTestsFromMain() from a main() function. See --help for details of
* the options. For a more general overview, see \ref Teuchos_UnitTest_grp.
*/
class TEUCHOSCORE_LIB_DLL_EXPORT UnitTestRepository {
public:
/** \brief Return the CLP to add options to. */
static CommandLineProcessor& getCLP();
/** \brief Set if the unit tests should reduce pass/fail across processes. */
static void setGloballyReduceTestResult(const bool globallyReduceUnitTestResult);
/** \brief Get if the unit tests should reduce across processes or not. */
static bool getGloballyReduceTestResult();
/** \brief Run the registered unit tests */
static bool runUnitTests(FancyOStream &out);
/** \brief Run the unit tests from main() passing in (argc, argv).
*
* \returns Returns the appropriate int for main()
*/
static int runUnitTestsFromMain(int argc, char* argv[]);
/** \brief Add an unit test (called indirectly through macros.
*
* unittest [in] The unit test. NOTE: the memory of *unittest must be persistant.
*/
static void addUnitTest(UnitTestBase *unitTest, const std::string groupName,
const std::string testName);
/** \brief Returns if unit tests are verbose or not.
*
* This can be used in individual unit tests that need to know if the unit
* test harness is running in verbose mode. This is useful when the unit
* test's std::ostream 'out' can not be printed to (for example, when
* Fortran is testing is running).
*/
static bool verboseUnitTests();
private:
UnitTestRepository();
static void setUpCLP(const Ptr<CommandLineProcessor>& clp);
class InstanceData;
static InstanceData& getData();
static bool runUnitTestImpl(const UnitTestBase &unitTest, FancyOStream &out);
};
} // namespace Teuchos
#endif // TEUCHOS_UNIT_TEST_REPOSITORY_HPP
|