[QC-310] Dump a property qcConfiguration for the QC devices (#7942)

Barthelemy · web-flow · commit bc1d52175a2f · 2022-01-18T09:00:34.000+01:00
* [QC-310] Dump a property qcConfiguration for the QC devices

Introduce a new label `qc-reconfigurable`.
Dump a property in the qc tasks pointing to the file in consul to reconfigure the tasks.

* format

* Fix the formatting

* apply pr comments
diff --git a/Framework/Core/include/Framework/O2ControlLabels.h b/Framework/Core/include/Framework/O2ControlLabels.h
@@ -31,6 +31,10 @@ const extern DataProcessorLabel uniqueProxyLabel;
 // Thus, AliECS will not perform host and port allocation automatically. It takes priority over `uniqueProxyLabel`.
 const extern DataProcessorLabel preserveRawChannelsLabel;
 
+// This label makes AliECS templates add the property `qcConfiguration` to the tasks, allowing them
+// to reconfigure in init with a freshly templated config.
+const extern DataProcessorLabel qcReconfigurable;
+
 } // namespace ecs
 } // namespace o2::framework
 
diff --git a/Framework/Core/src/O2ControlHelpers.cxx b/Framework/Core/src/O2ControlHelpers.cxx
@@ -185,6 +185,41 @@ std::vector<RawChannel> extractRawChannels(const DeviceSpec& spec, const DeviceE
   return rawChannels;
 }
 
+bool isUniqueProxy(const DeviceSpec& spec)
+{
+  return std::find(spec.labels.begin(), spec.labels.end(), ecs::uniqueProxyLabel) != spec.labels.end();
+}
+
+bool shouldPreserveRawChannels(const DeviceSpec& spec)
+{
+  return std::find(spec.labels.begin(), spec.labels.end(), ecs::preserveRawChannelsLabel) != spec.labels.end();
+}
+
+bool isQcReconfigurable(const DeviceSpec& spec)
+{
+  return std::find(spec.labels.begin(), spec.labels.end(), ecs::qcReconfigurable) != spec.labels.end();
+}
+
+void dumpProperties(std::ostream& dumpOut, const DeviceExecution& execution, const DeviceSpec& spec, const std::string& indLevel)
+{
+  // get the argument `--config`
+  std::string configPath;
+  auto it = std::find_if(execution.args.begin(), execution.args.end(), [](char* v) { return v != nullptr && strcmp(v, "--config") == 0; });
+
+  // get the next argument and find `/o2/components/` in it, then take what comes after in the string.
+  if (it != execution.args.end()) {
+    std::string configParam = *(++it);
+    std::string prefix = "/o2/components/"; // keep only the path to the config file, i.e. stuff after "/o2/components/"
+    size_t pos = configParam.find(prefix);
+    if (pos != std::string::npos) {
+      configPath = configParam.substr(pos + prefix.length());
+    }
+  }
+
+  dumpOut << indLevel << "properties:\n";
+  dumpOut << indLevel << indScheme << "qcConfiguration: " << configPath << "\n";
+}
+
 void dumpCommand(std::ostream& dumpOut, const DeviceExecution& execution, std::string indLevel)
 {
   dumpOut << indLevel << "shell: true\n";
@@ -260,16 +295,6 @@ std::string findBinder(const std::vector<DeviceSpec>& specs, const std::string&
   throw std::runtime_error("Could not find a device which binds the '" + channel + "' channel.");
 }
 
-bool isUniqueProxy(const DeviceSpec& spec)
-{
-  return std::find(spec.labels.begin(), spec.labels.end(), ecs::uniqueProxyLabel) != spec.labels.end();
-}
-
-bool shouldPreserveRawChannels(const DeviceSpec& spec)
-{
-  return std::find(spec.labels.begin(), spec.labels.end(), ecs::preserveRawChannelsLabel) != spec.labels.end();
-}
-
 void dumpRole(std::ostream& dumpOut, const std::string& taskName, const DeviceSpec& spec, const std::vector<DeviceSpec>& allSpecs, const DeviceExecution& execution, const std::string indLevel)
 {
   dumpOut << indLevel << "- name: \"" << spec.id << "\"\n";
@@ -374,6 +399,10 @@ void dumpTask(std::ostream& dumpOut, const DeviceSpec& spec, const DeviceExecuti
     }
   }
 
+  if (implementation::isQcReconfigurable(spec)) {
+    implementation::dumpProperties(dumpOut, execution, spec, indLevel);
+  }
+
   dumpOut << indLevel << "command:\n";
   implementation::dumpCommand(dumpOut, execution, indLevel + indScheme);
 }
diff --git a/Framework/Core/src/O2ControlLabels.cxx b/Framework/Core/src/O2ControlLabels.cxx
@@ -16,4 +16,5 @@ namespace o2::framework::ecs
 
 const DataProcessorLabel uniqueProxyLabel = {"ecs-unique-proxy"};
 const DataProcessorLabel preserveRawChannelsLabel = {"ecs-preserve-raw-channels"};
+const DataProcessorLabel qcReconfigurable = {"qc-reconfigurable"};
 }

Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,5 @@ namespace o2::framework::ecs`
`16`	`16`
`17`	`17`	`const DataProcessorLabel uniqueProxyLabel = {"ecs-unique-proxy"};`
`18`	`18`	`const DataProcessorLabel preserveRawChannelsLabel = {"ecs-preserve-raw-channels"};`
	`19`	`+const DataProcessorLabel qcReconfigurable = {"qc-reconfigurable"};`
`19`	`20`	`}`