2 * Copyright (c) 2014-2017 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @file test_runner.cpp
18 * @author Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
19 * @author Lukasz Wrzosek (l.wrzosek@samsung.com)
21 * @brief This file is the implementation file of test runner
24 #include <dpl/test/test_failed.h>
25 #include <dpl/test/test_ignored.h>
26 #include <dpl/test/test_runner.h>
27 #include <dpl/test/test_results_collector.h>
28 #include <dpl/test/safe_cleanup.h>
29 #include <dpl/exception.h>
30 #include <dpl/scoped_free.h>
31 #include <dpl/log/log.h>
32 #include <dpl/colors.h>
41 #include <libxml/xpath.h>
42 #include <libxml/xpathInternals.h>
43 #include <libxml/parser.h>
44 #include <libxml/tree.h>
46 #include <dpl/singleton_impl.h>
47 IMPLEMENT_SINGLETON(DPL::Test::TestRunner)
51 std::string getXMLNode(xmlNodePtr node)
54 xmlChar * value = xmlNodeGetContent(node);
55 ret = std::string(reinterpret_cast<char*>(value));
65 TestResult::FailStatus TryCatch(const std::function<void(void)> &func, std::string &reason) {
68 } catch (const DPL::Test::TestFailed &e) {
69 reason = e.GetMessage();
70 return TestResult::FailStatus::FAILED;
71 } catch (const DPL::Test::TestIgnored &e) {
72 reason = e.GetMessage();
73 return TestResult::FailStatus::IGNORED;
74 } catch (const std::exception &e) {
76 return TestResult::FailStatus::FAILED;
78 reason = "Unknown exception";
79 return TestResult::FailStatus::FAILED;
81 reason = std::string();
82 return TestResult::FailStatus::NONE;
85 void TestRunner::RegisterTest(TestCasePtr testCase)
87 m_testGroups[m_currentGroup].push_back(testCase);
88 m_testCaseSet.insert(testCase);
91 void TestRunner::InitGroup(const char* name)
93 m_currentGroup = name;
96 void TestRunner::normalizeXMLTag(std::string& str, const std::string& testcase)
98 //Add testcase if missing
99 std::string::size_type pos = str.find(testcase);
102 str = testcase + "_" + str;
105 //dpl test runner cannot have '-' character in name so it have to be replaced
106 // for TCT case to make comparision works
107 std::replace(str.begin(), str.end(), '-', '_');
110 bool TestRunner::filterGroupsByXmls(const std::vector<std::string> & files)
112 DECLARE_EXCEPTION_TYPE(DPL::Exception, XMLError)
114 const std::string idPath = "/test_definition/suite/set/testcase/@id";
117 std::map<std::string, bool> casesMap;
119 std::string testsuite;
120 if(!m_testGroups.empty())
122 for(TestCaseGroupMap::const_iterator cit = m_testGroups.begin(); cit != m_testGroups.end(); ++cit)
124 if(!cit->second.empty())
126 for(TestCaseList::const_iterator cj = cit->second.begin(); cj != cit->second.end(); ++cj)
128 std::string name = (*cj)->GetName();
129 std::string::size_type st = name.find('_');
130 if(st != std::string::npos)
132 name = name.substr(0, st);
137 if(!testsuite.empty()) break;
148 for (const std::string &file : files)
151 xmlXPathContextPtr xpathCtx;
153 doc = xmlReadFile(file.c_str(), nullptr, 0);
154 if (doc == nullptr) {
155 ThrowMsg(XMLError, "File Problem");
158 xpathCtx = xmlXPathNewContext(doc);
159 if (xpathCtx == nullptr) {
161 "Error: unable to create new XPath context\n");
163 xpathCtx->node = xmlDocGetRootElement(doc);
167 xmlXPathObjectPtr xpathObject;
168 //get requested node's values
169 xpathObject = xmlXPathEvalExpression(BAD_CAST idPath.c_str(), xpathCtx);
170 if (xpathObject == nullptr)
172 ThrowMsg(XMLError, "XPath evaluation failure: " << idPath);
174 xmlNodeSetPtr nodes = xpathObject->nodesetval;
175 unsigned size = (nodes) ? nodes->nodeNr : 0;
176 LogDebug("Found " << size << " nodes matching xpath");
177 for(unsigned i = 0; i < size; ++i)
179 LogPedantic("Type: " << nodes->nodeTab[i]->type);
180 if (nodes->nodeTab[i]->type == XML_ATTRIBUTE_NODE) {
181 xmlNodePtr curNode = nodes->nodeTab[i];
182 result = getXMLNode(curNode);
183 LogPedantic("Result: " << result);
184 normalizeXMLTag(result, testsuite);
185 casesMap.insert(make_pair(result, false));
188 //Cleanup of XPath data
189 xmlXPathFreeObject(xpathObject);
190 xmlXPathFreeContext(xpathCtx);
196 LogError("Libxml error: " << _rethrown_exception.DumpToString());
201 if(!filterByXML(casesMap))
209 bool TestRunner::filterByXML(std::map<std::string, bool> & casesMap)
211 for (auto &group : m_testGroups) {
212 TestCaseList newList;
213 for (auto &tc : group.second)
215 if (casesMap.find(tc->GetName()) != casesMap.end()) {
216 casesMap[tc->GetName()] = true;
217 newList.push_back(tc);
220 group.second = newList;
222 for (auto &cs : casesMap)
224 if(cs.second == false)
226 LogError("Cannot find testcase from XML file: " << cs.first);
233 void TestRunner::RunTestCase(TestCasePtr testCase)
235 setCurrentTestCase(testCase);
236 m_deferDeepness = 0U;
238 std::string initReason;
239 TestResult::FailStatus initStatus = TryCatch(std::bind(&TestCase::Init, testCase),
241 if (initStatus != TestResult::FailStatus::NONE) {
242 CollectResult(testCase->GetName(),
243 TestResult(initStatus, getConcatedFailReason(initReason), testCase->GetPerformance()));
244 setCurrentTestCase(nullptr);
248 SafeCleanup::reset();
250 std::string testReason;
251 TestResult::FailStatus testStatus = TryCatch(std::bind(&TestCase::Test, testCase),
253 testReason = getConcatedFailReason(testReason);
254 std::string finishReason;
255 TestResult::FailStatus finishStatus = TryCatch(std::bind(&TestCase::Finish, testCase),
257 finishReason = getConcatedFailReason(finishReason);
259 std::string cleanupReason = SafeCleanup::dump();
261 switch (finishStatus) {
262 case TestResult::FailStatus::FAILED:
263 testStatus = TestResult::FailStatus::FAILED;
264 if (!testReason.empty())
266 testReason += finishReason;
267 if (!cleanupReason.empty()) {
268 if (!testReason.empty())
270 testReason += cleanupReason;
273 case TestResult::FailStatus::IGNORED:
274 if (testStatus == TestResult::FailStatus::NONE)
275 testStatus = TestResult::FailStatus::IGNORED;
276 if (!testReason.empty())
278 testReason += finishReason;
279 case TestResult::FailStatus::NONE:
280 if (!cleanupReason.empty()) {
281 if (!testReason.empty())
283 testReason += cleanupReason;
284 if (testStatus == TestResult::FailStatus::NONE)
285 testStatus = TestResult::FailStatus::FAILED;
289 Assert(false && "Unhandled fail status");
292 CollectResult(testCase->GetName(),
293 TestResult(testStatus, testReason, testCase->GetPerformance()));
294 setCurrentTestCase(nullptr);
297 void TestRunner::RunTests()
299 using namespace DPL::Colors::Text;
302 for (auto &collector : m_collectors) {
303 collector.second->Start();
307 for (auto &group : m_testGroups) {
308 count += group.second.size();
310 fprintf(stderr, "%sFound %d testcases...%s\n", GREEN_BEGIN, count, GREEN_END);
311 fprintf(stderr, "%s%s%s\n", GREEN_BEGIN, "Running tests...", GREEN_END);
312 for (auto &group : m_testGroups) {
313 TestCaseList list = group.second;
315 for (auto &collector : m_collectors) {
316 collector.second->CollectCurrentTestGroupName(group.first);
318 list.sort([](const TestCasePtr &a, const TestCasePtr &b) { return (*a < *b); });
320 for (TestCaseList::const_iterator iterator = list.begin();
321 iterator != list.end();
324 TestCasePtr test = *iterator;
325 if (m_startTestId == test->GetName()) {
329 if (m_startTestId.empty()) {
332 if (m_terminate == true) {
333 // Terminate quietly without any logs
340 std::for_each(m_collectors.begin(),
342 [] (const TestResultsCollectors::value_type & collector)
344 collector.second->Finish();
348 fprintf(stderr, "%s%s%s\n\n", GREEN_BEGIN, "Finished", GREEN_END);
351 TestCasePtr TestRunner::getCurrentTestCase()
353 return m_currentTestCase;
356 void TestRunner::setCurrentTestCase(TestCasePtr testCase)
358 m_currentTestCase = testCase;
361 void TestRunner::beginPerformance(std::chrono::system_clock::duration maxDurationInMicroseconds)
363 TestCasePtr testCase = getCurrentTestCase();
367 if (!testCase->GetPerformance())
368 testCase->SetPerformance(
369 std::unique_ptr<PerformanceResult> \
370 (new PerformanceResult(maxDurationInMicroseconds)));
373 void TestRunner::endPerformance()
375 TestCasePtr testCase = getCurrentTestCase();
379 testCase->GetPerformance()->Finish();
382 ConstPerformanceResultPtr TestRunner::getCurrentTestCasePerformanceResult()
384 TestCasePtr testCase = getCurrentTestCase();
388 return testCase->GetPerformance();
391 void TestRunner::setCurrentTestCasePerformanceResult(const PerformanceResultPtr &performance)
393 TestCasePtr testCase = getCurrentTestCase();
397 testCase->SetPerformance(performance);
400 void TestRunner::addFailReason(const std::string &reason)
402 m_failReason.push(reason);
405 std::string TestRunner::getConcatedFailReason(const std::string &reason)
408 while (!m_failReason.empty())
410 ret += m_failReason.front();
416 TestRunner::~TestRunner()
418 for(auto &t : m_testCaseSet)
422 void TestRunner::CollectResult(const std::string& id, const TestResult& result)
424 if (result.GetFailStatus() == TestResult::FailStatus::IGNORED && m_runIgnored)
427 std::for_each(m_collectors.begin(),
429 [&](const TestResultsCollectors::value_type & collector)
431 collector.second->CollectResult(id, result);
435 void TestRunner::Banner()
437 using namespace DPL::Colors::Text;
451 void TestRunner::InvalidArgs(const std::string& message)
453 using namespace DPL::Colors::Text;
461 void TestRunner::Usage()
463 fprintf(stderr, "Usage: runner [options]\n\n");
464 fprintf(stderr, "Output type:\n");
465 fprintf(stderr, " --output=<output type> --output=<output type> ...\n");
466 fprintf(stderr, "\n possible output types:\n");
467 for (std::string &type : TestResultsCollectorBase::GetCollectorsNames()) {
468 fprintf(stderr, " --output=%s\n", type.c_str());
470 fprintf(stderr, "\n example:\n");
472 " test-binary --output=text --output=xml --file=output.xml\n\n");
473 fprintf(stderr, "Other parameters:\n");
474 fprintf(stderr, " --test=<test name> Run only one test\n");
476 " --regexp='regexp'\t Only selected tests"
477 " which names match regexp run\n\n");
478 fprintf(stderr, " --start=<test id>\tStart from concrete test id\n");
479 fprintf(stderr, " --group=<group name>\t Run tests only from one group\n");
480 fprintf(stderr, " --runignored\t Run also ignored tests\n");
481 fprintf(stderr, " --list\t Show a list of Test IDs\n");
482 fprintf(stderr, " --listgroups\t Show a list of Test Group names \n");
483 fprintf(stderr, " --only-from-xml=<xml file>\t Run only testcases specified in XML file \n"
484 " XML name is taken from attribute id=\"part1_part2\" as whole.\n"
485 " If part1 is not found (no _) then it is implicitily "
486 "set according to suite part1 from binary tests\n");
489 " --listingroup=<group name>\t Show a list of Test IDS in one group\n");
490 fprintf(stderr, " --allowchildlogs\t Allow to print logs from child process on screen.\n");
491 fprintf(stderr, " When active child process will be able to print logs on stdout and stderr.\n");
492 fprintf(stderr, " Both descriptors will be closed after test.\n");
493 fprintf(stderr, " --help\t This help\n\n");
494 std::for_each(m_collectors.begin(),
496 [] (const TestResultsCollectors::value_type & collector)
499 "Output %s has specific args:\n",
500 collector.first.c_str());
504 CollectorSpecificHelp().c_str());
506 fprintf(stderr, "For bug reporting, please write to:\n");
507 fprintf(stderr, "<p.dobrowolsk@samsung.com>\n");
510 int TestRunner::ExecTestRunner(int argc, char *argv[])
512 std::vector<std::string> args;
513 for (int i = 0; i < argc; ++i) {
514 args.push_back(argv[i]);
516 return ExecTestRunner(args);
519 int TestRunner::ExecTestRunner(ArgsList args)
521 m_runIgnored = false;
522 // Parse command line
524 args.erase(args.begin());
526 bool showHelp = false;
527 bool justList = false;
528 std::vector<std::string> xmlFiles;
530 TestResultsCollectorBasePtr currentCollector;
532 // Parse each argument
533 for(std::string &arg : args)
535 const std::string test = "--test=";
536 const std::string regexp = "--regexp=";
537 const std::string output = "--output=";
538 const std::string groupId = "--group=";
539 const std::string runIgnored = "--runignored";
540 const std::string listCmd = "--list";
541 const std::string startCmd = "--start=";
542 const std::string listGroupsCmd = "--listgroups";
543 const std::string listInGroup = "--listingroup=";
544 const std::string allowChildLogs = "--allowchildlogs";
545 const std::string onlyFromXML = "--only-from-xml=";
547 if (currentCollector) {
548 if (currentCollector->ParseCollectorSpecificArg(arg)) {
553 if (arg.find(startCmd) == 0) {
554 arg.erase(0, startCmd.length());
555 for (auto &group : m_testGroups) {
556 for (auto &tc : group.second) {
557 if (tc->GetName() == arg) {
562 if (!m_startTestId.empty()) {
566 if (!m_startTestId.empty()) {
570 fprintf(stderr, "Start test id has not been found\n");
573 } else if (arg.find(groupId) == 0) {
574 arg.erase(0, groupId.length());
575 TestCaseGroupMap::iterator found = m_testGroups.find(arg);
576 if (found != m_testGroups.end()) {
577 std::string name = found->first;
578 TestCaseList newList = found->second;
579 m_testGroups.clear();
580 m_testGroups[name] = newList;
582 fprintf(stderr, "Group %s not found\n", arg.c_str());
587 } else if (arg == runIgnored) {
589 } else if (arg == listCmd) {
591 } else if (arg == listGroupsCmd) {
592 for (auto &group : m_testGroups) {
593 printf("GR:%s\n", group.first.c_str());
596 } else if (arg.find(listInGroup) == 0) {
597 arg.erase(0, listInGroup.length());
598 for (auto &test : m_testGroups[arg]) {
599 printf("ID:%s\n", test->GetName().c_str());
602 } else if (arg.find(allowChildLogs) == 0) {
603 arg.erase(0, allowChildLogs.length());
604 m_allowChildLogs = true;
605 } else if (arg == "--help") {
607 } else if (arg.find(output) == 0) {
608 arg.erase(0, output.length());
609 if (m_collectors.find(arg) != m_collectors.end()) {
611 "Multiple outputs of the same type are not supported!");
615 currentCollector.reset(TestResultsCollectorBase::Create(arg));
616 if (!currentCollector) {
617 InvalidArgs("Unsupported output type!");
621 m_collectors[arg] = currentCollector;
622 } else if (arg.find(regexp) == 0) {
623 arg.erase(0, regexp.length());
624 if (arg.length() == 0) {
630 if (arg[0] == '\'' && arg[arg.length() - 1] == '\'') {
632 arg.erase(arg.length() - 1);
635 if (arg.length() == 0) {
641 pcrecpp::RE re(arg.c_str());
642 for (auto &group : m_testGroups) {
643 TestCaseList newList;
644 for (auto &tc : group.second)
646 if (re.PartialMatch(tc->GetName())) {
647 newList.push_back(tc);
650 group.second = newList;
652 } else if (arg.find(test) == 0) {
653 arg.erase(0, test.length());
654 if (arg.length() == 0) {
660 if (arg[0] == '\'' && arg[arg.length() - 1] == '\'') {
662 arg.erase(arg.length() - 1);
665 if (arg.length() == 0) {
671 pcrecpp::RE re(arg.c_str());
672 for (auto &group : m_testGroups) {
673 TestCaseList newList;
674 for (auto &tc : group.second)
676 if (re.FullMatch(tc->GetName())) {
677 newList.push_back(tc);
680 group.second = newList;
682 } else if(arg.find(onlyFromXML) == 0) {
683 arg.erase(0, onlyFromXML.length());
684 if (arg.length() == 0) {
690 if (arg[0] == '\'' && arg[arg.length() - 1] == '\'') {
692 arg.erase(arg.length() - 1);
695 if (arg.length() == 0) {
701 xmlFiles.push_back(arg);
709 if(!xmlFiles.empty())
711 if(!filterGroupsByXmls(xmlFiles))
713 fprintf(stderr, "XML file is not correct\n");
720 for (auto &group : m_testGroups) {
721 for (auto &tc : group.second) {
722 printf("ID:%s:%s\n", group.first.c_str(), tc->GetName().c_str());
728 currentCollector.reset();
736 if (m_collectors.empty()) {
737 TestResultsCollectorBasePtr collector(
738 TestResultsCollectorBase::Create("text"));
739 m_collectors["text"] = collector;
742 for (auto &collector : m_collectors) {
743 if (!collector.second->Configure()) {
744 fprintf(stderr, "Could not configure selected output");
755 void TestRunner::Terminate()
760 bool TestRunner::GetAllowChildLogs()
762 return m_allowChildLogs;
765 void TestRunner::deferFailedException(const DPL::Test::TestFailed &ex)
767 if (m_deferDeepness <= 0)
770 if (m_deferredExceptionsMessages.empty()) {
771 m_firstDeferredFail = ex;
772 m_firstDeferredExceptionType = DeferredExceptionType::DEFERRED_FAILED;
774 m_deferredExceptionsMessages.push_back(ex.GetMessage());
777 void TestRunner::deferIgnoredException(const DPL::Test::TestIgnored &ex)
779 if (m_deferDeepness <= 0)
782 if (m_deferredExceptionsMessages.empty()) {
783 m_firstDeferredIgnore = ex;
784 m_firstDeferredExceptionType = DeferredExceptionType::DEFERRED_IGNORED;
786 m_deferredExceptionsMessages.push_back(ex.GetMessage());
789 void TestRunner::deferBegin()
794 void TestRunner::deferEnd()
796 if (m_deferDeepness > 0)
799 if (m_deferDeepness > 0)
802 for (size_t i = 0; i < m_deferredExceptionsMessages.size(); ++i) {
803 addFailReason(m_deferredExceptionsMessages[i]);
806 if (!m_deferredExceptionsMessages.empty())
808 m_deferredExceptionsMessages.clear();
809 switch (m_firstDeferredExceptionType) {
810 case DeferredExceptionType::DEFERRED_FAILED:
811 throw m_firstDeferredFail;
812 case DeferredExceptionType::DEFERRED_IGNORED:
813 throw m_firstDeferredIgnore;
816 m_deferredExceptionsMessages.clear();