Test with UNRELEASED gradle-actions-caching library v0.8.1-cc

sources/src/actions/dependency-submission/post.ts

@@ -1,6 +1,6 @@
 import * as setupGradle from '../../setup-gradle'
 
-import {CacheConfig, DevelocityConfig, SummaryConfig} from '../../configuration'
+import {CacheConfig, SummaryConfig} from '../../configuration'
 import {handlePostActionError} from '../../errors'
 import {forceExit} from '../../force-exit'
 
@@ -14,7 +14,7 @@ process.on('uncaughtException', e => handlePostActionError(e))
  */
 export async function run(): Promise<void> {
     try {
-        await setupGradle.complete(new CacheConfig(), new DevelocityConfig(), new SummaryConfig())
+        await setupGradle.complete(new CacheConfig(), new SummaryConfig())
     } catch (error) {
         handlePostActionError(error)
     }

sources/src/actions/setup-gradle/post.ts

@@ -1,7 +1,7 @@
 import * as setupGradle from '../../setup-gradle'
 import * as dependencyGraph from '../../dependency-graph'
 
-import {CacheConfig, DependencyGraphConfig, DevelocityConfig, SummaryConfig} from '../../configuration'
+import {CacheConfig, DependencyGraphConfig, SummaryConfig} from '../../configuration'
 import {handlePostActionError} from '../../errors'
 import {emitDeprecationWarnings, restoreDeprecationState} from '../../deprecation-collector'
 import {forceExit} from '../../force-exit'
@@ -19,7 +19,7 @@ export async function run(): Promise<void> {
         restoreDeprecationState()
         emitDeprecationWarnings()
 
-        if (await setupGradle.complete(new CacheConfig(), new DevelocityConfig(), new SummaryConfig())) {
+        if (await setupGradle.complete(new CacheConfig(), new SummaryConfig())) {
             // Only submit the dependency graphs once per job
             await dependencyGraph.complete(new DependencyGraphConfig())
         }

sources/src/cache-service.ts

@@ -8,8 +8,6 @@ export interface CacheOptions {
     strictMatch: boolean
     cleanup: string
     encryptionKey?: string
-    develocityAccessToken?: string
-    develocityServerUrl?: string
     includes: string[]
     excludes: string[]
 }
@@ -29,12 +27,7 @@ export type CacheCleanupStatus =
     | 'disabled-config-cache-hit'
     | 'disabled-readonly'
 
-export type ProjectCacheStatus =
-    | 'not-enabled' // the hidden opt-in env var was not set (rendered as nothing)
-    | 'trial-expired' // past the hard trial expiry
-    | 'trial-not-licensed' // Develocity trial token missing or invalid
-    | 'no-encryption-key' // Cannot store due to missing encryption key
-    | 'enabled' // Trial in effect: will attempt to save project state
+export type ConfigurationCacheStatus = 'not-active' | 'restored' | 'not-restored' | 'restore-incomplete'
 
 export interface CacheEntryReport {
     entryName: string
@@ -56,7 +49,7 @@ export interface CacheEntryReport {
 export interface CacheReport {
     status: CacheStatus
     cleanup?: CacheCleanupStatus
-    projectCache?: ProjectCacheStatus
+    configurationCache?: ConfigurationCacheStatus
     entries: CacheEntryReport[]
 }
 

sources/src/caching-report.ts

@@ -1,4 +1,4 @@
-import {CacheCleanupStatus, CacheEntryReport, CacheReport, CacheStatus, ProjectCacheStatus} from './cache-service'
+import {CacheCleanupStatus, CacheEntryReport, CacheReport, CacheStatus, ConfigurationCacheStatus} from './cache-service'
 
 const DOCS = 'https://github.com/gradle/actions/blob/main/docs/setup-gradle.md'
 const DISTRIBUTION = 'https://github.com/gradle/actions/blob/main/DISTRIBUTION.md'
@@ -28,12 +28,11 @@ const CLEANUP_COPY: Record<CacheCleanupStatus, string> = {
     'disabled-readonly': `[Cache cleanup](${DOCS}#configuring-cache-cleanup) is always disabled when the cache is read-only.`
 }
 
-const PROJECT_CACHE_COPY: Record<ProjectCacheStatus, string> = {
-    'not-enabled': ``,
-    'trial-expired': `Project state (build-logic and configuration cache) was not cached - the Develocity caching trial has expired.`,
-    'trial-not-licensed': `Project state (build-logic and configuration cache) was not cached - a develocity-access-key and develocity-server-url is required.`,
-    'no-encryption-key': `Project state (build-logic and configuration cache) was not cached - a [cache-encryption-key](${DOCS}#cache-encryption-key) is required.`,
-    enabled: `Caching of project state (build-logic and configuration cache) was enabled.`
+const CONFIG_CACHE_COPY: Record<ConfigurationCacheStatus, string> = {
+    'not-active': `Configuration cache state was not cached — set a [cache-encryption-key](${DOCS}#cache-encryption-key) to enable configuration-cache caching.`,
+    restored: `Configuration cache state was restored from the cache.`,
+    'not-restored': `Configuration cache state was not restored — no cached data was available (e.g. the first run for this cache key).`,
+    'restore-incomplete': `Configuration cache state was not restored — the Gradle User Home was not fully restored.`
 }
 
 /**
@@ -77,9 +76,8 @@ function renderCleanupLine(cleanup?: CacheCleanupStatus): string | undefined {
     return cleanup ? CLEANUP_COPY[cleanup] : undefined
 }
 
-function renderProjectCacheLine(projectCache?: ProjectCacheStatus): string | undefined {
-    // PROJECT_CACHE_COPY['not-enabled'] is '', which the .filter(Boolean) at the call site drops.
-    return projectCache ? PROJECT_CACHE_COPY[projectCache] : undefined
+function renderConfigCacheLine(configurationCache?: ConfigurationCacheStatus): string | undefined {
+    return configurationCache ? CONFIG_CACHE_COPY[configurationCache] : undefined
 }
 
 function renderProviderNote(providerNote?: ProviderNote): string | undefined {
@@ -101,10 +99,10 @@ function renderDetails(report: CacheReport): string {
         : `Entries: ${restored} restored, ${saved} saved - Expand for more details`
 
     const cleanup = report.status === 'enabled' ? renderCleanupLine(report.cleanup) : undefined
-    const projectCache = renderProjectCacheLine(report.projectCache)
+    const configCache = renderConfigCacheLine(report.configurationCache)
     const table = renderEntryTable(report.entries)
     const pre = `<pre>\n${renderEntryDetails(report.entries)}</pre>`
-    const body = [STATUS_COPY[report.status], cleanup, projectCache, table, pre].filter(Boolean).join('\n\n')
+    const body = [STATUS_COPY[report.status], cleanup, configCache, table, pre].filter(Boolean).join('\n\n')
 
     return `<details>
 <summary>${summary}</summary>

sources/src/develocity/build-scan.ts

@@ -1,7 +1,8 @@
 import * as core from '@actions/core'
 import {DevelocityConfig} from '../configuration'
+import {setupToken} from './short-lived-token'
 
-export function setup(config: DevelocityConfig): void {
+export async function setup(config: DevelocityConfig): Promise<void> {
     maybeExportVariable('DEVELOCITY_INJECTION_INIT_SCRIPT_NAME', 'gradle-actions.inject-develocity.init.gradle')
     maybeExportVariable('DEVELOCITY_INJECTION_CUSTOM_VALUE', 'gradle-actions')
 
@@ -38,6 +39,12 @@ export function setup(config: DevelocityConfig): void {
         maybeExportVariable('DEVELOCITY_INJECTION_TERMS_OF_USE_URL', config.getTermsOfUseUrl())
         maybeExportVariable('DEVELOCITY_INJECTION_TERMS_OF_USE_AGREE', config.getTermsOfUseAgree())
     }
+
+    return setupToken(
+        config.getDevelocityAccessKey(),
+        config.getDevelocityAllowUntrustedServer(),
+        config.getDevelocityTokenExpiry()
+    )
 }
 
 function maybeExportVariable(variableName: string, value: unknown): void {

sources/src/develocity/short-lived-token.ts

@@ -3,41 +3,28 @@ import * as httpm from '@actions/http-client'
 import {DevelocityConfig} from '../configuration'
 import {recordDeprecation} from '../deprecation-collector'
 
-/**
- * Exchange the configured Develocity access key(s) for short-lived tokens, export them as the access
- * key env vars, and return the short-lived token matching the configured Develocity server URL (for
- * use as the `develocityAccessToken` cache option). Returns `undefined` when there is no access key,
- * token fetching fails, or no token matches the configured server.
- */
-export async function setupToken(config: DevelocityConfig): Promise<string | undefined> {
-    const develocityAccessKey = config.getDevelocityAccessKey()
-    if (!develocityAccessKey) {
-        return undefined
-    }
-    try {
-        core.debug('Fetching short-lived token...')
-        const tokens = await getToken(
-            develocityAccessKey,
-            config.getDevelocityAllowUntrustedServer(),
-            config.getDevelocityTokenExpiry()
-        )
-        if (tokens != null && !tokens.isEmpty()) {
-            core.debug(`Got token(s), setting the access key env vars`)
-            const token = tokens.raw()
-            core.setSecret(token)
-            exportAccessKeyEnvVars(token)
-            for (const k of tokens.keys) {
-                core.setSecret(k.key)
+export async function setupToken(
+    develocityAccessKey: string,
+    develocityAllowUntrustedServer: boolean | undefined,
+    develocityTokenExpiry: string
+): Promise<void> {
+    if (develocityAccessKey) {
+        try {
+            core.debug('Fetching short-lived token...')
+            const tokens = await getToken(develocityAccessKey, develocityAllowUntrustedServer, develocityTokenExpiry)
+            if (tokens != null && !tokens.isEmpty()) {
+                core.debug(`Got token(s), setting the access key env vars`)
+                const token = tokens.raw()
+                core.setSecret(token)
+                exportAccessKeyEnvVars(token)
+            } else {
+                handleMissingAccessToken()
             }
-            const serverUrl = config.getDevelocityUrl()
-            return serverUrl ? resolveTokenForServer(tokens, serverUrl) : undefined
+        } catch (e) {
+            handleMissingAccessToken()
+            core.warning(`Failed to fetch short-lived token, reason: ${e}`)
         }
-        handleMissingAccessToken()
-    } catch (e) {
-        handleMissingAccessToken()
-        core.warning(`Failed to fetch short-lived token, reason: ${e}`)
     }
-    return undefined
 }
 
 function exportAccessKeyEnvVars(value: string): void {
@@ -187,20 +174,3 @@ export class DevelocityAccessCredentials {
         return this.accessKeyRegexp.test(allKeys)
     }
 }
-
-/**
- * Resolve the token whose hostname matches a given Develocity server URL. Returns `undefined`
- * (fail-closed) when the server URL is empty or no token matches the server's host.
- */
-export function resolveTokenForServer(tokens: DevelocityAccessCredentials, serverUrl: string): string | undefined {
-    if (!serverUrl) {
-        return undefined
-    }
-    let host: string
-    try {
-        host = new URL(serverUrl).hostname
-    } catch {
-        host = serverUrl // tolerate a bare hostname (no scheme)
-    }
-    return tokens.keys.find(k => k.hostname === host)?.key
-}

sources/src/job-summary.ts

@@ -13,8 +13,6 @@ export async function generateJobSummary(
     providerNote: ProviderNote | undefined,
     config: SummaryConfig
 ): Promise<void> {
-    core.startGroup('Generating Job Summary')
-
     const errors = renderErrors()
     if (errors) {
         core.summary.addRaw(errors)
@@ -25,17 +23,19 @@ export async function generateJobSummary(
     const summaryTable = renderSummaryTable(buildResults)
     const cachingReport = renderCachingReport(cacheReport, providerNote)
     const hasFailure = anyFailed(buildResults)
-
-    core.info(summaryTable)
-    core.info('============================')
-    core.info(cachingReport)
-
     if (config.shouldGenerateJobSummary(hasFailure)) {
+        core.info('Generating Job Summary')
+
         core.summary.addRaw(summaryTable)
         core.summary.addRaw(cachingReport)
         await core.summary.write()
+    } else {
+        core.info('============================')
+        core.info(summaryTable)
+        core.info('============================')
+        core.info(cachingReport)
+        core.info('============================')
     }
-    core.endGroup()
 
     if (config.canAddPRComment()) {
         await minimizeObsoletePRComments()

sources/src/setup-gradle.ts

@@ -5,7 +5,6 @@ import * as path from 'path'
 import * as os from 'os'
 import * as jobSummary from './job-summary'
 import * as buildScan from './develocity/build-scan'
-import {setupToken} from './develocity/short-lived-token'
 
 import {loadBuildResults, markBuildResultsProcessed} from './build-results'
 import {getCacheService, getProviderNote} from './cache-service-loader'
@@ -22,8 +21,6 @@ import {initializeGradleUserHome} from './gradle-user-home'
 
 const GRADLE_SETUP_VAR = 'GRADLE_BUILD_ACTION_SETUP_COMPLETED'
 const GRADLE_USER_HOME = 'GRADLE_USER_HOME'
-// Short-lived Develocity token for the configured server, resolved during setup and reused on save.
-const DEVELOCITY_CACHE_TOKEN = 'DEVELOCITY_CACHE_TOKEN'
 
 export async function setup(
     cacheConfig: CacheConfig,
@@ -47,27 +44,17 @@ export async function setup(
 
     initializeGradleUserHome(userHome, gradleUserHome, cacheConfig.getCacheEncryptionKey())
 
-    // Exchange the long-lived access key(s) for short-lived tokens, resolving the token for the
-    // configured Develocity server and retaining it for the post-action (save) step.
-    const develocityServerUrl = develocityConfig.getDevelocityUrl() || undefined
-    const cacheToken = await setupToken(develocityConfig)
-    core.saveState(DEVELOCITY_CACHE_TOKEN, cacheToken ?? '')
-
     const cacheService = await getCacheService(cacheConfig)
-    await cacheService.restore(gradleUserHome, cacheOptionsFrom(cacheConfig, develocityServerUrl, cacheToken))
+    await cacheService.restore(gradleUserHome, cacheOptionsFrom(cacheConfig))
 
     await wrapperValidator.validateWrappers(wrapperValidationConfig, getWorkspaceDirectory(), gradleUserHome)
 
-    buildScan.setup(develocityConfig)
+    await buildScan.setup(develocityConfig)
 
     return true
 }
 
-export async function complete(
-    cacheConfig: CacheConfig,
-    develocityConfig: DevelocityConfig,
-    summaryConfig: SummaryConfig
-): Promise<boolean> {
+export async function complete(cacheConfig: CacheConfig, summaryConfig: SummaryConfig): Promise<boolean> {
     if (!core.getState(GRADLE_SETUP_VAR)) {
         core.info('Gradle setup post-action only performed for first gradle/actions step in workflow.')
         return false
@@ -77,14 +64,8 @@ export async function complete(
     const buildResults = loadBuildResults()
 
     const gradleUserHome = core.getState(GRADLE_USER_HOME)
-    const develocityServerUrl = develocityConfig.getDevelocityUrl() || undefined
-    const cacheToken = core.getState(DEVELOCITY_CACHE_TOKEN) || undefined
     const cacheService = await getCacheService(cacheConfig)
-    const cacheReport = await cacheService.save(
-        gradleUserHome,
-        buildResults,
-        cacheOptionsFrom(cacheConfig, develocityServerUrl, cacheToken)
-    )
+    const cacheReport = await cacheService.save(gradleUserHome, buildResults, cacheOptionsFrom(cacheConfig))
     await jobSummary.generateJobSummary(buildResults, cacheReport, getProviderNote(cacheConfig), summaryConfig)
 
     markBuildResultsProcessed()
@@ -94,11 +75,7 @@ export async function complete(
     return true
 }
 
-function cacheOptionsFrom(
-    config: CacheConfig,
-    develocityServerUrl: string | undefined,
-    develocityAccessToken: string | undefined
-): CacheOptions {
+function cacheOptionsFrom(config: CacheConfig): CacheOptions {
     return {
         disabled: config.isCacheDisabled(),
         readOnly: config.isCacheReadOnly(),
@@ -107,8 +84,6 @@ function cacheOptionsFrom(
         strictMatch: config.isCacheStrictMatch(),
         cleanup: config.getCacheCleanupOption(),
         encryptionKey: config.getCacheEncryptionKey() || undefined,
-        develocityAccessToken,
-        develocityServerUrl,
         includes: config.getCacheIncludes(),
         excludes: config.getCacheExcludes()
     }

sources/test/jest/caching-report.test.ts

@@ -79,39 +79,37 @@ describe('renderCachingReport', () => {
         expect(md).toContain('<summary>Entries: 1 restored, 0 saved - Expand for more details</summary>')
     })
 
-    it('renders the project-cache status line inside the details', () => {
+    it('renders the configuration-cache status line inside the details', () => {
         const report: CacheReport = {
             status: 'enabled',
             cleanup: 'enabled',
-            projectCache: 'enabled',
+            configurationCache: 'restored',
             entries: [entry()]
         }
         const md = renderCachingReport(report, ENHANCED)
 
         const detailsBody = md.slice(md.indexOf('</summary>'))
-        expect(detailsBody).toContain(
-            'Caching of project state (build-logic and configuration cache) was enabled.'
-        )
+        expect(detailsBody).toContain('Configuration cache state was restored from the cache.')
     })
 
-    it('renders nothing for the not-enabled project-cache status', () => {
+    it('explains an inactive configuration cache with a link to the encryption key docs', () => {
         const report: CacheReport = {
             status: 'enabled',
             cleanup: 'enabled',
-            projectCache: 'not-enabled',
+            configurationCache: 'not-active',
             entries: [entry()]
         }
         const md = renderCachingReport(report, ENHANCED)
 
-        expect(md).not.toContain('Project state')
-        expect(md).not.toContain('build-logic')
+        expect(md).toContain('Configuration cache state was not cached')
+        expect(md).toContain('#cache-encryption-key')
     })
 
-    it('omits the project-cache line when the status is absent', () => {
+    it('omits the configuration-cache line when the status is absent', () => {
         const report: CacheReport = {status: 'enabled', cleanup: 'enabled', entries: [entry()]}
         const md = renderCachingReport(report, ENHANCED)
 
-        expect(md).not.toContain('Project state')
+        expect(md).not.toContain('Configuration cache state')
     })
 
     it('renders a compact disabled report with no note and no details', () => {

sources/test/jest/short-lived-token.test.ts

@@ -1,7 +1,7 @@
 import nock from "nock";
 import {describe, expect, it} from '@jest/globals'
 
-import {DevelocityAccessCredentials, getToken, resolveTokenForServer} from "../../src/develocity/short-lived-token";
+import {DevelocityAccessCredentials, getToken} from "../../src/develocity/short-lived-token";
 
 describe('short lived tokens', () => {
     it('parse valid access key should return an object', async () => {
@@ -134,42 +134,3 @@ describe('short lived tokens with retry', () => {
             .toBeNull()
     })
 })
-
-describe('resolveTokenForServer', () => {
-    const credentials = (...pairs: [string, string][]): DevelocityAccessCredentials =>
-        DevelocityAccessCredentials.of(pairs.map(([hostname, key]) => ({hostname, key})))
-
-    it('returns the token matching the server host from a full URL', () => {
-        const tokens = credentials(['ge.example.com', 'key1'], ['other', 'key2'])
-        expect(resolveTokenForServer(tokens, 'https://ge.example.com')).toBe('key1')
-    })
-
-    it('matches on hostname, ignoring scheme, port and path', () => {
-        const tokens = credentials(['ge.example.com', 'key1'])
-        expect(resolveTokenForServer(tokens, 'https://ge.example.com:8443/path')).toBe('key1')
-    })
-
-    it('tolerates a bare hostname with no scheme', () => {
-        const tokens = credentials(['ge.example.com', 'key1'])
-        expect(resolveTokenForServer(tokens, 'ge.example.com')).toBe('key1')
-    })
-
-    it('selects the matching token when multiple are present', () => {
-        const tokens = credentials(['dev', 'key1'], ['ge.example.com', 'key2'])
-        expect(resolveTokenForServer(tokens, 'https://ge.example.com')).toBe('key2')
-    })
-
-    it('returns undefined when no token matches the server host', () => {
-        const tokens = credentials(['ge.example.com', 'key1'])
-        expect(resolveTokenForServer(tokens, 'https://other.example.com')).toBeUndefined()
-    })
-
-    it('returns undefined for an empty server URL', () => {
-        const tokens = credentials(['ge.example.com', 'key1'])
-        expect(resolveTokenForServer(tokens, '')).toBeUndefined()
-    })
-
-    it('returns undefined when there are no tokens', () => {
-        expect(resolveTokenForServer(credentials(), 'https://ge.example.com')).toBeUndefined()
-    })
-})