Extend CCDB interface to get past data (QC-186) (#181)

* QC-186 extend CCDB interface to get past data

* fix for CC7

* formatting

Author: Barthelemy

Framework/include/QualityControl/CcdbDatabase.h

@@ -55,18 +55,18 @@ class CcdbDatabase : public DatabaseInterface
   void connect(std::string host, std::string database, std::string username, std::string password) override;
   void connect(const std::unordered_map<std::string, std::string>& config) override;
   void store(std::shared_ptr<o2::quality_control::core::MonitorObject> mo) override;
-  core::MonitorObject* retrieve(std::string taskName, std::string objectName) override;
+  core::MonitorObject* retrieve(std::string taskName, std::string objectName, long timestamp = 0) override;
   std::string retrieveJson(std::string taskName, std::string objectName) override;
   void disconnect() override;
   void prepareTaskDataContainer(std::string taskName) override;
   std::vector<std::string> getListOfTasksWithPublications() override;
   std::vector<std::string> getPublishedObjectNames(std::string taskName) override;
   void truncate(std::string taskName, std::string objectName) override;
   void storeStreamerInfosToFile(std::string filename);
-
- private:
   static long getCurrentTimestamp();
   static long getFutureTimestamp(int secondsInFuture);
+
+ private:
   /**
    * \brief Load StreamerInfos from a ROOT file.
    * When we were not saving TFiles in the CCDB, we streamed ROOT objects without their StreamerInfos.

Framework/include/QualityControl/DatabaseInterface.h

@@ -65,7 +65,7 @@ class DatabaseInterface
    * templates)
    * TODO evaluate whether we should have a method to retrieve a list of objects (optimization)
    */
-  virtual o2::quality_control::core::MonitorObject* retrieve(std::string taskName, std::string objectName) = 0;
+  virtual o2::quality_control::core::MonitorObject* retrieve(std::string taskName, std::string objectName, long timestamp = 0) = 0;
 
   /**
    * Returns JSON encoded object

Framework/include/QualityControl/MySqlDatabase.h

@@ -39,7 +39,7 @@ class MySqlDatabase : public DatabaseInterface
   void connect(std::string host, std::string database, std::string username, std::string password) override;
   void connect(const std::unordered_map<std::string, std::string>& config) override;
   void store(std::shared_ptr<o2::quality_control::core::MonitorObject> mo) override;
-  o2::quality_control::core::MonitorObject* retrieve(std::string taskName, std::string objectName) override;
+  o2::quality_control::core::MonitorObject* retrieve(std::string taskName, std::string objectName, long timestamp = 0) override;
   std::string retrieveJson(std::string taskName, std::string objectName) override;
   void disconnect() override;
   std::vector<std::string> getPublishedObjectNames(std::string taskName) override;

Framework/src/CcdbDatabase.cxx

@@ -114,16 +114,17 @@ void CcdbDatabase::store(std::shared_ptr<o2::quality_control::core::MonitorObjec
   ccdbApi.store(mo.get(), path, metadata, from, to);
 }
 
-core::MonitorObject* CcdbDatabase::retrieve(std::string taskName, std::string objectName)
+core::MonitorObject* CcdbDatabase::retrieve(std::string taskName, std::string objectName, long timestamp)
 {
   string path = taskName + "/" + objectName;
   map<string, string> metadata;
+  long when = timestamp == 0 ? getCurrentTimestamp() : timestamp;
 
   // we try first to load a TFile
-  TObject* object = ccdbApi.retrieveFromTFile(path, metadata, getCurrentTimestamp());
+  TObject* object = ccdbApi.retrieveFromTFile(path, metadata, when);
   if (object == nullptr) {
     // We could not open a TFile we should now try to open an object directly serialized
-    object = ccdbApi.retrieve(path, metadata, getCurrentTimestamp());
+    object = ccdbApi.retrieve(path, metadata, when);
     LOG(INFO) << "We could retrieve the object " << path << " as a streamed object.";
     if (object == nullptr) {
       return nullptr;

Framework/src/MySqlDatabase.cxx

@@ -161,8 +161,10 @@ void MySqlDatabase::storeForTask(std::string taskName)
   objects.clear();
 }
 
-o2::quality_control::core::MonitorObject* MySqlDatabase::retrieve(std::string taskName, std::string objectName)
+o2::quality_control::core::MonitorObject* MySqlDatabase::retrieve(std::string taskName, std::string objectName, long timestamp)
 {
+  // TODO use the timestamp
+
   string query;
   TMySQLStatement* statement = nullptr;
 

Framework/test/testCcdbDatabase.cxx

@@ -11,10 +11,12 @@
 ///
 /// \file   testCcdbDatabase.cxx
 /// \author Adam Wegrzynek
+/// \author Bartheley von Haller
 ///
 
 #include <QualityControl/DatabaseFactory.h>
 #include <unordered_map>
+#include <QualityControl/CcdbDatabase.h>
 
 #define BOOST_TEST_MODULE CcdbDatabase test
 #define BOOST_TEST_MAIN
@@ -26,6 +28,8 @@
 #include <TH1F.h>
 #include <TFile.h>
 
+namespace utf = boost::unit_test;
+
 namespace o2::quality_control::core
 {
 
@@ -83,7 +87,7 @@ BOOST_AUTO_TEST_CASE(ccdb_store)
   f.backend->store(mo1);
 }
 
-BOOST_AUTO_TEST_CASE(ccdb_retrieve)
+BOOST_AUTO_TEST_CASE(ccdb_retrieve, *utf::depends_on("ccdb_store"))
 {
   test_fixture f;
   MonitorObject* mo = f.backend->retrieve("my/task", "asdf/asdf");
@@ -124,5 +128,37 @@ BOOST_AUTO_TEST_CASE(ccdb_retrievejson)
   }
 }
 
+BOOST_AUTO_TEST_CASE(ccdb_retrieve_former_versions, *utf::depends_on("ccdb_store"))
+{
+  // store a new object
+  long initialTimestamp = CcdbDatabase::getCurrentTimestamp();
+  test_fixture f;
+  TH1F* h1 = new TH1F("asdf/asdf", "asdf", 100, 0, 99);
+  h1->FillRandom("gaus", 10001);
+  shared_ptr<MonitorObject> mo1 = make_shared<MonitorObject>(h1, "my/task");
+  f.backend->store(mo1);
+
+  // Retrieve old object stored at timestampStorage
+  MonitorObject* mo = f.backend->retrieve("my/task", "asdf/asdf", initialTimestamp);
+  BOOST_CHECK_NE(mo, nullptr);
+  TH1F* old = dynamic_cast<TH1F*>(mo->getObject());
+  BOOST_CHECK_NE(old, nullptr);
+  BOOST_CHECK_EQUAL(old->GetEntries(), 10000);
+
+  // Retrieve latest object with timestamp
+  MonitorObject* mo2 = f.backend->retrieve("my/task", "asdf/asdf", CcdbDatabase::getCurrentTimestamp());
+  BOOST_CHECK_NE(mo2, nullptr);
+  TH1F* latest = dynamic_cast<TH1F*>(mo2->getObject());
+  BOOST_CHECK_NE(latest, nullptr);
+  BOOST_CHECK_EQUAL(latest->GetEntries(), 10001);
+
+  // Retrieve latest object without timetsamp
+  MonitorObject* mo3 = f.backend->retrieve("my/task", "asdf/asdf");
+  BOOST_CHECK_NE(mo3, nullptr);
+  TH1F* latest2 = dynamic_cast<TH1F*>(mo3->getObject());
+  BOOST_CHECK_NE(latest2, nullptr);
+  BOOST_CHECK_EQUAL(latest2->GetEntries(), 10001);
+}
+
 } // namespace
 } // namespace o2::quality_control::core