refactor(cache): consolidate tar fallback handling and tests
Share the Windows BSD tar/zstd predicate and prepare archive and workspace arguments once per command. Parameterize duplicate BSD-tar read tests and use the real temporary-directory utilities in the concurrency fixture. Retain the existing concurrency, path-handling, and failure coverage.
This commit is contained in:
1 parent
90977320aa
commit
dd137a579c
3 files changed
+89
-175
No files matched your search
+28
-75
@@ -84,57 +84,56 @@ test('zstd extract tar', async () => {
|
|||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
test('zstd extract tar with windows BSDtar', async () => {
|
test.each([
|
||||||
if (IS_WINDOWS) {
|
{operation: 'extract', read: tar.extractTar, flag: '-xf'},
|
||||||
|
{operation: 'list', read: tar.listTar, flag: '-tf'}
|
||||||
|
])(
|
||||||
|
'zstd $operation tar with windows BSDtar',
|
||||||
|
async ({operation, read, flag}) => {
|
||||||
|
if (!IS_WINDOWS) {
|
||||||
|
return
|
||||||
|
}
|
||||||
const mkdirMock = jest.spyOn(io, 'mkdirP')
|
const mkdirMock = jest.spyOn(io, 'mkdirP')
|
||||||
const execMock = jest.spyOn(exec, 'exec')
|
const execMock = jest.spyOn(exec, 'exec')
|
||||||
const tempDirectory = getTempDir()
|
const tempDirectory = getTempDir()
|
||||||
jest.spyOn(utils, 'createTempDirectory').mockResolvedValue(tempDirectory)
|
jest.spyOn(utils, 'createTempDirectory').mockResolvedValue(tempDirectory)
|
||||||
jest
|
jest.spyOn(utils, 'getGnuTarPathOnWindows').mockResolvedValue('')
|
||||||
.spyOn(utils, 'getGnuTarPathOnWindows')
|
|
||||||
.mockReturnValue(Promise.resolve(''))
|
|
||||||
|
|
||||||
const archivePath = `${process.env['windir']}\\fakepath\\cache.tar`
|
const archivePath = `${process.env['windir']}\\fakepath\\cache.tar`
|
||||||
const workspace = process.env['GITHUB_WORKSPACE']
|
const workspace = process.env['GITHUB_WORKSPACE']
|
||||||
const tarPath = SystemTarPathOnWindows
|
const options = {
|
||||||
|
cwd: tempDirectory,
|
||||||
|
env: expect.objectContaining(defaultEnv)
|
||||||
|
}
|
||||||
|
const tarArgs = [`"${SystemTarPathOnWindows}"`, flag, TarFilename, '-P']
|
||||||
|
if (operation === 'extract') {
|
||||||
|
tarArgs.push('-C', `"${workspace?.replace(/\\/g, '/')}"`)
|
||||||
|
}
|
||||||
|
|
||||||
await tar.extractTar(archivePath, CompressionMethod.Zstd)
|
await read(archivePath, CompressionMethod.Zstd)
|
||||||
|
|
||||||
expect(mkdirMock).toHaveBeenCalledWith(workspace)
|
if (operation === 'extract') {
|
||||||
|
expect(mkdirMock).toHaveBeenCalledWith(workspace)
|
||||||
|
}
|
||||||
expect(execMock).toHaveBeenCalledTimes(2)
|
expect(execMock).toHaveBeenCalledTimes(2)
|
||||||
|
|
||||||
expect(execMock).toHaveBeenNthCalledWith(
|
expect(execMock).toHaveBeenNthCalledWith(
|
||||||
1,
|
1,
|
||||||
[
|
[
|
||||||
'zstd -d --long=30 --force -o',
|
'zstd -d --long=30 --force -o',
|
||||||
TarFilename.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
|
TarFilename,
|
||||||
`"${archivePath.replace(new RegExp(`\\${path.sep}`, 'g'), '/')}"`
|
`"${archivePath.replace(/\\/g, '/')}"`
|
||||||
].join(' '),
|
].join(' '),
|
||||||
undefined,
|
undefined,
|
||||||
{
|
options
|
||||||
cwd: tempDirectory,
|
|
||||||
env: expect.objectContaining(defaultEnv)
|
|
||||||
}
|
|
||||||
)
|
)
|
||||||
|
|
||||||
expect(execMock).toHaveBeenNthCalledWith(
|
expect(execMock).toHaveBeenNthCalledWith(
|
||||||
2,
|
2,
|
||||||
[
|
tarArgs.join(' '),
|
||||||
`"${tarPath}"`,
|
|
||||||
'-xf',
|
|
||||||
TarFilename.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
|
|
||||||
'-P',
|
|
||||||
'-C',
|
|
||||||
`"${workspace?.replace(/\\/g, '/')}"`
|
|
||||||
].join(' '),
|
|
||||||
undefined,
|
undefined,
|
||||||
{
|
options
|
||||||
cwd: tempDirectory,
|
|
||||||
env: expect.objectContaining(defaultEnv)
|
|
||||||
}
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
})
|
)
|
||||||
|
|
||||||
test('gzip extract tar', async () => {
|
test('gzip extract tar', async () => {
|
||||||
const mkdirMock = jest.spyOn(io, 'mkdirP')
|
const mkdirMock = jest.spyOn(io, 'mkdirP')
|
||||||
@@ -380,52 +379,6 @@ test('zstd list tar', async () => {
|
|||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
test('zstd list tar with windows BSDtar', async () => {
|
|
||||||
if (IS_WINDOWS) {
|
|
||||||
const execMock = jest.spyOn(exec, 'exec')
|
|
||||||
const tempDirectory = getTempDir()
|
|
||||||
jest.spyOn(utils, 'createTempDirectory').mockResolvedValue(tempDirectory)
|
|
||||||
jest
|
|
||||||
.spyOn(utils, 'getGnuTarPathOnWindows')
|
|
||||||
.mockReturnValue(Promise.resolve(''))
|
|
||||||
const archivePath = `${process.env['windir']}\\fakepath\\cache.tar`
|
|
||||||
|
|
||||||
await tar.listTar(archivePath, CompressionMethod.Zstd)
|
|
||||||
|
|
||||||
const tarPath = SystemTarPathOnWindows
|
|
||||||
expect(execMock).toHaveBeenCalledTimes(2)
|
|
||||||
|
|
||||||
expect(execMock).toHaveBeenNthCalledWith(
|
|
||||||
1,
|
|
||||||
[
|
|
||||||
'zstd -d --long=30 --force -o',
|
|
||||||
TarFilename.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
|
|
||||||
`"${archivePath.replace(new RegExp(`\\${path.sep}`, 'g'), '/')}"`
|
|
||||||
].join(' '),
|
|
||||||
undefined,
|
|
||||||
{
|
|
||||||
cwd: tempDirectory,
|
|
||||||
env: expect.objectContaining(defaultEnv)
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
expect(execMock).toHaveBeenNthCalledWith(
|
|
||||||
2,
|
|
||||||
[
|
|
||||||
`"${tarPath}"`,
|
|
||||||
'-tf',
|
|
||||||
TarFilename.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
|
|
||||||
'-P'
|
|
||||||
].join(' '),
|
|
||||||
undefined,
|
|
||||||
{
|
|
||||||
cwd: tempDirectory,
|
|
||||||
env: expect.objectContaining(defaultEnv)
|
|
||||||
}
|
|
||||||
)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
test('zstdWithoutLong list tar', async () => {
|
test('zstdWithoutLong list tar', async () => {
|
||||||
const execMock = jest.spyOn(exec, 'exec')
|
const execMock = jest.spyOn(exec, 'exec')
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
import * as exec from '@actions/exec'
|
import * as exec from '@actions/exec'
|
||||||
import * as io from '@actions/io'
|
|
||||||
import * as fs from 'fs'
|
import * as fs from 'fs'
|
||||||
import * as path from 'path'
|
import * as path from 'path'
|
||||||
import * as tar from '../src/internal/tar'
|
import * as tar from '../src/internal/tar'
|
||||||
@@ -7,10 +6,10 @@ import * as utils from '../src/internal/cacheUtils'
|
|||||||
import {CompressionMethod} from '../src/internal/constants'
|
import {CompressionMethod} from '../src/internal/constants'
|
||||||
|
|
||||||
jest.mock('@actions/exec')
|
jest.mock('@actions/exec')
|
||||||
jest.mock('@actions/io')
|
|
||||||
|
|
||||||
const describeWindows = process.platform === 'win32' ? describe : describe.skip
|
const describeWindows = process.platform === 'win32' ? describe : describe.skip
|
||||||
type Operation = 'extract' | 'list'
|
const readers = {extract: tar.extractTar, list: tar.listTar}
|
||||||
|
type Operation = keyof typeof readers
|
||||||
|
|
||||||
interface Fixture {
|
interface Fixture {
|
||||||
file: string
|
file: string
|
||||||
@@ -25,7 +24,7 @@ describeWindows.each([
|
|||||||
{file: 'first.txt', content: 'first archive'},
|
{file: 'first.txt', content: 'first archive'},
|
||||||
{file: 'second.txt', content: 'second archive'}
|
{file: 'second.txt', content: 'second archive'}
|
||||||
]
|
]
|
||||||
const originalWorkspace = process.env['GITHUB_WORKSPACE']
|
const originalEnv = {...process.env}
|
||||||
let root: string
|
let root: string
|
||||||
let workspace: string
|
let workspace: string
|
||||||
let archives: string[]
|
let archives: string[]
|
||||||
@@ -51,17 +50,12 @@ describeWindows.each([
|
|||||||
listedFiles = []
|
listedFiles = []
|
||||||
failStage = undefined
|
failStage = undefined
|
||||||
afterDecompression = async () => {}
|
afterDecompression = async () => {}
|
||||||
process.env['GITHUB_WORKSPACE'] = workspace
|
process.env = {
|
||||||
|
...originalEnv,
|
||||||
|
GITHUB_WORKSPACE: workspace,
|
||||||
|
RUNNER_TEMP: root
|
||||||
|
}
|
||||||
jest.spyOn(utils, 'getGnuTarPathOnWindows').mockResolvedValue('')
|
jest.spyOn(utils, 'getGnuTarPathOnWindows').mockResolvedValue('')
|
||||||
jest.spyOn(utils, 'createTempDirectory').mockImplementation(async () => {
|
|
||||||
return fs.promises.mkdtemp(path.join(root, 'scratch-'))
|
|
||||||
})
|
|
||||||
jest.spyOn(io, 'mkdirP').mockImplementation(async directory => {
|
|
||||||
await fs.promises.mkdir(path.resolve(directory), {recursive: true})
|
|
||||||
})
|
|
||||||
jest.spyOn(io, 'rmRF').mockImplementation(async directory => {
|
|
||||||
await fs.promises.rm(directory, {recursive: true, force: true})
|
|
||||||
})
|
|
||||||
|
|
||||||
// Model the filesystem effects of zstd and tar without requiring either
|
// Model the filesystem effects of zstd and tar without requiring either
|
||||||
// program to be installed. The fixture content stands in for archive data.
|
// program to be installed. The fixture content stands in for archive data.
|
||||||
@@ -82,26 +76,26 @@ describeWindows.each([
|
|||||||
throw new Error('simulated decompression failure')
|
throw new Error('simulated decompression failure')
|
||||||
}
|
}
|
||||||
await afterDecompression()
|
await afterDecompression()
|
||||||
} else {
|
return 0
|
||||||
if (failStage === 'tar') {
|
}
|
||||||
throw new Error('simulated tar failure')
|
if (failStage === 'tar') {
|
||||||
}
|
throw new Error('simulated tar failure')
|
||||||
const extracting = argv.includes('-xf')
|
}
|
||||||
const source = path.resolve(
|
const extracting = argv.includes('-xf')
|
||||||
cwd,
|
const source = path.resolve(
|
||||||
argv[argv.indexOf(extracting ? '-xf' : '-tf') + 1]
|
cwd,
|
||||||
|
argv[argv.indexOf(extracting ? '-xf' : '-tf') + 1]
|
||||||
|
)
|
||||||
|
const fixture: Fixture = JSON.parse(fs.readFileSync(source, 'utf8'))
|
||||||
|
if (extracting) {
|
||||||
|
const destination = path.resolve(cwd, argv[argv.indexOf('-C') + 1])
|
||||||
|
await fs.promises.mkdir(destination, {recursive: true})
|
||||||
|
fs.writeFileSync(
|
||||||
|
path.join(destination, fixture.file),
|
||||||
|
fixture.content
|
||||||
)
|
)
|
||||||
const fixture: Fixture = JSON.parse(fs.readFileSync(source, 'utf8'))
|
} else {
|
||||||
if (extracting) {
|
listedFiles.push(fixture.file)
|
||||||
const destination = path.resolve(cwd, argv[argv.indexOf('-C') + 1])
|
|
||||||
await fs.promises.mkdir(destination, {recursive: true})
|
|
||||||
fs.writeFileSync(
|
|
||||||
path.join(destination, fixture.file),
|
|
||||||
fixture.content
|
|
||||||
)
|
|
||||||
} else {
|
|
||||||
listedFiles.push(fixture.file)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
return 0
|
return 0
|
||||||
})
|
})
|
||||||
@@ -109,25 +103,10 @@ describeWindows.each([
|
|||||||
|
|
||||||
afterEach(async () => {
|
afterEach(async () => {
|
||||||
jest.restoreAllMocks()
|
jest.restoreAllMocks()
|
||||||
if (originalWorkspace === undefined) {
|
process.env = {...originalEnv}
|
||||||
delete process.env['GITHUB_WORKSPACE']
|
|
||||||
} else {
|
|
||||||
process.env['GITHUB_WORKSPACE'] = originalWorkspace
|
|
||||||
}
|
|
||||||
await fs.promises.rm(root, {recursive: true, force: true})
|
await fs.promises.rm(root, {recursive: true, force: true})
|
||||||
})
|
})
|
||||||
|
|
||||||
async function readArchive(
|
|
||||||
operation: Operation,
|
|
||||||
archive: string
|
|
||||||
): Promise<void> {
|
|
||||||
if (operation === 'extract') {
|
|
||||||
await tar.extractTar(archive, compression)
|
|
||||||
} else {
|
|
||||||
await tar.listTar(archive, compression)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function expectCleanScratch(): void {
|
function expectCleanScratch(): void {
|
||||||
expect(fs.readdirSync(root).sort()).toEqual([
|
expect(fs.readdirSync(root).sort()).toEqual([
|
||||||
'archives',
|
'archives',
|
||||||
@@ -166,7 +145,7 @@ describeWindows.each([
|
|||||||
const operations = [first, second]
|
const operations = [first, second]
|
||||||
await Promise.all(
|
await Promise.all(
|
||||||
operations.map(async (operation, index) => {
|
operations.map(async (operation, index) => {
|
||||||
await readArchive(operation, archives[index])
|
await readers[operation](archives[index], compression)
|
||||||
})
|
})
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -209,9 +188,9 @@ describeWindows.each([
|
|||||||
async (operation, stage) => {
|
async (operation, stage) => {
|
||||||
failStage = stage
|
failStage = stage
|
||||||
|
|
||||||
await expect(readArchive(operation, archives[0])).rejects.toThrow(
|
await expect(
|
||||||
'simulated'
|
readers[operation](archives[0], compression)
|
||||||
)
|
).rejects.toThrow('simulated')
|
||||||
|
|
||||||
expectCleanScratch()
|
expectCleanScratch()
|
||||||
}
|
}
|
||||||
|
|||||||
+29
-47
@@ -19,6 +19,17 @@ interface TarCommands {
|
|||||||
requiresTempDirectory: boolean
|
requiresTempDirectory: boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function isBsdTarZstd(
|
||||||
|
tarPath: ArchiveTool,
|
||||||
|
compressionMethod: CompressionMethod
|
||||||
|
): boolean {
|
||||||
|
return (
|
||||||
|
IS_WINDOWS &&
|
||||||
|
tarPath.type === ArchiveToolType.BSD &&
|
||||||
|
compressionMethod !== CompressionMethod.Gzip
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
// Returns tar path and type: BSD or GNU
|
// Returns tar path and type: BSD or GNU
|
||||||
async function getTarPath(): Promise<ArchiveTool> {
|
async function getTarPath(): Promise<ArchiveTool> {
|
||||||
switch (process.platform) {
|
switch (process.platform) {
|
||||||
@@ -63,14 +74,16 @@ async function getTarArgs(
|
|||||||
archivePath = ''
|
archivePath = ''
|
||||||
): Promise<string[]> {
|
): Promise<string[]> {
|
||||||
const args = [`"${tarPath.path}"`]
|
const args = [`"${tarPath.path}"`]
|
||||||
const cacheFileName = utils.getCacheFileName(compressionMethod)
|
const BSD_TAR_ZSTD = isBsdTarZstd(tarPath, compressionMethod)
|
||||||
const tarFile = 'cache.tar'
|
const tarFile = BSD_TAR_ZSTD
|
||||||
const workingDirectory = getWorkingDirectory()
|
? TarFilename
|
||||||
// Speficic args for BSD tar on windows for workaround
|
: (type === 'create'
|
||||||
const BSD_TAR_ZSTD =
|
? utils.getCacheFileName(compressionMethod)
|
||||||
tarPath.type === ArchiveToolType.BSD &&
|
: archivePath
|
||||||
compressionMethod !== CompressionMethod.Gzip &&
|
).replace(new RegExp(`\\${path.sep}`, 'g'), '/')
|
||||||
IS_WINDOWS
|
const workingDirectory = BSD_TAR_ZSTD
|
||||||
|
? quoteAbsolutePath(getWorkingDirectory())
|
||||||
|
: getWorkingDirectory().replace(new RegExp(`\\${path.sep}`, 'g'), '/')
|
||||||
|
|
||||||
// Method specific args
|
// Method specific args
|
||||||
switch (type) {
|
switch (type) {
|
||||||
@@ -78,43 +91,21 @@ async function getTarArgs(
|
|||||||
args.push(
|
args.push(
|
||||||
'--posix',
|
'--posix',
|
||||||
'-cf',
|
'-cf',
|
||||||
BSD_TAR_ZSTD
|
tarFile,
|
||||||
? tarFile
|
|
||||||
: cacheFileName.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
|
|
||||||
'--exclude',
|
'--exclude',
|
||||||
BSD_TAR_ZSTD
|
tarFile,
|
||||||
? tarFile
|
|
||||||
: cacheFileName.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
|
|
||||||
'-P',
|
'-P',
|
||||||
'-C',
|
'-C',
|
||||||
BSD_TAR_ZSTD
|
workingDirectory,
|
||||||
? quoteAbsolutePath(workingDirectory)
|
|
||||||
: workingDirectory.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
|
|
||||||
'--files-from',
|
'--files-from',
|
||||||
ManifestFilename
|
ManifestFilename
|
||||||
)
|
)
|
||||||
break
|
break
|
||||||
case 'extract':
|
case 'extract':
|
||||||
args.push(
|
args.push('-xf', tarFile, '-P', '-C', workingDirectory)
|
||||||
'-xf',
|
|
||||||
BSD_TAR_ZSTD
|
|
||||||
? tarFile
|
|
||||||
: archivePath.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
|
|
||||||
'-P',
|
|
||||||
'-C',
|
|
||||||
BSD_TAR_ZSTD
|
|
||||||
? quoteAbsolutePath(workingDirectory)
|
|
||||||
: workingDirectory.replace(new RegExp(`\\${path.sep}`, 'g'), '/')
|
|
||||||
)
|
|
||||||
break
|
break
|
||||||
case 'list':
|
case 'list':
|
||||||
args.push(
|
args.push('-tf', tarFile, '-P')
|
||||||
'-tf',
|
|
||||||
BSD_TAR_ZSTD
|
|
||||||
? tarFile
|
|
||||||
: archivePath.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
|
|
||||||
'-P'
|
|
||||||
)
|
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -152,10 +143,7 @@ async function getCommands(
|
|||||||
type !== 'create'
|
type !== 'create'
|
||||||
? await getDecompressionProgram(tarPath, compressionMethod, archivePath)
|
? await getDecompressionProgram(tarPath, compressionMethod, archivePath)
|
||||||
: await getCompressionProgram(tarPath, compressionMethod)
|
: await getCompressionProgram(tarPath, compressionMethod)
|
||||||
const BSD_TAR_ZSTD =
|
const BSD_TAR_ZSTD = isBsdTarZstd(tarPath, compressionMethod)
|
||||||
tarPath.type === ArchiveToolType.BSD &&
|
|
||||||
compressionMethod !== CompressionMethod.Gzip &&
|
|
||||||
IS_WINDOWS
|
|
||||||
|
|
||||||
if (BSD_TAR_ZSTD && type !== 'create') {
|
if (BSD_TAR_ZSTD && type !== 'create') {
|
||||||
args = [[...compressionArgs].join(' '), [...tarArgs].join(' ')]
|
args = [[...compressionArgs].join(' '), [...tarArgs].join(' ')]
|
||||||
@@ -187,10 +175,7 @@ async function getDecompressionProgram(
|
|||||||
// unzstd is equivalent to 'zstd -d'
|
// unzstd is equivalent to 'zstd -d'
|
||||||
// --long=#: Enables long distance matching with # bits. Maximum is 30 (1GB) on 32-bit OS and 31 (2GB) on 64-bit.
|
// --long=#: Enables long distance matching with # bits. Maximum is 30 (1GB) on 32-bit OS and 31 (2GB) on 64-bit.
|
||||||
// Using 30 here because we also support 32-bit self-hosted runners.
|
// Using 30 here because we also support 32-bit self-hosted runners.
|
||||||
const BSD_TAR_ZSTD =
|
const BSD_TAR_ZSTD = isBsdTarZstd(tarPath, compressionMethod)
|
||||||
tarPath.type === ArchiveToolType.BSD &&
|
|
||||||
compressionMethod !== CompressionMethod.Gzip &&
|
|
||||||
IS_WINDOWS
|
|
||||||
switch (compressionMethod) {
|
switch (compressionMethod) {
|
||||||
case CompressionMethod.Zstd:
|
case CompressionMethod.Zstd:
|
||||||
return BSD_TAR_ZSTD
|
return BSD_TAR_ZSTD
|
||||||
@@ -223,10 +208,7 @@ async function getCompressionProgram(
|
|||||||
compressionMethod: CompressionMethod
|
compressionMethod: CompressionMethod
|
||||||
): Promise<string[]> {
|
): Promise<string[]> {
|
||||||
const cacheFileName = utils.getCacheFileName(compressionMethod)
|
const cacheFileName = utils.getCacheFileName(compressionMethod)
|
||||||
const BSD_TAR_ZSTD =
|
const BSD_TAR_ZSTD = isBsdTarZstd(tarPath, compressionMethod)
|
||||||
tarPath.type === ArchiveToolType.BSD &&
|
|
||||||
compressionMethod !== CompressionMethod.Gzip &&
|
|
||||||
IS_WINDOWS
|
|
||||||
switch (compressionMethod) {
|
switch (compressionMethod) {
|
||||||
case CompressionMethod.Zstd:
|
case CompressionMethod.Zstd:
|
||||||
return BSD_TAR_ZSTD
|
return BSD_TAR_ZSTD
|
||||||
|
|||||||
Reference in new issue
Block a user