report the resolved commit when a ref is downloaded without a SHA

On the REST API fallback, a ref given without a SHA (a branch or tag of
another repository, or the default branch) left the commit output empty: the
archive was downloaded by ref and nothing recorded which commit that was.

downloadRepository now resolves the ref to its commit first
(GET /repos/{owner}/{repo}/commits/{ref} with the sha media type), downloads
that commit, and returns its SHA, which getSource sets as the output. The
downloaded content and the reported SHA are the same commit even if the ref
moves meanwhile. If the ref cannot be resolved, the download falls back to
the ref as before, a warning is logged, and the output stays empty.
This commit is contained in:
askalf 2026-09-28 15:38:49 -04:00
parent 56a41f36e5
commit dbd3a6024b
5 changed files with 170 additions and 13 deletions

View file

@ -35,7 +35,11 @@ jest.unstable_mockModule('../src/git-command-manager.js', () => ({
MinimumGitSparseCheckoutVersion: '2.28'
}))
const mockDownloadRepository = jest.fn()
// downloadRepository returns the commit it downloaded: the one requested, or the one the ref resolved to.
const resolvedCommitSha = 'abcdefabcdefabcdefabcdefabcdefabcdefabcd'
const mockDownloadRepository = jest.fn(
async (...args: any[]) => (args[4] as string) || resolvedCommitSha
)
jest.unstable_mockModule('../src/github-api-helper.js', () => ({
downloadRepository: mockDownloadRepository,
getDefaultBranch: jest.fn(async () => 'refs/heads/main'),
@ -160,7 +164,7 @@ describe('git-source-provider tests', () => {
expect(mockSetOutput).toHaveBeenCalledWith('commit', commitSha)
})
it('sets the commit output when downloading using the REST API without a commit', async () => {
it('sets the commit output to the resolved commit when downloading using the REST API without a commit', async () => {
// Arrange
mockCreateCommandManager.mockImplementation(async () => {
throw new Error('Git is not installed')
@ -173,10 +177,10 @@ describe('git-source-provider tests', () => {
// Assert
expect(mockDownloadRepository).toHaveBeenCalled()
expect(mockSetOutput).toHaveBeenCalledWith('commit', '')
expect(mockSetOutput).toHaveBeenCalledWith('commit', resolvedCommitSha)
})
it('sets an empty commit output when downloading a ref that is not a SHA', async () => {
it('sets the commit output to the resolved commit when downloading a ref that is not a SHA', async () => {
// Arrange
mockCreateCommandManager.mockImplementation(async () => {
throw new Error('Git is not installed')
@ -190,7 +194,7 @@ describe('git-source-provider tests', () => {
// Assert
expect(mockDownloadRepository).toHaveBeenCalled()
expect(mockSetOutput).toHaveBeenCalledWith('commit', undefined)
expect(mockSetOutput).toHaveBeenCalledWith('commit', resolvedCommitSha)
})
it('sets the commit output when downloading a SHA-256 object format repository', async () => {

View file

@ -2,10 +2,11 @@ import {jest, describe, it, expect, beforeEach, afterEach} from '@jest/globals'
// Mock @actions/core
const mockDebug = jest.fn()
const mockWarning = jest.fn()
jest.unstable_mockModule('@actions/core', () => ({
debug: mockDebug,
info: jest.fn(),
warning: jest.fn(),
warning: mockWarning,
error: jest.fn()
}))
@ -15,6 +16,11 @@ jest.unstable_mockModule('@actions/github', () => ({
getOctokit: mockGetOctokit
}))
// Run retried actions once, so a failing lookup does not wait out the backoff
jest.unstable_mockModule('../src/retry-helper.js', () => ({
execute: async (action: () => Promise<unknown>) => await action()
}))
// Dynamic imports after mocking
const githubApiHelper = await import('../src/github-api-helper.js')
@ -110,3 +116,74 @@ describe('github-api-helper object format', () => {
)
})
})
describe('github-api-helper commit resolution', () => {
const sha1 = '0123456789abcdef0123456789abcdef01234567'
const sha256 =
'0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef'
let request: jest.Mock<any>
function mockCommitApi(data: unknown): void {
request = jest.fn(async () => ({data}))
mockGetOctokit.mockReturnValue({request} as any)
}
afterEach(() => {
jest.clearAllMocks()
})
it('resolves a ref to the SHA of its commit', async () => {
mockCommitApi(`${sha1}\n`)
await expect(
githubApiHelper.tryGetCommitSha(
'token',
'owner',
'repo',
'refs/heads/dev'
)
).resolves.toBe(sha1)
expect(request).toHaveBeenCalledWith(
'GET /repos/{owner}/{repo}/commits/{ref}',
{
owner: 'owner',
repo: 'repo',
ref: 'refs/heads/dev',
headers: {accept: 'application/vnd.github.sha'}
}
)
})
it('resolves a ref in a SHA-256 repository', async () => {
mockCommitApi(sha256)
await expect(
githubApiHelper.tryGetCommitSha('token', 'owner', 'repo', 'v1.0.0')
).resolves.toBe(sha256)
})
it('returns an empty string and warns when the response is not a SHA', async () => {
mockCommitApi('<html>not a sha</html>')
await expect(
githubApiHelper.tryGetCommitSha('token', 'owner', 'repo', 'main')
).resolves.toBe('')
expect(mockWarning).toHaveBeenCalledWith(
expect.stringContaining("Unable to resolve the commit for 'main'")
)
})
it('returns an empty string and warns when the lookup fails', async () => {
request = jest.fn(async () => {
throw new Error('Not Found')
})
mockGetOctokit.mockReturnValue({request} as any)
await expect(
githubApiHelper.tryGetCommitSha('token', 'owner', 'repo', 'gone')
).resolves.toBe('')
expect(mockWarning).toHaveBeenCalledWith(
"Unable to resolve the commit for 'gone': Not Found"
)
})
})