feat(rulesets): add support for PR labeled events (#361)

* Add support for PR label event

1. Add new action to the Pull struct
2. Update constants to reflect new event for the integer mask
3. Update YAML package to add new label rule
4. Update ruleset matching logic

* Update test files related to PR event

* Add support for PR unlabeled event

1. Add new action to the Pull struct
2. Update constants to reflect new event for the integer mask
3. Update YAML package to add new unlabeled rule
4. Update tests

* Extend label rule to include other PR events

* Fix linter warning

---------

Co-authored-by: Easton Crupper <65553218+ecrupper@users.noreply.github.com>
Co-authored-by: dave vader <48764154+plyr4@users.noreply.github.com>

constants/action.go

@@ -22,6 +22,12 @@ const (
 	// ActionSynchronize defines the action for the synchronizing of pull requests.
 	ActionSynchronize = "synchronize"
 
+	// ActionLabeled defines the action for the labeling of pull requests.
+	ActionLabeled = "labeled"
+
+	// ActionUnlabeled defines the action for the unlabeling of pull requests.
+	ActionUnlabeled = "unlabeled"
+
 	// ActionTransferred defines the action for transferring repository ownership.
 	ActionTransferred = "transferred"
 

constants/allow_events.go

@@ -11,7 +11,7 @@ const (
 	AllowPullSync
 	_ // AllowPullAssigned - Not Implemented
 	_ // AllowPullMilestoned - Not Implemented
-	_ // AllowPullLabel - Not Implemented
+	AllowPullLabel
 	_ // AllowPullLocked - Not Implemented
 	_ // AllowPullReady - Not Implemented
 	AllowPullReopen
@@ -23,4 +23,5 @@ const (
 	AllowSchedule
 	AllowPushDeleteBranch
 	AllowPushDeleteTag
+	AllowPullUnlabel
 )

library/actions/pull.go

@@ -12,6 +12,8 @@ type Pull struct {
 	Edited      *bool `json:"edited"`
 	Synchronize *bool `json:"synchronize"`
 	Reopened    *bool `json:"reopened"`
+	Labeled     *bool `json:"labeled"`
+	Unlabeled   *bool `json:"unlabeled"`
 }
 
 // FromMask returns the Pull type resulting from the provided integer mask.
@@ -20,6 +22,8 @@ func (a *Pull) FromMask(mask int64) *Pull {
 	a.SetSynchronize(mask&constants.AllowPullSync > 0)
 	a.SetEdited(mask&constants.AllowPullEdit > 0)
 	a.SetReopened(mask&constants.AllowPullReopen > 0)
+	a.SetLabeled(mask&constants.AllowPullLabel > 0)
+	a.SetUnlabeled(mask&constants.AllowPullUnlabel > 0)
 
 	return a
 }
@@ -44,6 +48,14 @@ func (a *Pull) ToMask() int64 {
 		mask = mask | constants.AllowPullReopen
 	}
 
+	if a.GetLabeled() {
+		mask = mask | constants.AllowPullLabel
+	}
+
+	if a.GetUnlabeled() {
+		mask = mask | constants.AllowPullUnlabel
+	}
+
 	return mask
 }
 
@@ -91,6 +103,28 @@ func (a *Pull) GetReopened() bool {
 	return *a.Reopened
 }
 
+// GetLabeled returns the Labeled field from the provided Pull. If the object is nil,
+// or the field within the object is nil, it returns the zero value instead.
+func (a *Pull) GetLabeled() bool {
+	// return zero value if Pull type or Labeled field is nil
+	if a == nil || a.Labeled == nil {
+		return false
+	}
+
+	return *a.Labeled
+}
+
+// GetUnlabeled returns the Unlabeled field from the provided Pull. If the object is nil,
+// or the field within the object is nil, it returns the zero value instead.
+func (a *Pull) GetUnlabeled() bool {
+	// return zero value if Pull type or Unlabeled field is nil
+	if a == nil || a.Unlabeled == nil {
+		return false
+	}
+
+	return *a.Unlabeled
+}
+
 // SetOpened sets the Pull Opened field.
 //
 // When the provided Pull type is nil, it
@@ -142,3 +176,29 @@ func (a *Pull) SetReopened(v bool) {
 
 	a.Reopened = &v
 }
+
+// SetLabeled sets the Pull Labeled field.
+//
+// When the provided Pull type is nil, it
+// will set nothing and immediately return.
+func (a *Pull) SetLabeled(v bool) {
+	// return if Pull type is nil
+	if a == nil {
+		return
+	}
+
+	a.Labeled = &v
+}
+
+// SetUnlabeled sets the Pull Unlabeled field.
+//
+// When the provided Pull type is nil, it
+// will set nothing and immediately return.
+func (a *Pull) SetUnlabeled(v bool) {
+	// return if Pull type is nil
+	if a == nil {
+		return
+	}
+
+	a.Unlabeled = &v
+}

library/actions/pull_test.go

@@ -42,6 +42,14 @@ func TestLibrary_Pull_Getters(t *testing.T) {
 		if test.actions.GetReopened() != test.want.GetReopened() {
 			t.Errorf("GetReopened is %v, want %v", test.actions.GetReopened(), test.want.GetReopened())
 		}
+
+		if test.actions.GetLabeled() != test.want.GetLabeled() {
+			t.Errorf("GetLabeled is %v, want %v", test.actions.GetLabeled(), test.want.GetLabeled())
+		}
+
+		if test.actions.GetUnlabeled() != test.want.GetUnlabeled() {
+			t.Errorf("GetUnlabeled is %v, want %v", test.actions.GetUnlabeled(), test.want.GetUnlabeled())
+		}
 	}
 }
 
@@ -70,6 +78,8 @@ func TestLibrary_Pull_Setters(t *testing.T) {
 		test.actions.SetSynchronize(test.want.GetSynchronize())
 		test.actions.SetEdited(test.want.GetEdited())
 		test.actions.SetReopened(test.want.GetReopened())
+		test.actions.SetLabeled(test.want.GetLabeled())
+		test.actions.SetUnlabeled(test.want.GetUnlabeled())
 
 		if test.actions.GetOpened() != test.want.GetOpened() {
 			t.Errorf("SetOpened is %v, want %v", test.actions.GetOpened(), test.want.GetOpened())
@@ -86,6 +96,14 @@ func TestLibrary_Pull_Setters(t *testing.T) {
 		if test.actions.GetReopened() != test.want.GetReopened() {
 			t.Errorf("SetReopened is %v, want %v", test.actions.GetReopened(), test.want.GetReopened())
 		}
+
+		if test.actions.GetLabeled() != test.want.GetLabeled() {
+			t.Errorf("SetLabeled is %v, want %v", test.actions.GetLabeled(), test.want.GetLabeled())
+		}
+
+		if test.actions.GetUnlabeled() != test.want.GetUnlabeled() {
+			t.Errorf("SetUnlabeled is %v, want %v", test.actions.GetUnlabeled(), test.want.GetUnlabeled())
+		}
 	}
 }
 
@@ -107,7 +125,7 @@ func TestLibrary_Pull_ToMask(t *testing.T) {
 	// setup types
 	actions := testPull()
 
-	want := int64(constants.AllowPullOpen | constants.AllowPullSync | constants.AllowPullReopen)
+	want := int64(constants.AllowPullOpen | constants.AllowPullSync | constants.AllowPullReopen | constants.AllowPullUnlabel)
 
 	// run test
 	got := actions.ToMask()
@@ -123,6 +141,8 @@ func testPull() *Pull {
 	pr.SetSynchronize(true)
 	pr.SetEdited(false)
 	pr.SetReopened(true)
+	pr.SetLabeled(false)
+	pr.SetUnlabeled(true)
 
 	return pr
 }

library/actions/push_test.go

@@ -128,6 +128,7 @@ func testMask() int64 {
 			constants.AllowPullOpen |
 			constants.AllowPullSync |
 			constants.AllowPullReopen |
+			constants.AllowPullUnlabel |
 			constants.AllowDeployCreate |
 			constants.AllowCommentCreate |
 			constants.AllowSchedule,

library/events.go

@@ -68,6 +68,10 @@ func NewEventsFromSlice(events []string) *Events {
 			mask = mask | constants.AllowPullSync
 		case constants.EventPull + ":" + constants.ActionReopened:
 			mask = mask | constants.AllowPullReopen
+		case constants.EventPull + ":" + constants.ActionLabeled:
+			mask = mask | constants.AllowPullLabel
+		case constants.EventPull + ":" + constants.ActionUnlabeled:
+			mask = mask | constants.AllowPullUnlabel
 
 		// deployment actions
 		case constants.EventDeploy, constants.EventDeployAlternate, constants.EventDeploy + ":" + constants.ActionCreated:
@@ -111,6 +115,10 @@ func (e *Events) Allowed(event, action string) bool {
 		allowed = e.GetPullRequest().GetEdited()
 	case constants.EventPull + ":" + constants.ActionReopened:
 		allowed = e.GetPullRequest().GetReopened()
+	case constants.EventPull + ":" + constants.ActionLabeled:
+		allowed = e.GetPullRequest().GetLabeled()
+	case constants.EventPull + ":" + constants.ActionUnlabeled:
+		allowed = e.GetPullRequest().GetUnlabeled()
 	case constants.EventTag:
 		allowed = e.GetPush().GetTag()
 	case constants.EventComment + ":" + constants.ActionCreated:
@@ -155,6 +163,14 @@ func (e *Events) List() []string {
 		eventSlice = append(eventSlice, constants.EventPull+":"+constants.ActionReopened)
 	}
 
+	if e.GetPullRequest().GetLabeled() {
+		eventSlice = append(eventSlice, constants.EventPull+":"+constants.ActionLabeled)
+	}
+
+	if e.GetPullRequest().GetUnlabeled() {
+		eventSlice = append(eventSlice, constants.EventPull+":"+constants.ActionUnlabeled)
+	}
+
 	if e.GetPush().GetTag() {
 		eventSlice = append(eventSlice, constants.EventTag)
 	}

library/events_test.go

@@ -122,6 +122,7 @@ func TestLibrary_Events_List(t *testing.T) {
 		"pull_request:opened",
 		"pull_request:synchronize",
 		"pull_request:reopened",
+		"pull_request:unlabeled",
 		"tag",
 		"comment:created",
 		"schedule",
@@ -130,6 +131,7 @@ func TestLibrary_Events_List(t *testing.T) {
 
 	wantTwo := []string{
 		"pull_request:edited",
+		"pull_request:labeled",
 		"deployment",
 		"comment:edited",
 		"delete:tag",
@@ -158,6 +160,7 @@ func TestLibrary_Events_NewEventsFromMask_ToDatabase(t *testing.T) {
 			constants.AllowPullOpen |
 			constants.AllowPullSync |
 			constants.AllowPullReopen |
+			constants.AllowPullUnlabel |
 			constants.AllowCommentCreate |
 			constants.AllowSchedule,
 	)
@@ -166,6 +169,7 @@ func TestLibrary_Events_NewEventsFromMask_ToDatabase(t *testing.T) {
 		constants.AllowPushDeleteTag |
 			constants.AllowPullEdit |
 			constants.AllowCommentEdit |
+			constants.AllowPullLabel |
 			constants.AllowDeployCreate,
 	)
 
@@ -209,12 +213,12 @@ func Test_NewEventsFromSlice(t *testing.T) {
 	}{
 		{
 			name:   "action specific events to e1",
-			events: []string{"push:branch", "push:tag", "delete:branch", "pull_request:opened", "pull_request:synchronize", "pull_request:reopened", "comment:created", "schedule:run"},
+			events: []string{"push:branch", "push:tag", "delete:branch", "pull_request:opened", "pull_request:synchronize", "pull_request:reopened", "comment:created", "schedule:run", "pull_request:unlabeled"},
 			want:   e1,
 		},
 		{
 			name:   "action specific events to e2",
-			events: []string{"delete:tag", "pull_request:edited", "deployment:created", "comment:edited"},
+			events: []string{"delete:tag", "pull_request:edited", "deployment:created", "comment:edited", "pull_request:labeled"},
 			want:   e2,
 		},
 		{
@@ -232,6 +236,8 @@ func Test_NewEventsFromSlice(t *testing.T) {
 					Reopened:    &tBool,
 					Edited:      &fBool,
 					Synchronize: &tBool,
+					Labeled:     &fBool,
+					Unlabeled:   &fBool,
 				},
 				Deployment: &actions.Deploy{
 					Created: &tBool,
@@ -260,6 +266,8 @@ func Test_NewEventsFromSlice(t *testing.T) {
 					Reopened:    &tBool,
 					Edited:      &fBool,
 					Synchronize: &tBool,
+					Labeled:     &fBool,
+					Unlabeled:   &fBool,
 				},
 				Deployment: &actions.Deploy{
 					Created: &fBool,
@@ -306,6 +314,8 @@ func TestLibrary_Events_Allowed(t *testing.T) {
 		{event: "pull_request", action: "synchronize", want: true},
 		{event: "pull_request", action: "edited", want: false},
 		{event: "pull_request", action: "reopened", want: true},
+		{event: "pull_request", action: "labeled", want: false},
+		{event: "pull_request", action: "unlabeled", want: true},
 		{event: "deployment", want: false},
 		{event: "comment", action: "created", want: true},
 		{event: "comment", action: "edited", want: false},
@@ -345,6 +355,8 @@ func testEvents() (*Events, *Events) {
 			Synchronize: &tBool,
 			Edited:      &fBool,
 			Reopened:    &tBool,
+			Labeled:     &fBool,
+			Unlabeled:   &tBool,
 		},
 		Deployment: &actions.Deploy{
 			Created: &fBool,
@@ -370,6 +382,8 @@ func testEvents() (*Events, *Events) {
 			Synchronize: &fBool,
 			Edited:      &tBool,
 			Reopened:    &fBool,
+			Labeled:     &tBool,
+			Unlabeled:   &fBool,
 		},
 		Deployment: &actions.Deploy{
 			Created: &tBool,

library/repo_test.go

@@ -15,7 +15,7 @@ func TestLibrary_Repo_Environment(t *testing.T) {
 	// setup types
 	want := map[string]string{
 		"VELA_REPO_ACTIVE":        "true",
-		"VELA_REPO_ALLOW_EVENTS":  "push,pull_request:opened,pull_request:synchronize,pull_request:reopened,tag,comment:created,schedule,delete:branch",
+		"VELA_REPO_ALLOW_EVENTS":  "push,pull_request:opened,pull_request:synchronize,pull_request:reopened,pull_request:unlabeled,tag,comment:created,schedule,delete:branch",
 		"VELA_REPO_BRANCH":        "main",
 		"VELA_REPO_TOPICS":        "cloud,security",
 		"VELA_REPO_BUILD_LIMIT":   "10",
@@ -31,7 +31,7 @@ func TestLibrary_Repo_Environment(t *testing.T) {
 		"VELA_REPO_PIPELINE_TYPE": "",
 		"VELA_REPO_APPROVE_BUILD": "never",
 		"REPOSITORY_ACTIVE":       "true",
-		"REPOSITORY_ALLOW_EVENTS": "push,pull_request:opened,pull_request:synchronize,pull_request:reopened,tag,comment:created,schedule,delete:branch",
+		"REPOSITORY_ALLOW_EVENTS": "push,pull_request:opened,pull_request:synchronize,pull_request:reopened,pull_request:unlabeled,tag,comment:created,schedule,delete:branch",
 		"REPOSITORY_BRANCH":       "main",
 		"REPOSITORY_CLONE":        "https://github.com/github/octocat.git",
 		"REPOSITORY_FULL_NAME":    "github/octocat",