[QC-1083] Introduce a start/end of activity method in checkInterface … (#2082)

* [QC-1083] Introduce a start/end of activity method in checkInterface and aggregatorInterface

* fix test

* fix

* fix

* remove activity from interface

* fix for detectors

* fix

* fix

* format

---------

Co-authored-by: Barthelemy von Haller <bvonhall@cern.ch>

Author: Barthelemy

Framework/CMakeLists.txt

@@ -46,6 +46,7 @@ add_library(O2QualityControl
   src/CheckRunnerFactory.cxx
   src/AggregatorRunnerFactory.cxx
   src/CheckInterface.cxx
+  src/AggregatorInterface.cxx
   src/DatabaseFactory.cxx
   src/CcdbDatabase.cxx
   src/QcInfoLogger.cxx

Framework/include/QualityControl/Aggregator.h

@@ -75,7 +75,8 @@ class Aggregator
   std::vector<AggregatorSource> getSources() const;
   std::vector<AggregatorSource> getSources(core::DataSourceType type);
   const std::string& getDetector() const { return mAggregatorConfig.detectorName; };
-  void setActivity(std::shared_ptr<core::Activity> activity);
+  void startOfActivity(const core::Activity& activity);
+  void endOfActivity(const core::Activity& activity);
 
   static AggregatorConfig extractConfig(const core::CommonSpec&, const AggregatorSpec&);
 

Framework/include/QualityControl/AggregatorInterface.h

@@ -17,12 +17,12 @@
 #ifndef QC_CHECKER_AGGREGATORINTERFACE_H
 #define QC_CHECKER_AGGREGATORINTERFACE_H
 
-#include <unordered_map>
 #include <map>
 
 #include "QualityControl/QualityObject.h"
 #include "QualityControl/UserCodeInterface.h"
 #include "QualityControl/Quality.h"
+#include "QualityControl/Activity.h"
 
 namespace o2::quality_control::checker
 {
@@ -42,15 +42,12 @@ class AggregatorInterface : public o2::quality_control::core::UserCodeInterface
   ///
   /// @param qoMap A map of the the QualityObjects to aggregate and their full names.
   /// @return The new qualities, associated with a name.
-  virtual std::map<std::string, o2::quality_control::core::Quality> aggregate(std::map<std::string, std::shared_ptr<const o2::quality_control::core::QualityObject>>& qoMap) = 0;
+  virtual std::map<std::string, core::Quality> aggregate(std::map<std::string, std::shared_ptr<const core::QualityObject>>& qoMap) = 0;
 
-  void setActivity(std::shared_ptr<core::Activity> activity) { mActivity = activity; }
-  std::shared_ptr<const core::Activity> getActivity() const { return mActivity; }
+  virtual void startOfActivity(const core::Activity& activity);
+  virtual void endOfActivity(const core::Activity& activity);
 
- private:
-  std::shared_ptr<core::Activity> mActivity; // TODO should probably go to UserCodeInterface
-
-  ClassDef(AggregatorInterface, 3)
+  ClassDef(AggregatorInterface, 4)
 };
 
 } // namespace o2::quality_control::checker

Framework/include/QualityControl/Check.h

@@ -69,7 +69,8 @@ class Check
   o2::framework::Inputs getInputs() const { return mCheckConfig.inputSpecs; };
   const std::string& getDetector() const { return mCheckConfig.detectorName; };
   const CheckConfig& getConfig() const { return mCheckConfig; };
-  void setActivity(std::shared_ptr<core::Activity> activity);
+  void startOfActivity(const core::Activity& activity);
+  void endOfActivity(const core::Activity& activity);
 
   //TODO: Unique Input string
   static o2::header::DataDescription createCheckDataDescription(const std::string& checkName);

Framework/include/QualityControl/CheckInterface.h

@@ -19,14 +19,14 @@
 
 #include "QualityControl/Quality.h"
 #include "QualityControl/UserCodeInterface.h"
+#include "QualityControl/Activity.h"
 
 namespace o2::quality_control::core
 {
 class Activity;
 class MonitorObject;
 }
 
-// todo: do not expose other namespaces in headers
 using namespace o2::quality_control::core;
 
 namespace o2::quality_control::checker
@@ -35,7 +35,7 @@ namespace o2::quality_control::checker
 /// \brief  Skeleton of a check.
 ///
 /// \author Barthelemy von Haller
-class CheckInterface : public UserCodeInterface
+class CheckInterface : public core::UserCodeInterface
 {
  public:
   /// Default constructor
@@ -47,7 +47,7 @@ class CheckInterface : public UserCodeInterface
   ///
   /// @param moMap A map of the the MonitorObjects to check and their full names.
   /// @return The quality associated with these objects.
-  virtual core::Quality check(std::map<std::string, std::shared_ptr<MonitorObject>>* moMap) = 0;
+  virtual core::Quality check(std::map<std::string, std::shared_ptr<core::MonitorObject>>* moMap) = 0;
 
   /// \brief Modify the aspect of the plot.
   ///
@@ -76,20 +76,17 @@ class CheckInterface : public UserCodeInterface
   /// If the class does not override it, we return "TObject".
   virtual std::string getAcceptedType();
 
-  void setActivity(std::shared_ptr<core::Activity> activity) { mActivity = activity; }
-  std::shared_ptr<const core::Activity> getActivity() const { return mActivity; }
-
   bool isObjectCheckable(const std::shared_ptr<core::MonitorObject> mo);
   bool isObjectCheckable(const core::MonitorObject* mo);
 
+  virtual void startOfActivity(const core::Activity& activity); // not fully abstract because we don't want to change all the existing subclasses
+  virtual void endOfActivity(const core::Activity& activity);   // not fully abstract because we don't want to change all the existing subclasses
+
  protected:
   /// \brief Called each time mCustomParameters is updated.
   virtual void configure() override;
 
- private:
-  std::shared_ptr<core::Activity> mActivity;
-
-  ClassDef(CheckInterface, 5)
+  ClassDef(CheckInterface, 6)
 };
 
 } // namespace o2::quality_control::checker

Framework/src/Aggregator.cxx

@@ -224,12 +224,21 @@ AggregatorConfig Aggregator::extractConfig(const core::CommonSpec& commonSpec, c
   };
 }
 
-void Aggregator::setActivity(std::shared_ptr<core::Activity> activity)
+void Aggregator::startOfActivity(const core::Activity& activity)
 {
   if (mAggregatorInterface) {
-    mAggregatorInterface->setActivity(std::move(activity));
+    mAggregatorInterface->startOfActivity(activity);
   } else {
-    throw std::runtime_error("Trying to set Activity on an empty AggregatorInterface '" + mAggregatorConfig.name + "'");
+    throw std::runtime_error("Trying to start an Activity on an empty AggregatorInterface '" + mAggregatorConfig.name + "'");
+  }
+}
+
+void Aggregator::endOfActivity(const core::Activity& activity)
+{
+  if (mAggregatorInterface) {
+    mAggregatorInterface->endOfActivity(activity);
+  } else {
+    throw std::runtime_error("Trying to end an Activity on an empty AggregatorInterface '" + mAggregatorConfig.name + "'");
   }
 }
 

Framework/src/AggregatorInterface.cxx

@@ -0,0 +1,35 @@
+// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+///
+/// \file   AggregatorInterface.cxx
+/// \author Barthelemy von Haller
+///
+
+#include "QualityControl/AggregatorInterface.h"
+
+using namespace std;
+using namespace o2::quality_control::core;
+
+namespace o2::quality_control::checker
+{
+
+void AggregatorInterface::startOfActivity(const Activity& activity)
+{
+  // noop, override it if you want.
+}
+
+void AggregatorInterface::endOfActivity(const Activity& activity)
+{
+  // noop, override it if you want.
+}
+
+} // namespace o2::quality_control::checker

Framework/src/AggregatorRunner.cxx

@@ -400,7 +400,7 @@ void AggregatorRunner::start(ServiceRegistryRef services)
   QcInfoLogger::setPartition(mActivity->mPartitionName);
   ILOG(Info, Support) << "Starting run " << mActivity->mId << ENDM;
   for (auto& aggregator : mAggregators) {
-    aggregator->setActivity(mActivity);
+    aggregator->startOfActivity(*mActivity);
   }
 
   // register ourselves to the BK
@@ -417,6 +417,9 @@ void AggregatorRunner::start(ServiceRegistryRef services)
 void AggregatorRunner::stop()
 {
   ILOG(Info, Support) << "Stopping run " << mActivity->mId << ENDM;
+  for (auto& aggregator : mAggregators) {
+    aggregator->endOfActivity(*mActivity);
+  }
 }
 
 void AggregatorRunner::reset()

Framework/src/Check.cxx

@@ -30,6 +30,8 @@
 #include "QualityControl/QcInfoLogger.h"
 #include "QualityControl/Quality.h"
 
+#include <QualityControl/AggregatorRunner.h>
+
 using namespace AliceO2::Common;
 using namespace AliceO2::InfoLogger;
 
@@ -268,12 +270,21 @@ framework::OutputSpec Check::createOutputSpec(const std::string& checkName)
   return { "QC", createCheckDataDescription(checkName), 0, framework::Lifetime::Sporadic };
 }
 
-void Check::setActivity(std::shared_ptr<core::Activity> activity)
+void Check::startOfActivity(const core::Activity& activity)
+{
+  if (mCheckInterface) {
+    mCheckInterface->startOfActivity(activity);
+  } else {
+    throw std::runtime_error("Trying to start an Activity on an empty CheckInterface '" + mCheckConfig.name + "'");
+  }
+}
+
+void Check::endOfActivity(const core::Activity& activity)
 {
   if (mCheckInterface) {
-    mCheckInterface->setActivity(std::move(activity));
+    mCheckInterface->endOfActivity(activity);
   } else {
-    throw std::runtime_error("Trying to set Activity on an empty CheckInterface '" + mCheckConfig.name + "'");
+    throw std::runtime_error("Trying to stop an Activity on an empty CheckInterface '" + mCheckConfig.name + "'");
   }
 }
 

Framework/src/CheckInterface.cxx

@@ -19,9 +19,8 @@
 
 #include <TClass.h>
 
-ClassImp(o2::quality_control::checker::CheckInterface)
-
-  using namespace std;
+using namespace std;
+using namespace o2::quality_control::core;
 
 namespace o2::quality_control::checker
 {
@@ -50,4 +49,14 @@ void CheckInterface::reset()
   // noop, override it if you want.
 }
 
+void CheckInterface::startOfActivity(const Activity& activity)
+{
+  // noop, override it if you want.
+}
+
+void CheckInterface::endOfActivity(const Activity& activity)
+{
+  // noop, override it if you want.
+}
+
 } // namespace o2::quality_control::checker