Generate JSON output from validate_drp for inclusion in a test harness

XMLWordPrintable

Details

• Type: Story
• Status: Done
• Resolution: Done
• Fix Version/s: None
• Component/s:
• Labels:
None
• Story Points:
2
• Team:
SQuaRE

Description

Generate JSON output from validate_drp for inclusion in a test harness.

Generate a file that summarizes the key metrics calculated by validate_drp.

Develop naming conventions that will make it easy to plug into the eventual harness being developed as part of DM-2050.

Activity

Hide
Michael Wood-Vasey added a comment -

Moderately straight-forward review. Refactoring and new ability to output Key Performance Metrics and their associated info as JSON files.

I would appreciate your thoughts on presenting the output. I currently have a separate JSON fild for each metric. Putting them together in one makes sense, but then would need a packaging solution, which was taking a step toward DM-2050. So I figured I would keep it simple and obvious and we can restructure things later however might be best useful.

Show
Michael Wood-Vasey added a comment - Moderately straight-forward review. Refactoring and new ability to output Key Performance Metrics and their associated info as JSON files. I would appreciate your thoughts on presenting the output. I currently have a separate JSON fild for each metric. Putting them together in one makes sense, but then would need a packaging solution, which was taking a step toward DM-2050 . So I figured I would keep it simple and obvious and we can restructure things later however might be best useful.
Hide
Michael Wood-Vasey added a comment -

Oh, right. J Matt Peterson [X] has wonderful reasons to not be reviewing tickets.

Tim Jenness Would you mind taking a look at this on his behalf?

Show
Michael Wood-Vasey added a comment - Oh, right. J Matt Peterson [X] has wonderful reasons to not be reviewing tickets. Tim Jenness Would you mind taking a look at this on his behalf?
Hide
Tim Jenness added a comment -

I have some comments on the PR, many of them caused by confusion at lack of documentation for a parameter.

Regarding JSON output, keeping it simple is fine but I think we have to consider moving that generic serialization code to pipe_base.

Show
Tim Jenness added a comment - I have some comments on the PR, many of them caused by confusion at lack of documentation for a parameter. Regarding JSON output, keeping it simple is fine but I think we have to consider moving that generic serialization code to pipe_base .
Hide
Michael Wood-Vasey added a comment -

Thanks Tim Jenness.
Merged to master.

Key changes in response to PR comments.
1. Documentation improved, particularly about the behavior of the plotBase, now outputPrefix, option.
2. Docstrings updated to better follow Python documentation standards.
3. JSON test now a real unittest.

Open Questions that arose in the review:
1. Should the Struct serialization to JSON code be adopted into pipe_base itself.
2. Should we encourage module-specific Error hierarchies, and if so, should those multiply inherit from both the module base error class and a relevant standard Python error class?

Show
Michael Wood-Vasey added a comment - Thanks Tim Jenness . Merged to master. Key changes in response to PR comments. 1. Documentation improved, particularly about the behavior of the plotBase , now outputPrefix , option. 2. Docstrings updated to better follow Python documentation standards. 3. JSON test now a real unittest. Open Questions that arose in the review: 1. Should the Struct serialization to JSON code be adopted into pipe_base itself. 2. Should we encourage module-specific Error hierarchies, and if so, should those multiply inherit from both the module base error class and a relevant standard Python error class?

People

Assignee:
Michael Wood-Vasey
Reporter:
Michael Wood-Vasey
Reviewers:
Tim Jenness
Watchers:
J Matt Peterson [X] (Inactive), Michael Wood-Vasey, Tim Jenness