X-Git-Url: https://git.teslayout.com/public/public/public/?p=anna.git;a=blobdiff_plain;f=example%2Fdiameter%2Flauncher%2FLauncher.cpp;h=60a9cb0cfb7a0fec3dcc13f668d50713fc9af26c;hp=a6c5bee3123363e4225f713d425e476981c50cf5;hb=415985b3f67878c2e3cee785a0b1cb36f4eff901;hpb=2921c651c9945cefec0715167201596aaa079e8d diff --git a/example/diameter/launcher/Launcher.cpp b/example/diameter/launcher/Launcher.cpp index a6c5bee..60a9cb0 100644 --- a/example/diameter/launcher/Launcher.cpp +++ b/example/diameter/launcher/Launcher.cpp @@ -11,29 +11,37 @@ #include // std::cout #include // ceil #include +#include // chdir +//#include TODO: use this from gcc4.9.0: http://stackoverflow.com/questions/8060025/is-this-c11-regex-error-me-or-the-compiler +#include // Project #include #include +#include #include +#include #include #include #include #include #include +#include #include +#include +#include // Process #include -#include +#include +#include #include -#include -#include +#include +#include -#define SIGUSR2_TASKS_INPUT_FILENAME "./sigusr2.in" -#define SIGUSR2_TASKS_OUTPUT_FILENAME "./sigusr2.out" - +#define SIGUSR2_TASKS_INPUT_FILENAME "sigusr2.in" +#define SIGUSR2_TASKS_OUTPUT_FILENAME "sigusr2.out" const char *ServicesDTD = "\ @@ -43,66 +51,85 @@ const char *ServicesDTD = "\ \n\ \n\ \n\ -\n\ +\n\ \n\ \n\ \n\ -\n\ +\n\ \n\ \n\ @@ -110,38 +137,51 @@ const char *ServicesDTD = "\ Launcher::Launcher() : anna::comm::Application("launcher", "DiameterLauncher", "1.1"), a_communicator(NULL) { - a_codecEngine = new anna::diameter::codec::Engine("MyCodecEngine"); - a_baseProtocolDictionary = NULL; a_timeEngine = NULL; a_counterRecorder = NULL; a_admlMinResolution = 2 * anna::timex::Engine::minResolution; // 2*10 = 20 ms; 1000/20 = 50 ticks per second; //a_admlMinResolution = (anna::Millisecond)100; a_counterRecorderClock = NULL; - // a_nodes.clear(); a_workingNode = NULL; a_httpServerSocket = NULL; } +std::string Launcher::getSignalUSR2InputFile() const throw() { + return (a_initialWorkingDirectory + "/" + SIGUSR2_TASKS_INPUT_FILENAME); +} + +std::string Launcher::getSignalUSR2OutputFile() const throw() { + return (a_initialWorkingDirectory + "/" + SIGUSR2_TASKS_OUTPUT_FILENAME); +} void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOperation) throw(anna::RuntimeException) { - // - const anna::xml::Attribute *id, *dictionary; - // - const anna::xml::Attribute *originRealm, *originHost, *cer, *dwr, *allowedInactivityTime, *tcpConnectDelay, - *answersTimeout, *ceaTimeout, *watchdogPeriod, *entity, *entityServerSessions, - *diameterServer, *diameterServerSessions, *balance, *sessionBasedModelsClientSocketSelection, - *retries, *log, *splitLog, *detailedLog, *dumpLog, *burstLog; + CommandLine& cl(anna::CommandLine::instantiate()); + bool allLogsDisabled = cl.exists("disableLogs"); + + // + const anna::xml::Attribute *id, *dictionary; + // + const anna::xml::Attribute *originHost, *appId, *originRealm, *cer, *dwr, *cea, *allowedInactivityTime, *tcpConnectDelay, + *answersTimeout, *ceaTimeout, *watchdogPeriod, *entity, *entityServerSessions, + *diameterServer, *diameterServerSessions, *balance, *sessionBasedModelsClientSocketSelection, + *retries, *log, *splitLog, *detailedLog, *dumpLog, *burstLog; // Never clear services content from here (append new data from xml). At the moment no node removing is implemented in this process // Stacks anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate(); anna::diameter::stack::Dictionary *d; + const anna::diameter::stack::Dictionary *bpd = NULL; // base protocol dictionary + + // Codec engine manager: + anna::diameter::codec::EngineManager &em = anna::diameter::codec::EngineManager::instantiate(); + anna::diameter::codec::Engine *ce; + /////////////////////////////////////////// // APPLICATION MESSAGE OAM MODULE SCOPES // /////////////////////////////////////////// @@ -149,8 +189,8 @@ void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOp anna::diameter::comm::ApplicationMessageOamModule & appMsgOamModule = anna::diameter::comm::ApplicationMessageOamModule::instantiate(); appMsgOamModule.enableCounters(); // this special module is disabled by default (the only) static int scope_id = 3; - bool id_0_registered = false; unsigned int id_value; + std::string codecEngineName; for(anna::xml::Node::const_child_iterator it = servicesNode->child_begin(); it != servicesNode->child_end(); it++) { std::string nodeName = (*it)->getName(); @@ -161,9 +201,14 @@ void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOp dictionary = (*it)->getAttribute("dictionary"); id_value = id->getIntegerValue(); + if (stackEngine.getDictionary(id_value)) { // Ignore (but don't fail) dictionary load with same stack id already registered + LOGWARNING(anna::Logger::warning(anna::functions::asString("Ignore dictionary load for stack id already registered: %llu", id_value), ANNA_FILE_LOCATION)); + continue; + } + try { d = stackEngine.createDictionary(id_value, dictionary->getValue()); - getCodecEngine()->setDictionary(d); + LOGDEBUG(anna::Logger::debug(anna::functions::asString("Created dictionary (%p) for stack id %llu", d, id_value), ANNA_FILE_LOCATION)); // OAM module for counters: appMsgOamModule.createStackCounterScope(scope_id, id_value /* application-id */); @@ -174,9 +219,44 @@ void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOp throw ex; } - if (id_value == 0) - id_0_registered = true; - a_baseProtocolDictionary = d; + bpd = d; // base protocol dictionary in case of monostack. If multistack, will be calculated later + + // Create codec engine and register it in the codec engine manager: + codecEngineName = anna::functions::asString("CodecEngineForStackId_%llu", id_value); + ce = new anna::diameter::codec::Engine(codecEngineName.c_str(), d); + em.registerCodecEngine(id_value, ce); + + // Codec engine configuration: + const anna::xml::Attribute *vm_attr = (*it)->getAttribute("validationMode", false /* no exception */); + const anna::xml::Attribute *vd_attr = (*it)->getAttribute("validationDepth", false /* no exception */); + const anna::xml::Attribute *fm_attr = (*it)->getAttribute("fixMode", false /* no exception */); + const anna::xml::Attribute *if_attr = (*it)->getAttribute("ignoreFlagsOnValidation", false /* no exception */); + + std::string vm_value = vm_attr ? vm_attr->getValue() : "AfterDecoding"; + std::string vd_value = vd_attr ? vd_attr->getValue() : "FirstError"; + std::string fm_value = fm_attr ? fm_attr->getValue() : "BeforeEncoding"; + + anna::diameter::codec::Engine::ValidationMode::_v vm; + if (vm_value == "BeforeEncoding") vm = anna::diameter::codec::Engine::ValidationMode::BeforeEncoding; + else if (vm_value == "AfterDecoding") vm = anna::diameter::codec::Engine::ValidationMode::AfterDecoding; + else if (vm_value == "Always") vm = anna::diameter::codec::Engine::ValidationMode::Always; + else if (vm_value == "Never") vm = anna::diameter::codec::Engine::ValidationMode::Never; + ce->setValidationMode(vm); + + anna::diameter::codec::Engine::ValidationDepth::_v vd; + if (vd_value == "Complete") vd = anna::diameter::codec::Engine::ValidationDepth::Complete; + else if (vd_value == "FirstError") vd = anna::diameter::codec::Engine::ValidationDepth::FirstError; + ce->setValidationDepth(vd); + + anna::diameter::codec::Engine::FixMode::_v fm; + if (fm_value == "BeforeEncoding") fm = anna::diameter::codec::Engine::FixMode::BeforeEncoding; + else if (fm_value == "AfterDecoding") fm = anna::diameter::codec::Engine::FixMode::AfterDecoding; + else if (fm_value == "Always") fm = anna::diameter::codec::Engine::FixMode::Always; + else if (fm_value == "Never") fm = anna::diameter::codec::Engine::FixMode::Never; + ce->setFixMode(fm); + + bool if_value = (if_attr ? (if_attr->getValue() == "yes") : false); + ce->ignoreFlagsOnValidation(if_value); } } @@ -184,29 +264,26 @@ void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOp std::cout << "Stacks currently loaded:" << std::endl; std::cout << anna::functions::tab(stackEngine.asString(false /* light */)) << std::endl; - - // Codec engine adjustments: - // Auto stack selection based on Application-ID: + // Basic checking for multistack: bool multistack = (stackEngine.stack_size() > 1); if (multistack) { - getCodecEngine()->selectStackWithApplicationId(true); - // In multistack, id = 0 MUST be registered: - if (!id_0_registered) + bpd = stackEngine.getDictionary(0); + if(!bpd) throw anna::RuntimeException("In multistack applications is mandatory register a stack id = 0 using a dictionary which contains the needed elements to build base protocol messages (CER/A, DWR/A, DPR/A, STR/A, etc.)", ANNA_FILE_LOCATION); } - else { - a_baseProtocolDictionary = d; - } + // REALMS: for(anna::xml::Node::const_child_iterator it = servicesNode->child_begin(); it != servicesNode->child_end(); it++) { std::string nodeName = (*it)->getName(); if(nodeName == "node") { // Input data: - originRealm = (*it)->getAttribute("originRealm"); - originHost = (*it)->getAttribute("originHost", false /* no exception */); + originHost = (*it)->getAttribute("originHost"); + appId = (*it)->getAttribute("applicationId"); + originRealm = (*it)->getAttribute("originRealm", false /* no exception */); cer = (*it)->getAttribute("cer", false /* no exception */); dwr = (*it)->getAttribute("dwr", false /* no exception */); + cea = (*it)->getAttribute("cea", false /* no exception */); allowedInactivityTime = (*it)->getAttribute("allowedInactivityTime", false /* no exception */); tcpConnectDelay = (*it)->getAttribute("tcpConnectDelay", false /* no exception */); answersTimeout = (*it)->getAttribute("answersTimeout", false /* no exception */); @@ -226,9 +303,16 @@ void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOp burstLog = (*it)->getAttribute("burstLog", false /* no exception */); // (yes | no) // Basic checkings: - realm_nodes_it nodeIt = a_nodes.find(originRealm->getValue()); - if (nodeIt != a_nodes.end()) { - std::string msg = "Already registered node name (Origin-Realm): "; msg += originRealm->getValue(); + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + anna::diameter::comm::OriginHost *oh = ohm.getOriginHost(originHost->getValue()); + if (oh) { + std::string msg = "Already registered such Origin-Host: "; msg += originHost->getValue(); + throw anna::RuntimeException(msg, ANNA_FILE_LOCATION); + } + + unsigned int applicationId = appId->getIntegerValue(); + if (!stackEngine.getDictionary(applicationId)) { + std::string msg = "Cannot found a registered stack id with the value of applicationId provided: "; msg += appId->getValue(); throw anna::RuntimeException(msg, ANNA_FILE_LOCATION); } @@ -247,11 +331,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 = anna::diameter::comm::Entity::SessionBasedModelsType::SessionIdLowPart; 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; @@ -259,18 +356,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 RealmNode(originRealm->getValue(), a_codecEngine, a_baseProtocolDictionary); - 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: - if (originHost) commEngine->setHost(originHost->getValue()); - commEngine->setRealm(originRealm->getValue()); // Diameter entity: if(entity) { @@ -287,8 +387,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->setRequestRetransmissions(retransmissions); - 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(); } @@ -296,29 +395,37 @@ void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOp // Diameter Server: if(diameterServer) { + // Server CEA + std::string ceaPathfile = cea ? cea->getValue() : ""; + int sessions = diameterServerSessions ? diameterServerSessions->getIntegerValue() : 1; - a_workingNode->startDiameterServer(diameterServer->getValue(), sessions, allowedInactivityTimeMs); + a_workingNode->createDiameterServer(diameterServer->getValue(), sessions, allowedInactivityTimeMs, answersTimeoutMs, ceaPathfile); } // Logs: - std::string realm = commEngine->getRealm(); - std::string s_log = realm + ".launcher.log"; if (log) s_log = log->getValue(); - bool b_splitLog = (splitLog ? (splitLog->getValue() == "yes") : false); - bool b_detailedLog = (detailedLog ? (detailedLog->getValue() == "yes") : false); - bool b_dumpLog = (dumpLog ? (dumpLog->getValue() == "yes") : false); - std::string s_burstLog = realm + ".launcher.burst"; if (burstLog) s_burstLog = burstLog->getValue(); - a_workingNode->setLogs(s_log, b_splitLog, b_detailedLog, b_dumpLog, s_burstLog); + if (!allLogsDisabled) { + 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); + bool b_dumpLog = (dumpLog ? (dumpLog->getValue() == "yes") : false); + std::string s_burstLog = host + ".launcher.burst"; if (burstLog) s_burstLog = burstLog->getValue(); + a_workingNode->setLogs(s_log, b_splitLog, b_detailedLog, b_dumpLog, s_burstLog); + } // Lazy initialization for comm engine: if (eventOperation) commEngine->lazyInitialize(); - // New Node assignment ////////////////////////////////////////////////////////////////////// - a_nodes[originRealm->getValue()] = a_workingNode; + // Node and Codec Engine registration /////////////////////////////////////////////////////// + ohm.registerOriginHost(originHost->getValue(), a_workingNode); ///////////////////////////////////////////////////////////////////////////////////////////// } } + if (!uniqueOriginHost()) + a_workingNode = NULL; // by default, mode auto + // Diameter comm engines which are loaded after application start (via management operation 'services') are not really started, // but this don't care because application startComponents() -> initialize() -> do_initialize() -> do nothing. // And when stopped, running state is not checked and it will be stopped anyway. @@ -333,10 +440,10 @@ void Launcher::loadServices(const std::string & xmlPathFile, bool eventOperation } LOGDEBUG( - std::string trace = "Loading ADML services file '"; - trace += xmlPathFile; - trace += "'"; - anna::Logger::debug(trace, ANNA_FILE_LOCATION); + std::string trace = "Loading ADML services file '"; + trace += xmlPathFile; + trace += "'"; + anna::Logger::debug(trace, ANNA_FILE_LOCATION); ); anna::xml::DocumentFile xmlDocument; // has private copy constructor defined but not implemented to avoid inhenrit/copy (is very heavy) anna::xml::DTDMemory xmlDTD; @@ -348,19 +455,19 @@ void Launcher::loadServices(const std::string & xmlPathFile, bool eventOperation } catch (anna::RuntimeException &ex) { LOGWARNING( - std::string msg = "Services DTD schema:\n\n"; - msg += ServicesDTD; - anna::Logger::warning(msg, ANNA_FILE_LOCATION); + std::string msg = "Services DTD schema:\n\n"; + msg += ServicesDTD; + anna::Logger::warning(msg, ANNA_FILE_LOCATION); ); throw ex; } LOGDEBUG( - std::string trace = "Loaded XML file ("; - trace += xmlPathFile; - trace += "):\n"; - trace += anna::xml::Compiler().apply(rootNode); - anna::Logger::debug(trace, ANNA_FILE_LOCATION); + std::string trace = "Loaded XML file ("; + trace += xmlPathFile; + trace += "):\n"; + trace += anna::xml::Compiler().apply(rootNode); + anna::Logger::debug(trace, ANNA_FILE_LOCATION); ); servicesFromXML(rootNode, eventOperation); } @@ -407,37 +514,76 @@ anna::Millisecond Launcher::checkTimeMeasure(const std::string ¶meter, const throw RuntimeException(msg, ANNA_FILE_LOCATION); } -RealmNode *Launcher::getWorkingNode() const throw(anna::RuntimeException) { +bool Launcher::setWorkingNode(const std::string &name) throw() { + bool result = false; + + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + anna::diameter::comm::OriginHost *oh = ohm.getOriginHost(name); + + if (oh) { + a_workingNode = const_cast(oh); + result = true; + } + + return result; +} + +anna::diameter::comm::OriginHost *Launcher::getOriginHost(const std::string &name) const throw(anna::RuntimeException) { + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + anna::diameter::comm::OriginHost *result = ohm.getOriginHost(name); - if (!a_workingNode) - throw RuntimeException("No services yet loaded. Try 'services' operation (via management interface), or restart process using command-line 'services' parameter", ANNA_FILE_LOCATION); + if (!result) + 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)", name.c_str()), ANNA_FILE_LOCATION); + + return result; +} + +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)); +} + +bool Launcher::uniqueOriginHost() const throw() { + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + return (ohm.size() == 1); +} + + +void Launcher::updateOperatedOriginHostWithMessage(const anna::diameter::codec::Message &message) throw(anna::RuntimeException) { + if (!a_operatedHost) // priority for working node by mean 'node' operation + a_operatedHost = getOriginHost(message); +} + +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; } -bool Launcher::setWorkingNode(const std::string &name) throw() { - bool result = false; +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); - realm_nodes_nc_it nodeIt = a_nodes.find(name); - if (nodeIt == a_nodes.end()) { - LOGWARNING( - std::string msg = "Unknown node with name '"; msg += name; msg += "'. Ignoring ..."; - anna::Logger::warning(msg, ANNA_FILE_LOCATION); - ); - } - else { - a_workingNode = nodeIt->second; - result = true; - } + return a_operatedHost; +} +MyDiameterEntity *Launcher::getOperatedEntity() const throw(anna::RuntimeException) { + MyDiameterEntity *result = (MyDiameterEntity *)(getOperatedHost()->getEntity()); + if (!result) + throw anna::RuntimeException("No entity configured for the operated node", ANNA_FILE_LOCATION); return result; } -RealmNode *Launcher::getRealmNode(const std::string &realmName) const throw() { - realm_nodes_it it = a_nodes.find(realmName); - if (it != a_nodes.end()) return it->second; +MyLocalServer *Launcher::getOperatedServer() const throw(anna::RuntimeException) { + MyLocalServer *result = (MyLocalServer *)(getOperatedHost()->getDiameterServer()); + if (!result) + throw anna::RuntimeException("No local server configured for the operated node", ANNA_FILE_LOCATION); + return result; +} - return NULL; // this never happens +MyDiameterEngine *Launcher::getOperatedEngine() const throw(anna::RuntimeException) { + return (MyDiameterEngine *)getOperatedHost()->getCommEngine(); // never will be NULL } void Launcher::initialize() @@ -447,11 +593,18 @@ 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"; - anna::Millisecond cntRecordPeriod = (cl.exists(varname)) ? checkTimeMeasure(varname, cl.getValue(varname)) : (anna::Millisecond)300000; + anna::Millisecond cntRecordPeriod; + try { + cntRecordPeriod = (cl.exists(varname)) ? checkTimeMeasure(varname, cl.getValue(varname)) : (anna::Millisecond)300000; + } + catch(anna::RuntimeException &ex) { + if (cntRecordPeriod != 0) throw ex; + } + if(cntRecordPeriod != 0) { a_counterRecorderClock = new MyCounterRecorderClock("Counters record procedure clock", cntRecordPeriod); // clock std::string cntDir = "."; @@ -462,7 +615,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")) @@ -476,20 +629,25 @@ void Launcher::run() throw(anna::RuntimeException) { LOGMETHOD(anna::TraceMethod tm("Launcher", "run", ANNA_FILE_LOCATION)); CommandLine& cl(anna::CommandLine::instantiate()); - anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate(); + anna::diameter::stack::Engine::instantiate(); // Start time: a_start_time.setNow(); + + // Initial working directory: + char cwd[1024]; + if (getcwd(cwd, sizeof(cwd)) == NULL) + throw anna::RuntimeException("Cannot retrieve initial working directory !!", ANNA_FILE_LOCATION); + a_initialWorkingDirectory = cwd; + // Statistics: anna::statistics::Engine::instantiate().enable(); LOGINFORMATION( - // Help on startup traces: - anna::Logger::information(help(), ANNA_FILE_LOCATION); - // Test messages dtd: - std::string msg = "\n ------------- TESTMESSAGES DTD -------------\n"; - msg += anna::diameter::codec::MessageDTD; - anna::Logger::information(msg, ANNA_FILE_LOCATION); + // Test messages dtd: + std::string msg = "\n ------------- TESTMESSAGES DTD -------------\n"; + msg += anna::diameter::codec::MessageDTD; + anna::Logger::information(msg, ANNA_FILE_LOCATION); ); // HTTP Server: @@ -626,62 +784,17 @@ throw(anna::RuntimeException) { a_timeEngine->activate(a_counterRecorderClock); // start clock } - - // Integration (validation 'Complete' for receiving messages) and debugging (validation also before encoding: 'Always'). - // If missing 'integrationAndDebugging', default behaviour at engine is: mode 'AfterDecoding', depth 'FirstError': - if(cl.exists("integrationAndDebugging")) { - getCodecEngine()->setValidationMode(anna::diameter::codec::Engine::ValidationMode::Always); - getCodecEngine()->setValidationDepth(anna::diameter::codec::Engine::ValidationDepth::Complete); - } - - // Fix mode - if(cl.exists("fixMode")) { // BeforeEncoding(default), AfterDecoding, Always, Never - std::string fixMode = cl.getValue("fixMode"); - anna::diameter::codec::Engine::FixMode::_v fm; - if (fixMode == "BeforeEncoding") fm = anna::diameter::codec::Engine::FixMode::BeforeEncoding; - else if (fixMode == "AfterDecoding") fm = anna::diameter::codec::Engine::FixMode::AfterDecoding; - else if (fixMode == "Always") fm = anna::diameter::codec::Engine::FixMode::Always; - else if (fixMode == "Never") fm = anna::diameter::codec::Engine::FixMode::Never; - else LOGINFORMATION(anna::Logger::information("Unreconized command-line fix mode. Assumed default 'BeforeEncoding'", ANNA_FILE_LOCATION)); - getCodecEngine()->setFixMode(fm); - } - - getCodecEngine()->ignoreFlagsOnValidation(cl.exists("ignoreFlags")); - - - // 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 (realm_nodes_it it = a_nodes.begin(); it != a_nodes.end(); it++) { - entity = it->second->getEntity(); + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + for (diameter::comm::origin_hosts_it it = ohm.begin(); it != ohm.end(); it++) { + entity = (MyDiameterEntity *)(it->second->getEntity()); if (entity) entity->bind(); } @@ -695,8 +808,7 @@ throw(anna::RuntimeException) { a_communicator->accept(); } - -bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBlock &db) const throw() { +bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBlock &db) const throw(anna::RuntimeException) { // Get hex string static char buffer[8192]; std::ifstream infile(pathfile.c_str(), std::ifstream::in); @@ -707,11 +819,12 @@ bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBl // Allow colon separator in hex string: we have to remove them before processing with 'fromHexString': hexString.erase(std::remove(hexString.begin(), hexString.end(), ':'), hexString.end()); LOGDEBUG( - std::string msg = "Hex string (remove colons if exists): "; - msg += hexString; - anna::Logger::debug(msg, ANNA_FILE_LOCATION); + std::string msg = "Hex string (remove colons if exists): "; + msg += hexString; + anna::Logger::debug(msg, ANNA_FILE_LOCATION); ); - anna::functions::fromHexString(hexString, db); + + anna::functions::fromHexString(hexString, db); // could launch exception // Close file infile.close(); return true; @@ -721,7 +834,15 @@ bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBl } void Launcher::resetStatistics() throw() { - getWorkingNode()->getMyDiameterEngine()->resetStatistics(); + if (a_workingNode) { + a_workingNode->getCommEngine()->resetStatistics(); + } + else { + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + for (diameter::comm::origin_hosts_it it = ohm.begin(); it != ohm.end(); it++) { + it->second->getCommEngine()->resetStatistics(); + } + } } void Launcher::resetCounters() throw() { @@ -730,31 +851,48 @@ void Launcher::resetCounters() throw() { anna::diameter::codec::OamModule::instantiate().resetCounters(); } +void Launcher::signalTerminate() throw(anna::RuntimeException) { + LOGMETHOD(anna::TraceMethod tm("Launcher", "signalTerminate", ANNA_FILE_LOCATION)); + + forceCountersRecord(); + + a_communicator->terminate (); + comm::Application::signalTerminate (); +} + void Launcher::signalUSR2() throw(anna::RuntimeException) { + + std::string inputFile = getSignalUSR2InputFile(); + std::string outputFile = getSignalUSR2OutputFile(); + LOGNOTICE( - std::string msg = "Captured signal SIGUSR2. Reading tasks at '"; - msg += SIGUSR2_TASKS_INPUT_FILENAME; - msg += "' (results will be written at '"; - msg += SIGUSR2_TASKS_OUTPUT_FILENAME; - msg += "')"; - anna::Logger::notice(msg, ANNA_FILE_LOCATION); + std::string msg = "Captured signal SIGUSR2. Reading tasks at '"; + msg += inputFile; + msg += "' (results will be written at '"; + msg += outputFile; + msg += "')"; + anna::Logger::notice(msg, ANNA_FILE_LOCATION); ); // Operation: std::string line; std::string response_content; - std::ifstream in_file(SIGUSR2_TASKS_INPUT_FILENAME); - std::ofstream out_file(SIGUSR2_TASKS_OUTPUT_FILENAME); + std::ifstream in_file(inputFile); + std::ofstream out_file(outputFile); if(!in_file.is_open()) throw RuntimeException("Unable to read tasks", ANNA_FILE_LOCATION); - if(!out_file.is_open()) throw RuntimeException("Unable to write tasks", ANNA_FILE_LOCATION); while(getline(in_file, line)) { + + // Ignore comments and blank lines: + if (line[0] == '#') continue; + if (std::string::npos == line.find_first_not_of(" \t")) continue; + LOGDEBUG( - std::string msg = "Processing line: "; - msg += line; - anna::Logger::debug(msg, ANNA_FILE_LOCATION); + std::string msg = "Processing line: "; + msg += line; + anna::Logger::debug(msg, ANNA_FILE_LOCATION); ); try { @@ -767,543 +905,80 @@ void Launcher::signalUSR2() throw(anna::RuntimeException) { } in_file.close(); + out_file << "EOF\n"; out_file.close(); } -std::string Launcher::help() const throw() { - std::string result = "\n"; - result += "\n ------------- HELP -------------\n"; - result += "\n"; - result += "\nOVERVIEW"; - result += "\n--------"; - result += "\n"; - result += "\nThe ADML (ANNA Diameter Multirealm Launcher) process is a multi-realm node with client and server"; - result += "\n capabilities as well as balancer (proxy) features. It could be used as diameter server (i.e. to"; - result += "\n simulate PCRF nodes, OCS systems, etc.), as diameter client (GGSNs, DPIs, etc.), and balancer"; - result += "\n systems to provide failover to external round-robin launchers. Also, auxiliary encoder/decoder/loader"; - result += "\n function could be deployed to reinterpret certain external flow and send it to another process."; - result += "\n "; - result += "\nThe ANNA::diameter_comm built-in module provides a great set of characteristics as multiple connections"; - result += "\n on both server and client side, definition for multiple-server entities (and not only two as standard"; - result += "\n establish as minimum), separate statistics analyzer per each resource, automatic CER/CEA and DWR/DWA"; - result += "\n generation, expiration control and many more features."; - result += "\n"; - result += "\nThe ADML process can easily configure a many realm nodes as needed, which will have own endpoints."; - result += "\nYou should avoid loop configurations (client and server for that client) because automatic forwarding,"; - result += "\n is implemented and this would get in a never ending cycle when a request is sent."; - result += "\n"; - result += "\nProcess traces are dump on \"launcher.trace\" and could have any trace level (POSIX levels), usually"; - result += "\n 'debug' or 'warning'. See ANNA documentation for more details."; - result += "\n"; - result += "\nAs any other ANNA process, context dump could be retrieved sending SIGUSR1 signal:"; - result += "\n kill -10 "; - result += "\n or"; - result += "\n kill -s SIGUSR1 "; - result += "\n and then"; - result += "\n vi /var/tmp/anna.context."; - result += "\n"; - result += "\nA complete xml report will show all the context information (counters, alarms, statistics,"; - result += "\n handlers, diameter stacks, etc.), and a powerful log module could dump all the events"; - result += "\n processed and flow information. Statistics could be analized at context dump and optionally"; - result += "\n written to disk as sample files (useful for graphs and spreadsheet reports) with all the"; - result += "\n measurements."; - result += "\n"; - result += "\nAlso SIGUSR2 is handled for management purposes. We will talk later about this."; - result += "\n"; - result += "\n"; - result += "\nCOMMAND LINE"; - result += "\n------------"; - result += "\n"; - result += "\nStart the launcher process without arguments in order to see all the startup configuration"; - result += "\n posibilities, many of which could be modified on the air through the management interface"; - result += "\n (we will talk later about this great feature). There is only one mandatory parameter which"; - result += "\n is the services definition: --services . You must follow the dtd schema"; - result += "\n to build a valid services xml file. Some basic examples are:"; - result += "\n"; - result += "\nClient configuration:"; - result += "\n"; - result += "\n"; - result += "\n "; - result += "\n "; - result += "\n"; - result += "\n "; - result += "\n "; - result += "\n"; - result += "\n"; - result += "\nServer configuration:"; - result += "\n"; - result += "\n"; - result += "\n "; - result += "\n "; - result += "\n"; - result += "\n "; - result += "\n "; - result += "\n"; - result += "\n"; - result += "\nIf you act as a proxy or a translation agent, you need to combine both former setups, and probably"; - result += "\n will need to program the answers to be replied through the operations interface. To balance the"; - result += "\n traffic at your client side you shall use '--balance' and '--sessionBasedModelsClientSocketSelection'"; - result += "\n arguments in order to define the balancing behaviour. To make hybrid setups you only must mix the realms:"; - result += "\n"; - result += "\nClient and server configuration:"; - result += "\n"; - result += "\n"; - result += "\n "; - result += "\n "; - result += "\n "; - result += "\n "; - result += "\n"; - result += "\n "; - result += "\n "; - result += "\n "; - result += "\n"; - result += "\n"; - result += "\n"; - result += "\nThe process builds automatically CER and DWR messages as a client, but you could specify your own"; - result += "\n as shown in the hybrid former example. Note that the base protocol stack must be registered because"; - result += "\n the configuration corresponds to a multistack process which change the stack using the application-id"; - result += "\n processed (0 in the case of base protocol messages: CER, CEA, DWR, DWA, DPR, DPA)."; - result += "\n"; - result += "\nDYNAMIC OPERATIONS"; - result += "\n------------------"; - result += "\n"; - result += "\nADML supports several operations which could be reconized via HTTP interface or SIGUSR2 caugh."; - result += "\nAn operation is specified by mean a string containing the operation name and needed arguments"; - result += "\n separated by pipes. These are the available commands:"; - result += "\n"; - result += "\n--------------------------------------------------------------------------------------- General purpose"; - result += "\n"; - result += "\nhelp This help."; - result += "\n"; - result += "\n---------------------------------------------------------------------------------------- Node selection"; - result += "\n"; - result += "\nnode[|] Select current working node by mean the registered name."; - result += "\n All the subsequent operations will be referred to this node."; - result += "\n Without argument, the current node information is retrieved."; - result += "\n"; - result += "\n------------------------------------------------------------------------------------ Parsing operations"; - result += "\n"; - result += "\ncode|| Encodes source file (pathfile) into target file (pathfile)."; - result += "\ndecode|| Decodes source file (pathfile) into target file (pathfile)."; - result += "\nloadxml| Reinterpret xml source file (pathfile)."; - result += "\n"; - result += "\n------------------------------------------------------------------------------------------- Hot changes"; - result += "\n"; - result += "\nservices[|source file] Adds and starts the services specified in the xml file provided."; - result += "\n (if missing, the file 'services.xml' will be used)."; - result += "\n The last loaded realm node will be automatically the new current"; - result += "\n working node. This is used to load new nodes once the ADML is"; - result += "\n started, regardless if '--services' command line parameter was"; - result += "\n used or not. Those services which are not correctly loaded, will"; - result += "\n be ignored, keeping the process alive."; - result += "\n"; - result += "\ndiameterServerSessions| Updates the maximum number of accepted connections to diameter"; - result += "\n server socket."; - result += "\ncontext[|target file] Application context could also be written by mean this operation,"; - result += "\n and not only through SIGUSR1. If optional path file is missing,"; - result += "\n default '/var/tmp/anna.context.' will be used."; - result += "\ncollect Reset statistics and counters to start a new test stage of"; - result += "\n performance measurement. Context data can be written at"; - result += "\n '/var/tmp/anna.context.' by mean 'kill -10 '"; - result += "\n or sending operation 'context|[target file]'."; - result += "\nforceCountersRecord Forces dump to file the current counters of the process."; - result += "\n"; - result += "\n[|
:][|socket id]"; - result += "\n"; - result += "\n Actions: hide, show (update state) and hidden, shown (query state)."; - result += "\n Acts over a client session for messages delivery (except CER/A, DWR/A, DPR/A)."; - result += "\n If missing server (first parameter) all applications sockets will be affected."; - result += "\n If missing socket (second parameter) for specific server, all its sockets will be affected."; - result += "\n"; - result += "\n All application client sessions are shown on startup, but standard delivery only use primary"; - result += "\n server ones except if fails. Balance configuration use all the allowed sockets. You could also"; - result += "\n use command line 'sessionBasedModelsClientSocketSelection' to force traffic flow over certain"; - result += "\n client sessions, but for this, hide/show feature seems easier."; - result += "\n"; - result += "\n--------------------------------------------------------------------------------------- Flow operations"; - result += "\n"; - result += "\nsendxml2e| Sends xml source file (pathfile) through configured entity."; - result += "\nsendxml2c| Sends xml source file (pathfile) to client."; - result += "\nsendxml| Same as 'sendxml2e'."; - result += "\nanswerxml2e[|source_file] Answer xml source file (pathfile) for incoming request with same code from entity."; - result += "\n The answer is stored in a FIFO queue for a specific message code, then there are"; - result += "\n as many queues as different message codes have been programmed."; - result += "\nanswerxml2c[|source_file] Answer xml source file (pathfile) for incoming request with same code from client."; - result += "\n The answer is stored in a FIFO queue for a specific message code, then there are"; - result += "\n as many queues as different message codes have been programmed."; - result += "\nanswerxml[|source_file] Same as 'answerxml2c'."; - result += "\nanswerxml(2e/2c) List programmed answers (to entity/client) if no parameter provided."; - result += "\nanswerxml(2e/2c)|dump Write programmed answers (to entity/client) to file 'programmed_answer..',"; - result += "\n where 'sequence' is the order of the answer in each FIFO code-queue of programmed answers."; - result += "\nanswerxml(2e/2c)|clear Clear programmed answers (to entity/client)."; - result += "\nanswerxml(2e/2c)|exhaust Disable the corresponding queue rotation, which is the default behaviour."; - result += "\nanswerxml(2e/2c)|rotate Enable the corresponding queue rotation, useful in performance tests."; - result += "\n Rotation consists in add again to the queue, each element retrieved for answering."; - result += "\n"; - result += "\nSend operations are available using hexadecimal content (hex formatted files) which also allow to test"; - result += "\nspecial scenarios (protocol errors):"; - result += "\n"; - result += "\nsendhex2e| Sends hex source file (pathfile) through configured entity."; - result += "\nsendhex2c| Sends hex source file (pathfile) to client."; - result += "\nsendhex| Same as 'sendhex2e'."; - result += "\n"; - result += "\nAnswer programming in hexadecimal is not really neccessary (you could use send primitives) and also"; - result += "\n is intended to be used with decoded messages in order to replace things like hop by hop, end to end,"; - result += "\n subscriber id, session id, etc. Anyway you could use 'decode' operation and then program the xml created."; - result += "\n"; - result += "\nIf a request is received, answer map (built with 'answerxml<[2c] or 2e>' operations) will be"; - result += "\n checked to find a corresponding programmed answer to be replied(*). If no ocurrence is found,"; - result += "\n or answer message was received, the message is forwarded to the other side (entity or client),"; - result += "\n or nothing but trace when no peer at that side is configured. Answer to client have sense when"; - result += "\n diameter server socket is configured, answer to entity have sense when entity does."; - result += "\n"; - result += "\nIn the most complete situation (process with both client and server side) there are internally"; - result += "\n two maps with N FIFO queues, one for each different message code within programmed answers."; - result += "\nOne map is for answers towards the client, and the other is to react entity requests. Then in"; - result += "\n each one we could program different answers corresponding to different request codes received."; - result += "\n"; - result += "\n(*) sequence values (hop-by-hop and end-to-end), Session-Id and Subscription-Id avps, are mirrored"; - result += "\n to the peer which sent the request. If user wants to test a specific answer without changing it,"; - result += "\n use sendxml/sendhex operations better than programming."; - result += "\n"; - result += "\nBalance ('--balance' command line parameter) could be used to forward server socket receptions through"; - result += "\n entity servers by mean a round-robin algorithm. Both diameter server socket and entity targets should"; - result += "\n have been configured, that is to say: launcher acts as client and server. If no balance is used, an"; - result += "\n standard delivery is performed: first primary entity server, secondary when fails, etc."; - result += "\n"; - result += "\n--------------------------------------------------------------------------- Processing types (log tags)"; - result += "\n"; - result += "\nUsed as log file extensions (when '--splitLog' is provided on command line) and context preffixes on log"; - result += "\n details when unique log file is dumped:"; - result += "\n"; - result += "\n [sent2e/send2eError] Send to entity (success/error)"; - result += "\n [sent2c/send2cError] Send to client (success/error)"; - result += "\n [fwd2e/fwd2eError] Forward to entity a reception from client (success/error)"; - result += "\n [fwd2c/fwd2cError] Forward to client a reception from entity (success/error)"; - result += "\n [recvfc] Reception from client"; - result += "\n [recvfe] Reception from entity"; - result += "\n [req2c-expired] A request sent to client has been expired"; - result += "\n [req2e-expired] A request sent to entity has been expired"; - result += "\n [recvfc-ans-unknown] Reception from client of an unknown answer (probably former [req2c-expired]"; - result += "\n has been logged)"; - result += "\n [recvfe-ans-unknown] Reception from entity of an unknown answer (probably former [req2e-expired]"; - result += "\n has been logged)"; - result += "\n [retry] Request retransmission"; - result += "\n"; - result += "\n------------------------------------------------------------------------------------------- Burst tests"; - result += "\n"; - result += "\nburst|[|parameter] Used for performance testing, we first program diameter requests"; - result += "\n messages in order to launch them from client side to the configured"; - result += "\n diameter entity. We could start the burst with an initial load"; - result += "\n (non-asynchronous sending), after this, a new request will be sent"; - result += "\n per answer received or expired context. There are 10 actions: clear,"; - result += "\n load, start, push, pop, stop, repeat, send, goto and look."; - result += "\n"; - result += "\n burst|clear Clears all loaded burst messages."; - result += "\n burst|load| Loads the next diameter message into launcher burst."; - result += "\n burst|start| Starts (or restarts if already in progress) the message sending with"; - result += "\n a certain initial load."; - result += "\n burst|push| Sends specific non-aynchronous load."; - result += "\n burst|pop| Skip send burst messages in order to reduce over-the-air requests."; - result += "\n Popping all OTA requests implies burst stop because no more answer"; - result += "\n will arrive to the process. Burst output file (--burstLog command"; - result += "\n line parameter) shows popped messages with crosses (x). Each cross"; - result += "\n represents one received answer for which no new request is sent."; - result += "\n burst|stop Stops the burst cycle. You can resume pushing 1 load amount."; - result += "\n burst|repeat[|[yes]|no] Restarts the burst launch when finish. If initial load or push load"; - result += "\n amount is greater than burst list size, they will be limited when"; - result += "\n the list is processed except when repeat mode is enabled."; - result += "\n burst|send| Sends messages from burst list. The main difference with start/push"; - result += "\n operations is that burst won't be awaken. Externally we could control"; - result += "\n sending time (no request will be sent for answers)."; - result += "\n burst|goto| Updates current burst pointer position."; - result += "\n burst|look[|order] Show programmed burst message for order provided, current when missing."; - result += "\n"; - result += "\n-------------------------------------------------------------------------------------- Advanced testing"; - result += "\n"; - result += "\n Burst mode only allows single interface interaction. For multiple interface"; - result += "\n (realm) coordination, you could use the advanced test cases programming:"; - result += "\n"; - result += "\n"; - result += "\n test||[|parameters]"; - result += "\n"; - result += "\n Adds a new step to the test case with provided identifier. If provided identifier"; - result += "\n is not registered yet, a new test case will be created with that value and the"; - result += "\n step will be added as the first. For a specific 'id', the steps are stored in"; - result += "\n order as they are programmed"; - result += "\n"; - result += "\n : integer number, normally monotonically increased for each test case. Some external"; - result += "\n script/procedure shall clone a test case template in order to build a collection"; - result += "\n of independent and coherent test cases (normally same type) with different context"; - result += "\n values (Session-Id, Subscriber-Id, etc.)."; - result += "\n"; - result += "\n : commands to be executed for the test id provided. Each command programmed"; - result += "\n constitutes a test case 'step', numbered from 1 to N."; - result += "\n"; - result += "\n timeout| Sets an asynchronous timer to restrict the maximum timeout"; - result += "\n until last test step. Normally, this command is invoked"; - result += "\n in the first step, anyway it measures the time from the"; - result += "\n execution point whatever it is. The expiration will abort"; - result += "\n the test if still running. One or more timeouts could be"; - result += "\n programmed (not usual), but the more restrict will apply."; - result += "\n It is highly recommended to program a initial timeout step,"; - result += "\n or the test case could be eternally in-progress."; - result += "\n"; - result += "\n sendxml2e|[|]"; - result += "\n Sends xml source file (pathfile) to entity (it would be a"; - result += "\n 'forward' event if it came through local server endpoint)."; - result += "\n The step number should be provided for answers to indicate"; - result += "\n the 'wait for request' corresponding step. If you miss this"; - result += "\n reference, the sequence information (hop-by-hop, end-to-end)"; - result += "\n will be sent as they are in the answer xml message (realize"; - result += "\n the difficulty of predicting these information). Be sure to"; - result += "\n refer to a 'wait for request' step. Conditions like 'regexp'"; - result += "\n (as we will see later) are not verified."; - result += "\n"; - result += "\n sendxml2c|[|]"; - result += "\n Sends xml source file (pathfile) to client (it would be a"; - result += "\n 'forward' event if it came through remote server endpoint)."; - result += "\n Same commented for 'sendxml2e' regarding the step number."; - result += "\n"; - result += "\n delay| Blocking step until the time lapse expires. Useful to give "; - result += "\n some cadence control and time schedule for a specific case."; - result += "\n wait| Blocking step until condition is fulfilled. The message could"; - result += "\n received from entity (waitfe) or from client (waitfc)."; - result += "\n"; - result += "\n wait-regexp|"; - result += "\n Wait condition, from entity (waitfe-regexp) or client (waitfc-regexp)"; - result += "\n to match the serialized xml content for received messages. CPU cost"; - result += "\n is bigger than the former ones because the whole message must be"; - result += "\n decoded and converted to xml instead of doing a direct hexadecimal"; - result += "\n buffer search. The main advantage is the great flexibility to identify"; - result += "\n any content with a regular expression."; - result += "\n"; - result += "\n : Optional parameters which must be fulfilled to continue through the next step."; - result += "\n Any received message over diameter interfaces will be evaluated against the"; - result += "\n corresponding test case starting from the current step until the first one"; - result += "\n whose condition is fulfilled. If no condition is fulfilled the event will be"; - result += "\n classified as 'uncovered' (normally a test case bad configuration, or perhaps"; - result += "\n a real unexpected message)."; - - // TODO(***) -// result += "\n The way to identify the test case, is through registered Session-Id values for"; -// result += "\n programmed requests. But this depends on the type of node. Acting as clients,"; -// result += "\n requests received have Session-Id values which are already registered with"; -// result += "\n one test case, causing an error if not found. Acting as servers, requests are"; -// result += "\n received over a diameter local server from a client which are generating that"; -// result += "\n Session-Id values. Then we know nothing about such values. The procedure in"; -// result += "\n this case is find out a test case not-started containing a condition which"; -// result += "\n comply with the incoming message, and reactivates it."; - // The other solution: register Session-Id values for answers send to client from a local diameter server. - - result += "\n How to answer: a wait condition for a request will store the incoming message"; - result += "\n which fulfills that condition. This message is useful together with the peer"; - result += "\n connection source in a further send step configured with the corresponding"; - result += "\n response. You could also insert a delay between wait and send steps to be"; - result += "\n more realistic (processing time simulation in a specific ADML realm node)."; - result += "\n Always, a response send step will get the needed information from the most"; - result += "\n recent wait step finding in reverse order (note that some race conditions"; - result += "\n could happen if your condition is not specific enough)."; - - result += "\n"; - result += "\n Condition format:"; - result += "\n"; - result += "\n [code]|[bitR]|[ResultCode]|[sessionId]|[hopByHop]|[msisdn]|[imsi]|[serviceContextId]"; - result += "\n"; - result += "\n code: integer number"; - result += "\n bitR: 1 (request), 0 (answer)"; - result += "\n ResultCode: integer number"; - result += "\n sessionId: string"; - result += "\n hopByHop: integer number or request send step reference: #"; - result += "\n"; - result += "\n Using the hash reference, you would indicate a specific wait condition"; - result += "\n for answers. The step number provided must correspond to any of the"; - result += "\n previous send commands (sendxml2e/sendxml2c) configured for a request."; - result += "\n This 'hop-by-hop' variant eases the wait condition for answers in the"; - result += "\n safest way."; - result += "\n"; - result += "\n msisdn: string"; - result += "\n imsi: string"; - result += "\n serviceContextId: string"; - result += "\n"; - result += "\n Take into account these rules, useful in general:"; - result += "\n"; - result += "\n - Be as much specific as possible defining conditions to avoid ambiguity sending"; - result += "\n messages out of context due to race conditions. Although you could program several"; - result += "\n times similar conditions, some risky practices will throw a warning trace (if you"; - result += "\n repeat the same condition within the same test case)."; - result += "\n - Adding a ResultCode and/or HopByHop to the condition are only valid waiting answers."; - result += "\n - Requests hop-by-hop values must be different for all the test case requests."; - result += "\n RFC says that a hop by hop must be unique for a specific connection, something that"; - result += "\n could be difficult to manage if we have multiple available connections from client"; - result += "\n side endpoint (entity or local server), even if we would have only one connection but"; - result += "\n several realm interfaces. It is enough to configure different hop-by-hop values within"; - result += "\n each test case, because on reception, the Session-Id is used to identify that test case."; - result += "\n"; - result += "\n"; - result += "\n"; - result += "\n"; - result += "\n Programming example:"; - result += "\n"; - result += "\n Basic Rx/Gx scenary: PCEF (Gx) - PCRF - AF (Rx)"; - result += "\n"; - result += "\n test|1|timeout|5000 (step 1: whole time requirement is 5 seconds)"; - result += "\n test|1|sendxml2e|CCR-I.xml (step 2: imagine this xml uses the Session-Id 'SGx')"; - result += "\n test|1|waitfe|272|0|2001|SGx (step 3: waits the CCA for the CCR-I with Result-Code = DIAMETER_SUCCESS)"; - result += "\n test|1|sendxml2e|AAR-flows.xml (step 4: imagine this xml uses the Session-Id 'SRx')"; - result += "\n test|1|waitfe|265|0|2001|SRx (step 5: waits the AAA for the AAR-flows with Result-Code = DIAMETER_SUCCESS)"; - result += "\n test|1|waitfe|258|1||SGx (step 6: waits the RAR (install policies) from the PCRF server)"; - result += "\n test|1|sendxml2e|RAA-install.xml|6 (step 7: sends the response for the RAR)"; - result += "\n test|1|sendxml2e|CCR-T.xml (step 8: termination of the Gx session, imagine this xml puts hop-by-hop 'H1')"; - result += "\n test|1|waitfe|272|0|2001|SGx|H1 (step 9: waits the CCA for the CCR-T with Result-Code = DIAMETER_SUCCESS and hop-by-hop 'H1')"; - result += "\n test|1|waitfe|258|1||SGx (step 10: waits the RAR (remove policies) from the PCRF server)"; - result += "\n test|1|sendxml2e|RAA-remove.xml|10 (step 11: sends the response for the RAR)"; - result += "\n"; - result += "\n Notes: We added an additional condition in step 9: the hop-by-hop. When we program the corresponding"; - result += "\n source request (CCR-T), we configured the value 'H1' for the hop-by-hop. This is an 'application"; - result += "\n value' because the real hop-by-hop transported through the client connection is managed by the"; - result += "\n diameter stack. But when returned, the transaction pool resolve the original value. This feature"; - result += "\n is necessary to ease the implementation of certain diameter agents (proxies for example). In our"; - result += "\n case, we could format the hop-by-hop values within the request templates with total freedom to"; - result += "\n improve the programmed conditions."; - result += "\n"; - result += "\n In the case of 'waiting for requests' is not such easy. Indeed, steps 6 and 10 will write a warning"; - result += "\n because they are the same condition. We know that we are not going to have any problem because"; - result += "\n such events are blocking-protected regarding logic-dependent messages (CCR-T), and race condition"; - result += "\n is absolutely strange in this case."; - result += "\n"; - result += "\n You could speed up the test case moving forward steps like 3 & 5, understood as non-strict requirements"; - result += "\n to continue testing. Anyway, remember that test cases should be as real as possible, and that there"; - result += "\n are many ways to increase the load rate as we will see in next section (test cases execution)."; - result += "\n"; - result += "\n Other simplifications: the steps 3, 5 and 9 can be replaced by"; - result += "\n"; - result += "\n test|1|waitfe||0|||#2"; - result += "\n test|1|waitfe||0|||#4"; - result += "\n test|1|waitfe||0|||#8"; - result += "\n"; - result += "\n which means that hop-by-hop must be retrieved from steps 2, 4 and 8 respectively,"; - result += "\n and the expected message shall be an answer. Normally you will add other conditions,"; - result += "\n for example a DIAMETER_SUCCESS result (adding 2001 as Result-Code)."; - result += "\n"; - result += "\nTest cases execution:"; - result += "\n"; - result += "\n"; - result += "\n test|ttps| Starts/resume the provided number of test ticks per second (ttps). The ADML starts"; - result += "\n with the event trigger system suspended, and this operation is neccessary to begin"; - result += "\n those cases which need this time event (internal triggering). Some other test cases"; - result += "\n could be started through external events (first test case event could be programmed"; - result += "\n to wait specific message), but is not usual this external mode and neither usual to"; - result += "\n mix triggering types. Normally, you will pause/stop new test launchs providing 0 as"; - result += "\n ttps value, and also you could dynamically modify the load rate updating that value."; - result += "\n If a test case has N messages then 'ttps * N' will be the virtual number of messages"; - result += "\n managed per second when no bottleneck exists."; - result += "\n"; - result += "\n Provide 0 in order to stop the timer triggering."; - result += "\n"; - result += "\n There timer manager resolution currently harcoded allows a maximum of "; - result += anna::functions::asString(1000/a_admlMinResolution); result += " events"; - result += "\n per second. To reach greater rates ADML will join synchronously the needed number of"; - result += "\n new time-triggered test cases per a single event, writting a warning-level trace to"; - result += "\n advice about the risk of burst sendings and recommend launching multiple instances"; - result += "\n to achieve such load with a lower rate per instance."; - result += "\n"; - result += "\n test|ip-limit[|amount] In-progress limit of test cases. No new test cases will be launched over this value"; - result += "\n (test Manager tick work will be ignored). Zero-value is equivalent to stop the clock."; - result += "\n tick, -1 is used to specify 'no limit' which is the default. If missing amount, the"; - result += "\n limit and current amount of in-progress test cases will be shown."; - result += "\n"; - result += "\n test|goto| Updates current test pointer position."; - result += "\n"; - result += "\n test|look[|id] Show programmed test case for id provided, current when missing. Test cases programmed"; - result += "\n are not dumped on process context (too many information in general). When the test case"; - result += "\n has been completed or initiated, it will contain context information acting as a report."; - result += "\n"; - result += "\n test|report[|[yes]|no] Every time a test case is finished, its xml representation will be dump on a file under"; - result += "\n the execution directory (or the one configured in process command-line 'tmDir') with"; - result += "\n the name 'testcase..xml'. If repeat mode is active, new test case executions will"; - result += "\n append its reports into the same file. This option is disabled by default to improve"; - result += "\n performance (reducing IO). ADML process context will show test manager whole information"; - result += "\n and test case reports will be written depending on this report option. Anyway, you could"; - result += "\n use the 'look' operation to see the report."; - result += "\n"; - result += "\n test|reset|[|id] Reset the test case for id provided, all the tests when missing. It could be hard/soft:"; - result += "\n - hard: you probably may need to stop the load rate before. This operation initializes"; - result += "\n all test cases regardless their states."; - result += "\n - soft: only for finished cases (those with 'Success' or 'Failed' states). It does not"; - result += "\n affect to test cases with 'InProgress' state."; - result += "\n"; - result += "\n test|repeat[|[yes]|no] Restarts the whole programmed test list when finished, disabled by default (testing"; - result += "\n time trigger system will enter suspended state until new ttps operation is received)."; - result += "\n Test cases state & data will be reset (when achieved again), but general statistics"; - result += "\n and counters will continue measuring until reset with 'collect' operation."; - result += "\n When the test cases pool has been processed (and this repeat option is disabled), you"; - result += "\n could reactivate the testing by mean 'test|reset|soft' and then 'test|ttps|'."; - result += "\n"; - result += "\n test|clear Clears all the programmed test cases and stop testing (if in progress)."; - result += "\n"; - result += "\n"; - result += "\nUSING OPERATIONS INTERFACE"; - result += "\n--------------------------"; - result += "\n"; - result += "\n------------------------------------------------------------------------- Operations via HTTP interface"; - result += "\n"; - result += "\nAll the operations described above can be used through the optional HTTP interface. You only have"; - result += "\n to define the http server at the command line with something like: '--httpServer localhost:9000'."; - result += "\nTo send the task, we shall build the http request body with the operation string. Some examples"; - result += "\n using curl client could be:"; - result += "\n"; - result += "\n curl -m 1 --data \"diameterServerSessions|4\" localhost:9000"; - result += "\n curl -m 1 --data \"code|ccr.xml\" localhost:9000"; - result += "\n curl -m 1 --data \"decode|ccr.hex\" localhost:9000"; - result += "\n curl -m 1 --data \"sendxml2e|ccr.xml\" localhost:9000"; - result += "\n etc."; - result += "\n"; - result += "\n------------------------------------------------------------------------- Operations via SIGUSR2 signal"; - result += "\n"; - result += "\nThe alternative using SIGUSR2 signal requires the creation of the task(s) file which will be read at"; - result += "\n signal event:"; - result += "\n echo \"<\" > "; result += SIGUSR2_TASKS_INPUT_FILENAME; - result += "\n then"; - result += "\n kill -12 "; - result += "\n or"; - result += "\n kill -s SIGUSR2 "; - result += "\n and then see the results:"; - result += "\n cat "; result += SIGUSR2_TASKS_OUTPUT_FILENAME; - result += "\n"; - result += "\nYou could place more than one line (task) in the input file. Output reports will be appended in that"; - result += "\n case over the output file. Take into account that all the content of the task file will be executed"; - result += "\n sinchronously by the process. If you are planning traffic load, better use the asynchronous http"; - result += "\n interface."; - result += "\n"; - result += "\n"; - 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 - CommandLine& cl(anna::CommandLine::instantiate()); - TestManager &testManager = TestManager::instantiate(); - LOGDEBUG(anna::Logger::debug(operation, ANNA_FILE_LOCATION)); +bool Launcher::eventOperation(const std::string &operation, std::string &response_content) throw(anna::RuntimeException) { - // Default response: - response_content = "Operation processed with exception (see traces): "; - response_content += operation; + bool result = true; + LOGMETHOD(anna::TraceMethod tm("Launcher", "eventOperation", ANNA_FILE_LOCATION)); + if (operation == "") return result; // ignore + LOGDEBUG(anna::Logger::debug(anna::functions::asString("Operation: %s", operation.c_str()), ANNA_FILE_LOCATION)); + // Default response: + response_content = "Operation processed with exception: "; + response_content += operation; std::string opt_response_content = ""; // aditional response content anna::DataBlock db_aux(true); + anna::diameter::codec::Message codecMsg; // auxiliary codec message + + // Singletons: + anna::testing::TestManager &testManager = anna::testing::TestManager::instantiate(); + /////////////////////////////////////////////////////////////////// // Simple operations without arguments: - // Help: - if(operation == "help") { - response_content = help(); - return; + // 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. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + try { + p.execute(args, response_content); + } + catch(anna::RuntimeException &ex) { + ex.trace(); + response_content = ex.asString(); + return false; + } + return true; // OK } // Reset performance data: @@ -1311,14 +986,26 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons resetCounters(); resetStatistics(); response_content = "All process counters & statistic information have been reset"; - return; + return true; // OK } // Counters dump on demand: if(operation == "forceCountersRecord") { forceCountersRecord(); response_content = "Current counters have been dump to disk"; - return; + return true; // OK + } + + // OAM & statistics: + if(operation == "show-oam") { + anna::xml::Node root("root"); + response_content = anna::xml::Compiler().apply(oamAsXML(&root)); + return true; // OK + } + if(operation == "show-stats") { + anna::xml::Node root("root"); + response_content = anna::xml::Compiler().apply(statsAsXML(&root)); + return true; // OK } /////////////////////////////////////////////////////////////////// @@ -1330,7 +1017,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons // Get the operation type and parameters: Tokenizer::const_iterator tok_iter = params.begin(); std::string opType = Tokenizer::data(tok_iter); - std::string param1, param2, param3, param4, param5, param6, param7, param8, param9, param10; + std::string param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11; if(numParams >= 1) { tok_iter++; param1 = Tokenizer::data(tok_iter); } if(numParams >= 2) { tok_iter++; param2 = Tokenizer::data(tok_iter); } if(numParams >= 3) { tok_iter++; param3 = Tokenizer::data(tok_iter); } @@ -1342,6 +1029,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons if(numParams >= 8) { tok_iter++; param8 = Tokenizer::data(tok_iter); } if(numParams >= 9) { tok_iter++; param9 = Tokenizer::data(tok_iter); } if(numParams >= 10) { tok_iter++; param10 = Tokenizer::data(tok_iter); } + if(numParams >= 11) { tok_iter++; param11 = Tokenizer::data(tok_iter); } // Remove '' artificial token to ease further checkings: if (param1 == "") param1 = ""; if (param2 == "") param2 = ""; @@ -1353,20 +1041,25 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons if (param8 == "") param8 = ""; if (param9 == "") param9 = ""; if (param10 == "") param10 = ""; + if (param11 == "") param11 = ""; // No operation has more than 2 arguments except 'test' ... if(opType != "test" && numParams > 2) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); // Check the number of parameters: 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; + if(((opType == "code") || (opType == "decode")) && (numParams != 2)) wrongBody = true; - if(((opType == "sendxml") || (opType == "sendxml2e") || (opType == "sendhex") || (opType == "sendhex2e")) && (numParams != 1)) wrongBody = true; + if(((opType == "sendxml2e") || (opType == "sendhex2e")) && (numParams != 1)) wrongBody = true; if((opType == "burst") && (numParams < 1)) wrongBody = true; @@ -1378,7 +1071,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons // Launch exception std::string msg = "Wrong body content format on HTTP Request for '"; msg += opType; - msg += "' operation (missing parameter/s). Use 'help' management command to see more information."; + msg += "' operation (missing parameter/s). Check 'HELP.md' for more information."; throw anna::RuntimeException(msg, ANNA_FILE_LOCATION); } @@ -1387,7 +1080,27 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons std::string contextFile = ((numParams == 1) ? param1 : anna::functions::asString("/var/tmp/anna.context.%05d", getPid())); writeContext(contextFile); response_content = anna::functions::asString("Context dumped on file '%s'", contextFile.c_str()); - return; + return true; // OK + } + + if(opType == "log-statistics-samples") { + logStatisticsSamples(param1); + response_content = anna::functions::asString("Log statistics samples for '%s' concepts", param1.c_str()); + return true; // OK + } + + // Change execution directory: + if(opType == "change-dir") { + if (param1 == "") param1 = a_initialWorkingDirectory; + result = (chdir(param1.c_str()) == 0); + + if (result) + response_content = "New execution directory configured: "; + else + response_content = "Cannot assign provided execution directory: "; + + response_content += param1; + return result; } if(opType == "services") { @@ -1397,33 +1110,45 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons } catch(anna::RuntimeException &ex) { ex.trace(); - response_content = anna::functions::asString("Loaded services from file '%s' with some problems (ignored ones)", servicesFile.c_str()); - return; + response_content = anna::functions::asString("Loaded services from file '%s' with errors", servicesFile.c_str()); + return false; } response_content = anna::functions::asString("Loaded services from file '%s'", servicesFile.c_str()); - return; + return true; // OK } - // Realm switch: + // Host switch: if(opType == "node") { if (param1 != "") { - if (setWorkingNode(param1)) response_content = anna::functions::asString("Current node is now '%s'", param1.c_str()); + if (setWorkingNode(param1)) response_content = anna::functions::asString("Forced node is now '%s'", param1.c_str()); } else { - response_content = getWorkingNode()->asXMLString(); + if (a_workingNode) { + response_content = "Working node is forced to be: \n\n"; + response_content += a_workingNode->asXMLString(); + } + else { + response_content = "Working node is automatic"; + } } - return; + return true; // OK + } + if(opType == "node_auto") { + a_workingNode = NULL; + response_content = "Working node has been set to automatic"; + return true; // OK } - // Diameter endpoints: - MyDiameterEntity *entity = getWorkingNode()->getEntity(); - MyDiameterEngine *commEngine = getWorkingNode()->getMyDiameterEngine(); - MyLocalServer *localServer = getWorkingNode()->getDiameterServer(); - anna::diameter::codec::Message codecMsg(getCodecEngine()); + // Operated host from possible forced-working node: + a_operatedHost = a_workingNode ? a_workingNode /* priority */: NULL /* auto */; + // Use later: + // If any message is managed: updateOperatedOriginHostWithMessage(codecMessage) + // To operate, use the exception-protected methods which never will return NULL: + // getOperatedHost(), getOperatedEntity(), getOperatedServer(), getOperatedEngine() if(opType == "code") { - codecMsg.loadXML(param1); + codecMsg.loadXMLFile(param1); std::string hexString = anna::functions::asHexString(codecMsg.code()); // write to outfile std::ofstream outfile(param2.c_str(), std::ifstream::out); @@ -1443,7 +1168,6 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons outfile.write(xmlString.c_str(), xmlString.size()); outfile.close(); } else if((opType == "hide") || (opType == "show") || (opType == "hidden") || (opType == "shown")) { - if(!entity) throw anna::RuntimeException("No entity configured to send messages", ANNA_FILE_LOCATION); if(param1 != "") { if(param2 != "") { @@ -1451,65 +1175,68 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons key += "|"; key += param2; - if(opType == "hide") commEngine->findClientSession(key)->hide(); + if(opType == "hide") getOperatedEngine()->findClientSession(key)->hide(); - if(opType == "show") commEngine->findClientSession(key)->show(); + if(opType == "show") getOperatedEngine()->findClientSession(key)->show(); - if(opType == "hidden") opt_response_content = commEngine->findClientSession(key)->hidden() ? "true" : "false"; + if(opType == "hidden") opt_response_content = getOperatedEngine()->findClientSession(key)->hidden() ? "true" : "false"; - if(opType == "shown") opt_response_content = commEngine->findClientSession(key)->shown() ? "true" : "false"; + if(opType == "shown") opt_response_content = getOperatedEngine()->findClientSession(key)->shown() ? "true" : "false"; } else { std::string address; int port; anna::functions::getAddressAndPortFromSocketLiteral(param1, address, port); - if(opType == "hide") commEngine->findServer(address, port)->hide(); + if(opType == "hide") getOperatedEngine()->findServer(address, port)->hide(); - if(opType == "show") commEngine->findServer(address, port)->show(); + if(opType == "show") getOperatedEngine()->findServer(address, port)->show(); - if(opType == "hidden") opt_response_content = commEngine->findServer(address, port)->hidden() ? "true" : "false"; + if(opType == "hidden") opt_response_content = getOperatedEngine()->findServer(address, port)->hidden() ? "true" : "false"; - if(opType == "shown") opt_response_content = commEngine->findServer(address, port)->shown() ? "true" : "false"; + if(opType == "shown") opt_response_content = getOperatedEngine()->findServer(address, port)->shown() ? "true" : "false"; } } else { - if(opType == "hide") entity->hide(); + if(opType == "hide") getOperatedEntity()->hide(); - if(opType == "show") entity->show(); + if(opType == "show") getOperatedEntity()->show(); - if(opType == "hidden") opt_response_content = entity->hidden() ? "true" : "false"; + if(opType == "hidden") opt_response_content = getOperatedEntity()->hidden() ? "true" : "false"; - if(opType == "shown") opt_response_content = entity->shown() ? "true" : "false"; + if(opType == "shown") opt_response_content = getOperatedEntity()->shown() ? "true" : "false"; } - } else if((opType == "sendxml") || (opType == "sendxml2e") || (opType == "sendhex") || (opType == "sendhex2e")) { - if(!entity) throw anna::RuntimeException("No entity configured to send the message", ANNA_FILE_LOCATION); - anna::diameter::comm::Message *msg = getWorkingNode()->createCommMessage(); + } else if((opType == "sendxml2e") || (opType == "sendhex2e")) { + anna::diameter::comm::Message *msg; - if((opType == "sendxml") || (opType == "sendxml2e")) { - codecMsg.loadXML(param1); + if(opType == "sendxml2e") { + codecMsg.loadXMLFile(param1); + updateOperatedOriginHostWithMessage(codecMsg); + msg = getOperatedHost()->createCommMessage(); msg->clearBody(); try { codecMsg.valid(); } catch(anna::RuntimeException &ex) { ex.trace(); } // at least we need to see validation errors although it will continue sending (see validation mode configured in launcher) - msg->setBody(codecMsg.code()); } else { // Get DataBlock from file with hex content: if(!getDataBlockFromHexFile(param1, db_aux)) throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION); - + msg = getOperatedHost()->createCommMessage(); msg->setBody(db_aux); + try { if(getOperatedHost()->logEnabled()) codecMsg.decode(db_aux); } catch(anna::RuntimeException &ex) { ex.trace(); } } - bool success = entity->send(msg, cl.exists("balance")); - getWorkingNode()->releaseCommMessage(msg); + bool success = getOperatedEntity()->send(msg); + getOperatedHost()->releaseCommMessage(msg); // Detailed log: - if(getWorkingNode()->logEnabled()) { - anna::diameter::comm::Server *usedServer = entity->getLastUsedResource(); + if(getOperatedHost()->logEnabled()) { + anna::diameter::comm::Server *usedServer = getOperatedEntity()->getLastUsedResource(); anna::diameter::comm::ClientSession *usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL; - std::string detail = usedClientSession ? usedClientSession->asString() : ""; // esto no deberia ocurrir - getWorkingNode()->writeLogFile(codecMsg, (success ? "sent2e" : "send2eError"), detail); + std::string detail = usedClientSession ? usedClientSession->asString() : ""; // shouldn't happen + getOperatedHost()->writeLogFile(codecMsg, (success ? "sent2e" : "send2eError"), detail); } } else if((opType == "burst")) { - if(!entity) throw anna::RuntimeException("No entity configured to use burst feature", ANNA_FILE_LOCATION); + + if (!uniqueOriginHost()) + throw anna::RuntimeException("Burst category operations are only allowed in single host node configuration. This is only to simplify user experience.", ANNA_FILE_LOCATION); // burst|clear clears all loaded burst messages. // burst|load| loads the next diameter message into launcher burst. @@ -1526,17 +1253,16 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons if(param1 == "clear") { opt_response_content = "removed "; - opt_response_content += anna::functions::asString(getWorkingNode()->clearBurst()); + opt_response_content += anna::functions::asString(getOperatedHost()->clearBurst()); opt_response_content += " elements"; } else if(param1 == "load") { if(param2 == "") throw anna::RuntimeException("Missing xml path file for burst load operation", ANNA_FILE_LOCATION); - codecMsg.loadXML(param2); - + codecMsg.loadXMLFile(param2); if(codecMsg.isAnswer()) throw anna::RuntimeException("Cannot load diameter answers for burst feature", ANNA_FILE_LOCATION); try { codecMsg.valid(); } catch(anna::RuntimeException &ex) { ex.trace(); } // at least we need to see validation errors although it will continue loading (see validation mode configured in launcher) - int position = getWorkingNode()->loadBurstMessage(codecMsg.code()); + int position = getOperatedHost()->loadBurstMessage(codecMsg.code()); opt_response_content = "loaded '"; opt_response_content += param2; opt_response_content += "' file into burst list position "; @@ -1545,7 +1271,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons if(param2 == "") throw anna::RuntimeException("Missing initial load for burst start operation", ANNA_FILE_LOCATION); int initialLoad = atoi(param2.c_str()); - int processed = getWorkingNode()->startBurst(initialLoad); + int processed = getOperatedHost()->startBurst(initialLoad); if(processed > 0) { opt_response_content = "initial load completed for "; @@ -1554,7 +1280,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons } else if(param1 == "push") { if(param2 == "") throw anna::RuntimeException("Missing load amount for burst push operation", ANNA_FILE_LOCATION); - int pushed = getWorkingNode()->pushBurst(atoi(param2.c_str())); + int pushed = getOperatedHost()->pushBurst(atoi(param2.c_str())); if(pushed > 0) { opt_response_content = "pushed "; @@ -1564,14 +1290,14 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons if(param2 == "") throw anna::RuntimeException("Missing amount for burst pop operation", ANNA_FILE_LOCATION); int releaseLoad = atoi(param2.c_str()); - int popped = getWorkingNode()->popBurst(releaseLoad); + int popped = getOperatedHost()->popBurst(releaseLoad); if(popped > 0) { opt_response_content = "burst popped for "; opt_response_content += anna::functions::entriesAsString(popped, "message"); } } else if(param1 == "stop") { - int left = getWorkingNode()->stopBurst(); + int left = getOperatedHost()->stopBurst(); if(left != -1) { opt_response_content += anna::functions::entriesAsString(left, "message"); @@ -1581,12 +1307,12 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons if(param2 == "") param2 = "yes"; bool repeat = (param2 == "yes"); - getWorkingNode()->repeatBurst(repeat); + getOperatedHost()->repeatBurst(repeat); opt_response_content += (repeat ? "repeat enabled" : "repeat disabled"); } else if(param1 == "send") { if(param2 == "") throw anna::RuntimeException("Missing amount for burst send operation", ANNA_FILE_LOCATION); - int sent = getWorkingNode()->sendBurst(atoi(param2.c_str())); + int sent = getOperatedHost()->sendBurst(atoi(param2.c_str())); if(sent > 0) { opt_response_content = "sent "; @@ -1595,29 +1321,37 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons } else if(param1 == "goto") { if(param2 == "") throw anna::RuntimeException("Missing order position for burst goto operation", ANNA_FILE_LOCATION); - opt_response_content = getWorkingNode()->gotoBurst(atoi(param2.c_str())); + opt_response_content = getOperatedHost()->gotoBurst(atoi(param2.c_str())); } else if(param1 == "look") { int order = ((param2 != "") ? atoi(param2.c_str()) : -1); opt_response_content = "\n\n"; - opt_response_content += getWorkingNode()->lookBurst(order); + opt_response_content += getOperatedHost()->lookBurst(order); } else { - throw anna::RuntimeException("Wrong body content format on HTTP Request for 'burst' operation (unexpected action parameter). See help", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request for 'burst' operation (unexpected action parameter). Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); } } else if((opType == "test")) { - // test||[|parameters] Add a new step to the test case ... - // test|ttps| Starts/resume the provided number of time ticks per second (ttps). The ADML starts ... - // test|ip-limit[|amount] In-progress limit of test cases. No new test cases will be launched over this value ... - // test|repeat[|[yes]|no] Restarts the programmed test cases when finished. Disabled by default: the testing ... - // test|report[|[yes]|no] Every time a test case is finished a report file in xml format will be created under ... - // test|goto| Updates current test pointer position. - // test|look[|id] Show programmed test case for id provided, current when missing ... - // test|reset|[|id] Reset the test case for id provided, all the tests when missing ... - // test|clear Clears all the programmed test cases. + // test||[|parameters] Add a new step to the test case ... + // test|ttps| Starts/resume the provided number of time ticks per second (ttps). The ADML starts ... + // test|next[|] Forces the execution of the next test case(s) without waiting for test manager tick ... + // test|ip-limit[|amount] In-progress limit of test cases. No new test cases will be launched over this value ... + // test|repeats| Restarts the whole programmed test list when finished the amount number of times ... + // test|report|[|[yes]|no] + // Enables/disables report generation for a certain test case state: initialized, in-progress ... + // test|report-hex[|[yes]|no] Reports could include the diameter messages in hexadecimal format. Disabled by default. + // test|goto| Updates current test pointer position. + // test|look[|id] Show programmed test case for id provided, current when missing ... + // test|state[|id] Show test case state for id provided, current when missing ... + // test|interact|amount|id Makes interactive a specific test case id. The amount is the margin of execution steps ... + // test|reset|<[soft]/hard>[|id] Reset the test case for id provided, all the tests when missing ... + // test|auto-reset| When cycling, current test cases can be soft (default) or hard reset ... + // test|clear Clears all the programmed test cases. + // test|summary Test manager general report (number of test cases, counts by state ... + if(param1 == "ttps") { if (numParams > 2) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); bool success = ((param2 != "") ? testManager.configureTTPS(atoi(param2.c_str())) : false); if (success) { @@ -1629,9 +1363,25 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons opt_response_content += "unable to configure the test rate provided"; } } + else if (param1 == "next") { + if (numParams > 2) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + + int sync_amount = ((param2 != "") ? atoi(param2.c_str()) : 1); + + if (sync_amount < 1) + throw anna::RuntimeException("The parameter 'sync-amount' must be a positive integer value", ANNA_FILE_LOCATION); + + bool success = testManager.execTestCases(sync_amount); + + opt_response_content = (success ? "" : "not completely " /* completed cycle and no repeats, rare case */); + opt_response_content += "processed "; + opt_response_content += anna::functions::asString(sync_amount); + opt_response_content += ((sync_amount > 1) ? " test cases synchronously" : " test case"); + } else if(param1 == "ip-limit") { if (numParams > 2) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); unsigned int limit; if (param2 != "") { @@ -1649,25 +1399,67 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons opt_response_content += " test cases running"; } } - else if(param1 == "repeat") { + else if(param1 == "repeats") { + if (numParams != 2) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + int repeats = atoi(param2.c_str()); + if (repeats < 0) repeats = -1; + testManager.setPoolRepeats(repeats); + std::string nolimit = (repeats != -1) ? "":" [no limit]"; + opt_response_content += anna::functions::asString("Pool repeats: %d%s (current cycle: %d)", repeats, nolimit.c_str(), testManager.getPoolCycle()); + } + else if(param1 == "report") { + if (numParams > 3) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + + if(param2 == "") param2 = "all"; + if(param3 == "") param3 = "yes"; + bool enable = (param3 == "yes"); + + if(param2 == "initialized") + testManager.setDumpInitializedReports(enable); + else if(param2 == "in-progress") + testManager.setDumpInProgressReports(enable); + else if(param2 == "failed") + testManager.setDumpFailedReports(enable); + else if(param2 == "success") + testManager.setDumpSuccessReports(enable); + else if(param2 == "all") { + param2 = "any"; + testManager.setDumpAllReports(enable); + } + else if(param2 == "none") { + enable = !enable; + param2 = "any"; + testManager.setDumpAllReports(enable); + } + else + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + + opt_response_content += (enable ? "report enabled " : "report disabled "); + opt_response_content += "for tests in '"; + opt_response_content += param2; + opt_response_content += "' state"; + } + else if(param1 == "report-hex") { if (numParams > 2) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); if(param2 == "") param2 = "yes"; - testManager.setPoolRepeat((param2 == "yes")); - opt_response_content += (testManager.getPoolRepeat() ? "repeat enabled" : "repeat disabled"); + testManager.setDumpHex((param2 == "yes")); + opt_response_content += (testManager.getDumpHex() ? "report includes hexadecimal messages" : "report excludes hexadecimal messages"); } - else if(param1 == "report") { + else if(param1 == "dump-stdout") { if (numParams > 2) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); if(param2 == "") param2 = "yes"; - testManager.setDumpReports((param2 == "yes")); - opt_response_content += (testManager.getDumpReports() ? "report enabled" : "report disabled"); + testManager.setDumpStdout((param2 == "yes")); + opt_response_content += (testManager.getDumpHex() ? "test manager dumps progress into stdout" : "test manager does not dump progress into stdout"); } else if(param1 == "goto") { if (numParams > 2) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); if(param2 == "") throw anna::RuntimeException("Missing id for test goto operation", ANNA_FILE_LOCATION); int id = atoi(param2.c_str()); @@ -1680,18 +1472,34 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons opt_response_content += anna::functions::asString(id); opt_response_content += ")"; } + else if(param1 == "run") { + if (numParams > 2) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + + if(param2 == "") throw anna::RuntimeException("Missing id for test run operation", ANNA_FILE_LOCATION); + int id = atoi(param2.c_str()); + if (testManager.runTestCase(id)) { + opt_response_content = "test executed for id provided ("; + } + else { + opt_response_content = "cannot found test id ("; + } + opt_response_content += anna::functions::asString(id); + opt_response_content += ")"; + } else if(param1 == "look") { if (numParams > 2) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for 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(); - return; + return true; // OK } else { + result = false; if (id == -1) { opt_response_content = "no current test case detected (testing started ?)"; } @@ -1702,18 +1510,74 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons } } } + else if(param1 == "state") { + if (numParams > 2) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + + int id = ((param2 != "") ? atoi(param2.c_str()) : -1); + anna::testing::TestCase *testCase = testManager.findTestCase(id); + + if (testCase) { + response_content = anna::testing::TestCase::asText(testCase->getState()); + return testCase->isSuccess(); + } + else { + result = false; + if (id == -1) { + opt_response_content = "no current test case detected (testing started ?)"; + } + else { + opt_response_content = "cannot found test id ("; + opt_response_content += anna::functions::asString(id); + opt_response_content += ")"; + } + } + } + else if (param1 == "interact") { + if (numParams != 2) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + + int amount = atoi(param2.c_str()); + if (amount < -1) + throw anna::RuntimeException("Interactive amount must be -1 (to disable interactive mode) or a positive number.", ANNA_FILE_LOCATION); + + int id = ((param3 != "") ? atoi(param3.c_str()) : -1); + anna::testing::TestCase *testCase = testManager.findTestCase(id); + if (testCase) { + if (amount == -1) { + testCase->makeInteractive(false); + opt_response_content = "interactive mode disabled"; + } + else { + testCase->addInteractiveAmount(amount); + opt_response_content = "added interactive amount of "; + opt_response_content += anna::functions::asString(amount); + opt_response_content += " units"; + if (amount == 0) opt_response_content += " (0: freezing a non-interactive testcase, no effect on already interactive)"; + } + opt_response_content += " for test case id "; + opt_response_content += anna::functions::asString(id); + } + else { + result = false; + opt_response_content = "cannot found test id ("; + opt_response_content += anna::functions::asString(id); + opt_response_content += ")"; + } + } else if(param1 == "reset") { if (numParams > 3) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); - if (param2 != "soft" && param2 != "hard") - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + if(param2 == "") param2 = "soft"; + if (param2 != "soft" && param2 != "hard") + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for 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); + bool done = testCase->reset(param2 == "hard"); opt_response_content = "test "; opt_response_content += param2; opt_response_content += " reset for id "; @@ -1722,19 +1586,42 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons } else { if (id == -1) { - bool anyReset = testManager.resetPool((param2 == "hard") ? true:false); - opt_response_content = "reset have been sent to all programmed tests: "; opt_response_content += anyReset ? "some/all was actually reset" : "nothing was reset"; + bool anyReset = testManager.resetPool(param2 == "hard"); + opt_response_content = param2; opt_response_content += " reset have been sent to all programmed tests: "; opt_response_content += anyReset ? "some/all have been reset" : "nothing was reset"; } else { + result = false; opt_response_content = "cannot found test id ("; opt_response_content += anna::functions::asString(id); opt_response_content += ")"; } } } + else if(param1 == "auto-reset") { + if (numParams != 2) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + + if (param2 != "soft" && param2 != "hard") + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + + testManager.setAutoResetHard(param2 == "hard"); + opt_response_content += anna::functions::asString("Auto-reset configured to '%s'", param2.c_str()); + } + else if(param1 == "initialized") { + if (numParams > 1) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + + opt_response_content = anna::functions::asString("%lu", testManager.getInitializedCount()); + } + else if(param1 == "finished") { + if (numParams > 1) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + + opt_response_content = anna::functions::asString("%lu", testManager.getFinishedCount()); + } else if(param1 == "clear") { if (numParams > 1) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); if (testManager.clearPool()) { opt_response_content = "all the programmed test cases have been dropped"; @@ -1743,93 +1630,207 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons opt_response_content = "there are not programmed test cases to be removed"; } } + else if(param1 == "junit") { + response_content = testManager.junitAsXMLString(); + return true; // OK + } + else if(param1 == "summary-counts") { + response_content = testManager.summaryCounts(); + return true; // OK + } + else if(param1 == "summary-states") { + response_content = testManager.summaryStates(); + return true; // OK + } + else if(param1 == "summary") { + response_content = testManager.asXMLString(); + return true; // OK + } else { int id = atoi(param1.c_str()); if(id < 0) throw anna::RuntimeException("Invalid test case identifier: must be a non-negative number", ANNA_FILE_LOCATION); - // PARAM: 1 2 3 4 5 6 7 8 9 10 + // PARAM: 1 2 3 4 5 6 7 8 9 10 11 // test|| + // description| + // ip-limit[|] // timeout| // sendxml2e| [|] // sendxml2c| [|] // delay| [msecs] - // wait|[code]|[bitR]|[ResultCode]|[sessionId]|[hopByHop]|[msisdn]|[imsi]|[serviceContextId] + // wait|[code]|[bitR]|[hopByHop]|[applicationId]|[sessionId]|[resultCode]|[msisdn]|[imsi]|[serviceContextId] // wait-answer| - // wait-regexp| + // wait-xml |[|strict] + // wait-hex |[|strict] if(param2 == "") throw anna::RuntimeException("Missing command for test id operation", ANNA_FILE_LOCATION); // Commands: - if (param2 == "timeout") { + if (param2 == "description") { + if (numParams > 3) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + if(param3 == "") throw anna::RuntimeException("Missing description for test case", ANNA_FILE_LOCATION); + testManager.getTestCase(id)->setDescription(param3); // creates / reuses + } + else if (param2 == "ip-limit") { if (numParams > 3) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + unsigned int limit = (param3 == "") ? 1 : atoi(param3.c_str()); + testManager.getTestCase(id)->addIpLimit(limit); // creates / reuses + } + else if (param2 == "timeout") { + if (numParams > 3) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); if(param3 == "") throw anna::RuntimeException("Missing milliseconds for 'timeout' command in test id operation", ANNA_FILE_LOCATION); anna::Millisecond timeout = checkTimeMeasure("Test case timeout", param3); testManager.getTestCase(id)->addTimeout(timeout); // creates / reuses } else if ((param2 == "sendxml2e")||(param2 == "sendxml2c")) { if (numParams > 4) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); if(param3 == "") throw anna::RuntimeException(anna::functions::asString("Missing xml file for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION); - codecMsg.loadXML(param3); - if (codecMsg.isRequest()) { - if (param4 != "") - throw anna::RuntimeException("Step number is provided with answers (to resolve the corresponding 'wait for request' step), but NOT with requests", ANNA_FILE_LOCATION); - } - else { - if (param4 == "") LOGWARNING(anna::Logger::warning("Step number has not been provided. Take into account that this answer message will be sent 'as is' and sequence information could be wrong at the remote peer", ANNA_FILE_LOCATION)); - } + codecMsg.loadXMLFile(param3); + LOGWARNING( + if (!codecMsg.isRequest() && (param4 == "")) + anna::Logger::warning("Step number has not been provided. Take into account that this answer message will be sent 'as is' and sequence information could be wrong at the remote peer", ANNA_FILE_LOCATION); + ); + + updateOperatedOriginHostWithMessage(codecMsg); int stepNumber = ((param4 != "") ? atoi(param4.c_str()):-1); - std::string originRealm = codecMsg.getAvp(anna::diameter::helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->getValue(); - RealmNode *realm = getRealmNode(originRealm); - if (!realm) - throw anna::RuntimeException("Cannot identify the realm node for the manager message. Check the Origin-Realm avp value (use the realm node name)", ANNA_FILE_LOCATION); if (param2 == "sendxml2e") - testManager.getTestCase(id)->addSendxml2e(codecMsg.code(), realm, stepNumber); // creates / reuses + testManager.getTestCase(id)->addSendDiameterXml2e(codecMsg.code(), getOperatedHost(), stepNumber); // creates / reuses else - testManager.getTestCase(id)->addSendxml2c(codecMsg.code(), realm, stepNumber); // creates / reuses + testManager.getTestCase(id)->addSendDiameterXml2c(codecMsg.code(), getOperatedHost(), stepNumber); // creates / reuses } else if (param2 == "delay") { if (numParams > 3) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); if(param3 == "") throw anna::RuntimeException("Missing milliseconds for 'delay' command in test id operation", ANNA_FILE_LOCATION); - anna::Millisecond delay = checkTimeMeasure("Test case delay step", param3); + anna::Millisecond delay = ((param3 == "0" /* special case */) ? (anna::Millisecond)0 : checkTimeMeasure("Test case delay step", param3)); testManager.getTestCase(id)->addDelay(delay); // creates / reuses } + +// TODO(***) +// The way to identify the test case, is through registered Session-Id values for +// programmed requests. But this depends on the type of node. Acting as clients, +// requests received have Session-Id values which are already registered with +// one test case, causing an error if not found. Acting as servers, requests are +// received over a diameter local server from a client which are generating that +// Session-Id values. Then we know nothing about such values. The procedure in +// this case is find out a test case not-started containing a condition which +// comply with the incoming message, and reactivates it. +// The other solution: register Session-Id values for answers send to client from a local diameter server. else if ((param2 == "waitfe")||(param2 == "waitfc")) { - if (numParams > 10) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); - if (param3 != "" || param4 != "" || param5 != "" || param6 != "" || param7 != "" || param8 != "" || param9 != "" || param10 != "") { + if (numParams > 11) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + if (param3 != "" || param4 != "" || param5 != "" || param6 != "" || param7 != "" || param8 != "" || param9 != "" || param10 != "" || param11 != "") { bool fromEntity = (param2.substr(4,2) == "fe"); - testManager.getTestCase(id)->addWait(fromEntity, param3, param4, param5, param6, param7, param8, param9, param10); + testManager.getTestCase(id)->addWaitDiameter(fromEntity, param3, param4, param5, param6, param7, param8, param9, param10, param11); } else { throw anna::RuntimeException(anna::functions::asString("Missing condition for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION); } } - else if ((param2 == "waitfe-regexp")||(param2 == "waitfc-regexp")) { - if (numParams > 3) - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); - if (param3 != "") { - bool fromEntity = (param2.substr(4,2) == "fe"); - testManager.getTestCase(id)->addWaitRegexp(fromEntity, param3); + else if ((param2 == "waitfe-hex")||(param2 == "waitfc-hex")) { + if (numParams > 4) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + if(param3 == "") throw anna::RuntimeException(anna::functions::asString("Missing hex file for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION); + + // Get DataBlock from file with hex content: + if(!getDataBlockFromHexFile(param3, db_aux)) + throw anna::RuntimeException("Error reading hex content from file provided", ANNA_FILE_LOCATION); + + // Hexadecimal representation read from file: + std::string regexp = anna::functions::asHexString(db_aux); + + // optional 'full': + if(param4 != "strict") { + //// If request, we will ignore sequence data: + //if (anna::diameter::codec::functions::requestBit(db_aux)) + regexp.replace (24, 16, "[0-9A-Fa-f]{16}"); + + regexp.insert(0, "^"); + regexp += "$"; } - else { - throw anna::RuntimeException(anna::functions::asString("Missing condition for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION); + + bool fromEntity = (param2.substr(4,2) == "fe"); + testManager.getTestCase(id)->addWaitDiameterRegexpHex(fromEntity, regexp); + } + else if ((param2 == "waitfe-xml")||(param2 == "waitfc-xml")) { + if (numParams > 4) + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + if(param3 == "") throw anna::RuntimeException(anna::functions::asString("Missing xml file for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION); + + codecMsg.loadXMLFile(param3); + std::string regexp = codecMsg.asXMLString(true /* normalization */); + + // Now we must insert regular expressions in hop-by-hop, end-to-end and Origin-State-Id: + + // optional 'full': + if(param4 != "strict") { + std::string::size_type pos, pos_1, pos_2; + + pos = regexp.find("end-to-end-id=", 0u); + pos = regexp.find("\"", pos); + pos_1 = pos; + pos = regexp.find("\"", pos+1); + pos_2 = pos; + regexp.replace(pos_1 + 1, pos_2 - pos_1 - 1, "[0-9]+"); + + pos = regexp.find("hop-by-hop-id=", 0u); + pos = regexp.find("\"", pos); + pos_1 = pos; + pos = regexp.find("\"", pos+1); + pos_2 = pos; + regexp.replace(pos_1 + 1, pos_2 - pos_1 - 1, "[0-9]+"); + + // For this representation: + //pos = regexp.find("Origin-State-Id", 0u); + //pos = regexp.find("\"", pos); + //pos = regexp.find("\"", pos+1); + //pos_1 = pos; + //pos = regexp.find("\"", pos+1); + //pos_2 = pos; + //regexp.replace(pos_1 + 1, pos_2 - pos_1 - 1, "[0-9]+"); + // But we have this one: + pos = regexp.find("Origin-State-Id", 0u); + pos = regexp.rfind("\"", pos); + pos = regexp.rfind("\"", pos-1); + pos = regexp.rfind("\"", pos-1); + pos_1 = pos; + pos = regexp.find("\"", pos+1); + pos_2 = pos; + regexp.replace(pos_1 + 1, pos_2 - pos_1 - 1, "[0-9]+"); + + //regexp.insert(0, "^"); + //regexp += "$"; } + + bool fromEntity = (param2.substr(4,2) == "fe"); + testManager.getTestCase(id)->addWaitDiameterRegexpXml(fromEntity, regexp); + } + else if (param2 == "sh-command") { + // Allow pipes in command: + //if (numParams > 4) + // throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); + if(param3 == "") throw anna::RuntimeException("Missing script/executable command-line for 'sh-command' in test id operation", ANNA_FILE_LOCATION); + std::string token = "|sh-command|"; + std::string command = operation.substr(operation.find(token) + token.size()); + testManager.getTestCase(id)->addCommand(command); // creates / reuses } else { - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); } } } else if((opType == "sendxml2c") || (opType == "sendhex2c")) { - if(!localServer) throw anna::RuntimeException("No local server configured to send the message", ANNA_FILE_LOCATION); - anna::diameter::comm::Message *msg = getWorkingNode()->createCommMessage(); + anna::diameter::comm::Message *msg; if(opType == "sendxml2c") { - codecMsg.loadXML(param1); + codecMsg.loadXMLFile(param1); + updateOperatedOriginHostWithMessage(codecMsg); + msg = getOperatedHost()->createCommMessage(); msg->clearBody(); try { codecMsg.valid(); } catch(anna::RuntimeException &ex) { ex.trace(); } // at least we need to see validation errors although it will continue sending (see validation mode configured in launcher) @@ -1838,91 +1839,80 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons // Get DataBlock from file with hex content: if(!getDataBlockFromHexFile(param1, db_aux)) throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION); - + msg = getOperatedHost()->createCommMessage(); msg->setBody(db_aux); } - bool success = localServer->send(msg); - getWorkingNode()->releaseCommMessage(msg); + bool success = getOperatedServer()->send(msg); + getOperatedHost()->releaseCommMessage(msg); // Detailed log: - if(getWorkingNode()->logEnabled()) { - anna::diameter::comm::ServerSession *usedServerSession = localServer->getLastUsedResource(); - std::string detail = usedServerSession ? usedServerSession->asString() : ""; // esto no deberia ocurrir - getWorkingNode()->writeLogFile(codecMsg, (success ? "sent2c" : "send2cError"), detail); + if(getOperatedHost()->logEnabled()) { + anna::diameter::comm::ServerSession *usedServerSession = getOperatedServer()->getLastUsedResource(); + std::string detail = usedServerSession ? usedServerSession->asString() : ""; // shouldn't happen + getOperatedHost()->writeLogFile(codecMsg, (success ? "sent2c" : "send2cError"), detail); } } else if(opType == "loadxml") { - codecMsg.loadXML(param1); + codecMsg.loadXMLFile(param1); response_content = codecMsg.asXMLString(); - return; + return true; // OK } else if(opType == "diameterServerSessions") { int diameterServerSessions = atoi(param1.c_str()); + getOperatedServer()->setMaxConnections(diameterServerSessions); - if(localServer) - localServer->setMaxConnections(diameterServerSessions); - else - LOGWARNING(anna::Logger::warning("To update the number of sessions, you must configure the process diameter local server: you could also launch it with no sessions (disabled)", ANNA_FILE_LOCATION)); - - } else if((opType == "answerxml") || (opType == "answerxml2c")) { - if(!localServer) - throw anna::RuntimeException("Operation not applicable (no own diameter server has been configured)", ANNA_FILE_LOCATION); - + } else if(opType == "answerxml2c") { if(param1 == "") { // programmed answers FIFO's to stdout - response_content = localServer->getReactingAnswers()->asString("ANSWERS TO CLIENT"); - return; + response_content = getOperatedServer()->getReactingAnswers()->asString("ANSWERS TO CLIENT"); + return true; // OK } else if (param1 == "rotate") { - localServer->getReactingAnswers()->rotate(true); + getOperatedServer()->getReactingAnswers()->rotate(true); } else if (param1 == "exhaust") { - localServer->getReactingAnswers()->rotate(false); + getOperatedServer()->getReactingAnswers()->rotate(false); } else if (param1 == "clear") { - localServer->getReactingAnswers()->clear(); + getOperatedServer()->getReactingAnswers()->clear(); } else if (param1 == "dump") { - localServer->getReactingAnswers()->dump(); + getOperatedServer()->getReactingAnswers()->dump("programmed_answer"); } else { - anna::diameter::codec::Message *message = getCodecEngine()->createMessage(param1); - LOGDEBUG - ( - anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION); - ); + codecMsg.loadXMLFile(param1); + updateOperatedOriginHostWithMessage(codecMsg); + anna::diameter::codec::Message *message = getOperatedHost()->getCodecEngine()->createMessage(param1); // loads xml again, lesser of two evils + LOGDEBUG(anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION)); if(message->isRequest()) throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION); int code = message->getId().first; LOGDEBUG(anna::Logger::debug("Adding a new programed 'answer to client' to the FIFO queue corresponding to its message code ...", ANNA_FILE_LOCATION)); - localServer->getReactingAnswers()->addMessage(code, message); + getOperatedServer()->getReactingAnswers()->addMessage(code, message); } } else if(opType == "answerxml2e") { - if(!entity) - throw anna::RuntimeException("Operation not applicable (no diameter entity has been configured)", ANNA_FILE_LOCATION); if(param1 == "") { // programmed answers FIFO's to stdout - response_content = entity->getReactingAnswers()->asString("ANSWERS TO ENTITY"); - return; + response_content = getOperatedEntity()->getReactingAnswers()->asString("ANSWERS TO ENTITY"); + return true; // OK } else if (param1 == "rotate") { - entity->getReactingAnswers()->rotate(true); + getOperatedEntity()->getReactingAnswers()->rotate(true); } else if (param1 == "exhaust") { - entity->getReactingAnswers()->rotate(false); + getOperatedEntity()->getReactingAnswers()->rotate(false); } else if (param1 == "clear") { - entity->getReactingAnswers()->clear(); + getOperatedEntity()->getReactingAnswers()->clear(); } else if (param1 == "dump") { - entity->getReactingAnswers()->dump(); + getOperatedEntity()->getReactingAnswers()->dump("programmed_answer"); } else { - anna::diameter::codec::Message *message = getCodecEngine()->createMessage(param1); - LOGDEBUG - ( - anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION); - ); + codecMsg.loadXMLFile(param1); + updateOperatedOriginHostWithMessage(codecMsg); + anna::diameter::codec::Message *message = getOperatedHost()->getCodecEngine()->createMessage(param1); // loads xml again, lesser of two evils + LOGDEBUG(anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION)); if(message->isRequest()) throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION); int code = message->getId().first; LOGDEBUG(anna::Logger::debug("Adding a new programed 'answer to entity' to the FIFO queue corresponding to its message code ...", ANNA_FILE_LOCATION)); - entity->getReactingAnswers()->addMessage(code, message); + getOperatedEntity()->getReactingAnswers()->addMessage(code, message); } } else { - throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION); + throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION); } // HTTP response @@ -1931,6 +1921,8 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons response_content += " => "; response_content += opt_response_content; } + + return result; } anna::xml::Node* Launcher::asXML(anna::xml::Node* parent) const @@ -1939,22 +1931,46 @@ throw() { anna::comm::Application::asXML(result); // Timming: result->createAttribute("StartTime", a_start_time.asString()); + result->createAttribute("InitialWorkingDirectory", a_initialWorkingDirectory); result->createAttribute("SecondsLifeTime", anna::time::functions::lapsedMilliseconds() / 1000); // Diameter: - getCodecEngine()->asXML(result); - for (realm_nodes_it it = a_nodes.begin(); it != a_nodes.end(); it++) { + anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate(); + for (diameter::comm::origin_hosts_it it = ohm.begin(); it != ohm.end(); it++) { it->second->asXML(result); } + // Registered codec engines: + anna::diameter::codec::EngineManager &em = anna::diameter::codec::EngineManager::instantiate(); + em.asXML(result); + + // OAM & statistics: + oamAsXML(result); + statsAsXML(result); + + // Testing: could be heavy if test case reports are enabled + anna::testing::TestManager::instantiate().asXML(result); + + return result; +} + +anna::xml::Node* Launcher::oamAsXML(anna::xml::Node* parent) const +throw() { + anna::xml::Node* result = parent->createChild("Oam"); + // OAM: anna::diameter::comm::OamModule::instantiate().asXML(result); anna::diameter::comm::ApplicationMessageOamModule::instantiate().asXML(result); anna::diameter::codec::OamModule::instantiate().asXML(result); + + return result; +} + +anna::xml::Node* Launcher::statsAsXML(anna::xml::Node* parent) const +throw() { + anna::xml::Node* result = parent->createChild("Statistics"); + // Statistics: anna::statistics::Engine::instantiate().asXML(result); - // Testing: could be heavy if test case reports are enabled - TestManager::instantiate().asXML(result); - return result; }