Feature/invite after cherry pick pr created

cmd/ticommunitycherrypicker/github.go

@@ -0,0 +1,74 @@
+package main
+
+import (
+	"context"
+	"time"
+
+	gc "github.com/google/go-github/v29/github"
+	"golang.org/x/oauth2"
+	"k8s.io/test-infra/prow/github"
+
+	"github.com/ti-community-infra/tichi/internal/pkg/externalplugins/cherrypicker"
+)
+
+const (
+	timeoutForAddCollaborator = 5 * time.Second
+	timeoutForListInvitations = 5 * time.Second
+)
+
+type oauth2TokenSource func() []byte
+
+// Token implement interface oauth2.TokenSource.
+func (o oauth2TokenSource) Token() (*oauth2.Token, error) {
+	return &oauth2.Token{AccessToken: string(o())}, nil
+}
+
+func newExtGithubClient(client github.Client, tokenGenerator oauth2TokenSource) cherrypicker.GithubClient {
+	ctx := context.Background()
+
+	ts := oauth2.ReuseTokenSource(nil, tokenGenerator)
+	cc := gc.NewClient(oauth2.NewClient(ctx, ts))
+
+	return &extendGithubClient{
+		Client: client,
+		rs:     cc.Repositories,
+	}
+}
+
+type extendGithubClient struct {
+	github.Client
+	rs *gc.RepositoriesService
+}
+
+// AddCollaborator to repository.
+func (c *extendGithubClient) AddCollaborator(org, repo, user string, permission github.RepoPermissionLevel) error {
+	ctx, cancel := context.WithTimeout(context.TODO(), timeoutForAddCollaborator)
+	defer cancel()
+
+	options := &gc.RepositoryAddCollaboratorOptions{Permission: string(permission)}
+	_, _, err := c.rs.AddCollaborator(ctx, org, repo, user, options)
+	return err
+}
+
+// ListRepoInvitations list repository invitations.
+func (c *extendGithubClient) ListRepoInvitations(org, repo string) ([]*gc.RepositoryInvitation, error) {
+	ctx, cancel := context.WithTimeout(context.TODO(), timeoutForListInvitations)
+	defer cancel()
+
+	var invitations []*gc.RepositoryInvitation
+	for page, nextPage := 1, 1; nextPage > 0; page++ {
+		data, res, err := c.rs.ListInvitations(ctx, org, repo, &gc.ListOptions{PerPage: 100, Page: page})
+		if err != nil {
+			return nil, err
+		}
+
+		invitations = append(invitations, data...)
+		if res == nil {
+			nextPage = 0
+		} else {
+			nextPage = res.NextPage
+		}
+	}
+
+	return invitations, nil
+}

cmd/ticommunitycherrypicker/main.go

@@ -110,15 +110,16 @@ func main() {
 		log.WithError(err).Fatal("Error listing bot repositories.")
 	}
 
+	tokenGenerator := secretAgent.GetTokenGenerator(o.github.TokenPath)
 	server := &cherrypicker.Server{
 		WebhookSecretGenerator: secretAgent.GetTokenGenerator(o.webhookSecretFile),
-		GitHubTokenGenerator:   secretAgent.GetTokenGenerator(o.github.TokenPath),
+		GitHubTokenGenerator:   tokenGenerator,
 		BotUser:                botUser,
 		Email:                  email,
 		ConfigAgent:            epa,
 
 		GitClient:    git.ClientFactoryFrom(gitClient),
-		GitHubClient: githubClient,
+		GitHubClient: newExtGithubClient(githubClient, tokenGenerator),
 		Log:          log,
 
 		Bare:      &http.Client{},

cmd/ticommunitymerge/main.go

@@ -115,7 +115,6 @@ func main() {
 	helpProvider := merge.HelpProvider(epa)
 	externalplugins.ServeExternalPluginHelp(mux, log, helpProvider)
 	httpServer := &http.Server{Addr: ":" + strconv.Itoa(o.port), Handler: mux}
-
 	defer interrupts.WaitForGracefulShutdown()
 	interrupts.ListenAndServe(httpServer, 5*time.Second)
 }

docs/en/plugins/cherrypicker.md

@@ -12,6 +12,7 @@ This plugin is primarily responsible for cherry-picking code and creating PRs wi
 
 - `allow_all` set to true, all GitHub users can trigger `/cherry-pick some-branch`
 - `allow_all` set to false, only members of the repo's Org can trigger `/cherry-pick some-branch`
+- **only** members of the repo's Org can trigger `/cherry-pick-invite` on cherry-pick pull requests.
 
 ## Design
 

docs/plugins/cherrypicker.md

@@ -12,6 +12,7 @@ ti-community-cherrypicker 将帮助我们自动的 cherry-pick PR 的改动到
 
 - `allow_all` 配置为 true，所有 GitHub 用户都可以触发 `/cherry-pick some-branch`
 - `allow_all` 配置为 false，则只有该 repo 所在 Org 的成员可以触发 `/cherry-pick some-branch`
+- **只有** 该 repo 所在 Org 的成员可以在 cherry-pick PR 上触发 `/cherry-pick-invite`.
 
 ## 设计思路
 

go.mod

@@ -5,6 +5,7 @@ go 1.18
 require (
 	github.com/gin-gonic/gin v1.7.0
 	github.com/mroth/weightedrand v0.4.1
+	github.com/pkg/errors v0.9.1
 	github.com/shurcooL/githubv4 v0.0.0-20191102174205-af46314aec7b
 	github.com/shurcooL/graphql v0.0.0-20181231061246-d48a9a75455f
 	github.com/sirupsen/logrus v1.9.0
@@ -53,6 +54,7 @@ require (
 	github.com/gomodule/redigo v1.7.0 // indirect
 	github.com/google/btree v1.0.0 // indirect
 	github.com/google/go-cmp v0.5.2 // indirect
+	github.com/google/go-github/v29 v29.0.3
 	github.com/google/go-querystring v1.0.0 // indirect
 	github.com/google/gofuzz v1.2.1-0.20210504230335-f78f29fc09ea // indirect
 	github.com/google/pprof v0.0.0-20200905233945-acf8798be1f7 // indirect
@@ -76,7 +78,6 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.1 // indirect
 	github.com/peterbourgon/diskv v2.0.1+incompatible // indirect
-	github.com/pkg/errors v0.9.1 // indirect
 	github.com/prometheus/client_golang v1.7.1 // indirect
 	github.com/prometheus/client_model v0.2.0 // indirect
 	github.com/prometheus/common v0.10.0 // indirect
@@ -93,7 +94,7 @@ require (
 	golang.org/x/lint v0.0.0-20200302205851-738671d3881b // indirect
 	golang.org/x/mod v0.3.0 // indirect
 	golang.org/x/net v0.0.0-20201110031124-69a78807bb2b // indirect
-	golang.org/x/oauth2 v0.0.0-20200902213428-5d25da1a8d43 // indirect
+	golang.org/x/oauth2 v0.0.0-20200902213428-5d25da1a8d43
 	golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9 // indirect
 	golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
 	golang.org/x/text v0.3.6 // indirect

go.sum

@@ -617,6 +617,7 @@ github.com/google/go-containerregistry v0.1.1/go.mod h1:npTSyywOeILcgWqd+rvtzGWf
 github.com/google/go-github v17.0.0+incompatible/go.mod h1:zLgOLi98H3fifZn+44m+umXrS52loVEgC2AApnigrVQ=
 github.com/google/go-github/v27 v27.0.6/go.mod h1:/0Gr8pJ55COkmv+S/yPKCczSkUPIM/LnFyubufRNIS0=
 github.com/google/go-github/v28 v28.1.1/go.mod h1:bsqJWQX05omyWVmc00nEUql9mhQyv38lDZ8kPZcQVoM=
+github.com/google/go-github/v29 v29.0.3 h1:IktKCTwU//aFHnpA+2SLIi7Oo9uhAzgsdZNbcAqhgdc=
 github.com/google/go-github/v29 v29.0.3/go.mod h1:CHKiKKPHJ0REzfwc14QMklvtHwCveD0PxlMjLlzAM5E=
 github.com/google/go-licenses v0.0.0-20191112164736-212ea350c932/go.mod h1:16wa6pRqNDUIhOtwF0GcROVqMeXHZJ7H6eGDFUh5Pfk=
 github.com/google/go-licenses v0.0.0-20200227160636-0fa8c766a591/go.mod h1:JWeTIGPLQ9gF618ZOdlUitd1gRR/l99WOkHOlmR/UVA=

internal/pkg/externalplugins/cherrypicker/cherrypicker.go

@@ -34,9 +34,8 @@ import (
 	"sync"
 	"time"
 
+	gc "github.com/google/go-github/v29/github"
 	"github.com/sirupsen/logrus"
-	tiexternalplugins "github.com/ti-community-infra/tichi/internal/pkg/externalplugins"
-	"github.com/ti-community-infra/tichi/internal/pkg/externalplugins/utils"
 	utilerrors "k8s.io/apimachinery/pkg/util/errors"
 	"k8s.io/apimachinery/pkg/util/sets"
 	"k8s.io/test-infra/prow/config"
@@ -46,19 +45,35 @@ import (
 	"k8s.io/test-infra/prow/pluginhelp/externalplugins"
 	"k8s.io/test-infra/prow/plugins"
 	"k8s.io/utils/exec"
+
+	tiexternalplugins "github.com/ti-community-infra/tichi/internal/pkg/externalplugins"
+	"github.com/ti-community-infra/tichi/internal/pkg/externalplugins/utils"
 )
 
-const PluginName = "ti-community-cherrypicker"
+const (
+	PluginName = "ti-community-cherrypicker"
+
+	pluginDescription = `The cherrypicker plugin is used for cherry-pick PRs across branches.
+For every successful cherry-pick invocation a new PR is opened against the target branch and assigned to the requestor.
+The plugin will send an repo collaborator invitation if the requestor is not a collaborator.
+`
+
+	upstreamRemoteName           = "upstream"
+	collaboratorPermission       = "push"
+	cherryPickInviteExample      = "/cherry-pick-invite"
+	cherryPickBranchFmt          = "cherry-pick-%d-to-%s"
+	cherryPickTipFmt             = "This is an automated cherry-pick of #%d"
+	cherryPickInviteNotifyMsgTpl = `@%s Please accept the invitation then you can push to the cherry-pick pull requests. 
+	Comment with "%s" if the invitation is expired.
+	%s`
+)
 
 var (
-	cherryPickRe        = regexp.MustCompile(`(?m)^(?:/cherrypick|/cherry-pick)\s+(.+)$`)
-	cherryPickBranchFmt = "cherry-pick-%d-to-%s"
-	cherryPickTipFmt    = "This is an automated cherry-pick of #%d"
+	cherryPickRe       = regexp.MustCompile(`(?m)^(?:/cherrypick|/cherry-pick)\s+(.+)$`)
+	cherryPickInviteRe = regexp.MustCompile(`(?m)^(?:/cherrypick|/cherry-pick)-invite\b`)
 )
 
-const upstreamRemoteName = "upstream"
-
-type githubClient interface {
+type GithubClient interface {
 	AddLabels(org, repo string, number int, labels ...string) error
 	AssignIssue(org, repo string, number int, logins []string) error
 	CreateComment(org, repo string, number int, comment string) error
@@ -75,6 +90,10 @@ type githubClient interface {
 	ListIssueComments(org, repo string, number int) ([]github.IssueComment, error)
 	GetIssueLabels(org, repo string, number int) ([]github.Label, error)
 	ListOrgMembers(org, role string) ([]github.TeamMember, error)
+	ListRepoInvitations(org, repo string) ([]*gc.RepositoryInvitation, error)
+	IsCollaborator(org, repo, user string) (bool, error)
+	// AddCollaborator invite collaborator to repo with permission(pull, triage, push, maintain, admin)
+	AddCollaborator(org, repo, user string, permission github.RepoPermissionLevel) error
 }
 
 // HelpProvider constructs the PluginHelp for this plugin that takes into account enabled repositories.
@@ -135,12 +154,10 @@ func HelpProvider(epa *tiexternalplugins.ConfigAgent) externalplugins.ExternalPl
 		}
 
 		pluginHelp := &pluginhelp.PluginHelp{
-			Description: "The cherrypicker plugin is used for cherry-pick PRs across branches. " +
-				"For every successful cherry-pick invocation a new PR is opened " +
-				"against the target branch and assigned to the requestor. ",
-			Config:  configInfo,
-			Snippet: yamlSnippet,
-			Events:  []string{tiexternalplugins.PullRequestEvent, tiexternalplugins.IssueCommentEvent},
+			Description: pluginDescription,
+			Config:      configInfo,
+			Snippet:     yamlSnippet,
+			Events:      []string{tiexternalplugins.PullRequestEvent, tiexternalplugins.IssueCommentEvent},
 		}
 
 		pluginHelp.AddCommand(pluginhelp.Command{
@@ -152,6 +169,14 @@ func HelpProvider(epa *tiexternalplugins.ConfigAgent) externalplugins.ExternalPl
 			WhoCanUse: "Members of the trusted organization for the repo or anyone(depends on the AllowAll configuration).",
 			Examples:  []string{"/cherrypick release-3.9", "/cherry-pick release-1.15"},
 		})
+		pluginHelp.AddCommand(pluginhelp.Command{
+			Usage: cherryPickInviteExample,
+			Description: "Request a collaborator invitation" +
+				"This command works in cherry-pick pull requests.",
+			Featured:  true,
+			WhoCanUse: "Members of the trusted organization for the repo.",
+			Examples:  []string{cherryPickInviteExample},
+		})
 
 		return pluginHelp, nil
 	}
@@ -168,7 +193,7 @@ type Server struct {
 	GitClient git.ClientFactory
 	// Used for unit testing
 	Push         func(forkName, newBranch string, force bool) error
-	GitHubClient githubClient
+	GitHubClient GithubClient
 	Log          *logrus.Entry
 	ConfigAgent  *tiexternalplugins.ConfigAgent
 
@@ -215,7 +240,7 @@ func (s *Server) handleEvent(eventType, eventGUID string, payload []byte) error
 			return err
 		}
 		go func() {
-			if err := s.handleIssueComment(l, ic); err != nil {
+			if err := s.handleIssueComment(l, &ic); err != nil {
 				s.Log.WithError(err).WithFields(l.Data).Info("Cherry-pick failed.")
 			}
 		}()
@@ -225,7 +250,7 @@ func (s *Server) handleEvent(eventType, eventGUID string, payload []byte) error
 			return err
 		}
 		go func() {
-			if err := s.handlePullRequest(l, pr); err != nil {
+			if err := s.handlePullRequest(l, &pr); err != nil {
 				s.Log.WithError(err).WithFields(l.Data).Info("Cherry-pick failed.")
 			}
 		}()
@@ -235,12 +260,20 @@ func (s *Server) handleEvent(eventType, eventGUID string, payload []byte) error
 	return nil
 }
 
-func (s *Server) handleIssueComment(l *logrus.Entry, ic github.IssueCommentEvent) error {
+func (s *Server) handleIssueComment(l *logrus.Entry, ic *github.IssueCommentEvent) error {
 	// Only consider new comments in PRs.
 	if !ic.Issue.IsPullRequest() || ic.Action != github.IssueCommentActionCreated {
 		return nil
 	}
 
+	if cherryPickInviteRe.MatchString(ic.Comment.Body) {
+		return s.inviteCollaborator(ic)
+	}
+
+	return s.handleIssueCherryPickComment(l, ic)
+}
+
+func (s *Server) handleIssueCherryPickComment(l *logrus.Entry, ic *github.IssueCommentEvent) error {
 	org := ic.Repo.Owner.Login
 	repo := ic.Repo.Name
 	num := ic.Issue.Number
@@ -338,7 +371,7 @@ func (s *Server) handleIssueComment(l *logrus.Entry, ic github.IssueCommentEvent
 	return nil
 }
 
-func (s *Server) handlePullRequest(log *logrus.Entry, pre github.PullRequestEvent) error {
+func (s *Server) handlePullRequest(log *logrus.Entry, pre *github.PullRequestEvent) error {
 	// Only consider merged PRs.
 	pr := pre.PullRequest
 	if !pr.Merged || pr.MergeSHA == nil {
@@ -472,8 +505,9 @@ func (s *Server) handlePullRequest(log *logrus.Entry, pre github.PullRequestEven
 	return utilerrors.NewAggregate(errs)
 }
 
-//nolint:gocyclo
 // TODO: refactoring to reduce complexity.
+//
+//nolint:gocyclo
 func (s *Server) handle(logger *logrus.Entry, requestor string,
 	comment *github.IssueComment, org, repo, targetBranch string, pr *github.PullRequest) error {
 	num := pr.Number
@@ -708,6 +742,7 @@ func (s *Server) handle(logger *logrus.Entry, requestor string,
 	return nil
 }
 
+// TODO(wuhuizuo): reduce param count
 func (s *Server) createComment(l *logrus.Entry, org, repo string,
 	num int, comment *github.IssueComment, resp string) error {
 	if err := func() error {
@@ -724,6 +759,7 @@ func (s *Server) createComment(l *logrus.Entry, org, repo string,
 }
 
 // createIssue creates an issue on GitHub.
+// TODO(wuhuizuo): reduce param count
 func (s *Server) createIssue(l *logrus.Entry, org, repo, title, body string, num int,
 	comment *github.IssueComment, labels, assignees []string) error {
 	issueNum, err := s.GitHubClient.CreateIssue(org, repo, title, body, 0, labels, assignees)
@@ -777,7 +813,7 @@ func normalize(input string) string {
 }
 
 // createCherryPickCommitMessage creates the commit message for the cherry-pick commit.
-func createCherryPickCommitMessage(gc githubClient, log *logrus.Entry, copyIssueNumbers bool,
+func createCherryPickCommitMessage(gc GithubClient, log *logrus.Entry, copyIssueNumbers bool,
 	org, repo string, num int, mergeSHA *string) string {
 	cherryPickCommitMessage := fmt.Sprintf(cherryPickTipFmt, num)