src/framework/src/test_runner.cpp

   1 /*
   2  * Copyright (c) 2014-2015 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_runner.cpp
  18  * @author      Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
  19  * @author      Lukasz Wrzosek (l.wrzosek@samsung.com)
  20  * @version     1.0
  21  * @brief       This file is the implementation file of test runner
  22  */
  23 #include <stddef.h>
  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>
  30 #include <pcrecpp.h>
  31 #include <algorithm>
  32 #include <cstdio>
  33 #include <memory.h>
  34 #include <libgen.h>
  35 #include <cstring>
  36 #include <cstdlib>
  37
  38 #include <libxml/xpath.h>
  39 #include <libxml/xpathInternals.h>
  40 #include <libxml/parser.h>
  41 #include <libxml/tree.h>
  42
  43 #include <dpl/singleton_impl.h>
  44 IMPLEMENT_SINGLETON(DPL::Test::TestRunner)
  45
  46 namespace {
  47
  48 std::string getXMLNode(xmlNodePtr node)
  49 {
  50     std::string ret;
  51     xmlChar * value = xmlNodeGetContent(node);
  52     ret = std::string(reinterpret_cast<char*>(value));
  53     xmlFree(value);
  54     return ret;
  55 }
  56
  57 }
  58
  59
  60 namespace DPL {
  61 namespace Test {
  62 namespace // anonymous
  63 {
  64 std::string BaseName(std::string aPath)
  65 {
  66     ScopedFree<char> path(strdup(aPath.c_str()));
  67     if (nullptr == path.Get()) {
  68         throw std::bad_alloc();
  69     }
  70     char* baseName = basename(path.Get());
  71     std::string retValue = baseName;
  72     return retValue;
  73 }
  74 } // namespace anonymous
  75
  76 //! \brief Failed test message creator
  77 //!
  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,
  83                                    const char* aFile,
  84                                    int aLine,
  85                                    const std::string &aMessage)
  86 {
  87     std::ostringstream assertMsg;
  88     assertMsg << "[" << BaseName(aFile) << ":" << aLine
  89               << "] Assertion failed ("
  90               << aTest << ") " << aMessage;
  91     m_message = assertMsg.str();
  92 }
  93
  94 TestRunner::TestFailed::TestFailed(const std::string &message)
  95 {
  96     m_message = message;
  97 }
  98
  99 void TestRunner::RegisterTest(const char *testName, TestCase proc)
 100 {
 101     m_testGroups[m_currentGroup].push_back(TestCaseStruct(testName, proc));
 102 }
 103
 104 void TestRunner::InitGroup(const char* name)
 105 {
 106     m_currentGroup = name;
 107 }
 108
 109 void TestRunner::normalizeXMLTag(std::string& str, const std::string& testcase)
 110 {
 111     //Add testcase if missing
 112     std::string::size_type pos = str.find(testcase);
 113     if(pos != 0)
 114     {
 115         str = testcase + "_" + str;
 116     }
 117
 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(), '-', '_');
 121 }
 122
 123 bool TestRunner::filterGroupsByXmls(const std::vector<std::string> & files)
 124 {
 125     DECLARE_EXCEPTION_TYPE(DPL::Exception, XMLError)
 126
 127     const std::string idPath = "/test_definition/suite/set/testcase/@id";
 128
 129     bool success = true;
 130     std::map<std::string, bool> casesMap;
 131
 132     std::string testsuite;
 133     if(!m_testGroups.empty())
 134     {
 135         for(TestCaseGroupMap::const_iterator cit = m_testGroups.begin(); cit != m_testGroups.end(); ++cit)
 136         {
 137             if(!cit->second.empty())
 138             {
 139                 for(TestCaseStructList::const_iterator cj = cit->second.begin(); cj != cit->second.end(); ++cj)
 140                 {
 141                     std::string name = cj->name;
 142                     std::string::size_type st = name.find('_');
 143                     if(st != std::string::npos)
 144                     {
 145                         name = name.substr(0, st);
 146                         testsuite = name;
 147                         break;
 148                     }
 149                 }
 150                 if(!testsuite.empty()) break;
 151             }
 152         }
 153     }
 154
 155     xmlInitParser();
 156     LIBXML_TEST_VERSION
 157     xmlXPathInit();
 158
 159     Try
 160     {
 161         for (const std::string &file : files)
 162         {
 163             xmlDocPtr doc;
 164             xmlXPathContextPtr xpathCtx;
 165
 166             doc = xmlReadFile(file.c_str(), nullptr, 0);
 167             if (doc == nullptr) {
 168                 ThrowMsg(XMLError, "File Problem");
 169             } else {
 170                 //context
 171                 xpathCtx = xmlXPathNewContext(doc);
 172                 if (xpathCtx == nullptr) {
 173                     ThrowMsg(XMLError,
 174                              "Error: unable to create new XPath context\n");
 175                 }
 176                 xpathCtx->node = xmlDocGetRootElement(doc);
 177             }
 178
 179             std::string result;
 180             xmlXPathObjectPtr xpathObject;
 181             //get requested node's values
 182             xpathObject = xmlXPathEvalExpression(BAD_CAST idPath.c_str(), xpathCtx);
 183             if (xpathObject == nullptr)
 184             {
 185                 ThrowMsg(XMLError, "XPath evaluation failure: " << idPath);
 186             }
 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)
 191             {
 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));
 199                 }
 200             }
 201             //Cleanup of XPath data
 202             xmlXPathFreeObject(xpathObject);
 203             xmlXPathFreeContext(xpathCtx);
 204             xmlFreeDoc(doc);
 205         }
 206     }
 207     Catch(XMLError)
 208     {
 209         LogError("Libxml error: " << _rethrown_exception.DumpToString());
 210         success = false;
 211     }
 212     xmlCleanupParser();
 213
 214     if(!filterByXML(casesMap))
 215     {
 216         success = false;
 217     }
 218
 219     return success;
 220 }
 221
 222 bool TestRunner::filterByXML(std::map<std::string, bool> & casesMap)
 223 {
 224     for (auto &group : m_testGroups) {
 225         TestCaseStructList newList;
 226         for (auto &tc : group.second)
 227         {
 228             if (casesMap.find(tc.name) != casesMap.end()) {
 229                 casesMap[tc.name] = true;
 230                 newList.push_back(tc);
 231             }
 232         }
 233         group.second = newList;
 234     }
 235     for (auto &cs : casesMap)
 236     {
 237         if(cs.second == false)
 238         {
 239             LogError("Cannot find testcase from XML file: " << cs.first);
 240             return false;
 241         }
 242     }
 243     return true;
 244 }
 245
 246 void TestRunner::RunTestCase(const TestCaseStruct& testCase)
 247 {
 248     setCurrentTestCase(&(const_cast<TestCaseStruct &>(testCase)));
 249     try {
 250         testCase.proc();
 251     } catch (const TestFailed &e) {
 252         // Simple test failure
 253         CollectResult(testCase.name,
 254                       TestResult(TestResult::FailStatus::FAILED,
 255                                  getConcatedFailReason(e.GetMessage())));
 256
 257         setCurrentTestCase(nullptr);
 258         return;
 259     } catch (const Ignored &e) {
 260         if (m_runIgnored) {
 261             // Simple test have to be implemented
 262             CollectResult(testCase.name,
 263                           TestResult(TestResult::FailStatus::IGNORED, e.GetMessage()));
 264         }
 265
 266         setCurrentTestCase(nullptr);
 267         return;
 268     } catch (const std::exception &) {
 269         // std exception failure
 270         CollectResult(testCase.name,
 271                       TestResult(TestResult::FailStatus::FAILED, "std exception"));
 272
 273         setCurrentTestCase(nullptr);
 274         return;
 275     } catch (...) {
 276         // Unknown exception failure
 277         CollectResult(testCase.name,
 278                       TestResult(TestResult::FailStatus::FAILED, "unknown exception"));
 279         setCurrentTestCase(nullptr);
 280         return;
 281     }
 282
 283     // Everything OK
 284     CollectResult(testCase.name,
 285                   TestResult(TestResult::FailStatus::NONE,
 286                              std::string(),
 287                              testCase.performance));
 288     setCurrentTestCase(nullptr);
 289 }
 290
 291 void TestRunner::RunTests()
 292 {
 293     using namespace DPL::Colors::Text;
 294
 295     Banner();
 296     for (auto &collector : m_collectors) {
 297         collector.second->Start();
 298     }
 299
 300     unsigned count = 0;
 301     for (auto &group : m_testGroups) {
 302         count += group.second.size();
 303     }
 304     fprintf(stderr, "%sFound %d testcases...%s\n", GREEN_BEGIN, count, GREEN_END);
 305     fprintf(stderr, "%s%s%s\n", GREEN_BEGIN, "Running tests...", GREEN_END);
 306     for (auto &group : m_testGroups) {
 307         TestCaseStructList list = group.second;
 308         if (!list.empty()) {
 309             for (auto &collector : m_collectors) {
 310                 collector.second->CollectCurrentTestGroupName(group.first);
 311             }
 312             list.sort();
 313
 314             for (TestCaseStructList::const_iterator iterator = list.begin();
 315                  iterator != list.end();
 316                  ++iterator)
 317             {
 318                 TestCaseStruct test = *iterator;
 319                 if (m_startTestId == test.name) {
 320                     m_startTestId = "";
 321                 }
 322
 323                 if (m_startTestId.empty()) {
 324                     RunTestCase(test);
 325                 }
 326                 if (m_terminate == true) {
 327                     // Terminate quietly without any logs
 328                     return;
 329                 }
 330             }
 331         }
 332     }
 333
 334     std::for_each(m_collectors.begin(),
 335                   m_collectors.end(),
 336                   [] (const TestResultsCollectors::value_type & collector)
 337                   {
 338                       collector.second->Finish();
 339                   });
 340
 341     // Finished
 342     fprintf(stderr, "%s%s%s\n\n", GREEN_BEGIN, "Finished", GREEN_END);
 343 }
 344
 345 TestRunner::TestCaseStruct *TestRunner::getCurrentTestCase()
 346 {
 347     return m_currentTestCase;
 348 }
 349
 350 void TestRunner::setCurrentTestCase(TestCaseStruct* testCase)
 351 {
 352     m_currentTestCase = testCase;
 353 }
 354
 355 void TestRunner::beginPerformance(std::chrono::system_clock::duration maxDurationInMicroseconds)
 356 {
 357     TestCaseStruct* testCase = getCurrentTestCase();
 358     if (!testCase)
 359         return;
 360
 361     if (!testCase->performance)
 362         testCase->performance.reset(new PerformanceResult(maxDurationInMicroseconds));
 363 }
 364
 365 void TestRunner::endPerformance()
 366 {
 367     TestCaseStruct* testCase = getCurrentTestCase();
 368     if (!testCase)
 369         return;
 370
 371     testCase->performance->Finish();
 372 }
 373
 374 ConstPerformanceResultPtr TestRunner::getCurrentTestCasePerformanceResult()
 375 {
 376     TestCaseStruct* testCase = getCurrentTestCase();
 377     if (!testCase)
 378         return nullptr;
 379
 380     return testCase->performance;
 381 }
 382
 383 void TestRunner::setCurrentTestCasePerformanceResult(const PerformanceResultPtr &performance)
 384 {
 385     TestCaseStruct* testCase = getCurrentTestCase();
 386     if (!testCase)
 387         return;
 388
 389     testCase->performance = performance;
 390 }
 391
 392 void TestRunner::addFailReason(const std::string &reason)
 393 {
 394     m_failReason.push(reason);
 395 }
 396
 397 std::string TestRunner::getConcatedFailReason(const std::string &reason)
 398 {
 399     std::string ret;
 400     while (!m_failReason.empty())
 401     {
 402         ret += m_failReason.front();
 403         m_failReason.pop();
 404     }
 405     return reason + ret;
 406 }
 407
 408 void TestRunner::CollectResult(const std::string& id, const TestResult& result)
 409 {
 410     std::for_each(m_collectors.begin(),
 411                   m_collectors.end(),
 412                   [&](const TestResultsCollectors::value_type & collector)
 413                   {
 414                       collector.second->CollectResult(id, result);
 415                   });
 416 }
 417
 418 void TestRunner::Banner()
 419 {
 420     using namespace DPL::Colors::Text;
 421     fprintf(stderr,
 422             "%s%s%s\n",
 423             BOLD_GREEN_BEGIN,
 424             "DPL tests runner",
 425             BOLD_GREEN_END);
 426     fprintf(stderr,
 427             "%s%s%s%s\n\n",
 428             GREEN_BEGIN,
 429             "Build: ",
 430             __TIMESTAMP__,
 431             GREEN_END);
 432 }
 433
 434 void TestRunner::InvalidArgs(const std::string& message)
 435 {
 436     using namespace DPL::Colors::Text;
 437     fprintf(stderr,
 438             "%s%s%s\n",
 439             BOLD_RED_BEGIN,
 440             message.c_str(),
 441             BOLD_RED_END);
 442 }
 443
 444 void TestRunner::Usage()
 445 {
 446     fprintf(stderr, "Usage: runner [options]\n\n");
 447     fprintf(stderr, "Output type:\n");
 448     fprintf(stderr, "  --output=<output type> --output=<output type> ...\n");
 449     fprintf(stderr, "\n  possible output types:\n");
 450     for (std::string &type : TestResultsCollectorBase::GetCollectorsNames()) {
 451         fprintf(stderr, "    --output=%s\n", type.c_str());
 452     }
 453     fprintf(stderr, "\n  example:\n");
 454     fprintf(stderr,
 455             "    test-binary --output=text --output=xml --file=output.xml\n\n");
 456     fprintf(stderr, "Other parameters:\n");
 457     fprintf(stderr,
 458             "  --regexp='regexp'\t Only selected tests"
 459             " which names match regexp run\n\n");
 460     fprintf(stderr, "  --start=<test id>\tStart from concrete test id");
 461     fprintf(stderr, "  --group=<group name>\t Run tests only from one group\n");
 462     fprintf(stderr, "  --runignored\t Run also ignored tests\n");
 463     fprintf(stderr, "  --list\t Show a list of Test IDs\n");
 464     fprintf(stderr, "  --listgroups\t Show a list of Test Group names \n");
 465     fprintf(stderr, "  --only-from-xml=<xml file>\t Run only testcases specified in XML file \n"
 466                     "       XML name is taken from attribute id=\"part1_part2\" as whole.\n"
 467                     "       If part1 is not found (no _) then it is implicitily "
 468                            "set according to suite part1 from binary tests\n");
 469     fprintf(
 470         stderr,
 471         "  --listingroup=<group name>\t Show a list of Test IDS in one group\n");
 472     fprintf(stderr, "  --allowchildlogs\t Allow to print logs from child process on screen.\n");
 473     fprintf(stderr, "       When active child process will be able to print logs on stdout and stderr.\n");
 474     fprintf(stderr, "       Both descriptors will be closed after test.\n");
 475     fprintf(stderr, "  --help\t This help\n\n");
 476     std::for_each(m_collectors.begin(),
 477                   m_collectors.end(),
 478                   [] (const TestResultsCollectors::value_type & collector)
 479                   {
 480                       fprintf(stderr,
 481                               "Output %s has specific args:\n",
 482                               collector.first.c_str());
 483                       fprintf(stderr,
 484                               "%s\n",
 485                               collector.second->
 486                                   CollectorSpecificHelp().c_str());
 487                   });
 488     fprintf(stderr, "For bug reporting, please write to:\n");
 489     fprintf(stderr, "<p.dobrowolsk@samsung.com>\n");
 490 }
 491
 492 int TestRunner::ExecTestRunner(int argc, char *argv[])
 493 {
 494     std::vector<std::string> args;
 495     for (int i = 0; i < argc; ++i) {
 496         args.push_back(argv[i]);
 497     }
 498     return ExecTestRunner(args);
 499 }
 500
 501 void TestRunner::MarkAssertion()
 502 {
 503     ++m_totalAssertions;
 504 }
 505
 506 int TestRunner::ExecTestRunner(ArgsList args)
 507 {
 508     m_runIgnored = false;
 509     // Parse command line
 510
 511     args.erase(args.begin());
 512
 513     bool showHelp = false;
 514     bool justList = false;
 515     std::vector<std::string> xmlFiles;
 516
 517     TestResultsCollectorBasePtr currentCollector;
 518
 519     // Parse each argument
 520     for(std::string &arg : args)
 521     {
 522         const std::string regexp = "--regexp=";
 523         const std::string output = "--output=";
 524         const std::string groupId = "--group=";
 525         const std::string runIgnored = "--runignored";
 526         const std::string listCmd = "--list";
 527         const std::string startCmd = "--start=";
 528         const std::string listGroupsCmd = "--listgroups";
 529         const std::string listInGroup = "--listingroup=";
 530         const std::string allowChildLogs = "--allowchildlogs";
 531         const std::string onlyFromXML = "--only-from-xml=";
 532
 533         if (currentCollector) {
 534             if (currentCollector->ParseCollectorSpecificArg(arg)) {
 535                 continue;
 536             }
 537         }
 538
 539         if (arg.find(startCmd) == 0) {
 540             arg.erase(0, startCmd.length());
 541             for (auto &group : m_testGroups) {
 542                 for (auto &tc : group.second) {
 543                     if (tc.name == arg) {
 544                         m_startTestId = arg;
 545                         break;
 546                     }
 547                 }
 548                 if (!m_startTestId.empty()) {
 549                     break;
 550                 }
 551             }
 552             if (!m_startTestId.empty()) {
 553                 continue;
 554             }
 555             InvalidArgs();
 556             fprintf(stderr, "Start test id has not been found\n");
 557             Usage();
 558             return 0;
 559         } else if (arg.find(groupId) == 0) {
 560             arg.erase(0, groupId.length());
 561             TestCaseGroupMap::iterator found = m_testGroups.find(arg);
 562             if (found != m_testGroups.end()) {
 563                 std::string name = found->first;
 564                 TestCaseStructList newList = found->second;
 565                 m_testGroups.clear();
 566                 m_testGroups[name] = newList;
 567             } else {
 568                 fprintf(stderr, "Group %s not found\n", arg.c_str());
 569                 InvalidArgs();
 570                 Usage();
 571                 return -1;
 572             }
 573         } else if (arg == runIgnored) {
 574             m_runIgnored = true;
 575         } else if (arg == listCmd) {
 576             justList = true;
 577         } else if (arg == listGroupsCmd) {
 578             for (auto &group : m_testGroups) {
 579                 printf("GR:%s\n", group.first.c_str());
 580             }
 581             return 0;
 582         } else if (arg.find(listInGroup) == 0) {
 583             arg.erase(0, listInGroup.length());
 584             for (auto &test : m_testGroups[arg]) {
 585                 printf("ID:%s\n", test.name.c_str());
 586             }
 587             return 0;
 588         } else if (arg.find(allowChildLogs) == 0) {
 589             arg.erase(0, allowChildLogs.length());
 590             m_allowChildLogs = true;
 591         } else if (arg == "--help") {
 592             showHelp = true;
 593         } else if (arg.find(output) == 0) {
 594             arg.erase(0, output.length());
 595             if (m_collectors.find(arg) != m_collectors.end()) {
 596                 InvalidArgs(
 597                     "Multiple outputs of the same type are not supported!");
 598                 Usage();
 599                 return -1;
 600             }
 601             currentCollector.reset(TestResultsCollectorBase::Create(arg));
 602             if (!currentCollector) {
 603                 InvalidArgs("Unsupported output type!");
 604                 Usage();
 605                 return -1;
 606             }
 607             m_collectors[arg] = currentCollector;
 608         } else if (arg.find(regexp) == 0) {
 609             arg.erase(0, regexp.length());
 610             if (arg.length() == 0) {
 611                 InvalidArgs();
 612                 Usage();
 613                 return -1;
 614             }
 615
 616             if (arg[0] == '\'' && arg[arg.length() - 1] == '\'') {
 617                 arg.erase(0);
 618                 arg.erase(arg.length() - 1);
 619             }
 620
 621             if (arg.length() == 0) {
 622                 InvalidArgs();
 623                 Usage();
 624                 return -1;
 625             }
 626
 627             pcrecpp::RE re(arg.c_str());
 628             for (auto &group : m_testGroups) {
 629                 TestCaseStructList newList;
 630                 for (auto &tc : group.second)
 631                 {
 632                     if (re.PartialMatch(tc.name)) {
 633                         newList.push_back(tc);
 634                     }
 635                 }
 636                 group.second = newList;
 637             }
 638         } else if(arg.find(onlyFromXML) == 0) {
 639             arg.erase(0, onlyFromXML.length());
 640             if (arg.length() == 0) {
 641                 InvalidArgs();
 642                 Usage();
 643                 return -1;
 644             }
 645
 646             if (arg[0] == '\'' && arg[arg.length() - 1] == '\'') {
 647                 arg.erase(0);
 648                 arg.erase(arg.length() - 1);
 649             }
 650
 651             if (arg.length() == 0) {
 652                 InvalidArgs();
 653                 Usage();
 654                 return -1;
 655             }
 656
 657             xmlFiles.push_back(arg);
 658         } else {
 659             InvalidArgs();
 660             Usage();
 661             return -1;
 662         }
 663     }
 664
 665     if(!xmlFiles.empty())
 666     {
 667         if(!filterGroupsByXmls(xmlFiles))
 668         {
 669             fprintf(stderr, "XML file is not correct\n");
 670             return 0;
 671         }
 672     }
 673
 674     if(justList)
 675     {
 676         for (auto &group : m_testGroups) {
 677             for (auto &tc : group.second) {
 678                 printf("ID:%s:%s\n", group.first.c_str(), tc.name.c_str());
 679             }
 680         }
 681         return 0;
 682     }
 683
 684     currentCollector.reset();
 685
 686     // Show help
 687     if (showHelp) {
 688         Usage();
 689         return 0;
 690     }
 691
 692     if (m_collectors.empty()) {
 693         TestResultsCollectorBasePtr collector(
 694             TestResultsCollectorBase::Create("text"));
 695         m_collectors["text"] = collector;
 696     }
 697
 698     for (auto &collector : m_collectors) {
 699         if (!collector.second->Configure()) {
 700             fprintf(stderr, "Could not configure selected output");
 701             return 0;
 702         }
 703     }
 704
 705     // Run tests
 706     RunTests();
 707
 708     return 0;
 709 }
 710
 711 bool TestRunner::getRunIgnored() const
 712 {
 713     return m_runIgnored;
 714 }
 715
 716 void TestRunner::Terminate()
 717 {
 718     m_terminate = true;
 719 }
 720
 721 bool TestRunner::GetAllowChildLogs()
 722 {
 723     return m_allowChildLogs;
 724 }
 725
 726 }
 727 } // namespace DPL