import * as core from '@actions/core' import {ConfigurationOptions, Changes, Change, Scorecard} from './schemas' import {SummaryTableRow} from '@actions/core/lib/summary' import {InvalidLicenseChanges, InvalidLicenseChangeTypes} from './licenses' import {groupDependenciesByManifest, getManifestsSet, renderUrl} from './utils' const icons = { check: '✅', cross: '❌', warning: '⚠️' } export function addSummaryToSummary( vulnerableChanges: Changes, invalidLicenseChanges: InvalidLicenseChanges, deniedChanges: Changes, scorecard: Scorecard, config: ConfigurationOptions ): void { const scorecardWarnings = countScorecardWarnings(scorecard, config) const licenseIssues = countLicenseIssues(invalidLicenseChanges) core.summary.addHeading('Dependency Review', 1) if ( vulnerableChanges.length === 0 && licenseIssues === 0 && deniedChanges.length === 0 && scorecardWarnings === 0 ) { const issueTypes = [ config.vulnerability_check ? 'vulnerabilities' : '', config.license_check ? 'license issues' : '', config.show_openssf_scorecard ? 'OpenSSF Scorecard issues' : '' ] if (issueTypes.filter(Boolean).length === 0) { core.summary.addRaw(`${icons.check} No issues found.`) } else { core.summary.addRaw( `${icons.check} No ${issueTypes.filter(Boolean).join(' or ')} found.` ) } return } core.summary .addRaw('The following issues were found:') .addList([ ...(config.vulnerability_check ? [ `${checkOrFailIcon(vulnerableChanges.length)} ${ vulnerableChanges.length } vulnerable package(s)` ] : []), ...(config.license_check ? [ `${checkOrFailIcon(invalidLicenseChanges.forbidden.length)} ${ invalidLicenseChanges.forbidden.length } package(s) with incompatible licenses`, `${checkOrFailIcon(invalidLicenseChanges.unresolved.length)} ${ invalidLicenseChanges.unresolved.length } package(s) with invalid SPDX license definitions`, `${checkOrWarnIcon(invalidLicenseChanges.unlicensed.length)} ${ invalidLicenseChanges.unlicensed.length } package(s) with unknown licenses.` ] : []), ...(deniedChanges.length > 0 ? [ `${checkOrWarnIcon(deniedChanges.length)} ${ deniedChanges.length } package(s) denied.` ] : []), ...(config.show_openssf_scorecard && scorecardWarnings > 0 ? [ `${checkOrWarnIcon(scorecardWarnings)} ${scorecardWarnings ? scorecardWarnings : 'No'} packages with OpenSSF Scorecard issues.` ] : []) ]) .addRaw('See the Details below.') } function countScorecardWarnings( scorecard: Scorecard, config: ConfigurationOptions ): number { return scorecard.dependencies.reduce( (total, dependency) => total + (dependency.scorecard?.score && dependency.scorecard?.score < config.warn_on_openssf_scorecard_level ? 1 : 0), 0 ) } export function addChangeVulnerabilitiesToSummary( vulnerableChanges: Changes, severity: string ): void { if (vulnerableChanges.length === 0) { return } const rows: SummaryTableRow[] = [] const manifests = getManifestsSet(vulnerableChanges) core.summary.addHeading('Vulnerabilities', 2) for (const manifest of manifests) { for (const change of vulnerableChanges.filter( pkg => pkg.manifest === manifest )) { let previous_package = '' let previous_version = '' for (const vuln of change.vulnerabilities) { const sameAsPrevious = previous_package === change.name && previous_version === change.version if (!sameAsPrevious) { rows.push([ renderUrl(change.source_repository_url, change.name), change.version, renderUrl(vuln.advisory_url, vuln.advisory_summary), vuln.severity ]) } else { rows.push([ {data: '', colspan: '2'}, renderUrl(vuln.advisory_url, vuln.advisory_summary), vuln.severity ]) } previous_package = change.name previous_version = change.version } } core.summary.addHeading(`${manifest}`, 4).addTable([ [ {data: 'Name', header: true}, {data: 'Version', header: true}, {data: 'Vulnerability', header: true}, {data: 'Severity', header: true} ], ...rows ]) } if (severity !== 'low') { core.summary.addQuote( `Only included vulnerabilities with severity ${severity} or higher.` ) } } export function addLicensesToSummary( invalidLicenseChanges: InvalidLicenseChanges, config: ConfigurationOptions ): void { if (countLicenseIssues(invalidLicenseChanges) === 0) { return } core.summary.addHeading('License Issues', 2) printLicenseViolations(invalidLicenseChanges) if (config.allow_licenses && config.allow_licenses.length > 0) { core.summary.addQuote( `Allowed Licenses: ${config.allow_licenses.join(', ')}` ) } if (config.deny_licenses && config.deny_licenses.length > 0) { core.summary.addQuote( `Denied Licenses: ${config.deny_licenses.join(', ')}` ) } if (config.allow_dependencies_licenses) { core.summary.addQuote( `Excluded from license check: ${config.allow_dependencies_licenses.join( ', ' )}` ) } core.debug( `found ${invalidLicenseChanges.unlicensed.length} unknown licenses` ) core.debug( `${invalidLicenseChanges.unresolved.length} licenses could not be validated` ) } const licenseIssueTypes: InvalidLicenseChangeTypes[] = [ 'forbidden', 'unresolved', 'unlicensed' ] const issueTypeNames: Record = { forbidden: 'Incompatible License', unresolved: 'Invalid SPDX License', unlicensed: 'Unknown License' } function printLicenseViolations(changes: InvalidLicenseChanges): void { const rowsGroupedByManifest: Record = {} for (const issueType of licenseIssueTypes) { for (const change of changes[issueType]) { if (!rowsGroupedByManifest[change.manifest]) { rowsGroupedByManifest[change.manifest] = [] } rowsGroupedByManifest[change.manifest].push([ renderUrl(change.source_repository_url, change.name), change.version, formatLicense(change.license), issueTypeNames[issueType] ]) } } for (const [manifest, rows] of Object.entries(rowsGroupedByManifest)) { core.summary.addHeading(`${manifest}`, 4) core.summary.addTable([ ['Package', 'Version', 'License', 'Issue Type'], ...rows ]) } } function formatLicense(license: string | null): string { if (license === null || license === 'NOASSERTION') { return 'Null' } return license } export function addScannedDependencies(changes: Changes): void { const dependencies = groupDependenciesByManifest(changes) const manifests = dependencies.keys() const summary = core.summary.addHeading('Scanned Manifest Files', 2) for (const manifest of manifests) { const deps = dependencies.get(manifest) if (deps) { const dependencyNames = deps.map( dependency => `
  • ${dependency.name}@${dependency.version}
  • ` ) summary.addDetails(manifest, ``) } } } function snapshotWarningRecommendation( config: ConfigurationOptions, warnings: string ): string { const no_pr_snaps = warnings.includes( 'No snapshots were found for the head SHA' ) const retries_disabled = !config.retry_on_snapshot_warnings if (no_pr_snaps && retries_disabled) { return 'Ensure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings.' } else if (no_pr_snaps) { return 'Ensure that dependencies are being submitted on PR branches. Re-running this action after a short time may resolve the issue.' } else if (retries_disabled) { return 'Consider enabling retry-on-snapshot-warnings.' } return 'Re-running this action after a short time may resolve the issue.' } export function addScorecardToSummary( scorecard: Scorecard, config: ConfigurationOptions ): void { core.summary.addHeading('OpenSSF Scorecard', 2) if (scorecard.dependencies.length > 10) { core.summary.addRaw(`
    Scorecard details`, true) } core.summary.addRaw( ``, true ) for (const dependency of scorecard.dependencies) { core.debug('Adding scorecard to summary') core.debug(`Overall score ${dependency.scorecard?.score}`) // Set the icon based on the overall score value let overallIcon = '' if (dependency.scorecard?.score) { overallIcon = dependency.scorecard?.score < config.warn_on_openssf_scorecard_level ? ':warning:' : ':green_circle:' } //Add a row for the dependency core.summary.addRaw( ``, false ) //Add details table in the last column if (dependency.scorecard?.checks !== undefined) { let detailsTable = '
    PackageVersionScoreDetails
    ${dependency.change.source_repository_url ? `` : ''} ${dependency.change.ecosystem}/${dependency.change.name} ${dependency.change.source_repository_url ? `` : ''}${dependency.change.version} ${overallIcon} ${dependency.scorecard?.score === undefined || dependency.scorecard?.score === null ? 'Unknown' : dependency.scorecard?.score}
    ' for (const check of dependency.scorecard?.checks || []) { const icon = parseFloat(check.score) < config.warn_on_openssf_scorecard_level ? ':warning:' : ':green_circle:' detailsTable += `` } detailsTable += `
    CheckScoreReason
    ${check.name}${icon} ${check.score}${check.reason}
    ` core.summary.addRaw( `
    Details${detailsTable}
    `, true ) } else { core.summary.addRaw('Unknown', true) } } core.summary.addRaw(``) if (scorecard.dependencies.length > 10) { core.summary.addRaw(`
    `) } } export function addSnapshotWarnings( config: ConfigurationOptions, warnings: string ): void { core.summary.addHeading('Snapshot Warnings', 2) core.summary.addQuote(`${icons.warning}: ${warnings}`) const recommendation = snapshotWarningRecommendation(config, warnings) const docsLink = 'See the documentation for more information and troubleshooting advice.' core.summary.addRaw(`${recommendation} ${docsLink}`) } function countLicenseIssues( invalidLicenseChanges: InvalidLicenseChanges ): number { return Object.values(invalidLicenseChanges).reduce( (acc, val) => acc + val.length, 0 ) } export function addDeniedToSummary(deniedChanges: Change[]): void { if (deniedChanges.length === 0) { return } core.summary.addHeading('Denied dependencies', 2) for (const change of deniedChanges) { core.summary.addHeading(`Denied dependencies`, 4) core.summary.addTable([ ['Package', 'Version', 'License'], [ renderUrl(change.source_repository_url, change.name), change.version, change.license || '' ] ]) } } function checkOrFailIcon(count: number): string { return count === 0 ? icons.check : icons.cross } function checkOrWarnIcon(count: number): string { return count === 0 ? icons.check : icons.warning }