Fix new variables
[anna.git] / example / diameter / launcher / Launcher.cpp
index 45f51a9..4219399 100644 (file)
@@ -65,50 +65,51 @@ const char *ServicesDTD = "\
 \n\
    originRealm:                             Node identifier (Origin-Realm name).\n\
    applicationId:                           The Application-Id provided must exists as a registered 'stack id'.\n\
-   originHost:                              Diameter application host name (system name). If missing, process sets o.s. hostname\n\
+   originHost:                              Diameter application host name (system name). If missing, process sets o.s. hostname.\n\
                                             Note that if you have two or more realms, the names must be different.\n\
    cer:                                     User defined CER path file to be encoded to establish diameter connections.\n\
-                                            If missing, will be harcoded\n\
+                                            If missing, will be harcoded.\n\
    dwr:                                     User defined DWR path file to be encoded for diameter protocol keep alive.\n\
-                                            If missing, will be harcoded\n\
+                                            If missing, will be harcoded.\n\
    allowedInactivityTime:                   Milliseconds for the maximum allowed inactivity time on server sessions born over the\n\
-                                            local server before being reset. If missing, default value of 90000 will be assigned\n\
+                                            local server before being reset. If missing, default value of 90000 will be assigned.\n\
    tcpConnectDelay:                         Milliseconds to wait TCP connect to any server. If missing, default value of 200 will\n\
                                             be assigned\n\
    answersTimeout:                          Milliseconds to wait pending application answers from diameter peers. If missing,\n\
-                                            default value of 10000 will be assigned\n\
+                                            default value of 10000 will be assigned.\n\
    ceaTimeout:                              Milliseconds to wait CEA from diameter server. If missing, default value of 'answersTimeout'\n\
-                                            will be assigned\n\
+                                            will be assigned.\n\
    watchdogPeriod:                          Milliseconds for watchdog timer (Tw) for diameter keep-alive procedure. If missing, default\n\
-                                            value of 30000 will be assigned\n\
+                                            value of 30000 will be assigned.\n\
    entity:                                  Target diameter entity (comma-separated '<address>:<port>' format).\n\
-                                            For example: 10.20.30.40:3868,10.20.30.41:3868. If missing, no entity will be enabled\n\
-   entityServerSessions:                    Diameter entity server sessions (0: diameter entity disabled). Default value of 1\n\
+                                            For example: 10.20.30.40:3868,10.20.30.41:3868. If missing, no entity will be enabled.\n\
+   entityServerSessions:                    Diameter entity server sessions (0: diameter entity disabled). Default value of 1.\n\
    diameterServer:                          Diameter own server address in '<address>:<port>' format. For example: 10.20.30.40:3868.\n\
-                                            If missing, no local server will be enabled\n\
-   diameterServerSessions:                  Diameter own server available connections (0: diameter server disabled). Default value of 1\n\
+                                            If missing, no local server will be enabled.\n\
+   diameterServerSessions:                  Diameter own server available connections (0: diameter server disabled). Default value of 1.\n\
+                                            Negative value implies no limit accepting incoming connections.\n\
    balance:                                 Balance over entity servers instead of doing standard behaviour (first primary, secondary\n\
-                                            if fails, etc.). Default value 'no'\n\
+                                            if fails, etc.). Default value 'no'.\n\
    sessionBasedModelsClientSocketSelection: By default, round-robin will be applied for IEC model (SMS/MMS), and Session-Id Low Part\n\
                                             will be analyzed for ECUR/SCUR model (data, voice and content). You could change ECUR/SCUR\n\
                                             analysis behaviour providing 'SessionIdHighPart', 'SessionIdOptionalPart' (atoi applied;\n\
-                                            usually subscriber id data, i.e. MSISDN or IMSI) and 'RoundRobin' (also 'SessionIdLowPart')\n\
-   retries:                                 Expired responses will cause a number of request retransmissions. Disabled by default (0 retries)\n\
+                                            usually subscriber id data, i.e. MSISDN or IMSI) and 'RoundRobin' (also 'SessionIdLowPart').\n\
+   retries:                                 Expired responses will cause a number of request retransmissions. Disabled by default (0 retries).\n\
    log:                                     Process log file (operations result, traffic log, etc.). By default '<originRealm>.launcher.log'.\n\
                                             Empty string or \"null\" name, to disable. Warning: there is no rotation for log files\n\
-                                            (use logrotate or whatever you consider)\n\
+                                            (use logrotate or whatever you consider).\n\
    splitLog:                                Splits log file (appends to log filename, extensions with the type of event: see help on\n\
                                             startup information-level traces). No log files for code/decode and load operations are created.\n\
-                                            Default value 'no'\n\
+                                            Default value 'no'.\n\
    detailedLog:                             Insert detailed information at log files. Should be disabled on automatic tests. Useful on\n\
-                                            'balance' mode to know messages flow along the sockets. Default value 'no'\n\
+                                            'balance' mode to know messages flow along the sockets. Default value 'no'.\n\
    dumpLog:                                 Write to disk every incoming/outcoming message named as:\n\
                                                '<originRealm>.<hop by hop>.<end to end>.<message code>.<request|answer>.<type of event>.xml'\n\
-                                            Default value 'no'\n\
+                                            Default value 'no'.\n\
    burstLog:                                Burst operations log file. By default '<originRealm>.launcher.burst'. Empty string or \"null\" name, to disable.\n\
                                             Warning: there is no rotation for log files (use logrotate or whatever). Output: dot (.) for each\n\
                                             burst message sent/pushed, cross (x) for popped ones, and order number when multiple of 1% of burst\n\
-                                            list size, plus OTA requests when changed\n\
+                                            list size, plus OTA requests when changed.\n\
 \n\
 -->\n\
 \n\
@@ -1339,15 +1340,6 @@ std::string Launcher::help() const throw() {
   result += "\n                                 Test cases reports are not dumped on process context (too many information in general).";
   result += "\n                                 The report contains context information in every moment: this operation acts as a snapshot.";
   result += "\n";
-  result += "\n   test|report[|[yes]|no]        Every time a test case is finished, its xml representation will be dump on a file under";
-  result += "\n                                 the execution directory (or the one configured in process command-line 'tmDir') with";
-  result += "\n                                 the name 'cycle-<cycle id>.testcase-<test case id>.xml'. This option is disabled by";
-  result += "\n                                 default reducing IO. ADML process context won't show test manager whole information";
-  result += "\n                                 because it could be a huge amount of data to write. Anyway, you could use the 'look'";
-  result += "\n                                 operation to see the desired report(s).";
-  result += "\n";
-  result += "\n   test|report-hex[|[yes]|no]    Reports could include the diameter messages in hexadecimal format. Disabled by default.";
-  result += "\n";
   result += "\n   test|interact|amount|id       Makes interactive a specific test case id. The amount is the margin of execution steps";
   result += "\n                                 to be done. Normally, we will execute 'test|interact|0|<test case id>', which means that";
   result += "\n                                 the test case is selected to be interactive, but no step is executed. Then you have to";
@@ -1372,7 +1364,24 @@ std::string Launcher::help() const throw() {
   result += "\n";
   result += "\n   test|summary                  Test manager general report (number of test cases, counts by state, global configuration,";
   result += "\n                                 forced in-progress limitation, reports visibility, etc.). Be careful when you have reports";
-  result += "\n                                 dumps enabled because all the programmed test cases will be dump and that could be heavy.";
+  result += "\n                                 enabled because the programmed test cases dumps could be heavy (anyway you could enable the";
+  result += "\n                                 dumps separately, for any of the possible states: Initialized, InProgress, Failed, Success).";
+  result += "\n";
+  result += "\n   test|report|<initialized/in-progress/failed/success/all>[|[yes]|no]";
+  result += "\n";
+  result += "\n                                 Enables/disables report generation for a certain test case state: initialized, in-progress,";
+  result += "\n                                 failed or success. This applies to report summary (former described operation) and automatic";
+  result += "\n                                 dumps during testing where only failed or success states will appear: every time a test case";
+  result += "\n                                 is finished its xml representation will be dump on a file under the execution directory (or";
+  result += "\n                                 the one configured in process command-line 'tmDir') with the name:";
+  result += "\n";
+  result += "\n                                    'cycle-<cycle id>.testcase-<test case id>.xml'.";
+  result += "\n";
+  result += "\n                                 By default, all the states are disabled to avoid IO overload. In most of cases not all the";
+  result += "\n                                 tests are going to fail and you could enable only such failed dumps, but you can enable all";
+  result += "\n                                 the types if you want (use reserved word 'all' for this).";
+  result += "\n";
+  result += "\n   test|report-hex[|[yes]|no]    Reports could include the diameter messages in hexadecimal format. Disabled by default.";
   result += "\n";
   result += "\n";
   result += "\nUSING OPERATIONS INTERFACE";
@@ -1768,19 +1777,20 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
     }
 
   } else if((opType == "test")) {
-    // test|<id>|<command>[|parameters]   Add a new step to the test case ...
-    // test|ttps|<amount>                 Starts/resume the provided number of time ticks per second (ttps). The ADML starts ...
-    // test|next[|<sync-amount>]          Forces the execution of the next test case(s) without waiting for test manager tick ...
-    // test|ip-limit[|amount]             In-progress limit of test cases. No new test cases will be launched over this value ...
-    // test|repeats|<amount>              Restarts the whole programmed test list when finished the amount number of times ...
-    // test|report[|[yes]|no]             Every time a test case is finished a report file in xml format will be created under ...
-    // test|report-hex[|[yes]|no]         Reports could include the diameter messages in hexadecimal format. Disabled by default.
-    // test|goto|<id>                     Updates current test pointer position.
-    // test|look[|id]                     Show programmed test case for id provided, current when missing ...
-    // test|interact|amount|id            Makes interactive a specific test case id. The amount is the margin of execution steps ...
-    // test|reset|<soft/hard>[|id]        Reset the test case for id provided, all the tests when missing ...
-    // test|clear                         Clears all the programmed test cases.
-    // test|summary                       Test manager general report (number of test cases, counts by state ...
+    // test|<id>|<command>[|parameters]         Add a new step to the test case ...
+    // test|ttps|<amount>                       Starts/resume the provided number of time ticks per second (ttps). The ADML starts ...
+    // test|next[|<sync-amount>]                Forces the execution of the next test case(s) without waiting for test manager tick ...
+    // test|ip-limit[|amount]                   In-progress limit of test cases. No new test cases will be launched over this value ...
+    // test|repeats|<amount>                    Restarts the whole programmed test list when finished the amount number of times ...
+    // test|report|<initialized/in-progress/failed/success/all>[|[yes]|no]
+    //                                          Enables/disables report generation for a certain test case state: initialized, in-progress ...
+    // test|report-hex[|[yes]|no]               Reports could include the diameter messages in hexadecimal format. Disabled by default.
+    // test|goto|<id>                           Updates current test pointer position.
+    // test|look[|id]                           Show programmed test case for id provided, current when missing ...
+    // test|interact|amount|id                  Makes interactive a specific test case id. The amount is the margin of execution steps ...
+    // test|reset|<soft/hard>[|id]              Reset the test case for id provided, all the tests when missing ...
+    // test|clear                               Clears all the programmed test cases.
+    // test|summary                             Test manager general report (number of test cases, counts by state ...
 
 
     if(param1 == "ttps") {
@@ -1843,12 +1853,30 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
       opt_response_content += anna::functions::asString("Pool repeats: %d%s (current cycle: %d)", repeats, nolimit.c_str(), testManager.getPoolCycle());
     }
     else if(param1 == "report") {
-      if (numParams > 2)
+      if (numParams > 3)
         throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
 
-      if(param2 == "") param2 = "yes";
-      testManager.setDumpReports((param2 == "yes"));
-      opt_response_content += (testManager.getDumpReports() ? "report enabled" : "report disabled");
+      if(param2 != "initialized" && param2 != "in-progress" && param2 != "failed" && param2 != "success" && param2 != "all")
+        throw anna::RuntimeException("Wrong body content format on HTTP Request. Use 'help' management command to see more information.", ANNA_FILE_LOCATION);
+
+      if(param3 == "") param3 = "yes";
+      bool enable = (param3 == "yes");
+
+      if(param2 == "initialized")
+        testManager.setDumpInitializedReports(enable);
+      else if(param2 == "in-progress")
+        testManager.setDumpInProgressReports(enable);
+      else if(param2 == "failed")
+        testManager.setDumpFailedReports(enable);
+      else if(param2 == "success")
+        testManager.setDumpSuccessReports(enable);
+      else // all
+        testManager.setDumpAllReports(enable);
+
+      opt_response_content += (enable ? "report enabled " : "report disabled ");
+      opt_response_content += "for tests in '";
+      opt_response_content += param2;
+      opt_response_content += "' state";
     }
     else if(param1 == "report-hex") {
       if (numParams > 2)