handler: support artifact env

config/config.go

@@ -155,6 +155,9 @@ type GithubReportType string
 const (
 	GithubCheckRuns GithubReportType = "github_check_run"
 	GithubPRReview  GithubReportType = "github_pr_review"
+
+	// for debug and testing
+	Quiet GithubReportType = "quiet"
 )
 
 func boolPtr(b bool) *bool {

internal/linters/linters.go

@@ -39,6 +39,8 @@ var (
 	linterLanguages     = map[string][]string{}
 )
 
+const artifactDirFlag = "reviewbot"
+
 // PullRequestHandlerFunc knows how to handle a pull request event.
 type PullRequestHandlerFunc func(*xlog.Logger, Agent) error
 
@@ -157,15 +159,48 @@ func ExecRun(workDir string, command []string, args ...string) ([]byte, error) {
 	if len(command) > 1 {
 		cmdArgs = command[1:]
 	}
+	cmdArgs = append(cmdArgs, args...)
+	c := exec.Command(executable, cmdArgs...)
+	c.Dir = workDir
 
-	if len(args) > 0 {
-		cmdArgs = append(cmdArgs, args...)
+	// create a temp dir for the artifact
+	artifact, err := os.MkdirTemp("", artifactDirFlag)
+	if err != nil {
+		return nil, err
 	}
+	defer os.RemoveAll(artifact)
+	c.Env = append(os.Environ(), fmt.Sprintf("ARTIFACT=%s", artifact))
 
-	c := exec.Command(executable, cmdArgs...)
-	c.Dir = workDir
 	log.Infof("run command: %v", c)
-	return c.CombinedOutput()
+	output, execErr := c.CombinedOutput()
+
+	// read all files under the artifact dir
+	var fileContent []byte
+	artifactFiles, err := os.ReadDir(artifact)
+	if err != nil {
+		return nil, err
+	}
+
+	for _, file := range artifactFiles {
+		if file.IsDir() {
+			continue
+		}
+
+		content, err := os.ReadFile(fmt.Sprintf("%s/%s", artifact, file.Name()))
+		if err != nil {
+			return nil, err
+		}
+
+		fileContent = append(fileContent, content...)
+	}
+
+	// use the content of the files under Artifact dir as first priority
+	if len(fileContent) > 0 {
+		log.Debugf("artifact files used instead. legacy output:\n%v", string(output))
+		output = fileContent
+	}
+
+	return output, execErr
 }
 
 // GeneralParse parses the output of a linter command.
@@ -246,6 +281,8 @@ func Report(log *xlog.Logger, a Agent, lintResults map[string][]LinterOutput) er
 		}
 		log.Infof("[%s] add %d comments for this PR %d (%s) \n", linterName, len(addedCmts), num, orgRepo)
 		metric.NotifyWebhookByText(ConstructGotchaMsg(linterName, a.PullRequestEvent.GetPullRequest().GetHTMLURL(), addedCmts[0].GetHTMLURL(), lintResults))
+	case config.Quiet:
+		return nil
 	default:
 		log.Errorf("unsupported report format: %v", a.LinterConfig.ReportFormat)
 	}

internal/linters/linters_test.go

@@ -20,6 +20,9 @@ import (
 	"fmt"
 	"reflect"
 	"testing"
+
+	"github.com/qiniu/reviewbot/config"
+	"github.com/qiniu/x/xlog"
 )
 
 func TestFormatStaticcheckLine(t *testing.T) {
@@ -168,3 +171,48 @@ func TestConstructUnknownMsg(t *testing.T) {
 		}
 	}
 }
+
+func TestGeneralHandler(t *testing.T) {
+	tp := true
+	tcs := []struct {
+		id    string
+		input Agent
+		err   error
+	}{
+		{
+			id: "case1 - without ARTIFACT",
+			input: Agent{
+				LinterName: "ut",
+				LinterConfig: config.Linter{
+					Enable:       &tp,
+					Command:      []string{"/bin/bash", "-c", "--"},
+					Args:         []string{"golangci-lint run"},
+					ReportFormat: config.Quiet,
+				},
+			},
+			err: nil,
+		},
+		{
+			id: "case2 - with ARTIFACT",
+			input: Agent{
+				LinterName: "ut",
+				LinterConfig: config.Linter{
+					Enable:       &tp,
+					Command:      []string{"/bin/bash", "-c", "--"},
+					Args:         []string{"golangci-lint run >> $ARTIFACT/golangci-lint.log 2>&1"},
+					ReportFormat: config.Quiet,
+				},
+			},
+			err: nil,
+		},
+	}
+
+	for _, tc := range tcs {
+		t.Run(tc.id, func(t *testing.T) {
+			got := GeneralHandler(xlog.New("UnitTest"), tc.input, GeneralParse)
+			if got != tc.err {
+				t.Errorf("handler() = %v, want %v", got, tc.err)
+			}
+		})
+	}
+}