rename filter to files and add issue title condition

Author: bivas

README.md

@@ -102,11 +102,16 @@ rules:
           - label2
         skip-if-labeled:
           - label3
-        filter:
+        files:
           patterns: 
             - "docs/.*"
           extensions: 
             - ".go"
+        title:
+          starts-with: "BUGFIX"
+          ends-with: "WIP"
+          patterns:
+            - ".* Bug( )?[0-9]{5} .*"
         order: 5
       commenter:
         comment: "We have a match!"
@@ -118,9 +123,13 @@ rules:
 The entire `condition` section is optional - you can run all rules all the time and see if it helps :smile:
 - `if-labeled` - apply the rule if the issue has any of the provided labels
 - `skip-if-labeled` - skip rule processing if issue has any of the provided labels
-- `filter`
+- `files`
   - `patterns` - [pattern](https://golang.org/s/re2syntax) matching the pull request file list (any of the patterns)
   - `extensions` - which file extension to match on pull request file list (must start with a dot [`.`])
+- `title`
+  - `starts-with` - issue title has a prefix
+  - `ends-with` - issue title has a suffix
+  - `patterns` - [pattern](https://golang.org/s/re2syntax) matching issue title (any of the patterns)
 - `order` - apply order hint to a rule. All rules are given order index **0**. 
 **Important**: This will not place a rule in the exact position, but can assist in re-order rules. 
 
@@ -166,7 +175,7 @@ rules:
 
   docs:
         condition:
-          filter:
+          files:
             patterns: 
               - "docs/.*"
         labeler:

bot/condition.go

@@ -4,16 +4,22 @@ import (
 	"github.com/bivas/rivi/util"
 	"github.com/spf13/viper"
 	"regexp"
+	"strings"
 )
 
 type Condition struct {
 	Order         int      `mapstructure:"order,omitempty"`
 	IfLabeled     []string `mapstructure:"if-labeled,omitempty"`
 	SkipIfLabeled []string `mapstructure:"skip-if-labeled,omitempty"`
-	Filter        struct {
+	Files         struct {
 		Patterns   []string `mapstructure:"patterns,omitempty"`
 		Extensions []string `mapstructure:"extensions,omitempty"`
-	} `mapstructure:"filter,omitempty"`
+	} `mapstructure:"files,omitempty"`
+	Title struct {
+		StartsWith string   `mapstructure:"starts-with,omitempty"`
+		EndsWith   string   `mapstructure:"ends-with,omitempty"`
+		Patterns   []string `mapstructure:"patterns,omitempty"`
+	} `mapstructure:"title,omitempty"`
 }
 
 func (c *Condition) checkIfLabeled(meta EventData) bool {
@@ -32,11 +38,11 @@ func (c *Condition) checkIfLabeled(meta EventData) bool {
 }
 
 func (c *Condition) checkPattern(meta EventData) bool {
-	if len(c.Filter.Patterns) == 0 {
+	if len(c.Files.Patterns) == 0 {
 		return false
 	} else {
 		compiled := make([]*regexp.Regexp, 0)
-		for _, pattern := range c.Filter.Patterns {
+		for _, pattern := range c.Files.Patterns {
 			re, err := regexp.Compile(pattern)
 			if err != nil {
 				util.Logger.Warning("Unable to compile regex '%s'. %s", pattern, err)
@@ -60,11 +66,11 @@ func (c *Condition) checkPattern(meta EventData) bool {
 }
 
 func (c *Condition) checkExt(meta EventData) bool {
-	if len(c.Filter.Extensions) == 0 {
+	if len(c.Files.Extensions) == 0 {
 		return false
 	} else {
 		for _, check := range meta.GetFileExtensions() {
-			for _, ext := range c.Filter.Extensions {
+			for _, ext := range c.Files.Extensions {
 				if ext == check {
 					return true
 				}
@@ -74,12 +80,54 @@ func (c *Condition) checkExt(meta EventData) bool {
 	return false
 }
 
+func (c *Condition) checkTitle(meta EventData) bool {
+	titleCondition := c.Title
+	if titleCondition.StartsWith == "" && titleCondition.EndsWith == "" && len(titleCondition.Patterns) == 0 {
+		return false
+	} else {
+		title := meta.GetTitle()
+		if titleCondition.StartsWith != "" && strings.HasPrefix(title, titleCondition.StartsWith) {
+			return true
+		}
+		if titleCondition.EndsWith != "" && strings.HasSuffix(title, titleCondition.EndsWith) {
+			return true
+		}
+		if len(titleCondition.Patterns) > 0 {
+			compiled := make([]*regexp.Regexp, 0)
+			for _, pattern := range titleCondition.Patterns {
+				re, err := regexp.Compile(pattern)
+				if err != nil {
+					util.Logger.Warning("Unable to compile regex '%s'. %s", pattern, err)
+					continue
+				}
+				compiled = append(compiled, re)
+			}
+			if len(compiled) == 0 {
+				util.Logger.Error("All configured patterns have failed to compile")
+				return false
+			}
+			for _, reg := range compiled {
+				if reg.MatchString(title) {
+					return true
+				}
+			}
+		}
+	}
+	return false
+}
+
+func (c *Condition) checkFiles(meta EventData) bool {
+	return c.checkPattern(meta) || c.checkExt(meta)
+}
+
 func (c *Condition) checkAllEmpty(meta EventData) bool {
-	return len(c.IfLabeled) == 0 && len(c.Filter.Patterns) == 0 && len(c.Filter.Extensions) == 0
+	return len(c.IfLabeled) == 0 &&
+		len(c.Files.Patterns) == 0 && len(c.Files.Extensions) == 0 &&
+		c.Title.StartsWith == "" && c.Title.EndsWith == "" && len(c.Title.Patterns) == 0
 }
 
 func (c *Condition) Match(meta EventData) bool {
-	match := c.checkAllEmpty(meta) || c.checkIfLabeled(meta) || c.checkPattern(meta) || c.checkExt(meta)
+	match := c.checkAllEmpty(meta) || c.checkIfLabeled(meta) || c.checkTitle(meta) || c.checkFiles(meta)
 
 	if match {
 		for _, check := range c.SkipIfLabeled {

bot/condition_test.go

@@ -156,6 +156,35 @@ func TestMatchExt(t *testing.T) {
 	assert.True(t, matched, "matched")
 }
 
+func TestTitleStartsWith(t *testing.T) {
+	var rule rule
+	rule.condition.Title.StartsWith = "BUGFIX"
+	meta := &mockConditionEventData{Title: "NOT A BUGFIX"}
+	assert.False(t, rule.Accept(meta), "shouldn't match")
+	meta.Title = "BUGFIX it"
+	assert.True(t, rule.Accept(meta), "should match")
+}
+
+func TestTitleEndsWith(t *testing.T) {
+	var rule rule
+	rule.condition.Title.EndsWith = "WIP"
+	meta := &mockConditionEventData{Title: "NOT A BUGFIX"}
+	assert.False(t, rule.Accept(meta), "shouldn't match")
+	meta.Title = "BUGFIX WIP"
+	assert.True(t, rule.Accept(meta), "should match")
+}
+
+func TestTitlePattern(t *testing.T) {
+	var rule rule
+	rule.condition.Title.Patterns = []string{".* Bug( )?[0-9]{5} .*"}
+	meta := &mockConditionEventData{Title: "NOT A BUGFIX"}
+	assert.False(t, rule.Accept(meta), "shouldn't match")
+	meta.Title = "This PR for Bug1 with comment"
+	assert.False(t, rule.Accept(meta), "shouldn't match")
+	meta.Title = "This PR for Bug 45456 with comment"
+	assert.True(t, rule.Accept(meta), "should match")
+}
+
 func TestMatchEmptyCondition(t *testing.T) {
 	meta := &mockConditionEventData{}
 	rule := rule{condition: Condition{}}

bot/config_test.yml

@@ -29,11 +29,11 @@ rules:
   rule3:
       condition:
         order: 1
-        filter:
+        files:
           extensions:
             - ".go"
   rule4:
       condition:
-        filter:
+        files:
           patterns:
             - ".*/docs/.*"

bot/empty_config_test.yml

@@ -24,11 +24,11 @@ rules:
   rule3:
       condition:
         order: 1
-        filter:
+        files:
           extensions:
             - ".go"
   rule4:
       condition:
-        filter:
+        files:
           patterns:
             - ".*/docs/.*"