Skip to content

feat: add tool to send a test notification #16611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Feb 19, 2025
Merged

feat: add tool to send a test notification #16611

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
53d6975
chore: begin impl of test notification
DanielleMaywood Feb 11, 2025
879cdd1
chore: remove frontend logic
DanielleMaywood Feb 13, 2025
13567ff
chore: bump migration number, add cli cmd
DanielleMaywood Feb 18, 2025
27e9765
chore: add golden file tests
DanielleMaywood Feb 18, 2025
fc49ec4
chore: add tests
DanielleMaywood Feb 18, 2025
4a2ec9b
chore: add cli tests
DanielleMaywood Feb 18, 2025
a74d3f7
chore: fix lint, add action
DanielleMaywood Feb 18, 2025
1a2d1ea
chore: update golden files
DanielleMaywood Feb 18, 2025
f75f822
chore: add description
DanielleMaywood Feb 19, 2025
2316e96
chore: run 'make gen'
DanielleMaywood Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: add tests
  • Loading branch information
@DanielleMaywood
DanielleMaywood committed Feb 18, 2025
commit fc49ec4b6b971e982dc3fc39404b388ab5711d84
54 changes: 54 additions & 0 deletions coderd/notifications_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/notifications"
"github.com/coder/coder/v2/coderd/notifications/notificationstest"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/testutil"
)
Expand Down Expand Up @@ -317,3 +318,56 @@ func TestNotificationDispatchMethods(t *testing.T) {
})
}
}

func TestNotificationTest(t *testing.T) {
t.Parallel()

t.Run("OwnerCanSendTestNotification", func(t *testing.T) {
t.Parallel()

ctx := testutil.Context(t, testutil.WaitShort)

notifyEnq := &notificationstest.FakeEnqueuer{}
ownerClient := coderdtest.New(t, &coderdtest.Options{
DeploymentValues: coderdtest.DeploymentValues(t),
NotificationsEnqueuer: notifyEnq,
})

// Given: A user with owner permissions.
_ = coderdtest.CreateFirstUser(t, ownerClient)

// When: They attempt to send a test notification.
err := ownerClient.PostTestNotification(ctx)
require.NoError(t, err)

// Then: We expect a notification to have been sent.
sent := notifyEnq.Sent(notificationstest.WithTemplateID(notifications.TemplateTestNotification))
require.Len(t, sent, 1)
})

t.Run("MemberCannotSendTestNotification", func(t *testing.T) {
ctx := testutil.Context(t, testutil.WaitShort)

notifyEnq := &notificationstest.FakeEnqueuer{}
ownerClient := coderdtest.New(t, &coderdtest.Options{
DeploymentValues: coderdtest.DeploymentValues(t),
NotificationsEnqueuer: notifyEnq,
})

// Given: A user without owner permissions.
ownerUser := coderdtest.CreateFirstUser(t, ownerClient)
memberClient, _ := coderdtest.CreateAnotherUser(t, ownerClient, ownerUser.OrganizationID)

// When: They attempt to send a test notification.
err := memberClient.PostTestNotification(ctx)

// Then: We expect a forbidden error with no notifications sent
var sdkError *codersdk.Error
require.Error(t, err)
require.ErrorAsf(t, err, &sdkError, "error should be of type *codersdk.Error")
require.Equal(t, http.StatusForbidden, sdkError.StatusCode())

sent := notifyEnq.Sent(notificationstest.WithTemplateID(notifications.TemplateTestNotification))
require.Len(t, sent, 0)
})
}