fix: program validation for related program property [DHIS2-15952] #15885

jbee · 2023-12-11T12:35:26Z

Summary

It was possible to set the relatedProgram property to the program itself. This then is a circular reference which causes all kinds of errors in other places but also in the app.

In addition I found that following the app UI it seems that only tracker programs should have this property but it was possible to set it for event programs as well. So an additional validation was added to prevent this.

Automatic Testing

New scenario was added to verify that a program cannot reference itself as related program.

Manual Testing

UI

open maintenance app
edit a tracker program, try to select itself as the related program (2nd tab on enrollment details)
try to save, check an error message is shown
now try to select another program and save, check this works
now try to clear the related program and save, check this works

REST API

find a program to test with using the maintenance app or /api/programs
try to update the program with PUT to update the relatedProgram property to itself relatedProgram: { "id": "<uid>"}
check this gives error E6022 for tracker programs and error E4023 for event programs
try to update the property to any other program and check it works
try to clear the property and check it works

codecov · 2023-12-11T12:48:54Z

Codecov Report

Merging #15885 (e28348e) into master (a01b627) will decrease coverage by 0.01%.
Report is 1 commits behind head on master.
The diff coverage is 40.00%.

Additional details and impacted files

@@             Coverage Diff              @@
##             master   #15885      +/-   ##
============================================
- Coverage     66.38%   66.37%   -0.01%     
+ Complexity    31473    31472       -1     
============================================
  Files          3494     3494              
  Lines        130141   130149       +8     
  Branches      15191    15193       +2     
============================================
  Hits          86391    86391              
- Misses        36674    36678       +4     
- Partials       7076     7080       +4

Flag	Coverage Δ
integration	`50.07% <30.00%> (-0.01%)`	⬇️
integration-h2	`32.32% <40.00%> (+<0.01%)`	⬆️
unit	`30.39% <30.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
...rc/main/java/org/hisp/dhis/feedback/ErrorCode.java	`100.00% <100.00%> (ø)`
...c/main/java/org/hisp/dhis/program/ProgramType.java	`66.66% <33.33%> (-15.16%)`	⬇️
...ta/objectbundle/hooks/ProgramObjectBundleHook.java	`87.71% <33.33%> (-6.40%)`	⬇️

... and 1 file with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a01b627...e28348e. Read the comment docs.