Compare commits

...
4 changed files with 41 additions and 5 deletions
+21
View File
@@ -22,6 +22,19 @@ const npmChange: Change = {
] ]
} }
const actionsChange: Change = {
manifest: 'workflow.yml',
change_type: 'added',
ecosystem: 'actions',
name: 'actions/checkout/',
version: 'v3',
package_url: 'pkg:githubactions/actions@v3',
license: 'MIT',
source_repository_url: 'null',
scope: 'runtime',
vulnerabilities: []
}
test('Get scorecard from API', async () => { test('Get scorecard from API', async () => {
const changes: Changes = [npmChange] const changes: Changes = [npmChange]
const scorecard = await getScorecardLevels(changes) const scorecard = await getScorecardLevels(changes)
@@ -38,3 +51,11 @@ test('Get project URL from deps.dev API', async () => {
) )
expect(result).not.toBeNull() expect(result).not.toBeNull()
}) })
test('Handles Actions special case', async () => {
const changes: Changes = [actionsChange]
const result = await getScorecardLevels(changes)
expect(result).not.toBeNull()
expect(result.dependencies).toHaveLength(1)
expect(result.dependencies[0].scorecard?.score).toBeGreaterThan(0)
})
Generated Vendored
+9 -2
View File
@@ -1043,8 +1043,15 @@ function getScorecardLevels(changes) {
if (repositoryUrl === null || repositoryUrl === void 0 ? void 0 : repositoryUrl.startsWith('https://')) { if (repositoryUrl === null || repositoryUrl === void 0 ? void 0 : repositoryUrl.startsWith('https://')) {
repositoryUrl = repositoryUrl.replace('https://', ''); repositoryUrl = repositoryUrl.replace('https://', '');
} }
// Handle the special case for GitHub Actions, where the repository URL is null
if (ecosystem === 'actions') {
// The package name for GitHub Actions in the API is in the format `owner/repo/`, so we can use that to get the repository URL
// If the package name has more than 2 slashes, it's referencing a sub-action, and we need to strip the last part out
const parts = packageName.split('/');
repositoryUrl = `github.com/${parts[0]}/${parts[1]}`; // e.g. github.com/actions/checkout
}
// If GitHub API doesn't have the repository URL, query deps.dev for it. // If GitHub API doesn't have the repository URL, query deps.dev for it.
if (repositoryUrl) { if (!repositoryUrl) {
// Call the deps.dev API to get the repository URL from there // Call the deps.dev API to get the repository URL from there
repositoryUrl = yield getProjectUrl(ecosystem, packageName, version); repositoryUrl = yield getProjectUrl(ecosystem, packageName, version);
} }
@@ -1069,7 +1076,7 @@ function getScorecardLevels(changes) {
exports.getScorecardLevels = getScorecardLevels; exports.getScorecardLevels = getScorecardLevels;
function getScorecard(repositoryUrl) { function getScorecard(repositoryUrl) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
const apiRoot = 'https://api.securityscorecards.dev/'; const apiRoot = 'https://api.securityscorecards.dev';
let scorecardResponse = {}; let scorecardResponse = {};
const url = `${apiRoot}/projects/${repositoryUrl}`; const url = `${apiRoot}/projects/${repositoryUrl}`;
const response = yield fetch(url); const response = yield fetch(url);
Generated Vendored
+1 -1
View File
File diff suppressed because one or more lines are too long
+10 -2
View File
@@ -17,8 +17,16 @@ export async function getScorecardLevels(
repositoryUrl = repositoryUrl.replace('https://', '') repositoryUrl = repositoryUrl.replace('https://', '')
} }
// Handle the special case for GitHub Actions, where the repository URL is null
if (ecosystem === 'actions') {
// The package name for GitHub Actions in the API is in the format `owner/repo/`, so we can use that to get the repository URL
// If the package name has more than 2 slashes, it's referencing a sub-action, and we need to strip the last part out
const parts = packageName.split('/')
repositoryUrl = `github.com/${parts[0]}/${parts[1]}` // e.g. github.com/actions/checkout
}
// If GitHub API doesn't have the repository URL, query deps.dev for it. // If GitHub API doesn't have the repository URL, query deps.dev for it.
if (repositoryUrl) { if (!repositoryUrl) {
// Call the deps.dev API to get the repository URL from there // Call the deps.dev API to get the repository URL from there
repositoryUrl = await getProjectUrl(ecosystem, packageName, version) repositoryUrl = await getProjectUrl(ecosystem, packageName, version)
} }
@@ -41,7 +49,7 @@ export async function getScorecardLevels(
} }
async function getScorecard(repositoryUrl: string): Promise<ScorecardApi> { async function getScorecard(repositoryUrl: string): Promise<ScorecardApi> {
const apiRoot = 'https://api.securityscorecards.dev/' const apiRoot = 'https://api.securityscorecards.dev'
let scorecardResponse: ScorecardApi = {} as ScorecardApi let scorecardResponse: ScorecardApi = {} as ScorecardApi
const url = `${apiRoot}/projects/${repositoryUrl}` const url = `${apiRoot}/projects/${repositoryUrl}`