ComplianceAsCode / auditree-arboretum

The Auditree common fetchers, checks and harvest reports library.
https://auditree.github.io/
Apache License 2.0
17 stars 10 forks source link

Add Github organization collaborators fetcher #38

Closed mlomena closed 3 years ago

mlomena commented 4 years ago

What

Adds fetcher to retrieve collaborators of repositories in a Github organization

Why

Provide the business justification for the work included in the pull request.

How

Context

drsm79 commented 4 years ago

I think this should be under a GitHub provider. The auditree fetchers/checks are verifying the correct configuration of the tool, which this isn’t really related to.

alfinkel commented 4 years ago

@drsm79 I understand the logic behind your comment about this going under a Github provider folder and if this were just a fetcher thing then I think it could make sense. However, I think that any checks written against this sort of evidence could possibly be applied to Bitbucket and GitLab repo hosting services too. Ideally this would go under some provider and within that provider we'd have fetchers in github, bitbucket, and gitlab subfolders and checks in their checks folder. I figured that since the auditree provider is already structured that way for repo integrity f/c's we could continue to put things in there. But I see your point. I suppose we could come up with another generic "provider" to put this under and then follow the same pattern as we have for repo integrity. What do you think about repo_host_service or repo_host or rhs as the provider?

alfinkel commented 4 years ago

@mlomena is there a check in the works?

alfinkel commented 4 years ago

re: fetcher location - I've added a "permissions" vendor in PR #39 and this github fetcher should live under there. Can you move all of the content in this PR to the appropriate sub-folders under the "permissions" vendor?

alfinkel commented 4 years ago

The "auditree" vendor will stay as is. The fetcher in this PR should go under the "permissions" vendor under "fetchers" and the "github" technology. So following the pattern in the auditree vendor structure: arboretum/permissions/fetchers/github.

alfinkel commented 4 years ago

I believe we're waiting on unit tests for the evidence code: See: https://github.com/ComplianceAsCode/auditree-arboretum/pull/38#pullrequestreview-521848231 - specifically:

... Also, for your evidence we would need unit tests included as well.

mlomena commented 3 years ago

@alfinkel Sorry for the long delay. I am now back from a long absence. I have moved the stuff in this PR to permissions and have added unit tests.

alfinkel commented 3 years ago

Can you squash commits down to one signed commit?