chore: improve notification template tests' resilience #14196
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
johnstcn
approved these changes
Aug 7, 2024
coderd/database/migrations/000240_notification_workspace_updated_version_message.down.sql
Show resolved
Hide resolved
coderd/database/migrations/000240_notification_workspace_updated_version_message.up.sql
Show resolved
Hide resolved
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I added a nasty little func called
enumerateAllTemplateswhich enumerates all the notification templates defined incoderd/notifications/events.go. Using this, we can determine when we're missing test cases inTestNotificationTemplatesCanRender. I found two, and added those.This is obviously suboptimal as a strategy: we should be using code-generation and linting. I've covered this in coder/internal#36. In the interim, let's not let the perfect get in the way of better test coverage.
Additionally, this adds the template update message to the
TemplateWorkspaceAutoUpdatedtemplate so users will be informed of what changed when their template was auto-updated.