Skip to content

feat: add template delete notification #14250

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 13 commits into from
Aug 14, 2024
Merged

feat: add template delete notification #14250

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5915daa
feat: add template delete notification
BrunoQuaresma Aug 12, 2024
76ee1f6
Merge branch 'main' of https://github.com/coder/coder into bq/notify-…
BrunoQuaresma Aug 13, 2024
1f7046c
Notify all template admins
BrunoQuaresma Aug 13, 2024
30faf4f
Apply Dannys suggestions
BrunoQuaresma Aug 13, 2024
1e11cb7
Fix lint
BrunoQuaresma Aug 13, 2024
99c1950
Merge branch 'main' of https://github.com/coder/coder into bq/notify-…
BrunoQuaresma Aug 13, 2024
be31ed8
Fix migration
BrunoQuaresma Aug 13, 2024
9e6462d
Merge branch 'main' of https://github.com/coder/coder into bq/notify-…
BrunoQuaresma Aug 14, 2024
7fb0fa2
Improve tests
BrunoQuaresma Aug 14, 2024
92c11de
Filter delete notifications
BrunoQuaresma Aug 14, 2024
450235e
Improve test
BrunoQuaresma Aug 14, 2024
eaf87c5
Fix test
BrunoQuaresma Aug 14, 2024
4688765
Add missing can render test
BrunoQuaresma Aug 14, 2024
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
Filter delete notifications
  • Loading branch information
@BrunoQuaresma
BrunoQuaresma committed Aug 14, 2024
commit 92c11deb5e777557e15577c48b54e5bb57343294
20 changes: 13 additions & 7 deletions coderd/templates_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1359,13 +1359,19 @@ func TestTemplateNotifications(t *testing.T) {
// Then: verify that the notification is sent to the correct user
// (template admin) and targets, using the appropriate labels. Note that
// the owner, being the initiator, will not receive the notification.
require.Len(t, notifyEnq.Sent, 1)
require.Contains(t, notifyEnq.Sent[0].TemplateID, notifications.TemplateTemplateDeleted)
require.Contains(t, notifyEnq.Sent[0].UserID, templateAdmin.ID)
require.Contains(t, notifyEnq.Sent[0].Targets, template.ID)
require.Contains(t, notifyEnq.Sent[0].Targets, template.OrganizationID)
require.Equal(t, notifyEnq.Sent[0].Labels["name"], template.Name)
require.Equal(t, notifyEnq.Sent[0].Labels["initiator"], coderdtest.FirstUserParams.Username)
deleteNotifications := make([]*testutil.Notification, 0)
for _, n := range notifyEnq.Sent {
if n.TemplateID == notifications.TemplateTemplateDeleted {
deleteNotifications = append(deleteNotifications, n)
}
}
require.Len(t, deleteNotifications, 1)
require.Contains(t, deleteNotifications[0].TemplateID, notifications.TemplateTemplateDeleted)
require.Contains(t, deleteNotifications[0].UserID, templateAdmin.ID)
require.Contains(t, deleteNotifications[0].Targets, template.ID)
require.Contains(t, deleteNotifications[0].Targets, template.OrganizationID)
require.Equal(t, deleteNotifications[0].Labels["name"], template.Name)
require.Equal(t, deleteNotifications[0].Labels["initiator"], coderdtest.FirstUserParams.Username)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you could simplify this to show that the notification is not received at all in this test if there's only one owner.
In the other test you're checking for exactly the same thing.
Tests should validate one (or as close to one) aspect of business logic at a time, IMHO.

})

t.Run("OnlyNotifyOwnersAndTemplateAdmins", func(t *testing.T) {
Expand Down
Loading