mirror of
https://github.com/gradle/actions.git
synced 2025-04-29 14:19:20 +08:00
95ef72241e
Gradle 8.8 introduces new features that allow us to avoid using timestamp manipulation to force the cleanup of the Gradle User Home directory. This solution is simpler and more robust, but relies on Gradle 8.8+ always being used for the cache cleanup operation. Fixes #24
110 lines
4.8 KiB
TypeScript
110 lines
4.8 KiB
TypeScript
import * as exec from '@actions/exec'
|
|
import * as core from '@actions/core'
|
|
import * as glob from '@actions/glob'
|
|
import fs from 'fs'
|
|
import path from 'path'
|
|
import {CacheCleaner} from '../../src/caching/cache-cleaner'
|
|
|
|
jest.setTimeout(120000)
|
|
|
|
test('will cleanup unused dependency jars and build-cache entries', async () => {
|
|
const projectRoot = prepareTestProject()
|
|
const gradleUserHome = path.resolve(projectRoot, 'HOME')
|
|
const tmpDir = path.resolve(projectRoot, 'tmp')
|
|
const cacheCleaner = new CacheCleaner(gradleUserHome, tmpDir)
|
|
|
|
await runGradleBuild(projectRoot, 'build', '3.1')
|
|
|
|
const timestamp = await cacheCleaner.prepare()
|
|
|
|
await runGradleBuild(projectRoot, 'build', '3.1.1')
|
|
|
|
const commonsMath31 = path.resolve(gradleUserHome, "caches/modules-2/files-2.1/org.apache.commons/commons-math3/3.1")
|
|
const commonsMath311 = path.resolve(gradleUserHome, "caches/modules-2/files-2.1/org.apache.commons/commons-math3/3.1.1")
|
|
const buildCacheDir = path.resolve(gradleUserHome, "caches/build-cache-1")
|
|
|
|
expect(fs.existsSync(commonsMath31)).toBe(true)
|
|
expect(fs.existsSync(commonsMath311)).toBe(true)
|
|
expect(fs.readdirSync(buildCacheDir).length).toBe(4) // gc.properties, build-cache-1.lock, and 2 task entries
|
|
|
|
await cacheCleaner.forceCleanupFilesOlderThan(timestamp)
|
|
|
|
expect(fs.existsSync(commonsMath31)).toBe(false)
|
|
expect(fs.existsSync(commonsMath311)).toBe(true)
|
|
expect(fs.readdirSync(buildCacheDir).length).toBe(3) // 1 task entry has been cleaned up
|
|
})
|
|
|
|
test('will cleanup unused gradle versions', async () => {
|
|
const projectRoot = prepareTestProject()
|
|
const gradleUserHome = path.resolve(projectRoot, 'HOME')
|
|
const tmpDir = path.resolve(projectRoot, 'tmp')
|
|
const cacheCleaner = new CacheCleaner(gradleUserHome, tmpDir)
|
|
|
|
// Initialize HOME with 2 different Gradle versions
|
|
await runGradleWrapperBuild(projectRoot, 'build')
|
|
await runGradleBuild(projectRoot, 'build')
|
|
|
|
const timestamp = await cacheCleaner.prepare()
|
|
|
|
// Run with only one of these versions
|
|
await runGradleBuild(projectRoot, 'build')
|
|
|
|
const gradle802 = path.resolve(gradleUserHome, "caches/8.0.2")
|
|
const transforms3 = path.resolve(gradleUserHome, "caches/transforms-3")
|
|
const metadata100 = path.resolve(gradleUserHome, "caches/modules-2/metadata-2.100")
|
|
const wrapper802 = path.resolve(gradleUserHome, "wrapper/dists/gradle-8.0.2-bin")
|
|
const gradleCurrent = path.resolve(gradleUserHome, "caches/8.8")
|
|
const metadataCurrent = path.resolve(gradleUserHome, "caches/modules-2/metadata-2.106")
|
|
|
|
expect(fs.existsSync(gradle802)).toBe(true)
|
|
expect(fs.existsSync(transforms3)).toBe(true)
|
|
expect(fs.existsSync(metadata100)).toBe(true)
|
|
expect(fs.existsSync(wrapper802)).toBe(true)
|
|
|
|
expect(fs.existsSync(gradleCurrent)).toBe(true)
|
|
expect(fs.existsSync(metadataCurrent)).toBe(true)
|
|
|
|
// The wrapper won't be removed if it was recently downloaded. Age it.
|
|
setUtimes(wrapper802, new Date(Date.now() - 48 * 60 * 60 * 1000))
|
|
|
|
await cacheCleaner.forceCleanupFilesOlderThan(timestamp)
|
|
|
|
expect(fs.existsSync(gradle802)).toBe(false)
|
|
expect(fs.existsSync(transforms3)).toBe(false)
|
|
expect(fs.existsSync(metadata100)).toBe(false)
|
|
expect(fs.existsSync(wrapper802)).toBe(false)
|
|
|
|
expect(fs.existsSync(gradleCurrent)).toBe(true)
|
|
expect(fs.existsSync(metadataCurrent)).toBe(true)
|
|
})
|
|
|
|
async function runGradleBuild(projectRoot: string, args: string, version: string = '3.1'): Promise<void> {
|
|
const status31 = await exec.exec(`gradle -g HOME --no-daemon --build-cache -Dcommons_math3_version="${version}" ${args}`, [], {
|
|
cwd: projectRoot
|
|
})
|
|
console.log(`Gradle User Home initialized with commons_math3_version=${version} ${args}`)
|
|
}
|
|
|
|
async function runGradleWrapperBuild(projectRoot: string, args: string, version: string = '3.1'): Promise<void> {
|
|
const status31 = await exec.exec(`./gradlew -g HOME --no-daemon --build-cache -Dcommons_math3_version="${version}" ${args}`, [], {
|
|
cwd: projectRoot
|
|
})
|
|
console.log(`Gradle User Home initialized with commons_math3_version="${version}" ${args}`)
|
|
}
|
|
|
|
function prepareTestProject(): string {
|
|
const projectRoot = 'test/jest/resources/cache-cleanup'
|
|
fs.rmSync(path.resolve(projectRoot, 'HOME'), { recursive: true, force: true })
|
|
fs.rmSync(path.resolve(projectRoot, 'tmp'), { recursive: true, force: true })
|
|
fs.rmSync(path.resolve(projectRoot, 'build'), { recursive: true, force: true })
|
|
fs.rmSync(path.resolve(projectRoot, '.gradle'), { recursive: true, force: true })
|
|
return projectRoot
|
|
}
|
|
|
|
async function setUtimes(pattern: string, timestamp: Date): Promise<void> {
|
|
const globber = await glob.create(pattern)
|
|
for await (const file of globber.globGenerator()) {
|
|
fs.utimesSync(file, timestamp, timestamp)
|
|
}
|
|
}
|