Merge pull request #426 from telefonicaid/bug/pagination_details_on_n…

…ot_rendering Fix bug related with pagination
telefonicaid · Jun 23, 2014 · cd972a5 · cd972a5
2 parents c76b3b1 + f57819b
commit cd972a5
Show file tree

Hide file tree

Showing 10 changed files with 113 additions and 42 deletions.
diff --git a/src/lib/ngsi10/QueryContextResponse.cpp b/src/lib/ngsi10/QueryContextResponse.cpp
@@ -75,6 +75,27 @@ std::string QueryContextResponse::render(RequestType requestType, Format format,
 
   out += startTag(indent, tag, format, false);
 
+  if (contextElementResponseVector.size() > 0)
+  {
+    bool commaNeeded = (errorCode.code != SccNone);
+    out += contextElementResponseVector.render(QueryContext, format, indent + "  ", commaNeeded);
+  }
+
+  if (errorCode.code != SccNone)
+  {
+    out += errorCode.render(format, indent + "  ");
+  }
+
+  /* Safety check: neither errorCode nor CER vector was filled by mongoBackend */
+  if (errorCode.code == SccNone && contextElementResponseVector.size() == 0)
+  {
+      errorCode.fill(SccReceiverInternalError, "Both the error-code structure and the response vector were empty");
+      out += errorCode.render(format, indent + "  ");
+  }
+
+#if 0
+  // I needed to adjust rednder function for details=on to work. Ken, please review that this code can be safely removed, after the
+  // above re-factoring
   if ((errorCode.code == SccNone) || (errorCode.code == SccOk))
   {
     if (contextElementResponseVector.size() == 0)
@@ -89,6 +110,7 @@ std::string QueryContextResponse::render(RequestType requestType, Format format,
   }
   else
      out += errorCode.render(format, indent + "  ");
+#endif
 
   out += endTag(indent, tag, format);
 

diff --git a/src/lib/ngsi9/DiscoverContextAvailabilityResponse.cpp b/src/lib/ngsi9/DiscoverContextAvailabilityResponse.cpp
@@ -82,11 +82,33 @@ std::string DiscoverContextAvailabilityResponse::render(RequestType requestType,
   // no JSON commas necessary
   //
   out += startTag(indent, tag, format, false);
-
+
+  if (responseVector.size() > 0)
+  {
+    bool commaNeeded = (errorCode.code != SccNone);
+    out += responseVector.render(format, indent + "  ", commaNeeded);
+  }
+
+  if (errorCode.code != SccNone)
+  {
+    out += errorCode.render(format, indent + "  ", false);
+  }
+
+  /* Safety check: neither errorCode nor CER vector was filled by mongoBackend */
+  if (errorCode.code == SccNone && responseVector.size() == 0)
+  {
+      errorCode.fill(SccReceiverInternalError, "Both the error-code structure and the response vector were empty");
+      out += errorCode.render(format, indent + "  ");
+  }
+
+#if 0
+  // I needed to adjust rednder function for details=on to work. Ken, please review that this code can be safely removed, after the
+  // above re-factoring
   if (errorCode.code == SccNone)
      out += responseVector.render(format, indent + "  ", false);
   else
      out += errorCode.render(format, indent + "  ", false);
+#endif
 
   out += endTag(indent, tag, format);
 

diff --git a/test/unittests/ngsi10/QueryContextResponse_test.cpp b/test/unittests/ngsi10/QueryContextResponse_test.cpp
@@ -38,19 +38,14 @@ TEST(QueryContextResponse, ok_xml)
 {
   StatusCode*           ecP = new StatusCode(SccOk, "Detail");
   StatusCode            ec(SccOk, "Detail2");
-  QueryContextResponse  qcr1;
-  QueryContextResponse  qcr2(ec);
+  QueryContextResponse  qcr(ec);
   std::string           out;
-  const char*           outfile  = "ngsi10.queryContextResponse.notFound.valid.xml";
+  const char*           outfile  = "ngsi10.queryContextResponse.ok.valid.xml";
 
   utInit();
 
   EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), outfile)) << "Error getting test data from '" << outfile << "'";
-  out = qcr1.render(QueryContext, XML, "");
-  EXPECT_STREQ(expectedBuf, out.c_str());
-
-  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), outfile)) << "Error getting test data from '" << outfile << "'";
-  out = qcr2.render(QueryContext, XML, "");
+  out = qcr.render(QueryContext, XML, "");
   EXPECT_STREQ(expectedBuf, out.c_str());
 
   delete ecP;
@@ -212,6 +207,7 @@ TEST(QueryContextResponse, json_render)
   qcrP->errorCode.fill(SccOk);
 
   EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), filename12)) << "Error getting test data from '" << filename12 << "'";
+  qcrP->errorCode.code = SccNone;
   out = qcrP->render(QueryContext, JSON, "");
   EXPECT_STREQ(expectedBuf, out.c_str());
 
@@ -220,6 +216,7 @@ TEST(QueryContextResponse, json_render)
   qcrP->errorCode.fill(SccBadRequest, "no details");
 
   EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), filename13)) << "Error getting test data from '" << filename13 << "'";
+  qcrP->contextElementResponseVector.release();
   out = qcrP->render(QueryContext, JSON, "");
   EXPECT_STREQ(expectedBuf, out.c_str());
 

diff --git a/test/unittests/ngsi9/DiscoverContextAvailabilityResponse_test.cpp b/test/unittests/ngsi9/DiscoverContextAvailabilityResponse_test.cpp
@@ -48,7 +48,7 @@ TEST(DiscoverContextAvailabilityResponse, render)
 {
   DiscoverContextAvailabilityResponse  dcar1;
   std::string                          out;
-  const char*                          outfile1 = "ngsi9.discoverContextAvailabilityResponse.empty.invalid.xml";
+  const char*                          outfile1 = "ngsi9.discoverContextAvailabilityResponse.empty.valid.xml";
   const char*                          outfile2 = "ngsi9.discoverContextAvailabilityResponse.error.valid.xml";
   StatusCode                           ec(SccBadRequest, "Detail");
   DiscoverContextAvailabilityResponse  dcar2(ec);
@@ -58,7 +58,7 @@ TEST(DiscoverContextAvailabilityResponse, render)
   EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), outfile1)) << "Error getting test data from '" << outfile1 << "'";
   out = dcar1.render(DiscoverContextAvailability, XML, "");
   EXPECT_STREQ(expectedBuf, out.c_str());
-  EXPECT_EQ(SccNone, dcar1.errorCode.code);
+  EXPECT_EQ(SccReceiverInternalError, dcar1.errorCode.code);
 
   EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), outfile2)) << "Error getting test data from '" << outfile2 << "'";
   out = dcar2.render(DiscoverContextAvailability, XML, "");
@@ -99,6 +99,7 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   const char*                           filename18 = "ngsi9.discoverContextAvailabilityResponse.jsonRender18.valid.json";
   const char*                           filename19 = "ngsi9.discoverContextAvailabilityResponse.jsonRender19.valid.json";
   const char*                           filename20 = "ngsi9.discoverContextAvailabilityResponse.jsonRender20.valid.json";
+  const char*                           emptyFilename = "ngsi9.discoverContextAvailabilityResponse.jsonRender.empty.valid.json";
   std::string                           rendered;
   DiscoverContextAvailabilityResponse*  dcarP      = new DiscoverContextAvailabilityResponse();
   ContextRegistrationResponse*          crrP;
@@ -121,8 +122,11 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
   free(dcarP);
 
 
@@ -153,9 +157,10 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
-
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
 
 
   // 4.  ContextRegistration: One entityId inside entityIdVector
@@ -183,9 +188,10 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
-
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
 
 
   // 6.  ContextRegistration: one attribute in contextRegistrationAttributeVector
@@ -214,9 +220,10 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
-
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
 
 
   // 8.  ContextRegistration: one metadata in registrationMetadataVector
@@ -245,9 +252,10 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
-
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
 
 
   // 10. !entityIdVector !contextRegistrationAttributeVector !registrationMetadataVector +providingApplication
@@ -274,9 +282,10 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
-
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
 
 
   // 12. !entityIdVector +contextRegistrationAttributeVector !registrationMetadataVector +providingApplication
@@ -304,9 +313,10 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
-
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
 
 
   // 14. +entityIdVector !contextRegistrationAttributeVector !registrationMetadataVector +providingApplication
@@ -347,9 +357,10 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
-
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
 
 
   // 16. +entityIdVector +contextRegistrationAttributeVector !registrationMetadataVector +providingApplication
@@ -367,9 +378,10 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
-
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
 
 
   // 18. StatusCode
@@ -381,8 +393,9 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
 
   dcarP->release();
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
-
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
 
 
   // 19. StatusCode
@@ -393,8 +406,10 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
+  dcarP->release();  // ... otherwise the 500 remains and "pollutes" next tests
 
 
   // 20. Two ContextRegistrationResponses
@@ -417,8 +432,9 @@ TEST(DiscoverContextAvailabilityResponse, jsonRender)
   EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   dcarP->release();
+  EXPECT_EQ("OK", testDataFromFile(expectedBuf, sizeof(expectedBuf), emptyFilename)) << "Error getting test data from '" << emptyFilename << "'";
   rendered = dcarP->render(DiscoverContextAvailability, JSON, "");
-  EXPECT_STREQ(EMPTY_JSON, rendered.c_str());
+  EXPECT_STREQ(expectedBuf, rendered.c_str());
 
   free(dcarP);
 

diff --git a/test/unittests/testData/ngsi10.queryContextResponse.notFound.valid.xml b/test/unittests/testData/ngsi10.queryContextResponse.notFound.valid.xml
diff --git a/test/unittests/testData/ngsi10.queryContextResponse.ok.valid.xml b/test/unittests/testData/ngsi10.queryContextResponse.ok.valid.xml
@@ -0,0 +1,7 @@
+<queryContextResponse>
+  <errorCode>
+    <code>200</code>
+    <reasonPhrase>OK</reasonPhrase>
+    <details>Detail2</details>
+  </errorCode>
+</queryContextResponse>
diff --git a/test/unittests/testData/ngsi10.restReply.queryContextResponse01.ok.valid.xml b/test/unittests/testData/ngsi10.restReply.queryContextResponse01.ok.valid.xml
@@ -1,6 +1,7 @@
 <queryContextResponse>
   <errorCode>
-    <code>404</code>
-    <reasonPhrase>No context element found</reasonPhrase>
+    <code>200</code>
+    <reasonPhrase>OK</reasonPhrase>
+    <details>detail</details>
   </errorCode>
 </queryContextResponse>
diff --git a/test/unittests/testData/ngsi9.discoverContextAvailabilityResponse.empty.invalid.xml b/test/unittests/testData/ngsi9.discoverContextAvailabilityResponse.empty.invalid.xml
diff --git a/test/unittests/testData/ngsi9.discoverContextAvailabilityResponse.empty.valid.xml b/test/unittests/testData/ngsi9.discoverContextAvailabilityResponse.empty.valid.xml
@@ -0,0 +1,7 @@
+<discoverContextAvailabilityResponse>
+  <errorCode>
+    <code>500</code>
+    <reasonPhrase>Internal Server Error</reasonPhrase>
+    <details>Both the error-code structure and the response vector were empty</details>
+  </errorCode>
+</discoverContextAvailabilityResponse>
diff --git a/.../unittests/testData/ngsi9.discoverContextAvailabilityResponse.jsonRender.empty.valid.json b/.../unittests/testData/ngsi9.discoverContextAvailabilityResponse.jsonRender.empty.valid.json
@@ -0,0 +1,7 @@
+{
+  "errorCode" : {
+    "code" : "500",
+    "reasonPhrase" : "Internal Server Error",
+    "details" : "Both the error-code structure and the response vector were empty"
+  }
+}