Merge pull request cms-sw#43291 from mmusich/mm_lessVerbose_BeamSpotRcdPrinte

add verbose option to `BeamSpotRcdPrinter` and use it in the unit tests

Author: cmsbuild

CondTools/BeamSpot/plugins/BeamSpotRcdPrinter.cc

@@ -33,7 +33,7 @@ namespace BSPrintUtils {
 class BeamSpotRcdPrinter : public edm::one::EDAnalyzer<> {
 public:
   explicit BeamSpotRcdPrinter(const edm::ParameterSet& iConfig);
-  ~BeamSpotRcdPrinter() override;
+  ~BeamSpotRcdPrinter() override = default;
   void analyze(const edm::Event& evt, const edm::EventSetup& evtSetup) override;
   void endJob() override;
   static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);
@@ -48,6 +48,8 @@ class BeamSpotRcdPrinter : public edm::one::EDAnalyzer<> {
   unsigned long long m_endTime;
   // Specify output text file name. Leave empty if do not want to dump beamspots in a file.
   std::string m_output;
+  // decide if to print to screen the dump
+  bool m_verbose;
 };
 
 BeamSpotRcdPrinter::BeamSpotRcdPrinter(const edm::ParameterSet& iConfig)
@@ -56,13 +58,12 @@ BeamSpotRcdPrinter::BeamSpotRcdPrinter(const edm::ParameterSet& iConfig)
       m_tagName(iConfig.getParameter<std::string>("tagName")),
       m_startTime(iConfig.getParameter<unsigned long long>("startIOV")),
       m_endTime(iConfig.getParameter<unsigned long long>("endIOV")),
-      m_output(iConfig.getParameter<std::string>("output")) {
+      m_output(iConfig.getParameter<std::string>("output")),
+      m_verbose(iConfig.getParameter<bool>("verbose")) {
   m_connectionPool.setParameters(iConfig.getParameter<edm::ParameterSet>("DBParameters"));
   m_connectionPool.configure();
 }
 
-BeamSpotRcdPrinter::~BeamSpotRcdPrinter() {}
-
 void BeamSpotRcdPrinter::analyze(const edm::Event& evt, const edm::EventSetup& evtSetup) {
   cond::Time_t startIov = m_startTime;
   cond::Time_t endIov = m_endTime;
@@ -112,7 +113,7 @@ void BeamSpotRcdPrinter::analyze(const edm::Event& evt, const edm::EventSetup& e
   edm::LogInfo("BeamSpotRcdPrinter") << "[BeamSpotRcdPrinter::" << __func__ << "] "
                                      << "Read " << niov << " IOVs from tag " << m_tagName
                                      << " corresponding to the specified time interval.\n\n"
-                                     << ss.str();
+                                     << (m_verbose ? ss.str() : std::string{});
 
   condDbSession.transaction().commit();
 
@@ -130,7 +131,8 @@ void BeamSpotRcdPrinter::fillDescriptions(edm::ConfigurationDescriptions& descri
   desc.add<std::string>("tagName", "BeamSpotObjects_PCL_byLumi_v0_prompt");
   desc.add<unsigned long long>("startIOV", 1406859487478481);
   desc.add<unsigned long long>("endIOV", 1406876667347162);
-  desc.add<std::string>("output", "summary.txt");
+  desc.add<std::string>("output", "summary.txt")->setComment("ASCII file with the full tag dump information");
+  desc.add<bool>("verbose", true)->setComment("print to screen the dump of all the payloads");
   desc.add<std::string>("connect", "");
 
   edm::ParameterSetDescription descDBParameters;

CondTools/BeamSpot/test/BeamSpotRcdPrinter_cfg.py

@@ -13,12 +13,18 @@
                  1406713458589700, # default value
                  VarParsing.VarParsing.multiplicity.singleton, # singleton or list
                  VarParsing.VarParsing.varType.int, # string, int, or float
-                 "location of the input data")
+                 "starting IOV since")
 options.register('endIOV',
                  1406876667347162, # default value
                  VarParsing.VarParsing.multiplicity.singleton, # singleton or list
                  VarParsing.VarParsing.varType.int, # string, int, or float
-                 "location of the input data")
+                 "ending IOV since")
+options.register('verbose',
+                 True, # default value
+                 VarParsing.VarParsing.multiplicity.singleton, # singleton or list
+                 VarParsing.VarParsing.varType.bool, # string, int, or float
+                 "verbose output to screen")
+
 options.parseArguments()
 
 process.MessageLogger = cms.Service( "MessageLogger",
@@ -41,6 +47,7 @@
 process.BeamSpotRcdPrinter.tagName  = options.inputTag
 process.BeamSpotRcdPrinter.startIOV = options.startIOV
 process.BeamSpotRcdPrinter.endIOV   = options.endIOV
+process.BeamSpotRcdPrinter.verbose  = options.verbose
 process.BeamSpotRcdPrinter.output   = "summary.txt"
 
 ### 2018 Prompt

CondTools/BeamSpot/test/testReadWriteBeamSpotsFromDB.sh

@@ -38,7 +38,7 @@ printf "TESTING Reading BeamSpotOnlineHLTObjectsRcd DB object ...\n\n"
 cmsRun ${SCRAM_TEST_PATH}/BeamSpotOnlineRecordsReader_cfg.py unitTest=True inputRecord=BeamSpotOnlineHLTObjectsRcd || die "Failure reading payload for BeamSpotOnlineHLTObjectsRcd" $?
 
 printf "TESTING reading BeamSpotObjectRcd DB object ...\n\n"
-cmsRun ${SCRAM_TEST_PATH}/BeamSpotRcdPrinter_cfg.py || die "Failure running BeamSpotRcdPrinter" $?
+cmsRun ${SCRAM_TEST_PATH}/BeamSpotRcdPrinter_cfg.py startIOV=1406713458589700 endIOV=1614147494085159 verbose=False || die "Failure running BeamSpotRcdPrinter" $?
 cmsRun ${SCRAM_TEST_PATH}/BeamSpotRcdRead_cfg.py || die "Failure running BeamSpotRcdRead" $?
 
 printf "TESTING converting BeamSpotOnlineObjects from BeamSpotObjects ...\n\n"