Add support for pipeline root.when conditions

pipeline/frontend/yaml/compiler/compiler.go

@@ -81,6 +81,14 @@ func New(opts ...Option) *Compiler {
 func (c *Compiler) Compile(conf *yaml.Config) *backend.Config {
 	config := new(backend.Config)
 
+	if !conf.Constraints.Match(c.metadata) {
+		// basically dont do nothing. No need to run in this case.
+		// This would also remove this item from the UI
+		// which seems to be as the case for each of the container
+		// contraints.
+		return config
+	}
+
 	// create a default volume
 	config.Volumes = append(config.Volumes, &backend.Volume{
 		Name:   fmt.Sprintf("%s_default", c.prefix),

pipeline/frontend/yaml/config.go

@@ -10,19 +10,21 @@ import (
 type (
 	// Config defines a pipeline configuration.
 	Config struct {
-		Cache     types.Stringorslice
-		Platform  string
-		Branches  constraint.List
-		Workspace Workspace
-		Clone     Containers
-		Pipeline  Containers
-		Services  Containers
-		Networks  Networks
-		Volumes   Volumes
-		Labels    types.SliceorMap
-		DependsOn []string `yaml:"depends_on,omitempty"`
-		RunsOn    []string `yaml:"runs_on,omitempty"`
-		SkipClone bool     `yaml:"skip_clone"`
+		// TODO: change to When (also in Pipeline)
+		Constraints constraint.Constraints `yaml:"when,omitempty"`
+		Cache       types.Stringorslice
+		Platform    string
+		Branches    constraint.List
+		Workspace   Workspace
+		Clone       Containers
+		Pipeline    Containers
+		Services    Containers
+		Networks    Networks
+		Volumes     Volumes
+		Labels      types.SliceorMap
+		DependsOn   []string `yaml:"depends_on,omitempty"`
+		RunsOn      []string `yaml:"runs_on,omitempty"`
+		SkipClone   bool     `yaml:"skip_clone"`
 	}
 
 	// Workspace defines a pipeline workspace.

pipeline/frontend/yaml/config_test.go

@@ -19,6 +19,8 @@ func TestParse(t *testing.T) {
 					g.Fail(err)
 				}
 
+				g.Assert(out.Constraints.Event.Match("push")).Equal(true)
+
 				g.Assert(out.Workspace.Base).Equal("/go")
 				g.Assert(out.Workspace.Path).Equal("src/github.com/octocat/hello-world")
 				g.Assert(out.Volumes.Volumes[0].Name).Equal("custom")
@@ -72,6 +74,9 @@ func TestParse(t *testing.T) {
 
 var sampleYaml = `
 image: hello-world
+when:
+  event: 
+    - push
 build:
   context: .
   dockerfile: Dockerfile

server/api/hook.go

@@ -186,23 +186,23 @@ func PostHook(c *gin.Context) {
 		return
 	}
 
-	filtered, err := branchFiltered(build, remoteYamlConfigs)
+	filtered, err := checkIfFiltered(build, remoteYamlConfigs)
 	if err != nil {
 		msg := "failure to parse yaml from hook"
-		log.Debug().Err(err).Str("repo", repo.FullName).Msg(msg)
+		log.Info().Err(err).Str("repo", repo.FullName).Msg(msg)
 		c.String(http.StatusBadRequest, msg)
 		return
 	}
 	if filtered {
-		msg := "ignoring hook: branch does not match restrictions defined in yaml"
-		log.Debug().Str("repo", repo.FullName).Msg(msg)
+		msg := "ignoring hook: branch/event does not match restrictions defined in (any) yaml"
+		log.Info().Str("repo", repo.FullName).Msg(msg)
 		c.String(http.StatusOK, msg)
 		return
 	}
 
 	if zeroSteps(build, remoteYamlConfigs) {
 		msg := "ignoring hook: step conditions yield zero runnable steps"
-		log.Debug().Str("repo", repo.FullName).Msg(msg)
+		log.Info().Str("repo", repo.FullName).Msg(msg)
 		c.String(http.StatusOK, msg)
 		return
 	}
@@ -269,7 +269,7 @@ func PostHook(c *gin.Context) {
 }
 
 // TODO: parse yaml once and not for each filter function
-func branchFiltered(build *model.Build, remoteYamlConfigs []*remote.FileMeta) (bool, error) {
+func checkIfFiltered(build *model.Build, remoteYamlConfigs []*remote.FileMeta) (bool, error) {
 	log.Trace().Msgf("hook.branchFiltered(): build branch: '%s' build event: '%s' config count: %d", build.Branch, build.Event, len(remoteYamlConfigs))
 
 	if build.Event == model.EventTag || build.Event == model.EventDeploy {
@@ -284,11 +284,26 @@ func branchFiltered(build *model.Build, remoteYamlConfigs []*remote.FileMeta) (b
 		}
 		log.Trace().Msgf("config '%s': %#v", remoteYamlConfig.Name, parsedPipelineConfig)
 
-		if parsedPipelineConfig.Branches.Match(build.Branch) {
-			return false, nil
+		// if was filtered by the constraints (event) continue
+		if !parsedPipelineConfig.Constraints.Event.Match(string(build.Event)) {
+			continue
+		}
+
+		// if was filtered by the constraints (branch) continue
+		if !parsedPipelineConfig.Constraints.Branch.Match(build.Branch) {
+			continue
+		}
+
+		// if was filtered by the branch (legacy) continue
+		if !parsedPipelineConfig.Branches.Match(build.Branch) {
+			continue
 		}
+
+		// at least one config yielded in a valid run.
+		return false, nil
 	}
 
+	// no configs yielded a valid run.
 	return true, nil
 }
 

server/shared/procBuilder.go

@@ -106,6 +106,12 @@ func (b *ProcBuilder) Build() ([]*BuildItem, error) {
 				return nil, err
 			}
 
+			// checking if filtered.
+			if !parsed.Constraints.Match((metadata)) {
+				proc.State = model.StatusSkipped
+			}
+
+			// legacy check.
 			if !parsed.Branches.Match(b.Curr.Branch) && (b.Curr.Event != model.EventDeploy && b.Curr.Event != model.EventTag) {
 				proc.State = model.StatusSkipped
 			}

server/shared/procBuilder_test.go

@@ -256,6 +256,52 @@ pipeline:
 	}
 }
 
+func TestRootWhenFilter(t *testing.T) {
+	t.Parallel()
+
+	b := ProcBuilder{
+		Repo:  &model.Repo{},
+		Curr:  &model.Build{Event: "tester"},
+		Last:  &model.Build{},
+		Netrc: &model.Netrc{},
+		Secs:  []*model.Secret{},
+		Regs:  []*model.Registry{},
+		Link:  "",
+		Yamls: []*remote.FileMeta{
+			{Data: []byte(`
+when:
+  event:
+    - tester
+pipeline:
+  xxx:
+    image: scratch
+`)},
+			{Data: []byte(`
+when:
+  event:
+    - push
+pipeline:
+  xxx:
+    image: scratch
+`)},
+			{Data: []byte(`
+pipeline:
+  build:
+    image: scratch
+`)},
+		},
+	}
+
+	buildItems, err := b.Build()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	if len(buildItems) != 2 {
+		t.Fatal("Should have generated 2 buildItems")
+	}
+}
+
 func TestZeroSteps(t *testing.T) {
 	t.Parallel()