sigs.k8s.io/prow@v0.0.0-20240503223140-c5e374dc7eb1/cmd/deck/rerun.go

/*
Copyright 2022 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package main

import (
	"context"
	"errors"
	"fmt"
	"net/http"

	"github.com/sirupsen/logrus"
	kerrors "k8s.io/apimachinery/pkg/api/errors"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	utilerrors "k8s.io/apimachinery/pkg/util/errors"
	"k8s.io/apimachinery/pkg/util/sets"
	prowapi "sigs.k8s.io/prow/pkg/apis/prowjobs/v1"
	prowv1 "sigs.k8s.io/prow/pkg/client/clientset/versioned/typed/prowjobs/v1"
	"sigs.k8s.io/prow/pkg/config"
	gerritsource "sigs.k8s.io/prow/pkg/gerrit/source"
	"sigs.k8s.io/prow/pkg/github"
	"sigs.k8s.io/prow/pkg/githuboauth"
	"sigs.k8s.io/prow/pkg/kube"
	"sigs.k8s.io/prow/pkg/pjutil"
	"sigs.k8s.io/prow/pkg/plugins"
	"sigs.k8s.io/prow/pkg/plugins/trigger"
)

var (
	// Stores the annotations and labels that are generated
	// and specified within components.
	ComponentSpecifiedAnnotationsAndLabels = sets.New[string](
		// Labels
		kube.GerritRevision,
		kube.GerritPatchset,
		kube.GerritReportLabel,
		github.EventGUID,
		kube.CreatedByTideLabel,
		// Annotations
		kube.GerritID,
		kube.GerritInstance,
	)
)

func verifyRerunRefs(refs *prowapi.Refs) error {
	var errs []error
	if refs == nil {
		return errors.New("Refs must be supplied")
	}
	if len(refs.Org) == 0 {
		errs = append(errs, errors.New("org must be supplied"))
	}
	if len(refs.Repo) == 0 {
		errs = append(errs, errors.New("repo must be supplied"))
	}
	if len(refs.BaseRef) == 0 {
		errs = append(errs, errors.New("baseRef must be supplied"))
	}
	return utilerrors.NewAggregate(errs)
}

func setRerunOrgRepo(refs *prowapi.Refs, labels map[string]string) string {
	org, repo := refs.Org, refs.Repo
	orgRepo := org + "/" + repo
	// Normalize prefix to orgRepo if this is a gerrit job.
	// (Unfortunately gerrit jobs use the full repo URL as the identifier.)
	if labels[kube.GerritRevision] != "" && !gerritsource.IsGerritOrg(refs.Org) {
		orgRepo = gerritsource.CloneURIFromOrgRepo(refs.Org, refs.Repo)
	}
	return orgRepo
}

type preOrPostsubmit interface {
	GetName() string
	CouldRun(string) bool
	GetLabels() map[string]string
	GetAnnotations() map[string]string
}

func getPreOrPostSpec[p preOrPostsubmit](jobGetter func(string) []p, creator func(p, prowapi.Refs) prowapi.ProwJobSpec, name string, refs *prowapi.Refs, labels map[string]string) (*prowapi.ProwJobSpec, map[string]string, map[string]string, error) {
	if err := verifyRerunRefs(refs); err != nil {
		return nil, nil, nil, err
	}
	var result *p
	branch := refs.BaseRef
	orgRepo := setRerunOrgRepo(refs, labels)
	nameFound := false
	for _, job := range jobGetter(orgRepo) {
		job := job
		if job.GetName() != name {
			continue
		}
		nameFound = true
		if job.CouldRun(branch) { // filter out jobs that are not branch matching
			if result != nil {
				return nil, nil, nil, fmt.Errorf("%s matches multiple prow jobs from orgRepo %q", name, orgRepo)
			}
			result = &job
		}
	}
	if result == nil {
		if nameFound {
			return nil, nil, nil, fmt.Errorf("found job %q, but not allowed to run for orgRepo %q", name, orgRepo)
		} else {
			return nil, nil, nil, fmt.Errorf("failed to find job %q for orgRepo %q", name, orgRepo)
		}
	}

	prowJobSpec := creator(*result, *refs)
	return &prowJobSpec, (*result).GetLabels(), (*result).GetAnnotations(), nil
}

func getPresubmitSpec(cfg config.Getter, name string, refs *prowapi.Refs, labels map[string]string) (*prowapi.ProwJobSpec, map[string]string, map[string]string, error) {
	return getPreOrPostSpec(cfg().GetPresubmitsStatic, pjutil.PresubmitSpec, name, refs, labels)
}

func getPostsubmitSpec(cfg config.Getter, name string, refs *prowapi.Refs, labels map[string]string) (*prowapi.ProwJobSpec, map[string]string, map[string]string, error) {
	return getPreOrPostSpec(cfg().GetPostsubmitsStatic, pjutil.PostsubmitSpec, name, refs, labels)
}

func getPeriodicSpec(cfg config.Getter, name string) (*prowapi.ProwJobSpec, map[string]string, map[string]string, error) {
	var periodicJob *config.Periodic
	for _, job := range cfg().AllPeriodics() {
		if job.Name == name {
			// Directly followed by break, so this is ok
			// nolint: exportloopref
			periodicJob = &job
			break
		}
	}
	if periodicJob == nil {
		return nil, nil, nil, fmt.Errorf("failed to find associated periodic job %q", name)
	}
	prowJobSpec := pjutil.PeriodicSpec(*periodicJob)
	return &prowJobSpec, periodicJob.Labels, periodicJob.Annotations, nil
}

func getProwJobSpec(pjType prowapi.ProwJobType, cfg config.Getter, name string, refs *prowapi.Refs, labels map[string]string) (*prowapi.ProwJobSpec, map[string]string, map[string]string, error) {
	switch pjType {
	case prowapi.PeriodicJob:
		return getPeriodicSpec(cfg, name)
	case prowapi.PresubmitJob:
		return getPresubmitSpec(cfg, name, refs, labels)
	case prowapi.PostsubmitJob:
		return getPostsubmitSpec(cfg, name, refs, labels)
	default:
		return nil, nil, nil, fmt.Errorf("Could not create new prowjob: Invalid prowjob type: %q", pjType)
	}
}

type pluginsCfg func() *plugins.Configuration

// canTriggerJob determines whether the given user can trigger any job.
func canTriggerJob(user string, pj prowapi.ProwJob, cfg *prowapi.RerunAuthConfig, cli deckGitHubClient, pluginsCfg pluginsCfg, log *logrus.Entry) (bool, error) {
	var org string
	if pj.Spec.Refs != nil {
		org = pj.Spec.Refs.Org
	} else if len(pj.Spec.ExtraRefs) > 0 {
		org = pj.Spec.ExtraRefs[0].Org
	}

	// Then check config-level rerun auth config.
	if auth, err := cfg.IsAuthorized(org, user, cli); err != nil {
		return false, err
	} else if auth {
		return true, err
	}

	// Check job-level rerun auth config.
	if auth, err := pj.Spec.RerunAuthConfig.IsAuthorized(org, user, cli); err != nil {
		return false, err
	} else if auth {
		return true, nil
	}

	if cli == nil {
		log.Warning("No GitHub token was provided, so we cannot retrieve GitHub teams")
		return false, nil
	}

	// If the job is a presubmit and has an associated PR, and a plugin config is provided,
	// do the same checks as for /test
	if pj.Spec.Type == prowapi.PresubmitJob && pj.Spec.Refs != nil && len(pj.Spec.Refs.Pulls) > 0 {
		if pluginsCfg == nil {
			log.Info("No plugin config was provided so we cannot check if the user would be allowed to use /test.")
		} else {
			pcfg := pluginsCfg()
			pull := pj.Spec.Refs.Pulls[0]
			org := pj.Spec.Refs.Org
			repo := pj.Spec.Refs.Repo
			_, allowed, err := trigger.TrustedPullRequest(cli, pcfg.TriggerFor(org, repo), user, org, repo, pull.Number, nil)
			return allowed, err
		}
	}
	return false, nil
}

func isAllowedToRerun(r *http.Request, acfg authCfgGetter, goa *githuboauth.Agent, ghc githuboauth.AuthenticatedUserIdentifier, pj prowapi.ProwJob, cli deckGitHubClient, pluginAgent *plugins.ConfigAgent, log *logrus.Entry) (bool, string, error, int) {
	authConfig := acfg(&pj.Spec)
	var allowed bool
	var login string
	if pj.Spec.RerunAuthConfig.IsAllowAnyone() || authConfig.IsAllowAnyone() {
		// Skip getting the users login via GH oauth if anyone is allowed to rerun
		// jobs so that GH oauth doesn't need to be set up for private Prows.
		allowed = true
	} else {
		if goa == nil {
			return allowed, "", errors.New("GitHub oauth must be configured to rerun jobs unless 'allow_anyone: true' is specified."), http.StatusInternalServerError
		}
		var err error
		login, err = goa.GetLogin(r, ghc)
		if err != nil {
			return allowed, "", errors.New("Error retrieving GitHub login."), http.StatusUnauthorized
		}
		log = log.WithField("user", login)
		allowed, err = canTriggerJob(login, pj, authConfig, cli, pluginAgent.Config, log)
		if err != nil {
			return allowed, "", err, http.StatusInternalServerError
		}
	}
	return allowed, login, nil, http.StatusOK
}

// Valid value for query parameter mode in rerun route
const (
	LATEST = "latest"
)

// handleRerun triggers a rerun of the given job if that features is enabled, it receives a
// POST request, and the user has the necessary permissions. Otherwise, it writes the config
// for a new job but does not trigger it.
func handleRerun(cfg config.Getter, prowJobClient prowv1.ProwJobInterface, createProwJob bool, acfg authCfgGetter, goa *githuboauth.Agent, ghc githuboauth.AuthenticatedUserIdentifier, cli deckGitHubClient, pluginAgent *plugins.ConfigAgent, log *logrus.Entry) http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
		name := r.URL.Query().Get("prowjob")
		mode := r.URL.Query().Get("mode")
		l := log.WithField("prowjob", name)
		if name == "" {
			http.Error(w, "request did not provide the 'prowjob' query parameter", http.StatusBadRequest)
			return
		}
		pj, err := prowJobClient.Get(context.TODO(), name, metav1.GetOptions{})
		if err != nil {
			http.Error(w, fmt.Sprintf("ProwJob not found: %v", err), http.StatusNotFound)
			if !kerrors.IsNotFound(err) {
				// admins only care about errors other than not found
				l.WithError(err).Warning("ProwJob not found.")
			}
			return
		}
		enableScheduling := cfg().Scheduler.Enabled
		var newPJ prowapi.ProwJob
		if mode == LATEST {
			prowJobSpec, labels, annotations, err := getProwJobSpec(pj.Spec.Type, cfg, pj.Spec.Job, pj.Spec.Refs, pj.Labels)
			if err != nil {
				// These are user errors, i.e. missing fields, requested prowjob doesn't exist etc.
				// These errors are already surfaced to user via pubsub two lines below.
				http.Error(w, fmt.Sprintf("Could not create new prowjob: Failed getting prowjob spec: %v", err), http.StatusBadRequest)
				l.WithError(err).Debug("Could not create new prowjob")
				return
			}

			// Add component specified labels and annotations from original prowjob
			for k, v := range pj.ObjectMeta.Labels {
				if ComponentSpecifiedAnnotationsAndLabels.Has(k) {
					if labels == nil {
						labels = make(map[string]string)
					}
					labels[k] = v
				}
			}
			for k, v := range pj.ObjectMeta.Annotations {
				if ComponentSpecifiedAnnotationsAndLabels.Has(k) {
					if annotations == nil {
						annotations = make(map[string]string)
					}
					annotations[k] = v
				}
			}

			newPJ = pjutil.NewProwJob(*prowJobSpec, labels, annotations, pjutil.RequireScheduling(enableScheduling))
		} else {
			newPJ = pjutil.NewProwJob(pj.Spec, pj.ObjectMeta.Labels, pj.ObjectMeta.Annotations, pjutil.RequireScheduling(enableScheduling))
		}
		l = l.WithField("job", newPJ.Spec.Job)
		switch r.Method {
		case http.MethodGet:
			handleSerialize(w, "prowjob", newPJ, l)
		case http.MethodPost:
			if !createProwJob {
				http.Error(w, "Direct rerun feature is not enabled. Enable with the '--rerun-creates-job' flag.", http.StatusMethodNotAllowed)
				return
			}
			allowed, user, err, code := isAllowedToRerun(r, acfg, goa, ghc, newPJ, cli, pluginAgent, l)
			if err != nil {
				http.Error(w, fmt.Sprintf("Could not verify if allowed to rerun: %v.", err), code)
				l.WithError(err).Debug("Could not verify if allowed to rerun.")
			}
			l = l.WithField("allowed", allowed).WithField("user", user).WithField("code", code)
			l.Info("Attempted rerun")
			if !allowed {
				if _, err = w.Write([]byte("You don't have permission to rerun that job.")); err != nil {
					l.WithError(err).Error("Error writing to rerun response.")
				}
				return
			}
			var rerunDescription string
			if len(user) > 0 {
				rerunDescription = fmt.Sprintf("%v successfully reran %v.", user, name)
			} else {
				rerunDescription = fmt.Sprintf("Successfully reran %v.", name)
			}
			newPJ.Status.Description = rerunDescription
			created, err := prowJobClient.Create(context.TODO(), &newPJ, metav1.CreateOptions{})
			if err != nil {
				l.WithError(err).Error("Error creating job.")
				http.Error(w, fmt.Sprintf("Error creating job: %v", err), http.StatusInternalServerError)
				return
			}
			l = l.WithField("new-prowjob", created.Name)
			if len(user) > 0 {
				l.Info(fmt.Sprintf("%v successfully created a rerun of %v.", user, name))
			} else {
				l.Info(fmt.Sprintf("Successfully created a rerun of %v.", name))
			}
			if _, err = w.Write([]byte("Job successfully triggered. Wait 30 seconds and refresh the page for the job to show up.")); err != nil {
				l.WithError(err).Error("Error writing to rerun response.")
			}
			return
		default:
			http.Error(w, fmt.Sprintf("bad verb %v", r.Method), http.StatusMethodNotAllowed)
			return
		}
	}
}