feat: Add plan webhook support

server/controllers/events/events_controller_e2e_test.go

@@ -1691,7 +1691,7 @@ func (m *mockLockURLGenerator) GenerateLockURL(_ string) string {
 
 type mockWebhookSender struct{}
 
-func (w *mockWebhookSender) Send(_ logging.SimpleLogging, _ webhooks.ApplyResult) error {
+func (w *mockWebhookSender) Send(_ logging.SimpleLogging, _ webhooks.EventResult) error {
 	return nil
 }
 

server/events/project_command_runner.go

@@ -109,7 +109,7 @@ type MultiEnvStepRunner interface {
 // WebhooksSender sends webhook.
 type WebhooksSender interface {
 	// Send sends the webhook.
-	Send(log logging.SimpleLogging, res webhooks.ApplyResult) error
+	Send(log logging.SimpleLogging, res webhooks.EventResult) error
 }
 
 //go:generate pegomock generate --package mocks -o mocks/mock_project_command_runner.go ProjectCommandRunner
@@ -610,6 +610,21 @@ func (p *DefaultProjectCommandRunner) doPlan(ctx command.ProjectContext) (*model
 
 	outputs, err := p.runSteps(ctx.Steps, ctx, projAbsPath)
 
+	webhookSendErr := p.Webhooks.Send(ctx.Log, webhooks.EventResult{ // nolint: errcheck
+		Event:       webhooks.PlanEvent,
+		Workspace:   ctx.Workspace,
+		User:        ctx.User,
+		Repo:        ctx.Pull.BaseRepo,
+		Pull:        ctx.Pull,
+		Success:     err == nil,
+		Directory:   ctx.RepoRelDir,
+		ProjectName: ctx.ProjectName,
+	})
+
+	if webhookSendErr != nil {
+		ctx.Log.Err("error sending plan webhook; %v", webhookSendErr)
+	}
+
 	if err != nil {
 		if unlockErr := lockAttempt.UnlockFn(); unlockErr != nil {
 			ctx.Log.Err("error unlocking state after plan error: %v", unlockErr)
@@ -668,7 +683,8 @@ func (p *DefaultProjectCommandRunner) doApply(ctx command.ProjectContext) (apply
 
 	outputs, err := p.runSteps(ctx.Steps, ctx, absPath)
 
-	p.Webhooks.Send(ctx.Log, webhooks.ApplyResult{ // nolint: errcheck
+	webhookSendErr := p.Webhooks.Send(ctx.Log, webhooks.EventResult{ // nolint: errcheck
+		Event:       webhooks.ApplyEvent,
 		Workspace:   ctx.Workspace,
 		User:        ctx.User,
 		Repo:        ctx.Pull.BaseRepo,
@@ -678,6 +694,10 @@ func (p *DefaultProjectCommandRunner) doApply(ctx command.ProjectContext) (apply
 		ProjectName: ctx.ProjectName,
 	})
 
+	if webhookSendErr != nil {
+		ctx.Log.Err("error sending apply webhook; %v", webhookSendErr)
+	}
+
 	if err != nil {
 		return "", "", fmt.Errorf("%s\n%s", err, strings.Join(outputs, "\n"))
 	}

server/events/webhooks/http.go

@@ -21,18 +21,18 @@ type HttpWebhook struct {
 }
 
 // Send sends the webhook to URL if workspace and branch matches their respective regex.
-func (h *HttpWebhook) Send(_ logging.SimpleLogging, applyResult ApplyResult) error {
-	if !h.WorkspaceRegex.MatchString(applyResult.Workspace) || !h.BranchRegex.MatchString(applyResult.Pull.BaseBranch) {
+func (h *HttpWebhook) Send(_ logging.SimpleLogging, eventResult EventResult) error {
+	if !h.WorkspaceRegex.MatchString(eventResult.Workspace) || !h.BranchRegex.MatchString(eventResult.Pull.BaseBranch) {
 		return nil
 	}
-	if err := h.doSend(applyResult); err != nil {
+	if err := h.doSend(eventResult); err != nil {
 		return errors.Wrap(err, fmt.Sprintf("sending webhook to %q", h.URL))
 	}
 	return nil
 }
 
-func (h *HttpWebhook) doSend(applyResult ApplyResult) error {
-	body, err := json.Marshal(applyResult)
+func (h *HttpWebhook) doSend(eventResult EventResult) error {
+	body, err := json.Marshal(eventResult)
 	if err != nil {
 		return err
 	}

server/events/webhooks/http_test.go

@@ -12,7 +12,8 @@ import (
 	. "github.com/runatlantis/atlantis/testing"
 )
 
-var httpApplyResult = webhooks.ApplyResult{
+var httpApplyResult = webhooks.EventResult{
+	Event:     "apply",
 	Workspace: "production",
 	Repo: models.Repo{
 		FullName: "runatlantis/atlantis",

server/events/webhooks/slack.go

@@ -43,9 +43,9 @@ func NewSlack(wr *regexp.Regexp, br *regexp.Regexp, channel string, client Slack
 }
 
 // Send sends the webhook to Slack if workspace and branch matches their respective regex.
-func (s *SlackWebhook) Send(_ logging.SimpleLogging, applyResult ApplyResult) error {
-	if !s.WorkspaceRegex.MatchString(applyResult.Workspace) || !s.BranchRegex.MatchString(applyResult.Pull.BaseBranch) {
+func (s *SlackWebhook) Send(_ logging.SimpleLogging, eventResult EventResult) error {
+	if !s.WorkspaceRegex.MatchString(eventResult.Workspace) || !s.BranchRegex.MatchString(eventResult.Pull.BaseBranch) {
 		return nil
 	}
-	return s.Client.PostMessage(s.Channel, applyResult)
+	return s.Client.PostMessage(s.Channel, eventResult)
 }

server/events/webhooks/slack_client.go

@@ -15,6 +15,7 @@ package webhooks
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/slack-go/slack"
 )
@@ -30,7 +31,7 @@ const (
 type SlackClient interface {
 	AuthTest() error
 	TokenIsSet() bool
-	PostMessage(channel string, applyResult ApplyResult) error
+	PostMessage(channel string, eventResult EventResult) error
 }
 
 //go:generate pegomock generate --package mocks -o mocks/mock_underlying_slack_client.go UnderlyingSlackClient
@@ -64,8 +65,8 @@ func (d *DefaultSlackClient) TokenIsSet() bool {
 	return d.Token != ""
 }
 
-func (d *DefaultSlackClient) PostMessage(channel string, applyResult ApplyResult) error {
-	attachments := d.createAttachments(applyResult)
+func (d *DefaultSlackClient) PostMessage(channel string, eventResult EventResult) error {
+	attachments := d.createAttachments(eventResult)
 	_, _, err := d.Slack.PostMessage(
 		channel,
 		slack.MsgOptionAsUser(true),
@@ -75,19 +76,25 @@ func (d *DefaultSlackClient) PostMessage(channel string, applyResult ApplyResult
 	return err
 }
 
-func (d *DefaultSlackClient) createAttachments(applyResult ApplyResult) []slack.Attachment {
+func (d *DefaultSlackClient) createAttachments(eventResult EventResult) []slack.Attachment {
 	var colour string
 	var successWord string
-	if applyResult.Success {
+	if eventResult.Success {
 		colour = slackSuccessColour
 		successWord = "succeeded"
 	} else {
 		colour = slackFailureColour
 		successWord = "failed"
 	}
 
-	text := fmt.Sprintf("Apply %s for <%s|%s>", successWord, applyResult.Pull.URL, applyResult.Repo.FullName)
-	directory := applyResult.Directory
+	eventName := string(eventResult.Event)
+	if eventName == "" {
+		eventName = "event"
+	}
+	eventName = strings.ToUpper(eventName[:1]) + eventName[1:]
+	text := fmt.Sprintf("%s %s for <%s|%s>", eventName, successWord, eventResult.Pull.URL, eventResult.Repo.FullName)
+
+	directory := eventResult.Directory
 	// Since "." looks weird, replace it with "/" to make it clear this is the root.
 	if directory == "." {
 		directory = "/"
@@ -99,17 +106,17 @@ func (d *DefaultSlackClient) createAttachments(applyResult ApplyResult) []slack.
 		Fields: []slack.AttachmentField{
 			{
 				Title: "Workspace",
-				Value: applyResult.Workspace,
+				Value: eventResult.Workspace,
 				Short: true,
 			},
 			{
 				Title: "Branch",
-				Value: applyResult.Pull.BaseBranch,
+				Value: eventResult.Pull.BaseBranch,
 				Short: true,
 			},
 			{
 				Title: "User",
-				Value: applyResult.User.Username,
+				Value: eventResult.User.Username,
 				Short: true,
 			},
 			{

server/events/webhooks/slack_client_test.go

@@ -27,7 +27,7 @@ import (
 
 var underlying *mocks.MockUnderlyingSlackClient
 var client webhooks.DefaultSlackClient
-var result webhooks.ApplyResult
+var result webhooks.EventResult
 
 func TestAuthTest_Success(t *testing.T) {
 	t.Log("When the underlying client succeeds, function should succeed")
@@ -157,7 +157,7 @@ func setup(t *testing.T) {
 		Slack: underlying,
 		Token: "sometoken",
 	}
-	result = webhooks.ApplyResult{
+	result = webhooks.EventResult{
 		Workspace: "production",
 		Repo: models.Repo{
 			FullName: "runatlantis/atlantis",

server/events/webhooks/slack_test.go

@@ -39,7 +39,7 @@ func TestSend_PostMessage(t *testing.T) {
 		BranchRegex:    regex,
 		Channel:        channel,
 	}
-	result := webhooks.ApplyResult{
+	result := webhooks.EventResult{
 		Workspace: "production",
 		Pull: models.PullRequest{
 			BaseBranch: "main",
@@ -65,7 +65,7 @@ func TestSend_NoopSuccess(t *testing.T) {
 		BranchRegex:    regex,
 		Channel:        channel,
 	}
-	result := webhooks.ApplyResult{
+	result := webhooks.EventResult{
 		Workspace: "production",
 		Pull: models.PullRequest{
 			BaseBranch: "main",