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

Add a command to view scoring breakdown #28

Closed
7 of 8 tasks
alilleybrinker opened this issue Apr 25, 2024 · 2 comments · Fixed by #170
Closed
7 of 8 tasks

Add a command to view scoring breakdown #28

alilleybrinker opened this issue Apr 25, 2024 · 2 comments · Fixed by #170
Assignees
Labels
type: enhancement New feature or request
Milestone

Comments

@alilleybrinker
Copy link
Collaborator

alilleybrinker commented Apr 25, 2024

Right now you can configure Hipcheck to produce scores based on weights for different analyses, but you can't really see the calculated percentages for each leaf of the scoring tree, which makes it difficult to understand how scores are actually calculated. It would be really great if there were a command to see this broken down, and ideally also a way to see it in the output (both human and machine readable) when you run analyses.

  • Define new AnalysisReport struct to abstract value/threshold predicate and move into Pass/Fail enumeration.
  • Update analyses to use new AnalysisReport.
  • Move decision to run/skip analysis out of X_analysis() functions and into the HipCheck core
  • Change AnalysisResults to be a HashMap that maps analysis labels to updated AnalysisReport objects
  • Create WeightTree object and provider for getting a normalized version based on config
  • Update scoring to combine updated AnalysisResults map + normalized WeightTree to produce a ScoreTree
  • Update errored analyses to act as Fail for the purpose of score calculation, and notify user of errors
  • Add ability to print what percentage of the total score each analysis accounted for by walking the ScoreTree
@alilleybrinker
Copy link
Collaborator Author

Hey @vcfxb, with Julian out for a bit, think you could bring this over the finish line? With the introduction of the weight tree abstraction we should have all the underlying mechanisms in place to add the new subcommand. I'm happy to sync to discuss what's left for this.

@vcfxb
Copy link
Contributor

vcfxb commented Jul 1, 2024

Looking into this now -- I think it would probably be good to sync up and discuss what still needs to be done sometime @alilleybrinker

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
Archived in project
Status: No status
Development

Successfully merging a pull request may close this issue.

3 participants