Skip to content

verbose validate 1 #4

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.

Sign up for GitHub

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

Draft
dancewithheart wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

verbose validate 1 #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 32 additions & 3 deletions src/Hgs/Validate.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,42 @@ validateSnapshotValue =
isValid :: ValidationErrors -> Bool
isValid = null . getValidationErrors

-- TODO this needs to be rewriten
-- currently we just explain what checks does,
-- but those checks can fail undepenely and one need to know
-- which one failed
-- leaving comment for now as there are higher ROI changes
renderValidationReport :: ValidationErrors -> String
renderValidationReport errs
| isValid errs = "snapshot validation OK"
| isValid errs =
unlines
[ "snapshot validation OK"
, ""
, "checked:"
, " - valid JSON object"
, " - required top-level keys: version, sha, ref, job, detector, manifests, scanned"
, " - one or more manifests"
, " - manifest name and resolved object"
, " - resolved dependency closure"
, " - no dependency equals parent package_url"
, " - no duplicate dependency entries per package"
]
| otherwise =
unlines $
"snapshot validation FAILED:"
: map ((" - " <>) . Text.unpack) (getValidationErrors errs)
[ "snapshot validation FAILED"
, ""
, "checked:"
, " - valid JSON object"
, " - required top-level keys: version, sha, ref, job, detector, manifests, scanned"
, " - one or more manifests"
, " - manifest name and resolved object"
, " - resolved dependency closure"
, " - no dependency equals parent package_url"
, " - no duplicate dependency entries per package"
, ""
, "errors:"
]
<> map ((" - " <>) . Text.unpack) (getValidationErrors errs)

topLevelChecks :: KeyMap.KeyMap Value -> ValidationErrors
topLevelChecks o =
Expand Down