src/framework/include/dpl/test/test_results_collector.h

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /*
  17  * @file        test_results_collector.h
  18  * @author      Lukasz Wrzosek (l.wrzosek@samsung.com)
  19  * @version     1.0
  20  * @brief       Header file with declaration of TestResultsCollectorBase
  21  */
  22
  23 #ifndef DPL_TEST_RESULTS_COLLECTOR_H
  24 #define DPL_TEST_RESULTS_COLLECTOR_H
  25
  26 #include <dpl/noncopyable.h>
  27 #include <vector>
  28 #include <list>
  29 #include <map>
  30 #include <chrono>
  31 #include <string>
  32 #include <memory>
  33
  34 namespace DPL {
  35 namespace Test {
  36 class TestResultsCollectorBase;
  37 typedef std::shared_ptr<TestResultsCollectorBase>
  38 TestResultsCollectorBasePtr;
  39
  40 class TestResultsCollectorBase :
  41     private DPL::Noncopyable
  42 {
  43   public:
  44     typedef TestResultsCollectorBase* (*CollectorConstructorFunc)();
  45     typedef std::list<std::string> TestCaseIdList;
  46     enum class FailStatus
  47     {
  48         NONE,
  49         FAILED,
  50         IGNORED
  51     };
  52
  53     virtual ~TestResultsCollectorBase() {}
  54
  55     virtual bool Configure()
  56     {
  57         return true;
  58     }
  59     virtual void Start() { }
  60     virtual void Finish() { }
  61     virtual void CollectCurrentTestGroupName(const std::string& /*groupName*/)
  62     {}
  63
  64     virtual void CollectTestsCasesList(const TestCaseIdList& /*list*/) {}
  65     virtual void CollectResult(const std::string& id,
  66                                const FailStatus status = FailStatus::NONE,
  67                                const std::string& reason = "",
  68                                const bool& isPerformanceTest = false,
  69                                const std::chrono::system_clock::duration& performanceTime = std::chrono::microseconds::zero(),
  70                                const std::chrono::system_clock::duration& performanceMaxTime = std::chrono::microseconds::zero()) = 0;
  71     virtual std::string CollectorSpecificHelp() const
  72     {
  73         return "";
  74     }
  75     virtual bool ParseCollectorSpecificArg (const std::string& /*arg*/)
  76     {
  77         return false;
  78     }
  79
  80     static TestResultsCollectorBase* Create(const std::string& name);
  81     static void RegisterCollectorConstructor(
  82         const std::string& name,
  83         CollectorConstructorFunc
  84         constructor);
  85     static std::vector<std::string> GetCollectorsNames();
  86
  87   private:
  88     typedef std::map<std::string, CollectorConstructorFunc> ConstructorsMap;
  89     static ConstructorsMap m_constructorsMap;
  90 };
  91 }
  92 }
  93
  94 #endif /* DPL_TEST_RESULTS_COLLECTOR_H */