[SCSB-174] move DMS requirement <-> test correlations from @metrics_logger decorators to romancal/tests/dms_requirement_tests.json

[zacharyburnett]

Resolves SCSB-174

consolidates all test requirement correlations into romancal/tests/dms_requirement_tests.json, obviating the need to insert log messages at test execution time with metrics_logger

This PR (and its sister PRs spacetelescope/romanisim#146 and spacetelescope/crds#1064) blocks https://grit.stsci.edu/dmd/roman-metrics/-/merge_requests/21

Checklist

• for a public change, added a towncrier news fragment in changes/

  echo "changed something" > changes/<PR#>.<changetype>.rst

  • changes/<PR#>.general.rst: infrastructure or miscellaneous change
  • changes/<PR#>.docs.rst
  • changes/<PR#>.stpipe.rst
  • changes/<PR#>.associations.rst
  • changes/<PR#>.scripts.rst
  • changes/<PR#>.mosaic_pipeline.rst
  • changes/<PR#>.patch_match.rst

  steps

  • changes/<PR#>.dq_init.rst
  • changes/<PR#>.saturation.rst
  • changes/<PR#>.refpix.rst
  • changes/<PR#>.linearity.rst
  • changes/<PR#>.dark_current.rst
  • changes/<PR#>.jump_detection.rst
  • changes/<PR#>.ramp_fitting.rst
  • changes/<PR#>.assign_wcs.rst
  • changes/<PR#>.flatfield.rst
  • changes/<PR#>.photom.rst
  • changes/<PR#>.flux.rst
  • changes/<PR#>.source_detection.rst
  • changes/<PR#>.tweakreg.rst
  • changes/<PR#>.skymatch.rst
  • changes/<PR#>.outlier_detection.rst
  • changes/<PR#>.resample.rst
  • changes/<PR#>.source_catalog.rst

• updated relevant tests

• updated relevant documentation

• updated relevant milestone(s)

• added relevant label(s)

• ran regression tests, post a link to the Jenkins job below. How to run regression tests on a PR

[braingram]

Thanks for taking this on. Would you add a test that confirms the tests listed in the json file are found by pytest? That way if a future PR renames or removes a test we'll know before the metrics collection fails.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.55%. Comparing base (908f0f9) to head (6357adc).
Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1399      +/-   ##
==========================================
+ Coverage   78.46%   78.55%   +0.08%     
==========================================
  Files         117      117              
  Lines        7866     7843      -23     
==========================================
- Hits         6172     6161      -11     
+ Misses       1694     1682      -12     

Flag	Coverage Δ		*Carryforward flag
nightly	62.24% <ø> (ø)		Carriedforward from f64cdcc

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[braingram]

Can we hide the test_requirements.json file and rename it soemthing like required_dms_tests.json. I think the generic test_requirements.json invites confusion.

[zacharyburnett]

Can we hide the test_requirements.json file and rename it soemthing like required_dms_tests.json. I think the generic test_requirements.json invites confusion.

good idea, would you want to put it in romancal/tests/?

[braingram]

Good idea! I think romancal/tests makes sense.

[braingram]

I "approve" this but leave the final approvals up to @jglorioso-stsci and @schlafly. Thanks!

[jglorioso-stsci]

Missing a few DMS requirements in test_ramp_fitting.py. Otherwise, looks good!