gh_common.go

// Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements;
// and to You under the Apache License, Version 2.0.  See LICENSE in project root for full license + copyright.

package keynuker

import (
	"context"
	"fmt"
	"github.com/google/go-github/github"
	"golang.org/x/oauth2"
	"net/url"
)


// Wrap the github.RepositoryCommit and github.PushEventCommit into a single common interface
type WrappedCommit interface {
	Sha() string
	Url() string
}

type RepositoryCommit github.RepositoryCommit
type PushEventCommit github.PushEventCommit

func (r *RepositoryCommit) Sha() string {
	return *r.SHA
}

func (p *PushEventCommit) Sha() string {
	return *p.SHA
}

func (r *RepositoryCommit) Url() string {
	return *r.URL
}

func (p *PushEventCommit) Url() string {
	return *p.URL
}

func ConvertRepositoryCommits(repositoryCommits []*github.RepositoryCommit) []WrappedCommit {
	result := make([]WrappedCommit, len(repositoryCommits))
	for i, repositoryCommitPtr := range repositoryCommits {
		repositoryCommit := *repositoryCommitPtr
		resultCommit := RepositoryCommit(repositoryCommit)
		result[i] = &resultCommit
	}
	return result
}

func ConvertPushEventCommits(pushEventCommits []github.PushEventCommit) []WrappedCommit {
	result := make([]WrappedCommit, len(pushEventCommits))
	for i, pushEventCommit := range pushEventCommits {
		resultCommit := PushEventCommit(pushEventCommit)
		result[i] = &resultCommit
	}
	return result
}



type GithubClientWrapper struct {
	AccessToken string
	ApiClient   *github.Client
}

// The connection parameters requires to connect to the Github API on github.com or
// hosted on Github Enterprise.
type GithubConnectionParams struct {

	// The URL of the github API to connect to.  If blank, will connect to https://api.github.com.
	// Github Enterprise users will need to set this to point to their Github Enterprise server
	GithubApiUrl string

	// The github access token, which needs "read:org" permissions in order to read the concealed "non-public"
	// members of the orgs
	GithubAccessToken string
}

// If you want to use the default github API (as opposed to github enterprise), pass
// in an empty string for the githubApiBaseUrl
func NewGithubClientWrapper(accessToken, githubApiBaseUrl string) *GithubClientWrapper {

	ctx := context.Background()

	ts := oauth2.StaticTokenSource(
		&oauth2.Token{AccessToken: accessToken},
	)
	tc := oauth2.NewClient(ctx, ts)

	client := github.NewClient(tc)

	// If an alternative github API base url was given, use that
	if githubApiBaseUrl != "" {
		baseUrl, err := url.Parse(githubApiBaseUrl)
		if err != nil {
			panic(fmt.Sprintf("Invalid Github API url given: %v", githubApiBaseUrl))
		}
		client.BaseURL = baseUrl
	}

	return &GithubClientWrapper{
		AccessToken: accessToken,
		ApiClient:   client,
	}
}