QC check improvements (#286)

* Add parameter support in Check

* Change CheckRunner name to a generated name from Check names

* Clang format

* Implement BSD checksum algorithm

* follow the naming rules

Co-authored-by: knopers8 <piotr.jan.konopka@cern.ch>

Author: rpacholek

Framework/include/QualityControl/Check.h

@@ -116,6 +116,7 @@ class Check
   std::string mModuleName;
   std::string mClassName;
   CheckInterface* mCheckInterface = nullptr;
+  std::unordered_map<std::string, std::string> mCustomParameters;
 
   // Policy
   std::string mPolicyType;

Framework/include/QualityControl/CheckInterface.h

@@ -82,6 +82,11 @@ class CheckInterface
   bool isObjectCheckable(const std::shared_ptr<MonitorObject> mo);
   bool isObjectCheckable(const MonitorObject* mo);
 
+  void setCustomParameters(const std::unordered_map<std::string, std::string>& parameters);
+
+ protected:
+  std::unordered_map<std::string, std::string> mCustomParameters;
+
   //  private:
   //    std::string mName;
 

Framework/include/QualityControl/CheckRunner.h

@@ -165,6 +165,13 @@ class CheckRunner : public framework::Task
    */
   void updateRevision();
 
+  /**
+   * \brief BSD checksum algorithm.
+   *
+   * \param input_string String intended to be hashed
+   */
+  static std::size_t hash(std::string input_string);
+
   // General state
   std::string mDeviceName;
   std::vector<Check> mChecks;

Framework/src/Check.cxx

@@ -71,6 +71,9 @@ void Check::initConfig()
     std::vector<std::string> inputs;
     const auto& conf = config->getRecursive("qc.checks." + mName);
     // Params
+    if (conf.count("checkParameters")) {
+      mCustomParameters = config->getRecursiveMap("qc.checks." + mName + ".checkParameters");
+    }
 
     // Policy
     if (conf.count("policy")) {
@@ -254,6 +257,7 @@ void Check::loadLibrary()
     tempString += R"( because the class named ")";
     BOOST_THROW_EXCEPTION(FatalException() << errinfo_details(tempString));
   }
+  mCheckInterface->setCustomParameters(mCustomParameters);
   mCheckInterface->configure(mName);
 }
 

Framework/src/CheckInterface.cxx

@@ -28,4 +28,9 @@ bool CheckInterface::isObjectCheckable(const MonitorObject* mo)
   return encapsulated->IsA()->InheritsFrom(getAcceptedType().c_str());
 }
 
+void CheckInterface::setCustomParameters(const std::unordered_map<std::string, std::string>& parameters)
+{
+  mCustomParameters = parameters;
+}
+
 } // namespace o2::quality_control::checker

Framework/src/CheckRunner.cxx

@@ -21,7 +21,8 @@
 
 #include <utility>
 #include <memory>
-#include <random>
+#include <functional>
+#include <algorithm>
 #include <set>
 // ROOT
 #include <TClass.h>
@@ -78,6 +79,21 @@ o2::framework::Inputs CheckRunner::createInputSpec(const std::string checkName,
   return inputs;
 }
 
+std::size_t CheckRunner::hash(std::string inputString)
+{
+  // BSD checksum
+  const int mode = 16;
+  std::size_t checksum = 0;
+
+  const std::size_t mask = (1 << (mode + 1)) - 1;
+  for (char c : inputString) {
+    // Rotate the sum
+    checksum = (checksum >> 1) + ((checksum & 1) << (mode - 1));
+    checksum = (checksum + (std::size_t)c) & mask;
+  }
+  return checksum;
+}
+
 std::string CheckRunner::createCheckRunnerName(std::vector<Check> checks)
 {
   static const std::string alphanumeric =
@@ -91,11 +107,25 @@ std::string CheckRunner::createCheckRunnerName(std::vector<Check> checks)
     // If single check, use the check name
     name += checks[0].getName();
   } else {
-    std::default_random_engine generator;
-    std::uniform_int_distribution<int> distribution(0, alphanumeric.size());
+    std::string hash_string = "";
+    std::vector<std::string> names;
+    // Fill vector with check names
+    for (auto& c : checks) {
+      names.push_back(c.getName());
+    }
+    // Be sure that after configuration shuffle, the name will be the same
+    std::sort(names.begin(), names.end());
+
+    // Create a single string and hash it
+    for (auto& n : names) {
+      hash_string += n;
+    }
+    std::size_t num = hash(hash_string);
 
+    // Change numerical to alphanumeric hash representation
     for (int i = 0; i < NAME_LEN; ++i) {
-      name += alphanumeric[distribution(generator)];
+      name += alphanumeric[num % alphanumeric.size()];
+      num = num / alphanumeric.size();
     }
   }
   return name;