UnitTestFixture.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
*/

 
 
//
// includes
//
 
#include <EventLoopTest/UnitTestFixture.h>
 
#include <AsgMessaging/MessageCheck.h>
#include <EventLoop/Driver.h>
#include <AnaAlgorithm/AnaAlgorithmConfig.h>
#include <EventLoopTest/UnitTestAlg1.h>
#include <EventLoopTest/UnitTestConfig.h>
#include <RootCoreUtils/Assert.h>
#include <RootCoreUtils/ThrowMsg.h>
#include <SampleHandler/DiskWriter.h>
#include <SampleHandler/MetaFields.h>
#include <SampleHandler/SampleHandler.h>
#include <SampleHandler/SampleLocal.h>
#include <TChain.h>
#include <TFile.h>
#include <TH1.h>
#include <TTree.h>
#include <TSystem.h>
#include <mutex>
 
//
// method implementations
//
 
namespace EL
{
  namespace
  {
    std::vector<std::string>
    readVectorFromTree (SH::Sample *sample, const std::string& treeName,
            const std::string& branchName)
    {
      std::vector<std::string> result;
      auto fileNames = sample->makeFileList();
      TString *var = nullptr;
      for (auto& fileName : fileNames)
      {
    std::unique_ptr<TFile> file (TFile::Open (fileName.c_str(), "READ"));
    if (file == nullptr)
      RCU_THROW_MSG ("failed to open file: " + fileName);
    TTree *tree = dynamic_cast<TTree*>(file->Get (treeName.c_str()));
    Long64_t nentries = 0;
    if (tree != nullptr && (nentries = tree->GetEntries()) > 0)
    {
      TBranch *branch = nullptr;
      tree->SetBranchAddress (branchName.c_str(), &var, &branch);
      for (Long64_t entry = 0; entry < nentries; ++ entry)
      {
        if (branch->GetEntry(entry) <= 0)
          RCU_THROW_MSG ("failed to read entry from branch");
        result.push_back (var->Data());
      }
    }
      }
      return result;
    }
  }
 
 
 
 
  std::map<std::shared_ptr<Driver>,std::string> UnitTestFixture::m_jobs;
 
  std::shared_ptr<SH::Sample> UnitTestFixture ::
  getSample (const std::string& sampleName)
  {
    if (sampleName == "empty")
    {
      static std::shared_ptr<SH::Sample> result;
      static std::once_flag flag;
      std::call_once (flag, [this]() {
        auto myresult = std::make_shared<SH::SampleLocal> ("empty");
        myresult->add (makeFile ({}));
        result = std::move (myresult);
      });
      return result;
    }
    if (sampleName == "single")
    {
      static std::shared_ptr<SH::Sample> result;
      static std::once_flag flag;
      std::call_once (flag, [this]() {
        auto myresult = std::make_shared<SH::SampleLocal> ("single");
        std::vector<unsigned> entries;
        for (unsigned iter = 0; iter != 10000; ++ iter)
          entries.push_back (iter % 10);
        myresult->add (makeFile (entries));
        result = std::move (myresult);
      });
      return result;
    }
    if (sampleName == "multi")
    {
      static std::shared_ptr<SH::Sample> result;
      static std::once_flag flag;
      std::call_once (flag, [this]() {
        auto myresult = std::make_shared<SH::SampleLocal> ("multi");
        for (unsigned jter = 0; jter != 10; ++ jter)
        {
          std::vector<unsigned> entries;
          for (unsigned iter = 0; iter != 10000; ++ iter)
            entries.push_back (iter % 10);
          myresult->add (makeFile (entries));
        }
        result = std::move (myresult);
      });
      return result;
    }
    RCU_THROW_MSG ("unknown sample: " + sampleName);
  }
 
 
 
  SH::SampleHandler UnitTestFixture ::
  getSH ()
  {
    SH::SampleHandler sh;
    sh.add (getSample ("empty"));
    sh.add (getSample ("single"));
    sh.add (getSample ("multi"));
    sh.setMetaString (SH::MetaFields::treeName, "physics");
    return sh;
  }
 
 
 
  std::string UnitTestFixture ::
  getJob ()
  {
    using namespace asg::msgUserCode;
    ANA_MSG_INFO ("in EventLoopTest");
 
    std::shared_ptr<Driver> driver = GetParam().m_driver;
    auto iter = m_jobs.find (driver);
    if (iter != m_jobs.end())
      return iter->second;
 
    Job job;
    job.sampleHandler (getSH());
    GetParam().setupJob (job);
    {
      EL::AnaAlgorithmConfig config;
      config.setType ("EL::UnitTestAlg2");
      config.setName ("newAlg");
      config.setUseXAODs (false);
      ANA_CHECK_THROW (config.setProperty ("property", 42));
      job.algsAdd (config);
    }
    {
      std::unique_ptr<UnitTestAlg1> alg (new UnitTestAlg1);
      job.algsAdd (alg.release());
    }
 
    std::ostringstream submit;
    submit << "submit-" << driver.get();
    driver->submit (job, submit.str());
    driver->wait (submit.str());
    m_jobs[driver] = submit.str();
    return submit.str();
  }
 
 
 
  TObject *UnitTestFixture ::
  getTObject (const std::string& sampleName,
          const std::string& objectName,
          bool isMandatory)
  {
    SH::SampleHandler sh;
    sh.load (getJob() + "/hist");
    SH::Sample *sample = sh.get (sampleName);
    if (sample == nullptr)
      RCU_THROW_MSG ("couldn't find sample: " + sampleName);
    TObject *object = sample->readHist (objectName);
    if (isMandatory && object == nullptr)
      RCU_THROW_MSG ("couldn't find object: " + objectName);
    return object;
  }
 
 
 
  unsigned UnitTestFixture ::
  eventCount (const std::string& sampleName)
  {
    TH1 *hist = getHist<TH1> (sampleName, "EventLoop_EventCount", true);
    return hist->GetBinContent (1);
  }
 
 
 
  TH1 *UnitTestFixture ::
  getCallbacks (const std::string& sampleName)
  {
    return getHist<TH1> (sampleName, "callbacks", true);
  }
 
 
 
  void UnitTestFixture ::
  checkFileExecuted (const std::string& sampleName)
  {
    std::set<std::string> filesOut;
    {
      SH::SampleHandler sh;
      sh.load (getJob() + "/hist");
      SH::Sample *sample = sh.get (sampleName);
      if (sample == nullptr)
    RCU_THROW_MSG ("couldn't find sample: " + sampleName);
      auto vec = readVectorFromTree (sample, "EventLoop_FileExecuted", "file");
      filesOut.insert (vec.begin(), vec.end());
    }
    std::set<std::string> filesIn;
    for (auto& file : getSample (sampleName)->makeFileList())
    {
      auto split = file.rfind ('/');
      if (split == std::string::npos)
    split = 0;
      else
    ++ split;
      std::string fileName = file.substr (split);
      ASSERT_TRUE (filesIn.find (fileName) == filesIn.end());
      filesIn.insert (fileName);
    }
    ASSERT_EQ (filesIn, filesOut);
  }
 
 
 
  std::string UnitTestFixture ::
  makeFile (const std::vector<unsigned>& entries)
  {
    static unsigned index = 0;
    std::ostringstream fileName;
    fileName << "file-" << ++ index << ".root";
 
    std::unique_ptr<SH::DiskWriter> file
      = GetParam().make_file_writer (fileName.str());
    {
      if (!entries.empty())
      {
    TTree *tree = new TTree ("physics", "physics");
    Int_t el_n = 0;
    tree->Branch ("el_n", &el_n, "el_n/I");
    for (auto entry : entries)
    {
      el_n = entry;
      tree->Fill ();
    }
      }
      file->file()->Write ();
      file->close ();
    }
    return file->path();
  }
 
 
 
  TEST_P (UnitTestFixture, empty_eventCount)
  {
    EXPECT_EQ (eventCount ("empty"), 0u);
  }
 
 
 
  TEST_P (UnitTestFixture, empty_callbacks)
  {
    TH1 *callbacks = getCallbacks ("empty");
    EXPECT_EQ (0, callbacks->GetBinContent (1 + UnitTestAlg1::CB_CHANGE_INPUT_FIRST));
    EXPECT_EQ (0, callbacks->GetBinContent (1 + UnitTestAlg1::CB_CHANGE_INPUT_OTHER));
    EXPECT_EQ (0, callbacks->GetBinContent (1 + UnitTestAlg1::CB_INITIALIZE));
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_HIST_INITIALIZE));
    EXPECT_EQ (0, callbacks->GetBinContent (1 + UnitTestAlg1::CB_EXECUTE));
    EXPECT_EQ (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_FILE_EXECUTE));
    EXPECT_EQ (0, callbacks->GetBinContent (1 + UnitTestAlg1::CB_FINALIZE));
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_HIST_FINALIZE));
  }
 
 
 
  TEST_P (UnitTestFixture, empty_fileExecuted)
  {
    checkFileExecuted ("empty");
  }
 
 
 
  TEST_P (UnitTestFixture, single_eventCount)
  {
    EXPECT_EQ (eventCount ("single"), 10000u);
  }
 
 
 
  TEST_P (UnitTestFixture, single_callbacks)
  {
    TH1 *callbacks = getCallbacks ("single");
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_CHANGE_INPUT_FIRST));
    EXPECT_LE (0, callbacks->GetBinContent (1 + UnitTestAlg1::CB_CHANGE_INPUT_OTHER));
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_INITIALIZE));
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_HIST_INITIALIZE));
    EXPECT_EQ (10000, callbacks->GetBinContent (1 + UnitTestAlg1::CB_EXECUTE));
    EXPECT_EQ (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_FILE_EXECUTE));
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_FINALIZE));
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_HIST_FINALIZE));
  }
 
 
 
  TEST_P (UnitTestFixture, single_fileExecuted)
  {
    checkFileExecuted ("single");
  }
 
 
 
  TEST_P (UnitTestFixture, multi_eventCount)
  {
    EXPECT_EQ (eventCount ("multi"), 100000u);
  }
 
 
 
  TEST_P (UnitTestFixture, multi_callbacks)
  {
    TH1 *callbacks = getCallbacks ("multi");
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_CHANGE_INPUT_FIRST));
    EXPECT_LE (0, callbacks->GetBinContent (1 + UnitTestAlg1::CB_CHANGE_INPUT_OTHER));
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_INITIALIZE));
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_HIST_INITIALIZE));
    EXPECT_EQ (100000, callbacks->GetBinContent (1 + UnitTestAlg1::CB_EXECUTE));
    EXPECT_EQ (10, callbacks->GetBinContent (1 + UnitTestAlg1::CB_FILE_EXECUTE));
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_FINALIZE));
    EXPECT_LE (1, callbacks->GetBinContent (1 + UnitTestAlg1::CB_HIST_FINALIZE));
  }
 
 
 
  TEST_P (UnitTestFixture, multi_fileExecuted)
  {
    checkFileExecuted ("multi");
  }
 
 
 
  TEST_P (UnitTestFixture, multi_out_empty)
  {
    SH::SampleHandler sh;
    sh.load (getJob() + "/output-out_empty");
    SH::Sample *sample = sh.get ("multi");
    ASSERT_TRUE (sample != nullptr);
 
    for (auto fileName : sample->makeFileList())
    {
      std::unique_ptr<TFile> file (TFile::Open (fileName.c_str(), "READ"));
    }
  }
}