Dynamic lib selection and deployment
[anna.git] / example / diameter / launcher / testing / TestStep.cpp
index c1f27d8..fdbd798 100644 (file)
 #include <stdlib.h>    // exit
 #include <sys/wait.h>  // waitpid, pid_t, WNOHANG
 
+// cmd with fork:
+#include <sys/types.h>
+#include <unistd.h>
+
+
 // Project
 #include <anna/xml/Compiler.hpp>
 #include <anna/core/util/Millisecond.hpp>
@@ -28,7 +33,7 @@
 #include <anna/diameter/helpers/base/functions.hpp>
 
 // Process
-#include <RealmNode.hpp>
+#include <OriginHost.hpp>
 #include <MyDiameterEntity.hpp>
 #include <MyLocalServer.hpp>
 #include <TestStep.hpp>
@@ -57,19 +62,19 @@ namespace {
     sa.sa_flags = SA_RESTART | SA_NOCLDSTOP;
     if (sigaction(SIGCHLD, &sa, 0) != -1) {
       status = system(cmd.c_str());
-     /* POPEN version:
-      char readbuf[256];
-      FILE *fp = popen(cmd.c_str(), "r");
-      if (fp) {
-        while(fgets(readbuf, sizeof(readbuf), fp))
-          step->appendOutput("\n");
-          step->appendOutput(readbuf);
-          status = pclose(fp);
-      }
-      else {
-        status = -1;
-      }
-      */
+      /* POPEN version:
+          char readbuf[256];
+          FILE *fp = popen(cmd.c_str(), "r");
+          if (fp) {
+            while(fgets(readbuf, sizeof(readbuf), fp))
+              step->appendOutput("\n");
+              step->appendOutput(readbuf);
+              status = pclose(fp);
+          }
+          else {
+            status = -1;
+          }
+       */
     }
     else {
       perror(0);
@@ -92,6 +97,54 @@ namespace {
     // TODO: mutex the step while setting data here !!
   }
 
+  void cmdRunOnThreadWithFork (TestStepCmd *step, const std::string &cmd) {
+
+    // Thread running:
+    step->setThreadRunning(true);
+
+    pid_t cpid, w;
+    int status = -2;
+
+    if ((cpid = fork()) < 0) {
+      step->setErrorMsg("Error in fork()");
+    }
+    else if (cpid == 0) {
+      // child
+      status = system(cmd.c_str());
+      _exit(WEXITSTATUS(status));
+    }
+    else {
+      // parent
+      step->setChildPid(cpid);
+      do {
+        w = waitpid(cpid, &status, WUNTRACED | WCONTINUED);
+        if (w != -1) {
+
+          if (WIFEXITED(status)) {
+            step->setResultCode(WEXITSTATUS(status)); // rc = status >>= 8; // divide by 256
+            break;
+          }
+          else if (WIFSIGNALED(status)) {
+            step->setErrorMsg(anna::functions::asString("killed by signal %d", WTERMSIG(status)));
+            step->setResultCode(128 + WTERMSIG(status));
+            break;
+          } else if (WIFSTOPPED(status)) {
+            step->setErrorMsg(anna::functions::asString("stopped by signal %d", WSTOPSIG(status)));
+          } else if (WIFCONTINUED(status)) {
+            step->setErrorMsg("continued");
+          }
+        }
+        else {
+          step->setErrorMsg("waitpid error");
+          step->setResultCode(-1);
+          break;
+        }
+      } while (!WIFEXITED(status) && !WIFSIGNALED(status));
+
+      step->complete();
+    }
+  }
+
   bool decodeMessage(const anna::DataBlock &message, anna::diameter::codec::Message &messageCodec) throw() {
 
     if (message.isEmpty())
@@ -99,7 +152,7 @@ namespace {
 
     bool result = true;
     try {
-      messageCodec.setEngine(NULL); // perhaps we will need another codec engine ...
+      messageCodec.clear();
       messageCodec.decode(message);
     }
     catch (anna::RuntimeException &ex) {
@@ -124,10 +177,14 @@ void TestStep::initialize(TestCase *testCase) {
   a_number = testCase->steps() + 1; // testCase is not NULL
 }
 
-bool TestStep::decodeMessage() throw() {
+bool TestStep::decodeMessage(bool trust) throw() {
   if (a_messageCodec) return true;
   a_messageCodec = new anna::diameter::codec::Message;
   if (::decodeMessage(a_message, *a_messageCodec)) return true;
+  if (trust) {
+    LOGDEBUG(anna::Logger::debug("Error DECODING, but trusting it ...", ANNA_FILE_LOCATION));
+    return true;
+  }
 
   delete a_messageCodec;
   a_messageCodec = NULL;
@@ -150,14 +207,14 @@ throw() {
 
   // Begin
   std::string s_aux = a_beginTimestamp.asString();
-//  int deltaMs = (int)(a_beginTimestamp - a_testCase->getStartTimestamp());
-//  if (a_beginTimestamp != 0 && deltaMs > 0) s_aux += anna::functions::asString(" [%.3f]", deltaMs/1000.0);
+  //  int deltaMs = (int)(a_beginTimestamp - a_testCase->getStartTimestamp());
+  //  if (a_beginTimestamp != 0 && deltaMs > 0) s_aux += anna::functions::asString(" [%.3f]", deltaMs/1000.0);
   result->createAttribute("BeginTimestamp", s_aux);
 
   // End
   s_aux = a_endTimestamp.asString();
-//  deltaMs = (int)(a_endTimestamp - a_testCase->getStartTimestamp());
-//  if (a_endTimestamp != 0 && deltaMs > 0) s_aux += anna::functions::asString(" [%.3f]", deltaMs/1000.0);
+  //  deltaMs = (int)(a_endTimestamp - a_testCase->getStartTimestamp());
+  //  if (a_endTimestamp != 0 && deltaMs > 0) s_aux += anna::functions::asString(" [%.3f]", deltaMs/1000.0);
   result->createAttribute("EndTimestamp", s_aux);
 
   return result;
@@ -178,21 +235,21 @@ bool TestStep::execute() throw() {
     if (a_executed) return false; // avoid repeating (this implies amount consumption)
   }
 
-  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));
+  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));
   setBeginTimestamp(anna::functions::millisecond());
   a_executed = true;
   return do_execute();
 }
 
 void TestStep::complete() throw() {
-  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));
+  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));
   a_completed = true;
   setEndTimestamp(anna::functions::millisecond());
   do_complete();
 }
 
 void TestStep::reset() throw() {
-  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));
+  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));
   // type and testCase kept
   a_completed = false;
   a_executed = false;
@@ -247,8 +304,6 @@ void TestStepTimeout::do_complete() throw() {
 }
 
 void TestStepTimeout::do_reset() throw() {
-  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));
-
   try {
     TestManager::instantiate().cancelTimer(a_timer);
   }
@@ -283,6 +338,9 @@ throw() {
     xmlmsg += a_messageCodec->asXMLString();
     xmlmsg += "\n";
   }
+  else {
+    xmlmsg = "<unable to decode, check traces>"; 
+  }
 
   if (msg != "") result->createAttribute("Message", msg);
   if (xmlmsg != "") result->createAttribute("XMLMessage", xmlmsg);
@@ -295,38 +353,49 @@ throw() {
 
 bool TestStepSendxml::do_execute() throw() {
   bool success = false;
-  std::string failReason, s_warn;
-  MyDiameterEntity *entity = a_realmNode->getEntity(); // by default
-  MyLocalServer *localServer = a_realmNode->getDiameterServer(); // by default
+  std::string failReason;
+  MyDiameterEntity *entity = a_originHost->getEntity(); // by default
+  MyLocalServer *localServer = a_originHost->getDiameterServer(); // by default
   const TestStepWait *tsw = NULL;
-
-  // Create comm message:
-  anna::diameter::comm::Message *msg = a_realmNode->createCommMessage();
-  //msg->clearBody();
-  msg->setBody(a_message);
+  anna::diameter::comm::Message *msg = a_originHost->createCommMessage();
 
   try {
-    // Update sequence for answers:
-    if (a_waitForRequestStepNumber != -1) { // is an answer: try to copy sequence information; alert about Session-Id discrepance
-      // Request which was received:
-      tsw = (const TestStepWait*)(a_testCase->getStep(a_waitForRequestStepNumber));
-      const anna::DataBlock &request = tsw->getMsgDataBlock();
-      anna::diameter::HopByHop hbh = anna::diameter::codec::functions::getHopByHop(request);
-      anna::diameter::EndToEnd ete = anna::diameter::codec::functions::getEndToEnd(request);
-      // Update sequence:
-      anna::diameter::codec::functions::setHopByHop(a_message, hbh);
-      anna::diameter::codec::functions::setEndToEnd(a_message, ete);
-
-      // Check Session-Id for warning ...
-      std::string sessionIdAnswer = anna::diameter::helpers::base::functions::getSessionId(a_message);
-      std::string sessionIdRequest = anna::diameter::helpers::base::functions::getSessionId(request);
-      if (sessionIdRequest != sessionIdAnswer) {
-        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());
-        LOGWARNING(anna::Logger::warning(s_warn, ANNA_FILE_LOCATION));
-        a_testCase->addDebugSummaryHint(s_warn);
+
+    if (a_waitForRequestStepNumber != -1) {
+
+      // Referenced request in the 'wait for request step':
+      tsw = static_cast<const TestStepWait*>(a_testCase->getStep(a_waitForRequestStepNumber));
+      const anna::DataBlock &referenceRequest = tsw->getMsgDataBlock();
+      std::string sessionIdReferenceRequest = anna::diameter::helpers::base::functions::getSessionId(referenceRequest);
+      bool thisIsAnswer = anna::diameter::codec::functions::isRequest(getMsgDataBlock());
+
+      if (thisIsAnswer) { // is an answer: try to copy sequence information; alert about Session-Id discrepance
+        anna::diameter::HopByHop hbh = anna::diameter::codec::functions::getHopByHop(referenceRequest);
+        anna::diameter::EndToEnd ete = anna::diameter::codec::functions::getEndToEnd(referenceRequest);
+
+        // Update sequence:
+        anna::diameter::codec::functions::setHopByHop(a_message, hbh);
+        anna::diameter::codec::functions::setEndToEnd(a_message, ete);
+      }
+
+      // Session-Id substitution:
+      std::string thisSessionId = anna::diameter::helpers::base::functions::getSessionId(getMsgDataBlock());
+      if (thisSessionId != sessionIdReferenceRequest) {
+        static anna::diameter::codec::Message codecMsg;
+        codecMsg.decode(getMsgDataBlock());
+        codecMsg.getAvp("Session-Id")->getUTF8String()->setValue(sessionIdReferenceRequest);
+        a_message = codecMsg.code();
+        std::string trace = anna::functions::asString("Replacing %s Session-Id (%s) to set the corresponding request one (%s)", (thisIsAnswer ? "answer":"request"), thisSessionId.c_str(), sessionIdReferenceRequest.c_str());
+        LOGDEBUG(anna::Logger::debug(trace, ANNA_FILE_LOCATION));
+        a_testCase->addDebugSummaryHint(trace);
       }
     }
 
+    // Create comm message:
+    //msg->clearBody();
+    msg->setBody(a_message);
+
+
     if (getType() == Type::Sendxml2e) {
       anna::diameter::comm::ClientSession *usedClientSession = NULL;
 
@@ -355,10 +424,10 @@ bool TestStepSendxml::do_execute() throw() {
       } // else (normal sending)
 
       // Detailed log:
-      if(a_realmNode->logEnabled()) {
-        if (decodeMessage()) {
+      if(a_originHost->logEnabled()) {
+        if (decodeMessage(true /* trust */)) {
           std::string detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // shouldn't happen
-          a_realmNode->writeLogFile(*a_messageCodec, (success ? "sent2e" : "send2eError"), detail);
+          a_originHost->writeLogFile(*a_messageCodec, (success ? "sent2e" : "send2eError"), detail);
         }
       }
     }
@@ -389,10 +458,10 @@ bool TestStepSendxml::do_execute() throw() {
       } // else (normal sending)
 
       // Detailed log:
-      if(a_realmNode->logEnabled()) {
-        if (decodeMessage()) {
+      if(a_originHost->logEnabled()) {
+        if (decodeMessage(true /* trust */)) {
           std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // shouldn't happen
-          a_realmNode->writeLogFile(*a_messageCodec, (success ? "sent2c" : "send2cError"), detail);
+          a_originHost->writeLogFile(*a_messageCodec, (success ? "sent2c" : "send2cError"), detail);
         }
       }
     }
@@ -402,7 +471,7 @@ bool TestStepSendxml::do_execute() throw() {
   }
 
   // release msg
-  a_realmNode->releaseCommMessage(msg);
+  a_originHost->releaseCommMessage(msg);
 
   if (!success) {
     a_testCase->addDebugSummaryHint(failReason); // before report (when set Failed state);
@@ -429,12 +498,13 @@ throw() {
   anna::xml::Node* result = TestStep::asXML(parent);
   //parent->createChild("TestStepDelay");
 
-  result->createAttribute("Delay", a_delay.asString());
+  result->createAttribute("Delay", ((a_delay == 0) ? "dummy step, no delay" : a_delay.asString()));
 
   return result;
 }
 
 bool TestStepDelay::do_execute() throw() {
+  if (a_delay == 0) { complete(); return true; } // special case
   try {
     a_timer = TestManager::instantiate().createTimer((TestCaseStep*)this, a_delay, TestTimer::Type::Delay);
   }
@@ -448,11 +518,14 @@ bool TestStepDelay::do_execute() throw() {
 }
 
 void TestStepDelay::do_complete() throw() {
+  if (a_delay == 0) return; // special case
   a_timer = NULL;
   next(); // next() invoked here because execute() is always false for delay and never advance the iterator
+  // TODO, avoid this recursion
 }
 
 void TestStepDelay::do_reset() throw() {
+  if (a_delay == 0) return; // special case
   try {
     TestManager::instantiate().cancelTimer(a_timer);
   }
@@ -512,9 +585,14 @@ throw() {
     xmlmsg += a_messageCodec->asXMLString();
     xmlmsg += "\n";
   }
+  else {
+    xmlmsg = "<unable to decode, check traces>"; 
+  }
 
   if (msg != "") result->createAttribute("MatchedMessage", msg);
   if (xmlmsg != "") result->createAttribute("MatchedXMLMessage", xmlmsg);
+  if (a_clientSession) result->createAttribute("ClientSessionOrigin", anna::functions::asString("%p", a_clientSession));
+  if (a_serverSession) result->createAttribute("ServerSessionOrigin", anna::functions::asString("%p", a_serverSession));
 
   return result;
 }
@@ -554,9 +632,15 @@ throw() {
 
   result->createAttribute("Script", (a_script != "") ? a_script:"<no script>");
   if (a_errorMsg != "") result->createAttribute("ErrorMessage", a_errorMsg);
-  if (!a_threadRunning && a_resultCode != -2) {
-    result->createAttribute("ResultCode", a_resultCode);
-    //if (a_output != "") result->createAttribute("Output", a_output);
+  if (a_threadRunning) {
+    if (a_childPid != -1)
+      result->createAttribute("ChildPid", a_childPid);
+  }
+  else {
+    if (a_resultCode != -2) {
+      result->createAttribute("ResultCode", a_resultCode);
+      //if (a_output != "") result->createAttribute("Output", a_output);
+    }
   }
 
   return result;
@@ -575,11 +659,13 @@ bool TestStepCmd::do_execute() throw() {
       cmd.replace(index, strlen(SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID), anna::functions::asString(getNumber()));
 
     a_thread = std::thread(cmdRunOnThread, this, cmd);
+    //a_thread = std::thread(cmdRunOnThreadWithFork, this, cmd);
+
     a_thread.detach();
   }
 
   return false; // don't go next (wait complete): If system function on thread stucks, then the reset test case will stuck here forever.
-                // We must implement a interrupt procedure for the thread on reset call... TODO !      
+  // We must implement a interrupt procedure for the thread on reset call... TODO !
 }
 
 void TestStepCmd::do_complete() throw() {
@@ -597,17 +683,25 @@ void TestStepCmd::do_complete() throw() {
     a_testCase->setState(TestCase::State::Failed);
   else
     next(); // next() invoked here because execute() is always false for delay and never advance the iterator
+  // TODO, avoid this recursion
 }
 
 void TestStepCmd::do_reset() throw() {
 
-  if (a_threadRunning) {
-    std::string s_warn = anna::functions::asString("Thread still in progress: deprecating step %d for Test Case %llu", getNumber(), a_testCase->getId());
-    LOGWARNING(anna::Logger::warning(s_warn, ANNA_FILE_LOCATION));
-    a_threadDeprecated = true;
-  }
+    if (a_threadRunning) {
+      std::string s_warn = anna::functions::asString("Thread still in progress: deprecating step %d for Test Case %llu", getNumber(), a_testCase->getId());
+      LOGWARNING(anna::Logger::warning(s_warn, ANNA_FILE_LOCATION));
+      a_threadDeprecated = true;
+    }
+//  if (a_threadRunning) {
+//    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());
+//    LOGWARNING(anna::Logger::warning(s_warn, ANNA_FILE_LOCATION));
+//    kill (a_childPid, SIGKILL);
+//  }
 
   a_resultCode = -2;
+  a_errorMsg = "";
   //a_output = "";
+  a_childPid = -1;
 }