feat(cli): adds pr event (#177)

Author: jmgilman

cli/pkg/events/events.go

@@ -5,6 +5,7 @@ import (
 
 	"cuelang.org/go/cue"
 	"github.com/input-output-hk/catalyst-forge/lib/project/project"
+	"github.com/input-output-hk/catalyst-forge/lib/providers/github"
 )
 
 //go:generate go run github.com/matryer/moq@latest -pkg mocks -out mocks/handler.go . EventHandler
@@ -15,6 +16,7 @@ type EventType string
 const (
 	AlwaysEventName EventType = "always"
 	MergeEventName  EventType = "merge"
+	PREventName     EventType = "pr"
 	TagEventName    EventType = "tag"
 )
 
@@ -63,13 +65,22 @@ func (r *DefaultEventHandler) Firing(p *project.Project, events map[string]cue.V
 
 // NewDefaultEventHandler returns a new default event handler.
 func NewDefaultEventHandler(logger *slog.Logger) DefaultEventHandler {
+	// This should never error
+	gc, err := github.NewDefaultGithubClient("", "")
+	if err != nil {
+		panic(err)
+	}
+
 	return DefaultEventHandler{
 		logger: logger,
 		store: map[EventType]Event{
 			AlwaysEventName: &AlwaysEvent{},
 			MergeEventName: &MergeEvent{
 				logger: logger,
 			},
+			PREventName: &PREvent{
+				gc: gc,
+			},
 			TagEventName: &TagEvent{
 				logger: logger,
 			},

cli/pkg/events/pr.go

@@ -0,0 +1,20 @@
+package events
+
+import (
+	"cuelang.org/go/cue"
+	"github.com/input-output-hk/catalyst-forge/lib/project/project"
+	"github.com/input-output-hk/catalyst-forge/lib/providers/github"
+)
+
+// PREvent fires when the current operation is within a PR.
+type PREvent struct {
+	gc github.GithubClient
+}
+
+func (m *PREvent) Firing(p *project.Project, config cue.Value) (bool, error) {
+	if m.gc.Env().IsPR() {
+		return true, nil
+	}
+
+	return false, nil
+}

cli/pkg/events/pr_test.go

@@ -0,0 +1,52 @@
+package events
+
+import (
+	"testing"
+
+	"cuelang.org/go/cue"
+	"github.com/input-output-hk/catalyst-forge/lib/providers/github"
+	gm "github.com/input-output-hk/catalyst-forge/lib/providers/github/mocks"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestPREventFiring(t *testing.T) {
+	tests := []struct {
+		name     string
+		inPR     bool
+		expected bool
+	}{
+		{
+			name:     "firing on pr",
+			inPR:     true,
+			expected: true,
+		},
+		{
+			name:     "not firing on pr",
+			inPR:     false,
+			expected: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			em := gm.GithubEnvMock{
+				IsPRFunc: func() bool {
+					return tt.inPR
+				},
+			}
+			gc := gm.GithubClientMock{
+				EnvFunc: func() github.GithubEnv {
+					return &em
+				},
+			}
+
+			event := PREvent{
+				gc: &gc,
+			}
+			firing, err := event.Firing(nil, cue.Value{})
+			require.NoError(t, err)
+			assert.Equal(t, tt.expected, firing)
+		})
+	}
+}

docs/blueprint.cue

@@ -4,7 +4,8 @@ project: {
 	release: {
 		docs: {
 			on: {
-				always: {}
+				merge: {}
+				pr: {}
 			}
 
 			config: {