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.

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

Jump to bottom

Allow output in json format #13

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

Allow output in json format #13

Show file tree
Hide file tree
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
198 changes: 153 additions & 45 deletions audit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package main

import (
"context"
"encoding/json"
"flag"
"fmt"
"net/http"
Expand All @@ -26,13 +27,105 @@ func (cmd *auditCommand) Run(ctx context.Context, args []string) error {
return runCommand(ctx, handleAudit)
}

type outCollaborator struct {
Login string `json:"login"`
Teams []string `json:"teams"`
}

type outCollaborators struct {
TotalCount int `json:"totalCount"`
Admin []outCollaborator `json:"admin"`
Write []outCollaborator `json:"write"`
Read []outCollaborator `json:"read"`
}

type outDeployKey struct {
Title string `json:"title"`
ReadOnly bool `json:"readOnly"`
URL string `json:"url"`
}

type outHook struct {
Name string `json:"name"`
Active bool `json:"active"`
URL string `json:"url"`
}

type output struct {
Name string `json:"name"`
Collaborators outCollaborators `json:"collaborators"`
DeployKeys []outDeployKey `json:"deployKeys"`
Hooks []outHook `json:"hooks"`
ProtectedBranches []string `json:"protectedBranches"`
UnprotectedBranches []string `json:"unprotectedBranches"`
MergeMethods []string `json:"mergeMethods"`
}

func outputJSON(o output) {
b, err := json.Marshal(o)
if err == nil {
fmt.Printf("%s\n", b)
}
}

func outputText(o output) {
output := fmt.Sprintf("%s -> \n", o.Name)

if o.Collaborators.TotalCount > 1 {
push := []string{}
pull := []string{}
admin := []string{}
for _, c := range o.Collaborators.Admin {
admin = append(admin, fmt.Sprintf("\t\t\t%s (teams: %s)", c.Login, strings.Join(c.Teams, ", ")))
}
for _, c := range o.Collaborators.Write {
push = append(push, fmt.Sprintf("\t\t\t%s", c.Login))
}
for _, c := range o.Collaborators.Read {
pull = append(pull, fmt.Sprintf("\t\t\t%s", c.Login))
}
output += fmt.Sprintf("\tCollaborators (%d):\n", o.Collaborators.TotalCount)
output += fmt.Sprintf("\t\tAdmin (%d):\n%s\n", len(admin), strings.Join(admin, "\n"))
output += fmt.Sprintf("\t\tWrite (%d):\n%s\n", len(push), strings.Join(push, "\n"))
output += fmt.Sprintf("\t\tRead (%d):\n%s\n", len(pull), strings.Join(pull, "\n"))
}

if len(o.DeployKeys) > 0 {
kstr := []string{}
for _, k := range o.DeployKeys {
kstr = append(kstr, fmt.Sprintf("\t\t%s - ro:%t (%s)", k.Title, k.ReadOnly, k.URL))
}
output += fmt.Sprintf("\tKeys (%d):\n%s\n", len(kstr), strings.Join(kstr, "\n"))
}

if len(o.Hooks) > 0 {
hstr := []string{}
for _, h := range o.Hooks {
hstr = append(hstr, fmt.Sprintf("\t\t%s - active:%t (%s)", h.Name, h.Active, h.URL))
}
output += fmt.Sprintf("\tHooks (%d):\n%s\n", len(hstr), strings.Join(hstr, "\n"))
}

if len(o.ProtectedBranches) > 0 {
output += fmt.Sprintf("\tProtected Branches (%d): %s\n", len(o.ProtectedBranches), strings.Join(o.ProtectedBranches, ", "))
}

if len(o.UnprotectedBranches) > 0 {
output += fmt.Sprintf("\tUnprotected Branches (%d): %s\n", len(o.UnprotectedBranches), strings.Join(o.UnprotectedBranches, ", "))
}

output += fmt.Sprintf("\tMerge Methods: %s\n", strings.Join(o.MergeMethods, " "))

fmt.Printf("%s--\n\n", output)
}

// handleAudit will return nil error if the user does not have access to something.
func handleAudit(ctx context.Context, client *github.Client, repo *github.Repository) error {
opt := &github.ListOptions{
PerPage: 100,
}

teams, resp, err := client.Repositories.ListTeams(ctx, repo.GetOwner().GetLogin(), repo.GetName(), opt)
ghteams, resp, err := client.Repositories.ListTeams(ctx, repo.GetOwner().GetLogin(), repo.GetName(), opt)
if resp.StatusCode == http.StatusNotFound || resp.StatusCode == http.StatusForbidden || err != nil {
if _, ok := err.(*github.RateLimitError); ok {
return err
Expand All @@ -44,7 +137,7 @@ func handleAudit(ctx context.Context, client *github.Client, repo *github.Reposi
return err
}

collabs, resp, err := client.Repositories.ListCollaborators(ctx, repo.GetOwner().GetLogin(), repo.GetName(), &github.ListCollaboratorsOptions{ListOptions: *opt})
ghcollabs, resp, err := client.Repositories.ListCollaborators(ctx, repo.GetOwner().GetLogin(), repo.GetName(), &github.ListCollaboratorsOptions{ListOptions: *opt})
if resp.StatusCode == http.StatusNotFound || resp.StatusCode == http.StatusForbidden || err != nil {
if _, ok := err.(*github.RateLimitError); ok {
return err
Expand All @@ -56,7 +149,7 @@ func handleAudit(ctx context.Context, client *github.Client, repo *github.Reposi
return err
}

keys, resp, err := client.Repositories.ListKeys(ctx, repo.GetOwner().GetLogin(), repo.GetName(), opt)
ghkeys, resp, err := client.Repositories.ListKeys(ctx, repo.GetOwner().GetLogin(), repo.GetName(), opt)
if resp.StatusCode == http.StatusNotFound || resp.StatusCode == http.StatusForbidden || err != nil {
if _, ok := err.(*github.RateLimitError); ok {
return err
Expand All @@ -68,7 +161,7 @@ func handleAudit(ctx context.Context, client *github.Client, repo *github.Reposi
return err
}

hooks, resp, err := client.Repositories.ListHooks(ctx, repo.GetOwner().GetLogin(), repo.GetName(), opt)
ghhooks, resp, err := client.Repositories.ListHooks(ctx, repo.GetOwner().GetLogin(), repo.GetName(), opt)
if resp.StatusCode == http.StatusNotFound || resp.StatusCode == http.StatusForbidden || err != nil {
if _, ok := err.(*github.RateLimitError); ok {
return err
Expand All @@ -80,13 +173,13 @@ func handleAudit(ctx context.Context, client *github.Client, repo *github.Reposi
return err
}

branches, _, err := client.Repositories.ListBranches(ctx, repo.GetOwner().GetLogin(), repo.GetName(), opt)
ghbranches, _, err := client.Repositories.ListBranches(ctx, repo.GetOwner().GetLogin(), repo.GetName(), opt)
if err != nil {
return err
}
protectedBranches := []string{}
unprotectedBranches := []string{}
for _, branch := range branches {
for _, branch := range ghbranches {
// we must get the individual branch for the branch protection to work
b, _, err := client.Repositories.GetBranch(ctx, repo.GetOwner().GetLogin(), repo.GetName(), branch.GetName())
if err != nil {
Expand All @@ -100,19 +193,18 @@ func handleAudit(ctx context.Context, client *github.Client, repo *github.Reposi
}

// only print whole status if we have more that one collaborator
if len(collabs) <= 1 && len(keys) < 1 && len(hooks) < 1 && len(protectedBranches) < 1 && len(unprotectedBranches) < 1 {
if len(ghcollabs) <= 1 && len(ghkeys) < 1 && len(ghhooks) < 1 && len(protectedBranches) < 1 && len(unprotectedBranches) < 1 {
return nil
}

output := fmt.Sprintf("%s -> \n", repo.GetFullName())
push := []outCollaborator{}
pull := []outCollaborator{}
admin := []outCollaborator{}

if len(collabs) > 1 {
push := []string{}
pull := []string{}
admin := []string{}
for _, c := range collabs {
if len(ghcollabs) > 1 {
for _, c := range ghcollabs {
userTeams := []github.Team{}
for _, t := range teams {
for _, t := range ghteams {
isMember, resp, err := client.Teams.GetTeamMembership(ctx, t.GetID(), c.GetLogin())
if resp.StatusCode != http.StatusNotFound && resp.StatusCode != http.StatusForbidden && err == nil && isMember.GetState() == "active" {
userTeams = append(userTeams, *t)
Expand All @@ -129,61 +221,77 @@ func handleAudit(ctx context.Context, client *github.Client, repo *github.Reposi
permTeams = append(permTeams, t.GetName())
}
}
admin = append(admin, fmt.Sprintf("\t\t\t%s (teams: %s)", c.GetLogin(), strings.Join(permTeams, ", ")))
admin = append(admin, outCollaborator{c.GetLogin(), permTeams})
case perms["push"]:
push = append(push, fmt.Sprintf("\t\t\t%s", c.GetLogin()))
permTeams := []string{}
for _, t := range userTeams {
if t.GetPermission() == "push" {
permTeams = append(permTeams, t.GetName())
}
}
push = append(push, outCollaborator{c.GetLogin(), permTeams})
case perms["pull"]:
pull = append(pull, fmt.Sprintf("\t\t\t%s", c.GetLogin()))
permTeams := []string{}
for _, t := range userTeams {
if t.GetPermission() == "pull" {
permTeams = append(permTeams, t.GetName())
}
}
pull = append(pull, outCollaborator{c.GetLogin(), permTeams})
}
}
output += fmt.Sprintf("\tCollaborators (%d):\n", len(collabs))
output += fmt.Sprintf("\t\tAdmin (%d):\n%s\n", len(admin), strings.Join(admin, "\n"))
output += fmt.Sprintf("\t\tWrite (%d):\n%s\n", len(push), strings.Join(push, "\n"))
output += fmt.Sprintf("\t\tRead (%d):\n%s\n", len(pull), strings.Join(pull, "\n"))
}

if len(keys) > 0 {
kstr := []string{}
for _, k := range keys {
kstr = append(kstr, fmt.Sprintf("\t\t%s - ro:%t (%s)", k.GetTitle(), k.GetReadOnly(), k.GetURL()))
keys := []outDeployKey{}
if len(ghkeys) > 0 {
for _, k := range ghkeys {
keys = append(keys, outDeployKey{k.GetTitle(), k.GetReadOnly(), k.GetURL()})
}
output += fmt.Sprintf("\tKeys (%d):\n%s\n", len(kstr), strings.Join(kstr, "\n"))
}

if len(hooks) > 0 {
hstr := []string{}
for _, h := range hooks {
hstr = append(hstr, fmt.Sprintf("\t\t%s - active:%t (%s)", h.GetName(), h.GetActive(), h.GetURL()))
hooks := []outHook{}
if len(ghhooks) > 0 {
for _, h := range ghhooks {
hooks = append(hooks, outHook{h.GetName(), h.GetActive(), h.GetURL()})
}
output += fmt.Sprintf("\tHooks (%d):\n%s\n", len(hstr), strings.Join(hstr, "\n"))
}

if len(protectedBranches) > 0 {
output += fmt.Sprintf("\tProtected Branches (%d): %s\n", len(protectedBranches), strings.Join(protectedBranches, ", "))
}

if len(unprotectedBranches) > 0 {
output += fmt.Sprintf("\tUnprotected Branches (%d): %s\n", len(unprotectedBranches), strings.Join(unprotectedBranches, ", "))
}

repo, _, err = client.Repositories.Get(ctx, repo.GetOwner().GetLogin(), repo.GetName())
if err != nil {
return err
}

mergeMethods := "\tMerge Methods:"
mergeMethods := []string{}
if repo.GetAllowMergeCommit() {
mergeMethods += " mergeCommit"
mergeMethods = append(mergeMethods, "mergeCommit")
}
if repo.GetAllowSquashMerge() {
mergeMethods += " squash"
mergeMethods = append(mergeMethods, "squash")
}
if repo.GetAllowRebaseMerge() {
mergeMethods += " rebase"
mergeMethods = append(mergeMethods, "rebase")
}
output += mergeMethods + "\n"

fmt.Printf("%s--\n\n", output)
o := output{
repo.GetFullName(),
outCollaborators{
len(ghcollabs),
admin,
push,
pull,
},
keys,
hooks,
protectedBranches,
unprotectedBranches,
mergeMethods,
}

if jsonout {
outputJSON(o)
} else {
outputText(o)
}

return nil
}
3 changes: 3 additions & 0 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ var (
singleRepo string
nouser bool
dryrun bool
jsonout bool

debug bool
)
Expand Down Expand Up @@ -77,6 +78,8 @@ func main() {
p.FlagSet.BoolVar(&nouser, "nouser", false, "do not include your user")
p.FlagSet.BoolVar(&dryrun, "dry-run", false, "do not change settings just print the changes that would occur")

p.FlagSet.BoolVar(&jsonout, "json", false, "output as json")

p.FlagSet.BoolVar(&debug, "d", false, "enable debug logging")
p.FlagSet.BoolVar(&debug, "debug", false, "enable debug logging")

Expand Down