feat: add matrix subcommand + move bot to check

contribs/github-bot/bot.go → contribs/github-bot/check.go

@@ -12,12 +12,31 @@ import (
 	"github.com/gnolang/gno/contribs/github-bot/internal/logger"
 	p "github.com/gnolang/gno/contribs/github-bot/internal/params"
 	"github.com/gnolang/gno/contribs/github-bot/internal/utils"
+	"github.com/gnolang/gno/tm2/pkg/commands"
 	"github.com/google/go-github/v64/github"
 	"github.com/sethvargo/go-githubactions"
 	"github.com/xlab/treeprint"
 )
 
-func execBot(params *p.Params) error {
+func newCheckCmd() *commands.Command {
+	params := &p.Params{}
+
+	return commands.NewCommand(
+		commands.Metadata{
+			Name:       "check",
+			ShortUsage: "github-bot check [flags]",
+			ShortHelp:  "checks requirements for a pull request to be merged",
+			LongHelp:   "This tool checks if the requirements for a pull request to be merged are satisfied (defined in config.go) and displays PR status checks accordingly.\nA valid GitHub Token must be provided by setting the GITHUB_TOKEN environment variable.",
+		},
+		params,
+		func(_ context.Context, _ []string) error {
+			params.ValidateFlags()
+			return execCheck(params)
+		},
+	)
+}
+
+func execCheck(params *p.Params) error {
 	// Create context with timeout if specified in the parameters.
 	ctx := context.Background()
 	if params.Timeout > 0 {
@@ -51,27 +70,9 @@ func execBot(params *p.Params) error {
 
 	// If requested, retrieve all open pull requests.
 	if params.PRAll {
-		opts := &github.PullRequestListOptions{
-			State:     "open",
-			Sort:      "updated",
-			Direction: "desc",
-			ListOptions: github.ListOptions{
-				PerPage: client.PageSize,
-			},
-		}
-
-		for {
-			prsPage, response, err := gh.Client.PullRequests.List(gh.Ctx, gh.Owner, gh.Repo, opts)
-			if err != nil {
-				return fmt.Errorf("unable to retrieve all open pull requests: %w", err)
-			}
-
-			prs = append(prs, prsPage...)
-
-			if response.NextPage == 0 {
-				break
-			}
-			opts.Page = response.NextPage
+		prs, err = gh.ListPR(utils.PRStateOpen)
+		if err != nil {
+			return fmt.Errorf("unable to list all PR: %w", err)
 		}
 	} else {
 		// Otherwise, retrieve only specified pull request(s)
@@ -86,6 +87,10 @@ func execBot(params *p.Params) error {
 		}
 	}
 
+	return processPRList(gh, prs)
+}
+
+func processPRList(gh *client.GitHub, prs []*github.PullRequest) error {
 	if len(prs) > 1 {
 		prNums := make([]int, len(prs))
 		for i, pr := range prs {

contribs/github-bot/comment.go

@@ -9,6 +9,7 @@ import (
 	"text/template"
 
 	"github.com/gnolang/gno/contribs/github-bot/internal/client"
+	"github.com/gnolang/gno/contribs/github-bot/internal/utils"
 
 	"github.com/google/go-github/v64/github"
 	"github.com/sethvargo/go-githubactions"
@@ -71,23 +72,6 @@ func getCommentManualChecks(commentBody string) map[string]manualCheckDetails {
 	return checks
 }
 
-// Recursively search for nested values using the keys provided.
-func indexMap(m map[string]any, keys ...string) any {
-	if len(keys) == 0 {
-		return m
-	}
-
-	if val, ok := m[keys[0]]; ok {
-		if keys = keys[1:]; len(keys) == 0 {
-			return val
-		}
-		subMap, _ := val.(map[string]any)
-		return indexMap(subMap, keys...)
-	}
-
-	return nil
-}
-
 // handleCommentUpdate checks if:
 //   - the current run was triggered by GitHub Actions
 //   - the triggering event is an edit of the bot comment
@@ -96,7 +80,7 @@ func indexMap(m map[string]any, keys ...string) any {
 //   - the actor / comment editor has permission to modify this checkbox (or restore it)
 func handleCommentUpdate(gh *client.GitHub, actionCtx *githubactions.GitHubContext) error {
 	// Ignore if it's not a comment related event.
-	if actionCtx.EventName != "issue_comment" {
+	if actionCtx.EventName != utils.EventIssueComment {
 		gh.Logger.Debugf("Event is not issue comment related (%s)", actionCtx.EventName)
 		return nil
 	}
@@ -123,7 +107,7 @@ func handleCommentUpdate(gh *client.GitHub, actionCtx *githubactions.GitHubConte
 	}
 
 	// Get login of the author of the edited comment.
-	login, ok := indexMap(actionCtx.Event, "comment", "user", "login").(string)
+	login, ok := utils.IndexMap(actionCtx.Event, "comment", "user", "login").(string)
 	if !ok {
 		return errors.New("unable to get comment user login on issue comment event")
 	}
@@ -134,19 +118,19 @@ func handleCommentUpdate(gh *client.GitHub, actionCtx *githubactions.GitHubConte
 	}
 
 	// Get comment updated body.
-	current, ok := indexMap(actionCtx.Event, "comment", "body").(string)
+	current, ok := utils.IndexMap(actionCtx.Event, "comment", "body").(string)
 	if !ok {
 		return errors.New("unable to get comment body on issue comment event")
 	}
 
 	// Get comment previous body.
-	previous, ok := indexMap(actionCtx.Event, "changes", "body", "from").(string)
+	previous, ok := utils.IndexMap(actionCtx.Event, "changes", "body", "from").(string)
 	if !ok {
 		return errors.New("unable to get changes body content on issue comment event")
 	}
 
 	// Get PR number from GitHub Actions context.
-	prNum, ok := indexMap(actionCtx.Event, "issue", "number").(float64)
+	prNum, ok := utils.IndexMap(actionCtx.Event, "issue", "number").(float64)
 	if !ok || prNum <= 0 {
 		return errors.New("unable to get issue number on issue comment event")
 	}
@@ -200,7 +184,7 @@ func handleCommentUpdate(gh *client.GitHub, actionCtx *githubactions.GitHubConte
 		}
 
 		// This regex capture only the line of the current check.
-		specificManualCheck := regexp.MustCompile(fmt.Sprintf(`(?m:^- \[%s\] %s.*$)`, currentChecks[key].status, key))
+		specificManualCheck := regexp.MustCompile(fmt.Sprintf(`(?m:^- \[%s\] %s.*$)`, currentChecks[key].status, regexp.QuoteMeta(key)))
 
 		// If the box is checked, append the username of the user who checked it.
 		if strings.TrimSpace(currentChecks[key].status) == "x" {

contribs/github-bot/comment_test.go

@@ -71,42 +71,6 @@ func TestGeneratedComment(t *testing.T) {
 	}
 }
 
-func TestIndexMap(t *testing.T) {
-	t.Parallel()
-
-	m := map[string]any{
-		"Key1": map[string]any{
-			"Key2": map[string]any{
-				"Key3": 1,
-			},
-		},
-	}
-
-	test := indexMap(m)
-	assert.NotNil(t, test, "should return m")
-	_, ok := test.(map[string]any)
-	assert.True(t, ok, "returned m should be a map")
-
-	test = indexMap(m, "Key1")
-	assert.NotNil(t, test, "should return Key1 value")
-	_, ok = test.(map[string]any)
-	assert.True(t, ok, "Key1 value type should be a map")
-
-	test = indexMap(m, "Key1", "Key2")
-	assert.NotNil(t, test, "should return Key2 value")
-	_, ok = test.(map[string]any)
-	assert.True(t, ok, "Key2 value type should be a map")
-
-	test = indexMap(m, "Key1", "Key2", "Key3")
-	assert.NotNil(t, test, "should return Key3 value")
-	val, ok := test.(int)
-	assert.True(t, ok, "Key3 value type should be an int")
-	assert.Equal(t, 1, val, "Key3 value should be a 1")
-
-	test = indexMap(m, "Key1", "Key2", "Key3", "Key4")
-	assert.Nil(t, test, "Key4 value should not exist")
-}
-
 func setValue(t *testing.T, m map[string]any, value any, keys ...string) map[string]any {
 	t.Helper()
 
@@ -146,7 +110,7 @@ func TestCommentUpdateHandler(t *testing.T) {
 
 	// Exit without error because EventName is empty
 	assert.NoError(t, handleCommentUpdate(gh, actionCtx))
-	actionCtx.EventName = "issue_comment"
+	actionCtx.EventName = utils.EventIssueComment
 
 	// Exit with error because Event.action is not set
 	assert.Error(t, handleCommentUpdate(gh, actionCtx))

contribs/github-bot/internal/client/client.go

@@ -237,6 +237,36 @@ func (gh *GitHub) ListPRReviews(prNum int) ([]*github.PullRequestReview, error)
 	return allReviews, nil
 }
 
+// ListPR returns the list of pull requests in the specified state.
+func (gh *GitHub) ListPR(state string) ([]*github.PullRequest, error) {
+	var prs []*github.PullRequest
+
+	opts := &github.PullRequestListOptions{
+		State:     state,
+		Sort:      "updated",
+		Direction: "desc",
+		ListOptions: github.ListOptions{
+			PerPage: PageSize,
+		},
+	}
+
+	for {
+		prsPage, response, err := gh.Client.PullRequests.List(gh.Ctx, gh.Owner, gh.Repo, opts)
+		if err != nil {
+			return nil, fmt.Errorf("unable to list pull requests with state %s: %w", state, err)
+		}
+
+		prs = append(prs, prsPage...)
+
+		if response.NextPage == 0 {
+			break
+		}
+		opts.Page = response.NextPage
+	}
+
+	return prs, nil
+}
+
 // New initializes the API client, the logger, and creates an instance of GitHub.
 func New(ctx context.Context, params *p.Params) (*GitHub, error) {
 	gh := &GitHub{

contribs/github-bot/internal/params/params.go

@@ -6,6 +6,7 @@ import (
 	"os"
 	"time"
 
+	"github.com/gnolang/gno/contribs/github-bot/internal/utils"
 	"github.com/sethvargo/go-githubactions"
 )
 
@@ -83,55 +84,35 @@ func (p *Params) ValidateFlags() {
 
 	// Check if flags are coherent.
 	if p.PRAll && len(p.PRNums) != 0 {
-		errorUsage("You can specify only one of the '-pr-all' and '-pr-numbers' flags")
+		errorUsage("You can specify only one of the '-pr-all' and '-pr-numbers' flags.")
 	}
 
 	// If one of these values is empty, it must be retrieved
 	// from GitHub Actions context.
 	if p.Owner == "" || p.Repo == "" || (len(p.PRNums) == 0 && !p.PRAll) {
 		actionCtx, err := githubactions.Context()
 		if err != nil {
-			errorUsage(fmt.Sprintf("Unable to get GitHub Actions context: %v", err))
+			errorUsage(fmt.Sprintf("Unable to get GitHub Actions context: %v.", err))
 		}
 
 		if p.Owner == "" {
 			if p.Owner, _ = actionCtx.Repo(); p.Owner == "" {
-				errorUsage("Unable to retrieve owner from GitHub Actions context, you may want to set it using -onwer flag")
+				errorUsage("Unable to retrieve owner from GitHub Actions context, you may want to set it using -onwer flag.")
 			}
 		}
 		if p.Repo == "" {
 			if _, p.Repo = actionCtx.Repo(); p.Repo == "" {
-				errorUsage("Unable to retrieve repo from GitHub Actions context, you may want to set it using -repo flag")
+				errorUsage("Unable to retrieve repo from GitHub Actions context, you may want to set it using -repo flag.")
 			}
 		}
+
 		if len(p.PRNums) == 0 && !p.PRAll {
-			const errMsg = "Unable to retrieve pull request number from GitHub Actions context, you may want to set it using -pr-numbers flag"
-			var num float64
-
-			switch actionCtx.EventName {
-			case "issue_comment":
-				issue, ok := actionCtx.Event["issue"].(map[string]any)
-				if !ok {
-					errorUsage(errMsg)
-				}
-				num, ok = issue["number"].(float64)
-				if !ok || num <= 0 {
-					errorUsage(errMsg)
-				}
-			case "pull_request":
-				pr, ok := actionCtx.Event["pull_request"].(map[string]any)
-				if !ok {
-					errorUsage(errMsg)
-				}
-				num, ok = pr["number"].(float64)
-				if !ok || num <= 0 {
-					errorUsage(errMsg)
-				}
-			default:
-				errorUsage(errMsg)
+			prNum, err := utils.GetPRNumFromActionsCtx(actionCtx)
+			if err != nil {
+				errorUsage(fmt.Sprintf("Unable to retrieve pull request number from GitHub Actions context: %s\nYou may want to set it using -pr-numbers flag.", err.Error()))
 			}
 
-			p.PRNums = PRList([]int{int(num)})
+			p.PRNums = PRList{prNum}
 		}
 	}
 }

contribs/github-bot/internal/params/prlist.go

@@ -28,18 +28,22 @@ func (p PRList) MarshalText() (text []byte, err error) {
 
 // UnmarshalText implements encoding.TextUnmarshaler.
 func (p *PRList) UnmarshalText(text []byte) error {
-	for _, prNumStr := range strings.Split(string(text), ",") {
-		prNum, err := strconv.Atoi(strings.TrimSpace(prNumStr))
+	prNumsStr := strings.Split(string(text), ",")
+	prNums := make([]int, len(prNumsStr))
+
+	for i := range prNumsStr {
+		prNum, err := strconv.Atoi(strings.TrimSpace(prNumsStr[i]))
 		if err != nil {
 			return err
 		}
 
 		if prNum <= 0 {
-			return fmt.Errorf("invalid pull request number (<= 0): original(%s) parsed(%d)", prNumStr, prNum)
+			return fmt.Errorf("invalid pull request number (<= 0): original(%s) parsed(%d)", prNumsStr[i], prNum)
 		}
 
-		*p = append(*p, prNum)
+		prNums[i] = prNum
 	}
+	*p = prNums
 
 	return nil
 }

contribs/github-bot/internal/utils/actions.go

@@ -0,0 +1,45 @@
+package utils
+
+import (
+	"fmt"
+
+	"github.com/sethvargo/go-githubactions"
+)
+
+// Recursively search for nested values using the keys provided.
+func IndexMap(m map[string]any, keys ...string) any {
+	if len(keys) == 0 {
+		return m
+	}
+
+	if val, ok := m[keys[0]]; ok {
+		if keys = keys[1:]; len(keys) == 0 {
+			return val
+		}
+		subMap, _ := val.(map[string]any)
+		return IndexMap(subMap, keys...)
+	}
+
+	return nil
+}
+
+// Retrieve PR number from GitHub Actions context
+func GetPRNumFromActionsCtx(actionCtx *githubactions.GitHubContext) (int, error) {
+	firstKey := ""
+
+	switch actionCtx.EventName {
+	case EventIssueComment:
+		firstKey = "issue"
+	case EventPullRequest, EventPullRequestTarget:
+		firstKey = "pull_request"
+	default:
+		return 0, fmt.Errorf("unsupported event: %s", actionCtx.EventName)
+	}
+
+	num, ok := IndexMap(actionCtx.Event, firstKey, "number").(float64)
+	if !ok || num <= 0 {
+		return 0, fmt.Errorf("invalid value: %d", int(num))
+	}
+
+	return int(num), nil
+}