mirror of
				https://github.com/actions/setup-java.git
				synced 2025-11-04 08:20:54 +00:00 
			
		
		
		
	use the key in state to save caches in the post process
This commit is contained in:
		
					parent
					
						
							
								6977c031ae
							
						
					
				
			
			
				commit
				
					
						7fe6c4d631
					
				
			
		
					 5 changed files with 102 additions and 17 deletions
				
			
		| 
						 | 
					@ -45,6 +45,7 @@ describe('dependency cache', () => {
 | 
				
			||||||
    process.chdir(ORIGINAL_CWD);
 | 
					    process.chdir(ORIGINAL_CWD);
 | 
				
			||||||
    process.env['GITHUB_WORKSPACE'] = ORIGINAL_GITHUB_WORKSPACE;
 | 
					    process.env['GITHUB_WORKSPACE'] = ORIGINAL_GITHUB_WORKSPACE;
 | 
				
			||||||
    process.env['RUNNER_OS'] = ORIGINAL_RUNNER_OS;
 | 
					    process.env['RUNNER_OS'] = ORIGINAL_RUNNER_OS;
 | 
				
			||||||
 | 
					    resetState();
 | 
				
			||||||
  });
 | 
					  });
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  describe('restore', () => {
 | 
					  describe('restore', () => {
 | 
				
			||||||
| 
						 | 
					@ -126,13 +127,21 @@ describe('dependency cache', () => {
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    describe('for maven', () => {
 | 
					    describe('for maven', () => {
 | 
				
			||||||
      it('uploads cache even if no pom.xml found', async () => {
 | 
					      it('uploads cache even if no pom.xml found', async () => {
 | 
				
			||||||
 | 
					        createStateForMissingBuildFile();
 | 
				
			||||||
        await save('maven');
 | 
					        await save('maven');
 | 
				
			||||||
        expect(spyCacheSave).toBeCalled();
 | 
					        expect(spyCacheSave).toBeCalled();
 | 
				
			||||||
        expect(spyWarning).not.toBeCalled();
 | 
					        expect(spyWarning).not.toBeCalled();
 | 
				
			||||||
        expect(spyInfo).toBeCalledWith(expect.stringMatching(/^Cache saved with the key:.*/));
 | 
					      });
 | 
				
			||||||
 | 
					      it('does not upload cache if no restore run before', async () => {
 | 
				
			||||||
 | 
					        createFile(join(workspace, 'pom.xml'));
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        await save('maven');
 | 
				
			||||||
 | 
					        expect(spyCacheSave).not.toBeCalled();
 | 
				
			||||||
 | 
					        expect(spyWarning).toBeCalledWith('Error retrieving key from state.');
 | 
				
			||||||
      });
 | 
					      });
 | 
				
			||||||
      it('uploads cache', async () => {
 | 
					      it('uploads cache', async () => {
 | 
				
			||||||
        createFile(join(workspace, 'pom.xml'));
 | 
					        createFile(join(workspace, 'pom.xml'));
 | 
				
			||||||
 | 
					        createStateForSuccessfulRestore();
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        await save('maven');
 | 
					        await save('maven');
 | 
				
			||||||
        expect(spyCacheSave).toBeCalled();
 | 
					        expect(spyCacheSave).toBeCalled();
 | 
				
			||||||
| 
						 | 
					@ -142,13 +151,22 @@ describe('dependency cache', () => {
 | 
				
			||||||
    });
 | 
					    });
 | 
				
			||||||
    describe('for gradle', () => {
 | 
					    describe('for gradle', () => {
 | 
				
			||||||
      it('uploads cache even if no build.gradle found', async () => {
 | 
					      it('uploads cache even if no build.gradle found', async () => {
 | 
				
			||||||
 | 
					        createStateForMissingBuildFile();
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        await save('gradle');
 | 
					        await save('gradle');
 | 
				
			||||||
        expect(spyCacheSave).toBeCalled();
 | 
					        expect(spyCacheSave).toBeCalled();
 | 
				
			||||||
        expect(spyWarning).not.toBeCalled();
 | 
					        expect(spyWarning).not.toBeCalled();
 | 
				
			||||||
        expect(spyInfo).toBeCalledWith(expect.stringMatching(/^Cache saved with the key:.*/));
 | 
					      });
 | 
				
			||||||
 | 
					      it('does not upload cache if no restore run before', async () => {
 | 
				
			||||||
 | 
					        createFile(join(workspace, 'build.gradle'));
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        await save('gradle');
 | 
				
			||||||
 | 
					        expect(spyCacheSave).not.toBeCalled();
 | 
				
			||||||
 | 
					        expect(spyWarning).toBeCalledWith('Error retrieving key from state.');
 | 
				
			||||||
      });
 | 
					      });
 | 
				
			||||||
      it('uploads cache based on build.gradle', async () => {
 | 
					      it('uploads cache based on build.gradle', async () => {
 | 
				
			||||||
        createFile(join(workspace, 'build.gradle'));
 | 
					        createFile(join(workspace, 'build.gradle'));
 | 
				
			||||||
 | 
					        createStateForSuccessfulRestore();
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        await save('gradle');
 | 
					        await save('gradle');
 | 
				
			||||||
        expect(spyCacheSave).toBeCalled();
 | 
					        expect(spyCacheSave).toBeCalled();
 | 
				
			||||||
| 
						 | 
					@ -157,6 +175,7 @@ describe('dependency cache', () => {
 | 
				
			||||||
      });
 | 
					      });
 | 
				
			||||||
      it('uploads cache based on build.gradle.kts', async () => {
 | 
					      it('uploads cache based on build.gradle.kts', async () => {
 | 
				
			||||||
        createFile(join(workspace, 'build.gradle.kts'));
 | 
					        createFile(join(workspace, 'build.gradle.kts'));
 | 
				
			||||||
 | 
					        createStateForSuccessfulRestore();
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        await save('gradle');
 | 
					        await save('gradle');
 | 
				
			||||||
        expect(spyCacheSave).toBeCalled();
 | 
					        expect(spyCacheSave).toBeCalled();
 | 
				
			||||||
| 
						 | 
					@ -167,6 +186,40 @@ describe('dependency cache', () => {
 | 
				
			||||||
  });
 | 
					  });
 | 
				
			||||||
});
 | 
					});
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					function resetState() {
 | 
				
			||||||
 | 
					  jest.spyOn(core, 'getState').mockReset();
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/**
 | 
				
			||||||
 | 
					 * Create states to emulate a restore process without build file.
 | 
				
			||||||
 | 
					 */
 | 
				
			||||||
 | 
					function createStateForMissingBuildFile() {
 | 
				
			||||||
 | 
					  jest.spyOn(core, 'getState').mockImplementation(name => {
 | 
				
			||||||
 | 
					    switch (name) {
 | 
				
			||||||
 | 
					      case 'cache-primary-key':
 | 
				
			||||||
 | 
					        return 'setup-java-cache-';
 | 
				
			||||||
 | 
					      default:
 | 
				
			||||||
 | 
					        return '';
 | 
				
			||||||
 | 
					    }
 | 
				
			||||||
 | 
					  });
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/**
 | 
				
			||||||
 | 
					 * Create states to emulate a successful restore process.
 | 
				
			||||||
 | 
					 */
 | 
				
			||||||
 | 
					function createStateForSuccessfulRestore() {
 | 
				
			||||||
 | 
					  jest.spyOn(core, 'getState').mockImplementation(name => {
 | 
				
			||||||
 | 
					    switch (name) {
 | 
				
			||||||
 | 
					      case 'cache-primary-key':
 | 
				
			||||||
 | 
					        return 'setup-java-cache-primary-key';
 | 
				
			||||||
 | 
					      case 'cache-matched-key':
 | 
				
			||||||
 | 
					        return 'setup-java-cache-matched-key';
 | 
				
			||||||
 | 
					      default:
 | 
				
			||||||
 | 
					        return '';
 | 
				
			||||||
 | 
					    }
 | 
				
			||||||
 | 
					  });
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
function createFile(path: string) {
 | 
					function createFile(path: string) {
 | 
				
			||||||
  core.info(`created a file at ${path}`);
 | 
					  core.info(`created a file at ${path}`);
 | 
				
			||||||
  fs.writeFileSync(path, '');
 | 
					  fs.writeFileSync(path, '');
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,25 +1,21 @@
 | 
				
			||||||
import { mkdtempSync } from 'fs';
 | 
					 | 
				
			||||||
import { tmpdir } from 'os';
 | 
					 | 
				
			||||||
import { join } from 'path';
 | 
					 | 
				
			||||||
import { restore, save } from '../src/cache';
 | 
					 | 
				
			||||||
import { run as cleanup } from '../src/cleanup-java';
 | 
					import { run as cleanup } from '../src/cleanup-java';
 | 
				
			||||||
import * as fs from 'fs';
 | 
					 | 
				
			||||||
import * as os from 'os';
 | 
					 | 
				
			||||||
import * as core from '@actions/core';
 | 
					import * as core from '@actions/core';
 | 
				
			||||||
import * as cache from '@actions/cache';
 | 
					import * as cache from '@actions/cache';
 | 
				
			||||||
 | 
					
 | 
				
			||||||
describe('cleanup', () => {
 | 
					describe('cleanup', () => {
 | 
				
			||||||
  let spyInfo: jest.SpyInstance<void, Parameters<typeof core.info>>;
 | 
					 | 
				
			||||||
  let spyWarning: jest.SpyInstance<void, Parameters<typeof core.warning>>;
 | 
					  let spyWarning: jest.SpyInstance<void, Parameters<typeof core.warning>>;
 | 
				
			||||||
 | 
					 | 
				
			||||||
  let spyCacheSave: jest.SpyInstance<
 | 
					  let spyCacheSave: jest.SpyInstance<
 | 
				
			||||||
    ReturnType<typeof cache.saveCache>,
 | 
					    ReturnType<typeof cache.saveCache>,
 | 
				
			||||||
    Parameters<typeof cache.saveCache>
 | 
					    Parameters<typeof cache.saveCache>
 | 
				
			||||||
  >;
 | 
					  >;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  beforeEach(() => {
 | 
					  beforeEach(() => {
 | 
				
			||||||
    spyInfo = jest.spyOn(core, 'info');
 | 
					 | 
				
			||||||
    spyWarning = jest.spyOn(core, 'warning');
 | 
					    spyWarning = jest.spyOn(core, 'warning');
 | 
				
			||||||
    spyCacheSave = jest.spyOn(cache, 'saveCache');
 | 
					    spyCacheSave = jest.spyOn(cache, 'saveCache');
 | 
				
			||||||
 | 
					    createStateForSuccessfulRestore();
 | 
				
			||||||
 | 
					  });
 | 
				
			||||||
 | 
					  afterEach(() => {
 | 
				
			||||||
 | 
					    resetState();
 | 
				
			||||||
  });
 | 
					  });
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  it('does not fail nor warn even when the save provess throws a ReserveCacheError', async () => {
 | 
					  it('does not fail nor warn even when the save provess throws a ReserveCacheError', async () => {
 | 
				
			||||||
| 
						 | 
					@ -49,3 +45,23 @@ describe('cleanup', () => {
 | 
				
			||||||
    expect(spyCacheSave).toBeCalled();
 | 
					    expect(spyCacheSave).toBeCalled();
 | 
				
			||||||
  });
 | 
					  });
 | 
				
			||||||
});
 | 
					});
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					function resetState() {
 | 
				
			||||||
 | 
					  jest.spyOn(core, 'getState').mockReset();
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/**
 | 
				
			||||||
 | 
					 * Create states to emulate a successful restore process.
 | 
				
			||||||
 | 
					 */
 | 
				
			||||||
 | 
					function createStateForSuccessfulRestore() {
 | 
				
			||||||
 | 
					  jest.spyOn(core, 'getState').mockImplementation(name => {
 | 
				
			||||||
 | 
					    switch (name) {
 | 
				
			||||||
 | 
					      case 'cache-primary-key':
 | 
				
			||||||
 | 
					        return 'setup-java-cache-primary-key';
 | 
				
			||||||
 | 
					      case 'cache-matched-key':
 | 
				
			||||||
 | 
					        return 'setup-java-cache-matched-key';
 | 
				
			||||||
 | 
					      default:
 | 
				
			||||||
 | 
					        return '';
 | 
				
			||||||
 | 
					    }
 | 
				
			||||||
 | 
					  });
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
							
								
								
									
										9
									
								
								dist/cleanup/index.js
									
										
									
									
										vendored
									
									
								
							
							
						
						
									
										9
									
								
								dist/cleanup/index.js
									
										
									
									
										vendored
									
									
								
							| 
						 | 
					@ -64602,9 +64602,14 @@ exports.restore = restore;
 | 
				
			||||||
function save(id) {
 | 
					function save(id) {
 | 
				
			||||||
    return __awaiter(this, void 0, void 0, function* () {
 | 
					    return __awaiter(this, void 0, void 0, function* () {
 | 
				
			||||||
        const packageManager = findPackageManager(id);
 | 
					        const packageManager = findPackageManager(id);
 | 
				
			||||||
        const primaryKey = yield computeCacheKey(packageManager);
 | 
					 | 
				
			||||||
        const matchedKey = core.getState(CACHE_MATCHED_KEY);
 | 
					        const matchedKey = core.getState(CACHE_MATCHED_KEY);
 | 
				
			||||||
        if (matchedKey === primaryKey) {
 | 
					        // Inputs are re-evaluted before the post action, so we want the original key used for restore
 | 
				
			||||||
 | 
					        const primaryKey = core.getState(STATE_CACHE_PRIMARY_KEY);
 | 
				
			||||||
 | 
					        if (!primaryKey) {
 | 
				
			||||||
 | 
					            core.warning('Error retrieving key from state.');
 | 
				
			||||||
 | 
					            return;
 | 
				
			||||||
 | 
					        }
 | 
				
			||||||
 | 
					        else if (matchedKey === primaryKey) {
 | 
				
			||||||
            // no change in target directories
 | 
					            // no change in target directories
 | 
				
			||||||
            core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
 | 
					            core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
 | 
				
			||||||
            return;
 | 
					            return;
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
							
								
								
									
										9
									
								
								dist/setup/index.js
									
										
									
									
										vendored
									
									
								
							
							
						
						
									
										9
									
								
								dist/setup/index.js
									
										
									
									
										vendored
									
									
								
							| 
						 | 
					@ -18998,9 +18998,14 @@ exports.restore = restore;
 | 
				
			||||||
function save(id) {
 | 
					function save(id) {
 | 
				
			||||||
    return __awaiter(this, void 0, void 0, function* () {
 | 
					    return __awaiter(this, void 0, void 0, function* () {
 | 
				
			||||||
        const packageManager = findPackageManager(id);
 | 
					        const packageManager = findPackageManager(id);
 | 
				
			||||||
        const primaryKey = yield computeCacheKey(packageManager);
 | 
					 | 
				
			||||||
        const matchedKey = core.getState(CACHE_MATCHED_KEY);
 | 
					        const matchedKey = core.getState(CACHE_MATCHED_KEY);
 | 
				
			||||||
        if (matchedKey === primaryKey) {
 | 
					        // Inputs are re-evaluted before the post action, so we want the original key used for restore
 | 
				
			||||||
 | 
					        const primaryKey = core.getState(STATE_CACHE_PRIMARY_KEY);
 | 
				
			||||||
 | 
					        if (!primaryKey) {
 | 
				
			||||||
 | 
					            core.warning('Error retrieving key from state.');
 | 
				
			||||||
 | 
					            return;
 | 
				
			||||||
 | 
					        }
 | 
				
			||||||
 | 
					        else if (matchedKey === primaryKey) {
 | 
				
			||||||
            // no change in target directories
 | 
					            // no change in target directories
 | 
				
			||||||
            core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
 | 
					            core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
 | 
				
			||||||
            return;
 | 
					            return;
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
							
								
								
									
										10
									
								
								src/cache.ts
									
										
									
									
									
								
							
							
						
						
									
										10
									
								
								src/cache.ts
									
										
									
									
									
								
							| 
						 | 
					@ -90,9 +90,15 @@ export async function restore(id: string) {
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
export async function save(id: string) {
 | 
					export async function save(id: string) {
 | 
				
			||||||
  const packageManager = findPackageManager(id);
 | 
					  const packageManager = findPackageManager(id);
 | 
				
			||||||
  const primaryKey = await computeCacheKey(packageManager);
 | 
					 | 
				
			||||||
  const matchedKey = core.getState(CACHE_MATCHED_KEY);
 | 
					  const matchedKey = core.getState(CACHE_MATCHED_KEY);
 | 
				
			||||||
  if (matchedKey === primaryKey) {
 | 
					
 | 
				
			||||||
 | 
					  // Inputs are re-evaluted before the post action, so we want the original key used for restore
 | 
				
			||||||
 | 
					  const primaryKey = core.getState(STATE_CACHE_PRIMARY_KEY);
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					  if (!primaryKey) {
 | 
				
			||||||
 | 
					    core.warning('Error retrieving key from state.');
 | 
				
			||||||
 | 
					    return;
 | 
				
			||||||
 | 
					  } else if (matchedKey === primaryKey) {
 | 
				
			||||||
    // no change in target directories
 | 
					    // no change in target directories
 | 
				
			||||||
    core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
 | 
					    core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
 | 
				
			||||||
    return;
 | 
					    return;
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue