Initial Implementation of ProducesCollector

[wddgit]

PR description:

Initial implementation of the ProducesCollector. The ProducerBase::produces function is now a protected member of ProducerBase. When produces needs to be called in a helper class (outside the module constructor), the ProducesCollector must be used. This PR also migrates all the code in the repository to work with this change. It does not affect modules that call produces directly inside their constructor. The purpose is to reduce the number of things that depend on ProducerBase. Helper classes used by modules no longer need to depend on it.

PR validation:

Includes a new unit test for the ProducesCollector class.

[cmsbuild]

The code-checks are being triggered in jenkins.

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-28154/12208

• This PR adds an extra 484KB to repository

• There are other open Pull requests which might conflict with changes you have proposed:

  • File SimTracker/SiPhase2Digitizer/plugins/Phase2TrackerDigitizer.cc modified in PR(s): DataFormats dependency on Geometry Cleanup #28127
  • File SimTracker/SiPixelDigitizer/plugins/PreMixingSiPixelWorker.cc modified in PR(s): DataFormats dependency on Geometry Cleanup #28127
  • File SimTracker/SiPixelDigitizer/plugins/SiPixelDigitizer.cc modified in PR(s): DataFormats dependency on Geometry Cleanup #28127

[cmsbuild]

A new Pull Request was created by @wddgit (W. David Dagenhart) for master.

It involves the following packages:

EventFilter/L1TRawToDigi
EventFilter/RPCRawToDigi
FWCore/Framework
FWCore/Integration
FastSimulation/SimplifiedGeometryPropagator
FastSimulation/Tracking
HLTrigger/Muon
PhysicsTools/UtilAlgos
RecoPixelVertexing/PixelTriplets
RecoTracker/FinalTrackSelectors
RecoTracker/TkHitPairs
SimCalorimetry/CastorSim
SimCalorimetry/EcalSimProducers
SimCalorimetry/EcalTestBeam
SimCalorimetry/HGCalSimProducers
SimCalorimetry/HcalSimProducers
SimCalorimetry/HcalTestBeam
SimFastTiming/FastTimingCommon
SimG4Core/Application
SimG4Core/Watcher
SimGeneral/CaloAnalysis
SimGeneral/MixingModule
SimGeneral/PileupInformation
SimGeneral/PreMixingModule
SimGeneral/TrackingAnalysis
SimMuon/CSCDigitizer
SimTracker/SiPhase2Digitizer
SimTracker/SiPixelDigitizer
SimTracker/SiStripDigitizer

@perrotta, @smuzaffar, @benkrikler, @Dr15Jones, @lveldere, @civanch, @sbein, @ssekmen, @mdhildreth, @Martin-Grunewald, @rekovic, @cmsbuild, @kpedro88, @slava77, @fwyzard, @santocch can you please review it and eventually sign? Thanks.
@echabert, @felicepantaleo, @pieterdavid, @kpedro88, @argiro, @Martin-Grunewald, @pfs, @thomreis, @threus, @mmusich, @sethzenz, @battibass, @makortel, @jhgoh, @lgray, @apsallid, @prolay, @HuguesBrun, @dildick, @trocino, @vandreev11, @abbiendi, @GiacomoSguazzoni, @rovere, @VinInn, @cseez, @ptcox, @deguio, @mschrode, @ebrondol, @dgulhan, @calderona, @dkotlins, @gpetruc, @matt-komm, @mariadalfonso, @folguera this is something you requested to watch as well.
@davidlange6, @slava77, @fabiocos you are the release manager for this.

cms-bot commands are listed here

[wddgit]

please test

This should not change the results of any output.

[cmsbuild]

The tests are being triggered in jenkins.
https://cmssdt.cern.ch/jenkins/job/ib-run-pr-tests/2884/console Started: 2019/10/10 20:23

[cmsbuild]

+1
Tested at: ef9f5cd
https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-ba9894/2884/summary.html

[cmsbuild]

Comparison job queued.

[fabiocos]

@ssekmen @sbein @rekovic @civanch could you please check this PR?

[wddgit]

5 reviewers approved but still waiting for 3 on this PR. This one is a really simple technical software change. It creates a ProducesCollector analogous to the ConsumesCollector so
that modules do not have to interact directly with the ProducerBase class. Unless I've made a blatant mistake, it should have no effect on results or performance. It just improves code organization, reduces dependences, and makes the code easier to maintain. The changes outside the Core code simply migrate modules to use the new interface.

[fabiocos]

code-checks

[cmsbuild]

The code-checks are being triggered in jenkins.

[ssekmen]

+1

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-28154/12535

• This PR adds an extra 360KB to repository

• There are other open Pull requests which might conflict with changes you have proposed:

  • File SimCalorimetry/EcalSimProducers/plugins/PreMixingEcalWorker.cc modified in PR(s): ECAL for Time dependent MC. Premix option C. Handle for APD/PN tag for time dependence #28214

[fabiocos]

In my test there is no real merge conflict with #28214 so the integration of this PR may move forward seamlessly

[rekovic]

+1

[fabiocos]

@civanch please have a look, the implementation looks coherent with all the other areas as far as I can understand. I plan to integrate this PR in next IB tonight

[civanch]

+1

[cmsbuild]

This pull request is fully signed and it will be integrated in one of the next master IBs (tests are also fine). This pull request will now be reviewed by the release team before it's merged. @davidlange6, @slava77, @smuzaffar, @fabiocos (and backports should be raised in the release meeting by the corresponding L2)

[fabiocos]

+1