mirror of
https://github.com/actions/checkout
synced 2024-11-09 15:12:39 +00:00
8b5e8b7687
Setting the `show-progress` option to false in the `with` section of the workflow step will cause git fetch to run without `--progress`. The motivation is to be able to suppress the noisy progress status output which adds many hundreds of "remote: Counting objects: 85% (386/453)" and similar lines in the workflow log. This should be sufficient to resolve #894 and its older friends, though the solution is different to the one proposed there because it doesn't use the --quiet flag. IIUC git doesn't show the progress status by default since the output is not a terminal, so that's why removing the --progress option is all that's needed. Adding the --quiet flag doesn't make a lot of difference once the --progress flag is removed, and actually I think using --quiet would suppress some other more useful output that would be better left visible. Signed-off-by: Simon Baird <sbaird@redhat.com>
378 lines
9.3 KiB
TypeScript
378 lines
9.3 KiB
TypeScript
import * as exec from '@actions/exec'
|
|
import * as fshelper from '../lib/fs-helper'
|
|
import * as commandManager from '../lib/git-command-manager'
|
|
|
|
let git: commandManager.IGitCommandManager
|
|
let mockExec = jest.fn()
|
|
|
|
describe('git-auth-helper tests', () => {
|
|
beforeAll(async () => {})
|
|
|
|
beforeEach(async () => {
|
|
jest.spyOn(fshelper, 'fileExistsSync').mockImplementation(jest.fn())
|
|
jest.spyOn(fshelper, 'directoryExistsSync').mockImplementation(jest.fn())
|
|
})
|
|
|
|
afterEach(() => {
|
|
jest.restoreAllMocks()
|
|
})
|
|
|
|
afterAll(() => {})
|
|
|
|
it('branch list matches', async () => {
|
|
mockExec.mockImplementation((path, args, options) => {
|
|
console.log(args, options.listeners.stdout)
|
|
|
|
if (args.includes('version')) {
|
|
options.listeners.stdout(Buffer.from('2.18'))
|
|
return 0
|
|
}
|
|
|
|
if (args.includes('rev-parse')) {
|
|
options.listeners.stdline(Buffer.from('refs/heads/foo'))
|
|
options.listeners.stdline(Buffer.from('refs/heads/bar'))
|
|
return 0
|
|
}
|
|
|
|
return 1
|
|
})
|
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
const workingDirectory = 'test'
|
|
const lfs = false
|
|
const doSparseCheckout = false
|
|
git = await commandManager.createCommandManager(
|
|
workingDirectory,
|
|
lfs,
|
|
doSparseCheckout
|
|
)
|
|
|
|
let branches = await git.branchList(false)
|
|
|
|
expect(branches).toHaveLength(2)
|
|
expect(branches.sort()).toEqual(['foo', 'bar'].sort())
|
|
})
|
|
|
|
it('ambiguous ref name output is captured', async () => {
|
|
mockExec.mockImplementation((path, args, options) => {
|
|
console.log(args, options.listeners.stdout)
|
|
|
|
if (args.includes('version')) {
|
|
options.listeners.stdout(Buffer.from('2.18'))
|
|
return 0
|
|
}
|
|
|
|
if (args.includes('rev-parse')) {
|
|
options.listeners.stdline(Buffer.from('refs/heads/foo'))
|
|
// If refs/tags/v1 and refs/heads/tags/v1 existed on this repository
|
|
options.listeners.errline(
|
|
Buffer.from("error: refname 'tags/v1' is ambiguous")
|
|
)
|
|
return 0
|
|
}
|
|
|
|
return 1
|
|
})
|
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
const workingDirectory = 'test'
|
|
const lfs = false
|
|
const doSparseCheckout = false
|
|
git = await commandManager.createCommandManager(
|
|
workingDirectory,
|
|
lfs,
|
|
doSparseCheckout
|
|
)
|
|
|
|
let branches = await git.branchList(false)
|
|
|
|
expect(branches).toHaveLength(1)
|
|
expect(branches.sort()).toEqual(['foo'].sort())
|
|
})
|
|
})
|
|
|
|
describe('Test fetchDepth and fetchTags options', () => {
|
|
beforeEach(async () => {
|
|
jest.spyOn(fshelper, 'fileExistsSync').mockImplementation(jest.fn())
|
|
jest.spyOn(fshelper, 'directoryExistsSync').mockImplementation(jest.fn())
|
|
mockExec.mockImplementation((path, args, options) => {
|
|
console.log(args, options.listeners.stdout)
|
|
|
|
if (args.includes('version')) {
|
|
options.listeners.stdout(Buffer.from('2.18'))
|
|
}
|
|
|
|
return 0
|
|
})
|
|
})
|
|
|
|
afterEach(() => {
|
|
jest.restoreAllMocks()
|
|
})
|
|
|
|
it('should call execGit with the correct arguments when fetchDepth is 0 and fetchTags is true', async () => {
|
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
const workingDirectory = 'test'
|
|
const lfs = false
|
|
const doSparseCheckout = false
|
|
git = await commandManager.createCommandManager(
|
|
workingDirectory,
|
|
lfs,
|
|
doSparseCheckout
|
|
)
|
|
|
|
const refSpec = ['refspec1', 'refspec2']
|
|
const options = {
|
|
filter: 'filterValue',
|
|
fetchDepth: 0,
|
|
fetchTags: true
|
|
}
|
|
|
|
await git.fetch(refSpec, options)
|
|
|
|
expect(mockExec).toHaveBeenCalledWith(
|
|
expect.any(String),
|
|
[
|
|
'-c',
|
|
'protocol.version=2',
|
|
'fetch',
|
|
'--prune',
|
|
'--no-recurse-submodules',
|
|
'--filter=filterValue',
|
|
'origin',
|
|
'refspec1',
|
|
'refspec2'
|
|
],
|
|
expect.any(Object)
|
|
)
|
|
})
|
|
|
|
it('should call execGit with the correct arguments when fetchDepth is 0 and fetchTags is false', async () => {
|
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
|
|
const workingDirectory = 'test'
|
|
const lfs = false
|
|
const doSparseCheckout = false
|
|
git = await commandManager.createCommandManager(
|
|
workingDirectory,
|
|
lfs,
|
|
doSparseCheckout
|
|
)
|
|
const refSpec = ['refspec1', 'refspec2']
|
|
const options = {
|
|
filter: 'filterValue',
|
|
fetchDepth: 0,
|
|
fetchTags: false
|
|
}
|
|
|
|
await git.fetch(refSpec, options)
|
|
|
|
expect(mockExec).toHaveBeenCalledWith(
|
|
expect.any(String),
|
|
[
|
|
'-c',
|
|
'protocol.version=2',
|
|
'fetch',
|
|
'--no-tags',
|
|
'--prune',
|
|
'--no-recurse-submodules',
|
|
'--filter=filterValue',
|
|
'origin',
|
|
'refspec1',
|
|
'refspec2'
|
|
],
|
|
expect.any(Object)
|
|
)
|
|
})
|
|
|
|
it('should call execGit with the correct arguments when fetchDepth is 1 and fetchTags is false', async () => {
|
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
|
|
const workingDirectory = 'test'
|
|
const lfs = false
|
|
const doSparseCheckout = false
|
|
git = await commandManager.createCommandManager(
|
|
workingDirectory,
|
|
lfs,
|
|
doSparseCheckout
|
|
)
|
|
const refSpec = ['refspec1', 'refspec2']
|
|
const options = {
|
|
filter: 'filterValue',
|
|
fetchDepth: 1,
|
|
fetchTags: false
|
|
}
|
|
|
|
await git.fetch(refSpec, options)
|
|
|
|
expect(mockExec).toHaveBeenCalledWith(
|
|
expect.any(String),
|
|
[
|
|
'-c',
|
|
'protocol.version=2',
|
|
'fetch',
|
|
'--no-tags',
|
|
'--prune',
|
|
'--no-recurse-submodules',
|
|
'--filter=filterValue',
|
|
'--depth=1',
|
|
'origin',
|
|
'refspec1',
|
|
'refspec2'
|
|
],
|
|
expect.any(Object)
|
|
)
|
|
})
|
|
|
|
it('should call execGit with the correct arguments when fetchDepth is 1 and fetchTags is true', async () => {
|
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
|
|
const workingDirectory = 'test'
|
|
const lfs = false
|
|
const doSparseCheckout = false
|
|
git = await commandManager.createCommandManager(
|
|
workingDirectory,
|
|
lfs,
|
|
doSparseCheckout
|
|
)
|
|
const refSpec = ['refspec1', 'refspec2']
|
|
const options = {
|
|
filter: 'filterValue',
|
|
fetchDepth: 1,
|
|
fetchTags: true
|
|
}
|
|
|
|
await git.fetch(refSpec, options)
|
|
|
|
expect(mockExec).toHaveBeenCalledWith(
|
|
expect.any(String),
|
|
[
|
|
'-c',
|
|
'protocol.version=2',
|
|
'fetch',
|
|
'--prune',
|
|
'--no-recurse-submodules',
|
|
'--filter=filterValue',
|
|
'--depth=1',
|
|
'origin',
|
|
'refspec1',
|
|
'refspec2'
|
|
],
|
|
expect.any(Object)
|
|
)
|
|
})
|
|
|
|
it('should call execGit with the correct arguments when showProgress is true', async () => {
|
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
|
|
const workingDirectory = 'test'
|
|
const lfs = false
|
|
const doSparseCheckout = false
|
|
git = await commandManager.createCommandManager(
|
|
workingDirectory,
|
|
lfs,
|
|
doSparseCheckout
|
|
)
|
|
const refSpec = ['refspec1', 'refspec2']
|
|
const options = {
|
|
filter: 'filterValue',
|
|
showProgress: true
|
|
}
|
|
|
|
await git.fetch(refSpec, options)
|
|
|
|
expect(mockExec).toHaveBeenCalledWith(
|
|
expect.any(String),
|
|
[
|
|
'-c',
|
|
'protocol.version=2',
|
|
'fetch',
|
|
'--no-tags',
|
|
'--prune',
|
|
'--no-recurse-submodules',
|
|
'--progress',
|
|
'--filter=filterValue',
|
|
'origin',
|
|
'refspec1',
|
|
'refspec2'
|
|
],
|
|
expect.any(Object)
|
|
)
|
|
})
|
|
|
|
it('should call execGit with the correct arguments when fetchDepth is 42 and showProgress is true', async () => {
|
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
|
|
const workingDirectory = 'test'
|
|
const lfs = false
|
|
const doSparseCheckout = false
|
|
git = await commandManager.createCommandManager(
|
|
workingDirectory,
|
|
lfs,
|
|
doSparseCheckout
|
|
)
|
|
const refSpec = ['refspec1', 'refspec2']
|
|
const options = {
|
|
filter: 'filterValue',
|
|
fetchDepth: 42,
|
|
showProgress: true
|
|
}
|
|
|
|
await git.fetch(refSpec, options)
|
|
|
|
expect(mockExec).toHaveBeenCalledWith(
|
|
expect.any(String),
|
|
[
|
|
'-c',
|
|
'protocol.version=2',
|
|
'fetch',
|
|
'--no-tags',
|
|
'--prune',
|
|
'--no-recurse-submodules',
|
|
'--progress',
|
|
'--filter=filterValue',
|
|
'--depth=42',
|
|
'origin',
|
|
'refspec1',
|
|
'refspec2'
|
|
],
|
|
expect.any(Object)
|
|
)
|
|
})
|
|
|
|
it('should call execGit with the correct arguments when fetchTags is true and showProgress is true', async () => {
|
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
|
|
const workingDirectory = 'test'
|
|
const lfs = false
|
|
const doSparseCheckout = false
|
|
git = await commandManager.createCommandManager(
|
|
workingDirectory,
|
|
lfs,
|
|
doSparseCheckout
|
|
)
|
|
const refSpec = ['refspec1', 'refspec2']
|
|
const options = {
|
|
filter: 'filterValue',
|
|
fetchTags: true,
|
|
showProgress: true
|
|
}
|
|
|
|
await git.fetch(refSpec, options)
|
|
|
|
expect(mockExec).toHaveBeenCalledWith(
|
|
expect.any(String),
|
|
[
|
|
'-c',
|
|
'protocol.version=2',
|
|
'fetch',
|
|
'--prune',
|
|
'--no-recurse-submodules',
|
|
'--progress',
|
|
'--filter=filterValue',
|
|
'origin',
|
|
'refspec1',
|
|
'refspec2'
|
|
],
|
|
expect.any(Object)
|
|
)
|
|
})
|
|
})
|