Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DQM] Cleanup for private header usage #34773

Merged
merged 3 commits into from Aug 10, 2021
Merged

[DQM] Cleanup for private header usage #34773

merged 3 commits into from Aug 10, 2021

Conversation

smuzaffar
Copy link
Contributor

As reported in #34718 , this PR cleans up private header usage from DQM

  • cleanup of unnecessary DQM/Physics/src/EwkDQM.h include
  • DQMServices/Core/src/ROOTFilePB.pb.h is a generated header which we generate from ROOTFilePB.proto. I would suggest to keep it on the DQMServices/Core/src and instead provide a wrapper DQMServices/Core/interface/ROOTFilePB.h which other packages can include.

@cmsbuild
Copy link
Contributor

cmsbuild commented Aug 4, 2021

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-34773/24438

  • This PR adds an extra 32KB to repository

@cmsbuild
Copy link
Contributor

cmsbuild commented Aug 4, 2021

A new Pull Request was created by @smuzaffar (Malik Shahzad Muzaffar) for master.

It involves the following packages:

  • DQMOffline/Ecal (dqm)
  • DQMServices/Components (dqm)
  • DQMServices/Core (dqm)
  • DQMServices/FileIO (dqm)
  • DQMServices/StreamerIO (dqm)

@andrius-k, @kmaeshima, @ErnestaP, @ahmad3213, @cmsbuild, @jfernan2, @rvenditti can you please review it and eventually sign? Thanks.
@barvic, @rchatter, @argiro, @thomreis, @simonepigazzini, @rociovilar this is something you requested to watch as well.
@silviodonato, @dpiparo, @qliphy, @perrotta you are the release manager for this.

cms-bot commands are listed here

@smuzaffar
Copy link
Contributor Author

please test

@cmsbuild
Copy link
Contributor

cmsbuild commented Aug 4, 2021

+1

Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-33d024/17533/summary.html
COMMIT: 58cbff9
CMSSW: CMSSW_12_1_X_2021-08-03-2300/slc7_amd64_gcc900
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week0/cms-sw/cmssw/34773/17533/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

  • No significant changes to the logs found
  • Reco comparison results: 3 differences found in the comparisons
  • DQMHistoTests: Total files compared: 39
  • DQMHistoTests: Total histograms compared: 2998564
  • DQMHistoTests: Total failures: 1
  • DQMHistoTests: Total nulls: 0
  • DQMHistoTests: Total successes: 2998541
  • DQMHistoTests: Total skipped: 22
  • DQMHistoTests: Total Missing objects: 0
  • DQMHistoSizes: Histogram memory added: 0.0 KiB( 38 files compared)
  • Checked 165 log files, 37 edm output root files, 39 DQM output files
  • TriggerResults: no differences found

@jfernan2
Copy link
Contributor

jfernan2 commented Aug 5, 2021

Thanks @smuzaffar !!

@jfernan2
Copy link
Contributor

jfernan2 commented Aug 5, 2021

+1

@cmsbuild
Copy link
Contributor

cmsbuild commented Aug 5, 2021

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. @silviodonato, @dpiparo, @qliphy, @perrotta (and backports should be raised in the release meeting by the corresponding L2)

@@ -0,0 +1 @@
#include "DQMServices/Core/src/ROOTFilePB.pb.h"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@smuzaffar is this "trick" according to the rules? Isn't it the same as including from DQMServices/Core/src?
Why not to move directly DQMServices/Core/src/ROOTFilePB.pb.h into \interface?

Copy link
Contributor Author

@smuzaffar smuzaffar Aug 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes trick is according to the rules i.e. within a package one can use private headers :-) This allows unit tests of a package to use private headers and check the functionality.

I have no objections on moving ROOTFilePB.pb.h to interface too. We just need to make sure that next time when we update protobuf and re-generate these ROOTFilePB.pb.* files then the ROOTFilePB.pb.h should go in to interface.

Any objections @cms-sw/dqm-l2 ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No objections as far as I can tell

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes trick is according to the rules i.e. within a package one can use private headers :-) This allows unit tests of a package to use private headers and check the functionality.

Yes, but when included from DQMServices/FileIO/plugins/DQMFileSaverPB.cc or DQMServices/StreamerIO/plugins/DQMProtobufReader.cc it is not "within a package" any more...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thats true @perrotta but build rules only look for direct include of a private header of other package. As DQMServices/FileIO/plugins/DQMFileSaverPB.cc is not directly including src/ROOTFilePB.pb.h so it will not fail. Anyway, I will update the PR to move ROOTFilePB.pb.h in to interface

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done, src/ROOTFilePB.pb.h moved to interface/ROOTFilePB.pb.h

@smuzaffar
Copy link
Contributor Author

please test

@cmsbuild
Copy link
Contributor

cmsbuild commented Aug 5, 2021

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-34773/24481

  • This PR adds an extra 36KB to repository

  • Found files with invalid states:

    • DQMServices/Core/interface/ROOTFilePB.h:

@cmsbuild
Copy link
Contributor

cmsbuild commented Aug 5, 2021

Pull request #34773 was updated. @andrius-k, @kmaeshima, @ErnestaP, @ahmad3213, @jfernan2, @rvenditti can you please check and sign again.

@cmsbuild
Copy link
Contributor

cmsbuild commented Aug 5, 2021

+1

Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-33d024/17559/summary.html
COMMIT: a459f06
CMSSW: CMSSW_12_1_X_2021-08-04-2300/slc7_amd64_gcc900
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week0/cms-sw/cmssw/34773/17559/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

  • No significant changes to the logs found
  • Reco comparison results: 0 differences found in the comparisons
  • DQMHistoTests: Total files compared: 39
  • DQMHistoTests: Total histograms compared: 2999410
  • DQMHistoTests: Total failures: 1
  • DQMHistoTests: Total nulls: 0
  • DQMHistoTests: Total successes: 2999387
  • DQMHistoTests: Total skipped: 22
  • DQMHistoTests: Total Missing objects: 0
  • DQMHistoSizes: Histogram memory added: 0.0 KiB( 38 files compared)
  • Checked 165 log files, 37 edm output root files, 39 DQM output files
  • TriggerResults: no differences found

@perrotta
Copy link
Contributor

@cms-sw/dqm-l2 any further comment?

@jfernan2
Copy link
Contributor

+1

@cmsbuild
Copy link
Contributor

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. @perrotta, @dpiparo, @qliphy (and backports should be raised in the release meeting by the corresponding L2)

@qliphy
Copy link
Contributor

qliphy commented Aug 10, 2021

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants