Merge a8e0c559af into cd89f46ac9

* Add versions properties to cache

* lint fix

npm run format change

* [FIX] unit test

* docs: fix typo in the Readme.md

* docs: update link to the toolkit/cache package

---------

Co-authored-by: Ivan Zosimov <ivan.zosimov@Ivans-MacBook-Pro.local>

README.md

@@ -41,6 +41,8 @@ This action allows you to work with Java and Scala projects.
 
   - `cache`: Quick [setup caching](#caching-packages-dependencies) for the dependencies managed through one of the predifined package managers. It can be one of "maven", "gradle" or "sbt".
 
+  - `cache-dependency-path`: The path to a dependency file: pom.xml, build.gradle, build.sbt, etc. This option can be used with the `cache` option. If this option is omitted, the action searches for the dependency file in the entire repository. This option supports wildcards and a list of file names for caching multiple dependencies.
+
   #### Maven options
   The action has a bunch of inputs to generate maven's [settings.xml](https://maven.apache.org/settings.html) on the fly and pass the values to Apache Maven GPG Plugin as well as Apache Maven Toolchains. See [advanced usage](docs/advanced-usage.md) for more.
 
@@ -113,11 +115,14 @@ Currently, the following distributions are supported:
 **NOTE:** For Azul Zulu OpenJDK architectures x64 and arm64 are mapped to x86 / arm with proper hw_bitness.
 
 ### Caching packages dependencies
-The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under hood for caching dependencies but requires less configuration settings. Supported package managers are gradle, maven and sbt. The format of the used cache key is `setup-java-${{ platform }}-${{ packageManager }}-${{ fileHash }}`, where the hash is based on the following files:
+The action has a built-in functionality for caching and restoring dependencies. It uses [toolkit/cache](https://github.com/actions/toolkit/tree/main/packages/cache) under hood for caching dependencies but requires less configuration settings. Supported package managers are gradle, maven and sbt. The format of the used cache key is `setup-java-${{ platform }}-${{ packageManager }}-${{ fileHash }}`, where the hash is based on the following files:
-- gradle: `**/*.gradle*`, `**/gradle-wrapper.properties`, `buildSrc/**/Versions.kt`, `buildSrc/**/Dependencies.kt`, and `gradle/*.versions.toml`
+
+- gradle: `**/*.gradle*`, `**/gradle-wrapper.properties`, `buildSrc/**/Versions.kt`, `buildSrc/**/Dependencies.kt`, `gradle/*.versions.toml`, and `**/versions.properties`
 - maven: `**/pom.xml`
 - sbt: all sbt build definition files `**/*.sbt`, `**/project/build.properties`, `**/project/**.scala`, `**/project/**.sbt`
 
+When the option `cache-dependency-path` is specified, the hash is based on the matching file. This option supports wildcards and a list of file names, and is especially useful for monorepos.
+
 The workflow output `cache-hit` is set to indicate if an exact match was found for the key [as actions/cache does](https://github.com/actions/cache/tree/main#outputs).
 
 The cache input is optional, and caching is turned off by default.
@@ -131,6 +136,9 @@ steps:
     distribution: 'temurin'
     java-version: '17'
     cache: 'gradle'
+    cache-dependency-path: | # optional
+      sub-project/*.gradle*
+      sub-project/**/gradle-wrapper.properties
 - run: ./gradlew build --no-daemon
 ```
 
@@ -143,6 +151,7 @@ steps:
     distribution: 'temurin'
     java-version: '17'
     cache: 'maven'
+    cache-dependency-path: 'sub-project/pom.xml' # optional
 - name: Build with Maven
   run: mvn -B package --file pom.xml
 ```
@@ -156,6 +165,9 @@ steps:
     distribution: 'temurin'
     java-version: '17'
     cache: 'sbt'
+    cache-dependency-path: | # optional
+      sub-project/build.sbt
+      sub-project/project/build.properties
 - name: Build with SBT
   run: sbt package
 ```

__tests__/cache.test.ts

@@ -6,6 +6,7 @@ import * as fs from 'fs';
 import * as os from 'os';
 import * as core from '@actions/core';
 import * as cache from '@actions/cache';
+import * as glob from '@actions/glob';
 
 describe('dependency cache', () => {
   const ORIGINAL_RUNNER_OS = process.env['RUNNER_OS'];
@@ -64,6 +65,10 @@ describe('dependency cache', () => {
       ReturnType<typeof cache.restoreCache>,
       Parameters<typeof cache.restoreCache>
     >;
+    let spyGlobHashFiles: jest.SpyInstance<
+      ReturnType<typeof glob.hashFiles>,
+      Parameters<typeof glob.hashFiles>
+    >;
 
     beforeEach(() => {
       spyCacheRestore = jest
@@ -71,6 +76,7 @@ describe('dependency cache', () => {
         .mockImplementation((paths: string[], primaryKey: string) =>
           Promise.resolve(undefined)
         );
+      spyGlobHashFiles = jest.spyOn(glob, 'hashFiles');
       spyWarning.mockImplementation(() => null);
     });
 
@@ -93,6 +99,7 @@ describe('dependency cache', () => {
 
         await restore('maven');
         expect(spyCacheRestore).toHaveBeenCalled();
+        expect(spyGlobHashFiles).toHaveBeenCalledWith('**/pom.xml');
         expect(spyWarning).not.toHaveBeenCalled();
         expect(spyInfo).toHaveBeenCalledWith('maven cache is not found');
       });
@@ -102,7 +109,7 @@ describe('dependency cache', () => {
         await expect(restore('gradle')).rejects.toThrow(
           `No file in ${projectRoot(
             workspace
-          )} matched to [**/*.gradle*,**/gradle-wrapper.properties,buildSrc/**/Versions.kt,buildSrc/**/Dependencies.kt,gradle/*.versions.toml], make sure you have checked out the target repository`
+          )} matched to [**/*.gradle*,**/gradle-wrapper.properties,buildSrc/**/Versions.kt,buildSrc/**/Dependencies.kt,gradle/*.versions.toml,**/versions.properties], make sure you have checked out the target repository`
         );
       });
       it('downloads cache based on build.gradle', async () => {
@@ -110,6 +117,9 @@ describe('dependency cache', () => {
 
         await restore('gradle');
         expect(spyCacheRestore).toHaveBeenCalled();
+        expect(spyGlobHashFiles).toHaveBeenCalledWith(
+          '**/*.gradle*\n**/gradle-wrapper.properties\nbuildSrc/**/Versions.kt\nbuildSrc/**/Dependencies.kt\ngradle/*.versions.toml\n**/versions.properties'
+        );
         expect(spyWarning).not.toHaveBeenCalled();
         expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
       });
@@ -118,6 +128,9 @@ describe('dependency cache', () => {
 
         await restore('gradle');
         expect(spyCacheRestore).toHaveBeenCalled();
+        expect(spyGlobHashFiles).toHaveBeenCalledWith(
+          '**/*.gradle*\n**/gradle-wrapper.properties\nbuildSrc/**/Versions.kt\nbuildSrc/**/Dependencies.kt\ngradle/*.versions.toml\n**/versions.properties'
+        );
         expect(spyWarning).not.toHaveBeenCalled();
         expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
       });
@@ -127,18 +140,24 @@ describe('dependency cache', () => {
 
         await restore('gradle');
         expect(spyCacheRestore).toHaveBeenCalled();
+        expect(spyGlobHashFiles).toHaveBeenCalledWith(
+          '**/*.gradle*\n**/gradle-wrapper.properties\nbuildSrc/**/Versions.kt\nbuildSrc/**/Dependencies.kt\ngradle/*.versions.toml\n**/versions.properties'
+        );
         expect(spyWarning).not.toHaveBeenCalled();
         expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
       });
-    });
+      it('downloads cache based on buildSrc/Versions.kt', async () => {
-    it('downloads cache based on buildSrc/Versions.kt', async () => {
+        createDirectory(join(workspace, 'buildSrc'));
-      createDirectory(join(workspace, 'buildSrc'));
+        createFile(join(workspace, 'buildSrc', 'Versions.kt'));
-      createFile(join(workspace, 'buildSrc', 'Versions.kt'));
 
-      await restore('gradle');
+        await restore('gradle');
-      expect(spyCacheRestore).toHaveBeenCalled();
+        expect(spyCacheRestore).toHaveBeenCalled();
-      expect(spyWarning).not.toHaveBeenCalled();
+        expect(spyGlobHashFiles).toHaveBeenCalledWith(
-      expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
+          '**/*.gradle*\n**/gradle-wrapper.properties\nbuildSrc/**/Versions.kt\nbuildSrc/**/Dependencies.kt\ngradle/*.versions.toml\n**/versions.properties'
+        );
+        expect(spyWarning).not.toHaveBeenCalled();
+        expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
+      });
     });
     describe('for sbt', () => {
       it('throws error if no build.sbt found', async () => {
@@ -153,6 +172,9 @@ describe('dependency cache', () => {
 
         await restore('sbt');
         expect(spyCacheRestore).toHaveBeenCalled();
+        expect(spyGlobHashFiles).toHaveBeenCalledWith(
+          '**/*.sbt\n**/project/build.properties\n**/project/**.scala\n**/project/**.sbt'
+        );
         expect(spyWarning).not.toHaveBeenCalled();
         expect(spyInfo).toHaveBeenCalledWith('sbt cache is not found');
       });
@@ -179,6 +201,58 @@ describe('dependency cache', () => {
         expect(firstCall).not.toBe(thirdCall);
       });
     });
+    it('downloads cache based on versions.properties', async () => {
+      createFile(join(workspace, 'versions.properties'));
+
+      await restore('gradle');
+      expect(spyCacheRestore).toHaveBeenCalled();
+      expect(spyGlobHashFiles).toHaveBeenCalledWith(
+        '**/*.gradle*\n**/gradle-wrapper.properties\nbuildSrc/**/Versions.kt\nbuildSrc/**/Dependencies.kt\ngradle/*.versions.toml\n**/versions.properties'
+      );
+      expect(spyWarning).not.toHaveBeenCalled();
+      expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
+    });
+    describe('cache-dependency-path', () => {
+      it('throws error if no matching dependency file found', async () => {
+        createFile(join(workspace, 'build.gradle.kts'));
+        await expect(
+          restore('gradle', 'sub-project/**/build.gradle.kts')
+        ).rejects.toThrow(
+          `No file in ${projectRoot(
+            workspace
+          )} matched to [sub-project/**/build.gradle.kts], make sure you have checked out the target repository`
+        );
+      });
+      it('downloads cache based on the specified pattern', async () => {
+        createFile(join(workspace, 'build.gradle.kts'));
+        createDirectory(join(workspace, 'sub-project1'));
+        createFile(join(workspace, 'sub-project1', 'build.gradle.kts'));
+        createDirectory(join(workspace, 'sub-project2'));
+        createFile(join(workspace, 'sub-project2', 'build.gradle.kts'));
+
+        await restore('gradle', 'build.gradle.kts');
+        expect(spyCacheRestore).toHaveBeenCalled();
+        expect(spyGlobHashFiles).toHaveBeenCalledWith('build.gradle.kts');
+        expect(spyWarning).not.toHaveBeenCalled();
+        expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
+
+        await restore('gradle', 'sub-project1/**/*.gradle*\n');
+        expect(spyCacheRestore).toHaveBeenCalled();
+        expect(spyGlobHashFiles).toHaveBeenCalledWith(
+          'sub-project1/**/*.gradle*'
+        );
+        expect(spyWarning).not.toHaveBeenCalled();
+        expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
+
+        await restore('gradle', '*.gradle*\nsub-project2/**/*.gradle*\n');
+        expect(spyCacheRestore).toHaveBeenCalled();
+        expect(spyGlobHashFiles).toHaveBeenCalledWith(
+          '*.gradle*\nsub-project2/**/*.gradle*'
+        );
+        expect(spyWarning).not.toHaveBeenCalled();
+        expect(spyInfo).toHaveBeenCalledWith('gradle cache is not found');
+      });
+    });
   });
   describe('save', () => {
     let spyCacheSave: jest.SpyInstance<
@@ -333,6 +407,17 @@ describe('dependency cache', () => {
           expect.stringMatching(/^Cache saved with the key:.*/)
         );
       });
+      it('uploads cache based on versions.properties', async () => {
+        createFile(join(workspace, 'versions.properties'));
+        createStateForSuccessfulRestore();
+
+        await save('gradle');
+        expect(spyCacheSave).toHaveBeenCalled();
+        expect(spyWarning).not.toHaveBeenCalled();
+        expect(spyInfo).toHaveBeenCalledWith(
+          expect.stringMatching(/^Cache saved with the key:.*/)
+        );
+      });
     });
   });
 });

src/cache.ts

@@ -39,7 +39,8 @@ const supportedPackageManager: PackageManager[] = [
       '**/gradle-wrapper.properties',
       'buildSrc/**/Versions.kt',
       'buildSrc/**/Dependencies.kt',
-      'gradle/*.versions.toml'
+      'gradle/*.versions.toml',
+      '**/versions.properties'
     ]
   },
   {
@@ -82,31 +83,34 @@ function findPackageManager(id: string): PackageManager {
 /**
  * A function that generates a cache key to use.
  * Format of the generated key will be "${{ platform }}-${{ id }}-${{ fileHash }}"".
- * If there is no file matched to {@link PackageManager.path}, the generated key ends with a dash (-).
  * @see {@link https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows#matching-a-cache-key|spec of cache key}
  */
-async function computeCacheKey(packageManager: PackageManager) {
+async function computeCacheKey(
-  const hash = await glob.hashFiles(packageManager.pattern.join('\n'));
+  packageManager: PackageManager,
-  return `${CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-${packageManager.id}-${hash}`;
+  cacheDependencyPath?: string
+) {
+  const pattern = cacheDependencyPath
+    ? cacheDependencyPath.trim().split('\n')
+    : packageManager.pattern;
+  const fileHash = await glob.hashFiles(pattern.join('\n'));
+  if (!fileHash) {
+    throw new Error(
+      `No file in ${process.cwd()} matched to [${pattern}], make sure you have checked out the target repository`
+    );
+  }
+  return `${CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-${packageManager.id}-${fileHash}`;
 }
 
 /**
  * Restore the dependency cache
  * @param id ID of the package manager, should be "maven" or "gradle"
+ * @param cacheDependencyPath The path to a dependency file
  */
-export async function restore(id: string) {
+export async function restore(id: string, cacheDependencyPath?: string) {
   const packageManager = findPackageManager(id);
-  const primaryKey = await computeCacheKey(packageManager);
+  const primaryKey = await computeCacheKey(packageManager, cacheDependencyPath);
-
   core.debug(`primary key is ${primaryKey}`);
   core.saveState(STATE_CACHE_PRIMARY_KEY, primaryKey);
-  if (primaryKey.endsWith('-')) {
-    throw new Error(
-      `No file in ${process.cwd()} matched to [${
-        packageManager.pattern
-      }], make sure you have checked out the target repository`
-    );
-  }
 
   // No "restoreKeys" is set, to start with a clear cache after dependency update (see https://github.com/actions/setup-java/issues/269)
   const matchedKey = await cache.restoreCache(packageManager.path, primaryKey);

src/constants.ts

@@ -18,6 +18,7 @@ export const INPUT_DEFAULT_GPG_PRIVATE_KEY = undefined;
 export const INPUT_DEFAULT_GPG_PASSPHRASE = 'GPG_PASSPHRASE';
 
 export const INPUT_CACHE = 'cache';
+export const INPUT_CACHE_DEPENDENCY_PATH = 'cache-dependency-path';
 export const INPUT_JOB_STATUS = 'job-status';
 
 export const STATE_GPG_PRIVATE_KEY_FINGERPRINT = 'gpg-private-key-fingerprint';

src/setup-java.ts

@@ -24,6 +24,9 @@ async function run() {
     const packageType = core.getInput(constants.INPUT_JAVA_PACKAGE);
     const jdkFile = core.getInput(constants.INPUT_JDK_FILE);
     const cache = core.getInput(constants.INPUT_CACHE);
+    const cacheDependencyPath = core.getInput(
+      constants.INPUT_CACHE_DEPENDENCY_PATH
+    );
     const checkLatest = getBooleanInput(constants.INPUT_CHECK_LATEST, false);
     let toolchainIds = core.getMultilineInput(constants.INPUT_MVN_TOOLCHAIN_ID);
 
@@ -73,7 +76,7 @@ async function run() {
 
     await auth.configureAuthentication();
     if (cache && isCacheFeatureAvailable()) {
-      await restore(cache);
+      await restore(cache, cacheDependencyPath);
     }
   } catch (error) {
     core.setFailed(error.message);