QPR-12349 improve error message so that it is clear which report is causing the problem

Author: pcaspers

OREData/ored/report/csvreport.cpp

@@ -91,10 +91,9 @@ class ReportTypePrinter : public boost::static_visitor<> {
 };
 
 CSVFileReport::CSVFileReport(const string& filename, const char sep, const bool commentCharacter, char quoteChar,
-                             const string& nullString, bool lowerHeader,
-                             QuantLib::Size rolloverSize)
+                             const string& nullString, bool lowerHeader, QuantLib::Size rolloverSize)
     : filename_(filename), sep_(sep), commentCharacter_(commentCharacter), quoteChar_(quoteChar),
-      nullString_(nullString), lowerHeader_(lowerHeader), rolloverSize_(rolloverSize), i_(0), fp_(NULL) {    
+      nullString_(nullString), lowerHeader_(lowerHeader), rolloverSize_(rolloverSize), i_(0), fp_(NULL) {
     baseFilename_ = filename_;
     open();
 }
@@ -121,7 +120,8 @@ void CSVFileReport::rollover() {
     version_++;
     boost::filesystem::path p(baseFilename_);
     boost::filesystem::path newFilepath =
-        p.parent_path() / boost::filesystem::path(p.stem().string() + "_" + to_string(version_) + p.extension().string());
+        p.parent_path() /
+        boost::filesystem::path(p.stem().string() + "_" + to_string(version_) + p.extension().string());
     filename_ = newFilepath.string();
     open();
 }
@@ -135,6 +135,7 @@ void CSVFileReport::flush() {
 Report& CSVFileReport::addColumn(const string& name, const ReportType& rt, Size precision) {
     checkIsOpen("addColumn(" + name + ")");
     columnTypes_.push_back(rt);
+    headers_.push_back(name);
     printers_.push_back(ReportTypePrinter(fp_, precision, quoteChar_, nullString_));
     if (i_ == 0 && commentCharacter_)
         fprintf(fp_, "#");
@@ -162,18 +163,22 @@ Report& CSVFileReport::next() {
     }
 
     checkIsOpen("next()");
-    QL_REQUIRE(i_ == columnTypes_.size(), "Cannot go to next line, only " << i_ << " entries filled");
+    QL_REQUIRE(i_ == columnTypes_.size(), "Cannot go to next line, only "
+                                              << i_
+                                              << " entries filled, report headers are: " << boost::join(headers_, ","));
     fprintf(fp_, "\n");
     i_ = 0;    
     return *this;
 }
 
 Report& CSVFileReport::add(const ReportType& rt) {
     checkIsOpen("add()");
-    QL_REQUIRE(i_ < columnTypes_.size(), "No column to add [" << rt << "] to.");
-    QL_REQUIRE(rt.which() == columnTypes_[i_].which(), "Cannot add value " << rt << " of type " << rt.which()
-                                                                           << " to column " << i_ << " of type "
-                                                                           << columnTypes_[i_].which());
+    QL_REQUIRE(i_ < columnTypes_.size(),
+               "No column to add [" << rt << "] to, report headers are: " << boost::join(headers_, ","));
+    QL_REQUIRE(rt.which() == columnTypes_[i_].which(), "Cannot add value "
+                                                           << rt << " of type " << rt.which() << " to column " << i_
+                                                           << " of type " << columnTypes_[i_].which()
+                                                           << ", report headers are: " << boost::join(headers_, ","));
 
     if (i_ != 0)
         fprintf(fp_, "%c", sep_);
@@ -197,13 +202,14 @@ void CSVFileReport::end() {
     }
 
     QL_REQUIRE(i_ == columnTypes_.size() || i_ == 0, "csv report is finalized with incomplete row, got data for "
-                                                         << i_ << " columns out of " << columnTypes_.size());
+                                                         << i_ << " columns out of " << columnTypes_.size()
+                                                         << ", report headers are: " << boost::join(headers_, ","));
     finalized_ = true;
 }
 
 void CSVFileReport::checkIsOpen(const std::string& op) const {
-    QL_REQUIRE(!finalized_,
-               "CSV file report '" << filename_ << "' is already finalized, can not process operation " << op);
+    QL_REQUIRE(!finalized_, "CSV file report '" << filename_ << "' is already finalized, can not process operation "
+                                                << op << ", report headers are: " << boost::join(headers_, ","));
 }
 
 } // namespace data

OREData/ored/report/csvreport.hpp

@@ -76,6 +76,7 @@ class CSVFileReport : public Report {
     Size version_ = 0;
     FILE* fp_;
     bool finalized_ = false;
+    vector<string> headers_;
 };
 } // namespace data
 } // namespace ore

OREData/ored/report/inmemoryreport.cpp

@@ -16,7 +16,7 @@
  FITNESS FOR A PARTICULAR PURPOSE. See the license for more details.
 */
 
-#include <ored/report/inmemoryreport.hpp> 
+#include <ored/report/inmemoryreport.hpp>
 
 namespace ore {
 namespace data {
@@ -31,31 +31,36 @@ Report& InMemoryReport::addColumn(const string& name, const ReportType& rt, Size
 }
 
 Report& InMemoryReport::next() {
-    QL_REQUIRE(i_ == headers_.size(), "Cannot go to next line, only " << i_ << " entires filled");
+    QL_REQUIRE(i_ == headers_.size(), "Cannot go to next line, only " << i_ << " entires filled, report headers are: "
+                                                                      << boost::join(headers_, ","));
     i_ = 0;
     return *this;
 }
 
 Report& InMemoryReport::add(const ReportType& rt) {
     // check type is valid
     QL_REQUIRE(i_ < headers_.size(), "No column to add [" << rt << "] to.");
-    QL_REQUIRE(rt.which() == columnTypes_[i_].which(),
-                "Cannot add value " << rt << " of type " << rt.which() << " to column " << headers_[i_]
-                                    << " of type " << columnTypes_[i_].which());
+    QL_REQUIRE(rt.which() == columnTypes_[i_].which(), "Cannot add value "
+                                                           << rt << " of type " << rt.which() << " to column "
+                                                           << headers_[i_] << " of type " << columnTypes_[i_].which()
+                                                           << ", report headers are: " << boost::join(headers_, ","));
 
     data_[i_].push_back(rt);
     i_++;
     return *this;
 }
 
 Report& InMemoryReport::add(const InMemoryReport& report) {
-    QL_REQUIRE(columns() == report.columns(),
-                "Cannot combine reports of different sizes (" << columns() << " vs " << report.columns() << ").");
+    QL_REQUIRE(columns() == report.columns(), "Cannot combine reports of different sizes ("
+                                                  << columns() << " vs " << report.columns()
+                                                  << "), report headers are: " << boost::join(headers_, ","));
     end();
     for (Size i = 0; i < columns(); i++) {
         string h1 = headers_[i];
         string h2 = report.header(i);
-        QL_REQUIRE(h1 == h2, "Cannot combine reports with different headers (\"" << h1 << "\" and \"" << h2 << "\")");
+        QL_REQUIRE(h1 == h2, "Cannot combine reports with different headers (\""
+                                 << h1 << "\" and \"" << h2
+                                 << "\"), report headers are: " << boost::join(headers_, ","));
     }
 
     if (i_ == headers_.size())
@@ -72,19 +77,21 @@ Report& InMemoryReport::add(const InMemoryReport& report) {
 }
 
 void InMemoryReport::end() {
-    QL_REQUIRE(i_ == headers_.size() || i_ == 0,
-                "report is finalized with incomplete row, got data for " << i_ << " columns out of " << columns());
+    QL_REQUIRE(i_ == headers_.size() || i_ == 0, "report is finalized with incomplete row, got data for "
+                                                     << i_ << " columns out of " << columns()
+                                                     << ", report headers are: " << boost::join(headers_, ","));
 }
 
 const vector<Report::ReportType>& InMemoryReport::data(Size i) const {
     QL_REQUIRE(data_[i].size() == rows(), "internal error: report column "
-                                                << i << " (" << header(i) << ") contains " << data_[i].size()
-                                                << " rows, expected are " << rows() << " rows.");
+                                              << i << " (" << header(i) << ") contains " << data_[i].size()
+                                              << " rows, expected are " << rows()
+                                              << " rows, report headers are: " << boost::join(headers_, ","));
     return data_[i];
 }
 
 void InMemoryReport::toFile(const string& filename, const char sep, const bool commentCharacter, char quoteChar,
-            const string& nullString, bool lowerHeader) {
+                            const string& nullString, bool lowerHeader) {
 
     CSVFileReport cReport(filename, sep, commentCharacter, quoteChar, nullString, lowerHeader);