Add userCodeName and dataSources to UserCodeConfig (#2636)

knopers8 · web-flow · commit c4d6848e9b7d · 2026-02-05T09:42:00.000+01:00
Since all of the UserCodeConfig children share a name and data sources, we can brings them to the parent.
diff --git a/Framework/include/QualityControl/AggregatorConfig.h b/Framework/include/QualityControl/AggregatorConfig.h
@@ -31,7 +31,6 @@ namespace o2::quality_control::checker
 
 /// \brief  Container for the configuration of an Aggregator.
 struct AggregatorConfig : public o2::quality_control::core::UserCodeConfig {
-  std::string name;
   UpdatePolicyType policyType = UpdatePolicyType::OnAny;
   std::vector<std::string> objectNames{}; // fixme: if object names are empty, allObjects are true, consider reducing to one var // fixme: duplicates "sources"
   bool allObjects = false;
diff --git a/Framework/include/QualityControl/CheckConfig.h b/Framework/include/QualityControl/CheckConfig.h
@@ -29,7 +29,6 @@ namespace o2::quality_control::checker
 
 /// \brief  Container for the configuration of a Check.
 struct CheckConfig : public o2::quality_control::core::UserCodeConfig {
-  std::string name;
   UpdatePolicyType policyType = UpdatePolicyType::OnAny;
   std::vector<std::string> objectNames{}; // fixme: if object names are empty, allObjects are true, consider reducing to one var
   bool allObjects = false;
diff --git a/Framework/include/QualityControl/TaskRunnerConfig.h b/Framework/include/QualityControl/TaskRunnerConfig.h
@@ -42,7 +42,6 @@ namespace o2::quality_control::core
 /// \brief  Container for the configuration of a Task
 struct TaskRunnerConfig : public UserCodeConfig {
   std::string deviceName;
-  std::string taskName;
   std::vector<std::pair<size_t, size_t>> cycleDurations = {};
   int maxNumberCycles;
   bool critical;
diff --git a/Framework/include/QualityControl/UserCodeConfig.h b/Framework/include/QualityControl/UserCodeConfig.h
@@ -19,19 +19,22 @@
 
 #include "QualityControl/CustomParameters.h"
 #include "QualityControl/stringUtils.h"
+#include "QualityControl/DataSourceSpec.h"
 
 namespace o2::quality_control::core
 {
 
 /// \brief  Container for the configuration of a Task
 struct UserCodeConfig {
+  std::string name; // task name, check name, etc...
   std::string moduleName;
   std::string className;
   std::string detectorName = "MISC"; // intended to be the 3 letters code;
   std::string consulUrl;
   CustomParameters customParameters;
   std::string ccdbUrl;
   std::unordered_map<std::string, std::string> repository; // we need the full config of the database to build the database in the subclasses
+  std::vector<DataSourceSpec> dataSources;
 };
 
 } // namespace o2::quality_control::core
diff --git a/Framework/src/Aggregator.cxx b/Framework/src/Aggregator.cxx
@@ -240,14 +240,15 @@ AggregatorConfig Aggregator::extractConfig(const core::CommonSpec& commonSpec, c
   }
 
   return {
+    aggregatorSpec.aggregatorName,
     aggregatorSpec.moduleName,
     aggregatorSpec.className,
     aggregatorSpec.detectorName,
     commonSpec.consulUrl,
     aggregatorSpec.customParameters,
     commonSpec.conditionDBUrl,
     commonSpec.database,
-    aggregatorSpec.aggregatorName,
+    aggregatorSpec.dataSources,
     updatePolicy,
     std::move(objectNames),
     checkAllObjects,
diff --git a/Framework/src/Check.cxx b/Framework/src/Check.cxx
@@ -267,14 +267,15 @@ CheckConfig Check::extractConfig(const CommonSpec& commonSpec, const CheckSpec&
   }
 
   return {
+    checkSpec.checkName,
     checkSpec.moduleName,
     checkSpec.className,
     checkSpec.detectorName,
     commonSpec.consulUrl,
     checkSpec.customParameters,
     commonSpec.conditionDBUrl,
     commonSpec.database,
-    checkSpec.checkName,
+    checkSpec.dataSources,
     updatePolicy,
     std::move(objectNames),
     checkAllObjects,
diff --git a/Framework/src/TaskFactory.cxx b/Framework/src/TaskFactory.cxx
@@ -24,7 +24,7 @@ namespace o2::quality_control::core
 TaskInterface* TaskFactory::create(const TaskRunnerConfig& taskConfig, std::shared_ptr<ObjectsManager> objectsManager)
 {
   auto* result = root_class_factory::create<TaskInterface>(taskConfig.moduleName, taskConfig.className);
-  result->setName(taskConfig.taskName);
+  result->setName(taskConfig.name);
   result->setObjectsManager(objectsManager);
   result->setCustomParameters(taskConfig.customParameters);
   result->setCcdbUrl(taskConfig.ccdbUrl);
diff --git a/Framework/src/TaskRunner.cxx b/Framework/src/TaskRunner.cxx
@@ -85,7 +85,7 @@ TaskRunner::~TaskRunner()
 
 void TaskRunner::init(InitContext& iCtx)
 {
-  core::initInfologger(iCtx, mTaskConfig.infologgerDiscardParameters, "task/" + mTaskConfig.taskName, mTaskConfig.detectorName);
+  core::initInfologger(iCtx, mTaskConfig.infologgerDiscardParameters, "task/" + mTaskConfig.name, mTaskConfig.detectorName);
   ILOG(Info, Devel) << "Initializing TaskRunner" << ENDM;
 
   printTaskConfig();
@@ -103,11 +103,11 @@ void TaskRunner::init(InitContext& iCtx)
   // setup monitoring
   mCollector = MonitoringFactory::Get(mTaskConfig.monitoringUrl);
   mCollector->addGlobalTag(tags::Key::Subsystem, tags::Value::QC);
-  mCollector->addGlobalTag("TaskName", mTaskConfig.taskName);
+  mCollector->addGlobalTag("TaskName", mTaskConfig.name);
   mCollector->addGlobalTag("DetectorName", mTaskConfig.detectorName);
 
   // setup publisher
-  mObjectsManager = std::make_shared<ObjectsManager>(mTaskConfig.taskName, mTaskConfig.className, mTaskConfig.detectorName, mTaskConfig.parallelTaskID);
+  mObjectsManager = std::make_shared<ObjectsManager>(mTaskConfig.name, mTaskConfig.className, mTaskConfig.detectorName, mTaskConfig.parallelTaskID);
   mObjectsManager->setMovingWindowsList(mTaskConfig.movingWindows);
 
   // setup timekeeping
@@ -374,11 +374,11 @@ bool TaskRunner::isDataReady(const framework::InputRecord& inputs)
 
 void TaskRunner::printTaskConfig() const
 {
-  ILOG(Info, Devel) << "Configuration loaded > Task name : " << mTaskConfig.taskName //
-                    << " / Module name : " << mTaskConfig.moduleName                 //
-                    << " / Detector name : " << mTaskConfig.detectorName             //
-                    << " / Max number cycles : " << mTaskConfig.maxNumberCycles      //
-                    << " / critical : " << mTaskConfig.critical                      //
+  ILOG(Info, Devel) << "Configuration loaded > Task name : " << mTaskConfig.name //
+                    << " / Module name : " << mTaskConfig.moduleName             //
+                    << " / Detector name : " << mTaskConfig.detectorName         //
+                    << " / Max number cycles : " << mTaskConfig.maxNumberCycles  //
+                    << " / critical : " << mTaskConfig.critical                  //
                     << " / Save to file : " << mTaskConfig.saveToFile
                     << " / Cycle duration seconds : ";
   for (auto& [cycleDuration, period] : mTaskConfig.cycleDurations) {
@@ -437,7 +437,7 @@ void TaskRunner::registerToBookkeeping()
   if (!gSystem->Getenv("O2_QC_DONT_REGISTER_IN_BK")) { // Set this variable to disable the registration
     // register ourselves to the BK at the first cycle
     ILOG(Debug, Devel) << "Registering taskRunner to BookKeeping" << ENDM;
-    Bookkeeping::getInstance().registerProcess(mActivity.mId, mTaskConfig.taskName, mTaskConfig.detectorName, bkp::DplProcessType::QC_TASK, "");
+    Bookkeeping::getInstance().registerProcess(mActivity.mId, mTaskConfig.name, mTaskConfig.detectorName, bkp::DplProcessType::QC_TASK, "");
   }
 }
 
diff --git a/Framework/src/TaskRunnerFactory.cxx b/Framework/src/TaskRunnerFactory.cxx
@@ -169,15 +169,16 @@ TaskRunnerConfig TaskRunnerFactory::extractConfig(const CommonSpec& globalConfig
   o2::globaltracking::RecoContainer rd;
 
   return {
+    taskSpec.taskName,
     taskSpec.moduleName,
     taskSpec.className,
     InfrastructureSpecReader::validateDetectorName(taskSpec.detectorName),
     globalConfig.consulUrl,
     taskSpec.customParameters,
     globalConfig.conditionDBUrl,
     globalConfig.database,
+    taskSpec.dataSources,
     deviceName,
-    taskSpec.taskName,
     multipleCycleDurations,
     taskSpec.maxNumberCycles,
     taskSpec.critical,
diff --git a/Framework/test/testCheck.cxx b/Framework/test/testCheck.cxx
@@ -144,14 +144,15 @@ TEST_CASE("test_check_postprocessing")
 
 TEST_CASE("test_check_activity")
 {
-  Check check({ "QcSkeleton",
+  Check check({ "test",
+                "QcSkeleton",
                 "o2::quality_control_modules::skeleton::SkeletonCheck",
                 "TST",
                 "",
                 {},
                 "something",
                 { { "implementation", "CCDB" }, { "host", "something" } },
-                "test",
+                {},
                 UpdatePolicyType::OnAny,
                 {},
                 true });
diff --git a/Framework/test/testTaskInterface.cxx b/Framework/test/testTaskInterface.cxx
@@ -132,7 +132,7 @@ TEST_CASE("test_invoke_all_TaskRunnerConfig_methods")
 {
   // This is maximum that we can do until we are able to test the DPL algorithms in isolation.
   TaskRunnerConfig taskConfig;
-  auto* objectsManager = new ObjectsManager(taskConfig.taskName, taskConfig.className, taskConfig.detectorName, 0);
+  auto* objectsManager = new ObjectsManager(taskConfig.name, taskConfig.className, taskConfig.detectorName, 0);
 
   test::TestTask testTask(objectsManager);
   CHECK(testTask.test == 0);
@@ -167,22 +167,23 @@ TEST_CASE("test_invoke_all_TaskRunnerConfig_methods")
 TEST_CASE("test_task_factory")
 {
   TaskRunnerConfig config{
+    "skeletonTask",
     "QcSkeleton",
     "o2::quality_control_modules::skeleton::SkeletonTask",
     "TST",
     "",
     {},
     "something",
     {},
+    {},
     "SkeletonTaskRunner",
-    "skeletonTask",
     { { 10, 1 } },
     -1,
     true,
     ""
   };
 
-  auto objectsManager = make_shared<ObjectsManager>(config.taskName, config.className, config.detectorName, 0);
+  auto objectsManager = make_shared<ObjectsManager>(config.name, config.className, config.detectorName, 0);
 
   TaskFactory taskFactory;
   auto task = taskFactory.create(config, objectsManager);
@@ -205,7 +206,7 @@ TEST_CASE("retrieveCondition")
 
   // retrieve it
   TaskRunnerConfig taskConfig;
-  auto* objectsManager = new ObjectsManager(taskConfig.taskName, taskConfig.className, taskConfig.detectorName, 0);
+  auto* objectsManager = new ObjectsManager(taskConfig.name, taskConfig.className, taskConfig.detectorName, 0);
   test::TestTask testTask(objectsManager);
   testTask.setCcdbUrl("ccdb-test.cern.ch:8080");
   o2::emcal::BadChannelMap* bcm = testTask.testRetrieveCondition();
diff --git a/Modules/Example/test/testFactory.cxx b/Modules/Example/test/testFactory.cxx
@@ -26,12 +26,12 @@ BOOST_AUTO_TEST_CASE(Task_Factory)
 {
   TaskFactory factory;
   TaskRunnerConfig config;
-  config.taskName = "task";
+  config.name = "task";
   config.moduleName = "QcCommon";
   config.className = "o2::quality_control_modules::example::ExampleTask";
   config.detectorName = "DAQ";
   config.ccdbUrl = "something";
-  auto manager = make_shared<ObjectsManager>(config.taskName, config.className, config.detectorName, 0);
+  auto manager = make_shared<ObjectsManager>(config.name, config.className, config.detectorName, 0);
   try {
     gSystem->AddDynamicPath("lib:../../lib:../../../lib:.:"); // add local  paths for the test
     factory.create(config, manager);
@@ -46,15 +46,15 @@ BOOST_AUTO_TEST_CASE(Task_Factory_failures, *utf::depends_on("Task_Factory") /*
 {
   TaskFactory factory;
   TaskRunnerConfig config;
-  auto manager = make_shared<ObjectsManager>(config.taskName, config.className, config.detectorName, 0);
+  auto manager = make_shared<ObjectsManager>(config.name, config.className, config.detectorName, 0);
 
-  config.taskName = "task";
+  config.name = "task";
   config.moduleName = "WRONGNAME";
   config.className = "o2::quality_control_modules::example::ExampleTask";
   BOOST_CHECK_EXCEPTION(factory.create(config, manager), AliceO2::Common::FatalException, is_critical);
 
   gSystem->AddDynamicPath("lib:../../lib:../../../lib:"); // add local paths for the test
-  config.taskName = "task";
+  config.name = "task";
   config.moduleName = "QcCommon";
   config.className = "WRONGCLASS";
   BOOST_CHECK_EXCEPTION(factory.create(config, manager), AliceO2::Common::FatalException, is_critical);
diff --git a/Modules/Example/test/testQcExample.cxx b/Modules/Example/test/testQcExample.cxx
@@ -25,9 +25,9 @@ BOOST_AUTO_TEST_CASE(insantiate_task)
   ExampleTask task;
   TaskRunnerConfig config;
   config.consulUrl = "";
-  config.taskName = "qcExampleTest";
+  config.name = "qcExampleTest";
   config.detectorName = "TST";
-  auto manager = make_shared<ObjectsManager>(config.taskName, "ExampleTask", config.detectorName, 0);
+  auto manager = make_shared<ObjectsManager>(config.name, "ExampleTask", config.detectorName, 0);
   task.setObjectsManager(manager);
   //  task.initialize();// TODO
 
diff --git a/Modules/Skeleton/test/testQcSkeleton.cxx b/Modules/Skeleton/test/testQcSkeleton.cxx
@@ -36,9 +36,9 @@ BOOST_AUTO_TEST_CASE(instantiate_task)
   SkeletonTask task;
   TaskRunnerConfig config;
   config.consulUrl = "";
-  config.taskName = "qcSkeletonTest";
+  config.name = "qcSkeletonTest";
   config.detectorName = "TST";
-  auto manager = make_shared<ObjectsManager>(config.taskName, "SkeletonTask", config.detectorName, 0);
+  auto manager = make_shared<ObjectsManager>(config.name, "SkeletonTask", config.detectorName, 0);
   task.setObjectsManager(manager);
   //  o2::framework::InitContext ctx;
   //  task.initialize(ctx);

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ namespace o2::quality_control::core`
`24`	`24`	`TaskInterface* TaskFactory::create(const TaskRunnerConfig& taskConfig, std::shared_ptr<ObjectsManager> objectsManager)`
`25`	`25`	`{`
`26`	`26`	`auto* result = root_class_factory::create<TaskInterface>(taskConfig.moduleName, taskConfig.className);`
`27`		`- result->setName(taskConfig.taskName);`
	`27`	`+ result->setName(taskConfig.name);`
`28`	`28`	`result->setObjectsManager(objectsManager);`
`29`	`29`	`result->setCustomParameters(taskConfig.customParameters);`
`30`	`30`	`result->setCcdbUrl(taskConfig.ccdbUrl);`