Standard helpers for creating Input and Output Specs for user data

Author: knopers8

Framework/CMakeLists.txt

@@ -139,6 +139,7 @@ add_library(O2QualityControl
   src/ObjectMetadataHelpers.cxx
   src/QCInputsAdapters.cxx
   src/QCInputsFactory.cxx
+  src/UserInputOutput.cxx
 )
 
 target_include_directories(
@@ -294,6 +295,7 @@ add_executable(o2-qc-test-core
                test/testFlagHelpers.cxx
                test/testQualitiesToFlagCollectionConverter.cxx
                test/testQCInputs.cxx
+               test/testUserInputOutput.cxx
 )
 set_property(TARGET o2-qc-test-core
              PROPERTY RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/tests)

Framework/include/QualityControl/DataHeaderHelpers.h

@@ -27,7 +27,7 @@ namespace o2::quality_control::core
 /// Creates DataOrigin for a data source and detector code
 header::DataOrigin createDataOrigin(DataSourceType, const std::string& detectorCode);
 
-/// \brief Creates DataDescription from given name for any QC actor
+/// \brief Creates DataDescription from given name for a QC actor
 ///
 /// If the length of the name is <= 16 (hardcoded in DataDescription) it creates DataDescription from the original name.
 /// However, if the length of the name is > 16, it will create hash of the whole name and replace ending hashLength of bytes
@@ -39,6 +39,19 @@ header::DataOrigin createDataOrigin(DataSourceType, const std::string& detectorC
 /// \param hashLength - number of bytes which will overwrite the end of the name
 o2::header::DataDescription createDataDescription(const std::string& name, size_t hashLength);
 
+/// \brief Creates DataDescription from given name for a QC actor
+///
+/// If the length of the name is <= 16 (hardcoded in DataDescription) it creates DataDescription from the original name.
+/// However, if the length of the name is > 16, it will create hash of the whole name and replace ending hashLength of bytes
+/// of the name with hexa representation of computed hash.
+/// eg.: name == "veryLongNameThatIsLongerThan16B" with hashLength == 4 will result in "veryLongNameABCD", where ABCD
+/// is the hash create inside the function.
+/// This function deduces hash length for the provided data source type.
+///
+/// \param name - name which should cut and hashed
+/// \param type - data source type associated to an actor
+o2::header::DataDescription createDataDescription(const std::string& name, DataSourceType type);
+
 } // namespace o2::quality_control::core
 
 #endif

Framework/include/QualityControl/UserInputOutput.h

@@ -0,0 +1,46 @@
+// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+///
+/// \file    UserInputOutput.h
+/// \author  Piotr Konopka
+///
+
+#ifndef QUALITYCONTROL_USERINPUTOUTPUT_H
+#define QUALITYCONTROL_USERINPUTOUTPUT_H
+
+#include <string>
+
+#include <Framework/ConcreteDataMatcher.h>
+#include <Framework/InputSpec.h>
+#include <Framework/OutputSpec.h>
+
+#include "QualityControl/DataHeaderHelpers.h"
+#include "QualityControl/DataSourceType.h"
+
+namespace o2::quality_control::core
+{
+
+/// \brief returns a standard ConcreteDataMatcher for QC inputs and outputs
+framework::ConcreteDataMatcher
+  createUserDataMatcher(DataSourceType dataSourceType, const std::string& detectorName, const std::string& userCodeName);
+
+/// \brief returns a standard InputSpec for QC inputs and outputs
+framework::InputSpec
+  createUserInputSpec(DataSourceType dataSourceType, const std::string& detectorName, const std::string& userCodeName);
+
+/// \brief returns a standard OutputSpec for QC inputs and outputs
+framework::OutputSpec
+  createUserOutputSpec(DataSourceType dataSourceType, const std::string& detectorName, const std::string& userCodeName);
+
+} // namespace o2::quality_control::core
+
+#endif // QUALITYCONTROL_USERINPUTOUTPUT_H

Framework/src/DataHeaderHelpers.cxx

@@ -100,4 +100,29 @@ auto createDataDescription(const std::string& name, size_t hashLength) -> o2::he
   }
 }
 
+constexpr size_t descriptionHashLengthFor(DataSourceType type)
+{
+  size_t hashLength = 0;
+  switch (type) {
+    case DataSourceType::DataSamplingPolicy:
+    case DataSourceType::Direct:
+    case DataSourceType::ExternalTask:
+      throw std::invalid_argument("Provided data source type is not generated by QC, cannot provide a hash length");
+    case DataSourceType::Task:
+    case DataSourceType::TaskMovingWindow:
+    case DataSourceType::Check:
+    case DataSourceType::Aggregator:
+    case DataSourceType::PostProcessingTask:
+    default:
+      hashLength = 4;
+  }
+  assert(hashLength <= o2::header::DataDescription::size);
+  return hashLength;
+}
+
+auto createDataDescription(const std::string& name, DataSourceType type) -> o2::header::DataDescription
+{
+  return createDataDescription(name, descriptionHashLengthFor(type));
+}
+
 } // namespace o2::quality_control::core

Framework/src/InfrastructureGenerator.cxx

@@ -31,6 +31,7 @@
 #include "QualityControl/TaskRunner.h"
 #include "QualityControl/TaskRunnerFactory.h"
 #include "QualityControl/Version.h"
+#include "QualityControl/UserInputOutput.h"
 
 #include <Framework/DataProcessorSpec.h>
 #include <Framework/DataRefUtils.h>

Framework/src/UserInputOutput.cxx

@@ -0,0 +1,56 @@
+// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+///
+/// \file    UserInputOutput.cxx
+/// \author  Piotr Konopka
+///
+
+#include "QualityControl/UserInputOutput.h"
+
+namespace o2::quality_control::core
+{
+
+framework::ConcreteDataMatcher
+  createUserDataMatcher(DataSourceType dataSourceType, const std::string& detectorName, const std::string& userCodeName)
+{
+  return {
+    createDataOrigin(dataSourceType, detectorName),
+    createDataDescription(userCodeName, dataSourceType),
+    0
+  };
+}
+
+framework::InputSpec
+  createUserInputSpec(DataSourceType dataSourceType, const std::string& detectorName, const std::string& userCodeName)
+{
+  // currently all of our outputs are Lifetime::Sporadic, so we don't allow for customization, but it could be factored out.
+  // we assume using `userCodeName` as a binding in all cases
+  return {
+    userCodeName,
+    createUserDataMatcher(dataSourceType, detectorName, userCodeName),
+    framework::Lifetime::Sporadic
+  };
+}
+
+framework::OutputSpec
+  createUserOutputSpec(DataSourceType dataSourceType, const std::string& detectorName, const std::string& userCodeName)
+{
+  // currently all of our outputs are Lifetime::Sporadic, so we don't allow for customization, but it could be factored out.
+  // we assume using `userCodeName` as a binding in all cases
+  return {
+    framework::OutputLabel{ userCodeName },
+    createUserDataMatcher(dataSourceType, detectorName, userCodeName),
+    framework::Lifetime::Sporadic
+  };
+}
+
+} // namespace o2::quality_control::core

Framework/test/testDataHeaderHelpers.cxx

@@ -44,4 +44,7 @@ TEST_CASE("DataDescription")
   CHECK(createDataDescription("LOOOOOOOOOOOOOOONG", 4) != DataDescription("LOOOOOOOOOOOOOON"));
 
   CHECK_THROWS(createDataDescription("LOOOOOOOOOOOOOOONG", DataDescription::size + 50));
+
+  CHECK(createDataDescription("LOOOOOOOOOOOOOOONG", DataSourceType::Task) != DataDescription("LOOOOOOOOOOOOOON"));
+  CHECK_THROWS(createDataDescription("WHATEVER", DataSourceType::ExternalTask));
 }

Framework/test/testUserInputOutput.cxx

@@ -0,0 +1,53 @@
+// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+///
+/// \file    testUserInputOutput.cxx
+/// \author  Piotr Konopka
+///
+
+#include <catch_amalgamated.hpp>
+
+#include <Headers/DataHeader.h>
+#include <Framework/DataSpecUtils.h>
+
+#include "QualityControl/UserInputOutput.h"
+
+using namespace o2::header;
+
+namespace o2::quality_control::core
+{
+
+TEST_CASE("ConcreteDataMatcher")
+{
+  auto dataMatcher = createUserDataMatcher(DataSourceType::Task, "TST", "mytask");
+  CHECK(dataMatcher.origin == DataOrigin{ "QTST" });
+  CHECK(dataMatcher.description == DataDescription{ "mytask" });
+  CHECK(dataMatcher.subSpec == 0);
+}
+
+TEST_CASE("InputSpec")
+{
+  auto inputSpec = createUserInputSpec(DataSourceType::Task, "TST", "mytask");
+  CHECK(inputSpec.binding == "mytask");
+  CHECK(inputSpec.lifetime == framework::Lifetime::Sporadic);
+  CHECK(framework::DataSpecUtils::match(inputSpec, framework::ConcreteDataMatcher{ DataOrigin{ "QTST" }, DataDescription{ "mytask" }, 0 }));
+}
+
+TEST_CASE("OutputSpec")
+{
+  auto outputSpec = createUserOutputSpec(DataSourceType::Task, "TST", "mytask");
+  CHECK(outputSpec.binding.value == "mytask");
+  CHECK(outputSpec.lifetime == framework::Lifetime::Sporadic);
+  CHECK(framework::DataSpecUtils::match(outputSpec, framework::ConcreteDataMatcher{ DataOrigin{ "QTST" }, DataDescription{ "mytask" }, 0 }));
+}
+
+} // namespace o2::quality_control::core