example/diameter/launcher/testing/TestStep.cpp

   1 // ANNA - Anna is Not Nothingness Anymore                                                         //
   2 //                                                                                                //
   3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
   4 //                                                                                                //
   5 // See project site at http://redmine.teslayout.com/projects/anna-suite                           //
   6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
   7
   8
   9 // Standard
  10 #include <string>
  11 #include <iostream>
  12 #include <errno.h>
  13
  14 #include <signal.h>     // sigaction, sigemptyset, struct sigaction, SIGCHLD, SA_RESTART, SA_NOCLDSTOP
  15 #include <stdio.h>      // perror
  16 #include <stdlib.h>     // exit
  17 #include <sys/wait.h>   // waitpid, pid_t, WNOHANG
  18
  19 // cmd with fork:
  20 #include <sys/types.h>
  21 #include <unistd.h>
  22
  23
  24 // Project
  25 #include <anna/xml/Compiler.hpp>
  26 #include <anna/core/util/Millisecond.hpp>
  27 #include <anna/diameter.comm/Message.hpp>
  28 #include <anna/diameter.comm/ClientSession.hpp>
  29 #include <anna/diameter.comm/ServerSession.hpp>
  30 #include <anna/diameter.comm/Server.hpp>
  31 #include <anna/core/tracing/Logger.hpp>
  32 #include <anna/diameter/codec/functions.hpp>
  33 #include <anna/diameter/helpers/base/functions.hpp>
  34
  35 // Process
  36 #include <OriginHost.hpp>
  37 #include <MyDiameterEntity.hpp>
  38 #include <MyLocalServer.hpp>
  39 #include <TestStep.hpp>
  40 #include <TestCase.hpp>
  41 #include <TestManager.hpp>
  42 #include <TestTimer.hpp>
  43 #include <Launcher.hpp>
  44
  45
  46 namespace {
  47
  48   void handle_sigchld(int sig) {
  49     while (waitpid((pid_t)(-1 /* any child (the only) */), 0, WNOHANG|WNOWAIT) > 0) {}
  50   }
  51
  52   void cmdRunOnThread (TestStepCmd *step, const std::string &cmd) {
  53
  54     // Thread running:
  55     step->setThreadRunning(true);
  56
  57     int status = -2;
  58
  59     struct sigaction sa;
  60     sa.sa_handler = &handle_sigchld;
  61     sigemptyset(&sa.sa_mask);
  62     sa.sa_flags = SA_RESTART | SA_NOCLDSTOP;
  63     if (sigaction(SIGCHLD, &sa, 0) != -1) {
  64       status = system(cmd.c_str());
  65       /* POPEN version:
  66           char readbuf[256];
  67           FILE *fp = popen(cmd.c_str(), "r");
  68           if (fp) {
  69             while(fgets(readbuf, sizeof(readbuf), fp))
  70               step->appendOutput("\n");
  71               step->appendOutput(readbuf);
  72               status = pclose(fp);
  73           }
  74           else {
  75             status = -1;
  76           }
  77        */
  78     }
  79     else {
  80       perror(0);
  81     }
  82     // This can be implemented portably and somewhat more concisely with the signal function if you prefer:
  83     // if (signal(SIGCHLD, SIG_IGN) == SIG_ERR) {
  84     //   perror(0);
  85     //   exit(1);
  86     // }
  87
  88     if (status < 0) {
  89       char buf[256];
  90       char const * str = strerror_r(errno, buf, 256);
  91       step->setErrorMsg(anna::functions::asString("errno = %d (%s)", errno, str));
  92     }
  93
  94     step->setResultCode(WEXITSTATUS(status)); // rc = status >>= 8; // divide by 256
  95     step->complete();
  96     // TODO: terminate thread when deprecated (RT signal ?)
  97     // TODO: mutex the step while setting data here !!
  98   }
  99
 100   void cmdRunOnThreadWithFork (TestStepCmd *step, const std::string &cmd) {
 101
 102     // Thread running:
 103     step->setThreadRunning(true);
 104
 105     pid_t cpid, w;
 106     int status = -2;
 107
 108     if ((cpid = fork()) < 0) {
 109       step->setErrorMsg("Error in fork()");
 110     }
 111     else if (cpid == 0) {
 112       // child
 113       status = system(cmd.c_str());
 114       _exit(WEXITSTATUS(status));
 115     }
 116     else {
 117       // parent
 118       step->setChildPid(cpid);
 119       do {
 120         w = waitpid(cpid, &status, WUNTRACED | WCONTINUED);
 121         if (w != -1) {
 122
 123           if (WIFEXITED(status)) {
 124             step->setResultCode(WEXITSTATUS(status)); // rc = status >>= 8; // divide by 256
 125             break;
 126           }
 127           else if (WIFSIGNALED(status)) {
 128             step->setErrorMsg(anna::functions::asString("killed by signal %d", WTERMSIG(status)));
 129             step->setResultCode(128 + WTERMSIG(status));
 130             break;
 131           } else if (WIFSTOPPED(status)) {
 132             step->setErrorMsg(anna::functions::asString("stopped by signal %d", WSTOPSIG(status)));
 133           } else if (WIFCONTINUED(status)) {
 134             step->setErrorMsg("continued");
 135           }
 136         }
 137         else {
 138           step->setErrorMsg("waitpid error");
 139           step->setResultCode(-1);
 140           break;
 141         }
 142       } while (!WIFEXITED(status) && !WIFSIGNALED(status));
 143
 144       step->complete();
 145     }
 146   }
 147
 148   bool decodeMessage(const anna::DataBlock &message, anna::diameter::codec::Message &messageCodec) throw() {
 149
 150     if (message.isEmpty())
 151       return false;
 152
 153     bool result = true;
 154     try {
 155       messageCodec.clear();
 156       messageCodec.decode(message);
 157     }
 158     catch (anna::RuntimeException &ex) {
 159       ex.trace();
 160       result = false;
 161     }
 162
 163     return result;
 164   }
 165 }
 166
 167
 168 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 169 // TestStep
 170 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 171 void TestStep::initialize(TestCase *testCase) {
 172   a_testCase = testCase;
 173   a_completed = false;
 174   a_type = Type::Unconfigured;
 175   a_beginTimestamp = 0;
 176   a_endTimestamp = 0;
 177   a_number = testCase->steps() + 1; // testCase is not NULL
 178 }
 179
 180 bool TestStep::decodeMessage() throw() {
 181   if (a_messageCodec) return true;
 182   a_messageCodec = new anna::diameter::codec::Message;
 183   if (::decodeMessage(a_message, *a_messageCodec)) return true;
 184
 185   delete a_messageCodec;
 186   a_messageCodec = NULL;
 187   return false;
 188 }
 189
 190 const char* TestStep::asText(const Type::_v type)
 191 throw() {
 192   static const char* text [] = { "Unconfigured", "Timeout", "Sendxml2e", "Sendxml2c", "Delay", "Wait", "Command" };
 193   return text [type];
 194 }
 195
 196 anna::xml::Node* TestStep::asXML(anna::xml::Node* parent)
 197 throw() {
 198   anna::xml::Node* result = parent->createChild("TestStep");
 199
 200   result->createAttribute("Number", a_number);
 201   result->createAttribute("Type", asText(a_type));
 202   result->createAttribute("Completed", (a_completed ? "yes":"no"));
 203
 204   // Begin
 205   std::string s_aux = a_beginTimestamp.asString();
 206   //  int deltaMs = (int)(a_beginTimestamp - a_testCase->getStartTimestamp());
 207   //  if (a_beginTimestamp != 0 && deltaMs > 0) s_aux += anna::functions::asString(" [%.3f]", deltaMs/1000.0);
 208   result->createAttribute("BeginTimestamp", s_aux);
 209
 210   // End
 211   s_aux = a_endTimestamp.asString();
 212   //  deltaMs = (int)(a_endTimestamp - a_testCase->getStartTimestamp());
 213   //  if (a_endTimestamp != 0 && deltaMs > 0) s_aux += anna::functions::asString(" [%.3f]", deltaMs/1000.0);
 214   result->createAttribute("EndTimestamp", s_aux);
 215
 216   return result;
 217 }
 218
 219 std::string TestStep::asXMLString() throw() {
 220   anna::xml::Node root("root");
 221   return anna::xml::Compiler().apply(asXML(&root));
 222 }
 223
 224 bool TestStep::execute() throw() {
 225
 226   int ia = a_testCase->interactiveAmount();
 227   if (ia > -1) {
 228     if (ia == 0) return false;
 229     a_testCase->interactiveExecution();
 230     LOGDEBUG(anna::Logger::debug("Interactive execution ...", ANNA_FILE_LOCATION));
 231     if (a_executed) return false; // avoid repeating (this implies amount consumption)
 232   }
 233
 234   LOGDEBUG(anna::Logger::debug(anna::functions::asString("EXECUTING %s (step number %d) for Test Case %llu (%p)", asText(a_type), a_number, a_testCase->getId(), this), ANNA_FILE_LOCATION));
 235   setBeginTimestamp(anna::functions::millisecond());
 236   a_executed = true;
 237   return do_execute();
 238 }
 239
 240 void TestStep::complete() throw() {
 241   LOGDEBUG(anna::Logger::debug(anna::functions::asString("COMPLETE %s (step number %d) for Test Case %llu (%p)", asText(a_type), a_number, a_testCase->getId(), this), ANNA_FILE_LOCATION));
 242   a_completed = true;
 243   setEndTimestamp(anna::functions::millisecond());
 244   do_complete();
 245 }
 246
 247 void TestStep::reset() throw() {
 248   LOGDEBUG(anna::Logger::debug(anna::functions::asString("RESET %s (step number %d) for Test Case %llu (%p)", asText(a_type), a_number, a_testCase->getId(), this), ANNA_FILE_LOCATION));
 249   // type and testCase kept
 250   a_completed = false;
 251   a_executed = false;
 252   a_beginTimestamp = 0;
 253   a_endTimestamp = 0;
 254   do_reset();
 255 }
 256
 257 void TestStep::next() throw() {
 258   a_testCase->nextStep();
 259   a_testCase->process();
 260 }
 261
 262
 263 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 264 // TestStepTimeout
 265 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 266 anna::xml::Node* TestStepTimeout::asXML(anna::xml::Node* parent)
 267 throw() {
 268   anna::xml::Node* result = TestStep::asXML(parent); // end timestamp will be 0 if test finished OK
 269   //parent->createChild("TestStepTimeout");
 270   result->createAttribute("Timeout", a_timeout.asString());
 271
 272   return result;
 273 }
 274
 275 bool TestStepTimeout::do_execute() throw() {
 276   try {
 277     a_timer = TestManager::instantiate().createTimer((TestCaseStep*)this, a_timeout, TestTimer::Type::TimeLeft);
 278   }
 279   catch (anna::RuntimeException &ex) {
 280     ex.trace();
 281     a_testCase->addDebugSummaryHint(ex.asString()); // before report (when set Failed state)
 282     a_testCase->setState(TestCase::State::Failed);
 283   }
 284
 285   return true; // go next
 286 }
 287
 288 void TestStepTimeout::do_complete() throw() {
 289   int stepNumber = getNumber();
 290   if (stepNumber == a_testCase->steps()) {
 291     a_testCase->addDebugSummaryHint(anna::functions::asString("Timeout expired (step number %d) but it was the last test case step", stepNumber)); // before report (when set Failed state)
 292     a_testCase->setState(TestCase::State::Success);
 293   }
 294   else if (a_testCase->getState() == TestCase::State::InProgress) { // sure
 295     a_testCase->addDebugSummaryHint(anna::functions::asString("Timeout expired (step number %d) before test case finished", stepNumber)); // before report (when set Failed state)
 296     a_testCase->setState(TestCase::State::Failed);
 297   }
 298
 299   a_timer = NULL;
 300 }
 301
 302 void TestStepTimeout::do_reset() throw() {
 303   try {
 304     TestManager::instantiate().cancelTimer(a_timer);
 305   }
 306   catch (anna::RuntimeException &ex) {
 307     ex.trace();
 308   }
 309   a_timer = NULL;
 310   //a_timeout = 0; THIS IS CONFIGURATION INFO
 311 }
 312
 313 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 314 // TestStepSendxml
 315 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 316 anna::xml::Node* TestStepSendxml::asXML(anna::xml::Node* parent)
 317 throw() {
 318   anna::xml::Node* result = TestStep::asXML(parent);
 319   //parent->createChild("TestStepSendxml");
 320   std::string msg = "", xmlmsg = "";
 321
 322   // Message
 323   if (TestManager::instantiate().getDumpHex()) {
 324     if (a_message.isEmpty()) {
 325       msg = "<empty>";
 326     }
 327     else {
 328       msg = "\n"; msg += a_message.asString(); msg += "\n";
 329     }
 330   }
 331
 332   if (decodeMessage()) {
 333     xmlmsg = "\n";
 334     xmlmsg += a_messageCodec->asXMLString();
 335     xmlmsg += "\n";
 336   }
 337
 338   if (msg != "") result->createAttribute("Message", msg);
 339   if (xmlmsg != "") result->createAttribute("XMLMessage", xmlmsg);
 340   result->createAttribute("Expired", (a_expired ? "yes":"no"));
 341   if (a_waitForRequestStepNumber != -1)
 342     result->createAttribute("WaitForRequestStepNumber", a_waitForRequestStepNumber);
 343
 344   return result;
 345 }
 346
 347 bool TestStepSendxml::do_execute() throw() {
 348   bool success = false;
 349   std::string failReason, s_warn;
 350   MyDiameterEntity *entity = a_originHost->getEntity(); // by default
 351   MyLocalServer *localServer = a_originHost->getDiameterServer(); // by default
 352   const TestStepWait *tsw = NULL;
 353
 354   // Create comm message:
 355   anna::diameter::comm::Message *msg = a_originHost->createCommMessage();
 356   //msg->clearBody();
 357   msg->setBody(a_message);
 358
 359   try {
 360     // Update sequence for answers:
 361     if (a_waitForRequestStepNumber != -1) { // is an answer: try to copy sequence information; alert about Session-Id discrepance
 362       // Request which was received:
 363       tsw = static_cast<const TestStepWait*>(a_testCase->getStep(a_waitForRequestStepNumber));
 364
 365       const anna::DataBlock &request = tsw->getMsgDataBlock();
 366       anna::diameter::HopByHop hbh = anna::diameter::codec::functions::getHopByHop(request);
 367       anna::diameter::EndToEnd ete = anna::diameter::codec::functions::getEndToEnd(request);
 368
 369       // Update sequence:
 370       anna::diameter::codec::functions::setHopByHop(a_message, hbh);
 371       anna::diameter::codec::functions::setEndToEnd(a_message, ete);
 372
 373       // Check Session-Id for warning ...
 374       std::string sessionIdAnswer = anna::diameter::helpers::base::functions::getSessionId(a_message);
 375       std::string sessionIdRequest = anna::diameter::helpers::base::functions::getSessionId(request);
 376
 377       if (sessionIdRequest != sessionIdAnswer) {
 378         s_warn = anna::functions::asString("Sending an answer which Session-Id (%s) is different than supposed corresponding request (%s)", sessionIdAnswer.c_str(), sessionIdRequest.c_str());
 379         LOGWARNING(anna::Logger::warning(s_warn, ANNA_FILE_LOCATION));
 380         a_testCase->addDebugSummaryHint(s_warn);
 381       }
 382     }
 383
 384     if (getType() == Type::Sendxml2e) {
 385       anna::diameter::comm::ClientSession *usedClientSession = NULL;
 386
 387       if (tsw) { // is an answer for a received request on wait condition
 388         anna::diameter::comm::ClientSession *clientSession = tsw->getClientSession();
 389         if (clientSession) {
 390           /* response NULL (is an answer) */clientSession->send(msg);
 391           success = true;
 392           usedClientSession = clientSession;
 393         }
 394         else {
 395           failReason = "Reference wait step didn't store a valid client session. Unable to send the message";
 396           LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
 397         }
 398       }
 399       else {
 400         if (entity) {
 401           success = entity->send(msg);
 402           anna::diameter::comm::Server *usedServer = entity->getLastUsedResource();
 403           usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL;
 404         }
 405         else {
 406           failReason = "There is no diameter entity currently configured. Unable to send the message";
 407           LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
 408         }
 409       } // else (normal sending)
 410
 411       // Detailed log:
 412       if(a_originHost->logEnabled()) {
 413         if (decodeMessage()) {
 414           std::string detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // shouldn't happen
 415           a_originHost->writeLogFile(*a_messageCodec, (success ? "sent2e" : "send2eError"), detail);
 416         }
 417       }
 418     }
 419     else if (getType() == Type::Sendxml2c) {
 420       anna::diameter::comm::ServerSession *usedServerSession = NULL;
 421
 422       if (tsw) { // is an answer for a received request on wait condition
 423         anna::diameter::comm::ServerSession *serverSession = tsw->getServerSession();
 424         if (serverSession) {
 425           /* response NULL (is an answer) */serverSession->send(msg);
 426           success = true;
 427           usedServerSession = serverSession;
 428         }
 429         else {
 430           failReason = "Reference wait step didn't store a valid server session. Unable to send the message";
 431           LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
 432         }
 433       }
 434       else {
 435         if (localServer) {
 436           success = localServer->send(msg);
 437           usedServerSession = localServer->getLastUsedResource();
 438         }
 439         else {
 440           failReason = "There is no diameter local server currently configured. Unable to send the message";
 441           LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
 442         }
 443       } // else (normal sending)
 444
 445       // Detailed log:
 446       if(a_originHost->logEnabled()) {
 447         if (decodeMessage()) {
 448           std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // shouldn't happen
 449           a_originHost->writeLogFile(*a_messageCodec, (success ? "sent2c" : "send2cError"), detail);
 450         }
 451       }
 452     }
 453
 454   } catch(anna::RuntimeException &ex) {
 455     failReason = ex.asString();
 456   }
 457
 458   // release msg
 459   a_originHost->releaseCommMessage(msg);
 460
 461   if (!success) {
 462     a_testCase->addDebugSummaryHint(failReason); // before report (when set Failed state);
 463     a_testCase->setState(TestCase::State::Failed);
 464   }
 465   else {
 466     complete();
 467   }
 468
 469   return success; // go next if sent was OK
 470 }
 471
 472 void TestStepSendxml::do_reset() throw() {
 473   a_expired = false;
 474   //a_message.clear();
 475   //a_messageAlreadyDecoded = false;
 476 }
 477
 478 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 479 // TestStepDelay
 480 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 481 anna::xml::Node* TestStepDelay::asXML(anna::xml::Node* parent)
 482 throw() {
 483   anna::xml::Node* result = TestStep::asXML(parent);
 484   //parent->createChild("TestStepDelay");
 485
 486   result->createAttribute("Delay", ((a_delay == 0) ? "dummy step, no delay" : a_delay.asString()));
 487
 488   return result;
 489 }
 490
 491 bool TestStepDelay::do_execute() throw() {
 492   if (a_delay == 0) { complete(); return true; } // special case
 493   try {
 494     a_timer = TestManager::instantiate().createTimer((TestCaseStep*)this, a_delay, TestTimer::Type::Delay);
 495   }
 496   catch (anna::RuntimeException &ex) {
 497     ex.trace();
 498     a_testCase->addDebugSummaryHint(ex.asString()); // before report (when set Failed state)
 499     a_testCase->setState(TestCase::State::Failed);
 500   }
 501
 502   return false; // don't go next (wait complete)
 503 }
 504
 505 void TestStepDelay::do_complete() throw() {
 506   if (a_delay == 0) return; // special case
 507   a_timer = NULL;
 508   next(); // next() invoked here because execute() is always false for delay and never advance the iterator
 509   // TODO, avoid this recursion
 510 }
 511
 512 void TestStepDelay::do_reset() throw() {
 513   if (a_delay == 0) return; // special case
 514   try {
 515     TestManager::instantiate().cancelTimer(a_timer);
 516   }
 517   catch (anna::RuntimeException &ex) {
 518     ex.trace();
 519   }
 520   a_timer = NULL;
 521   //a_delay = 0; THIS IS CONFIGURATION INFO
 522 }
 523
 524 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 525 // TestStepWait
 526 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 527 void TestStepWait::setCondition(bool fromEntity,
 528     const std::string &code, const std::string &bitR, const std::string &hopByHop, const std::string &applicationId,
 529     const std::string &sessionId, const std::string &resultCode,
 530     const std::string &msisdn, const std::string &imsi, const std::string &serviceContextId) throw() {
 531
 532   a_condition.setReceivedFromEntity(fromEntity);
 533   a_condition.setCode(code);
 534   a_condition.setBitR(bitR);
 535   a_condition.setResultCode(resultCode);
 536   a_condition.setSessionId(sessionId);
 537   a_condition.setHopByHop(hopByHop);
 538   a_condition.setMsisdn(msisdn);
 539   a_condition.setImsi(imsi);
 540   a_condition.setServiceContextId(serviceContextId);
 541 }
 542
 543 void TestStepWait::setCondition(bool fromEntity, const std::string &regexp) throw() {
 544
 545   a_condition.setReceivedFromEntity(fromEntity);
 546   a_condition.setRegexp(regexp);
 547 }
 548
 549 anna::xml::Node* TestStepWait::asXML(anna::xml::Node* parent)
 550 throw() {
 551   anna::xml::Node* result = TestStep::asXML(parent);
 552   //parent->createChild("TestStepWait");
 553   std::string msg = "", xmlmsg = "";
 554
 555   // Condition
 556   a_condition.asXML(result);
 557
 558   // Message
 559   if (TestManager::instantiate().getDumpHex()) {
 560     if (a_message.isEmpty()) {
 561       msg = "<empty>";
 562     }
 563     else {
 564       msg = "\n"; msg += a_message.asString(); msg += "\n";
 565     }
 566   }
 567
 568   if (decodeMessage()) {
 569     xmlmsg = "\n";
 570     xmlmsg += a_messageCodec->asXMLString();
 571     xmlmsg += "\n";
 572   }
 573
 574   if (msg != "") result->createAttribute("MatchedMessage", msg);
 575   if (xmlmsg != "") result->createAttribute("MatchedXMLMessage", xmlmsg);
 576   if (a_clientSession) result->createAttribute("ClientSessionOrigin", anna::functions::asString("%p", a_clientSession));
 577   if (a_serverSession) result->createAttribute("ServerSessionOrigin", anna::functions::asString("%p", a_serverSession));
 578
 579   return result;
 580 }
 581
 582 bool TestStepWait::do_execute() throw() {
 583   return a_completed;
 584 }
 585
 586 void TestStepWait::do_complete() throw() {
 587   //a_testCase->process(); // next() not invoked; we only want to reactivate the test case
 588   // avoid stack overflow: we will process the test case externally when incoming message is fulfilled (TestCase.cpp), and TestManager is noticed
 589 }
 590
 591 bool TestStepWait::fulfilled(const anna::DataBlock &db/*, bool matchSessionId*/) throw() {
 592   if (a_condition.comply(db/*, matchSessionId*/)) {
 593     a_message = db; // store matched
 594     complete();
 595     return true;
 596   }
 597
 598   return false;
 599 }
 600
 601 void TestStepWait::do_reset() throw() {
 602   a_message.clear();
 603   a_clientSession = NULL;
 604   a_serverSession = NULL;
 605 }
 606
 607 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 608 // TestStepCmd
 609 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 610 anna::xml::Node* TestStepCmd::asXML(anna::xml::Node* parent)
 611 throw() {
 612   anna::xml::Node* result = TestStep::asXML(parent);
 613   //parent->createChild("TestStepCmd");
 614
 615   result->createAttribute("Script", (a_script != "") ? a_script:"<no script>");
 616   if (a_errorMsg != "") result->createAttribute("ErrorMessage", a_errorMsg);
 617   if (a_threadRunning) {
 618     if (a_childPid != -1)
 619       result->createAttribute("ChildPid", a_childPid);
 620   }
 621   else {
 622     if (a_resultCode != -2) {
 623       result->createAttribute("ResultCode", a_resultCode);
 624       //if (a_output != "") result->createAttribute("Output", a_output);
 625     }
 626   }
 627
 628   return result;
 629 }
 630
 631 bool TestStepCmd::do_execute() throw() {
 632   if (!a_threadRunning /* || a_threadDeprecated DO NOT WANT TO OVERLAP ... */) {
 633     // Special tags to replace:
 634     std::string cmd = getScript();
 635     size_t index;
 636     while ((index = cmd.find(SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID)) != std::string::npos)
 637       cmd.replace(index, strlen(SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID), anna::functions::asString(TestManager::instantiate().getPoolCycle()));
 638     while ((index = cmd.find(SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID)) != std::string::npos)
 639       cmd.replace(index, strlen(SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID), anna::functions::asString(a_testCase->getId()));
 640     while ((index = cmd.find(SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID)) != std::string::npos)
 641       cmd.replace(index, strlen(SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID), anna::functions::asString(getNumber()));
 642
 643     a_thread = std::thread(cmdRunOnThread, this, cmd);
 644     //a_thread = std::thread(cmdRunOnThreadWithFork, this, cmd);
 645
 646     a_thread.detach();
 647   }
 648
 649   return false; // don't go next (wait complete): If system function on thread stucks, then the reset test case will stuck here forever.
 650   // We must implement a interrupt procedure for the thread on reset call... TODO !
 651 }
 652
 653 void TestStepCmd::do_complete() throw() {
 654
 655   a_threadRunning = false;
 656   if (a_threadDeprecated) {
 657     a_threadDeprecated = false;
 658     do_reset();
 659     setErrorMsg(anna::functions::asString("Step %d deprecated due to previous reset for Test Case %llu", getNumber(), a_testCase->getId()));
 660     a_testCase->setState(TestCase::State::Failed);
 661     return; // ignore TODO: interrupt the thread to avoid execution of the script
 662   }
 663
 664   if (getResultCode() != 0)
 665     a_testCase->setState(TestCase::State::Failed);
 666   else
 667     next(); // next() invoked here because execute() is always false for delay and never advance the iterator
 668   // TODO, avoid this recursion
 669 }
 670
 671 void TestStepCmd::do_reset() throw() {
 672
 673     if (a_threadRunning) {
 674       std::string s_warn = anna::functions::asString("Thread still in progress: deprecating step %d for Test Case %llu", getNumber(), a_testCase->getId());
 675       LOGWARNING(anna::Logger::warning(s_warn, ANNA_FILE_LOCATION));
 676       a_threadDeprecated = true;
 677     }
 678 //  if (a_threadRunning) {
 679 //    std::string s_warn = anna::functions::asString("Thread still in progress: killing child pid %d within step %d for Test Case %llu", a_childPid, getNumber(), a_testCase->getId());
 680 //    LOGWARNING(anna::Logger::warning(s_warn, ANNA_FILE_LOCATION));
 681 //    kill (a_childPid, SIGKILL);
 682 //  }
 683
 684   a_resultCode = -2;
 685   a_errorMsg = "";
 686   //a_output = "";
 687   a_childPid = -1;
 688 }
 689