framework/common/tcuResultCollector.hpp

   1 #ifndef _TCURESULTCOLLECTOR_HPP
   2 #define _TCURESULTCOLLECTOR_HPP
   3 /*-------------------------------------------------------------------------
   4  * drawElements Quality Program Tester Core
   5  * ----------------------------------------
   6  *
   7  * Copyright 2014 The Android Open Source Project
   8  *
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  *//*!
  22  * \file
  23  * \brief Test result collector
  24  *//*--------------------------------------------------------------------*/
  25
  26 #include "tcuDefs.hpp"
  27 #include "qpTestLog.h"
  28
  29 #include <string>
  30
  31 namespace tcu
  32 {
  33
  34 class TestLog;
  35 class TestContext;
  36
  37 /*--------------------------------------------------------------------*//*!
  38  * This utility class collects test results with associated messages,
  39  * optionally logs them, and finally sets the test result of a TestContext to
  40  * the most severe collected result. This allows multiple problems to be
  41  * easily reported from a single test run.
  42  *//*--------------------------------------------------------------------*/
  43 class ResultCollector
  44 {
  45 public:
  46                                                 ResultCollector                 (void);
  47                                                 ResultCollector                 (TestLog& log, const std::string& prefix = "");
  48
  49         qpTestResult            getResult                               (void) const;
  50         const std::string       getMessage                              (void) const { return m_message; }
  51
  52         void                            fail                                    (const std::string& msg);
  53         bool                            check                                   (bool condition, const std::string& msg);
  54
  55         void                            addResult                               (qpTestResult result, const std::string& msg);
  56         bool                            checkResult                             (bool condition, qpTestResult result, const std::string& msg);
  57
  58         void                            setTestContextResult    (TestContext& testCtx);
  59
  60 private:
  61         TestLog* const          m_log;
  62         const std::string       m_prefix;
  63         qpTestResult            m_result;
  64         std::string                     m_message;
  65 } DE_WARN_UNUSED_TYPE;
  66
  67 } // tcu
  68
  69 #endif // _TCURESULTCOLLECTOR_HPP