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 //
17 #include <anna/testing/TestCase.hpp>
18 #include <anna/testing/TestStep.hpp>
20 #include <anna/xml/Compiler.hpp>
21 #include <anna/diameter/defines.hpp>
22 #include <anna/diameter/helpers/dcca/defines.hpp>
23 #include <anna/diameter/codec/functions.hpp>
24 #include <anna/diameter.comm/OriginHost.hpp>
25 #include <anna/diameter/helpers/base/functions.hpp>
26 #include <anna/diameter/helpers/dcca/functions.hpp>
27 #include <anna/core/util/Millisecond.hpp>
28 #include <anna/core/tracing/Logger.hpp>
29 #include <anna/testing/TestManager.hpp>
32 using namespace anna::testing;
35 ///////////////////////////////////////////////////////////////////////////////////////////////////
36 void TestCase::DebugSummary::addHint(const std::string &hint) {
38 event.Timestamp = anna::functions::millisecond();
40 a_events.push_back(event);
43 void TestCase::DebugSummary::clear() {
47 anna::xml::Node* TestCase::DebugSummary::asXML(anna::xml::Node* parent) const {
48 anna::xml::Node* result = parent->createChild("DebugSummary");
50 std::vector<event_t>::const_iterator it;
51 for (it = a_events.begin(); it != a_events.end(); it++) {
52 anna::xml::Node* event = result->createChild("Event");
53 event->createAttribute("Timestamp", (*it).Timestamp.asString());
54 event->createAttribute("Hint", (*it).Hint);
60 std::string TestCase::DebugSummary::asString() const {
61 std::string result = "";
63 std::vector<event_t>::const_iterator it;
64 for (it = a_events.begin(); it != a_events.end(); it++) {
65 result += anna::functions::asString("[Timestamp: %s] %s", (*it).Timestamp.asString().c_str(), (*it).Hint.c_str());
71 ///////////////////////////////////////////////////////////////////////////////////////////////////
74 TestCase::TestCase(unsigned int id, const std::string &description) :
77 a_description((description != "") ? description : (anna::functions::asString("Testcase_%d", id))),
78 a_state(State::Initialized),
81 a_interactiveAmount(-1) {
83 /*a_stepsIt = a_steps.end()*/;
84 TestManager &testManager = TestManager::instantiate();
85 testManager.tcsStateStats(State::Initialized, State::Initialized);
88 TestCase::~TestCase() {
89 // TestCase should not be deleted until is safeToClear()
90 reset(true); // hard reset
91 std::vector<TestStep*>::const_iterator it;
92 for (it = a_steps.begin(); it != a_steps.end(); it++) delete (*it);
96 const char* TestCase::asText(const State::_v state)
98 static const char* text [] = { "Initialized", "InProgress", "Failed", "Success" };
102 anna::Millisecond TestCase::getLapseMs() const {
103 return ((a_finishTimestamp >= a_startTimestamp) ? (a_finishTimestamp - a_startTimestamp) : (anna::Millisecond)0);
106 anna::xml::Node* TestCase::asXML(anna::xml::Node* parent) const
108 anna::xml::Node* result = parent->createChild("TestCase");
110 result->createAttribute("Id", a_id);
111 if (a_key != "") result->createAttribute("Key", a_key);
112 result->createAttribute("Description", a_description);
113 result->createAttribute("State", asText(a_state));
114 result->createAttribute("StartTimestamp", a_startTimestamp.asString());
116 if (a_finishTimestamp != 0) {
117 result->createAttribute("FinishTimestamp", a_finishTimestamp.asString());
118 result->createAttribute("LapseMs", getLapseMs());
121 int steps = a_steps.size();
123 result->createAttribute("NumberOfTestSteps", steps);
124 std::vector<TestStep*>::const_iterator it;
125 for (it = a_steps.begin(); it != a_steps.end(); it++) {
126 (*it)->asXML(result);
130 if (a_debugSummary.events()) {
131 a_debugSummary.asXML(result);
134 result->createAttribute("Interactive", (a_interactiveAmount != -1) ? "yes":"no");
139 std::string TestCase::asXMLString() const {
140 anna::xml::Node root("root");
141 return anna::xml::Compiler().apply(asXML(&root));
144 bool TestCase::hasSameCondition(const TestDiameterCondition &condition) const {
145 std::vector<TestStep*>::const_iterator it;
146 TestStepWaitDiameter *step;
147 for (it = a_steps.begin(); it != a_steps.end(); it++) {
148 if ((*it)->getType() != TestStep::Type::Wait) continue;
149 step = (TestStepWaitDiameter *)(*it);
150 if (step->getCondition() == condition) return true;
156 void TestCase::setState(const State::_v &state) {
158 State::_v previousState = a_state;
159 if (state == previousState) return;
161 TestManager &testManager = TestManager::instantiate();
164 testManager.tcsStateStats(previousState, state);
168 const char *literal = "FINISHED Test Case %llu/%llu [%s] => %s";
169 TestManager& testManager (TestManager::instantiate ());
170 LOGDEBUG(anna::Logger::debug(anna::functions::asString(literal, getId(), testManager.tests(), getDescription().c_str(), asText(a_state)), ANNA_FILE_LOCATION));
172 if (testManager.getDumpStdout()) {
173 std::cout << std::endl << anna::functions::asString(literal, getId(), testManager.tests(), getDescription().c_str(), asText(a_state)) << std::endl;
176 a_finishTimestamp = anna::functions::millisecond();
178 // Cancel existing timers:
179 std::vector<TestStep*>::iterator it;
180 for (it = a_steps.begin(); it != a_steps.end(); it++) {
181 if ((*it)->getType() == TestStep::Type::Timeout) {
182 TestStepTimeout *step = (TestStepTimeout *)(*it);
185 else if ((*it)->getType() == TestStep::Type::Delay) {
186 TestStepDelay *step = (TestStepDelay *)(*it);
191 if ((getState() == State::Failed) && (!testManager.getDumpFailedReports())) return;
192 if ((getState() == State::Success) && (!testManager.getDumpSuccessReports())) return;
193 // report file name: cycle-<cycle id>.testcase-<test case id>.xml
195 // FORMAT: We tabulate the cycle and test case in order to ease ordering of files by mean ls:
196 int cycles = testManager.getPoolRepeats();
197 int tests = testManager.tests();
198 int cyclesWidth = (cycles<=0) ? 3 /* 1000 cycles !! */: ((int) log10 ((double) cycles) + 1);
199 int testsWidth = (tests<=0) ? 9 /* subscribers */: ((int) log10 ((double) tests) + 1);
200 std::stringstream format;
201 format << "/cycle-%0" << cyclesWidth << "d.testcase-%0" << testsWidth << "llu.xml";
204 std::string file = testManager.getReportsDirectory() + anna::functions::asString(format.str().c_str(), testManager.getPoolCycle(), a_id);
206 out.open(file.c_str(), std::ofstream::out | std::ofstream::app);
207 if(out.is_open() == false) {
208 std::string msg("Error opening '");
210 msg += "' for writting";
211 anna::Logger::error(msg, ANNA_FILE_LOCATION);
214 out << asXMLString() << std::endl;
220 bool TestCase::done() {
221 if (a_stepsIt == a_steps.end()) {
222 setState(State::Success);
229 bool TestCase::process() {
231 LOGWARNING(anna::Logger::warning(anna::functions::asString("Test case %llu (%s) is empty, nothing to execute", a_id, a_description.c_str()), ANNA_FILE_LOCATION));
235 LOGDEBUG(anna::Logger::debug(anna::functions::asString("Test case %llu (%s) is finished, nothing done until soft-reset", a_id, a_description.c_str()), ANNA_FILE_LOCATION));
239 const char *literal = "PROCESS Test Case %llu/%llu [%s]";
240 TestManager& testManager (TestManager::instantiate ());
241 LOGDEBUG(anna::Logger::debug(anna::functions::asString(literal, getId(), testManager.tests(), getDescription().c_str()), ANNA_FILE_LOCATION));
243 if (a_state == State::Initialized) {
244 if (testManager.getDumpStdout()) {
245 std::cout << std::endl << std::endl << anna::functions::asString(literal, getId(), testManager.tests(), getDescription().c_str()) << std::endl;
248 a_stepsIt = a_steps.begin();
249 setState(State::InProgress);
251 // For 'wait' steps (not really useful, but better than nothing: begin timestamp on test case start timestamp...):
252 a_startTimestamp = anna::functions::millisecond();
255 // Check end of the test case:
256 if (done()) return false;
258 bool somethingDone = false;
259 while ((*a_stepsIt)->execute()) { // executes returns 'true' if the next step must be also executed (execute until can't stand no more)
261 // Check end of the test case:
262 if (done()) return false;
263 somethingDone = true;
266 return somethingDone;
269 bool TestCase::reset(bool hard) {
271 // Soft reset if finished:
272 if (!hard /* is soft reset */ && !isFinished()) return false;
274 // Dump as failed if still in progress (hard reset):
275 if (getState() == State::InProgress) {
276 addDebugSummaryHint("Testcase hard reset while in progress");
277 setState(State::Failed);
280 // Clean stage ////////////////////////////
282 std::vector<TestStep*>::iterator it;
283 for (it = a_steps.begin(); it != a_steps.end(); it++)
286 a_debugSummary.clear();
287 a_startTimestamp = 0;
288 a_finishTimestamp = 0;
289 a_interactiveAmount = -1;
291 setState(State::Initialized);
296 bool TestCase::safeToClear() {
298 // Check if any step is running (command steps):
299 std::vector<TestStep*>::const_iterator it;
300 for (it = a_steps.begin(); it != a_steps.end(); it++) {
301 if ((*it)->getType() == TestStep::Type::Cmd) {
302 const TestStepCmd *tscmd = static_cast<const TestStepCmd*>(*it);
303 if(tscmd->threadRunning())
311 void TestCase::assertInitialized() const noexcept(false) {
313 throw anna::RuntimeException(anna::functions::asString("Cannot program anymore. The test case %llu (%s) has finished. You must reset it to append new steps (or do it during execution, which is also allowed).", a_id, a_description.c_str()), ANNA_FILE_LOCATION);
316 std::string TestCase::assertMessage(const anna::DataBlock &db, bool toEntity) noexcept(false) {
320 bool isRequest = anna::diameter::codec::functions::isRequest(db);
321 bool registerKeys = ((isRequest && toEntity) || (!isRequest && !toEntity) /* (*) */);
322 // (*) we register answers Session-Id "assuming" that we will know the Session-Id values created by the client.
323 // This is another solution regarding diameter server testing. No sure about the final implementation.
324 // We will help registering also subscriber data, because certain messages (i.e. SLR) coming from clients could
325 // have specific Session-Id value (unknown at test programming), and normally are identified by subscriber.
329 anna::diameter::HopByHop hbh = anna::diameter::codec::functions::getHopByHop(db);
330 if (a_hopByHops.find(hbh) != a_hopByHops.end())
331 throw anna::RuntimeException(anna::functions::asString("Another request has been programmed with the same hop-by-hop (%llu) in this test case (%llu, '%s')", hbh, a_id, a_description.c_str()), ANNA_FILE_LOCATION);
332 a_hopByHops[hbh] = NULL; // may be assigned to a wait condition
336 TestManager &testManager = TestManager::instantiate();
337 key = anna::diameter::helpers::base::functions::getSessionId(db);
338 testManager.registerKey1(key, this);
341 key = anna::diameter::helpers::dcca::functions::getSubscriptionIdData(db, anna::diameter::helpers::dcca::AVPVALUES__Subscription_Id_Type::END_USER_E164);
342 if (key == "") // try with IMSI
343 key = anna::diameter::helpers::dcca::functions::getSubscriptionIdData(db, anna::diameter::helpers::dcca::AVPVALUES__Subscription_Id_Type::END_USER_IMSI);
346 testManager.registerKey2(key, this);
352 void TestCase::addTimeout(const anna::Millisecond &timeout) noexcept(false) {
354 TestStepTimeout *step = new TestStepTimeout(this);
355 step->setTimeout(timeout);
359 void TestCase::addSendDiameterXml2e(const anna::DataBlock &db, anna::diameter::comm::OriginHost *host, int stepNumber) noexcept(false) {
361 a_key = assertMessage(db, true /* to entity */);
363 if (stepNumber != -1) {
364 const TestStep *stepReferred = getStep(stepNumber);
366 throw anna::RuntimeException(anna::functions::asString("Step number (%d) do not exists (test case %llu, '%s')", stepNumber, a_id, a_description.c_str()), ANNA_FILE_LOCATION);
368 if (stepReferred->getType() != TestStep::Type::Wait)
369 throw anna::RuntimeException(anna::functions::asString("Step number (%d) must refer to a 'wait' step (test case %llu, '%s')", stepNumber, a_id, a_description.c_str()), ANNA_FILE_LOCATION);
371 const TestDiameterCondition &tc = (static_cast<const TestStepWaitDiameter*>(stepReferred))->getCondition();
372 if (tc.getCode() == "0") { // if regexp used, is not possible to detect this kind of errors
373 throw anna::RuntimeException(anna::functions::asString("Step number (%d) must refer to a 'wait for request' step (test case %llu, '%s')", stepNumber, a_id, a_description.c_str()), ANNA_FILE_LOCATION);
377 TestStepSendDiameterXml2e *step = new TestStepSendDiameterXml2e(this);
378 step->setMsgDataBlock(db);
379 step->setOriginHost(host);
380 step->setWaitForRequestStepNumber(stepNumber); // -1 means, no reference
384 void TestCase::addSendDiameterXml2c(const anna::DataBlock &db, anna::diameter::comm::OriginHost *host, int stepNumber) noexcept(false) {
386 a_key = assertMessage(db, false /* to client */);
388 if (stepNumber != -1) {
389 const TestStep *stepReferred = getStep(stepNumber);
391 throw anna::RuntimeException(anna::functions::asString("Step number (%d) do not exists (test case %llu, '%s')", stepNumber, a_id, a_description.c_str()), ANNA_FILE_LOCATION);
393 if (stepReferred->getType() != TestStep::Type::Wait)
394 throw anna::RuntimeException(anna::functions::asString("Step number (%d) must refer to a 'wait' step (test case %llu, '%s')", stepNumber, a_id, a_description.c_str()), ANNA_FILE_LOCATION);
396 const TestDiameterCondition &tc = (static_cast<const TestStepWaitDiameter*>(stepReferred))->getCondition();
397 if (tc.getCode() == "0") { // if regexp used, is not possible to detect this kind of errors
398 throw anna::RuntimeException(anna::functions::asString("Step number (%d) must refer to a 'wait for request' step (test case %llu, '%s')", stepNumber, a_id, a_description.c_str()), ANNA_FILE_LOCATION);
402 TestStepSendDiameterXml2c *step = new TestStepSendDiameterXml2c(this);
403 step->setMsgDataBlock(db);
404 step->setOriginHost(host);
405 step->setWaitForRequestStepNumber(stepNumber); // -1 means, no reference
409 void TestCase::addDelay(const anna::Millisecond &delay) noexcept(false) {
411 TestStepDelay *step = new TestStepDelay(this);
412 step->setDelay(delay);
416 void TestCase::addWaitDiameter(bool fromEntity,
417 const std::string &code, const std::string &bitR, const std::string &hopByHop, const std::string &applicationId,
418 const std::string &sessionId, const std::string &resultCode,
419 const std::string &msisdn, const std::string &imsi, const std::string &serviceContextId) noexcept(false) {
421 std::string usedHopByHop = hopByHop;
422 TestStepWaitDiameter *step = NULL;
424 // Check basic conditions:
426 if (resultCode != "")
427 throw anna::RuntimeException(anna::functions::asString("You cannot specify Result-Code (%s) for a wait condition of a diameter request message (test case %llu, '%s')", resultCode.c_str(), a_id, a_description.c_str()), ANNA_FILE_LOCATION);
429 throw anna::RuntimeException(anna::functions::asString("You cannot specify Hop-by-hop (%s) for a wait condition of a diameter request message (test case %llu, '%s')", hopByHop.c_str(), a_id, a_description.c_str()), ANNA_FILE_LOCATION);
432 if (hopByHop != "") {
433 if (hopByHop[0] == '#') {
435 throw anna::RuntimeException(anna::functions::asString("No steps has been programmed, step reference is nonsense (test case %llu, '%s')", a_id, a_description.c_str()), ANNA_FILE_LOCATION);
437 int stepNumber = atoi(hopByHop.substr(1).c_str());
439 const TestStep *stepReferred = getStep(stepNumber);
441 throw anna::RuntimeException(anna::functions::asString("Step reference number (%d) do not exists (test case %llu, '%s')", stepNumber, a_id, a_description.c_str()), ANNA_FILE_LOCATION);
443 if (stepReferred->getType() != TestStep::Type::Sendxml2e && stepReferred->getType() != TestStep::Type::Sendxml2c)
444 throw anna::RuntimeException(anna::functions::asString("Step number must refer to a 'sendxml2e' or 'sendxml2c' step (test case %llu, '%s')", a_id, a_description.c_str()), ANNA_FILE_LOCATION);
446 const anna::DataBlock &db = (static_cast<const TestStepSendDiameterXml*>(stepReferred))->getMsgDataBlock();
447 bool isAnswer = anna::diameter::codec::functions::isAnswer(db);
449 throw anna::RuntimeException(anna::functions::asString("Step number must refer to a request message (test case %llu, '%s')", a_id, a_description.c_str()), ANNA_FILE_LOCATION);
452 anna::diameter::HopByHop hbh = anna::diameter::codec::functions::getHopByHop(db);
453 usedHopByHop = anna::functions::asString(hbh);
454 step = new TestStepWaitDiameter(this);
455 a_hopByHops[hbh /* always exists: is the info we calculated above */] = step;
460 if (!step) step = new TestStepWaitDiameter(this);
461 step->setCondition(fromEntity, code, bitR, usedHopByHop, applicationId, sessionId, resultCode, msisdn, imsi, serviceContextId);
464 if (hasSameCondition(step->getCondition()))
465 anna::Logger::information(anna::functions::asString("The same wait condition has already been programmed in this test case (%llu, '%s'). Are you sure ?", a_id, a_description.c_str()), ANNA_FILE_LOCATION);
471 void TestCase::addWaitDiameterRegexpHex(bool fromEntity, const std::string ®exp) noexcept(false) {
474 TestStepWaitDiameter *step = new TestStepWaitDiameter(this);
475 step->setConditionRegexpHex(fromEntity, regexp);
478 if (hasSameCondition(step->getCondition()))
479 anna::Logger::information(anna::functions::asString("The same wait condition has already been programmed in this test case (%llu, '%s'). Are you sure ?", a_id, a_description.c_str()), ANNA_FILE_LOCATION);
485 void TestCase::addWaitDiameterRegexpXml(bool fromEntity, const std::string ®exp) noexcept(false) {
488 TestStepWaitDiameter *step = new TestStepWaitDiameter(this);
489 step->setConditionRegexpXml(fromEntity, regexp);
492 if (hasSameCondition(step->getCondition()))
493 anna::Logger::information(anna::functions::asString("The same wait condition has already been programmed in this test case (%llu, '%s'). Are you sure ?", a_id, a_description.c_str()), ANNA_FILE_LOCATION);
499 void TestCase::addCommand(const std::string &cmd) noexcept(false) {
502 TestStepCmd *step = new TestStepCmd(this);
503 step->setScript(cmd);
508 void TestCase::addIpLimit(unsigned int ipLimit) noexcept(false) {
511 TestStepIpLimit *step = new TestStepIpLimit(this);
512 step->setIpLimit(ipLimit);
517 TestStepWaitDiameter *TestCase::searchNextWaitConditionFulfilled(const anna::DataBlock &message, bool waitFromEntity) {
519 TestStepWaitDiameter *result;
520 for (std::vector<TestStep*>::const_iterator it = a_stepsIt /* current */; it != a_steps.end(); it++) {
521 if ((*it)->getType() != TestStep::Type::Wait) continue;
522 if ((*it)->isCompleted()) continue;
523 result = (TestStepWaitDiameter*)(*it);
524 if ((result->getCondition().receivedFromEntity() == waitFromEntity) && (result->fulfilled(message)))
531 const TestStep *TestCase::getStep(int stepNumber) const {
532 if (stepNumber < 1 || stepNumber > steps()) return NULL;
533 // return a_steps.at(stepNumber-1); // http://stackoverflow.com/questions/3269809/stdvectorat-vs-operator-surprising-results-5-to-10-times-slower-f
534 return a_steps[stepNumber-1];