-
Notifications
You must be signed in to change notification settings - Fork 127
update: drop number of vulnerabilities on --pre-release #1080
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.
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
Open
RafaelGSS
wants to merge
2
commits into
main
Choose a base branch
from
drop-vuln-number-prerelease
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+267
−21
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| import { describe, it } from 'node:test'; | ||
| import assert from 'node:assert'; | ||
|
|
||
| import SecurityBlog from '../../lib/security_blog.js'; | ||
| import { | ||
| getHighestSeverity, | ||
| getHighestSeverityAnnouncement | ||
| } from '../../lib/security-release/security-release.js'; | ||
|
|
||
| const cli = { | ||
| error() {} | ||
| }; | ||
|
|
||
| function assertExits(fn) { | ||
| const originalExit = process.exit; | ||
| process.exit = () => { | ||
| throw new Error('process.exit'); | ||
| }; | ||
|
|
||
| try { | ||
| assert.throws(fn, /process\.exit/); | ||
| } finally { | ||
| process.exit = originalExit; | ||
| } | ||
| } | ||
|
|
||
| function report(id, rating, affectedVersions = ['24.x']) { | ||
| return { | ||
| id, | ||
| severity: { rating }, | ||
| affectedVersions | ||
| }; | ||
| } | ||
|
|
||
| describe('security_release: severity announcement', () => { | ||
| it('uses the highest severity across reports', () => { | ||
| const reports = [ | ||
| report(1, 'low'), | ||
| report(2, 'medium'), | ||
| report(3, 'high') | ||
| ]; | ||
|
|
||
| assert.strictEqual(getHighestSeverity(reports), 'HIGH'); | ||
| assert.strictEqual( | ||
| getHighestSeverityAnnouncement(reports), | ||
| 'The highest severity issue fixed in this release is HIGH.' | ||
| ); | ||
| }); | ||
|
|
||
| it('uses medium severity wording', () => { | ||
| const reports = [ | ||
| report(1, 'low'), | ||
| report(2, 'medium') | ||
| ]; | ||
|
|
||
| assert.strictEqual(getHighestSeverity(reports), 'MEDIUM'); | ||
| assert.strictEqual( | ||
| getHighestSeverityAnnouncement(reports), | ||
| 'The highest severity issue fixed in this release is MEDIUM.' | ||
| ); | ||
| }); | ||
|
|
||
| it('ignores invalid severity ratings', () => { | ||
| const reports = [ | ||
| report(1, 'low'), | ||
| report(2, 'hypercritical'), | ||
| report(3, 'medium') | ||
| ]; | ||
|
|
||
| assert.strictEqual(getHighestSeverity(reports), 'MEDIUM'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('security_blog: pre-release severity wording', () => { | ||
| it('does not include severity counts in the summary', () => { | ||
| const blog = new SecurityBlog(cli); | ||
| const content = { | ||
| reports: [ | ||
| report(1, 'low'), | ||
| report(2, 'medium') | ||
| ] | ||
| }; | ||
|
|
||
| assert.strictEqual( | ||
| blog.getPreReleaseVulnerabilities(content), | ||
| 'The highest severity issue fixed in this release is MEDIUM.' | ||
| ); | ||
| }); | ||
|
|
||
| it('uses the highest severity per release line in impact text', () => { | ||
| const blog = new SecurityBlog(cli); | ||
| const content = { | ||
| reports: [ | ||
| report(1, 'low', ['22.x', '20.x']), | ||
| report(2, 'medium', ['22.x']), | ||
| report(3, 'high', ['20.x']) | ||
| ] | ||
| }; | ||
|
|
||
| assert.strictEqual( | ||
| blog.getImpact(content), | ||
| 'The highest severity issue fixed in the 22.x release line is MEDIUM.\n' + | ||
| 'The highest severity issue fixed in the 20.x release line is HIGH.' | ||
| ); | ||
| }); | ||
|
|
||
| it('replaces the pre-release template placeholder with the highest severity sentence', () => { | ||
| const blog = new SecurityBlog(cli); | ||
| const template = blog.getSecurityPreReleaseTemplate(); | ||
| const preRelease = blog.buildPreRelease(template, { | ||
| annoucementDate: '2026-06-01T00:00:00.000Z', | ||
| releaseDate: 'Tuesday, June 2, 2026', | ||
| affectedVersions: '24.x, 22.x', | ||
| vulnerabilities: blog.getPreReleaseVulnerabilities({ | ||
| reports: [ | ||
| report(1, 'low'), | ||
| report(2, 'high') | ||
| ] | ||
| }), | ||
| slug: 'june-2026-security-releases', | ||
| impact: 'The highest severity issue fixed in the 24.x release line is HIGH.' | ||
| }); | ||
|
|
||
| assert.match( | ||
| preRelease, | ||
| /The highest severity issue fixed in this release is HIGH\./ | ||
| ); | ||
| assert.doesNotMatch(preRelease, /%VULNERABILITIES%/); | ||
| }); | ||
|
|
||
| it('exits when a report is missing a severity rating', () => { | ||
| const errors = []; | ||
| const blog = new SecurityBlog({ | ||
| error(message) { | ||
| errors.push(message); | ||
| } | ||
| }); | ||
| const content = { | ||
| reports: [ | ||
| { | ||
| id: 1, | ||
| severity: {}, | ||
| affectedVersions: ['24.x'] | ||
| } | ||
| ] | ||
| }; | ||
|
|
||
| assertExits(() => blog.getPreReleaseVulnerabilities(content)); | ||
| assertExits(() => blog.getImpact(content)); | ||
| assert.deepStrictEqual(errors, [ | ||
| 'severity.rating not found for report 1.', | ||
| 'severity.rating not found for report 1.' | ||
| ]); | ||
| }); | ||
| }); | ||
|
|
||
| describe('security_blog: post-release severity wording', () => { | ||
| it('keeps the vulnerability count list', () => { | ||
| const blog = new SecurityBlog(cli); | ||
| const content = { | ||
| reports: [ | ||
| report(1, 'low'), | ||
| report(2, 'medium'), | ||
| report(3, 'medium') | ||
| ] | ||
| }; | ||
|
|
||
| assert.strictEqual( | ||
| blog.getVulnerabilities(content), | ||
| '- 1 low severity issues.\n- 2 medium severity issues.' | ||
| ); | ||
| }); | ||
|
|
||
| it('exits when a report is missing a severity rating', () => { | ||
| const errors = []; | ||
| const blog = new SecurityBlog({ | ||
| error(message) { | ||
| errors.push(message); | ||
| } | ||
| }); | ||
| const content = { | ||
| reports: [ | ||
| { | ||
| id: 1, | ||
| severity: {}, | ||
| affectedVersions: ['24.x'] | ||
| } | ||
| ] | ||
| }; | ||
|
|
||
| assertExits(() => blog.getVulnerabilities(content)); | ||
| assert.deepStrictEqual(errors, [ | ||
| 'severity.rating not found for report 1.' | ||
| ]); | ||
| }); | ||
| }); |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.