test_ProcessorOptions.cxx

Go to the documentation of this file.

// 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.
#include "Framework/runDataProcessing.h"
#include "Framework/CallbackService.h"
#include "Framework/ControlService.h"
#include "Framework/Logger.h"
 
#include <memory>
 
using namespace o2::framework;
 
#define ASSERT_ERROR(condition)                                                                      \
  if ((condition) == false) {                                                                        \
    LOG(fatal) << R"(Test condition ")" #condition R"(" failed at )" << __FILE__ << ":" << __LINE__; \
  }
 
// This is how you can define your processing in a declarative way
WorkflowSpec defineDataProcessing(ConfigContext const&)
{
  return WorkflowSpec{
    DataProcessorSpec{
      "producer",
      Inputs{},
      {
        OutputSpec{"TST", "TEST"},
      },
      AlgorithmSpec{
        // define init callback
        [](InitContext& ic) {
          auto configstring = ic.options().get<std::string>("global-config");
          // read back the option from the command line, see CMakeLists.txt
          ASSERT_ERROR(configstring == "require-me");
 
          return [isReady = std::make_shared<bool>(false)](ProcessingContext& ctx) {
            if (*isReady == true) {
              return;
            }
            // there is nothing to do, simply stop the workflow but we have to send at least one message
            // to make sure that the callback of the consumer is called
            ctx.outputs().make<int>(Output{"TST", "TEST", 0}) = 42;
            ctx.services().get<ControlService>().endOfStream();
            *isReady = true;
          };
        },
      },
      {
        ConfigParamSpec{"channel-config",
                        VariantType::String,
                        "name=foo,type=sub,method=connect,address=tcp://localhost:5450,rateLogging=1",
                        {"Out-of-band channel config"}},
        ConfigParamSpec{"global-config", VariantType::String, {"A global config option for all processor specs"}},
      },
    },
    DataProcessorSpec{
      "consumer",
      Inputs{
        InputSpec{"in", "TST", "TEST"},
      },
      {},
      AlgorithmSpec{
        // define an init callback
        [](InitContext& ic) {
          // read back the option from the command line, see CMakeLists.txt
          auto configstring = ic.options().get<std::string>("global-config");
          auto anotheroption = ic.options().get<std::string>("local-option");
          auto aBoolean = ic.options().get<bool>("a-boolean");
          auto aBoolean2 = ic.options().get<bool>("a-boolean2");
          auto aBoolean3 = ic.options().get<bool>("a-boolean3");
          auto anInt = ic.options().get<int>("an-int");
          auto anInt2 = ic.options().get<int>("an-int2");
          auto anInt64 = ic.options().get<int64_t>("an-int64");
          auto anInt64_2 = ic.options().get<int64_t>("an-int64-2");
          auto aDouble = ic.options().get<double>("a-double");
          auto aDouble2 = ic.options().get<double>("a-double2");
 
          ASSERT_ERROR(aBoolean == true);
          ASSERT_ERROR(aBoolean2 == false);
          ASSERT_ERROR(aBoolean3 == true);
          ASSERT_ERROR(anInt == 10);
          ASSERT_ERROR(anInt2 == 20);
          ASSERT_ERROR(anInt64 == 1ll);
          ASSERT_ERROR(anInt64_2 == 50000000000000ll);
          ASSERT_ERROR(aDouble == 11.);
          ASSERT_ERROR(aDouble2 == 22.);
          ASSERT_ERROR(configstring == "consumer-config");
          ASSERT_ERROR(anotheroption == "hello-aliceo2");
 
          auto data = std::make_shared<int>(0);
          ic.services().get<CallbackService>().set<CallbackService::Id::EndOfStream>(
            [data](EndOfStreamContext& context) {
              ASSERT_ERROR(*data == 42);
            });
          return [data](ProcessingContext& ctx) {
            // there is nothing to do, simply stop the workflow
            *data = ctx.inputs().get<int>("in");
          };
        },
      },
      {
        ConfigParamSpec{"global-config", VariantType::String, {"A global config option for all processor specs"}},
        ConfigParamSpec{"local-option", VariantType::String, {"Option only valid for this processor spec"}},
        ConfigParamSpec{"a-boolean", VariantType::Bool, true, {"A boolean which we pick by default"}},
        ConfigParamSpec{"a-boolean2", VariantType::Bool, false, {"Another boolean which we pick by default"}},
        ConfigParamSpec{"a-boolean3", VariantType::Bool, false, {"Another boolean which we pick from the outside options"}},
        ConfigParamSpec{"an-int", VariantType::Int, 10, {"An int for which we pick up the default"}},
        ConfigParamSpec{"an-int2", VariantType::Int, 1, {"An int for which we pick up the override"}},
        ConfigParamSpec{"an-int64", VariantType::Int64, 1ll, {"An int64 for which we pick up the default"}},
        ConfigParamSpec{"an-int64-2", VariantType::Int64, 2ll, {"An int64 for which we pick up the override"}},
        ConfigParamSpec{"a-double", VariantType::Double, 11., {"A double for which we pick up the override"}},
        ConfigParamSpec{"a-double2", VariantType::Double, 12., {"A double for which we pick up the override"}},
      },
    }};
}