#include <math.h> // ceil
#include <climits>
#include <unistd.h> // chdir
+//#include <regex> TODO: use this from gcc4.9.0: http://stackoverflow.com/questions/8060025/is-this-c11-regex-error-me-or-the-compiler
+#include <stdio.h>
// Project
#include <anna/timex/Engine.hpp>
#include <anna/diameter/helpers/base/functions.hpp>
#include <anna/time/functions.hpp>
#include <anna/diameter.comm/ApplicationMessageOamModule.hpp>
+#include <anna/testing/defines.hpp>
#include <anna/xml/xml.hpp>
+#include <anna/diameter.comm/OriginHost.hpp>
+#include <anna/diameter.comm/OriginHostManager.hpp>
// Process
#include <Launcher.hpp>
-#include <OriginHost.hpp>
+#include <Procedure.hpp>
+#include <EventOperation.hpp>
#include <MyDiameterEngine.hpp>
-#include <TestManager.hpp>
-#include <TestCase.hpp>
+#include <anna/testing/TestManager.hpp>
+#include <anna/testing/TestCase.hpp>
#define SIGUSR2_TASKS_INPUT_FILENAME "sigusr2.in"
log: Process log file (operations result, traffic log, etc.). By default '<originHost>.launcher.log'.\n\
Empty string or \"null\" name, to disable. Warning: there is no rotation for log files\n\
(use logrotate or whatever you consider).\n\
- splitLog: Splits log file (appends to log filename, extensions with the type of event: see help on\n\
- startup information-level traces). No log files for code/decode and load operations are created.\n\
+ splitLog: Splits log file (appends to log filename, extensions with the type of event.\n\
+ (Check 'HELP.md' for more information). No log files for code/decode and load operations are created.\n\
Default value 'no'.\n\
detailedLog: Insert detailed information at log files (timestamps, communication resources, etc.). Useful\n\
to analyze the messages flow along the sockets (specially on 'balance' mode). Default 'no'.\n\
//a_admlMinResolution = (anna::Millisecond)100;
a_counterRecorderClock = NULL;
- // a_originHosts.clear();
a_workingNode = NULL;
a_httpServerSocket = NULL;
burstLog = (*it)->getAttribute("burstLog", false /* no exception */); // (yes | no)
// Basic checkings:
- origin_hosts_it nodeIt = a_originHosts.find(originHost->getValue());
- if (nodeIt != a_originHosts.end()) {
+ 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);
}
// 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;
throw anna::RuntimeException("Parameter 'retries' must be non-negative", ANNA_FILE_LOCATION);
}
- // Create new Node instance /////////////////////////////////////////////////////////////////
- a_workingNode = new OriginHost(originHost->getValue(), applicationId, bpd);
- MyDiameterEngine *commEngine = a_workingNode->getMyDiameterEngine();
/////////////////////////////////////////////////////////////////////////////////////////////
-
- // Assignments:
+ // Diameter communication engine:
+ std::string commEngineName = originHost->getValue() + "_DiameterCommEngine";
+ MyDiameterEngine *commEngine = new MyDiameterEngine(commEngineName.c_str(), bpd);
+ commEngine->setAutoBind(false); // allow to create client-sessions without binding them, in order to set timeouts.
commEngine->setMaxConnectionDelay(tcpConnectDelayMs);
commEngine->setWatchdogPeriod(watchdogPeriodMs);
+ commEngine->setOriginHostName(originHost->getValue());
+ if (originRealm) commEngine->setOriginRealmName(originRealm->getValue());
+
+ // Origin host node:
+ a_workingNode = new anna::diameter::comm::OriginHost((anna::diameter::comm::Engine*)commEngine, applicationId);
+ a_workingNode->setRequestRetransmissions(retransmissions);
+ /////////////////////////////////////////////////////////////////////////////////////////////
- // Realm information:
- commEngine->setOriginHost(originHost->getValue());
- if (originRealm) commEngine->setOriginRealm(originRealm->getValue());
// Diameter entity:
if(entity) {
// 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();
}
std::string ceaPathfile = cea ? cea->getValue() : "";
int sessions = diameterServerSessions ? diameterServerSessions->getIntegerValue() : 1;
- a_workingNode->startDiameterServer(diameterServer->getValue(), sessions, allowedInactivityTimeMs, answersTimeoutMs, ceaPathfile);
+ a_workingNode->createDiameterServer(diameterServer->getValue(), sessions, allowedInactivityTimeMs, answersTimeoutMs, ceaPathfile);
}
// Logs:
if (!allLogsDisabled) {
- std::string host = commEngine->getOriginHost();
+ std::string host = commEngine->getOriginHostName();
std::string s_log = host + ".launcher.log"; if (log) s_log = log->getValue();
bool b_splitLog = (splitLog ? (splitLog->getValue() == "yes") : false);
bool b_detailedLog = (detailedLog ? (detailedLog->getValue() == "yes") : false);
if (eventOperation) commEngine->lazyInitialize();
// Node and Codec Engine registration ///////////////////////////////////////////////////////
- a_originHosts[originHost->getValue()] = a_workingNode;
+ ohm.registerOriginHost(originHost->getValue(), a_workingNode);
/////////////////////////////////////////////////////////////////////////////////////////////
}
}
bool Launcher::setWorkingNode(const std::string &name) throw() {
bool result = false;
- origin_hosts_it nodeIt = a_originHosts.find(name);
- if (nodeIt == a_originHosts.end()) {
- LOGWARNING(
- std::string msg = "Unknown node with name '"; msg += name; msg += "'. Ignoring ...";
- anna::Logger::warning(msg, ANNA_FILE_LOCATION);
- );
- }
- else {
- a_workingNode = const_cast<OriginHost*>(nodeIt->second);
+ anna::diameter::comm::OriginHostManager &ohm = anna::diameter::comm::OriginHostManager::instantiate();
+ anna::diameter::comm::OriginHost *oh = ohm.getOriginHost(name);
+
+ if (oh) {
+ a_workingNode = const_cast<anna::diameter::comm::OriginHost*>(oh);
result = true;
}
return result;
}
-OriginHost *Launcher::getOriginHost(const std::string &oh) const throw(anna::RuntimeException) {
- origin_hosts_it it = a_originHosts.find(oh);
- if (it != a_originHosts.end()) return it->second;
- throw anna::RuntimeException(anna::functions::asString("There is no origin host registered as '%s' (set Origin-Host avp correctly or force a specific host with 'node' operation)", oh.c_str()), ANNA_FILE_LOCATION);
+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 (!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;
}
-OriginHost *Launcher::getOriginHost(const anna::diameter::codec::Message &message) const throw(anna::RuntimeException) {
+anna::diameter::comm::OriginHost *Launcher::getOriginHost(const anna::diameter::codec::Message &message) const throw(anna::RuntimeException) {
std::string originHost = message.getAvp(anna::diameter::helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->getValue();
return (getOriginHost(originHost));
}
+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);
}
-OriginHost *Launcher::getOperatedHost() const throw(anna::RuntimeException) {
+anna::diameter::comm::OriginHost *Launcher::getWorkingNode() const throw(anna::RuntimeException) {
+ if(!a_workingNode)
+ throw anna::RuntimeException("Working node not identified (try to load services)", ANNA_FILE_LOCATION);
+
+ return a_workingNode;
+}
+
+anna::diameter::comm::OriginHost *Launcher::getOperatedHost() const throw(anna::RuntimeException) {
if(!a_operatedHost)
throw anna::RuntimeException("Node not identified (try to force a specific Origin-Host with 'node' operation)", ANNA_FILE_LOCATION);
}
MyDiameterEntity *Launcher::getOperatedEntity() const throw(anna::RuntimeException) {
- MyDiameterEntity *result = getOperatedHost()->getEntity();
+ MyDiameterEntity *result = (MyDiameterEntity *)(getOperatedHost()->getEntity());
if (!result)
throw anna::RuntimeException("No entity configured for the operated node", ANNA_FILE_LOCATION);
return result;
}
MyLocalServer *Launcher::getOperatedServer() const throw(anna::RuntimeException) {
- MyLocalServer *result = getOperatedHost()->getDiameterServer();
+ MyLocalServer *result = (MyLocalServer *)(getOperatedHost()->getDiameterServer());
if (!result)
throw anna::RuntimeException("No local server configured for the operated node", ANNA_FILE_LOCATION);
return result;
}
MyDiameterEngine *Launcher::getOperatedEngine() const throw(anna::RuntimeException) {
- return getOperatedHost()->getMyDiameterEngine(); // never will be NULL
+ return (MyDiameterEngine *)getOperatedHost()->getCommEngine(); // never will be NULL
}
void Launcher::initialize()
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 = ".";
// 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"))
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();
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;
a_timeEngine->activate(a_counterRecorderClock); // start clock
}
- // Log statistics concepts
- if(cl.exists("logStatisticSamples")) {
- std::string list = cl.getValue("logStatisticSamples");
- anna::statistics::Engine &statEngine = anna::statistics::Engine::instantiate();
-
- if(list == "all") {
- if(statEngine.enableSampleLog(/* -1: all concepts */))
- LOGDEBUG(anna::Logger::debug("Sample log activation for all statistic concepts", ANNA_FILE_LOCATION));
- } else {
- anna::Tokenizer lst;
- lst.apply(cl.getValue("logStatisticSamples"), ",");
-
- if(lst.size() >= 1) {
- anna::Tokenizer::const_iterator tok_min(lst.begin());
- anna::Tokenizer::const_iterator tok_max(lst.end());
- anna::Tokenizer::const_iterator tok_iter;
- int conceptId;
-
- for(tok_iter = tok_min; tok_iter != tok_max; tok_iter++) {
- conceptId = atoi(anna::Tokenizer::data(tok_iter));
-
- if(statEngine.enableSampleLog(conceptId))
- LOGDEBUG(anna::Logger::debug(anna::functions::asString("Sample log activation for statistic concept id = %d", conceptId), ANNA_FILE_LOCATION));
- }
- }
- }
- }
-
+ /////////////////////////////
+ // Log statistics concepts //
+ /////////////////////////////
+ if(cl.exists("logStatisticSamples"))
+ logStatisticsSamples(cl.getValue("logStatisticSamples"));
// Start client connections //////////////////////////////////////////////////////////////////////////////////
MyDiameterEntity *entity;
- for (origin_hosts_it it = a_originHosts.begin(); it != a_originHosts.end(); it++) {
- entity = it->second->getEntity();
+ 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();
}
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);
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;
void Launcher::resetStatistics() throw() {
if (a_workingNode) {
- a_workingNode->getMyDiameterEngine()->resetStatistics();
+ a_workingNode->getCommEngine()->resetStatistics();
}
else {
- for (origin_hosts_it it = a_originHosts.begin(); it != a_originHosts.end(); it++) {
- it->second->getMyDiameterEngine()->resetStatistics();
+ 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();
}
}
}
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();
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 MultiHost Launcher) process is a multi-host 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 origin-host 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 <pid>";
- result += "\n or";
- result += "\n kill -s SIGUSR1 <pid>";
- result += "\n and then";
- result += "\n vi /var/tmp/anna.context.<pid>";
- 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 <services xml file>. 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<services>";
- result += "\n <!-- Stacks -->";
- result += "\n <stack id=\"0\" dictionary=\"dictionary.xml\"/>";
- result += "\n";
- result += "\n <!-- Nodes -->";
- result += "\n <node originHost=\"ADML-client\" applicationId=\"0\" entity=\"localhost:3868\"/>";
- result += "\n</services>";
- result += "\n";
- result += "\nServer configuration:";
- result += "\n";
- result += "\n<services>";
- result += "\n <!-- Stacks -->";
- result += "\n <stack id=\"0\" dictionary=\"dictionary.xml\"/>";
- result += "\n";
- result += "\n <!-- Nodes -->";
- result += "\n <node originHost=\"ADML-server\" applicationId=\"0\" diameterServer=\"localhost:3868\"/>";
- result += "\n</services>";
- 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 nodes:";
- result += "\n";
- result += "\nClient and server configuration:";
- result += "\n";
- result += "\n<services>";
- result += "\n <!-- Stacks -->";
- result += "\n <stack id=\"16777236\" dictionary=\"dictionary_Rx.xml\"/>";
- result += "\n <stack id=\"16777238\" dictionary=\"dictionary_Gx.xml\"/>";
- result += "\n <stack id=\"0\" dictionary=\"dictionary_base.xml\"/>";
- result += "\n";
- result += "\n <!-- Nodes -->";
- result += "\n <node originHost=\"ADML-Rx-client\" applicationId=\"16777236\" entity=\"localhost:3868\" cer=\"cer_Rx.xml\"/>";
- result += "\n <node originHost=\"ADML-Gx-client\" applicationId=\"16777238\" entity=\"localhost:3868\" cer=\"cer_Gx.xml\"/>";
- result += "\n</services>";
- 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 management";
- result += "\n";
- result += "\nnode[|<name>] Selects a context working node by mean a registered name (origin-host).";
- result += "\n All the subsequent operations will be forced to work with";
- result += "\n this node, which makes possible some rare scenarios like";
- result += "\n sending unexpected messages on remote peers. This is also";
- result += "\n useful for some operations in order to restrict the scope";
- result += "\n of action (statistics, communication visibility, etc.).";
- result += "\n Empty parameter will show the current configuration.";
- result += "\n";
- result += "\nnode_auto Returns to the default behaviour (smart node selection).";
- result += "\n Depending on the operation, this could imply a global";
- result += "\n action scope, affecting to all the registered hosts.";
- result += "\n This should be the normal configuration. Take into";
- result += "\n account that if you fix the working node, this could";
- result += "\n affect to things like test programming: communication";
- result += "\n resources will override those which would be inferred";
- result += "\n from programmed messages Origin-Host avps.";
- result += "\n";
- result += "\n------------------------------------------------------------------------------------ Parsing operations";
- result += "\n";
- result += "\ncode|<source_file>|<target_file> Encodes source file (pathfile) into target file (pathfile).";
- result += "\ndecode|<source_file>|<target_file> Decodes source file (pathfile) into target file (pathfile).";
- result += "\nloadxml|<source_file> 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). This is used";
- result += "\n to load new nodes once the ADML is started, regardless if command";
- result += "\n line '--services' parameter was used or not. Those services which";
- result += "\n are not correctly loaded will be ignored to keep the process alive.";
- result += "\n If you need to load services as deltas, you must firstly load the";
- result += "\n diameter base dictionary with stack id 0, because all the nodes";
- result += "\n will use this dictionary to encode/decode base protocol messages";
- result += "\n managed by the communication engine.";
- result += "\n";
- result += "\ndiameterServerSessions|<integer> 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.<pid>' 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.<pid>' by mean 'kill -10 <pid>'.";
- result += "\n or sending operation 'context|[target file]'.";
- result += "\n This operation applies over all the registered host nodes";
- result += "\n except if one specific working node has been set.";
- result += "\nforceCountersRecord Forces dump to file the current counters of the process.";
- result += "\nchange-dir[|directory] Changes the execution point which could be fine to ease some";
- result += "\n file system interaction tasks. Be care about some requirements";
- result += "\n (for example if you have a user defined counters directory as";
- result += "\n relative path this must exists from the new execution directory).";
- result += "\n If nothing provided, initial working directory will be restored.";
- result += "\nshow-oam Dumps current counters of the process. This is also done at";
- result += "\n process context dump.";
- result += "\nshow-stats Dumps statistics of the process. This is also done at process";
- result += "\n context dump.";
- result += "\n";
- result += "\n<visibility action>[|<address>:<port>][|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|<source_file> Sends xml source file (pathfile) through configured entity.";
- result += "\nsendxml2c|<source_file> Sends xml source file (pathfile) to client.";
- 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<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.<message code>.<sequence>',";
- 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|<source_file> Sends hex source file (pathfile) through configured entity.";
- result += "\nsendhex2c|<source_file> Sends hex source file (pathfile) to client.";
- 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<2e/2c>' 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<2e/2c>/sendhex<2e/2c> 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 += "\nIn order to simplify user experience, burst category operations are only allowed in single host node";
- result += "\n configuration. Indeed, you could send messages with unmatched Origin-Host, and no warning is shown.";
- result += "\nAll the operations are performed through the unique host: if you need to use more interfaces, you may";
- result += "\n launch different ADML instances. Is nonsense to allow burst in a multi-host configured ADML, because";
- result += "\n this feature is not able to coordinate the messages.";
- result += "\n";
- result += "\nburst|<action>[|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|<source_file> Loads the next diameter message into launcher burst.";
- result += "\n burst|start|<initial load> Starts (or restarts if already in progress) the message sending with";
- result += "\n a certain initial load.";
- result += "\n burst|push|<load amount> Sends specific non-aynchronous load.";
- result += "\n burst|pop|<release amount> 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|<amount> 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|<order> 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 (origin-host) coordination, you could use the advanced test cases programming:";
- result += "\n";
- result += "\n";
- result += "\n test|<id>|<command>[|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. Check possible runtime exceptions when adding a";
- result += "\n new step because those which fail, will be ignored/skipped during test case";
- result += "\n programming giving an incomplete sequence invalid for the testing purpose.";
- result += "\n";
- result += "\n <id>: 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 <command>: 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|<msecs> 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|<source_file>[|<step number>]";
- 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|<source_file>[|<step number>]";
- 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|<msecs> Blocking step until the time lapse expires. Useful to give ";
- result += "\n some cadence control and time schedule for a specific case.";
- result += "\n A value of 0 could be used as a dummy step.";
- result += "\n wait<fe/fc>|<condition> Blocking step until condition is fulfilled. The message could";
- result += "\n received from entity (waitfe) or from client (waitfc).";
- result += "\n";
- result += "\n wait<fe/fc>-regexp|<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 sh-command|<script> External execution for script/executable via shell through a dedicated";
- result += "\n thread, providing the command and parameters. You could use dynamic";
- result += "\n variables ##<tag> to have more flexibility:";
- result += "\n Test pool cycle id: "; result += SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID;
- result += "\n Test case id: "; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID;
- result += "\n Test step id: "; result += SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID;
- result += "\n";
- result += "\n For example, your command could be something like this:";
- result += "\n insert_sql_"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID; result += ".sh -db dbname --verbose";
- result += "\n > /tmp/cycle-"; result += SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID;
- result += ".testcase-"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID;
- result += ".teststep-"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID;
- result += ".out";
- result += "\n Try to redirect stdout and stderr to avoid ADML output contamination";
- result += "\n with the possible outputs from the scripts. You could also put your";
- result += "\n job in background although sh-command will return 0-value immediately.";
- result += "\n";
- result += "\n <condition>: 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 host 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]|[hopByHop]|[applicationId]|[sessionId]|[resultCode]|[msisdn]|[imsi]|[serviceContextId]";
- result += "\n";
- result += "\n code: integer number";
- result += "\n bitR: 1 (request), 0 (answer)";
- result += "\n hopByHop: integer number or request send step reference: #<step number>";
- 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 applicationId: integer number";
- result += "\n sessionId: string";
- result += "\n resultCode: integer number";
- 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 host 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|||SGx|2001 (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|||SRx|2001 (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|H1||SGx|2001 (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|<amount> 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 The 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|next[|<sync-amount>] Forces the execution of the next test case(s) without waiting for test manager tick.";
- result += "\n Provide an integer value for 'sync-amount' to send a burst synchronous amount of the";
- result += "\n next programmed test cases (1 by default). This event works regardless the timer tick";
- result += "\n function, but it is normally used with the test manager tick stopped.";
- 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|<id> Updates current test pointer position.";
- result += "\n";
- result += "\n test|look[|id] Show programmed test case for id provided, current 'in-process' test case when missing.";
- result += "\n Test cases reports are not dumped on process context (too many information in general).";
- result += "\n The report contains context information in every moment: this operation acts as a snapshot.";
- result += "\n";
- result += "\n test|interact|amount|id Makes interactive a specific test case id. The amount is the margin of execution steps";
- result += "\n to be done. Normally, we will execute 'test|interact|0|<test case id>', which means that";
- result += "\n the test case is selected to be interactive, but no step is executed. Then you have to";
- result += "\n interact with positive amounts (usually 1), executing the provided number of steps if";
- result += "\n they are ready and fulfill the needed conditions. The value of 0, implies no execution";
- result += "\n steps margin, which could be useful to 'freeze' a test in the middle of its execution.";
- result += "\n You could also provide -1 to make it non-interactive resuming it from the current step.";
- result += "\n";
- result += "\n test|reset|<[soft]/hard>[|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|repeats|<amount> Restarts the whole programmed test list when finished the amount number of times (repeats";
- result += "\n forever if value -1 is provided). This is disabled by default (amount = 0): testing trigger";
- result += "\n system will enter suspended state until new ttps operation is received and a soft reset has";
- result += "\n been done before. Test cases state & data will be reset (when achieved again), but general";
- result += "\n statistics and counters will continue measuring until reset with 'collect' operation.";
- result += "\n";
- result += "\n test|clear Clears all the programmed test cases and stop testing (if in progress).";
- result += "\n";
- result += "\n test|summary Test manager general report (number of test cases, counts by state, global configuration,";
- result += "\n forced in-progress limitation, reports visibility, etc.). Be careful when you have reports";
- result += "\n enabled because the programmed test cases dumps could be heavy (anyway you could enable the";
- result += "\n dumps separately, for any of the possible states: Initialized, InProgress, Failed, Success).";
- result += "\n";
- result += "\n test|report|<initialized/in-progress/failed/success/[all]/none>[|[yes]|no]";
- result += "\n";
- result += "\n Enables/disables report generation for a certain test case state: initialized, in-progress,";
- result += "\n failed or success (also 'all' and 'none' reserved words could be used). This applies to report";
- result += "\n summary (former described operation) and automatic dumps during testing where only failed or";
- result += "\n successful states will appear: every time a test case is finished its xml representation will";
- result += "\n be dump on a file under the execution directory (or the one configured in process command-line";
- result += "\n 'tmDir') with the name:";
- result += "\n";
- result += "\n 'cycle-<cycle id>.testcase-<test case id>.xml'.";
- result += "\n";
- result += "\n By default, all the states are disabled to avoid IO overload. In most of cases not all the";
- result += "\n tests are going to fail then you could enable only such failed dumps. Anyway you could set";
- result += "\n the reports visibility to fit your needs in a given situation.";
- result += "\n";
- result += "\n test|report-hex[|[yes]|no] Reports could include the diameter messages in hexadecimal format. Disabled by default.";
- 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 \"<<operation>\" > "; result += getSignalUSR2InputFile();
- result += "\n then";
- result += "\n kill -12 <pid>";
- result += "\n or";
- result += "\n kill -s SIGUSR2 <pid>";
- result += "\n and then see the results:";
- result += "\n cat "; result += getSignalUSR2OutputFile();
- result += "\n";
- result += "\n (this file is ended with EOF final line, useful managing huge batch files to ensure the job completion)";
- 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) {
+
+bool Launcher::eventOperation(const std::string &operation, std::string &response_content) throw(anna::RuntimeException) {
+
+ bool result = true;
+
LOGMETHOD(anna::TraceMethod tm("Launcher", "eventOperation", ANNA_FILE_LOCATION));
- if (operation == "") return; // ignore
- LOGDEBUG(anna::Logger::debug(operation, 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: ";
anna::diameter::codec::Message codecMsg; // auxiliary codec message
// Singletons:
- CommandLine& cl(anna::CommandLine::instantiate());
- TestManager &testManager = TestManager::instantiate();
+ anna::testing::TestManager &testManager = anna::testing::TestManager::instantiate();
///////////////////////////////////////////////////////////////////
// Simple operations without arguments:
- // 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:
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;
+ return true; // OK
}
if(operation == "show-stats") {
anna::xml::Node root("root");
response_content = anna::xml::Compiler().apply(statsAsXML(&root));
- return;
+ return true; // OK
}
///////////////////////////////////////////////////////////////////
// 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;
// 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);
}
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;
- if (chdir(param1.c_str()) == 0)
+ 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;
+ return result;
}
if(opType == "services") {
catch(anna::RuntimeException &ex) {
ex.trace();
response_content = anna::functions::asString("Loaded services from file '%s' with errors", servicesFile.c_str());
- return;
+ return false;
}
response_content = anna::functions::asString("Loaded services from file '%s'", servicesFile.c_str());
- return;
+ return true; // OK
}
// Host switch:
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;
+ return true; // OK
}
// Operated host from possible forced-working node:
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);
anna::diameter::comm::Message *msg;
if(opType == "sendxml2e") {
- codecMsg.loadXML(param1);
+ codecMsg.loadXMLFile(param1);
updateOperatedOriginHostWithMessage(codecMsg);
msg = getOperatedHost()->createCommMessage();
msg->clearBody();
try { if(getOperatedHost()->logEnabled()) codecMsg.decode(db_aux); } catch(anna::RuntimeException &ex) { ex.trace(); }
}
- bool success = getOperatedEntity()->send(msg, cl.exists("balance"));
+ bool success = getOperatedEntity()->send(msg);
getOperatedHost()->releaseCommMessage(msg);
// Detailed log:
} 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)
opt_response_content = "\n\n";
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|report-hex[|[yes]|no] Reports could include the diameter messages in hexadecimal format. Disabled by default.
// test|goto|<id> 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|<soft|hard> 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) {
}
else if (param1 == "next") {
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 sync_amount = ((param2 != "") ? atoi(param2.c_str()) : 1);
}
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 != "") {
}
else if(param1 == "repeats") {
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 repeats = atoi(param2.c_str());
if (repeats < 0) repeats = -1;
testManager.setPoolRepeats(repeats);
}
else if(param1 == "report") {
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 == "") param2 = "all";
if(param3 == "") param3 = "yes";
testManager.setDumpAllReports(enable);
}
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);
opt_response_content += (enable ? "report enabled " : "report disabled ");
opt_response_content += "for tests in '";
}
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.setDumpHex((param2 == "yes"));
opt_response_content += (testManager.getDumpHex() ? "report includes hexadecimal messages" : "report excludes hexadecimal messages");
}
+ else if(param1 == "dump-stdout") {
+ if (numParams > 2)
+ throw anna::RuntimeException("Wrong body content format on HTTP Request. Check 'HELP.md' for more information.", ANNA_FILE_LOCATION);
+
+ if(param2 == "") param2 = "yes";
+ 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());
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 ?)";
+ }
+ else {
+ opt_response_content = "cannot found test id (";
+ opt_response_content += anna::functions::asString(id);
+ opt_response_content += ")";
+ }
+ }
+ }
+ 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 if (param1 == "interact") {
- 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 (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 = atoi(param3.c_str());
- TestCase *testCase = testManager.findTestCase(id);
+ 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 += 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 == "") param2 = "soft";
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);
+ 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 ";
}
else {
if (id == -1) {
- bool anyReset = testManager.resetPool((param2 == "hard") ? true:false);
+ 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";
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;
+ return true; // OK
}
else {
int id = atoi(param1.c_str());
// PARAM: 1 2 3 4 5 6 7 8 9 10 11
// test|<id>|<command>
+ // description|<description>
+ // ip-limit[|<iplimit>]
// timeout| <msecs>
// sendxml2e| <file>[|<step number>]
// sendxml2c| <file>[|<step number>]
// delay| [msecs]
// wait<fe/fc>|[code]|[bitR]|[hopByHop]|[applicationId]|[sessionId]|[resultCode]|[msisdn]|[imsi]|[serviceContextId]
// wait<fe/fc>-answer|<step number>
- // wait<fe/fc>-regexp|<regexp>
+ // wait<fe/fc>-xml |<source_file>[|strict]
+ // wait<fe/fc>-hex |<source_file>[|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. 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 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. 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);
if (param2 == "sendxml2e")
- testManager.getTestCase(id)->addSendxml2e(codecMsg.code(), getOperatedHost(), stepNumber); // creates / reuses
+ testManager.getTestCase(id)->addSendDiameterXml2e(codecMsg.code(), getOperatedHost(), stepNumber); // creates / reuses
else
- testManager.getTestCase(id)->addSendxml2c(codecMsg.code(), getOperatedHost(), 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 = ((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 > 11)
- 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 != "" || 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, param11);
+ 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: <avp name="Origin-State-Id" data="1428633668"/>
+ //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: <avp data="1428633668" name="Origin-State-Id"/>
+ 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. 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 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);
}
}
anna::diameter::comm::Message *msg;
if(opType == "sendxml2c") {
- codecMsg.loadXML(param1);
+ codecMsg.loadXMLFile(param1);
updateOperatedOriginHostWithMessage(codecMsg);
msg = getOperatedHost()->createCommMessage();
msg->clearBody();
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);
} else if(opType == "answerxml2c") {
if(param1 == "") { // programmed answers FIFO's to stdout
response_content = getOperatedServer()->getReactingAnswers()->asString("ANSWERS TO CLIENT");
- return;
+ return true; // OK
} else if (param1 == "rotate") {
getOperatedServer()->getReactingAnswers()->rotate(true);
} else if (param1 == "exhaust") {
} else if (param1 == "clear") {
getOperatedServer()->getReactingAnswers()->clear();
} else if (param1 == "dump") {
- getOperatedServer()->getReactingAnswers()->dump();
+ getOperatedServer()->getReactingAnswers()->dump("programmed_answer");
} else {
- codecMsg.loadXML(param1);
+ 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(param1 == "") { // programmed answers FIFO's to stdout
response_content = getOperatedEntity()->getReactingAnswers()->asString("ANSWERS TO ENTITY");
- return;
+ return true; // OK
} else if (param1 == "rotate") {
getOperatedEntity()->getReactingAnswers()->rotate(true);
} else if (param1 == "exhaust") {
} else if (param1 == "clear") {
getOperatedEntity()->getReactingAnswers()->clear();
} else if (param1 == "dump") {
- getOperatedEntity()->getReactingAnswers()->dump();
+ getOperatedEntity()->getReactingAnswers()->dump("programmed_answer");
} else {
- codecMsg.loadXML(param1);
+ 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));
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
response_content += " => ";
response_content += opt_response_content;
}
+
+ return result;
}
anna::xml::Node* Launcher::asXML(anna::xml::Node* parent) const
result->createAttribute("InitialWorkingDirectory", a_initialWorkingDirectory);
result->createAttribute("SecondsLifeTime", anna::time::functions::lapsedMilliseconds() / 1000);
// Diameter:
- for (origin_hosts_it it = a_originHosts.begin(); it != a_originHosts.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);
}
statsAsXML(result);
// Testing: could be heavy if test case reports are enabled
- TestManager::instantiate().asXML(result);
+ anna::testing::TestManager::instantiate().asXML(result);
return result;
}
projects / anna.git / blobdiff