Fix nswering procedure: have to use source resource.
[anna.git] / example / diameter / launcher / testing / TestStep.cpp
index e53ae9a..c8aef4e 100644 (file)
@@ -8,12 +8,23 @@
 
 // Standard
 #include <string>
+#include <iostream>
+#include <errno.h>
+
+#include <signal.h>    // sigaction, sigemptyset, struct sigaction, SIGCHLD, SA_RESTART, SA_NOCLDSTOP
+#include <stdio.h>     // perror
+#include <stdlib.h>    // exit
+#include <sys/wait.h>  // waitpid, pid_t, WNOHANG
 
 // Project
 #include <anna/xml/Compiler.hpp>
 #include <anna/core/util/Millisecond.hpp>
 #include <anna/diameter.comm/Message.hpp>
+#include <anna/diameter.comm/ClientSession.hpp>
+#include <anna/diameter.comm/ServerSession.hpp>
+#include <anna/diameter.comm/Server.hpp>
 #include <anna/core/tracing/Logger.hpp>
+#include <anna/diameter/codec/Message.hpp>
 #include <anna/diameter/codec/functions.hpp>
 #include <anna/diameter/helpers/base/functions.hpp>
 
 #include <TestTimer.hpp>
 
 
+namespace {
+
+  void handle_sigchld(int sig) {
+    while (waitpid((pid_t)(-1 /* any child (the only) */), 0, WNOHANG|WNOWAIT) > 0) {}
+  }
+
+  void cmdRunOnThread (TestStepCmd *step, const std::string &cmd) {
+
+    // Thread running:
+    step->setThreadRunning(true);
+
+    int status = -2;
+
+    struct sigaction sa;
+    sa.sa_handler = &handle_sigchld;
+    sigemptyset(&sa.sa_mask);
+    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;
+      }
+      */
+    }
+    else {
+      perror(0);
+    }
+    // This can be implemented portably and somewhat more concisely with the signal function if you prefer:
+    // if (signal(SIGCHLD, SIG_IGN) == SIG_ERR) {
+    //   perror(0);
+    //   exit(1);
+    // }
+
+    if (status < 0) {
+      char buf[256];
+      char const * str = strerror_r(errno, buf, 256);
+      step->setErrorMsg(anna::functions::asString("errno = %d (%s)", errno, str));
+    }
+
+    step->setResultCode(WEXITSTATUS(status)); // rc = status >>= 8; // divide by 256
+    step->complete();
+    // TODO: terminate thread when deprecated (RT signal ?)
+    // TODO: mutex the step while setting data here !!
+  }
+
+  bool decodeMessage(const anna::DataBlock &message, anna::diameter::codec::Message *messageCodec) throw() {
+
+    if (message.isEmpty())
+      return false;
+
+    bool result = true;
+    try {
+      if (!messageCodec) {
+        Launcher& my_app = static_cast <Launcher&>(anna::app::functions::getApp());
+        messageCodec = new anna::diameter::codec::Message(my_app.getCodecEngine());
+      }
+
+      messageCodec->decode(message);
+    }
+    catch (anna::RuntimeException &ex) {
+      ex.trace();
+      result = false;
+    }
+
+    return result;
+  }
+
+}
+
+
 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 // TestStep
 ////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -42,7 +132,7 @@ void TestStep::initialize(TestCase *testCase) {
 
 const char* TestStep::asText(const Type::_v type)
 throw() {
-  static const char* text [] = { "Unconfigured", "Timeout", "Sendxml2e", "Sendxml2c", "Delay", "Wait" };
+  static const char* text [] = { "Unconfigured", "Timeout", "Sendxml2e", "Sendxml2c", "Delay", "Wait", "Cmd" };
   return text [type];
 }
 
@@ -157,6 +247,11 @@ void TestStepTimeout::do_reset() throw() {
 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 // TestStepSendxml
 ////////////////////////////////////////////////////////////////////////////////////////////////////////
+TestStepSendxml::~TestStepSendxml() {
+  delete a_messageCodec;
+  a_messageCodec = NULL;
+}
+
 anna::xml::Node* TestStepSendxml::asXML(anna::xml::Node* parent) const
 throw() {
   anna::xml::Node* result = TestStep::asXML(parent);
@@ -173,16 +268,10 @@ throw() {
     }
   }
 
-  if (!a_message.isEmpty()) {
-    try {
-      Launcher& my_app = static_cast <Launcher&>(anna::app::functions::getApp());
-      static anna::diameter::codec::Message codecMsg(my_app.getCodecEngine());
-      codecMsg.decode(a_message);
-      xmlmsg = "\n"; xmlmsg += codecMsg.asXMLString(); xmlmsg += "\n";
-    }
-    catch (anna::RuntimeException &ex) {
-      ex.trace();
-    }
+  if (decodeMessage(a_message, a_messageCodec)) {
+    xmlmsg = "\n";
+    xmlmsg += a_messageCodec->asXMLString();
+    xmlmsg += "\n";
   }
 
   if (msg != "") result->createAttribute("Message", msg);
@@ -195,15 +284,22 @@ throw() {
 }
 
 bool TestStepSendxml::do_execute() throw() {
-  anna::diameter::comm::Message *msg = a_realmNode->createCommMessage();
   bool success = false;
   std::string failReason, s_warn;
+  MyDiameterEntity *entity = a_realmNode->getEntity(); // by default
+  MyLocalServer *localServer = a_realmNode->getDiameterServer(); // by default
+  const TestStepWait *tsw = NULL;
+
+  // Create comm message:
+  anna::diameter::comm::Message *msg = a_realmNode->createCommMessage();
+  //msg->clearBody();
+  msg->setBody(a_message);
 
   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:
-      const TestStepWait *tsw = (const TestStepWait*)(a_testCase->getStep(a_waitForRequestStepNumber));
+      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);
@@ -222,31 +318,81 @@ bool TestStepSendxml::do_execute() throw() {
     }
 
     if (getType() == Type::Sendxml2e) {
-      MyDiameterEntity *entity = a_realmNode->getEntity();
-      if (entity) {
-        //msg->clearBody();
-        msg->setBody(a_message);
-        /* response = NULL =*/entity->send(msg);
-        success = true;
+      anna::diameter::comm::ClientSession *usedClientSession = NULL;
+
+      if (tsw) { // is an answer for a received request on wait condition
+        anna::diameter::comm::ClientSession *clientSession = tsw->getClientSession();
+        if (clientSession) {
+          /* response NULL (is an answer) */clientSession->send(msg);
+          success = true;
+          usedClientSession = clientSession;
+        }
+        else {
+          failReason = "Reference wait step didn't store a valid client session. Unable to send the message";
+          LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
+        }
       }
       else {
-        failReason = "There is no diameter entity currently configured. Unable to send the message";
-        LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
+        if (entity) {
+          success = entity->send(msg);
+          anna::diameter::comm::Server *usedServer = entity->getLastUsedResource();
+          usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL;
+        }
+        else {
+          failReason = "There is no diameter entity currently configured. Unable to send the message";
+          LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
+        }
+      } // else (normal sending)
+
+      // Detailed log:
+      if(a_realmNode->logEnabled()) {
+        if (!a_messageCodec)
+          decodeMessage(a_message, a_messageCodec);
+
+        if (a_messageCodec) {
+          std::string detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // shouldn't happen
+          a_realmNode->writeLogFile(*a_messageCodec, (success ? "sent2e" : "send2eError"), detail);
+        }
       }
     }
     else if (getType() == Type::Sendxml2c) {
-      MyLocalServer *localServer = a_realmNode->getDiameterServer();
-      if (localServer) {
-        //msg->clearBody();
-        msg->setBody(a_message);
-        /* response = NULL =*/localServer->send(msg);
-        success = true;
+      anna::diameter::comm::ServerSession *usedServerSession = NULL;
+
+      if (tsw) { // is an answer for a received request on wait condition
+        anna::diameter::comm::ServerSession *serverSession = tsw->getServerSession();
+        if (serverSession) {
+          /* response NULL (is an answer) */serverSession->send(msg);
+          success = true;
+          usedServerSession = serverSession;
+        }
+        else {
+          failReason = "Reference wait step didn't store a valid server session. Unable to send the message";
+          LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
+        }
       }
       else {
-        failReason = "There is no diameter local server currently configured. Unable to send the message";
-        LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
+        if (localServer) {
+          success = localServer->send(msg);
+          usedServerSession = localServer->getLastUsedResource();
+        }
+        else {
+          failReason = "There is no diameter local server currently configured. Unable to send the message";
+          LOGWARNING(anna::Logger::warning(failReason, ANNA_FILE_LOCATION));
+        }
+      } // else (normal sending)
+
+      // Detailed log:
+      if(a_realmNode->logEnabled()) {
+        if (!a_messageCodec)
+          decodeMessage(a_message, a_messageCodec);
+
+        if (a_messageCodec) {
+          std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // shouldn't happen
+          a_realmNode->writeLogFile(*a_messageCodec, (success ? "sent2c" : "send2cError"), detail);
+        }
       }
     }
+
   } catch(anna::RuntimeException &ex) {
     failReason = ex.asString();
   }
@@ -298,7 +444,7 @@ bool TestStepDelay::do_execute() throw() {
 
 void TestStepDelay::do_complete() throw() {
   a_timer = NULL;
-  next(); // next() invoked here because execute() is always false for delay and never dvance the iterator
+  next(); // next() invoked here because execute() is always false for delay and never advance the iterator
 }
 
 void TestStepDelay::do_reset() throw() {
@@ -315,6 +461,11 @@ void TestStepDelay::do_reset() throw() {
 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 // TestStepWait
 ////////////////////////////////////////////////////////////////////////////////////////////////////////
+TestStepWait::~TestStepWait() {
+  delete a_messageCodec;
+  a_messageCodec = NULL;
+}
+
 void TestStepWait::setCondition(bool fromEntity,
                                   const std::string &code, const std::string &bitR, const std::string &resultCode, const std::string &sessionId,
                                   const std::string &hopByHop, const std::string &msisdn, const std::string &imsi, const std::string &serviceContextId) throw() {
@@ -355,20 +506,14 @@ throw() {
     }
   }
 
-  if (!a_message.isEmpty()) {
-    try {
-      Launcher& my_app = static_cast <Launcher&>(anna::app::functions::getApp());
-      static anna::diameter::codec::Message codecMsg(my_app.getCodecEngine());
-      codecMsg.decode(a_message);
-      xmlmsg = "\n"; xmlmsg += codecMsg.asXMLString(); xmlmsg += "\n";
-    }
-    catch (anna::RuntimeException &ex) {
-      ex.trace();
-    }
+  if (decodeMessage(a_message, a_messageCodec)) {
+    xmlmsg = "\n";
+    xmlmsg += a_messageCodec->asXMLString();
+    xmlmsg += "\n";
   }
 
   if (msg != "") result->createAttribute("MatchedMessage", msg);
-  if (xmlmsg != "") result->createAttribute("XMLMessage", xmlmsg);
+  if (xmlmsg != "") result->createAttribute("MatchedXMLMessage", xmlmsg);
 
   return result;
 }
@@ -378,12 +523,13 @@ bool TestStepWait::do_execute() throw() {
 }
 
 void TestStepWait::do_complete() throw() {
-  next(); // next() invoked here because execute() never do this.
+  a_testCase->process(); // next() not invoked; we only want to reactivate the test case
 }
 
 bool TestStepWait::fulfilled(const anna::DataBlock &db/*, bool matchSessionId*/) throw() {
   if (a_condition.comply(db/*, matchSessionId*/)) {
-    a_message = db; // store matched
+    //a_message = db; // store matched
+    a_message.assign(db);
     complete();
     return true;
   }
@@ -397,3 +543,73 @@ void TestStepWait::do_reset() throw() {
   a_serverSession = NULL;
 }
 
+////////////////////////////////////////////////////////////////////////////////////////////////////////
+// TestStepCmd
+////////////////////////////////////////////////////////////////////////////////////////////////////////
+anna::xml::Node* TestStepCmd::asXML(anna::xml::Node* parent) const
+throw() {
+  anna::xml::Node* result = TestStep::asXML(parent);
+  //parent->createChild("TestStepCmd");
+
+  result->createAttribute("Script", (a_script != "") ? a_script:"<no script>");
+  result->createAttribute("Parameters", (a_parameters != "") ? a_parameters:"<no parameters>");
+  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);
+  }
+
+  return result;
+}
+
+bool TestStepCmd::do_execute() throw() {
+  if (!a_threadRunning /* || a_threadDeprecated DO NOT WANT TO OVERLAP ... */) {
+    // Special tags to replace:
+    std::string cmd = getScript();
+    cmd += " ";
+    cmd += getParameters();
+    size_t index;
+    while ((index = cmd.find(SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID)) != std::string::npos)
+      cmd.replace(index, strlen(SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID), anna::functions::asString(TestManager::instantiate().getPoolCycle()));
+    while ((index = cmd.find(SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID)) != std::string::npos)
+      cmd.replace(index, strlen(SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID), anna::functions::asString(a_testCase->getId()));
+    while ((index = cmd.find(SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID)) != std::string::npos)
+      cmd.replace(index, strlen(SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID), anna::functions::asString(getNumber()));
+
+    a_thread = std::thread(cmdRunOnThread, 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 !      
+}
+
+void TestStepCmd::do_complete() throw() {
+
+  a_threadRunning = false;
+  if (a_threadDeprecated) {
+    a_threadDeprecated = false;
+    do_reset();
+    setErrorMsg(anna::functions::asString("Step %d deprecated due to previous reset for Test Case %llu", getNumber(), a_testCase->getId()));
+    a_testCase->setState(TestCase::State::Failed);
+    return; // ignore TODO: interrupt the thread to avoid execution of the script
+  }
+
+  if (getResultCode() != 0)
+    a_testCase->setState(TestCase::State::Failed);
+  else
+    next(); // next() invoked here because execute() is always false for delay and never advance the iterator
+}
+
+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;
+  }
+
+  a_resultCode = -2;
+  //a_output = "";
+}
+