mozilla / frost

Unit testing framework for test driven security of AWS, GCP, Heroku and more.
https://mozilla.github.io/frost/
Mozilla Public License 2.0
104 stars 24 forks source link

Add initial GitHub integration #422

Open hwine opened 3 years ago

hwine commented 3 years ago

Propose a squash merge on this -- or I can reorder & clean up some for a real review.

This branch is already running in jenkins staging without issues. All changes (except as noted) are in the github/ directory, so do not impact other code.

Changes outside of github/ are:

hwine commented 3 years ago

I really think that some tests should be added, as there is a lot of code here. As well, there are a lot of TODO

So, this the tension between "land early incomplete, but not buggy" and "wait until it's perfect". The longer it live outside of the production branch, the more cruft may show up. We can discuss.

Also, what exactly is the github/github_schema.py file?

Ah, yes -- that is an autogenerated file by a tool in the graphQL library. Anytime we want to use a newer feature of the GitHub GraphQL API, we need to regenerate this file. That clearly needs some docs, but we don't want to regenerate it at packaging time, as we need a full test suite run.

To clarify the status of the code - it runs, and produces correct output which is stored for metrics usage. It does not yet consume the frost results and take actions. Think of it as the MVP, with more sprints to come.

We can discuss how we handle all this at the frost meetup

hwine commented 3 years ago

Also, what exactly is the github/github_schema.py file?

That clearly needs some docs, ...

Updated github/README.md in next commit