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 <RealmNode.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.setEngine(NULL); // perhaps we will need another codec engine ...
 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) (%p)", asText(a_type), a_number, a_testCase->getId(), (TestCaseStep*)this, 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) (%p)", asText(a_type), a_number, a_testCase->getId(), (TestCaseStep*)this, 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) (%p)", asText(a_type), a_number, a_testCase->getId(), (TestCaseStep*)this, 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   LOGDEBUG(anna::Logger::debug(anna::functions::asString("REXXXXXET %s for Test Case %llu (%p) (%p) (a_timer %p)", asText(a_type), a_testCase->getId(), (TestCaseStep*)this, this, a_timer), ANNA_FILE_LOCATION));
 304
 305   try {
 306     TestManager::instantiate().cancelTimer(a_timer);
 307   }
 308   catch (anna::RuntimeException &ex) {
 309     ex.trace();
 310   }
 311   a_timer = NULL;
 312   //a_timeout = 0; THIS IS CONFIGURATION INFO
 313 }
 314
 315 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 316 // TestStepSendxml
 317 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 318 anna::xml::Node* TestStepSendxml::asXML(anna::xml::Node* parent)
 319 throw() {
 320   anna::xml::Node* result = TestStep::asXML(parent);
 321   //parent->createChild("TestStepSendxml");
 322   std::string msg = "", xmlmsg = "";
 323
 324   // Message
 325   if (TestManager::instantiate().getDumpHex()) {
 326     if (a_message.isEmpty()) {
 327       msg = "<empty>";
 328     }
 329     else {
 330       msg = "\n"; msg += a_message.asString(); msg += "\n";
 331     }
 332   }
 333
 334   if (decodeMessage()) {
 335     xmlmsg = "\n";
 336     xmlmsg += a_messageCodec->asXMLString();
 337     xmlmsg += "\n";
 338   }
 339
 340   if (msg != "") result->createAttribute("Message", msg);
 341   if (xmlmsg != "") result->createAttribute("XMLMessage", xmlmsg);
 342   result->createAttribute("Expired", (a_expired ? "yes":"no"));
 343   if (a_waitForRequestStepNumber != -1)
 344     result->createAttribute("WaitForRequestStepNumber", a_waitForRequestStepNumber);
 345
 346   return result;
 347 }
 348
 349 bool TestStepSendxml::do_execute() throw() {
 350   bool success = false;
 351   std::string failReason, s_warn;
 352   MyDiameterEntity *entity = a_realmNode->getEntity(); // by default
 353   MyLocalServer *localServer = a_realmNode->getDiameterServer(); // by default
 354   const TestStepWait *tsw = NULL;
 355
 356   // Create comm message:
 357   anna::diameter::comm::Message *msg = a_realmNode->createCommMessage();
 358   //msg->clearBody();
 359   msg->setBody(a_message);
 360
 361   try {
 362     // Update sequence for answers:
 363     if (a_waitForRequestStepNumber != -1) { // is an answer: try to copy sequence information; alert about Session-Id discrepance
 364       // Request which was received:
 365       tsw = (const TestStepWait*)(a_testCase->getStep(a_waitForRequestStepNumber));
 366       const anna::DataBlock &request = tsw->getMsgDataBlock();
 367       anna::diameter::HopByHop hbh = anna::diameter::codec::functions::getHopByHop(request);
 368       anna::diameter::EndToEnd ete = anna::diameter::codec::functions::getEndToEnd(request);
 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       if (sessionIdRequest != sessionIdAnswer) {
 377         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());
 378         LOGWARNING(anna::Logger::warning(s_warn, ANNA_FILE_LOCATION));
 379         a_testCase->addDebugSummaryHint(s_warn);
 380       }
 381     }
 382
 383     if (getType() == Type::Sendxml2e) {
 384       anna::diameter::comm::ClientSession *usedClientSession = NULL;
 385
 386       if (tsw) { // is an answer for a received request on wait condition
 387         anna::diameter::comm::ClientSession *clientSession = tsw->getClientSession();
 388         if (clientSession) {
 389           /* response NULL (is an answer) */clientSession->send(msg);
 390           success = true;
 391           usedClientSession = clientSession;
 392         }
 393         else {
 394           failReason = "Reference wait step didn't store a valid client session. Unable to send the message";
 395           LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
 396         }
 397       }
 398       else {
 399         if (entity) {
 400           success = entity->send(msg);
 401           anna::diameter::comm::Server *usedServer = entity->getLastUsedResource();
 402           usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL;
 403         }
 404         else {
 405           failReason = "There is no diameter entity currently configured. Unable to send the message";
 406           LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
 407         }
 408       } // else (normal sending)
 409
 410       // Detailed log:
 411       if(a_realmNode->logEnabled()) {
 412         if (decodeMessage()) {
 413           std::string detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // shouldn't happen
 414           a_realmNode->writeLogFile(*a_messageCodec, (success ? "sent2e" : "send2eError"), detail);
 415         }
 416       }
 417     }
 418     else if (getType() == Type::Sendxml2c) {
 419       anna::diameter::comm::ServerSession *usedServerSession = NULL;
 420
 421       if (tsw) { // is an answer for a received request on wait condition
 422         anna::diameter::comm::ServerSession *serverSession = tsw->getServerSession();
 423         if (serverSession) {
 424           /* response NULL (is an answer) */serverSession->send(msg);
 425           success = true;
 426           usedServerSession = serverSession;
 427         }
 428         else {
 429           failReason = "Reference wait step didn't store a valid server session. Unable to send the message";
 430           LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
 431         }
 432       }
 433       else {
 434         if (localServer) {
 435           success = localServer->send(msg);
 436           usedServerSession = localServer->getLastUsedResource();
 437         }
 438         else {
 439           failReason = "There is no diameter local server currently configured. Unable to send the message";
 440           LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
 441         }
 442       } // else (normal sending)
 443
 444       // Detailed log:
 445       if(a_realmNode->logEnabled()) {
 446         if (decodeMessage()) {
 447           std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // shouldn't happen
 448           a_realmNode->writeLogFile(*a_messageCodec, (success ? "sent2c" : "send2cError"), detail);
 449         }
 450       }
 451     }
 452
 453   } catch(anna::RuntimeException &ex) {
 454     failReason = ex.asString();
 455   }
 456
 457   // release msg
 458   a_realmNode->releaseCommMessage(msg);
 459
 460   if (!success) {
 461     a_testCase->addDebugSummaryHint(failReason); // before report (when set Failed state);
 462     a_testCase->setState(TestCase::State::Failed);
 463   }
 464   else {
 465     complete();
 466   }
 467
 468   return success; // go next if sent was OK
 469 }
 470
 471 void TestStepSendxml::do_reset() throw() {
 472   a_expired = false;
 473   //a_message.clear();
 474   //a_messageAlreadyDecoded = false;
 475 }
 476
 477 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 478 // TestStepDelay
 479 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 480 anna::xml::Node* TestStepDelay::asXML(anna::xml::Node* parent)
 481 throw() {
 482   anna::xml::Node* result = TestStep::asXML(parent);
 483   //parent->createChild("TestStepDelay");
 484
 485   result->createAttribute("Delay", a_delay.asString());
 486
 487   return result;
 488 }
 489
 490 bool TestStepDelay::do_execute() throw() {
 491   try {
 492     a_timer = TestManager::instantiate().createTimer((TestCaseStep*)this, a_delay, TestTimer::Type::Delay);
 493   }
 494   catch (anna::RuntimeException &ex) {
 495     ex.trace();
 496     a_testCase->addDebugSummaryHint(ex.asString()); // before report (when set Failed state)
 497     a_testCase->setState(TestCase::State::Failed);
 498   }
 499
 500   return false; // don't go next (wait complete)
 501 }
 502
 503 void TestStepDelay::do_complete() throw() {
 504   a_timer = NULL;
 505   next(); // next() invoked here because execute() is always false for delay and never advance the iterator
 506   // TODO, avoid this recursion
 507 }
 508
 509 void TestStepDelay::do_reset() throw() {
 510   try {
 511     TestManager::instantiate().cancelTimer(a_timer);
 512   }
 513   catch (anna::RuntimeException &ex) {
 514     ex.trace();
 515   }
 516   a_timer = NULL;
 517   //a_delay = 0; THIS IS CONFIGURATION INFO
 518 }
 519
 520 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 521 // TestStepWait
 522 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 523 void TestStepWait::setCondition(bool fromEntity,
 524     const std::string &code, const std::string &bitR, const std::string &hopByHop, const std::string &applicationId,
 525     const std::string &sessionId, const std::string &resultCode,
 526     const std::string &msisdn, const std::string &imsi, const std::string &serviceContextId) throw() {
 527
 528   a_condition.setReceivedFromEntity(fromEntity);
 529   a_condition.setCode(code);
 530   a_condition.setBitR(bitR);
 531   a_condition.setResultCode(resultCode);
 532   a_condition.setSessionId(sessionId);
 533   a_condition.setHopByHop(hopByHop);
 534   a_condition.setMsisdn(msisdn);
 535   a_condition.setImsi(imsi);
 536   a_condition.setServiceContextId(serviceContextId);
 537 }
 538
 539 void TestStepWait::setCondition(bool fromEntity, const std::string &regexp) throw() {
 540
 541   a_condition.setReceivedFromEntity(fromEntity);
 542   a_condition.setRegexp(regexp);
 543 }
 544
 545 anna::xml::Node* TestStepWait::asXML(anna::xml::Node* parent)
 546 throw() {
 547   anna::xml::Node* result = TestStep::asXML(parent);
 548   //parent->createChild("TestStepWait");
 549   std::string msg = "", xmlmsg = "";
 550
 551   // Condition
 552   a_condition.asXML(result);
 553
 554   // Message
 555   if (TestManager::instantiate().getDumpHex()) {
 556     if (a_message.isEmpty()) {
 557       msg = "<empty>";
 558     }
 559     else {
 560       msg = "\n"; msg += a_message.asString(); msg += "\n";
 561     }
 562   }
 563
 564   if (decodeMessage()) {
 565     xmlmsg = "\n";
 566     xmlmsg += a_messageCodec->asXMLString();
 567     xmlmsg += "\n";
 568   }
 569
 570   if (msg != "") result->createAttribute("MatchedMessage", msg);
 571   if (xmlmsg != "") result->createAttribute("MatchedXMLMessage", xmlmsg);
 572
 573   return result;
 574 }
 575
 576 bool TestStepWait::do_execute() throw() {
 577   return a_completed;
 578 }
 579
 580 void TestStepWait::do_complete() throw() {
 581   //a_testCase->process(); // next() not invoked; we only want to reactivate the test case
 582   // avoid stack overflow: we will process the test case externally when incoming message is fulfilled (TestCase.cpp), and TestManager is noticed
 583 }
 584
 585 bool TestStepWait::fulfilled(const anna::DataBlock &db/*, bool matchSessionId*/) throw() {
 586   if (a_condition.comply(db/*, matchSessionId*/)) {
 587     a_message = db; // store matched
 588     complete();
 589     return true;
 590   }
 591
 592   return false;
 593 }
 594
 595 void TestStepWait::do_reset() throw() {
 596   a_message.clear();
 597   a_clientSession = NULL;
 598   a_serverSession = NULL;
 599 }
 600
 601 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 602 // TestStepCmd
 603 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 604 anna::xml::Node* TestStepCmd::asXML(anna::xml::Node* parent)
 605 throw() {
 606   anna::xml::Node* result = TestStep::asXML(parent);
 607   //parent->createChild("TestStepCmd");
 608
 609   result->createAttribute("Script", (a_script != "") ? a_script:"<no script>");
 610   if (a_errorMsg != "") result->createAttribute("ErrorMessage", a_errorMsg);
 611   if (a_threadRunning) {
 612     if (a_childPid != -1)
 613       result->createAttribute("ChildPid", a_childPid);
 614   }
 615   else {
 616     if (a_resultCode != -2) {
 617       result->createAttribute("ResultCode", a_resultCode);
 618       //if (a_output != "") result->createAttribute("Output", a_output);
 619     }
 620   }
 621
 622   return result;
 623 }
 624
 625 bool TestStepCmd::do_execute() throw() {
 626   if (!a_threadRunning /* || a_threadDeprecated DO NOT WANT TO OVERLAP ... */) {
 627     // Special tags to replace:
 628     std::string cmd = getScript();
 629     size_t index;
 630     while ((index = cmd.find(SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID)) != std::string::npos)
 631       cmd.replace(index, strlen(SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID), anna::functions::asString(TestManager::instantiate().getPoolCycle()));
 632     while ((index = cmd.find(SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID)) != std::string::npos)
 633       cmd.replace(index, strlen(SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID), anna::functions::asString(a_testCase->getId()));
 634     while ((index = cmd.find(SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID)) != std::string::npos)
 635       cmd.replace(index, strlen(SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID), anna::functions::asString(getNumber()));
 636
 637     a_thread = std::thread(cmdRunOnThread, this, cmd);
 638     //a_thread = std::thread(cmdRunOnThreadWithFork, this, cmd);
 639
 640     a_thread.detach();
 641   }
 642
 643   return false; // don't go next (wait complete): If system function on thread stucks, then the reset test case will stuck here forever.
 644   // We must implement a interrupt procedure for the thread on reset call... TODO !
 645 }
 646
 647 void TestStepCmd::do_complete() throw() {
 648
 649   a_threadRunning = false;
 650   if (a_threadDeprecated) {
 651     a_threadDeprecated = false;
 652     do_reset();
 653     setErrorMsg(anna::functions::asString("Step %d deprecated due to previous reset for Test Case %llu", getNumber(), a_testCase->getId()));
 654     a_testCase->setState(TestCase::State::Failed);
 655     return; // ignore TODO: interrupt the thread to avoid execution of the script
 656   }
 657
 658   if (getResultCode() != 0)
 659     a_testCase->setState(TestCase::State::Failed);
 660   else
 661     next(); // next() invoked here because execute() is always false for delay and never advance the iterator
 662   // TODO, avoid this recursion
 663 }
 664
 665 void TestStepCmd::do_reset() throw() {
 666
 667     if (a_threadRunning) {
 668       std::string s_warn = anna::functions::asString("Thread still in progress: deprecating step %d for Test Case %llu", getNumber(), a_testCase->getId());
 669       LOGWARNING(anna::Logger::warning(s_warn, ANNA_FILE_LOCATION));
 670       a_threadDeprecated = true;
 671     }
 672 //  if (a_threadRunning) {
 673 //    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());
 674 //    LOGWARNING(anna::Logger::warning(s_warn, ANNA_FILE_LOCATION));
 675 //    kill (a_childPid, SIGKILL);
 676 //  }
 677
 678   a_resultCode = -2;
 679   a_errorMsg = "";
 680   //a_output = "";
 681   a_childPid = -1;
 682 }
 683