Merge pull request #6 from LuBingtan/dev

docs: Add probot docs.

pkg/probot/README.md

@@ -0,0 +1,20 @@
+<p align="center">
+  <a href="https://probot.github.io"><img src="docs/robot.svg" width="160" alt="Probot's logo, a cartoon robot" /></a>
+</p>
+
+<h1 align="center">Go-Probot</h1>
+
+> A framework for building GitHub Apps to automate and improve your workflow, in **Golang**.
+> 
+> Inspired by [Probot](https://github.com/probot/probot).
+
+## Example
+
+Please check the simplest [example](example/main.go).
+
+## Features
+
+- [x] Support building Github App
+- [ ] Simple dashboard
+- [ ] Support intergration with [Gitlab community edition](https://docs.gitlab.com/ee/install/)
+- [ ] Support intergration with [Gerrit](https://www.gerritcodereview.com/)

pkg/probot/app.go

@@ -37,6 +37,7 @@ type githubApp struct {
 	uploadURL      string
 	serverOpts     ServerOptions
 
+	dataMutex  sync.RWMutex
 	hmacToken  []byte
 	privateKey []byte
 	loggerOptions
@@ -53,6 +54,8 @@ func (app *githubApp) GetHTTPHandler() http.Handler {
 }
 
 func (app *githubApp) GetSecretToken() []byte {
+	app.dataMutex.RLock()
+	defer app.dataMutex.RUnlock()
 	return app.hmacToken
 }
 
@@ -103,6 +106,8 @@ func (app *githubApp) Run(ctx context.Context) error {
 func (app *githubApp) shutdown() {}
 
 func (app *githubApp) initialize() error {
+	app.dataMutex.Lock()
+	defer app.dataMutex.Unlock()
 	rawToken, err := os.ReadFile(app.hmacTokenFile)
 	if err != nil {
 		return fmt.Errorf("failed to read hmac token file, %w", err)

pkg/probot/example/example_suite_test.go

@@ -1,4 +1,4 @@
-package github_test
+package main
 
 import (
 	"encoding/json"

pkg/probot/example/example_test.go

@@ -1,4 +1,4 @@
-package github_test
+package main
 
 import (
 	"context"
@@ -47,7 +47,6 @@ var _ = Describe("Test Probot Example", func() {
 			Expect(app.Run(ctx)).Should(Succeed())
 		}()
 
-		time.Sleep(3 * time.Second)
 		Eventually(func(g Gomega) {
 			g.Expect(mock.Send(
 				app.(mock.AppMock[probot.GithubClient]),
@@ -62,6 +61,6 @@ var _ = Describe("Test Probot Example", func() {
 					Issue: &gh.Issue{Number: probot.ToPointer(1)},
 				},
 			)).Should(Succeed())
-		}, time.Second, 3*time.Second).Should(Succeed())
+		}, 5*time.Second, time.Second).Should(Succeed())
 	})
 })

pkg/probot/example/main.go

@@ -0,0 +1,46 @@
+package main
+
+import (
+	"context"
+
+	"github.com/google/go-github/v48/github"
+	"github.com/spf13/pflag"
+
+	"github.com/airconduct/kuilei/pkg/probot"
+	probotgh "github.com/airconduct/kuilei/pkg/probot/github"
+)
+
+func main() {
+	app := probot.NewGithubAPP()
+	app.AddFlags(pflag.CommandLine)
+	pflag.Parse()
+
+	// Add a handler for events "issue_comment.created"
+	app.On(probotgh.Event.IssueComment_created).WithHandler(probotgh.IssueCommentHandler(func(ctx probotgh.IssueCommentContext) {
+		payload := ctx.Payload()
+		ctx.Logger().Info("Get IssueComment event", "payload", payload)
+		owner := payload.Repo.Owner.GetLogin()
+		repo := payload.Repo.GetName()
+		issueNumber := *payload.Issue.Number
+		// If any error happen, the error message will be logged and sent as response
+		ctx.Must(ctx.Client().Issues.CreateComment(ctx, owner, repo, issueNumber, &github.IssueComment{
+			Body: github.String("Reply to this comment."),
+		}))
+	}))
+
+	// Add a handler for multiple events
+	app.On(
+		probotgh.Event.PullRequest_opened,      // pull_request.opened
+		probotgh.Event.PullRequest_edited,      // pull_request.edited
+		probotgh.Event.PullRequest_synchronize, // pull_request.synchronize
+		probotgh.Event.PullRequest_labeled,     // pull_request.labeled
+		probotgh.Event.PullRequest_assigned,    // pull_request.assigned
+	).WithHandler(probotgh.PullRequestHandler(func(ctx probotgh.PullRequestContext) {
+		payload := ctx.Payload()
+		ctx.Logger().Info("Do something", "action", payload.GetAction(), "PullRequest labels", payload.PullRequest.Labels)
+	}))
+
+	if err := app.Run(context.Background()); err != nil {
+		panic(err)
+	}
+}