2 * Copyright (c) 2014 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_runner.h>
25 #include <dpl/test/test_results_collector.h>
26 #include <dpl/exception.h>
27 #include <dpl/scoped_free.h>
28 #include <dpl/log/log.h>
29 #include <dpl/colors.h>
38 #include <libxml/xpath.h>
39 #include <libxml/xpathInternals.h>
40 #include <libxml/parser.h>
41 #include <libxml/tree.h>
43 #include <dpl/singleton_impl.h>
44 IMPLEMENT_SINGLETON(DPL::Test::TestRunner)
48 std::string getXMLNode(xmlNodePtr node)
51 xmlChar * value = xmlNodeGetContent(node);
52 ret = std::string(reinterpret_cast<char*>(value));
62 namespace // anonymous
64 std::string BaseName(std::string aPath)
66 ScopedFree<char> path(strdup(aPath.c_str()));
67 if (nullptr == path.Get()) {
68 throw std::bad_alloc();
70 char* baseName = basename(path.Get());
71 std::string retValue = baseName;
74 } // namespace anonymous
76 //! \brief Failed test message creator
78 //! \param[in] aTest string for tested expression
79 //! \param[in] aFile source file name
80 //! \param[in] aLine source file line
81 //! \param[in] aMessage error message
82 TestRunner::TestFailed::TestFailed(const char* aTest,
85 const std::string &aMessage)
87 std::ostringstream assertMsg;
88 assertMsg << "[" << BaseName(aFile) << ":" << aLine
89 << "] Assertion failed ("
90 << aTest << ") " << aMessage;
91 m_message = assertMsg.str();
94 TestRunner::TestFailed::TestFailed(const std::string &message)
99 void TestRunner::RegisterTest(const char *testName, TestCase proc)
101 m_testGroups[m_currentGroup].push_back(TestCaseStruct(testName, proc));
104 void TestRunner::InitGroup(const char* name)
106 m_currentGroup = name;
109 void TestRunner::normalizeXMLTag(std::string& str, const std::string& testcase)
111 //Add testcase if missing
112 std::string::size_type pos = str.find(testcase);
115 str = testcase + "_" + str;
118 //dpl test runner cannot have '-' character in name so it have to be replaced
119 // for TCT case to make comparision works
120 std::replace(str.begin(), str.end(), '-', '_');
123 bool TestRunner::filterGroupsByXmls(const std::vector<std::string> & files)
125 DECLARE_EXCEPTION_TYPE(DPL::Exception, XMLError)
127 const std::string idPath = "/test_definition/suite/set/testcase/@id";
130 std::map<std::string, bool> casesMap;
132 std::string testsuite;
133 if(!m_testGroups.empty())
135 for(TestCaseGroupMap::const_iterator cit = m_testGroups.begin(); cit != m_testGroups.end(); ++cit)
137 if(!cit->second.empty())
139 for(TestCaseStructList::const_iterator cj = cit->second.begin(); cj != cit->second.end(); ++cj)
141 std::string name = cj->name;
142 std::string::size_type st = name.find('_');
143 if(st != std::string::npos)
145 name = name.substr(0, st);
150 if(!testsuite.empty()) break;
161 for (const std::string &file : files)
164 xmlXPathContextPtr xpathCtx;
166 doc = xmlReadFile(file.c_str(), nullptr, 0);
167 if (doc == nullptr) {
168 ThrowMsg(XMLError, "File Problem");
171 xpathCtx = xmlXPathNewContext(doc);
172 if (xpathCtx == nullptr) {
174 "Error: unable to create new XPath context\n");
176 xpathCtx->node = xmlDocGetRootElement(doc);
180 xmlXPathObjectPtr xpathObject;
181 //get requested node's values
182 xpathObject = xmlXPathEvalExpression(BAD_CAST idPath.c_str(), xpathCtx);
183 if (xpathObject == nullptr)
185 ThrowMsg(XMLError, "XPath evaluation failure: " << idPath);
187 xmlNodeSetPtr nodes = xpathObject->nodesetval;
188 unsigned size = (nodes) ? nodes->nodeNr : 0;
189 LogDebug("Found " << size << " nodes matching xpath");
190 for(unsigned i = 0; i < size; ++i)
192 LogPedantic("Type: " << nodes->nodeTab[i]->type);
193 if (nodes->nodeTab[i]->type == XML_ATTRIBUTE_NODE) {
194 xmlNodePtr curNode = nodes->nodeTab[i];
195 result = getXMLNode(curNode);
196 LogPedantic("Result: " << result);
197 normalizeXMLTag(result, testsuite);
198 casesMap.insert(make_pair(result, false));
201 //Cleanup of XPath data
202 xmlXPathFreeObject(xpathObject);
203 xmlXPathFreeContext(xpathCtx);
209 LogError("Libxml error: " << _rethrown_exception.DumpToString());
214 if(!filterByXML(casesMap))
222 bool TestRunner::filterByXML(std::map<std::string, bool> & casesMap)
224 for (auto &group : m_testGroups) {
225 TestCaseStructList newList;
226 for (auto &tc : group.second)
228 if (casesMap.find(tc.name) != casesMap.end()) {
229 casesMap[tc.name] = true;
230 newList.push_back(tc);
233 group.second = newList;
235 for (auto &cs : casesMap)
237 if(cs.second == false)
239 LogError("Cannot find testcase from XML file: " << cs.first);
246 TestRunner::Status TestRunner::RunTestCase(const TestCaseStruct& testCase)
248 setCurrentTestCase(&(const_cast<TestCaseStruct &>(testCase)));
251 } catch (const TestFailed &e) {
252 // Simple test failure
253 CollectResult(testCase.name,
254 TestResultsCollectorBase::FailStatus::FAILED,
255 getConcatedFailReason(e.GetMessage()));
257 setCurrentTestCase(nullptr);
259 } catch (const Ignored &e) {
261 // Simple test have to be implemented
262 CollectResult(testCase.name,
263 TestResultsCollectorBase::FailStatus::IGNORED,
267 setCurrentTestCase(nullptr);
269 } catch (const std::exception &) {
270 // std exception failure
271 CollectResult(testCase.name,
272 TestResultsCollectorBase::FailStatus::FAILED,
275 setCurrentTestCase(nullptr);
278 // Unknown exception failure
279 CollectResult(testCase.name,
280 TestResultsCollectorBase::FailStatus::FAILED,
281 "unknown exception");
283 setCurrentTestCase(nullptr);
287 CollectResult(testCase.name,
288 TestResultsCollectorBase::FailStatus::NONE,
290 testCase.m_isPerformanceTest,
291 testCase.m_performanceTestDurationTime,
292 testCase.m_performanceMaxTime);
293 setCurrentTestCase(nullptr);
299 void TestRunner::RunTests()
301 using namespace DPL::Colors::Text;
304 for (auto &collector : m_collectors) {
305 collector.second->Start();
309 for (auto &group : m_testGroups) {
310 count += group.second.size();
312 fprintf(stderr, "%sFound %d testcases...%s\n", GREEN_BEGIN, count, GREEN_END);
313 fprintf(stderr, "%s%s%s\n", GREEN_BEGIN, "Running tests...", GREEN_END);
314 for (auto &group : m_testGroups) {
315 TestCaseStructList list = group.second;
317 for (auto &collector : m_collectors) {
318 collector.second->CollectCurrentTestGroupName(group.first);
322 for (TestCaseStructList::const_iterator iterator = list.begin();
323 iterator != list.end();
326 TestCaseStruct test = *iterator;
327 if (m_startTestId == test.name) {
331 if (m_startTestId.empty()) {
334 if (m_terminate == true) {
335 // Terminate quietly without any logs
342 std::for_each(m_collectors.begin(),
344 [] (const TestResultsCollectors::value_type & collector)
346 collector.second->Finish();
350 fprintf(stderr, "%s%s%s\n\n", GREEN_BEGIN, "Finished", GREEN_END);
353 TestRunner::TestCaseStruct *TestRunner::getCurrentTestCase()
355 return m_currentTestCase;
358 void TestRunner::setCurrentTestCase(TestCaseStruct* testCase)
360 m_currentTestCase = testCase;
363 void TestRunner::beginPerformanceTestTime(std::chrono::system_clock::duration maxTimeInMicroseconds)
365 TestCaseStruct* testCase = getCurrentTestCase();
369 testCase->m_isPerformanceTest = true;
370 testCase->m_performanceMaxTime = maxTimeInMicroseconds;
371 testCase->m_performanceTestStartTime = std::chrono::system_clock::now();
373 // Set result to 0 microseconds. Display 0ms result when end macro is missing.
374 testCase->m_performanceTestDurationTime = std::chrono::microseconds::zero();
377 void TestRunner::endPerformanceTestTime()
379 TestCaseStruct* testCase = getCurrentTestCase();
383 testCase->m_performanceTestDurationTime = std::chrono::system_clock::now() -
384 testCase->m_performanceTestStartTime;
387 void TestRunner::getCurrentTestCasePerformanceResult(bool& isPerformanceTest,
388 std::chrono::system_clock::duration& result,
389 std::chrono::system_clock::duration& resultMax)
391 TestCaseStruct* testCase = getCurrentTestCase();
392 if (!testCase || !(testCase->m_isPerformanceTest)){
393 isPerformanceTest = false;
397 isPerformanceTest = testCase->m_isPerformanceTest;
398 result = testCase->m_performanceTestDurationTime;
399 resultMax = testCase->m_performanceMaxTime;
402 void TestRunner::setCurrentTestCasePerformanceResult(bool isPerformanceTest,
403 std::chrono::system_clock::duration result,
404 std::chrono::system_clock::duration resultMax)
406 TestCaseStruct* testCase = getCurrentTestCase();
410 testCase->m_isPerformanceTest = isPerformanceTest;
411 testCase->m_performanceTestDurationTime = result;
412 testCase->m_performanceMaxTime = resultMax;
415 void TestRunner::addFailReason(const std::string &reason)
417 m_failReason.push(reason);
420 std::string TestRunner::getConcatedFailReason(const std::string &reason)
423 while (!m_failReason.empty())
425 ret += m_failReason.front();
431 void TestRunner::CollectResult(
432 const std::string& id,
433 const TestResultsCollectorBase::FailStatus status,
434 const std::string& reason,
435 const bool& isPerformanceTest,
436 const std::chrono::system_clock::duration& performanceTestDurationTime,
437 const std::chrono::system_clock::duration& performanceMaxTime)
439 std::for_each(m_collectors.begin(),
441 [&](const TestResultsCollectors::value_type & collector)
443 collector.second->CollectResult(id,
447 performanceTestDurationTime,
452 void TestRunner::Banner()
454 using namespace DPL::Colors::Text;
468 void TestRunner::InvalidArgs(const std::string& message)
470 using namespace DPL::Colors::Text;
478 void TestRunner::Usage()
480 fprintf(stderr, "Usage: runner [options]\n\n");
481 fprintf(stderr, "Output type:\n");
482 fprintf(stderr, " --output=<output type> --output=<output type> ...\n");
483 fprintf(stderr, "\n possible output types:\n");
484 for (std::string &type : TestResultsCollectorBase::GetCollectorsNames()) {
485 fprintf(stderr, " --output=%s\n", type.c_str());
487 fprintf(stderr, "\n example:\n");
489 " test-binary --output=text --output=xml --file=output.xml\n\n");
490 fprintf(stderr, "Other parameters:\n");
492 " --regexp='regexp'\t Only selected tests"
493 " which names match regexp run\n\n");
494 fprintf(stderr, " --start=<test id>\tStart from concrete test id");
495 fprintf(stderr, " --group=<group name>\t Run tests only from one group\n");
496 fprintf(stderr, " --runignored\t Run also ignored tests\n");
497 fprintf(stderr, " --list\t Show a list of Test IDs\n");
498 fprintf(stderr, " --listgroups\t Show a list of Test Group names \n");
499 fprintf(stderr, " --only-from-xml=<xml file>\t Run only testcases specified in XML file \n"
500 " XML name is taken from attribute id=\"part1_part2\" as whole.\n"
501 " If part1 is not found (no _) then it is implicitily "
502 "set according to suite part1 from binary tests\n");
505 " --listingroup=<group name>\t Show a list of Test IDS in one group\n");
506 fprintf(stderr, " --allowchildlogs\t Allow to print logs from child process on screen.\n");
507 fprintf(stderr, " When active child process will be able to print logs on stdout and stderr.\n");
508 fprintf(stderr, " Both descriptors will be closed after test.\n");
509 fprintf(stderr, " --help\t This help\n\n");
510 std::for_each(m_collectors.begin(),
512 [] (const TestResultsCollectors::value_type & collector)
515 "Output %s has specific args:\n",
516 collector.first.c_str());
520 CollectorSpecificHelp().c_str());
522 fprintf(stderr, "For bug reporting, please write to:\n");
523 fprintf(stderr, "<p.dobrowolsk@samsung.com>\n");
526 int TestRunner::ExecTestRunner(int argc, char *argv[])
528 std::vector<std::string> args;
529 for (int i = 0; i < argc; ++i) {
530 args.push_back(argv[i]);
532 return ExecTestRunner(args);
535 void TestRunner::MarkAssertion()
540 int TestRunner::ExecTestRunner(ArgsList args)
542 m_runIgnored = false;
543 // Parse command line
545 args.erase(args.begin());
547 bool showHelp = false;
548 bool justList = false;
549 std::vector<std::string> xmlFiles;
551 TestResultsCollectorBasePtr currentCollector;
553 // Parse each argument
554 for(std::string &arg : args)
556 const std::string regexp = "--regexp=";
557 const std::string output = "--output=";
558 const std::string groupId = "--group=";
559 const std::string runIgnored = "--runignored";
560 const std::string listCmd = "--list";
561 const std::string startCmd = "--start=";
562 const std::string listGroupsCmd = "--listgroups";
563 const std::string listInGroup = "--listingroup=";
564 const std::string allowChildLogs = "--allowchildlogs";
565 const std::string onlyFromXML = "--only-from-xml=";
567 if (currentCollector) {
568 if (currentCollector->ParseCollectorSpecificArg(arg)) {
573 if (arg.find(startCmd) == 0) {
574 arg.erase(0, startCmd.length());
575 for (auto &group : m_testGroups) {
576 for (auto &tc : group.second) {
577 if (tc.name == arg) {
582 if (!m_startTestId.empty()) {
586 if (!m_startTestId.empty()) {
590 fprintf(stderr, "Start test id has not been found\n");
593 } else if (arg.find(groupId) == 0) {
594 arg.erase(0, groupId.length());
595 TestCaseGroupMap::iterator found = m_testGroups.find(arg);
596 if (found != m_testGroups.end()) {
597 std::string name = found->first;
598 TestCaseStructList newList = found->second;
599 m_testGroups.clear();
600 m_testGroups[name] = newList;
602 fprintf(stderr, "Group %s not found\n", arg.c_str());
607 } else if (arg == runIgnored) {
609 } else if (arg == listCmd) {
611 } else if (arg == listGroupsCmd) {
612 for (auto &group : m_testGroups) {
613 printf("GR:%s\n", group.first.c_str());
616 } else if (arg.find(listInGroup) == 0) {
617 arg.erase(0, listInGroup.length());
618 for (auto &test : m_testGroups[arg]) {
619 printf("ID:%s\n", test.name.c_str());
622 } else if (arg.find(allowChildLogs) == 0) {
623 arg.erase(0, allowChildLogs.length());
624 m_allowChildLogs = true;
625 } else if (arg == "--help") {
627 } else if (arg.find(output) == 0) {
628 arg.erase(0, output.length());
629 if (m_collectors.find(arg) != m_collectors.end()) {
631 "Multiple outputs of the same type are not supported!");
635 currentCollector.reset(TestResultsCollectorBase::Create(arg));
636 if (!currentCollector) {
637 InvalidArgs("Unsupported output type!");
641 m_collectors[arg] = currentCollector;
642 } else if (arg.find(regexp) == 0) {
643 arg.erase(0, regexp.length());
644 if (arg.length() == 0) {
650 if (arg[0] == '\'' && arg[arg.length() - 1] == '\'') {
652 arg.erase(arg.length() - 1);
655 if (arg.length() == 0) {
661 pcrecpp::RE re(arg.c_str());
662 for (auto &group : m_testGroups) {
663 TestCaseStructList newList;
664 for (auto &tc : group.second)
666 if (re.PartialMatch(tc.name)) {
667 newList.push_back(tc);
670 group.second = newList;
672 } else if(arg.find(onlyFromXML) == 0) {
673 arg.erase(0, onlyFromXML.length());
674 if (arg.length() == 0) {
680 if (arg[0] == '\'' && arg[arg.length() - 1] == '\'') {
682 arg.erase(arg.length() - 1);
685 if (arg.length() == 0) {
691 xmlFiles.push_back(arg);
699 if(!xmlFiles.empty())
701 if(!filterGroupsByXmls(xmlFiles))
703 fprintf(stderr, "XML file is not correct\n");
710 for (auto &group : m_testGroups) {
711 for (auto &tc : group.second) {
712 printf("ID:%s:%s\n", group.first.c_str(), tc.name.c_str());
718 currentCollector.reset();
726 if (m_collectors.empty()) {
727 TestResultsCollectorBasePtr collector(
728 TestResultsCollectorBase::Create("text"));
729 m_collectors["text"] = collector;
732 for (auto &collector : m_collectors) {
733 if (!collector.second->Configure()) {
734 fprintf(stderr, "Could not configure selected output");
745 bool TestRunner::getRunIgnored() const
750 void TestRunner::Terminate()
755 bool TestRunner::GetAllowChildLogs()
757 return m_allowChildLogs;