[Test Improver] Add unit tests for addReleaseNotesNotification utility - #41
Draft
github-actions[bot] wants to merge 1 commit into
Draft
[Test Improver] Add unit tests for addReleaseNotesNotification utility#41github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
11 tests covering all branches in addReleaseNotesNotification: - dispatches notifications/add when not found and not previously read - skips notifications/add when current version already exists in store - skips notifications/add when version already read via preference - dispatches notifications/remove for older release-notes notification - dispatches both remove and add for correct transition - skips add when version was read even after removing old notification - ignores non-release-notes notifications (no remove, still adds) - verifies full notification structure (level, preference, primaryAction) - strips pre-release suffix from version string (e.g. 2.11.0-rc1 → 2.11.0) - handles co-existing old and current version notifications - makes no dispatch calls when list empty and version already read Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
26 tasks
21 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🤖 Test Improver — automated AI assistant
Goal and Rationale
shell/utils/release-notes.tscontainsaddReleaseNotesNotification, an async function that manages "What's New" release-note notifications in the Rancher Notification Centre. It had zero test coverage despite containing several meaningful branches:found = truelastReadVersion === rancherVersionnotifications/removefor stale entries2.11.0-rc1→2.11.0via.split('-')[0]Approach
shell/utils/__tests__/release-notes.test.ts(11 tests)getVersionDataandREAD_WHATS_NEW; all other collaborators (getters, dispatch) are inline mocks — no Vuex store mounting neededCoverage Impact
Before:
release-notes.tshad 0% unit test coverage.After: All conditional branches in
addReleaseNotesNotificationare exercised by the 11 tests.Trade-offs
dispatchis mocked asjest.fn().mockResolvedValue(undefined)— no real Vuex store overheadi18n/tmock returns the translation key as-is; tests only assert structure, not translated stringsReproducibility
Test Status
✅ 11/11 tests pass
✅
eslint --max-warnings 0passesWarning
Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
download.cypress.ioSee Network Configuration for more information.