Checker 2.0 (QC-121) (#216)

* [WIP] Checker v2.0

* [WIP] Checker 2.0.1

* [WIP] Checker 2.0.2

* [WIP] Grouping checkers with the same input

* [WIP] Trigger checker on any monitor object

* [WIP] Store quality object

* Serialize QualityObject. Refacor Checker. Fix QualityObject creation. Fix MonitorObjectPolicy.

* Comment out not compatible test and modules.

* Fix warnings. Move qc.check to qc.checks. Remove potencial bug with Monitor object revision number.

* Simplify basic.json. Seperate revision update from isReady.

* Rename *checkerNames to *checkNames. Log quantity of MOs per input.

* Checker caches MO depending on getFullName().

* Separate single Check logic from Checker

* Use Check inside Checker

* Fix tests. Fix existing modules. Update DatabaseInterface. Add copyright.

* Rename Checker to CheckRunner

* Comply with the changes from master

* Send QualityObject onto Check OutputSpec. Add testCheck.

* Change to random name for CheckRunner.

* Remove inline keyword. Change adopt to snapshot. Change Inputs to vector<string> for QualityObject::setInputs.

* Clang format

* Add check module development documentation.

* Fix o2-qc-run-advanced

* Fix quality printing in runBasic. Store MO after beautify.

* Fix shadow map creation. Add and fix workflow test.

* Fix testSharedConfig.json

* Fix the json

* fix the testCheckRunner

* one more fix

* Fix the path of the QualityObject in the CCDB

* Fix testCcdbDatabase and testCheckWorkflow.

* Fix formating.

* Fix testInfrastructureGenerator. Change testSharedConfig.json and affected tests.

* Remove extra print

* Add copyright. Fix formating.

* Fix skipping of the first MonitorObject in Check

* Print message if check is not ready

* fix TOC

* Move hardcoded check declaration inside task to json config

* Fix example module. Remove addCheck in DAQ.

* Pass to CheckRunner info which MOs to store

Author: rpacholek

Framework/CMakeLists.txt

@@ -9,6 +9,7 @@ configure_file("include/QualityControl/Version.h.in"
 
 add_library(QualityControlTypes
   src/MonitorObject.cxx
+  src/QualityObject.cxx
   src/Quality.cxx
 )
 
@@ -27,6 +28,7 @@ target_link_libraries(QualityControlTypes
 
 add_root_dictionary(QualityControlTypes
   HEADERS include/QualityControl/MonitorObject.h
+  include/QualityControl/QualityObject.h
   include/QualityControl/Quality.h
   LINKDEF include/QualityControl/TypesLinkDef.h
   BASENAME QualityControlTypes
@@ -36,8 +38,8 @@ add_root_dictionary(QualityControlTypes
 
 add_library(QualityControl
             src/ObjectsManager.cxx
-            src/Checker.cxx
-            src/CheckerFactory.cxx
+            src/CheckRunner.cxx
+            src/CheckRunnerFactory.cxx
             src/CheckInterface.cxx
             src/DatabaseFactory.cxx
             src/CcdbDatabase.cxx
@@ -48,6 +50,7 @@ add_library(QualityControl
             src/RepositoryBenchmark.cxx
             src/HistoMerger.cxx
             src/InfrastructureGenerator.cxx
+            src/Check.cxx
             src/ServiceDiscovery.cxx
             src/Triggers.cxx
             src/TriggerHelpers.cxx
@@ -94,17 +97,18 @@ target_compile_definitions(QualityControl PRIVATE
                            $<$<BOOL:${ENABLE_MYSQL}>:_WITH_MYSQL>)
 
 add_root_dictionary(QualityControl
-                    HEADERS
+                    HEADERS include/QualityControl/Check.h
                             include/QualityControl/CheckInterface.h
-                            include/QualityControl/Checker.h
-                            include/QualityControl/CheckerFactory.h
+                            include/QualityControl/CheckRunner.h
+                            include/QualityControl/CheckRunnerFactory.h
                             include/QualityControl/DatabaseInterface.h
                             include/QualityControl/CcdbDatabase.h
                             include/QualityControl/ServiceDiscovery.h
                             include/QualityControl/TaskRunner.h
                             include/QualityControl/TaskRunnerFactory.h
                             include/QualityControl/HistoMerger.h
                             include/QualityControl/InfrastructureGenerator.h
+                            include/QualityControl/InputUtils.h
                             include/QualityControl/PostProcessingInterface.h
                     LINKDEF include/QualityControl/LinkDef.h
                     BASENAME QualityControl)
@@ -209,7 +213,8 @@ set(TEST_SRCS
     test/testTaskInterface.cxx
     test/testTaskRunner.cxx
     test/testCheckInterface.cxx
-    test/testChecker.cxx
+    test/testCheckRunner.cxx
+    test/testCheck.cxx
     test/testQuality.cxx
     test/testObjectsManager.cxx
     test/testCcdbDatabase.cxx
@@ -219,6 +224,7 @@ set(TEST_SRCS
     test/testPostProcessingRunner.cxx
     test/testPostProcessingInterface.cxx
     test/testPostProcessingConfig.cxx
+    test/testCheckWorkflow.cxx
     test/testWorkflow.cxx)
 
 set(TEST_ARGS
@@ -240,6 +246,8 @@ set(TEST_ARGS
     ""
     ""
     ""
+    ""
+    "-b --run"
     "-b --run")
 
 list(LENGTH TEST_SRCS count)
@@ -261,16 +269,18 @@ foreach(i RANGE ${count})
   set_tests_properties(${test_name} PROPERTIES TIMEOUT 30)
 endforeach()
 
-foreach(t testTaskInterface testWorkflow testTaskRunner
+foreach(t testTaskInterface testWorkflow testTaskRunner testCheckWorkflow
         testInfrastructureGenerator testPostProcessingConfig testPostProcessingInterface
-        testPostProcessingRunner)
+        testPostProcessingRunner testCheck testCheckRunner)
   target_sources(${t} PRIVATE
                  ${CMAKE_BINARY_DIR}/getTestDataDirectory.cxx)
   target_include_directories(${t} PRIVATE ${CMAKE_SOURCE_DIR})
 endforeach()
 
 set_property(TEST testWorkflow PROPERTY TIMEOUT 10)
 set_property(TEST testWorkflow PROPERTY LABELS slow)
+set_property(TEST testCheckWorkflow PROPERTY TIMEOUT 60)
+set_property(TEST testCheckWorkflow PROPERTY LABELS slow)
 set_property(TEST testObjectsManager PROPERTY TIMEOUT 20)
 set_property(TEST testObjectsManager PROPERTY LABELS slow)
 set_property(TEST testCcdbDatabase PROPERTY TIMEOUT 15)
@@ -361,6 +371,7 @@ install(PROGRAMS script/RepoCleaner/1_per_hour.py script/RepoCleaner/Ccdb.py scr
 
 set(TEST_FILES
   "testSharedConfig.json"
+  "testCheckWorkflow.json"
   "testWorkflow.json")
 set(TEST_FILES_PREFIXED ${TEST_FILES})
 list(TRANSFORM TEST_FILES_PREFIXED PREPEND ${CMAKE_BINARY_DIR}/tests/)

Framework/advanced.json

@@ -53,6 +53,30 @@
         },
         "location": "remote"
       }
+    },
+    "checks": {
+      "dataSizeCheck": {
+        "active": "true",
+        "className": "o2::quality_control_modules::skeleton::SkeletonCheck",
+        "moduleName": "QcSkeleton",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "dataSizeTask",
+          "MOs": ["example"]
+        }]
+      },
+      "someNumbersCheck": {
+        "active": "true",
+        "className": "o2::quality_control_modules::skeleton::SkeletonCheck",
+        "moduleName": "QcSkeleton",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "someNumbersTask",
+          "MOs": ["example"]
+        }]
+      }
     }
   },
   "dataSamplingPolicies": [
@@ -74,7 +98,7 @@
       "id": "tst2",
       "active": "true",
       "machines": [],
-      "query" : "data:TST/RAWDATA",
+      "query" : "data:TST/DATA",
       "samplingConditions": [
         {
           "condition": "payloadSize",

Framework/basic-no-sampling.json

@@ -39,6 +39,19 @@
         },
         "location": "remote"
       }
+    },
+    "checks": {
+      "QcCheck": {
+        "active": "true",
+        "className": "o2::quality_control_modules::skeleton::SkeletonCheck",
+        "moduleName": "QcSkeleton",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "QcTask",
+          "MOs": ["example"]
+        }]
+      }
     }
   },
   "dataSamplingPolicies": [

Framework/basic.json

@@ -40,6 +40,19 @@
         },
         "location": "remote"
       }
+    },
+    "checks": {
+      "QcCheck": {
+        "active": "true",
+        "className": "o2::quality_control_modules::skeleton::SkeletonCheck",
+        "moduleName": "QcSkeleton",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "QcTask",
+          "MOs": ["example"]
+        }]
+      }
     }
   },
   "dataSamplingPolicies": [

Framework/example-default.json

@@ -59,6 +59,86 @@
           "o2flp2"
         ]
       }
+    },
+    "checks": {
+      "example/checkMeanIsAbove": {
+        "active": "true",
+        "className": "o2::quality_control_modules::common::MeanIsAbove",
+        "moduleName": "QcCommon",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "myTask_1",
+          "MOs": "all"
+        }]
+      },
+      "example/checkNonEmpty": {
+        "active": "true",
+        "className": "o2::quality_control_modules::common::MeanIsAbove",
+        "moduleName": "QcCommon",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "myTask_1",
+          "MOs": "all"
+        }]
+      },
+      "example/checkFromExample": {
+        "active": "true",
+        "className": "o2::quality_control_modules::example::FakeCheck",
+        "moduleName": "QcCommon",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "myTask_1",
+          "MOs": "all"
+        }]
+      },
+      "daq/checkNonEmpty/payloadSize": {
+        "active": "true",
+        "className": "o2::quality_control_modules::common::NonEmpty",
+        "moduleName": "QcCommon",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "DaqTask",
+          "MOs": ["payloadSize"]
+        }]
+      },
+      "daq/checkNonEmpty/IDs": {
+        "active": "true",
+        "className": "o2::quality_control_modules::common::NonEmpty",
+        "moduleName": "QcCommon",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "DaqTask",
+          "MOs": ["IDs"]
+        }]
+      },
+      "daq/checkIncreasingIDs": {
+        "active": "true",
+        "className": "o2::quality_control_modules::daq::EverIncreasingGraph",
+        "moduleName": "QcDaq",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "DaqTask",
+          "MOs": ["IDs"]
+        }]
+      },
+      "benchmark/fakeCheck_1": {
+        "active": "true",
+        "className": "o2::quality_control_modules::common::NonEmpty",
+        "moduleName": "QcCommon",
+        "policy": "OnAny",
+        "dataSource": [{
+          "type": "Task",
+          "name": "myTask_1",
+          "MOs": ["histogram_myTask_1_0"]
+        }]
+      }
+
     }
   },
   "dataSamplingPoliciesFile_comment": "In case that policies are stored in different file, specify its path below. When both dataSamplingPolicies and dataSamplingPoliciesFile are specified, the latter has higher priority",
@@ -92,4 +172,4 @@
       ]
     }
   ]
-}
+}

Framework/include/QualityControl/CcdbDatabase.h

@@ -55,9 +55,15 @@ class CcdbDatabase : public DatabaseInterface
 
   void connect(std::string host, std::string database, std::string username, std::string password) override;
   void connect(const std::unordered_map<std::string, std::string>& config) override;
-  void store(std::shared_ptr<o2::quality_control::core::MonitorObject> mo) override;
-  core::MonitorObject* retrieve(std::string path, std::string objectName, long timestamp = 0) override;
-  std::string retrieveJson(std::string path, std::string objectName) override;
+  // MonitorObject
+  void storeMO(std::shared_ptr<o2::quality_control::core::MonitorObject> q) override;
+  std::shared_ptr<o2::quality_control::core::MonitorObject> retrieveMO(std::string taskName, std::string objectName, long timestamp = 0) override;
+  std::string retrieveMOJson(std::string taskName, std::string objectName) override;
+  // QualityObject
+  void storeQO(std::shared_ptr<o2::quality_control::core::QualityObject> q) override;
+  std::shared_ptr<o2::quality_control::core::QualityObject> retrieveQO(std::string checkerName, long timestamp = 0) override;
+  std::string retrieveQOJson(std::string checkName) override;
+
   void disconnect() override;
   void prepareTaskDataContainer(std::string taskName) override;
   std::vector<std::string> getPublishedObjectNames(std::string taskName) override;