1 // ANNA - Anna is Not Nothingness Anymore //
3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo //
5 // See project site at http://redmine.teslayout.com/projects/anna-suite //
6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
10 #include <sstream> // std::istringstream
11 #include <iostream> // std::cout
12 #include <math.h> // ceil
16 #include <anna/timex/Engine.hpp>
17 #include <anna/statistics/Engine.hpp>
18 #include <anna/diameter/codec/functions.hpp>
19 #include <anna/diameter/codec/Engine.hpp>
20 #include <anna/diameter/codec/EngineManager.hpp>
21 #include <anna/http/Transport.hpp>
22 #include <anna/diameter/stack/Engine.hpp>
23 #include <anna/diameter/helpers/base/functions.hpp>
24 #include <anna/time/functions.hpp>
25 #include <anna/diameter.comm/ApplicationMessageOamModule.hpp>
26 #include <anna/xml/xml.hpp>
29 #include <Launcher.hpp>
30 #include <RealmNode.hpp>
31 #include <MyDiameterEngine.hpp>
32 #include <TestManager.hpp>
33 #include <TestCase.hpp>
36 #define SIGUSR2_TASKS_INPUT_FILENAME "./sigusr2.in"
37 #define SIGUSR2_TASKS_OUTPUT_FILENAME "./sigusr2.out"
40 const char *ServicesDTD = "\
41 <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\
42 <!-- Diameter services DTD -->\n\
44 <!ELEMENT services (stack*, node*)>\n\
46 <!ELEMENT stack EMPTY>\n\
47 <!ATTLIST stack id CDATA #REQUIRED dictionary CDATA #REQUIRED validationMode (BeforeEncoding | AfterDecoding | Always | Never) #IMPLIED validationDepth (Complete | FirstError) #IMPLIED fixMode (BeforeEncoding | AfterDecoding | Always | Never) #IMPLIED ignoreFlagsOnValidation (yes | no) #IMPLIED>\n\
51 id: Normally the id corresponds to the Application-Id for which the dictionary provided is designed\n\
52 (in multistack applications, it shall be mandatory respect such association to know the stack used\n\
53 for processed messages).\n\
54 dictionary: Path to the dictionary file.\n\
55 validationMode: Sets the validation mode. Default is 'AfterDecoding'.\n\
56 validationDepth: Sets the validation depth. Default is 'FirstError'.\n\
57 fixMode: Sets the fix mode. Default is 'BeforeEncoding'.\n\
58 ignoreFlagsOnValidation: Ignore flags during message validation. Default is 'no'.\n\
61 <!ELEMENT node EMPTY>\n\
62 <!ATTLIST node originRealm CDATA #REQUIRED applicationId CDATA #REQUIRED originHost CDATA #IMPLIED cer CDATA #IMPLIED dwr CDATA #IMPLIED allowedInactivityTime CDATA #IMPLIED tcpConnectDelay CDATA #IMPLIED answersTimeout CDATA #IMPLIED ceaTimeout CDATA #IMPLIED watchdogPeriod CDATA #IMPLIED entity CDATA #IMPLIED entityServerSessions CDATA #IMPLIED diameterServer CDATA #IMPLIED diameterServerSessions CDATA #IMPLIED balance (yes | no) #IMPLIED sessionBasedModelsClientSocketSelection (SessionIdLowPart | SessionIdHighPart | SessionIdOptionalPart | RoundRobin) #IMPLIED retries CDATA #IMPLIED log CDATA #IMPLIED splitLog (yes | no) #IMPLIED detailedLog (yes | no) #IMPLIED dumpLog (yes | no) #IMPLIED burstLog (yes | no) #IMPLIED>\n\
66 originRealm: Node identifier (Origin-Realm name).\n\
67 applicationId: The Application-Id provided must exists as a registered 'stack id'.\n\
68 originHost: Diameter application host name (system name). If missing, process sets o.s. hostname\n\
69 Note that if you have two or more realms, the names must be different.\n\
70 cer: User defined CER path file to be encoded to establish diameter connections.\n\
71 If missing, will be harcoded\n\
72 dwr: User defined DWR path file to be encoded for diameter protocol keep alive.\n\
73 If missing, will be harcoded\n\
74 allowedInactivityTime: Milliseconds for the maximum allowed inactivity time on server sessions born over the\n\
75 local server before being reset. If missing, default value of 90000 will be assigned\n\
76 tcpConnectDelay: Milliseconds to wait TCP connect to any server. If missing, default value of 200 will\n\
78 answersTimeout: Milliseconds to wait pending application answers from diameter peers. If missing,\n\
79 default value of 10000 will be assigned\n\
80 ceaTimeout: Milliseconds to wait CEA from diameter server. If missing, default value of 'answersTimeout'\n\
82 watchdogPeriod: Milliseconds for watchdog timer (Tw) for diameter keep-alive procedure. If missing, default\n\
83 value of 30000 will be assigned\n\
84 entity: Target diameter entity (comma-separated '<address>:<port>' format).\n\
85 For example: 10.20.30.40:3868,10.20.30.41:3868. If missing, no entity will be enabled\n\
86 entityServerSessions: Diameter entity server sessions (0: diameter entity disabled). Default value of 1\n\
87 diameterServer: Diameter own server address in '<address>:<port>' format. For example: 10.20.30.40:3868.\n\
88 If missing, no local server will be enabled\n\
89 diameterServerSessions: Diameter own server available connections (0: diameter server disabled). Default value of 1\n\
90 balance: Balance over entity servers instead of doing standard behaviour (first primary, secondary\n\
91 if fails, etc.). Default value 'no'\n\
92 sessionBasedModelsClientSocketSelection: By default, round-robin will be applied for IEC model (SMS/MMS), and Session-Id Low Part\n\
93 will be analyzed for ECUR/SCUR model (data, voice and content). You could change ECUR/SCUR\n\
94 analysis behaviour providing 'SessionIdHighPart', 'SessionIdOptionalPart' (atoi applied;\n\
95 usually subscriber id data, i.e. MSISDN or IMSI) and 'RoundRobin' (also 'SessionIdLowPart')\n\
96 retries: Expired responses will cause a number of request retransmissions. Disabled by default (0 retries)\n\
97 log: Process log file (operations result, traffic log, etc.). By default '<originRealm>.launcher.log'.\n\
98 Empty string or \"null\" name, to disable. Warning: there is no rotation for log files\n\
99 (use logrotate or whatever you consider)\n\
100 splitLog: Splits log file (appends to log filename, extensions with the type of event: see help on\n\
101 startup information-level traces). No log files for code/decode and load operations are created.\n\
102 Default value 'no'\n\
103 detailedLog: Insert detailed information at log files. Should be disabled on automatic tests. Useful on\n\
104 'balance' mode to know messages flow along the sockets. Default value 'no'\n\
105 dumpLog: Write to disk every incoming/outcoming message named as:\n\
106 '<originRealm>.<hop by hop>.<end to end>.<message code>.<request|answer>.<type of event>.xml'\n\
107 Default value 'no'\n\
108 burstLog: Burst operations log file. By default '<originRealm>.launcher.burst'. Empty string or \"null\" name, to disable.\n\
109 Warning: there is no rotation for log files (use logrotate or whatever). Output: dot (.) for each\n\
110 burst message sent/pushed, cross (x) for popped ones, and order number when multiple of 1% of burst\n\
111 list size, plus OTA requests when changed\n\
118 Launcher::Launcher() : anna::comm::Application("launcher", "DiameterLauncher", "1.1"), a_communicator(NULL) {
120 a_counterRecorder = NULL;
121 a_admlMinResolution = 2 * anna::timex::Engine::minResolution; // 2*10 = 20 ms; 1000/20 = 50 ticks per second;
122 //a_admlMinResolution = (anna::Millisecond)100;
123 a_counterRecorderClock = NULL;
126 a_workingNode = NULL;
128 a_httpServerSocket = NULL;
134 void Launcher::servicesFromXML(const anna::xml::Node* servicesNode, bool eventOperation) throw(anna::RuntimeException) {
136 CommandLine& cl(anna::CommandLine::instantiate());
137 bool allLogsDisabled = cl.exists("disableLogs");
139 //<!ATTLIST stack id CDATA #REQUIRED dictionary CDATA #REQUIRED>
140 const anna::xml::Attribute *id, *dictionary;
142 // <!ATTLIST node originRealm CDATA #REQUIRED applicationId CDATA #REQUIRED originHost CDATA #IMPLIED cer CDATA #IMPLIED dwr CDATA #IMPLIED allowedInactivityTime CDATA #IMPLIED tcpConnectDelay CDATA #IMPLIED answersTimeout CDATA #IMPLIED ceaTimeout CDATA #IMPLIED watchdogPeriod CDATA #IMPLIED entity CDATA #IMPLIED entityServerSessions CDATA #IMPLIED diameterServer CDATA #IMPLIED diameterServerSessions CDATA #IMPLIED balance (yes | no) #IMPLIED sessionBasedModelsClientSocketSelection (SessionIdLowPart | SessionIdHighPart | SessionIdOptionalPart | RoundRobin) #IMPLIED retries CDATA #IMPLIED log CDATA #IMPLIED splitLog (yes | no) #IMPLIED detailedLog (yes | no) #IMPLIED dumpLog (yes | no) #IMPLIED burstLog (yes | no) #IMPLIED>
143 const anna::xml::Attribute *originRealm, *appId, *originHost, *cer, *dwr, *allowedInactivityTime, *tcpConnectDelay,
144 *answersTimeout, *ceaTimeout, *watchdogPeriod, *entity, *entityServerSessions,
145 *diameterServer, *diameterServerSessions, *balance, *sessionBasedModelsClientSocketSelection,
146 *retries, *log, *splitLog, *detailedLog, *dumpLog, *burstLog;
147 // Never clear services content from here (append new data from xml). At the moment no node removing is implemented in this process
150 anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate();
151 anna::diameter::stack::Dictionary *d;
152 const anna::diameter::stack::Dictionary *bpd = NULL; // base protocol dictionary
154 // Codec engine manager:
155 anna::diameter::codec::EngineManager &em = anna::diameter::codec::EngineManager::instantiate();
156 anna::diameter::codec::Engine *ce;
158 ///////////////////////////////////////////
159 // APPLICATION MESSAGE OAM MODULE SCOPES //
160 ///////////////////////////////////////////
161 // We will register a scope per stack id registered. The counters will be dynamically registered at count method.
162 anna::diameter::comm::ApplicationMessageOamModule & appMsgOamModule = anna::diameter::comm::ApplicationMessageOamModule::instantiate();
163 appMsgOamModule.enableCounters(); // this special module is disabled by default (the only)
164 static int scope_id = 3;
165 unsigned int id_value;
166 std::string codecEngineName;
168 for(anna::xml::Node::const_child_iterator it = servicesNode->child_begin(); it != servicesNode->child_end(); it++) {
169 std::string nodeName = (*it)->getName();
171 if(nodeName == "stack") {
173 id = (*it)->getAttribute("id");
174 dictionary = (*it)->getAttribute("dictionary");
175 id_value = id->getIntegerValue();
177 if (stackEngine.getDictionary(id_value)) { // Ignore (but don't fail) dictionary load with same stack id already registered
178 LOGWARNING(anna::Logger::warning(anna::functions::asString("Ignore dictionary load for stack id already registered: %llu", id_value), ANNA_FILE_LOCATION));
183 d = stackEngine.createDictionary(id_value, dictionary->getValue());
184 LOGDEBUG(anna::Logger::debug(anna::functions::asString("Created dictionary (%p) for stack id %llu", d, id_value), ANNA_FILE_LOCATION));
186 // OAM module for counters:
187 appMsgOamModule.createStackCounterScope(scope_id, id_value /* application-id */);
190 } catch(anna::RuntimeException &ex) {
191 //_exit(ex.asString());
195 bpd = d; // base protocol dictionary in case of monostack. If multistack, will be calculated later
197 // Create codec engine and register it in the codec engine manager:
198 codecEngineName = anna::functions::asString("CodecEngineForStackId_%llu", id_value);
199 ce = new anna::diameter::codec::Engine(codecEngineName.c_str(), d);
200 em.registerCodecEngine(id_value, ce);
202 // Codec engine configuration:
203 const anna::xml::Attribute *vm_attr = (*it)->getAttribute("validationMode", false /* no exception */);
204 const anna::xml::Attribute *vd_attr = (*it)->getAttribute("validationDepth", false /* no exception */);
205 const anna::xml::Attribute *fm_attr = (*it)->getAttribute("fixMode", false /* no exception */);
206 const anna::xml::Attribute *if_attr = (*it)->getAttribute("ignoreFlags", false /* no exception */);
208 std::string vm_value = vm_attr ? vm_attr->getValue() : "AfterDecoding";
209 std::string vd_value = vd_attr ? vd_attr->getValue() : "FirstError";
210 std::string fm_value = fm_attr ? fm_attr->getValue() : "BeforeEncoding";
212 anna::diameter::codec::Engine::ValidationMode::_v vm;
213 if (vm_value == "BeforeEncoding") vm = anna::diameter::codec::Engine::ValidationMode::BeforeEncoding;
214 else if (vm_value == "AfterDecoding") vm = anna::diameter::codec::Engine::ValidationMode::AfterDecoding;
215 else if (vm_value == "Always") vm = anna::diameter::codec::Engine::ValidationMode::Always;
216 else if (vm_value == "Never") vm = anna::diameter::codec::Engine::ValidationMode::Never;
217 ce->setValidationMode(vm);
219 anna::diameter::codec::Engine::ValidationDepth::_v vd;
220 if (vd_value == "Complete") vd = anna::diameter::codec::Engine::ValidationDepth::Complete;
221 else if (vd_value == "FirstError") vd = anna::diameter::codec::Engine::ValidationDepth::FirstError;
222 ce->setValidationDepth(vd);
224 anna::diameter::codec::Engine::FixMode::_v fm;
225 if (fm_value == "BeforeEncoding") fm = anna::diameter::codec::Engine::FixMode::BeforeEncoding;
226 else if (fm_value == "AfterDecoding") fm = anna::diameter::codec::Engine::FixMode::AfterDecoding;
227 else if (fm_value == "Always") fm = anna::diameter::codec::Engine::FixMode::Always;
228 else if (fm_value == "Never") fm = anna::diameter::codec::Engine::FixMode::Never;
231 bool if_value = (if_attr ? (if_attr->getValue() == "yes") : false);
232 ce->ignoreFlagsOnValidation(if_value);
236 // Show loaded stacks:
237 std::cout << "Stacks currently loaded:" << std::endl;
238 std::cout << anna::functions::tab(stackEngine.asString(false /* light */)) << std::endl;
240 // Basic checking for multistack:
241 bool multistack = (stackEngine.stack_size() > 1);
243 bpd = stackEngine.getDictionary(0);
245 throw anna::RuntimeException("In multistack applications is mandatory register a stack id = 0 using a dictionary which contains the needed elements to build base protocol messages (CER/A, DWR/A, DPR/A, STR/A, etc.)", ANNA_FILE_LOCATION);
249 for(anna::xml::Node::const_child_iterator it = servicesNode->child_begin(); it != servicesNode->child_end(); it++) {
250 std::string nodeName = (*it)->getName();
252 if(nodeName == "node") {
254 originRealm = (*it)->getAttribute("originRealm");
255 appId = (*it)->getAttribute("applicationId");
256 originHost = (*it)->getAttribute("originHost", false /* no exception */);
257 cer = (*it)->getAttribute("cer", false /* no exception */);
258 dwr = (*it)->getAttribute("dwr", false /* no exception */);
259 allowedInactivityTime = (*it)->getAttribute("allowedInactivityTime", false /* no exception */);
260 tcpConnectDelay = (*it)->getAttribute("tcpConnectDelay", false /* no exception */);
261 answersTimeout = (*it)->getAttribute("answersTimeout", false /* no exception */);
262 ceaTimeout = (*it)->getAttribute("ceaTimeout", false /* no exception */);
263 watchdogPeriod = (*it)->getAttribute("watchdogPeriod", false /* no exception */);
264 entity = (*it)->getAttribute("entity", false /* no exception */);
265 entityServerSessions = (*it)->getAttribute("entityServerSessions", false /* no exception */);
266 diameterServer = (*it)->getAttribute("diameterServer", false /* no exception */);
267 diameterServerSessions = (*it)->getAttribute("diameterServerSessions", false /* no exception */);
268 balance = (*it)->getAttribute("balance", false /* no exception */); // (yes | no)
269 sessionBasedModelsClientSocketSelection = (*it)->getAttribute("sessionBasedModelsClientSocketSelection", false /* no exception */); // (SessionIdHighPart | SessionIdOptionalPart | RoundRobin)
270 retries = (*it)->getAttribute("retries", false /* no exception */);
271 log = (*it)->getAttribute("log", false /* no exception */);
272 splitLog = (*it)->getAttribute("splitLog", false /* no exception */); // (yes | no)
273 detailedLog = (*it)->getAttribute("detailedLog", false /* no exception */); // (yes | no)
274 dumpLog = (*it)->getAttribute("dumpLog", false /* no exception */); // (yes | no)
275 burstLog = (*it)->getAttribute("burstLog", false /* no exception */); // (yes | no)
278 realm_nodes_it nodeIt = a_nodes.find(originRealm->getValue());
279 if (nodeIt != a_nodes.end()) {
280 std::string msg = "Already registered node name (Origin-Realm): "; msg += originRealm->getValue();
281 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
284 unsigned int applicationId = appId->getIntegerValue();
285 if (!stackEngine.getDictionary(applicationId)) {
286 std::string msg = "Cannot found a registered stack id with the value of applicationId provided: "; msg += appId->getValue();
287 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
290 // Engine time measures checking & assignment:
291 anna::Millisecond allowedInactivityTimeMs(90000);
292 anna::Millisecond tcpConnectDelayMs(200);
293 anna::Millisecond answersTimeoutMs(10000);
294 anna::Millisecond ceaTimeoutMs(10000);
295 anna::Millisecond watchdogPeriodMs(30000);
297 if (allowedInactivityTime) allowedInactivityTimeMs = checkTimeMeasure("allowedInactivityTime", allowedInactivityTime->getValue());
298 if (tcpConnectDelay) tcpConnectDelayMs = checkTimeMeasure("tcpConnectDelay", tcpConnectDelay->getValue());
299 if (answersTimeout) answersTimeoutMs = checkTimeMeasure("answersTimeout", answersTimeout->getValue());
300 if (ceaTimeout) ceaTimeoutMs = checkTimeMeasure("ceaTimeout", ceaTimeout->getValue());
301 if (watchdogPeriod) watchdogPeriodMs = checkTimeMeasure("watchdogPeriod", watchdogPeriod->getValue());
303 // Checking command line parameters
304 std::string sessionBasedModelsType;
305 if(sessionBasedModelsClientSocketSelection) {
306 sessionBasedModelsType = sessionBasedModelsClientSocketSelection->getValue();
307 if((sessionBasedModelsType != "SessionIdHighPart") && (sessionBasedModelsType != "SessionIdOptionalPart") && (sessionBasedModelsType != "RoundRobin")) {
308 throw anna::RuntimeException("Parameter 'sessionBasedModelsClientSocketSelection' only accepts 'SessionIdHighPart'/'SessionIdOptionalPart'/'RoundRobin' as parameter values", ANNA_FILE_LOCATION);
312 int retransmissions = retries ? retries->getIntegerValue() : 0;
313 if(retransmissions < 0) {
314 throw anna::RuntimeException("Parameter 'retries' must be non-negative", ANNA_FILE_LOCATION);
317 // Create new Node instance /////////////////////////////////////////////////////////////////
318 a_workingNode = new RealmNode(originRealm->getValue(), applicationId, bpd);
319 MyDiameterEngine *commEngine = a_workingNode->getMyDiameterEngine();
320 /////////////////////////////////////////////////////////////////////////////////////////////
323 commEngine->setMaxConnectionDelay(tcpConnectDelayMs);
324 commEngine->setWatchdogPeriod(watchdogPeriodMs);
326 // Realm information:
327 if (originHost) commEngine->setHost(originHost->getValue());
328 commEngine->setRealm(originRealm->getValue());
332 int sessions = entityServerSessions ? entityServerSessions->getIntegerValue() : 1;
335 // Number of sessions:
336 commEngine->setNumberOfClientSessionsPerServer(sessions);
338 // Client CER and DWR
339 std::string cerPathfile = cer ? cer->getValue() : "";
340 std::string dwrPathfile = dwr ? dwr->getValue() : "";
341 commEngine->setClientCERandDWR(cerPathfile, dwrPathfile);
343 // Register one entity for this engine:
344 a_workingNode->createEntity(entity->getValue(), ceaTimeoutMs, answersTimeoutMs);
345 a_workingNode->setRequestRetransmissions(retransmissions);
346 a_workingNode->getEntity()->setSessionBasedModelsType(sessionBasedModelsType);
347 a_workingNode->getEntity()->setBalance(balance ? (balance->getValue() == "yes") : false); // for sendings
348 if (eventOperation) a_workingNode->getEntity()->bind();
354 int sessions = diameterServerSessions ? diameterServerSessions->getIntegerValue() : 1;
355 a_workingNode->startDiameterServer(diameterServer->getValue(), sessions, allowedInactivityTimeMs);
359 if (!allLogsDisabled) {
360 std::string realm = commEngine->getRealm();
361 std::string s_log = realm + ".launcher.log"; if (log) s_log = log->getValue();
362 bool b_splitLog = (splitLog ? (splitLog->getValue() == "yes") : false);
363 bool b_detailedLog = (detailedLog ? (detailedLog->getValue() == "yes") : false);
364 bool b_dumpLog = (dumpLog ? (dumpLog->getValue() == "yes") : false);
365 std::string s_burstLog = realm + ".launcher.burst"; if (burstLog) s_burstLog = burstLog->getValue();
366 a_workingNode->setLogs(s_log, b_splitLog, b_detailedLog, b_dumpLog, s_burstLog);
370 // Lazy initialization for comm engine:
371 if (eventOperation) commEngine->lazyInitialize();
373 // Node and Codec Engine registration ///////////////////////////////////////////////////////
374 a_nodes[originRealm->getValue()] = a_workingNode;
375 /////////////////////////////////////////////////////////////////////////////////////////////
380 a_workingNode = NULL; // by default, mode auto
382 // Diameter comm engines which are loaded after application start (via management operation 'services') are not really started,
383 // but this don't care because application startComponents() -> initialize() -> do_initialize() -> do nothing.
384 // And when stopped, running state is not checked and it will be stopped anyway.
388 void Launcher::loadServices(const std::string & xmlPathFile, bool eventOperation) throw(anna::RuntimeException) {
390 if (xmlPathFile == "null" || xmlPathFile == "") {
391 LOGWARNING(anna::Logger::warning("Ignoring services configuration on start: empty or 'null' string provided as xml file. Use management interface (operation 'services') in order to add services", ANNA_FILE_LOCATION));
396 std::string trace = "Loading ADML services file '";
397 trace += xmlPathFile;
399 anna::Logger::debug(trace, ANNA_FILE_LOCATION);
401 anna::xml::DocumentFile xmlDocument; // has private copy constructor defined but not implemented to avoid inhenrit/copy (is very heavy)
402 anna::xml::DTDMemory xmlDTD;
403 const anna::xml::Node *rootNode;
404 xmlDocument.initialize(xmlPathFile.c_str()); // fail here is i/o error
405 xmlDTD.initialize(ServicesDTD);
407 rootNode = xmlDocument.parse(xmlDTD); // Parsing: fail here if xml violates dtd
409 catch (anna::RuntimeException &ex) {
411 std::string msg = "Services DTD schema:\n\n";
413 anna::Logger::warning(msg, ANNA_FILE_LOCATION);
419 std::string trace = "Loaded XML file (";
420 trace += xmlPathFile;
422 trace += anna::xml::Compiler().apply(rootNode);
423 anna::Logger::debug(trace, ANNA_FILE_LOCATION);
425 servicesFromXML(rootNode, eventOperation);
429 anna::Millisecond Launcher::checkTimeMeasure(const std::string ¶meter, const std::string &value) throw(anna::RuntimeException) {
431 if(anna::functions::isLike("^[0-9]+$", value)) { // para incluir numeros decimales: ^[0-9]+(.[0-9]+)?$
433 std::istringstream ( value ) >> msecs;
435 if(msecs > a_timeEngine->getMaxTimeout()) { // 600000 ms
436 std::string msg = "Configuration value for '";
438 msg += "' ("; msg += value; msg += " msecs) is greater than allowed max timeout for timming engine: ";
439 msg += anna::functions::asString(a_timeEngine->getMaxTimeout());
440 throw RuntimeException(msg, ANNA_FILE_LOCATION);
444 std::string msg = "Configuration value for '";
446 msg += "' ("; msg += value; msg += " msecs) is perhaps very big (over 5 minutes).";
447 LOGWARNING(anna::Logger::warning(msg, ANNA_FILE_LOCATION));
450 if(msecs <= a_timeEngine->getResolution()) {
451 std::string msg = "Configuration value for '";
453 msg += "' ("; msg += value; msg += " msecs) as any other time measure, must be greater than timming engine resolution: ";
454 msg += anna::functions::asString(a_timeEngine->getResolution());
455 throw RuntimeException(msg, ANNA_FILE_LOCATION);
458 return (anna::Millisecond)msecs; // ok
461 // Non-integer exception:
462 std::string msg = "Configuration error for '";
466 msg += "': must be a non-negative integer number";
467 throw RuntimeException(msg, ANNA_FILE_LOCATION);
470 bool Launcher::setWorkingNode(const std::string &name) throw() {
473 realm_nodes_it nodeIt = a_nodes.find(name);
474 if (nodeIt == a_nodes.end()) {
476 std::string msg = "Unknown node with name '"; msg += name; msg += "'. Ignoring ...";
477 anna::Logger::warning(msg, ANNA_FILE_LOCATION);
481 a_workingNode = const_cast<RealmNode*>(nodeIt->second);
488 RealmNode *Launcher::getRealmNode(const std::string &realmName) const throw(anna::RuntimeException) {
489 realm_nodes_it it = a_nodes.find(realmName);
490 if (it != a_nodes.end()) return it->second;
491 throw anna::RuntimeException(anna::functions::asString("There is no realm node registered as '%s' (set Origin-Realm avp correctly or force a specific realm with 'node' operation)", realmName.c_str()), ANNA_FILE_LOCATION);
494 RealmNode *Launcher::getRealmNode(const anna::diameter::codec::Message &message) const throw(anna::RuntimeException) {
495 std::string originRealm = message.getAvp(anna::diameter::helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->getValue();
496 return (getRealmNode(originRealm));
499 void Launcher::updateOperatedRealmNodeWithMessage(const anna::diameter::codec::Message &message) throw(anna::RuntimeException) {
500 if (!a_operatedRealm) // priority for working node by mean 'node' operation
501 a_operatedRealm = getRealmNode(message);
504 RealmNode *Launcher::getOperatedRealm() const throw(anna::RuntimeException) {
506 throw anna::RuntimeException("Realm Node not identified (try to force a specific realm with 'node' operation)", ANNA_FILE_LOCATION);
508 return a_operatedRealm;
511 MyDiameterEntity *Launcher::getOperatedEntity() const throw(anna::RuntimeException) {
512 MyDiameterEntity *result = getOperatedRealm()->getEntity();
514 throw anna::RuntimeException("No entity configured for the operated Realm Node", ANNA_FILE_LOCATION);
518 MyLocalServer *Launcher::getOperatedServer() const throw(anna::RuntimeException) {
519 MyLocalServer *result = getOperatedRealm()->getDiameterServer();
521 throw anna::RuntimeException("No local server configured for the operated Realm Node", ANNA_FILE_LOCATION);
525 MyDiameterEngine *Launcher::getOperatedEngine() const throw(anna::RuntimeException) {
526 return getOperatedRealm()->getMyDiameterEngine(); // never will be NULL
529 void Launcher::initialize()
530 throw(anna::RuntimeException) {
531 anna::comm::Application::initialize();
532 CommandLine& cl(anna::CommandLine::instantiate());
533 anna::comm::Communicator::WorkMode::_v workMode(anna::comm::Communicator::WorkMode::Single);
534 a_communicator = new MyCommunicator(workMode);
535 a_timeEngine = new anna::timex::Engine((anna::Millisecond)600000, a_admlMinResolution);
536 TestManager::instantiate().setTimerController(a_timeEngine);
538 // Counters record procedure:
539 const char *varname = "cntRecordPeriod";
540 anna::Millisecond cntRecordPeriod = (cl.exists(varname)) ? checkTimeMeasure(varname, cl.getValue(varname)) : (anna::Millisecond)300000;
541 if(cntRecordPeriod != 0) {
542 a_counterRecorderClock = new MyCounterRecorderClock("Counters record procedure clock", cntRecordPeriod); // clock
543 std::string cntDir = ".";
544 if(cl.exists("cntDir")) cntDir = cl.getValue("cntDir");
545 a_counterRecorder = new MyCounterRecorder(cntDir + anna::functions::asString("/Counters.Pid%d", (int)getPid()));
548 // Testing framework:
549 std::string tmDir = ".";
550 if(cl.exists("tmDir")) tmDir = cl.getValue("tmDir");
551 TestManager::instantiate().setReportsDirectory(tmDir);
554 if(cl.exists("trace"))
555 anna::Logger::setLevel(anna::Logger::asLevel(cl.getValue("trace")));
557 // Load launcher services:
558 loadServices(cl.getValue("services")); // before run (have components to be created)
562 throw(anna::RuntimeException) {
563 LOGMETHOD(anna::TraceMethod tm("Launcher", "run", ANNA_FILE_LOCATION));
564 CommandLine& cl(anna::CommandLine::instantiate());
565 anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate();
568 a_start_time.setNow();
570 anna::statistics::Engine::instantiate().enable();
573 // Help on startup traces:
574 anna::Logger::information(help(), ANNA_FILE_LOCATION);
575 // Test messages dtd:
576 std::string msg = "\n ------------- TESTMESSAGES DTD -------------\n";
577 msg += anna::diameter::codec::MessageDTD;
578 anna::Logger::information(msg, ANNA_FILE_LOCATION);
582 if(cl.exists("httpServer")) {
583 anna::comm::Network& network = anna::comm::Network::instantiate();
586 anna::functions::getAddressAndPortFromSocketLiteral(cl.getValue("httpServer"), address, port);
587 //const anna::comm::Device* device = network.find(Device::asAddress(address)); // here provide IP
588 const anna::comm::Device* device = *((network.resolve(address)->device_begin())); // trick to solve
589 a_httpServerSocket = new anna::comm::ServerSocket(anna::comm::INetAddress(device, port), cl.exists("httpServerShared") /* shared bind */, &anna::http::Transport::getFactory());
592 ///////////////////////////////
593 // Diameter library COUNTERS //
594 ///////////////////////////////
595 anna::diameter::comm::OamModule & oamDiameterComm = anna::diameter::comm::OamModule::instantiate();
596 oamDiameterComm.initializeCounterScope(1); // 1000 - 1999
597 oamDiameterComm.enableCounters();
598 oamDiameterComm.enableAlarms();
599 anna::diameter::codec::OamModule & oamDiameterCodec = anna::diameter::codec::OamModule::instantiate();
600 oamDiameterCodec.initializeCounterScope(2); // 2000 - 2999
601 oamDiameterCodec.enableCounters();
602 oamDiameterCodec.enableAlarms();
607 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceived, "" /* get defaults for enum type*/, 0 /*1000*/);
608 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceived, "", 1 /*1001*/);
609 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceivedOnClientSession, "", 2 /*1002*/);
610 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnClientSession, "", 3 /*1003*/);
611 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestReceivedOnServerSession, "", 4 /* etc. */);
612 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnServerSession, "", 5);
613 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOK, "", 6);
614 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentNOK, "", 7);
615 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOK, "", 8);
616 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentNOK, "", 9);
617 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionOK, "", 10);
618 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionNOK, "", 11);
619 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnClientSessionOK, "", 12);
620 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnClientSessionNOK, "", 13);
621 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionOK, "", 14);
622 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionNOK, "", 15);
623 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnServerSessionOK, "", 16);
624 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerSentOnServerSessionNOK, "", 17);
625 /* Diameter Base (capabilities exchange & keep alive) */
627 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERSentOK, "", 18);
628 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERSentNOK, "", 19);
629 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEAReceived, "", 20);
630 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRSentOK, "", 21);
631 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRSentNOK, "", 22);
632 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWAReceived, "", 23);
633 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRSentOK, "", 24);
634 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRSentNOK, "", 25);
635 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPAReceived, "", 26);
637 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CERReceived, "", 27);
638 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEASentOK, "", 28);
639 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CEASentNOK, "", 29);
640 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWRReceived, "", 30);
641 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWASentOK, "", 31);
642 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DWASentNOK, "", 32);
643 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPRReceived, "", 33);
644 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPASentOK, "", 34);
645 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::DPASentNOK, "", 35);
646 /* server socket operations (enable/disable listening port for any local server) */
647 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::ServerSocketsOpened, "", 36);
648 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::ServerSocketsClosed, "", 37);
651 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnableToDeliverOverEntity, "", 38);
652 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverClientSession, "", 39);
653 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverClientSession, "", 40);
654 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverServer, "", 41);
655 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverServer, "", 42);
656 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEntity, "", 43);
657 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEntity, "", 44);
658 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEngineForEntities, "", 45);
659 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEngineForEntities, "", 46);
661 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnableToDeliverToClient, "", 47);
662 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostConnectionForServerSession, "", 48);
663 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::UnbindConnectionForServerSessionDueToInactivityTimeAnomaly, "", 49);
664 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::CreatedConnectionForServerSession, "", 50);
665 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverLocalServer, "", 51);
666 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverLocalServer, "", 52);
667 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::LostAvailabilityOverEngineForLocalServers, "", 53);
668 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RecoveredAvailabilityOverEngineForLocalServers, "", 54);
669 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentExpired, "", 55);
670 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnClientSessionExpired, "", 56);
671 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestSentOnServerSessionExpired, "", 57);
672 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmitted, "", 58);
673 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmittedOnClientSession, "", 59);
674 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::RequestRetransmittedOnServerSession, "", 60);
675 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedUnknown, "", 61);
676 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnClientSessionUnknown, "", 62);
677 oamDiameterComm.registerCounter(anna::diameter::comm::OamModule::Counter::AnswerReceivedOnServerSessionUnknown, "", 63);
682 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength, "", 0 /*2000*/);
683 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__IncoherenceBetweenActivatedVBitAndZeroedVendorIDValueReceived, "", 1 /*2001*/);
684 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__IncorrectLength, "", 2 /*2002*/);
685 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__DataPartInconsistence, "", 3 /*2003*/);
686 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpDecode__UnknownAvpWithMandatoryBit, "", 4 /*2004*/);
687 /* Message decoding */
688 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageHeaderLength, "", 5 /*2005*/);
689 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageLength, "", 6 /*2006*/);
691 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpValidation__EnumeratedAvpWithValueDoesNotComplyRestriction, "", 10 /*2010*/);
692 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::AvpValidation__AvpFlagsDoesNotFulfillTheDefinedFlagRules, "", 11 /*2011*/);
693 /* Message validation */
694 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageValidation__UnknownOperationUnableToValidate, "", 12 /*2012*/);
695 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::MessageValidation__OperationHaveIncoherentFlags, "", 13 /*2013*/);
696 /* Level validation */
697 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__MissingFixedRule, "", 14 /*2014*/);
698 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinality, "", 15 /*2015*/);
699 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinalityLessThanNeeded, "", 16 /*2016*/);
700 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedRuleForCardinalityMoreThanNeeded, "", 17 /*2017*/);
701 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FailedGenericAvpRuleForCardinalityFoundDisregardedItem, "", 18 /*2018*/);
702 oamDiameterCodec.registerCounter(anna::diameter::codec::OamModule::Counter::LevelValidation__FoundDisregardedItemsAndGenericAVPWasNotSpecified, "", 19 /*2019*/);
705 /////////////////////////////////
706 // Counter recorder associated //
707 /////////////////////////////////
708 if(a_counterRecorderClock) {
709 oamDiameterComm.setCounterRecorder(a_counterRecorder);
710 oamDiameterCodec.setCounterRecorder(a_counterRecorder);
711 anna::diameter::comm::ApplicationMessageOamModule::instantiate().setCounterRecorder(a_counterRecorder);
712 a_timeEngine->activate(a_counterRecorderClock); // start clock
715 // Log statistics concepts
716 if(cl.exists("logStatisticSamples")) {
717 std::string list = cl.getValue("logStatisticSamples");
718 anna::statistics::Engine &statEngine = anna::statistics::Engine::instantiate();
721 if(statEngine.enableSampleLog(/* -1: all concepts */))
722 LOGDEBUG(anna::Logger::debug("Sample log activation for all statistic concepts", ANNA_FILE_LOCATION));
725 lst.apply(cl.getValue("logStatisticSamples"), ",");
727 if(lst.size() >= 1) {
728 anna::Tokenizer::const_iterator tok_min(lst.begin());
729 anna::Tokenizer::const_iterator tok_max(lst.end());
730 anna::Tokenizer::const_iterator tok_iter;
733 for(tok_iter = tok_min; tok_iter != tok_max; tok_iter++) {
734 conceptId = atoi(anna::Tokenizer::data(tok_iter));
736 if(statEngine.enableSampleLog(conceptId))
737 LOGDEBUG(anna::Logger::debug(anna::functions::asString("Sample log activation for statistic concept id = %d", conceptId), ANNA_FILE_LOCATION));
744 // Start client connections //////////////////////////////////////////////////////////////////////////////////
745 MyDiameterEntity *entity;
746 for (realm_nodes_it it = a_nodes.begin(); it != a_nodes.end(); it++) {
747 entity = it->second->getEntity();
748 if (entity) entity->bind();
751 // Go into communicator poll
752 // Reconnection period (tcp reconnect retry time):
753 const char *varname = "reconnectionPeriod";
754 anna::Millisecond reconnectionPeriod = (cl.exists(varname)) ? checkTimeMeasure(varname, cl.getValue(varname)) : (anna::Millisecond)10000;
756 a_communicator->setRecoveryTime(reconnectionPeriod);
757 if(cl.exists("httpServer")) a_communicator->attach(a_httpServerSocket); // HTTP
758 a_communicator->accept();
762 bool Launcher::getDataBlockFromHexFile(const std::string &pathfile, anna::DataBlock &db) const throw() {
764 static char buffer[8192];
765 std::ifstream infile(pathfile.c_str(), std::ifstream::in);
767 if(infile.is_open()) {
769 std::string hexString(buffer, strlen(buffer));
770 // Allow colon separator in hex string: we have to remove them before processing with 'fromHexString':
771 hexString.erase(std::remove(hexString.begin(), hexString.end(), ':'), hexString.end());
773 std::string msg = "Hex string (remove colons if exists): ";
775 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
777 anna::functions::fromHexString(hexString, db);
786 void Launcher::resetStatistics() throw() {
788 a_workingNode->getMyDiameterEngine()->resetStatistics();
791 for (realm_nodes_it it = a_nodes.begin(); it != a_nodes.end(); it++) {
792 it->second->getMyDiameterEngine()->resetStatistics();
797 void Launcher::resetCounters() throw() {
798 anna::diameter::comm::OamModule::instantiate().resetCounters();
799 anna::diameter::comm::ApplicationMessageOamModule::instantiate().resetCounters();
800 anna::diameter::codec::OamModule::instantiate().resetCounters();
803 void Launcher::signalUSR2() throw(anna::RuntimeException) {
805 std::string msg = "Captured signal SIGUSR2. Reading tasks at '";
806 msg += SIGUSR2_TASKS_INPUT_FILENAME;
807 msg += "' (results will be written at '";
808 msg += SIGUSR2_TASKS_OUTPUT_FILENAME;
810 anna::Logger::notice(msg, ANNA_FILE_LOCATION);
815 std::string response_content;
816 std::ifstream in_file(SIGUSR2_TASKS_INPUT_FILENAME);
817 std::ofstream out_file(SIGUSR2_TASKS_OUTPUT_FILENAME);
819 if(!in_file.is_open()) throw RuntimeException("Unable to read tasks", ANNA_FILE_LOCATION);
820 if(!out_file.is_open()) throw RuntimeException("Unable to write tasks", ANNA_FILE_LOCATION);
822 while(getline(in_file, line)) {
824 std::string msg = "Processing line: ";
826 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
830 eventOperation(line, response_content);
831 } catch(RuntimeException &ex) {
835 out_file << response_content << "\n";
843 std::string Launcher::help() const throw() {
844 std::string result = "\n";
845 result += "\n ------------- HELP -------------\n";
847 result += "\nOVERVIEW";
848 result += "\n--------";
850 result += "\nThe ADML (ANNA Diameter Multirealm Launcher) process is a multi-realm node with client and server";
851 result += "\n capabilities as well as balancer (proxy) features. It could be used as diameter server (i.e. to";
852 result += "\n simulate PCRF nodes, OCS systems, etc.), as diameter client (GGSNs, DPIs, etc.), and balancer";
853 result += "\n systems to provide failover to external round-robin launchers. Also, auxiliary encoder/decoder/loader";
854 result += "\n function could be deployed to reinterpret certain external flow and send it to another process.";
856 result += "\nThe ANNA::diameter_comm built-in module provides a great set of characteristics as multiple connections";
857 result += "\n on both server and client side, definition for multiple-server entities (and not only two as standard";
858 result += "\n establish as minimum), separate statistics analyzer per each resource, automatic CER/CEA and DWR/DWA";
859 result += "\n generation, expiration control and many more features.";
861 result += "\nThe ADML process can easily configure a many realm nodes as needed, which will have own endpoints.";
862 result += "\nYou should avoid loop configurations (client and server for that client) because automatic forwarding,";
863 result += "\n is implemented and this would get in a never ending cycle when a request is sent.";
865 result += "\nProcess traces are dump on \"launcher.trace\" and could have any trace level (POSIX levels), usually";
866 result += "\n 'debug' or 'warning'. See ANNA documentation for more details.";
868 result += "\nAs any other ANNA process, context dump could be retrieved sending SIGUSR1 signal:";
869 result += "\n kill -10 <pid>";
871 result += "\n kill -s SIGUSR1 <pid>";
872 result += "\n and then";
873 result += "\n vi /var/tmp/anna.context.<pid>";
875 result += "\nA complete xml report will show all the context information (counters, alarms, statistics,";
876 result += "\n handlers, diameter stacks, etc.), and a powerful log module could dump all the events";
877 result += "\n processed and flow information. Statistics could be analized at context dump and optionally";
878 result += "\n written to disk as sample files (useful for graphs and spreadsheet reports) with all the";
879 result += "\n measurements.";
881 result += "\nAlso SIGUSR2 is handled for management purposes. We will talk later about this.";
884 result += "\nCOMMAND LINE";
885 result += "\n------------";
887 result += "\nStart the launcher process without arguments in order to see all the startup configuration";
888 result += "\n posibilities, many of which could be modified on the air through the management interface";
889 result += "\n (we will talk later about this great feature). There is only one mandatory parameter which";
890 result += "\n is the services definition: --services <services xml file>. You must follow the dtd schema";
891 result += "\n to build a valid services xml file. Some basic examples are:";
893 result += "\nClient configuration:";
895 result += "\n<services>";
896 result += "\n <!-- Stacks -->";
897 result += "\n <stack id=\"0\" dictionary=\"dictionary.xml\"/>";
899 result += "\n <!-- Nodes -->";
900 result += "\n <node originRealm=\"ADML-client\" applicationId=\"0\" entity=\"localhost:3868\"/>";
901 result += "\n</services>";
903 result += "\nServer configuration:";
905 result += "\n<services>";
906 result += "\n <!-- Stacks -->";
907 result += "\n <stack id=\"0\" dictionary=\"dictionary.xml\"/>";
909 result += "\n <!-- Nodes -->";
910 result += "\n <node originRealm=\"ADML-server\" applicationId=\"0\" diameterServer=\"localhost:3868\"/>";
911 result += "\n</services>";
913 result += "\nIf you act as a proxy or a translation agent, you need to combine both former setups, and probably";
914 result += "\n will need to program the answers to be replied through the operations interface. To balance the";
915 result += "\n traffic at your client side you shall use '--balance' and '--sessionBasedModelsClientSocketSelection'";
916 result += "\n arguments in order to define the balancing behaviour. To make hybrid setups you only must mix the realms:";
918 result += "\nClient and server configuration:";
920 result += "\n<services>";
921 result += "\n <!-- Stacks -->";
922 result += "\n <stack id=\"16777236\" dictionary=\"dictionary_Rx.xml\"/>";
923 result += "\n <stack id=\"16777238\" dictionary=\"dictionary_Gx.xml\"/>";
924 result += "\n <stack id=\"0\" dictionary=\"dictionary_base.xml\"/>";
926 result += "\n <!-- Nodes -->";
927 result += "\n <node originRealm=\"ADML-Rx-client\" applicationId=\"16777236\" entity=\"localhost:3868\" cer=\"cer_Rx.xml\"/>";
928 result += "\n <node originRealm=\"ADML-Gx-client\" applicationId=\"16777238\" entity=\"localhost:3868\" cer=\"cer_Gx.xml\"/>";
929 result += "\n</services>";
932 result += "\nThe process builds automatically CER and DWR messages as a client, but you could specify your own";
933 result += "\n as shown in the hybrid former example. Note that the base protocol stack must be registered because";
934 result += "\n the configuration corresponds to a multistack process which change the stack using the application-id";
935 result += "\n processed (0 in the case of base protocol messages: CER, CEA, DWR, DWA, DPR, DPA).";
937 result += "\nDYNAMIC OPERATIONS";
938 result += "\n------------------";
940 result += "\nADML supports several operations which could be reconized via HTTP interface or SIGUSR2 caugh.";
941 result += "\nAn operation is specified by mean a string containing the operation name and needed arguments";
942 result += "\n separated by pipes. These are the available commands:";
944 result += "\n--------------------------------------------------------------------------------------- General purpose";
946 result += "\nhelp This help.";
948 result += "\n--------------------------------------------------------------------------------------- Node management";
950 result += "\nnode[|<name>] Selects a context working node by mean a registered name.";
951 result += "\n All the subsequent operations will be forced to work with";
952 result += "\n this node, which makes possible some rare scenarios like";
953 result += "\n sending unexpected messages on remote peers. This is also";
954 result += "\n useful for some operations in order to restrict the scope";
955 result += "\n of action (statistics, communication visibility, etc.).";
956 result += "\n Empty parameter will show the current configuration.";
958 result += "\nnode_auto Returns to the default behaviour (smart node selection).";
959 result += "\n Depending on the operation, this could imply a global";
960 result += "\n action scope, affecting to all the registered realms.";
961 result += "\n This should be the normal configuration. Take into";
962 result += "\n account that if you fix the working node, this could";
963 result += "\n affect to things like test programming: communication";
964 result += "\n resources will override those which would be inferred";
965 result += "\n from programmed messages Origin-Realm avps.";
967 result += "\n------------------------------------------------------------------------------------ Parsing operations";
969 result += "\ncode|<source_file>|<target_file> Encodes source file (pathfile) into target file (pathfile).";
970 result += "\ndecode|<source_file>|<target_file> Decodes source file (pathfile) into target file (pathfile).";
971 result += "\nloadxml|<source_file> Reinterpret xml source file (pathfile).";
973 result += "\n------------------------------------------------------------------------------------------- Hot changes";
975 result += "\nservices[|source file] Adds and starts the services specified in the xml file provided.";
976 result += "\n (if missing, the file 'services.xml' will be used). This is used";
977 result += "\n to load new nodes once the ADML is started, regardless if command";
978 result += "\n line '--services' parameter was used or not. Those services which";
979 result += "\n are not correctly loaded will be ignored to keep the process alive.";
980 result += "\n If you need to load services as deltas, you must firstly load the";
981 result += "\n diameter base dictionary with stack id 0, because all the realms";
982 result += "\n will use this dictionary to encode/decode base protocol messages";
983 result += "\n managed by the communication engine.";
985 result += "\ndiameterServerSessions|<integer> Updates the maximum number of accepted connections to diameter";
986 result += "\n server socket.";
987 result += "\ncontext[|target file] Application context could also be written by mean this operation,";
988 result += "\n and not only through SIGUSR1. If optional path file is missing,";
989 result += "\n default '/var/tmp/anna.context.<pid>' will be used.";
990 result += "\ncollect Reset statistics and counters to start a new test stage of";
991 result += "\n performance measurement. Context data can be written at";
992 result += "\n '/var/tmp/anna.context.<pid>' by mean 'kill -10 <pid>'.";
993 result += "\n or sending operation 'context|[target file]'.";
994 result += "\n This operation applies over all the registered realm nodes";
995 result += "\n except if one specific working node has been set.";
996 result += "\nforceCountersRecord Forces dump to file the current counters of the process.";
997 result += "\nshow-oam Dumps current counters of the process. This is also done at";
998 result += "\n process context dump.";
999 result += "\nshow-stats Dumps statistics of the process. This is also done at process";
1000 result += "\n context dump.";
1002 result += "\n<visibility action>[|<address>:<port>][|socket id]";
1004 result += "\n Actions: hide, show (update state) and hidden, shown (query state).";
1005 result += "\n Acts over a client session for messages delivery (except CER/A, DWR/A, DPR/A).";
1006 result += "\n If missing server (first parameter) all applications sockets will be affected.";
1007 result += "\n If missing socket (second parameter) for specific server, all its sockets will be affected.";
1009 result += "\n All application client sessions are shown on startup, but standard delivery only use primary";
1010 result += "\n server ones except if fails. Balance configuration use all the allowed sockets. You could also";
1011 result += "\n use command line 'sessionBasedModelsClientSocketSelection' to force traffic flow over certain";
1012 result += "\n client sessions, but for this, hide/show feature seems easier.";
1014 result += "\n--------------------------------------------------------------------------------------- Flow operations";
1016 result += "\nsendxml2e|<source_file> Sends xml source file (pathfile) through configured entity.";
1017 result += "\nsendxml2c|<source_file> Sends xml source file (pathfile) to client.";
1018 result += "\nanswerxml2e[|source_file] Answer xml source file (pathfile) for incoming request with same code from entity.";
1019 result += "\n The answer is stored in a FIFO queue for a specific message code, then there are";
1020 result += "\n as many queues as different message codes have been programmed.";
1021 result += "\nanswerxml2c[|source_file] Answer xml source file (pathfile) for incoming request with same code from client.";
1022 result += "\n The answer is stored in a FIFO queue for a specific message code, then there are";
1023 result += "\n as many queues as different message codes have been programmed.";
1024 result += "\nanswerxml<2e/2c> List programmed answers (to entity/client) if no parameter provided.";
1025 result += "\nanswerxml<2e/2c>|dump Write programmed answers (to entity/client) to file 'programmed_answer.<message code>.<sequence>',";
1026 result += "\n where 'sequence' is the order of the answer in each FIFO code-queue of programmed answers.";
1027 result += "\nanswerxml<2e/2c>|clear Clear programmed answers (to entity/client).";
1028 result += "\nanswerxml<2e/2c>|exhaust Disable the corresponding queue rotation, which is the default behaviour.";
1029 result += "\nanswerxml<2e/2c>|rotate Enable the corresponding queue rotation, useful in performance tests.";
1030 result += "\n Rotation consists in add again to the queue, each element retrieved for answering.";
1032 result += "\nSend operations are available using hexadecimal content (hex formatted files) which also allow to test";
1033 result += "\nspecial scenarios (protocol errors):";
1035 result += "\nsendhex2e|<source_file> Sends hex source file (pathfile) through configured entity.";
1036 result += "\nsendhex2c|<source_file> Sends hex source file (pathfile) to client.";
1038 result += "\nAnswer programming in hexadecimal is not really neccessary (you could use send primitives) and also";
1039 result += "\n is intended to be used with decoded messages in order to replace things like hop by hop, end to end,";
1040 result += "\n subscriber id, session id, etc. Anyway you could use 'decode' operation and then program the xml created.";
1042 result += "\nIf a request is received, answer map (built with 'answerxml<2e/2c>' operations) will be";
1043 result += "\n checked to find a corresponding programmed answer to be replied(*). If no ocurrence is found,";
1044 result += "\n or answer message was received, the message is forwarded to the other side (entity or client),";
1045 result += "\n or nothing but trace when no peer at that side is configured. Answer to client have sense when";
1046 result += "\n diameter server socket is configured, answer to entity have sense when entity does.";
1048 result += "\nIn the most complete situation (process with both client and server side) there are internally";
1049 result += "\n two maps with N FIFO queues, one for each different message code within programmed answers.";
1050 result += "\nOne map is for answers towards the client, and the other is to react entity requests. Then in";
1051 result += "\n each one we could program different answers corresponding to different request codes received.";
1053 result += "\n(*) sequence values (hop-by-hop and end-to-end), Session-Id and Subscription-Id avps, are mirrored";
1054 result += "\n to the peer which sent the request. If user wants to test a specific answer without changing it,";
1055 result += "\n use sendxml<2e/2c>/sendhex<2e/2c> operations better than programming.";
1057 result += "\nBalance ('--balance' command line parameter) could be used to forward server socket receptions through";
1058 result += "\n entity servers by mean a round-robin algorithm. Both diameter server socket and entity targets should";
1059 result += "\n have been configured, that is to say: launcher acts as client and server. If no balance is used, an";
1060 result += "\n standard delivery is performed: first primary entity server, secondary when fails, etc.";
1062 result += "\n--------------------------------------------------------------------------- Processing types (log tags)";
1064 result += "\nUsed as log file extensions (when '--splitLog' is provided on command line) and context preffixes on log";
1065 result += "\n details when unique log file is dumped:";
1067 result += "\n [sent2e/send2eError] Send to entity (success/error)";
1068 result += "\n [sent2c/send2cError] Send to client (success/error)";
1069 result += "\n [fwd2e/fwd2eError] Forward to entity a reception from client (success/error)";
1070 result += "\n [fwd2c/fwd2cError] Forward to client a reception from entity (success/error)";
1071 result += "\n [recvfc] Reception from client";
1072 result += "\n [recvfe] Reception from entity";
1073 result += "\n [req2c-expired] A request sent to client has been expired";
1074 result += "\n [req2e-expired] A request sent to entity has been expired";
1075 result += "\n [recvfc-ans-unknown] Reception from client of an unknown answer (probably former [req2c-expired]";
1076 result += "\n has been logged)";
1077 result += "\n [recvfe-ans-unknown] Reception from entity of an unknown answer (probably former [req2e-expired]";
1078 result += "\n has been logged)";
1079 result += "\n [retry] Request retransmission";
1081 result += "\n------------------------------------------------------------------------------------------- Burst tests";
1083 result += "\nIn order to simplify user experience, burst category operations are only allowed in single realm node";
1084 result += "\n configuration. Indeed, you could send messages with incorrect Origin-Realm, and no warning is shown.";
1085 result += "\nAll the operations are performed through the unique realm: if you need to use more interfaces, you may";
1086 result += "\n launch different ADML instances. Is nonsense to allow burst in a multi-realm configured ADML, because";
1087 result += "\n this feature is not able to coordinate the messages.";
1089 result += "\nburst|<action>[|parameter] Used for performance testing, we first program diameter requests";
1090 result += "\n messages in order to launch them from client side to the configured";
1091 result += "\n diameter entity. We could start the burst with an initial load";
1092 result += "\n (non-asynchronous sending), after this, a new request will be sent";
1093 result += "\n per answer received or expired context. There are 10 actions: clear,";
1094 result += "\n load, start, push, pop, stop, repeat, send, goto and look.";
1096 result += "\n burst|clear Clears all loaded burst messages.";
1097 result += "\n burst|load|<source_file> Loads the next diameter message into launcher burst.";
1098 result += "\n burst|start|<initial load> Starts (or restarts if already in progress) the message sending with";
1099 result += "\n a certain initial load.";
1100 result += "\n burst|push|<load amount> Sends specific non-aynchronous load.";
1101 result += "\n burst|pop|<release amount> Skip send burst messages in order to reduce over-the-air requests.";
1102 result += "\n Popping all OTA requests implies burst stop because no more answer";
1103 result += "\n will arrive to the process. Burst output file (--burstLog command";
1104 result += "\n line parameter) shows popped messages with crosses (x). Each cross";
1105 result += "\n represents one received answer for which no new request is sent.";
1106 result += "\n burst|stop Stops the burst cycle. You can resume pushing 1 load amount.";
1107 result += "\n burst|repeat[|[yes]|no] Restarts the burst launch when finish. If initial load or push load";
1108 result += "\n amount is greater than burst list size, they will be limited when";
1109 result += "\n the list is processed except when repeat mode is enabled.";
1110 result += "\n burst|send|<amount> Sends messages from burst list. The main difference with start/push";
1111 result += "\n operations is that burst won't be awaken. Externally we could control";
1112 result += "\n sending time (no request will be sent for answers).";
1113 result += "\n burst|goto|<order> Updates current burst pointer position.";
1114 result += "\n burst|look[|order] Show programmed burst message for order provided, current when missing.";
1116 result += "\n-------------------------------------------------------------------------------------- Advanced testing";
1118 result += "\n Burst mode only allows single interface interaction. For multiple interface";
1119 result += "\n (realm) coordination, you could use the advanced test cases programming:";
1122 result += "\n test|<id>|<command>[|parameters]";
1124 result += "\n Adds a new step to the test case with provided identifier. If provided identifier";
1125 result += "\n is not registered yet, a new test case will be created with that value and the";
1126 result += "\n step will be added as the first. For a specific 'id', the steps are stored in";
1127 result += "\n order as they are programmed. Check possible runtime exceptions when adding a";
1128 result += "\n new step because those which fail, will be ignored/skipped during test case";
1129 result += "\n programming giving an incomplete sequence invalid for the testing purpose.";
1131 result += "\n <id>: integer number, normally monotonically increased for each test case. Some external";
1132 result += "\n script/procedure shall clone a test case template in order to build a collection";
1133 result += "\n of independent and coherent test cases (normally same type) with different context";
1134 result += "\n values (Session-Id, Subscriber-Id, etc.).";
1136 result += "\n <command>: commands to be executed for the test id provided. Each command programmed";
1137 result += "\n constitutes a test case 'step', numbered from 1 to N.";
1139 result += "\n timeout|<msecs> Sets an asynchronous timer to restrict the maximum timeout";
1140 result += "\n until last test step. Normally, this command is invoked";
1141 result += "\n in the first step, anyway it measures the time from the";
1142 result += "\n execution point whatever it is. The expiration will abort";
1143 result += "\n the test if still running. One or more timeouts could be";
1144 result += "\n programmed (not usual), but the more restrict will apply.";
1145 result += "\n It is highly recommended to program a initial timeout step,";
1146 result += "\n or the test case could be eternally in-progress.";
1148 result += "\n sendxml2e|<source_file>[|<step number>]";
1149 result += "\n Sends xml source file (pathfile) to entity (it would be a";
1150 result += "\n 'forward' event if it came through local server endpoint).";
1151 result += "\n The step number should be provided for answers to indicate";
1152 result += "\n the 'wait for request' corresponding step. If you miss this";
1153 result += "\n reference, the sequence information (hop-by-hop, end-to-end)";
1154 result += "\n will be sent as they are in the answer xml message (realize";
1155 result += "\n the difficulty of predicting these information). Be sure to";
1156 result += "\n refer to a 'wait for request' step. Conditions like 'regexp'";
1157 result += "\n (as we will see later) are not verified.";
1159 result += "\n sendxml2c|<source_file>[|<step number>]";
1160 result += "\n Sends xml source file (pathfile) to client (it would be a";
1161 result += "\n 'forward' event if it came through remote server endpoint).";
1162 result += "\n Same commented for 'sendxml2e' regarding the step number.";
1164 result += "\n delay|<msecs> Blocking step until the time lapse expires. Useful to give ";
1165 result += "\n some cadence control and time schedule for a specific case.";
1166 result += "\n A value of 0 could be used as a dummy step.";
1167 result += "\n wait<fe/fc>|<condition> Blocking step until condition is fulfilled. The message could";
1168 result += "\n received from entity (waitfe) or from client (waitfc).";
1170 result += "\n wait<fe/fc>-regexp|<regexp>";
1171 result += "\n Wait condition, from entity (waitfe-regexp) or client (waitfc-regexp)";
1172 result += "\n to match the serialized xml content for received messages. CPU cost";
1173 result += "\n is bigger than the former ones because the whole message must be";
1174 result += "\n decoded and converted to xml instead of doing a direct hexadecimal";
1175 result += "\n buffer search. The main advantage is the great flexibility to identify";
1176 result += "\n any content with a regular expression.";
1178 result += "\n sh-command|<script> External execution for script/executable via shell through a dedicated";
1179 result += "\n thread, providing the command and parameters. You could use dynamic";
1180 result += "\n variables ##<tag> to have more flexibility:";
1181 result += "\n Test pool cycle id: "; result += SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID;
1182 result += "\n Test case id: "; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID;
1183 result += "\n Test step id: "; result += SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID;
1185 result += "\n For example, your command could be something like this:";
1186 result += "\n insert_sql_"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID; result += ".sh -db dbname --verbose";
1187 result += "\n > /tmp/cycle-"; result += SH_COMMAND_TAG_FOR_REPLACE__CYCLE_ID;
1188 result += ".testcase-"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTCASE_ID;
1189 result += ".teststep-"; result += SH_COMMAND_TAG_FOR_REPLACE__TESTSTEP_ID;
1191 result += "\n Try to redirect stdout and stderr to avoid ADML output contamination";
1192 result += "\n with the possible outputs from the scripts. You could also put your";
1193 result += "\n job in background although sh-command will return 0-value immediately.";
1195 result += "\n <condition>: Optional parameters which must be fulfilled to continue through the next step.";
1196 result += "\n Any received message over diameter interfaces will be evaluated against the";
1197 result += "\n corresponding test case starting from the current step until the first one";
1198 result += "\n whose condition is fulfilled. If no condition is fulfilled the event will be";
1199 result += "\n classified as 'uncovered' (normally a test case bad configuration, or perhaps";
1200 result += "\n a real unexpected message).";
1203 // result += "\n The way to identify the test case, is through registered Session-Id values for";
1204 // result += "\n programmed requests. But this depends on the type of node. Acting as clients,";
1205 // result += "\n requests received have Session-Id values which are already registered with";
1206 // result += "\n one test case, causing an error if not found. Acting as servers, requests are";
1207 // result += "\n received over a diameter local server from a client which are generating that";
1208 // result += "\n Session-Id values. Then we know nothing about such values. The procedure in";
1209 // result += "\n this case is find out a test case not-started containing a condition which";
1210 // result += "\n comply with the incoming message, and reactivates it.";
1211 // The other solution: register Session-Id values for answers send to client from a local diameter server.
1213 result += "\n How to answer: a wait condition for a request will store the incoming message";
1214 result += "\n which fulfills that condition. This message is useful together with the peer";
1215 result += "\n connection source in a further send step configured with the corresponding";
1216 result += "\n response. You could also insert a delay between wait and send steps to be";
1217 result += "\n more realistic (processing time simulation in a specific ADML realm node).";
1218 result += "\n Always, a response send step will get the needed information from the most";
1219 result += "\n recent wait step finding in reverse order (note that some race conditions";
1220 result += "\n could happen if your condition is not specific enough).";
1223 result += "\n Condition format:";
1225 result += "\n [code]|[bitR]|[hopByHop]|[applicationId]|[sessionId]|[resultCode]|[msisdn]|[imsi]|[serviceContextId]";
1227 result += "\n code: integer number";
1228 result += "\n bitR: 1 (request), 0 (answer)";
1229 result += "\n hopByHop: integer number or request send step reference: #<step number>";
1231 result += "\n Using the hash reference, you would indicate a specific wait condition";
1232 result += "\n for answers. The step number provided must correspond to any of the";
1233 result += "\n previous send commands (sendxml2e/sendxml2c) configured for a request.";
1234 result += "\n This 'hop-by-hop' variant eases the wait condition for answers in the";
1235 result += "\n safest way.";
1237 result += "\n applicationId: integer number";
1238 result += "\n sessionId: string";
1239 result += "\n resultCode: integer number";
1240 result += "\n msisdn: string";
1241 result += "\n imsi: string";
1242 result += "\n serviceContextId: string";
1244 result += "\n Take into account these rules, useful in general:";
1246 result += "\n - Be as much specific as possible defining conditions to avoid ambiguity sending";
1247 result += "\n messages out of context due to race conditions. Although you could program several";
1248 result += "\n times similar conditions, some risky practices will throw a warning trace (if you";
1249 result += "\n repeat the same condition within the same test case).";
1250 result += "\n - Adding a ResultCode and/or HopByHop to the condition are only valid waiting answers.";
1251 result += "\n - Requests hop-by-hop values must be different for all the test case requests.";
1252 result += "\n RFC says that a hop by hop must be unique for a specific connection, something that";
1253 result += "\n could be difficult to manage if we have multiple available connections from client";
1254 result += "\n side endpoint (entity or local server), even if we would have only one connection but";
1255 result += "\n several realm interfaces. It is enough to configure different hop-by-hop values within";
1256 result += "\n each test case, because on reception, the Session-Id is used to identify that test case.";
1261 result += "\n Programming example:";
1263 result += "\n Basic Rx/Gx scenary: PCEF (Gx) - PCRF - AF (Rx)";
1265 result += "\n test|1|timeout|5000 (step 1: whole time requirement is 5 seconds)";
1266 result += "\n test|1|sendxml2e|CCR-I.xml (step 2: imagine this xml uses the Session-Id 'SGx')";
1267 result += "\n test|1|waitfe|272|0|||SGx|2001 (step 3: waits the CCA for the CCR-I with Result-Code = DIAMETER_SUCCESS)";
1268 result += "\n test|1|sendxml2e|AAR-flows.xml (step 4: imagine this xml uses the Session-Id 'SRx')";
1269 result += "\n test|1|waitfe|265|0|||SRx|2001 (step 5: waits the AAA for the AAR-flows with Result-Code = DIAMETER_SUCCESS)";
1270 result += "\n test|1|waitfe|258|1|||SGx (step 6: waits the RAR (install policies) from the PCRF server)";
1271 result += "\n test|1|sendxml2e|RAA-install.xml|6 (step 7: sends the response for the RAR)";
1272 result += "\n test|1|sendxml2e|CCR-T.xml (step 8: termination of the Gx session, imagine this xml puts hop-by-hop 'H1')";
1273 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')";
1274 result += "\n test|1|waitfe|258|1|||SGx (step 10: waits the RAR (remove policies) from the PCRF server)";
1275 result += "\n test|1|sendxml2e|RAA-remove.xml|10 (step 11: sends the response for the RAR)";
1277 result += "\n Notes: We added an additional condition in step 9: the hop-by-hop. When we program the corresponding";
1278 result += "\n source request (CCR-T), we configured the value 'H1' for the hop-by-hop. This is an 'application";
1279 result += "\n value' because the real hop-by-hop transported through the client connection is managed by the";
1280 result += "\n diameter stack. But when returned, the transaction pool resolve the original value. This feature";
1281 result += "\n is necessary to ease the implementation of certain diameter agents (proxies for example). In our";
1282 result += "\n case, we could format the hop-by-hop values within the request templates with total freedom to";
1283 result += "\n improve the programmed conditions.";
1285 result += "\n In the case of 'waiting for requests' is not such easy. Indeed, steps 6 and 10 will write a warning";
1286 result += "\n because they are the same condition. We know that we are not going to have any problem because";
1287 result += "\n such events are blocking-protected regarding logic-dependent messages (CCR-T), and race condition";
1288 result += "\n is absolutely strange in this case.";
1290 result += "\n You could speed up the test case moving forward steps like 3 & 5, understood as non-strict requirements";
1291 result += "\n to continue testing. Anyway, remember that test cases should be as real as possible, and that there";
1292 result += "\n are many ways to increase the load rate as we will see in next section (test cases execution).";
1294 result += "\n Other simplifications: the steps 3, 5 and 9 can be replaced by";
1296 result += "\n test|1|waitfe||0|#2";
1297 result += "\n test|1|waitfe||0|#4";
1298 result += "\n test|1|waitfe||0|#8";
1300 result += "\n which means that hop-by-hop must be retrieved from steps 2, 4 and 8 respectively,";
1301 result += "\n and the expected message shall be an answer. Normally you will add other conditions,";
1302 result += "\n for example a DIAMETER_SUCCESS result (adding 2001 as Result-Code).";
1304 result += "\nTest cases execution:";
1307 result += "\n test|ttps|<amount> Starts/resume the provided number of test ticks per second (ttps). The ADML starts";
1308 result += "\n with the event trigger system suspended, and this operation is neccessary to begin";
1309 result += "\n those cases which need this time event (internal triggering). Some other test cases";
1310 result += "\n could be started through external events (first test case event could be programmed";
1311 result += "\n to wait specific message), but is not usual this external mode and neither usual to";
1312 result += "\n mix triggering types. Normally, you will pause/stop new test launchs providing 0 as";
1313 result += "\n ttps value, and also you could dynamically modify the load rate updating that value.";
1314 result += "\n If a test case has N messages then 'ttps * N' will be the virtual number of messages";
1315 result += "\n managed per second when no bottleneck exists.";
1317 result += "\n Provide 0 in order to stop the timer triggering.";
1319 result += "\n The timer manager resolution currently harcoded allows a maximum of ";
1320 result += anna::functions::asString(1000/a_admlMinResolution); result += " events";
1321 result += "\n per second. To reach greater rates ADML will join synchronously the needed number of";
1322 result += "\n new time-triggered test cases per a single event, writting a warning-level trace to";
1323 result += "\n advice about the risk of burst sendings and recommend launching multiple instances";
1324 result += "\n to achieve such load with a lower rate per instance.";
1326 result += "\n test|next[|<sync-amount>] Forces the execution of the next test case(s) without waiting for test manager tick.";
1327 result += "\n Provide an integer value for 'sync-amount' to send a burst synchronous amount of the";
1328 result += "\n next programmed test cases (1 by default). This event works regardless the timer tick";
1329 result += "\n function, but it is normally used with the test manager tick stopped.";
1331 result += "\n test|ip-limit[|amount] In-progress limit of test cases. No new test cases will be launched over this value";
1332 result += "\n (test Manager tick work will be ignored). Zero-value is equivalent to stop the clock.";
1333 result += "\n tick, -1 is used to specify 'no limit' which is the default. If missing amount, the";
1334 result += "\n limit and current amount of in-progress test cases will be shown.";
1336 result += "\n test|goto|<id> Updates current test pointer position.";
1338 result += "\n test|look[|id] Show programmed test case for id provided, current 'in-process' test case when missing.";
1339 result += "\n Test cases reports are not dumped on process context (too many information in general).";
1340 result += "\n The report contains context information in every moment: this operation acts as a snapshot.";
1342 result += "\n test|report[|[yes]|no] Every time a test case is finished, its xml representation will be dump on a file under";
1343 result += "\n the execution directory (or the one configured in process command-line 'tmDir') with";
1344 result += "\n the name 'cycle-<cycle id>.testcase-<test case id>.xml'. This option is disabled by";
1345 result += "\n default reducing IO. ADML process context won't show test manager whole information";
1346 result += "\n because it could be a huge amount of data to write. Anyway, you could use the 'look'";
1347 result += "\n operation to see the desired report(s).";
1349 result += "\n test|report-hex[|[yes]|no] Reports could include the diameter messages in hexadecimal format. Disabled by default.";
1351 result += "\n test|interact|amount|id Makes interactive a specific test case id. The amount is the margin of execution steps";
1352 result += "\n to be done. Normally, we will execute 'test|interact|0|<test case id>', which means that";
1353 result += "\n the test case is selected to be interactive, but no step is executed. Then you have to";
1354 result += "\n interact with positive amounts (usually 1), executing the provided number of steps if";
1355 result += "\n they are ready and fulfill the needed conditions. The value of 0, implies no execution";
1356 result += "\n steps margin, which could be useful to 'freeze' a test in the middle of its execution.";
1357 result += "\n You could also provide -1 to make it non-interactive resuming it from the current step.";
1359 result += "\n test|reset|<soft/hard>[|id] Reset the test case for id provided, all the tests when missing. It could be hard/soft:";
1360 result += "\n - hard: you probably may need to stop the load rate before. This operation initializes";
1361 result += "\n all test cases regardless their states.";
1362 result += "\n - soft: only for finished cases (those with 'Success' or 'Failed' states). It does not";
1363 result += "\n affect to test cases with 'InProgress' state.";
1365 result += "\n test|repeats|<amount> Restarts the whole programmed test list when finished the amount number of times (repeats";
1366 result += "\n forever if value -1 is provided). This is disabled by default (amount = 0): testing trigger";
1367 result += "\n system will enter suspended state until new ttps operation is received and a soft reset has";
1368 result += "\n been done before. Test cases state & data will be reset (when achieved again), but general";
1369 result += "\n statistics and counters will continue measuring until reset with 'collect' operation.";
1371 result += "\n test|clear Clears all the programmed test cases and stop testing (if in progress).";
1373 result += "\n test|summary Test manager general report (number of test cases, counts by state, global configuration,";
1374 result += "\n forced in-progress limitation, reports visibility, etc.). Be careful when you have reports";
1375 result += "\n dumps enabled because all the programmed test cases will be dump and that could be heavy.";
1378 result += "\nUSING OPERATIONS INTERFACE";
1379 result += "\n--------------------------";
1381 result += "\n------------------------------------------------------------------------- Operations via HTTP interface";
1383 result += "\nAll the operations described above can be used through the optional HTTP interface. You only have";
1384 result += "\n to define the http server at the command line with something like: '--httpServer localhost:9000'.";
1385 result += "\nTo send the task, we shall build the http request body with the operation string. Some examples";
1386 result += "\n using curl client could be:";
1388 result += "\n curl -m 1 --data \"diameterServerSessions|4\" localhost:9000";
1389 result += "\n curl -m 1 --data \"code|ccr.xml\" localhost:9000";
1390 result += "\n curl -m 1 --data \"decode|ccr.hex\" localhost:9000";
1391 result += "\n curl -m 1 --data \"sendxml2e|ccr.xml\" localhost:9000";
1392 result += "\n etc.";
1394 result += "\n------------------------------------------------------------------------- Operations via SIGUSR2 signal";
1396 result += "\nThe alternative using SIGUSR2 signal requires the creation of the task(s) file which will be read at";
1397 result += "\n signal event:";
1398 result += "\n echo \"<<operation>\" > "; result += SIGUSR2_TASKS_INPUT_FILENAME;
1399 result += "\n then";
1400 result += "\n kill -12 <pid>";
1402 result += "\n kill -s SIGUSR2 <pid>";
1403 result += "\n and then see the results:";
1404 result += "\n cat "; result += SIGUSR2_TASKS_OUTPUT_FILENAME;
1406 result += "\n (this file is ended with EOF final line, useful managing huge batch files to ensure the job completion)";
1408 result += "\nYou could place more than one line (task) in the input file. Output reports will be appended in that";
1409 result += "\n case over the output file. Take into account that all the content of the task file will be executed";
1410 result += "\n sinchronously by the process. If you are planning traffic load, better use the asynchronous http";
1411 result += "\n interface.";
1418 void Launcher::eventOperation(const std::string &operation, std::string &response_content) throw(anna::RuntimeException) {
1419 LOGMETHOD(anna::TraceMethod tm("Launcher", "eventOperation", ANNA_FILE_LOCATION));
1420 if (operation == "") return; // ignore
1421 LOGDEBUG(anna::Logger::debug(operation, ANNA_FILE_LOCATION));
1423 // Default response:
1424 response_content = "Operation processed with exception (see traces): ";
1425 response_content += operation;
1426 std::string opt_response_content = ""; // aditional response content
1427 anna::DataBlock db_aux(true);
1428 anna::diameter::codec::Message codecMsg; // auxiliary codec message
1431 CommandLine& cl(anna::CommandLine::instantiate());
1432 TestManager &testManager = TestManager::instantiate();
1435 ///////////////////////////////////////////////////////////////////
1436 // Simple operations without arguments:
1439 if(operation == "help") {
1440 response_content = help();
1444 // Reset performance data:
1445 if(operation == "collect") {
1448 response_content = "All process counters & statistic information have been reset";
1452 // Counters dump on demand:
1453 if(operation == "forceCountersRecord") {
1454 forceCountersRecord();
1455 response_content = "Current counters have been dump to disk";
1459 // OAM & statistics:
1460 if(operation == "show-oam") {
1461 anna::xml::Node root("root");
1462 response_content = anna::xml::Compiler().apply(oamAsXML(&root));
1465 if(operation == "show-stats") {
1466 anna::xml::Node root("root");
1467 response_content = anna::xml::Compiler().apply(statsAsXML(&root));
1471 ///////////////////////////////////////////////////////////////////
1472 // Tokenize operation
1474 params.apply(operation, "|", "<null>" /* allow contiguous separators */);
1475 int numParams = params.size() - 1;
1477 // Get the operation type and parameters:
1478 Tokenizer::const_iterator tok_iter = params.begin();
1479 std::string opType = Tokenizer::data(tok_iter);
1480 std::string param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11;
1481 if(numParams >= 1) { tok_iter++; param1 = Tokenizer::data(tok_iter); }
1482 if(numParams >= 2) { tok_iter++; param2 = Tokenizer::data(tok_iter); }
1483 if(numParams >= 3) { tok_iter++; param3 = Tokenizer::data(tok_iter); }
1485 if(numParams >= 4) { tok_iter++; param4 = Tokenizer::data(tok_iter); }
1486 if(numParams >= 5) { tok_iter++; param5 = Tokenizer::data(tok_iter); }
1487 if(numParams >= 6) { tok_iter++; param6 = Tokenizer::data(tok_iter); }
1488 if(numParams >= 7) { tok_iter++; param7 = Tokenizer::data(tok_iter); }
1489 if(numParams >= 8) { tok_iter++; param8 = Tokenizer::data(tok_iter); }
1490 if(numParams >= 9) { tok_iter++; param9 = Tokenizer::data(tok_iter); }
1491 if(numParams >= 10) { tok_iter++; param10 = Tokenizer::data(tok_iter); }
1492 if(numParams >= 11) { tok_iter++; param11 = Tokenizer::data(tok_iter); }
1493 // Remove '<null>' artificial token to ease further checkings:
1494 if (param1 == "<null>") param1 = "";
1495 if (param2 == "<null>") param2 = "";
1496 if (param3 == "<null>") param3 = "";
1497 if (param4 == "<null>") param4 = "";
1498 if (param5 == "<null>") param5 = "";
1499 if (param6 == "<null>") param6 = "";
1500 if (param7 == "<null>") param7 = "";
1501 if (param8 == "<null>") param8 = "";
1502 if (param9 == "<null>") param9 = "";
1503 if (param10 == "<null>") param10 = "";
1504 if (param11 == "<null>") param11 = "";
1506 // No operation has more than 2 arguments except 'test' ...
1507 if(opType != "test" && numParams > 2)
1508 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1511 // Check the number of parameters:
1512 bool wrongBody = false;
1514 if((opType == "node") && (numParams > 1)) wrongBody = true;
1515 if((opType == "node_auto") && (numParams > 0)) wrongBody = true;
1517 if(((opType == "code") || (opType == "decode")) && (numParams != 2)) wrongBody = true;
1519 if(((opType == "sendxml2e") || (opType == "sendhex2e")) && (numParams != 1)) wrongBody = true;
1521 if((opType == "burst") && (numParams < 1)) wrongBody = true;
1523 if((opType == "test") && (numParams < 1)) wrongBody = true;
1525 if(((opType == "sendxml2c") || (opType == "sendhex2c") || (opType == "loadxml") || (opType == "diameterServerSessions")) && (numParams != 1)) wrongBody = true;
1529 std::string msg = "Wrong body content format on HTTP Request for '";
1531 msg += "' operation (missing parameter/s). Use 'help' management command to see more information.";
1532 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1536 if(opType == "context") {
1537 std::string contextFile = ((numParams == 1) ? param1 : anna::functions::asString("/var/tmp/anna.context.%05d", getPid()));
1538 writeContext(contextFile);
1539 response_content = anna::functions::asString("Context dumped on file '%s'", contextFile.c_str());
1543 if(opType == "services") {
1544 std::string servicesFile = ((numParams == 1) ? param1 : "services.xml");
1546 loadServices(servicesFile, true /* bind entities */);
1548 catch(anna::RuntimeException &ex) {
1550 response_content = anna::functions::asString("Loaded services from file '%s' with errors", servicesFile.c_str());
1553 response_content = anna::functions::asString("Loaded services from file '%s'", servicesFile.c_str());
1558 if(opType == "node") {
1560 if (setWorkingNode(param1)) response_content = anna::functions::asString("Forced node is now '%s'", param1.c_str());
1563 if (a_workingNode) {
1564 response_content = "Working node is forced to be: \n\n";
1565 response_content += a_workingNode->asXMLString();
1568 response_content = "Working node is automatic";
1573 if(opType == "node_auto") {
1574 a_workingNode = NULL;
1575 response_content = "Working node has been set to automatic";
1579 // Operated realm from possible forced-working node:
1580 a_operatedRealm = a_workingNode ? a_workingNode /* priority */: NULL /* auto */;
1582 // If any message is managed: updateOperatedRealmNodeWithMessage(codecMessage)
1583 // To operate, use the exception-protected methods which never will return NULL:
1584 // getOperatedRealm(), getOperatedEntity(), getOperatedServer(), getOperatedEngine()
1587 if(opType == "code") {
1588 codecMsg.loadXML(param1);
1589 std::string hexString = anna::functions::asHexString(codecMsg.code());
1591 std::ofstream outfile(param2.c_str(), std::ifstream::out);
1592 outfile.write(hexString.c_str(), hexString.size());
1594 } else if(opType == "decode") {
1595 // Get DataBlock from file with hex content:
1596 if(!getDataBlockFromHexFile(param1, db_aux))
1597 throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
1600 try { codecMsg.decode(db_aux); } catch(anna::RuntimeException &ex) { ex.trace(); }
1602 std::string xmlString = codecMsg.asXMLString();
1604 std::ofstream outfile(param2.c_str(), std::ifstream::out);
1605 outfile.write(xmlString.c_str(), xmlString.size());
1607 } else if((opType == "hide") || (opType == "show") || (opType == "hidden") || (opType == "shown")) {
1611 std::string key = param1;
1615 if(opType == "hide") getOperatedEngine()->findClientSession(key)->hide();
1617 if(opType == "show") getOperatedEngine()->findClientSession(key)->show();
1619 if(opType == "hidden") opt_response_content = getOperatedEngine()->findClientSession(key)->hidden() ? "true" : "false";
1621 if(opType == "shown") opt_response_content = getOperatedEngine()->findClientSession(key)->shown() ? "true" : "false";
1623 std::string address;
1625 anna::functions::getAddressAndPortFromSocketLiteral(param1, address, port);
1627 if(opType == "hide") getOperatedEngine()->findServer(address, port)->hide();
1629 if(opType == "show") getOperatedEngine()->findServer(address, port)->show();
1631 if(opType == "hidden") opt_response_content = getOperatedEngine()->findServer(address, port)->hidden() ? "true" : "false";
1633 if(opType == "shown") opt_response_content = getOperatedEngine()->findServer(address, port)->shown() ? "true" : "false";
1636 if(opType == "hide") getOperatedEntity()->hide();
1638 if(opType == "show") getOperatedEntity()->show();
1640 if(opType == "hidden") opt_response_content = getOperatedEntity()->hidden() ? "true" : "false";
1642 if(opType == "shown") opt_response_content = getOperatedEntity()->shown() ? "true" : "false";
1644 } else if((opType == "sendxml2e") || (opType == "sendhex2e")) {
1645 anna::diameter::comm::Message *msg;
1647 if(opType == "sendxml2e") {
1648 codecMsg.loadXML(param1);
1649 updateOperatedRealmNodeWithMessage(codecMsg);
1650 msg = getOperatedRealm()->createCommMessage();
1652 try { codecMsg.valid(); } catch(anna::RuntimeException &ex) { ex.trace(); } // at least we need to see validation errors although it will continue sending (see validation mode configured in launcher)
1653 msg->setBody(codecMsg.code());
1655 // Get DataBlock from file with hex content:
1656 if(!getDataBlockFromHexFile(param1, db_aux))
1657 throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
1658 msg = getOperatedRealm()->createCommMessage();
1659 msg->setBody(db_aux);
1660 try { if(getOperatedRealm()->logEnabled()) codecMsg.decode(db_aux); } catch(anna::RuntimeException &ex) { ex.trace(); }
1663 bool success = getOperatedEntity()->send(msg, cl.exists("balance"));
1664 getOperatedRealm()->releaseCommMessage(msg);
1667 if(getOperatedRealm()->logEnabled()) {
1668 anna::diameter::comm::Server *usedServer = getOperatedEntity()->getLastUsedResource();
1669 anna::diameter::comm::ClientSession *usedClientSession = usedServer ? usedServer->getLastUsedResource() : NULL;
1670 std::string detail = usedClientSession ? usedClientSession->asString() : "<null client session>"; // shouldn't happen
1671 getOperatedRealm()->writeLogFile(codecMsg, (success ? "sent2e" : "send2eError"), detail);
1673 } else if((opType == "burst")) {
1676 throw anna::RuntimeException("Burst category operations are only allowed in single realm node configuration. This is only to simplify user experience.", ANNA_FILE_LOCATION);
1678 // burst|clear clears all loaded burst messages.
1679 // burst|load|<source_file> loads the next diameter message into launcher burst.
1680 // burst|start|<initial load> starts the message sending with a certain initial load.
1681 // burst|push|<load amount> sends specific non-aynchronous load.
1682 // burst|stop stops the burst cycle.
1683 // burst|repeat|[[yes]|no] restarts the burst launch when finish.
1684 // burst|send|<amount> send messages from burst list. The main difference with
1685 // start/push operations is that burst won't be awaken.
1686 // Externally we could control sending time (no request
1687 // will be sent for answers).
1688 // burst|goto|<order> Updates current burst pointer position.
1689 // burst|look|<order> Show programmed burst message for order provided, current when missing.
1691 if(param1 == "clear") {
1692 opt_response_content = "removed ";
1693 opt_response_content += anna::functions::asString(getOperatedRealm()->clearBurst());
1694 opt_response_content += " elements";
1695 } else if(param1 == "load") {
1696 if(param2 == "") throw anna::RuntimeException("Missing xml path file for burst load operation", ANNA_FILE_LOCATION);
1698 codecMsg.loadXML(param2);
1699 if(codecMsg.isAnswer()) throw anna::RuntimeException("Cannot load diameter answers for burst feature", ANNA_FILE_LOCATION);
1700 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)
1702 int position = getOperatedRealm()->loadBurstMessage(codecMsg.code());
1703 opt_response_content = "loaded '";
1704 opt_response_content += param2;
1705 opt_response_content += "' file into burst list position ";
1706 opt_response_content += anna::functions::asString(position);
1707 } else if(param1 == "start") {
1708 if(param2 == "") throw anna::RuntimeException("Missing initial load for burst start operation", ANNA_FILE_LOCATION);
1710 int initialLoad = atoi(param2.c_str());
1711 int processed = getOperatedRealm()->startBurst(initialLoad);
1714 opt_response_content = "initial load completed for ";
1715 opt_response_content += anna::functions::entriesAsString(processed, "message");
1717 } else if(param1 == "push") {
1718 if(param2 == "") throw anna::RuntimeException("Missing load amount for burst push operation", ANNA_FILE_LOCATION);
1720 int pushed = getOperatedRealm()->pushBurst(atoi(param2.c_str()));
1723 opt_response_content = "pushed ";
1724 opt_response_content += anna::functions::entriesAsString(pushed, "message");
1726 } else if(param1 == "pop") {
1727 if(param2 == "") throw anna::RuntimeException("Missing amount for burst pop operation", ANNA_FILE_LOCATION);
1729 int releaseLoad = atoi(param2.c_str());
1730 int popped = getOperatedRealm()->popBurst(releaseLoad);
1733 opt_response_content = "burst popped for ";
1734 opt_response_content += anna::functions::entriesAsString(popped, "message");
1736 } else if(param1 == "stop") {
1737 int left = getOperatedRealm()->stopBurst();
1740 opt_response_content += anna::functions::entriesAsString(left, "message");
1741 opt_response_content += " left to the end of the cycle";
1743 } else if(param1 == "repeat") {
1744 if(param2 == "") param2 = "yes";
1746 bool repeat = (param2 == "yes");
1747 getOperatedRealm()->repeatBurst(repeat);
1748 opt_response_content += (repeat ? "repeat enabled" : "repeat disabled");
1749 } else if(param1 == "send") {
1750 if(param2 == "") throw anna::RuntimeException("Missing amount for burst send operation", ANNA_FILE_LOCATION);
1752 int sent = getOperatedRealm()->sendBurst(atoi(param2.c_str()));
1755 opt_response_content = "sent ";
1756 opt_response_content += anna::functions::entriesAsString(sent, "message");
1758 } else if(param1 == "goto") {
1759 if(param2 == "") throw anna::RuntimeException("Missing order position for burst goto operation", ANNA_FILE_LOCATION);
1761 opt_response_content = getOperatedRealm()->gotoBurst(atoi(param2.c_str()));
1762 } else if(param1 == "look") {
1763 int order = ((param2 != "") ? atoi(param2.c_str()) : -1);
1764 opt_response_content = "\n\n";
1765 opt_response_content += getOperatedRealm()->lookBurst(order);
1767 throw anna::RuntimeException("Wrong body content format on HTTP Request for 'burst' operation (unexpected action parameter). See help", ANNA_FILE_LOCATION);
1770 } else if((opType == "test")) {
1771 // test|<id>|<command>[|parameters] Add a new step to the test case ...
1772 // test|ttps|<amount> Starts/resume the provided number of time ticks per second (ttps). The ADML starts ...
1773 // test|next[|<sync-amount>] Forces the execution of the next test case(s) without waiting for test manager tick ...
1774 // test|ip-limit[|amount] In-progress limit of test cases. No new test cases will be launched over this value ...
1775 // test|repeats|<amount> Restarts the whole programmed test list when finished the amount number of times ...
1776 // test|report[|[yes]|no] Every time a test case is finished a report file in xml format will be created under ...
1777 // test|report-hex[|[yes]|no] Reports could include the diameter messages in hexadecimal format. Disabled by default.
1778 // test|goto|<id> Updates current test pointer position.
1779 // test|look[|id] Show programmed test case for id provided, current when missing ...
1780 // test|interact|amount|id Makes interactive a specific test case id. The amount is the margin of execution steps ...
1781 // test|reset|<soft/hard>[|id] Reset the test case for id provided, all the tests when missing ...
1782 // test|clear Clears all the programmed test cases.
1783 // test|summary Test manager general report (number of test cases, counts by state ...
1786 if(param1 == "ttps") {
1788 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1790 bool success = ((param2 != "") ? testManager.configureTTPS(atoi(param2.c_str())) : false);
1792 opt_response_content = "assigned new test launch rate to ";
1793 opt_response_content += anna::functions::asString(atoi(param2.c_str()));
1794 opt_response_content += " events per second";
1797 opt_response_content += "unable to configure the test rate provided";
1800 else if (param1 == "next") {
1802 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1804 int sync_amount = ((param2 != "") ? atoi(param2.c_str()) : 1);
1806 if (sync_amount < 1)
1807 throw anna::RuntimeException("The parameter 'sync-amount' must be a positive integer value", ANNA_FILE_LOCATION);
1809 bool success = testManager.execTestCases(sync_amount);
1811 opt_response_content = (success ? "" : "not completely " /* completed cycle and no repeats, rare case */);
1812 opt_response_content += "processed ";
1813 opt_response_content += anna::functions::asString(sync_amount);
1814 opt_response_content += ((sync_amount > 1) ? " test cases synchronously" : " test case");
1816 else if(param1 == "ip-limit") {
1818 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1822 limit = atoi(param2.c_str());
1823 testManager.setInProgressLimit(limit);
1824 opt_response_content = "new in-progress limit: ";
1825 opt_response_content += (limit != UINT_MAX) ? anna::functions::asString(limit) : "<no limit>";
1828 opt_response_content = "in-progress limit amount: ";
1829 limit = testManager.getInProgressLimit();
1830 opt_response_content += (limit != UINT_MAX) ? anna::functions::asString(limit) : "<no limit>";
1831 opt_response_content += "; currently there are ";
1832 opt_response_content += anna::functions::asString(testManager.getInProgressCount());
1833 opt_response_content += " test cases running";
1836 else if(param1 == "repeats") {
1838 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1839 int repeats = atoi(param2.c_str());
1840 if (repeats < 0) repeats = -1;
1841 testManager.setPoolRepeats(repeats);
1842 std::string nolimit = (repeats != -1) ? "":" [no limit]";
1843 opt_response_content += anna::functions::asString("Pool repeats: %d%s (current cycle: %d)", repeats, nolimit.c_str(), testManager.getPoolCycle());
1845 else if(param1 == "report") {
1847 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1849 if(param2 == "") param2 = "yes";
1850 testManager.setDumpReports((param2 == "yes"));
1851 opt_response_content += (testManager.getDumpReports() ? "report enabled" : "report disabled");
1853 else if(param1 == "report-hex") {
1855 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1857 if(param2 == "") param2 = "yes";
1858 testManager.setDumpHex((param2 == "yes"));
1859 opt_response_content += (testManager.getDumpHex() ? "report includes hexadecimal messages" : "report excludes hexadecimal messages");
1861 else if(param1 == "goto") {
1863 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1865 if(param2 == "") throw anna::RuntimeException("Missing id for test goto operation", ANNA_FILE_LOCATION);
1866 int id = atoi(param2.c_str());
1867 if (testManager.gotoTestCase(id)) {
1868 opt_response_content = "position updated for id provided (";
1871 opt_response_content = "cannot found test id (";
1873 opt_response_content += anna::functions::asString(id);
1874 opt_response_content += ")";
1876 else if(param1 == "look") {
1878 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1880 int id = ((param2 != "") ? atoi(param2.c_str()) : -1);
1881 TestCase *testCase = testManager.findTestCase(id);
1884 response_content = testCase->asXMLString();
1889 opt_response_content = "no current test case detected (testing started ?)";
1892 opt_response_content = "cannot found test id (";
1893 opt_response_content += anna::functions::asString(id);
1894 opt_response_content += ")";
1898 else if (param1 == "interact") {
1900 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1902 int amount = atoi(param2.c_str());
1904 throw anna::RuntimeException("Interactive amount must be -1 (to disable interactive mode) or a positive number.", ANNA_FILE_LOCATION);
1906 int id = atoi(param3.c_str());
1907 TestCase *testCase = testManager.findTestCase(id);
1910 testCase->makeInteractive(false);
1911 opt_response_content = "interactive mode disabled";
1914 testCase->addInteractiveAmount(amount);
1915 opt_response_content = "added interactive amount of ";
1916 opt_response_content += anna::functions::asString(amount);
1917 opt_response_content += " units";
1918 if (amount == 0) opt_response_content += " (0: freezing a non-interactive testcase, no effect on already interactive)";
1920 opt_response_content += " for test case id ";
1921 opt_response_content += anna::functions::asString(id);
1924 opt_response_content = "cannot found test id (";
1925 opt_response_content += anna::functions::asString(id);
1926 opt_response_content += ")";
1929 else if(param1 == "reset") {
1931 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1933 if (param2 != "soft" && param2 != "hard")
1934 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1936 int id = ((param3 != "") ? atoi(param3.c_str()) : -1);
1937 TestCase *testCase = ((id != -1) ? testManager.findTestCase(id) : NULL);
1940 bool done = testCase->reset((param2 == "hard") ? true:false);
1941 opt_response_content = "test ";
1942 opt_response_content += param2;
1943 opt_response_content += " reset for id ";
1944 opt_response_content += anna::functions::asString(id);
1945 opt_response_content += done ? ": done": ": not done";
1949 bool anyReset = testManager.resetPool((param2 == "hard") ? true:false);
1950 opt_response_content = "reset have been sent to all programmed tests: "; opt_response_content += anyReset ? "some/all have been reset" : "nothing was reset";
1953 opt_response_content = "cannot found test id (";
1954 opt_response_content += anna::functions::asString(id);
1955 opt_response_content += ")";
1959 else if(param1 == "clear") {
1961 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1963 if (testManager.clearPool()) {
1964 opt_response_content = "all the programmed test cases have been dropped";
1967 opt_response_content = "there are not programmed test cases to be removed";
1970 else if(param1 == "summary") {
1971 response_content = testManager.asXMLString();
1975 int id = atoi(param1.c_str());
1977 throw anna::RuntimeException("Invalid test case identifier: must be a non-negative number", ANNA_FILE_LOCATION);
1979 // PARAM: 1 2 3 4 5 6 7 8 9 10 11
1980 // test|<id>|<command>
1982 // sendxml2e| <file>[|<step number>]
1983 // sendxml2c| <file>[|<step number>]
1985 // wait<fe/fc>|[code]|[bitR]|[hopByHop]|[applicationId]|[sessionId]|[resultCode]|[msisdn]|[imsi]|[serviceContextId]
1986 // wait<fe/fc>-answer|<step number>
1987 // wait<fe/fc>-regexp|<regexp>
1988 if(param2 == "") throw anna::RuntimeException("Missing command for test id operation", ANNA_FILE_LOCATION);
1991 if (param2 == "timeout") {
1993 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
1994 if(param3 == "") throw anna::RuntimeException("Missing milliseconds for 'timeout' command in test id operation", ANNA_FILE_LOCATION);
1995 anna::Millisecond timeout = checkTimeMeasure("Test case timeout", param3);
1996 testManager.getTestCase(id)->addTimeout(timeout); // creates / reuses
1998 else if ((param2 == "sendxml2e")||(param2 == "sendxml2c")) {
2000 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2001 if(param3 == "") throw anna::RuntimeException(anna::functions::asString("Missing xml file for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION);
2002 codecMsg.loadXML(param3);
2003 if (codecMsg.isRequest()) {
2005 throw anna::RuntimeException("Step number is provided with answers (to resolve the corresponding 'wait for request' step), but NOT with requests", ANNA_FILE_LOCATION);
2008 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));
2010 updateOperatedRealmNodeWithMessage(codecMsg);
2011 int stepNumber = ((param4 != "") ? atoi(param4.c_str()):-1);
2013 if (param2 == "sendxml2e")
2014 testManager.getTestCase(id)->addSendxml2e(codecMsg.code(), getOperatedRealm(), stepNumber); // creates / reuses
2016 testManager.getTestCase(id)->addSendxml2c(codecMsg.code(), getOperatedRealm(), stepNumber); // creates / reuses
2018 else if (param2 == "delay") {
2020 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2021 if(param3 == "") throw anna::RuntimeException("Missing milliseconds for 'delay' command in test id operation", ANNA_FILE_LOCATION);
2022 anna::Millisecond delay = ((param3 == "0" /* special case */) ? (anna::Millisecond)0 : checkTimeMeasure("Test case delay step", param3));
2023 testManager.getTestCase(id)->addDelay(delay); // creates / reuses
2025 else if ((param2 == "waitfe")||(param2 == "waitfc")) {
2027 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2028 if (param3 != "" || param4 != "" || param5 != "" || param6 != "" || param7 != "" || param8 != "" || param9 != "" || param10 != "" || param11 != "") {
2029 bool fromEntity = (param2.substr(4,2) == "fe");
2030 testManager.getTestCase(id)->addWait(fromEntity, param3, param4, param5, param6, param7, param8, param9, param10, param11);
2033 throw anna::RuntimeException(anna::functions::asString("Missing condition for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION);
2036 else if ((param2 == "waitfe-regexp")||(param2 == "waitfc-regexp")) {
2038 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2040 bool fromEntity = (param2.substr(4,2) == "fe");
2041 testManager.getTestCase(id)->addWaitRegexp(fromEntity, param3);
2044 throw anna::RuntimeException(anna::functions::asString("Missing condition for '%s' command in test id operation", param2.c_str()), ANNA_FILE_LOCATION);
2047 else if (param2 == "sh-command") {
2049 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2050 if(param3 == "") throw anna::RuntimeException("Missing script/executable command-line for 'sh-command' in test id operation", ANNA_FILE_LOCATION);
2051 testManager.getTestCase(id)->addCommand(param3); // creates / reuses
2054 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2058 } else if((opType == "sendxml2c") || (opType == "sendhex2c")) {
2059 anna::diameter::comm::Message *msg;
2061 if(opType == "sendxml2c") {
2062 codecMsg.loadXML(param1);
2063 updateOperatedRealmNodeWithMessage(codecMsg);
2064 msg = getOperatedRealm()->createCommMessage();
2066 try { codecMsg.valid(); } catch(anna::RuntimeException &ex) { ex.trace(); } // at least we need to see validation errors although it will continue sending (see validation mode configured in launcher)
2068 msg->setBody(codecMsg.code());
2070 // Get DataBlock from file with hex content:
2071 if(!getDataBlockFromHexFile(param1, db_aux))
2072 throw anna::RuntimeException("Error reading hex file provided", ANNA_FILE_LOCATION);
2073 msg = getOperatedRealm()->createCommMessage();
2074 msg->setBody(db_aux);
2077 bool success = getOperatedServer()->send(msg);
2078 getOperatedRealm()->releaseCommMessage(msg);
2081 if(getOperatedRealm()->logEnabled()) {
2082 anna::diameter::comm::ServerSession *usedServerSession = getOperatedServer()->getLastUsedResource();
2083 std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // shouldn't happen
2084 getOperatedRealm()->writeLogFile(codecMsg, (success ? "sent2c" : "send2cError"), detail);
2086 } else if(opType == "loadxml") {
2087 codecMsg.loadXML(param1);
2088 response_content = codecMsg.asXMLString();
2090 } else if(opType == "diameterServerSessions") {
2091 int diameterServerSessions = atoi(param1.c_str());
2092 getOperatedServer()->setMaxConnections(diameterServerSessions);
2094 } else if(opType == "answerxml2c") {
2095 if(param1 == "") { // programmed answers FIFO's to stdout
2096 response_content = getOperatedServer()->getReactingAnswers()->asString("ANSWERS TO CLIENT");
2098 } else if (param1 == "rotate") {
2099 getOperatedServer()->getReactingAnswers()->rotate(true);
2100 } else if (param1 == "exhaust") {
2101 getOperatedServer()->getReactingAnswers()->rotate(false);
2102 } else if (param1 == "clear") {
2103 getOperatedServer()->getReactingAnswers()->clear();
2104 } else if (param1 == "dump") {
2105 getOperatedServer()->getReactingAnswers()->dump();
2107 codecMsg.loadXML(param1);
2108 updateOperatedRealmNodeWithMessage(codecMsg);
2109 anna::diameter::codec::Message *message = getOperatedRealm()->getCodecEngine()->createMessage(param1); // loads xml again, lesser of two evils
2110 LOGDEBUG(anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION));
2112 if(message->isRequest())
2113 throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION);
2115 int code = message->getId().first;
2116 LOGDEBUG(anna::Logger::debug("Adding a new programed 'answer to client' to the FIFO queue corresponding to its message code ...", ANNA_FILE_LOCATION));
2117 getOperatedServer()->getReactingAnswers()->addMessage(code, message);
2119 } else if(opType == "answerxml2e") {
2121 if(param1 == "") { // programmed answers FIFO's to stdout
2122 response_content = getOperatedEntity()->getReactingAnswers()->asString("ANSWERS TO ENTITY");
2124 } else if (param1 == "rotate") {
2125 getOperatedEntity()->getReactingAnswers()->rotate(true);
2126 } else if (param1 == "exhaust") {
2127 getOperatedEntity()->getReactingAnswers()->rotate(false);
2128 } else if (param1 == "clear") {
2129 getOperatedEntity()->getReactingAnswers()->clear();
2130 } else if (param1 == "dump") {
2131 getOperatedEntity()->getReactingAnswers()->dump();
2133 codecMsg.loadXML(param1);
2134 updateOperatedRealmNodeWithMessage(codecMsg);
2135 anna::diameter::codec::Message *message = getOperatedRealm()->getCodecEngine()->createMessage(param1); // loads xml again, lesser of two evils
2136 LOGDEBUG(anna::Logger::debug(message->asXMLString(), ANNA_FILE_LOCATION));
2138 if(message->isRequest())
2139 throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION);
2141 int code = message->getId().first;
2142 LOGDEBUG(anna::Logger::debug("Adding a new programed 'answer to entity' to the FIFO queue corresponding to its message code ...", ANNA_FILE_LOCATION));
2143 getOperatedEntity()->getReactingAnswers()->addMessage(code, message);
2146 throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
2150 response_content = "Operation correctly processed: "; response_content += operation;
2151 if (opt_response_content != "") {
2152 response_content += " => ";
2153 response_content += opt_response_content;
2157 anna::xml::Node* Launcher::asXML(anna::xml::Node* parent) const
2159 anna::xml::Node* result = parent->createChild("launcher");
2160 anna::comm::Application::asXML(result);
2162 result->createAttribute("StartTime", a_start_time.asString());
2163 result->createAttribute("SecondsLifeTime", anna::time::functions::lapsedMilliseconds() / 1000);
2165 for (realm_nodes_it it = a_nodes.begin(); it != a_nodes.end(); it++) {
2166 it->second->asXML(result);
2169 // OAM & statistics:
2173 // Testing: could be heavy if test case reports are enabled
2174 TestManager::instantiate().asXML(result);
2179 anna::xml::Node* Launcher::oamAsXML(anna::xml::Node* parent) const
2181 anna::xml::Node* result = parent->createChild("Oam");
2184 anna::diameter::comm::OamModule::instantiate().asXML(result);
2185 anna::diameter::comm::ApplicationMessageOamModule::instantiate().asXML(result);
2186 anna::diameter::codec::OamModule::instantiate().asXML(result);
2191 anna::xml::Node* Launcher::statsAsXML(anna::xml::Node* parent) const
2193 anna::xml::Node* result = parent->createChild("Statistics");
2196 anna::statistics::Engine::instantiate().asXML(result);