doghouse.go

package main

import (
	"context"
	"errors"
	"fmt"
	"io"
	"log"
	"net/http"
	"os"
	"sort"

	"golang.org/x/oauth2"
	"golang.org/x/sync/errgroup"

	"github.com/reviewdog/reviewdog"
	"github.com/reviewdog/reviewdog/cienv"
	"github.com/reviewdog/reviewdog/doghouse"
	"github.com/reviewdog/reviewdog/doghouse/client"
	"github.com/reviewdog/reviewdog/filter"
	"github.com/reviewdog/reviewdog/project"
	"github.com/reviewdog/reviewdog/proto/rdf"
	"github.com/reviewdog/reviewdog/service/github/githubutils"
	"github.com/reviewdog/reviewdog/service/serviceutil"
)

func runDoghouse(ctx context.Context, r io.Reader, w io.Writer, opt *option, isProject bool, forPr bool, useAnnotationReporter bool) error {
	ghInfo, isPr, err := cienv.GetBuildInfo()
	if err != nil {
		return err
	}
	if !isPr && forPr {
		fmt.Fprintln(os.Stderr, "reviewdog: this is not PullRequest build.")
		return nil
	}
	resultSet, err := checkResultSet(ctx, r, opt, isProject)
	if err != nil {
		return err
	}
	cli, err := newDoghouseCli(ctx)
	if err != nil {
		return err
	}
	filteredResultSet, err := postResultSet(ctx, resultSet, ghInfo, cli, opt, useAnnotationReporter)
	if err != nil {
		return err
	}
	if foundResultShouldReport := reportResults(w, filteredResultSet, useAnnotationReporter); foundResultShouldReport {
		return errors.New("found at least one result in diff")
	}
	return nil
}

func newDoghouseCli(ctx context.Context) (client.DogHouseClientInterface, error) {
	// If skipDoghouseServer is true, run doghouse code directly instead of talking to
	// the doghouse server because provided GitHub API Token has Check API scope.
	// You can force skipping the doghouse server if you are generating your own application API token.
	skipDoghouseServer := (os.Getenv("REVIEWDOG_SKIP_DOGHOUSE") == "true" || cienv.IsInGitHubAction()) && os.Getenv("REVIEWDOG_TOKEN") == ""
	if skipDoghouseServer {
		token, err := nonEmptyEnv("REVIEWDOG_GITHUB_API_TOKEN")
		if err != nil {
			return nil, err
		}
		ghcli, err := githubClient(ctx, token)
		if err != nil {
			return nil, err
		}
		return &client.GitHubClient{Client: ghcli}, nil
	}
	return newDoghouseServerCli(ctx), nil
}

func newDoghouseServerCli(ctx context.Context) *client.DogHouseClient {
	httpCli := http.DefaultClient
	if token := os.Getenv("REVIEWDOG_TOKEN"); token != "" {
		ts := oauth2.StaticTokenSource(
			&oauth2.Token{AccessToken: token},
		)
		httpCli = oauth2.NewClient(ctx, ts)
	}
	return client.New(httpCli)
}

var projectRunAndParse = project.RunAndParse

func checkResultSet(ctx context.Context, r io.Reader, opt *option, isProject bool) (*reviewdog.ResultMap, error) {
	resultSet := new(reviewdog.ResultMap)
	if isProject {
		conf, err := projectConfig(opt.conf)
		if err != nil {
			return nil, err
		}
		resultSet, err = projectRunAndParse(ctx, conf, buildRunnersMap(opt.runners), opt.level, opt.tee)
		if err != nil {
			return nil, err
		}
	} else {
		p, err := newParserFromOpt(opt)
		if err != nil {
			return nil, err
		}
		diagnostics, err := p.Parse(r)
		if err != nil {
			return nil, err
		}
		resultSet.Store(toolName(opt), &reviewdog.Result{
			Level:       opt.level,
			Diagnostics: diagnostics,
		})
	}
	return resultSet, nil
}

func postResultSet(ctx context.Context, resultSet *reviewdog.ResultMap,
	ghInfo *cienv.BuildInfo, cli client.DogHouseClientInterface, opt *option, useAnnotationReporter bool) (*reviewdog.FilteredResultMap, error) {
	var g errgroup.Group
	wd, _ := os.Getwd()
	gitRelWd, err := serviceutil.GitRelWorkdir()
	if err != nil {
		return nil, err
	}
	filteredResultSet := new(reviewdog.FilteredResultMap)
	resultSet.Range(func(name string, result *reviewdog.Result) {
		diagnostics := result.Diagnostics
		as := make([]*doghouse.Annotation, 0, len(diagnostics))
		for _, d := range diagnostics {
			as = append(as, checkResultToAnnotation(d, wd, gitRelWd))
		}
		req := &doghouse.CheckRequest{
			Name:        name,
			Owner:       ghInfo.Owner,
			Repo:        ghInfo.Repo,
			PullRequest: ghInfo.PullRequest,
			SHA:         ghInfo.SHA,
			Branch:      ghInfo.Branch,
			Annotations: as,
			Level:       result.Level,
			FilterMode:  opt.filterMode,
		}
		g.Go(func() error {
			if err := result.CheckUnexpectedFailure(); err != nil {
				return err
			}

			res, err := cli.Check(ctx, req, !useAnnotationReporter)

			if err != nil {
				return fmt.Errorf("post failed for %s: %w", name, err)
			}
			if res.ReportURL != "" {
				conclusion := ""
				if res.Conclusion != "" {
					conclusion = fmt.Sprintf(" (conclusion=%s)", res.Conclusion)
				}
				log.Printf("[%s] reported: %s%s", name, res.ReportURL, conclusion)
			} else if res.CheckedResults != nil {
				// Fill results only when report URL is missing, which probably means
				// it failed to report results with Check API.
				filteredResultSet.Store(name, &reviewdog.FilteredResult{
					Level:              result.Level,
					FilteredDiagnostic: res.CheckedResults,
				})
			}
			if res.ReportURL == "" && res.CheckedResults == nil {
				return fmt.Errorf("[%s] no result found", name)
			}
			// If failOnError is on, return error when at least one report
			// returns failure conclusion (status). Users can check this
			// reviewdog run status (#446) to merge PRs for example.
			//
			// Also, the individual report conclusions are associated to random check
			// suite due to the GitHub bug (#403), so actually users cannot depends
			// on each report as of writing.
			if opt.failOnError && (res.Conclusion == "failure") {
				return fmt.Errorf("[%s] Check conclusion is %q", name, res.Conclusion)
			}
			return nil
		})
	})
	return filteredResultSet, g.Wait()
}

func checkResultToAnnotation(d *rdf.Diagnostic, wd, gitRelWd string) *doghouse.Annotation {
	d.GetLocation().Path = filter.NormalizePath(d.GetLocation().GetPath(), wd, gitRelWd)
	return &doghouse.Annotation{
		Diagnostic: d,
	}
}

// reportResults reports results to given io.Writer and possibly to GitHub
// Actions log using logging command.
//
// It returns true if reviewdog should exit with 1.
// e.g. At least one annotation result is in diff.
func reportResults(w io.Writer, filteredResultSet *reviewdog.FilteredResultMap, useAnnotationReporter bool) bool {
	if filteredResultSet.Len() != 0 && cienv.HasReadOnlyPermissionGitHubToken() {
		fmt.Fprintln(os.Stderr, `reviewdog: This GitHub token doesn't have write permission of Review API [1], 
so reviewdog will report results via logging command [2] and create annotations similar to
github-pr-check reporter as a fallback.
[1]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target, 
[2]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#logging-commands`)
	}

	// Sort names to get deterministic result.
	var names []string
	filteredResultSet.Range(func(name string, results *reviewdog.FilteredResult) {
		names = append(names, name)
	})
	sort.Strings(names)

	shouldFail := false
	foundNumOverall := 0
	for _, name := range names {
		results, err := filteredResultSet.Load(name)
		if err != nil {
			// Should not happen.
			log.Printf("reviewdog: result not found for %q", name)
			continue
		}
		fmt.Fprintf(w, "reviewdog: Reporting results for %q\n", name)
		foundResultPerName := false
		filteredNum := 0
		for _, result := range results.FilteredDiagnostic {
			if !result.ShouldReport {
				filteredNum++
				continue
			}
			foundNumOverall++
			// If it's not running in GitHub Actions and not using the annotation reporter, reviewdog should exit with 1
			// if there are at least one result in diff regardless of error level.
			shouldFail = shouldFail || (!cienv.IsInGitHubAction() && !useAnnotationReporter) ||
				!(results.Level == "warning" || results.Level == "info")

			if foundNumOverall == githubutils.MaxLoggingAnnotationsPerStep {
				githubutils.WarnTooManyAnnotationOnce()
				shouldFail = true
			}

			foundResultPerName = true
			if cienv.IsInGitHubAction() || useAnnotationReporter {
				githubutils.ReportAsGitHubActionsLog(name, results.Level, result.Diagnostic)
			} else {
				// Output original lines.
				fmt.Fprintln(w, result.Diagnostic.GetOriginalOutput())
			}
		}
		if !foundResultPerName {
			fmt.Fprintf(w, "reviewdog: No results found for %q. %d results found outside diff.\n", name, filteredNum)
		}
	}
	return shouldFail
}