Testing library separation: now not in launcher but isolated
[anna.git] / example / diameter / launcher / Launcher.cpp
index 88e4c44..b141865 100644 (file)
 #include <anna/diameter/helpers/base/functions.hpp>
 #include <anna/time/functions.hpp>
 #include <anna/diameter.comm/ApplicationMessageOamModule.hpp>
+#include <anna/testing/defines.hpp>
 #include <anna/xml/xml.hpp>
+#include <Procedure.hpp>
 
 // Process
 #include <Launcher.hpp>
-#include <OriginHost.hpp>
 #include <MyDiameterEngine.hpp>
-#include <TestManager.hpp>
-#include <TestCase.hpp>
+#include <anna/diameter.comm/OriginHost.hpp>
+#include <anna/testing/TestManager.hpp>
+#include <anna/testing/TestCase.hpp>
 
 
 #define SIGUSR2_TASKS_INPUT_FILENAME "sigusr2.in"
@@ -325,11 +327,24 @@ void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOp
 
       // Checking command line parameters
       std::string sessionBasedModelsType;
+      anna::diameter::comm::Entity::SessionBasedModelsType::_v sessionBasedModelsTypeEnum;
       if(sessionBasedModelsClientSocketSelection) {
         sessionBasedModelsType = sessionBasedModelsClientSocketSelection->getValue();
-        if((sessionBasedModelsType != "SessionIdHighPart") && (sessionBasedModelsType != "SessionIdOptionalPart") && (sessionBasedModelsType != "RoundRobin")) {
-          throw anna::RuntimeException("Parameter 'sessionBasedModelsClientSocketSelection' only accepts 'SessionIdHighPart'/'SessionIdOptionalPart'/'RoundRobin' as parameter values", ANNA_FILE_LOCATION);
-        }
+       if (sessionBasedModelsType == "RoundRobin") {
+          sessionBasedModelsTypeEnum = anna::diameter::comm::Entity::SessionBasedModelsType::RoundRobin;
+       }
+       else if (sessionBasedModelsType == "SessionIdOptionalPart") {
+          sessionBasedModelsTypeEnum = anna::diameter::comm::Entity::SessionBasedModelsType::SessionIdOptionalPart;
+       }
+       else if (sessionBasedModelsType == "SessionIdHighPart") {
+          sessionBasedModelsTypeEnum = anna::diameter::comm::Entity::SessionBasedModelsType::SessionIdHighPart;
+       }
+       else if (sessionBasedModelsType == "SessionIdLowPart") {
+          sessionBasedModelsTypeEnum = anna::diameter::comm::Entity::SessionBasedModelsType::SessionIdLowPart;
+       }
+       else {
+          throw anna::RuntimeException("Parameter 'sessionBasedModelsClientSocketSelection' only accepts 'SessionIdLowPart'/'SessionIdHighPart'/'SessionIdOptionalPart'/'RoundRobin' as parameter values", ANNA_FILE_LOCATION);
+       }
       }
 
       int retransmissions = retries ? retries->getIntegerValue() : 0;
@@ -337,19 +352,21 @@ void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOp
         throw anna::RuntimeException("Parameter 'retries' must be non-negative", ANNA_FILE_LOCATION);
       }
 
-      // Create new Node instance /////////////////////////////////////////////////////////////////
-      a_workingNode = new OriginHost(originHost->getValue(), applicationId, bpd);
-      MyDiameterEngine *commEngine = a_workingNode->getMyDiameterEngine();
       /////////////////////////////////////////////////////////////////////////////////////////////
-
-      // Assignments:
+      // Diameter communication engine:
+      std::string commEngineName = originHost->getValue() + "_DiameterCommEngine";
+      MyDiameterEngine *commEngine = new MyDiameterEngine(commEngineName.c_str(), bpd);
+      commEngine->setAutoBind(false);  // allow to create client-sessions without binding them, in order to set timeouts.
       commEngine->setMaxConnectionDelay(tcpConnectDelayMs);
       commEngine->setWatchdogPeriod(watchdogPeriodMs);
+      commEngine->setOriginHostName(originHost->getValue());
+      if (originRealm) commEngine->setOriginRealmName(originRealm->getValue());
+
+      // Origin host node:
+      a_workingNode = new anna::diameter::comm::OriginHost((anna::diameter::comm::Engine*)commEngine, applicationId);
       a_workingNode->setRequestRetransmissions(retransmissions);
+      /////////////////////////////////////////////////////////////////////////////////////////////
 
-      // Realm information:
-      commEngine->setOriginHost(originHost->getValue());
-      if (originRealm) commEngine->setOriginRealm(originRealm->getValue());
 
       // Diameter entity:
       if(entity) {
@@ -366,7 +383,7 @@ void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOp
 
           // Register one entity for this engine:
           a_workingNode->createEntity(entity->getValue(), ceaTimeoutMs, answersTimeoutMs);
-          a_workingNode->getEntity()->setSessionBasedModelsType(sessionBasedModelsType);
+          a_workingNode->getEntity()->setSessionBasedModelsType(sessionBasedModelsTypeEnum);
           a_workingNode->getEntity()->setBalance(balance ? (balance->getValue() == "yes") : false); // for sendings
           if (eventOperation) a_workingNode->getEntity()->bind();
         }
@@ -378,12 +395,12 @@ void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOp
         std::string ceaPathfile = cea ? cea->getValue() : "";
 
         int sessions = diameterServerSessions ? diameterServerSessions->getIntegerValue() : 1;
-        a_workingNode->startDiameterServer(diameterServer->getValue(), sessions, allowedInactivityTimeMs, answersTimeoutMs, ceaPathfile);
+        a_workingNode->createDiameterServer(diameterServer->getValue(), sessions, allowedInactivityTimeMs, answersTimeoutMs, ceaPathfile);
       }
 
       // Logs:
       if (!allLogsDisabled) {
-        std::string host = commEngine->getOriginHost();
+        std::string host = commEngine->getOriginHostName();
         std::string s_log = host + ".launcher.log"; if (log) s_log = log->getValue();
         bool b_splitLog = (splitLog ? (splitLog->getValue() == "yes") : false);
         bool b_detailedLog = (detailedLog ? (detailedLog->getValue() == "yes") : false);
@@ -504,20 +521,20 @@ bool Launcher::setWorkingNode(const std::string &name) throw() {
     );
   }
   else {
-    a_workingNode = const_cast<OriginHost*>(nodeIt->second);
+    a_workingNode = const_cast<anna::diameter::comm::OriginHost*>(nodeIt->second);
     result = true;
   }
 
   return result;
 }
 
-OriginHost *Launcher::getOriginHost(const std::string &oh) const throw(anna::RuntimeException) {
+anna::diameter::comm::OriginHost *Launcher::getOriginHost(const std::string &oh) const throw(anna::RuntimeException) {
   origin_hosts_it it = a_originHosts.find(oh);
   if (it != a_originHosts.end()) return it->second;
   throw anna::RuntimeException(anna::functions::asString("There is no origin host registered as '%s' (set Origin-Host avp correctly or force a specific host with 'node' operation)", oh.c_str()), ANNA_FILE_LOCATION);
 }
 
-OriginHost *Launcher::getOriginHost(const anna::diameter::codec::Message &message) const throw(anna::RuntimeException) {
+anna::diameter::comm::OriginHost *Launcher::getOriginHost(const anna::diameter::codec::Message &message) const throw(anna::RuntimeException) {
   std::string originHost = message.getAvp(anna::diameter::helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->getValue();
   return (getOriginHost(originHost));
 }
@@ -527,7 +544,14 @@ void Launcher::updateOperatedOriginHostWithMessage(const anna::diameter::codec::
     a_operatedHost = getOriginHost(message);
 }
 
-OriginHost *Launcher::getOperatedHost() const throw(anna::RuntimeException) {
+anna::diameter::comm::OriginHost *Launcher::getWorkingNode() const throw(anna::RuntimeException) {
+  if(!a_workingNode)
+    throw anna::RuntimeException("Working node not identified (try to load services)", ANNA_FILE_LOCATION);
+
+  return a_workingNode;
+}
+
+anna::diameter::comm::OriginHost *Launcher::getOperatedHost() const throw(anna::RuntimeException) {
   if(!a_operatedHost)
     throw anna::RuntimeException("Node not identified (try to force a specific Origin-Host with 'node' operation)", ANNA_FILE_LOCATION);
 
@@ -535,21 +559,21 @@ OriginHost *Launcher::getOperatedHost() const throw(anna::RuntimeException) {
 }
 
 MyDiameterEntity *Launcher::getOperatedEntity() const throw(anna::RuntimeException) {
-  MyDiameterEntity *result = getOperatedHost()->getEntity();
+  MyDiameterEntity *result = (MyDiameterEntity *)(getOperatedHost()->getEntity());
   if (!result)
     throw anna::RuntimeException("No entity configured for the operated node", ANNA_FILE_LOCATION);
   return result;
 }
 
 MyLocalServer *Launcher::getOperatedServer() const throw(anna::RuntimeException) {
-  MyLocalServer *result = getOperatedHost()->getDiameterServer();
+  MyLocalServer *result = (MyLocalServer *)(getOperatedHost()->getDiameterServer());
   if (!result)
     throw anna::RuntimeException("No local server configured for the operated node", ANNA_FILE_LOCATION);
   return result;
 }
 
 MyDiameterEngine *Launcher::getOperatedEngine() const throw(anna::RuntimeException) {
-  return getOperatedHost()->getMyDiameterEngine(); // never will be NULL
+  return (MyDiameterEngine *)getOperatedHost()->getCommEngine(); // never will be NULL
 }
 
 void Launcher::initialize()
@@ -559,7 +583,7 @@ throw(anna::RuntimeException) {
   anna::comm::Communicator::WorkMode::_v workMode(anna::comm::Communicator::WorkMode::Single);
   a_communicator = new MyCommunicator(workMode);
   a_timeEngine = new anna::timex::Engine((anna::Millisecond)600000, a_admlMinResolution);
-  TestManager::instantiate().setTimerController(a_timeEngine);
+  anna::testing::TestManager::instantiate().setTimerController(a_timeEngine);
 
   // Counters record procedure:
   const char *varname = "cntRecordPeriod";
@@ -574,7 +598,7 @@ throw(anna::RuntimeException) {
   // Testing framework:
   std::string tmDir = ".";
   if(cl.exists("tmDir")) tmDir = cl.getValue("tmDir");
-  TestManager::instantiate().setReportsDirectory(tmDir);
+  anna::testing::TestManager::instantiate().setReportsDirectory(tmDir);
 
   // Tracing:
   if(cl.exists("trace"))
@@ -745,39 +769,16 @@ throw(anna::RuntimeException) {
     a_timeEngine->activate(a_counterRecorderClock); // start clock
   }
 
-  // Log statistics concepts
-  if(cl.exists("logStatisticSamples")) {
-    std::string list = cl.getValue("logStatisticSamples");
-    anna::statistics::Engine &statEngine = anna::statistics::Engine::instantiate();
-
-    if(list == "all") {
-      if(statEngine.enableSampleLog(/* -1: all concepts */))
-        LOGDEBUG(anna::Logger::debug("Sample log activation for all statistic concepts", ANNA_FILE_LOCATION));
-    } else {
-      anna::Tokenizer lst;
-      lst.apply(cl.getValue("logStatisticSamples"), ",");
-
-      if(lst.size() >= 1) {
-        anna::Tokenizer::const_iterator tok_min(lst.begin());
-        anna::Tokenizer::const_iterator tok_max(lst.end());
-        anna::Tokenizer::const_iterator tok_iter;
-        int conceptId;
-
-        for(tok_iter = tok_min; tok_iter != tok_max; tok_iter++) {
-          conceptId = atoi(anna::Tokenizer::data(tok_iter));
-
-          if(statEngine.enableSampleLog(conceptId))
-            LOGDEBUG(anna::Logger::debug(anna::functions::asString("Sample log activation for statistic concept id = %d", conceptId), ANNA_FILE_LOCATION));
-        }
-      }
-    }
-  }
-
+  /////////////////////////////
+  // Log statistics concepts //
+  /////////////////////////////
+  if(cl.exists("logStatisticSamples"))
+    logStatisticsSamples(cl.getValue("logStatisticSamples"));
 
   // Start client connections //////////////////////////////////////////////////////////////////////////////////
   MyDiameterEntity *entity;
   for (origin_hosts_it it = a_originHosts.begin(); it != a_originHosts.end(); it++) {
-    entity = it->second->getEntity();
+    entity = (MyDiameterEntity *)(it->second->getEntity());
     if (entity) entity->bind();
   }
 
@@ -818,11 +819,11 @@ bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBl
 
 void Launcher::resetStatistics() throw() {
   if (a_workingNode) {
-    a_workingNode->getMyDiameterEngine()->resetStatistics();
+    a_workingNode->getCommEngine()->resetStatistics();
   }
   else {
     for (origin_hosts_it it = a_originHosts.begin(); it != a_originHosts.end(); it++) {
-      it->second->getMyDiameterEngine()->resetStatistics();
+      it->second->getCommEngine()->resetStatistics();
     }
   }
 }
@@ -1036,6 +1037,11 @@ std::string Launcher::help() const throw() {
   result += "\n                                     This operation applies over all the registered host nodes";
   result += "\n                                      except if one specific working node has been set.";
   result += "\nforceCountersRecord                  Forces dump to file the current counters of the process.";
+  result += "\nlog-statistics-samples|<list>        Log statistics samples for the provided comma-separated concept id";
+  result += "\n                                      list, over './sample.<concept id>.csv' files. For example: \"1,2\"";
+  result += "\n                                      will log concepts 1 and 2. Reserved words \"all\"/\"none\" activates/";
+  result += "\n                                      deactivates all registered statistics concept identifiers. That ids";
+  result += "\n                                      are shown at context dump.";
   result += "\nchange-dir[|directory]               Changes the execution point which could be fine to ease some";
   result += "\n                                     file system interaction tasks. Be care about some requirements";
   result += "\n                                     (for example if you have a user defined counters directory as";
@@ -1436,6 +1442,27 @@ std::string Launcher::help() const throw() {
   result += "\n   test|report-hex[|[yes]|no]    Reports could include the diameter messages in hexadecimal format. Disabled by default.";
   result += "\n";
   result += "\n";
+  result += "\n------------------------------------------------------------------------------------- Dynamic procedure";
+  result += "\n";
+  result += "\ndynamic[|args]                   This launch an internal operation implemented in 'Procedure' class.";
+  result += "\n                                 Its default implementation does nothing, but you could create a dynamic";
+  result += "\n                                 library 'libanna_launcherDynamic.so' and replace the one in this project.";
+  result += "\n                                 One interesting application consists in the use of the diameter API and";
+  result += "\n                                 event operation to create a set of libraries as the testing framework.";
+  result += "\n                                 To execute each test case, the ADML process would be executed with a";
+  result += "\n                                 specific library path. But the main use would be the stress programming";
+  result += "\n                                 to achieve a great amount of cloned (even mixed) tests without using";
+  result += "\n                                 the management operation interface by mean http or signals: a single";
+  result += "\n                                 call to 'dynamic' would be enough to start a cascade of internally";
+  result += "\n                                 implemented operations.";
+  result += "\n                                 This operation accepts a generic string argument (piped or not, as you";
+  result += "\n                                 desire and depending on your procedure implementation).";
+  result += "\n";
+  result += "\n                                 This operation requires advanced programming and knowlegde of ANNA Diameter";
+  result += "\n                                 stack and testing framework, to take advantage of all the possibilities.";
+  result += "\n";
+  result += "\n";
+  result += "\n";
   result += "\nUSING OPERATIONS INTERFACE";
   result += "\n--------------------------";
   result += "\n";
@@ -1476,6 +1503,38 @@ std::string Launcher::help() const throw() {
   return result;
 }
 
+
+void Launcher::logStatisticsSamples(const std::string &conceptsList) throw() {
+  anna::statistics::Engine &statEngine = anna::statistics::Engine::instantiate();
+
+  if(conceptsList == "all") {
+    if(statEngine.enableSampleLog(/* -1: all concepts */))
+      LOGDEBUG(anna::Logger::debug("Sample log activation for all statistic concepts", ANNA_FILE_LOCATION));
+  }
+  else if(conceptsList == "none") {
+      if(statEngine.disableSampleLog(/* -1: all concepts */))
+        LOGDEBUG(anna::Logger::debug("Sample log deactivation for all statistic concepts", ANNA_FILE_LOCATION));
+  } else {
+    anna::Tokenizer lst;
+    lst.apply(conceptsList, ",");
+
+    if(lst.size() >= 1) {
+      anna::Tokenizer::const_iterator tok_min(lst.begin());
+      anna::Tokenizer::const_iterator tok_max(lst.end());
+      anna::Tokenizer::const_iterator tok_iter;
+      int conceptId;
+
+      for(tok_iter = tok_min; tok_iter != tok_max; tok_iter++) {
+        conceptId = atoi(anna::Tokenizer::data(tok_iter));
+
+        if(statEngine.enableSampleLog(conceptId))
+          LOGDEBUG(anna::Logger::debug(anna::functions::asString("Sample log activation for statistic concept id = %d", conceptId), ANNA_FILE_LOCATION));
+      }
+    }
+  }
+}
+
+
 void Launcher::eventOperation(const std::string &operation, std::string &response_content) throw(anna::RuntimeException) {
   LOGMETHOD(anna::TraceMethod tm("Launcher", "eventOperation", ANNA_FILE_LOCATION));
   if (operation == "") return; // ignore
@@ -1489,13 +1548,30 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
   anna::diameter::codec::Message codecMsg; // auxiliary codec message
 
   // Singletons:
-  CommandLine& cl(anna::CommandLine::instantiate());
-  TestManager &testManager = TestManager::instantiate();
+  anna::testing::TestManager &testManager = anna::testing::TestManager::instantiate();
 
 
   ///////////////////////////////////////////////////////////////////
   // Simple operations without arguments:
 
+  // Dynamic operation:
+  if(operation.find("dynamic") == 0) {
+    Procedure p(this);
+    int op_size = operation.size();
+    std::string args = ((operation.find("dynamic|") == 0) && (op_size > 8)) ? operation.substr(8) : "";
+    if (args == "" && op_size != 7)
+      throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
+    try {
+      p.execute(args, response_content, getWorkingNode());
+    }
+    catch(anna::RuntimeException &ex) {
+      ex.trace();
+      response_content = ex.asString();
+      return;
+    }
+    return;
+  }
+
   // Help:
   if(operation == "help") {
     response_content = help();
@@ -1573,6 +1649,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
   bool wrongBody = false;
 
   if((opType == "change-dir") && (numParams > 1)) wrongBody = true;
+  if((opType == "log-statistics-samples") && (numParams != 1)) wrongBody = true;
   if((opType == "node") && (numParams > 1)) wrongBody = true;
 
   if((opType == "node_auto") && (numParams > 0)) wrongBody = true;
@@ -1603,6 +1680,12 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
     return;
   }
 
+  if(opType == "log-statistics-samples") {
+    logStatisticsSamples(param1);
+    response_content = anna::functions::asString("Log statistics samples for '%s' concepts", param1.c_str());
+    return;
+  }
+
   // Change execution directory:
   if(opType == "change-dir") {
     if (param1 == "") param1 = a_initialWorkingDirectory;
@@ -1735,7 +1818,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
       try { if(getOperatedHost()->logEnabled()) codecMsg.decode(db_aux); } catch(anna::RuntimeException &ex) { ex.trace(); }
     }
 
-    bool success = getOperatedEntity()->send(msg, cl.exists("balance"));
+    bool success = getOperatedEntity()->send(msg);
     getOperatedHost()->releaseCommMessage(msg);
 
     // Detailed log:
@@ -1979,7 +2062,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
 
       int id = ((param2 != "") ? atoi(param2.c_str()) : -1);
-      TestCase *testCase = testManager.findTestCase(id);
+      anna::testing::TestCase *testCase = testManager.findTestCase(id);
 
       if (testCase) {
         response_content = testCase->asXMLString();
@@ -2005,7 +2088,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
         throw anna::RuntimeException("Interactive amount must be -1 (to disable interactive mode) or a positive number.", ANNA_FILE_LOCATION);
 
       int id = atoi(param3.c_str());
-      TestCase *testCase = testManager.findTestCase(id);
+      anna::testing::TestCase *testCase = testManager.findTestCase(id);
       if (testCase) {
         if (amount == -1) {
           testCase->makeInteractive(false);
@@ -2036,7 +2119,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
 
       int id = ((param3 != "") ? atoi(param3.c_str()) : -1);
-      TestCase *testCase = ((id != -1) ? testManager.findTestCase(id) : NULL);
+      anna::testing::TestCase *testCase = ((id != -1) ? testManager.findTestCase(id) : NULL);
 
       if (testCase) {
         bool done = testCase->reset((param2 == "hard") ? true:false);
@@ -2205,7 +2288,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
     } else if (param1 == "clear") {
       getOperatedServer()->getReactingAnswers()->clear();
     } else if (param1 == "dump") {
-      getOperatedServer()->getReactingAnswers()->dump();
+      getOperatedServer()->getReactingAnswers()->dump("programmed_answer");
     } else {
       codecMsg.loadXML(param1);
       updateOperatedOriginHostWithMessage(codecMsg);
@@ -2231,7 +2314,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
     } else if (param1 == "clear") {
       getOperatedEntity()->getReactingAnswers()->clear();
     } else if (param1 == "dump") {
-      getOperatedEntity()->getReactingAnswers()->dump();
+      getOperatedEntity()->getReactingAnswers()->dump("programmed_answer");
     } else {
       codecMsg.loadXML(param1);
       updateOperatedOriginHostWithMessage(codecMsg);
@@ -2279,7 +2362,7 @@ throw() {
   statsAsXML(result);
 
   // Testing: could be heavy if test case reports are enabled
-  TestManager::instantiate().asXML(result);
+  anna::testing::TestManager::instantiate().asXML(result);
 
   return result;
 }