feat: trigger on deploy status and periodically

pkg/apis/lighthouse/v1alpha1/types.go

@@ -203,7 +203,7 @@ func (s *LighthouseJobSpec) GetEnvVars() map[string]string {
 		env[PullRefsEnv] = s.Refs.String()
 	}
 
-	if s.Type == job.PostsubmitJob || s.Type == job.BatchJob {
+	if s.Type != job.PresubmitJob {
 		return env
 	}
 

pkg/config/config.go

@@ -251,6 +251,16 @@ func (c *Config) GetPostsubmits(repository scm.Repository) []job.Postsubmit {
 	return answer
 }
 
+// GetDeployments lets return all the deployments
+func (c *Config) GetDeployments(repository scm.Repository) []job.Deployment {
+	fullNames := util.FullNames(repository)
+	var answer []job.Deployment
+	for _, fn := range fullNames {
+		answer = append(answer, c.Deployments[fn]...)
+	}
+	return answer
+}
+
 // GetPresubmits lets return all the pre submits for the given repo
 func (c *Config) GetPresubmits(repository scm.Repository) []job.Presubmit {
 	fullNames := util.FullNames(repository)
@@ -262,9 +272,9 @@ func (c *Config) GetPresubmits(repository scm.Repository) []job.Presubmit {
 }
 
 // BranchRequirements partitions status contexts for a given org, repo branch into three buckets:
-//  - contexts that are always required to be present
-//  - contexts that are required, _if_ present
-//  - contexts that are always optional
+//   - contexts that are always required to be present
+//   - contexts that are required, _if_ present
+//   - contexts that are always optional
 func BranchRequirements(org, repo, branch string, presubmits map[string][]job.Presubmit) ([]string, []string, []string) {
 	jobs, ok := presubmits[org+"/"+repo]
 	if !ok {

pkg/config/job/config.go

@@ -33,7 +33,8 @@ type Config struct {
 	Presubmits  map[string][]Presubmit  `json:"presubmits,omitempty"`
 	Postsubmits map[string][]Postsubmit `json:"postsubmits,omitempty"`
 	// Periodics are not associated with any repo.
-	Periodics []Periodic `json:"periodics,omitempty"`
+	Periodics   []Periodic              `json:"periodics,omitempty"`
+	Deployments map[string][]Deployment `json:"deployments,omitempty"`
 }
 
 func resolvePresets(name string, labels map[string]string, spec *v1.PodSpec, presets []Preset) error {

pkg/config/job/deployment.go

@@ -0,0 +1,25 @@
+/*
+Copyright 2017 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 job
+
+type Deployment struct {
+	Base
+	Reporter
+	// The deployment state that trigger this pipeline
+	// Can be one of: error, failure, inactive, in_progress, queued, pending, success
+	State string `json:"state,omitempty"`
+}

pkg/config/job/periodic.go

@@ -19,10 +19,11 @@ package job
 // Periodic runs on a timer.
 type Periodic struct {
 	Base
+	Reporter
+	// The branch to build
+	Branch string `json:"branch"`
 	// Cron representation of job trigger time
 	Cron string `json:"cron"`
-	// Tags for config entries
-	Tags []string `json:"tags,omitempty"`
 }
 
 // SetDefaults initializes default values

pkg/config/job/pipelinekind.go

@@ -35,6 +35,8 @@ const (
 	PostsubmitJob PipelineKind = "postsubmit"
 	// Periodic job means it runs on a time-basis, unrelated to git changes.
 	PeriodicJob PipelineKind = "periodic"
+	// Deployment job means it runs on deployment status event
+	DeploymentJob PipelineKind = "deployment"
 	// BatchJob tests multiple unmerged PRs at the same time.
 	BatchJob PipelineKind = "batch"
 )

pkg/jobutil/jobutil.go

@@ -143,6 +143,16 @@ func PostsubmitSpec(logger *logrus.Entry, p job.Postsubmit, refs v1alpha1.Refs)
 	return pjs
 }
 
+// DeploymentSpec initializes a PipelineOptionsSpec for a given deployment job.
+func DeploymentSpec(logger *logrus.Entry, p job.Deployment, refs v1alpha1.Refs) v1alpha1.LighthouseJobSpec {
+	pjs := specFromJobBase(logger, p.Base)
+	pjs.Type = job.DeploymentJob
+	pjs.Context = p.Context
+	pjs.Refs = completePrimaryRefs(refs, p.Base)
+
+	return pjs
+}
+
 // PeriodicSpec initializes a PipelineOptionsSpec for a given periodic job.
 func PeriodicSpec(logger *logrus.Entry, p job.Periodic) v1alpha1.LighthouseJobSpec {
 	pjs := specFromJobBase(logger, p.Base)

pkg/plugins/plugin.go

@@ -8,16 +8,17 @@ import (
 
 // Plugin defines a plugin and its handlers
 type Plugin struct {
-	Description           string
-	ExcludedProviders     sets.String
-	ConfigHelpProvider    ConfigHelpProvider
-	IssueHandler          IssueHandler
-	PullRequestHandler    PullRequestHandler
-	PushEventHandler      PushEventHandler
-	ReviewEventHandler    ReviewEventHandler
-	StatusEventHandler    StatusEventHandler
-	GenericCommentHandler GenericCommentHandler
-	Commands              []Command
+	Description             string
+	ExcludedProviders       sets.String
+	ConfigHelpProvider      ConfigHelpProvider
+	IssueHandler            IssueHandler
+	PullRequestHandler      PullRequestHandler
+	PushEventHandler        PushEventHandler
+	ReviewEventHandler      ReviewEventHandler
+	StatusEventHandler      StatusEventHandler
+	DeploymentStatusHandler DeploymentStatusHandler
+	GenericCommentHandler   GenericCommentHandler
+	Commands                []Command
 }
 
 // InvokeCommandHandler calls InvokeHandler on all commands

pkg/plugins/plugins.go

@@ -63,6 +63,8 @@ type PullRequestHandler func(Agent, scm.PullRequestHook) error
 // StatusEventHandler defines the function contract for a scm.Status handler.
 type StatusEventHandler func(Agent, scm.Status) error
 
+type DeploymentStatusHandler func(Agent, scm.DeploymentStatusHook) error
+
 // PushEventHandler defines the function contract for a scm.PushHook handler.
 type PushEventHandler func(Agent, scm.PushHook) error
 

pkg/plugins/trigger/trigger.go

@@ -45,9 +45,10 @@ var plugin = plugins.Plugin{
 	Description: `The trigger plugin starts tests in reaction to commands and pull request events. It is responsible for ensuring that test jobs are only run on trusted PRs. A PR is considered trusted if the author is a member of the 'trusted organization' for the repository or if such a member has left an '/ok-to-test' command on the PR.
 <br>Trigger starts jobs automatically when a new trusted PR is created or when an untrusted PR becomes trusted, but it can also be used to start jobs manually via the '/test' command.
 <br>The '/retest' command can be used to rerun jobs that have reported failure.`,
-	ConfigHelpProvider: configHelp,
-	PullRequestHandler: handlePullRequest,
-	PushEventHandler:   handlePush,
+	ConfigHelpProvider:      configHelp,
+	PullRequestHandler:      handlePullRequest,
+	PushEventHandler:        handlePush,
+	DeploymentStatusHandler: handleDeploymentStatus,
 	Commands: []plugins.Command{{
 		Name:        "ok-to-test",
 		Description: "Marks a PR as 'trusted' and starts tests.",
@@ -75,6 +76,35 @@ var plugin = plugins.Plugin{
 	}},
 }
 
+func handleDeploymentStatus(agent plugins.Agent, ds scm.DeploymentStatusHook) error {
+	return handleDeployment(getClient(agent), ds)
+}
+
+func handleDeployment(c Client, ds scm.DeploymentStatusHook) error {
+	for _, j := range c.Config.GetDeployments(ds.Repo) {
+		labels := make(map[string]string)
+		for k, v := range j.Labels {
+			labels[k] = v
+		}
+		refs := v1alpha1.Refs{
+			Org:      ds.Repo.Namespace,
+			Repo:     ds.Repo.Name,
+			BaseRef:  ds.Deployment.Ref,
+			BaseSHA:  ds.Deployment.Sha,
+			BaseLink: ds.Deployment.RepositoryLink,
+			CloneURI: ds.Repo.Clone,
+		}
+		labels[scmprovider.EventGUID] = ds.DeploymentStatus.ID
+		pj := jobutil.NewLighthouseJob(jobutil.DeploymentSpec(c.Logger, j, refs), labels, j.Annotations)
+		c.Logger.WithFields(jobutil.LighthouseJobFields(&pj)).Info("Creating a new LighthouseJob.")
+		if _, err := c.LauncherClient.Launch(&pj); err != nil {
+			return err
+		}
+
+	}
+	return nil
+}
+
 func init() {
 	customTriggerCommand := os.Getenv(customerTriggerCommandEnvVar)
 	if customTriggerCommand != "" {

pkg/triggerconfig/inrepo/load_triggers.go

@@ -95,6 +95,8 @@ func mergeConfigs(m map[string]*triggerconfig.Config) (*triggerconfig.Config, er
 	// lets check for duplicates
 	presubmitNames := map[string]string{}
 	postsubmitNames := map[string]string{}
+	periodicNames := map[string]string{}
+	deploymentNames := map[string]string{}
 	for file, cfg := range m {
 		for _, ps := range cfg.Spec.Presubmits {
 			name := ps.Name
@@ -114,6 +116,24 @@ func mergeConfigs(m map[string]*triggerconfig.Config) (*triggerconfig.Config, er
 				return nil, errors.Errorf("duplicate postsubmit %s in file %s and %s", name, otherFile, file)
 			}
 		}
+		for _, ps := range cfg.Spec.Periodics {
+			name := ps.Name
+			otherFile := periodicNames[name]
+			if otherFile == "" {
+				periodicNames[name] = file
+			} else {
+				return nil, errors.Errorf("duplicate periodic %s in file %s and %s", name, otherFile, file)
+			}
+		}
+		for _, ps := range cfg.Spec.Deployments {
+			name := ps.Name
+			otherFile := deploymentNames[name]
+			if otherFile == "" {
+				deploymentNames[name] = file
+			} else {
+				return nil, errors.Errorf("duplicate deployment %s in file %s and %s", name, otherFile, file)
+			}
+		}
 		answer = merge.CombineConfigs(answer, cfg)
 	}
 	if answer == nil {
@@ -193,6 +213,57 @@ func loadConfigFile(filePath string, fileBrowsers *filebrowser.FileBrowsers, fc
 			})
 		}
 	}
+	for i := range repoConfig.Spec.Deployments {
+		r := &repoConfig.Spec.Deployments[i]
+		sourcePath := r.SourcePath
+		if sourcePath != "" {
+			if r.Agent == "" {
+				r.Agent = job.TektonPipelineAgent
+			}
+			// lets load the local file data now as we have locked the git file system
+			data, err := loadLocalFile(dir, sourcePath, sha)
+			if err != nil {
+				return nil, err
+			}
+			r.SetPipelineLoader(func(base *job.Base) error {
+				err = loadJobBaseFromSourcePath(data, fileBrowsers, fc, cache, base, ownerName, repoName, sourcePath, sha)
+				if err != nil {
+					return errors.Wrapf(err, "failed to load source for deployment %s", r.Name)
+				}
+				r.Base = *base
+				if r.Agent == "" && r.PipelineRunSpec != nil {
+					r.Agent = job.TektonPipelineAgent
+				}
+				return nil
+			})
+		}
+	}
+	for i := range repoConfig.Spec.Periodics {
+		r := &repoConfig.Spec.Periodics[i]
+		sourcePath := r.SourcePath
+		if sourcePath != "" {
+			if r.Agent == "" {
+				r.Agent = job.TektonPipelineAgent
+			}
+			// lets load the local file data now as we have locked the git file system
+			data, err := loadLocalFile(dir, sourcePath, sha)
+			if err != nil {
+				return nil, err
+			}
+			r.SetPipelineLoader(func(base *job.Base) error {
+				err = loadJobBaseFromSourcePath(data, fileBrowsers, fc, cache, base, ownerName, repoName, sourcePath, sha)
+				if err != nil {
+					return errors.Wrapf(err, "failed to load source for periodic %s", r.Name)
+				}
+				r.Base = *base
+				if r.Agent == "" && r.PipelineRunSpec != nil {
+					r.Agent = job.TektonPipelineAgent
+				}
+				return nil
+			})
+		}
+	}
+
 	return repoConfig, nil
 }
 

pkg/triggerconfig/merge/combine.go

@@ -18,5 +18,11 @@ func CombineConfigs(a, b *triggerconfig.Config) *triggerconfig.Config {
 	for _, r := range b.Spec.Postsubmits {
 		a.Spec.Postsubmits = append(a.Spec.Postsubmits, r)
 	}
+	for _, r := range b.Spec.Periodics {
+		a.Spec.Periodics = append(a.Spec.Periodics, r)
+	}
+	for _, r := range b.Spec.Deployments {
+		a.Spec.Deployments = append(a.Spec.Deployments, r)
+	}
 	return a
 }

pkg/triggerconfig/merge/merge.go

@@ -64,6 +64,35 @@ func ConfigMerge(cfg *config.Config, pluginsCfg *plugins.Configuration, repoConf
 		}
 		cfg.Postsubmits[repoKey] = ps
 	}
+	if len(repoConfig.Spec.Periodics) > 0 {
+		cfg.Periodics = append(cfg.Periodics, repoConfig.Spec.Periodics...)
+	}
+	if len(repoConfig.Spec.Deployments) > 0 {
+		// lets make a new map to avoid concurrent modifications
+		m := map[string][]job.Deployment{}
+		if cfg.Deployments != nil {
+			for k, v := range cfg.Deployments {
+				m[k] = append([]job.Deployment{}, v...)
+			}
+		}
+		cfg.Deployments = m
+
+		ps := cfg.Deployments[repoKey]
+		for _, p := range repoConfig.Spec.Deployments {
+			found := false
+			for i := range ps {
+				pt2 := &ps[i]
+				if pt2.Name == p.Name {
+					ps[i] = p
+					found = true
+				}
+			}
+			if !found {
+				ps = append(ps, p)
+			}
+		}
+		cfg.Deployments[repoKey] = ps
+	}
 
 	// lets make sure we've got a trigger added
 	idx := len(pluginsCfg.Triggers) - 1

pkg/triggerconfig/types.go

@@ -23,6 +23,10 @@ type ConfigSpec struct {
 
 	// Postsubmit zero or more postsubmits
 	Postsubmits []job.Postsubmit `json:"postsubmits,omitempty"`
+
+	Periodics []job.Periodic `json:"periodics,omitempty"`
+
+	Deployments []job.Deployment `json:"deployments,omitempty"`
 }
 
 // ConfigList contains a list of Config

pkg/webhook/events.go

@@ -358,6 +358,36 @@ func (s *Server) handleReviewEvent(l *logrus.Entry, re scm.ReviewHook) {
 	}()
 }
 
+func (s *Server) handleDeploymentStatusEvent(l *logrus.Entry, ds scm.DeploymentStatusHook) {
+	l = l.WithFields(logrus.Fields{
+		scmprovider.OrgLogField:  ds.Repo.Namespace,
+		scmprovider.RepoLogField: ds.Repo.Name,
+	})
+	l.Infof("Deployment %s.", ds.Action)
+
+	// lets invoke the agent creation async as this can take a little while
+	go func() {
+		repo := ds.Repo
+		agent, err := s.CreateAgent(l, repo.Namespace, repo.Name, ds.Deployment.Sha)
+		if err != nil {
+			agent.Logger.WithError(err).Error("Error creating agent for DeploymentStatusEvent.")
+			return
+		}
+		for p, h := range s.getPlugins(ds.Repo.Namespace, ds.Repo.Name) {
+			if h.DeploymentStatusHandler != nil {
+				s.wg.Add(1)
+				go func(p string, h plugins.DeploymentStatusHandler) {
+					defer s.wg.Done()
+					if err := h(agent, ds); err != nil {
+						agent.Logger.WithError(err).Error("Error handling ReviewEvent.")
+					}
+				}(p, h.DeploymentStatusHandler)
+			}
+		}
+	}()
+
+}
+
 func (s *Server) reportErrorToPullRequest(l *logrus.Entry, agent plugins.Agent, repo scm.Repository, pr *scm.PullRequestHook, err error) {
 	fileLink := repo.Link + "/blob/" + pr.PullRequest.Sha + "/"
 	message := "failed to trigger Pull Request pipeline\n" + util.ErrorToMarkdown(err, fileLink)