[Framework] changes necessary to switch beamType to pdpBeamType

Michal Tichák · Michal Tichák · commit 220cee7c7985 · 2025-04-17T16:45:15.000+02:00
diff --git a/Framework/basic.json b/Framework/basic.json
@@ -84,7 +84,7 @@
         }],
         "extendedCheckParameters": {
           "physics": {
-            "PROTON-PROTON": {
+            "pp": {
               "myOwnKey1": "myOwnValue1c"
             }
           }
diff --git a/Framework/include/QualityControl/runnerUtils.h b/Framework/include/QualityControl/runnerUtils.h
@@ -42,8 +42,8 @@ std::string getFirstCheckName(const std::string& configurationSource);
 bool hasChecks(const std::string& configSource);
 
 template <typename T>
-requires std::is_arithmetic_v<T>
-  T computeNumericalActivityField(framework::ServiceRegistryRef services, const std::string& name, T fallbackNumber = 0)
+  requires std::is_arithmetic_v<T>
+T computeNumericalActivityField(framework::ServiceRegistryRef services, const std::string& name, T fallbackNumber = 0)
 {
   T result = 0;
 
@@ -86,8 +86,6 @@ uint64_t getCurrentTimestamp();
 
 void initInfologger(framework::InitContext& iCtx, core::LogDiscardParameters infologgerDiscardParameters, std::string facility, std::string detectorName = "");
 
-std::string translateBeamType(const std::string& pdpBeamType);
-
 } // namespace o2::quality_control::core
 
 #endif // QUALITYCONTROL_RUNNERUTILS_H
diff --git a/Framework/script/updatePdpBeam.sh b/Framework/script/updatePdpBeam.sh
@@ -0,0 +1,76 @@
+#!/bin/bash
+
+# Default values
+PREFIX="o2/"
+TMP_DIR="./consul_kv_backups"
+mkdir -p "$TMP_DIR"
+UPDATE=false
+
+# --- Parse arguments ---
+while [[ "$#" -gt 0 ]]; do
+  case "$1" in
+    -u|--update)
+      UPDATE=true
+      ;;
+    -p|--prefix)
+      PREFIX="$2"
+      shift
+      ;;
+    -h|--help)
+      echo "Usage: $0 [-p|--prefix <consul_prefix>] [-u|--update]"
+      echo
+      echo "  -p, --prefix   Prefix to search in Consul KV (default: o2/)"
+      echo "  -u, --update   Apply changes back to Consul"
+      exit 0
+      ;;
+    *)
+      echo "❌ Unknown option: $1"
+      echo "Use -h or --help for usage"
+      exit 1
+      ;;
+  esac
+  shift
+done
+
+echo "🔍 Using Consul prefix: $PREFIX"
+[[ "$UPDATE" == true ]] && echo "🚀 Update mode: ON (values will be written back)" || echo "🔒 Dry-run mode: changes only printed/saved"
+
+# --- Define replacement logic ---
+replace() {
+  sed -e 's/PROTON-PROTON/pp/g' \
+      -e 's/Pb-PROTON/pPb/g' \
+      -e 's/Pb-Pb/PbPb/g'
+}
+
+# --- Fetch all keys ---
+KEYS=$(consul kv get -recurse -keys "$PREFIX")
+
+# --- Process each key ---
+while IFS= read -r key; do
+  VALUE=$(consul kv get "$key")
+  MODIFIED=$(echo "$VALUE" | replace)
+
+  if [[ "$VALUE" != "$MODIFIED" ]]; then
+    SAFE_NAME=$(echo "$key" | sed 's|/|__|g')
+
+    ORIG_FILE="$TMP_DIR/$SAFE_NAME.orig"
+    NEW_FILE="$TMP_DIR/$SAFE_NAME.new"
+    DIFF_FILE="$TMP_DIR/$SAFE_NAME.diff"
+
+    echo "$VALUE" > "$ORIG_FILE"
+    echo "$MODIFIED" > "$NEW_FILE"
+    diff -u "$ORIG_FILE" "$NEW_FILE" > "$DIFF_FILE"
+
+    echo "✅ Changed key: $key"
+    echo "  📄 $ORIG_FILE"
+    echo "  🆕 $NEW_FILE"
+    echo "  📑 $DIFF_FILE"
+
+    if [[ "$UPDATE" == true ]]; then
+      echo "$MODIFIED" | consul kv put "$key" -
+      echo "  🔁 Updated in Consul: $key"
+    fi
+
+    echo "---------------------------------------"
+  fi
+done <<< "$KEYS"
diff --git a/Framework/src/runnerUtils.cxx b/Framework/src/runnerUtils.cxx
@@ -20,6 +20,7 @@
 
 #include <boost/property_tree/json_parser.hpp>
 #include <CommonUtils/StringUtils.h>
+#include <cstdlib>
 #include <regex>
 #include <Configuration/ConfigurationFactory.h>
 #include <Common/Exceptions.h>
@@ -28,6 +29,8 @@
 
 #include <chrono>
 #include <cstdint>
+#include <stdexcept>
+#include <string_view>
 #include <DataFormatsParameters/ECSDataAdapters.h>
 
 namespace o2::quality_control::core
@@ -91,25 +94,6 @@ std::string computeStringActivityField(framework::ServiceRegistryRef services, c
   return property;
 }
 
-std::string translateBeamType(const std::string& pdpBeamType)
-{
-  // convert the beam type received from pdp into the format we use in flp/ecs
-  std::string result = "";
-  if (pdpBeamType == "pp") {
-    result = "PROTON-PROTON";
-  } else if (pdpBeamType == "PbPb") {
-    result = "Pb-Pb";
-  } else if (pdpBeamType == "pPb") {
-    result = "Pb-PROTON";
-  } else if (pdpBeamType == "cosmic") {
-    result = "cosmic";
-  } else {
-    ILOG(Warning, Ops) << "Failed to convert the pdp beam type ('" << pdpBeamType << "'), returning an empty string" << ENDM;
-  }
-  ILOG(Debug, Devel) << "Translated pdp beam type '" << pdpBeamType << "' to '" << result << "'" << ENDM;
-  return result;
-}
-
 Activity computeActivity(framework::ServiceRegistryRef services, const Activity& fallbackActivity)
 {
   // for a complete list of the properties provided by ECS, see here: https://github.com/AliceO2Group/Control/blob/master/docs/handbook/configuration.md#variables-pushed-to-controlled-tasks
@@ -122,7 +106,8 @@ Activity computeActivity(framework::ServiceRegistryRef services, const Activity&
   auto periodName = computeStringActivityField(services, "lhc_period", fallbackActivity.mPeriodName);
   auto fillNumber = computeNumericalActivityField<int>(services, "fill_info_fill_number", fallbackActivity.mFillNumber);
   auto beam_type = computeStringActivityField(services, "pdp_beam_type", fallbackActivity.mBeamType);
-  beam_type = translateBeamType(beam_type);
+
+  // throw std::runtime_error{"blaaaaaaaaallala"};
 
   Activity activity(
     runNumber,
diff --git a/Framework/test/testCustomParameters.cxx b/Framework/test/testCustomParameters.cxx
@@ -138,23 +138,23 @@ TEST_CASE("test_at_optional")
 TEST_CASE("test_at_optional_activity")
 {
   Activity activity;
-  activity.mBeamType = "PROTON-PROTON";
+  activity.mBeamType = "pp";
   activity.mType = "PHYSICS";
 
   CustomParameters cp;
   cp.set("aaa", "AAA");
   cp.set("bbb", "BBB");
   cp.set("aaa", "asdf", "PHYSICS");
-  cp.set("aaa", "CCC", "PHYSICS", "PROTON-PROTON");
-  cp.set("aaa", "DDD", "PHYSICS", "Pb-Pb");
-  cp.set("aaa", "AAA", "TECHNICAL", "PROTON-PROTON");
+  cp.set("aaa", "CCC", "PHYSICS", "pp");
+  cp.set("aaa", "DDD", "PHYSICS", "PbPb");
+  cp.set("aaa", "AAA", "TECHNICAL", "pp");
 
   CHECK(cp.atOptional("aaa", activity).value() == "CCC");
   CHECK(cp.atOptional("abc", activity).has_value() == false);
   CHECK(cp.atOptional("abc", activity).value_or("bla") == "bla");
 
   Activity activity2;
-  activity.mBeamType = "Pb-Pb";
+  activity.mBeamType = "PbPb";
   activity.mType = "PHYSICS";
   CHECK(cp.atOptional("aaa", activity).value() == "DDD");
 }
@@ -214,21 +214,21 @@ TEST_CASE("test_default_if_not_found_at_optional")
   // prepare the CP
   cp.set("key", "valueDefaultDefault", "default", "default");
   cp.set("key", "valuePhysicsDefault", "PHYSICS", "default");
-  cp.set("key", "valuePhysicsPbPb", "PHYSICS", "Pb-Pb");
+  cp.set("key", "valuePhysicsPbPb", "PHYSICS", "PbPb");
   cp.set("key", "valueCosmicsDefault", "COSMICS", "default");
-  cp.set("key", "valueCosmicsDefault", "default", "PROTON-PROTON");
+  cp.set("key", "valueCosmicsDefault", "default", "pp");
 
   // check the data
   CHECK(cp.atOptional("key").value() == "valueDefaultDefault");
   CHECK(cp.atOptional("key", "PHYSICS").value() == "valuePhysicsDefault");
-  CHECK(cp.atOptional("key", "PHYSICS", "Pb-Pb").value() == "valuePhysicsPbPb");
+  CHECK(cp.atOptional("key", "PHYSICS", "PbPb").value() == "valuePhysicsPbPb");
   CHECK(cp.atOptional("key", "COSMICS", "default").value() == "valueCosmicsDefault");
-  CHECK(cp.atOptional("key", "default", "PROTON-PROTON").value() == "valueCosmicsDefault");
+  CHECK(cp.atOptional("key", "default", "pp").value() == "valueCosmicsDefault");
 
   // check when something is missing
-  CHECK(cp.atOptional("key", "PHYSICS", "PROTON-PROTON").value() == "valuePhysicsDefault");   // key is not defined for pp
+  CHECK(cp.atOptional("key", "PHYSICS", "pp").value() == "valuePhysicsDefault");   // key is not defined for pp
   CHECK(cp.atOptional("key", "TECHNICAL", "STRANGE").value() == "valueDefaultDefault");       // key is not defined for run nor beam
-  CHECK(cp.atOptional("key", "TECHNICAL", "PROTON-PROTON").value() == "valueCosmicsDefault"); // key is not defined for technical
+  CHECK(cp.atOptional("key", "TECHNICAL", "pp").value() == "valueCosmicsDefault"); // key is not defined for technical
 }
 
 TEST_CASE("test_default_if_not_found_at")
@@ -242,26 +242,26 @@ TEST_CASE("test_default_if_not_found_at")
   // prepare the CP
   cp.set("key", "valueDefaultDefault", "default", "default");
   cp.set("key", "valuePhysicsDefault", "PHYSICS", "default");
-  cp.set("key", "valuePhysicsPbPb", "PHYSICS", "Pb-Pb");
+  cp.set("key", "valuePhysicsPbPb", "PHYSICS", "PbPb");
   cp.set("key", "valueCosmicsDefault", "COSMICS", "default");
-  cp.set("key", "valueCosmicsDefault", "default", "PROTON-PROTON");
+  cp.set("key", "valueCosmicsDefault", "default", "pp");
 
   // check the data
   CHECK(cp.at("key") == "valueDefaultDefault");
   CHECK(cp.at("key", "PHYSICS") == "valuePhysicsDefault");
-  CHECK(cp.at("key", "PHYSICS", "Pb-Pb") == "valuePhysicsPbPb");
+  CHECK(cp.at("key", "PHYSICS", "PbPb") == "valuePhysicsPbPb");
   CHECK(cp.at("key", "COSMICS", "default") == "valueCosmicsDefault");
-  CHECK(cp.at("key", "default", "PROTON-PROTON") == "valueCosmicsDefault");
+  CHECK(cp.at("key", "default", "pp") == "valueCosmicsDefault");
 
   // check when something is missing
-  CHECK(cp.at("key", "PHYSICS", "PROTON-PROTON") == "valuePhysicsDefault");   // key is not defined for pp
+  CHECK(cp.at("key", "PHYSICS", "pp") == "valuePhysicsDefault");   // key is not defined for pp
   CHECK(cp.at("key", "TECHNICAL", "STRANGE") == "valueDefaultDefault");       // key is not defined for run nor beam
-  CHECK(cp.at("key", "TECHNICAL", "PROTON-PROTON") == "valueCosmicsDefault"); // key is not defined for technical
+  CHECK(cp.at("key", "TECHNICAL", "pp") == "valueCosmicsDefault"); // key is not defined for technical
 }
 
 TEST_CASE("test_getAllDefaults")
 {
   CustomParameters cp;
   auto result = cp.getAllDefaults();
   CHECK(result.size() == 0);
-}
+}
diff --git a/Modules/CTP/src/qc-ctp.json b/Modules/CTP/src/qc-ctp.json
@@ -58,12 +58,12 @@
               "MB1inputName" : "MTVX",
               "MB2inputName" : "MVBA"
             },
-            "PROTON-PROTON": {
+            "pp": {
               "MBclassName" : "CMTVX-B-NOPF",
               "MB1inputName" : "MTVX",
               "MB2inputName" : "MTVA"
             },
-            "Pb-Pb": {
+            "PbPb": {
               "MBclassName" : "CMTCE-B-NOPF",
               "MB1inputName" : "MTSC",
               "MB2inputName" : "MTCE"
diff --git a/Modules/Common/etc/reference-comparator-example.json b/Modules/Common/etc/reference-comparator-example.json
@@ -34,7 +34,7 @@
             }
           },
           "PHYSICS": {
-            "PROTON-PROTON": {
+            "pp": {
               "referenceRun" : "551890"
             }
           }
diff --git a/Modules/ITS/itsCluster.json b/Modules/ITS/itsCluster.json
@@ -11,7 +11,7 @@
       "Activity": {
         "number": "42",
         "type": "PHYSICS",
-        "beamType" : "PbPb",     "": "Beam type: `PROTON-PROTON`, `Pb-Pb`, `Pb-PROTON` "
+        "beamType" : "PbPb",     "": "Beam type: `pp`, `PbPb`, `pPb` "
       },
       "monitoring": {
         "url": "infologger:///debug?qc"
@@ -91,7 +91,7 @@
                                           "maxcluoccL5": "0.2",
                                           "maxcluoccL6": "0.2"
                         },
-                        "PROTON-PROTON": {
+                        "pp": {
 				          "maxcluoccL0": "5",
                                           "maxcluoccL1": "3",
                                           "maxcluoccL2": "3",
@@ -100,7 +100,7 @@
                                           "maxcluoccL5": "0.2",
                                           "maxcluoccL6": "0.2"
                         },
-                        "Pb-Pb": {
+                        "PbPb": {
 				          "maxcluoccL0": "65",
                                           "maxcluoccL1": "35",
                                           "maxcluoccL2": "25",
diff --git a/Modules/ITS/itsFee.json b/Modules/ITS/itsFee.json
@@ -11,7 +11,7 @@
             "Activity": {
 		        "number": "42",        
 		        "type": "PHYSICS",     
-        		"beamType" : "PbPb",     "": "Beam type: `PROTON-PROTON`, `Pb-Pb`, `Pb-PROTON` "
+        		"beamType" : "PbPb",     "": "Beam type: `pp`, `PbPb`, `pPb` "
             },
             "monitoring": {
                 "url": "infologger:///debug?qc"
@@ -78,10 +78,10 @@
             		"default": {
               			"expectedROFperOrbit": "18"
             		},
-            		"PROTON-PROTON": {
+                "pp": {
               			"expectedROFperOrbit": "18"
             		},
-            		"Pb-Pb": {
+            		"PbPb": {
               			"expectedROFperOrbit": "6"
             		}
           	},
diff --git a/doc/Advanced.md b/doc/Advanced.md
@@ -1295,10 +1295,10 @@ The new syntax is
               "myOwnKey1": "myOwnValue1b",
               "myOwnKey2": "myOwnValue2b"
             },
-            "PROTON-PROTON": {
+            "pp": {
               "myOwnKey1": "myOwnValue1c"
             },
-            "Pb-Pb": {
+            "PbPb": {
               "myOwnKey1": "myOwnValue1d"
             }
           },
@@ -1310,7 +1310,7 @@ The new syntax is
 ```
 It allows to have variations of the parameters depending on the run and beam types. The proper run types can be found here: [ECSDataAdapters.h](https://github.com/AliceO2Group/AliceO2/blob/dev/DataFormats/Parameters/include/DataFormatsParameters/ECSDataAdapters.h#L54). The `default` can be used 
 to ignore the run or the beam type. 
-The beam type is one of the following: `PROTON-PROTON`, `Pb-Pb`, `Pb-PROTON`, `cosmic`.
+The beam type is one of the following: `pp`, `PbPb`, `pPb`, `cosmic`.
 
 The values can be accessed in various ways described in the following sub-sections.
 
@@ -1322,9 +1322,9 @@ However, before returning an empty value we try to substitute the runType and th
 ```c++
 // returns an Optional<string> if it finds the key `myOwnKey` for the runType and beamType of the provided activity, 
 // or if it can find the key with the runType or beamType substituted with "default". 
-auto param = mCustomParameters.atOptional("myOwnKey1", activity); // activity is "PHYSICS", "Pb-Pb" , returns "myOwnValue1d"
+auto param = mCustomParameters.atOptional("myOwnKey1", activity); // activity is "PHYSICS", "PbPb" , returns "myOwnValue1d"
 // same but passing directly the run and beam types
-auto param = mCustomParameters.atOptional("myOwnKey1", "PHYSICS", "Pb-Pb"); // returns "myOwnValue1d"
+auto param = mCustomParameters.atOptional("myOwnKey1", "PHYSICS", "PbPb"); // returns "myOwnValue1d"
 // or with only the run type
 auto param = mCustomParameters.atOptional("myOwnKey1", "PHYSICS"); // returns "myOwnValue1b"
 ```
@@ -1340,8 +1340,8 @@ mCustomParameters.at("myOwnKey"); // returns `myOwnValue`
 mCustomParameters.at("myOwnKey", "default"); // returns `myOwnValue`
 mCustomParameters.at("myOwnKey", "default", "default"); // returns `myOwnValue`
 
-mCustomParameters.at("myOwnKey1", "PHYSICS", "PROTON-PROTON"); // returns `myOwnValue1c`
-mCustomParameters.at("myOwnKey1", "PHYSICS", "Pb-Pb"); // returns `myOwnValue1d`
+mCustomParameters.at("myOwnKey1", "PHYSICS", "pp"); // returns `myOwnValue1c`
+mCustomParameters.at("myOwnKey1", "PHYSICS", "PbPb"); // returns `myOwnValue1d`
 mCustomParameters.at("myOwnKey2", "COSMICS"); // returns `myOwnValue2e`
 
 mCustomParameters.at("myOwnKey1", activity); // result will depend on activity
@@ -1434,7 +1434,7 @@ The configuration looks like
             }
           },
           "PHYSICS": {
-            "PROTON-PROTON": {
+            "pp": {
               "referenceRun" : "551890"
             }
           }
@@ -1540,7 +1540,7 @@ should not be present in real configuration files.
         "provenance": "qc",               "": "Provenance - qc or qc_mc depending whether it is normal data or monte carlo data",
         "start" : "0",                    "": "Activity start time in ms since epoch. One can use it as a filter in post-processing",
         "end" : "1234",                   "": "Activity end time in ms since epoch. One can use it as a filter in post-processing", 
-        "beamType" : "PROTON-PROTON",     "": "Beam type: `PROTON-PROTON`, `Pb-Pb`, `Pb-PROTON` ", 
+        "beamType" : "pp",                "": "Beam type: `pp`, `PbPb`, `pPb` ", 
         "partitionName" : "",             "": "Partition name", 
         "fillNumber" : "123",             "": "Fill Number"
       },
diff --git a/doc/PostProcessing.md b/doc/PostProcessing.md
@@ -600,7 +600,7 @@ In the example configuration below, the relationship between the input and outpu
             }
           },
           "PHYSICS": {
-            "PROTON-PROTON": {
+            "pp": {
               "referenceRun" : "551890"
             }
           }

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@`
`84`	`84`	`}],`
`85`	`85`	`"extendedCheckParameters": {`
`86`	`86`	`"physics": {`
`87`		`- "PROTON-PROTON": {`
	`87`	`+ "pp": {`
`88`	`88`	`"myOwnKey1": "myOwnValue1c"`
`89`	`89`	`}`
`90`	`90`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@`
`34`	`34`	`}`
`35`	`35`	`},`
`36`	`36`	`"PHYSICS": {`
`37`		`- "PROTON-PROTON": {`
	`37`	`+ "pp": {`
`38`	`38`	`"referenceRun" : "551890"`
`39`	`39`	`}`
`40`	`40`	`}`