Code-dot-mil / code.mil

An experiment in open source at the Department of Defense.
https://www.code.mil
MIT License
1.29k stars 127 forks source link

Project Validation #186

Open arichiv-usds opened 6 years ago

arichiv-usds commented 6 years ago

We should validate the JSON before pushing any changes that could break or improperly update project info.

jgarber623-gov commented 6 years ago

Possibly useful links:

arichiv-usds commented 6 years ago

Nice

jordangov commented 6 years ago

Yeah... FYI, I've talked to Alvand and they'd like to get the schema validation into the API, but it is not there right now. We may want to wait for that versus doing this.

arichiv-usds commented 6 years ago

Maybe I could add that :-)

arichiv commented 6 years ago

https://github.com/GSA/code-gov-web/issues/564

DanielJDufour commented 5 years ago

FYI: We've updated our validator, which you can find here: https://code.gov/about/compliance/inventory-code/validate-schema

It's built with json-schema-validator-web-component a reusable web component! :-)

seakintruth commented 5 years ago

Similar to the Code.json Validator it would be helpful to report broken URL links in the Code.json file.

I put together a google sheets prototype of sorts here: https://docs.google.com/spreadsheets/d/13tzylBYFAISHDaN9QOgL-qIj4we0V7X_Jz_pyzKYrxU/edit?usp=sharing

It publishes a daily report to here: https://docs.google.com/spreadsheets/d/e/2PACX-1vQm1kqCv30grzurClLrYTGb3P-itY07Cbl70Hu-7UBEIAKAiz3s8v1y-VFAp4vLqaH3qQ2FVilRSFHb/pubhtml

This tool attempts to daily import each agency's code.json file as described by the code.gov site and verify pertinent URLs for each agency's code.json file. These verifications are displayed on the UrlStatus worksheet. This report displays the HTTPS response codes when >=300 from a call to Google App Script UrlFetch() for each URL.

It works as is, but only validates files that are found from the existing agencies code.json files.

jordangov commented 5 years ago

Neat! Have you also posted that to the Code.gov repo?

seakintruth commented 5 years ago

I just posted this as a comment to Code.gov Administration Tool for Agency Inventory Upload and Maintenance #29

jalbertbowden commented 5 years ago

Curious why Project Validation is only JSON validation? I'm sure it'll fail if JSON doesn't validate, but wondering the emphasis behind this? W3C has a linkrot validator, amongst their other validators, that you could use here too: https://validator.w3.org/checklink

jordangov commented 5 years ago

Happy to include that as well...

afomi commented 4 years ago

Is there more work to be done for this issue?

It looks like JSON is being validated. If there's more to be validated, perhaps it can be clarified in a new issue.

jordangov commented 4 years ago

The format of the JSON is validated, but not the structure that Code.gov really wants, or the content of the information (like that URLs really are URLs, or that there is a POC).