add support for read-only cache

__tests__/save.test.ts

@@ -35,6 +35,14 @@ beforeAll(() => {
         }
     );
 
+    jest.spyOn(actionUtils, "getInputAsBoolean").mockImplementation(
+        (name, options) => {
+            return jest
+                .requireActual("../src/utils/actionUtils")
+                .getInputAsBoolean(name, options);
+        }
+    );
+
     jest.spyOn(actionUtils, "isExactKeyMatch").mockImplementation(
         (key, cacheResult) => {
             return jest
@@ -388,4 +396,39 @@ test("save with valid inputs uploads a cache", async () => {
     });
 
     expect(failedMock).toHaveBeenCalledTimes(0);
+}); 
+
+test("save with read-only", async () => {
+  const failedMock = jest.spyOn(core, "setFailed");
+
+  const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
+  const savedCacheKey = "Linux-node-";
+
+  jest.spyOn(core, "getState")
+      // Cache Entry State
+      .mockImplementationOnce(() => {
+          return savedCacheKey;
+      })
+      // Cache Key State
+      .mockImplementationOnce(() => {
+          return primaryKey;
+      });
+
+  const inputPath = "node_modules";
+  testUtils.setInput(Inputs.Path, inputPath);
+  testUtils.setInput(Inputs.UploadChunkSize, "4000000");
+  testUtils.setInput(Inputs.ReadOnly, "true");
+
+  const cacheId = 4;
+  const saveCacheMock = jest
+      .spyOn(cache, "saveCache")
+      .mockImplementationOnce(() => {
+          return Promise.resolve(cacheId);
+      });
+
+  await run();
+
+  expect(saveCacheMock).toHaveBeenCalledTimes(0);
+
+  expect(failedMock).toHaveBeenCalledTimes(0);
 });

action.yml

@@ -14,6 +14,9 @@ inputs:
   upload-chunk-size:
     description: 'The chunk size used to split up large files during upload, in bytes'
     required: false
+  read-only:
+    description: 'If true, the action will only check for a cache hit and will not save a new cache'
+    required: false
 outputs:
   cache-hit:
     description: 'A boolean value to indicate an exact match was found for the primary key'

dist/restore/index.js

@@ -4947,6 +4947,7 @@ var Inputs;
     Inputs["Path"] = "path";
     Inputs["RestoreKeys"] = "restore-keys";
     Inputs["UploadChunkSize"] = "upload-chunk-size";
+    Inputs["ReadOnly"] = "read-only";
 })(Inputs = exports.Inputs || (exports.Inputs = {}));
 var Outputs;
 (function (Outputs) {
@@ -38398,7 +38399,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCacheFeatureAvailable = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.getCacheState = exports.setOutputAndState = exports.setCacheHitOutput = exports.setCacheState = exports.isExactKeyMatch = exports.isGhes = void 0;
+exports.isCacheFeatureAvailable = exports.getInputAsBoolean = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.getCacheState = exports.setOutputAndState = exports.setCacheHitOutput = exports.setCacheState = exports.isExactKeyMatch = exports.isGhes = void 0;
 const cache = __importStar(__webpack_require__(692));
 const core = __importStar(__webpack_require__(470));
 const constants_1 = __webpack_require__(196);
@@ -38464,6 +38465,10 @@ function getInputAsInt(name, options) {
     return value;
 }
 exports.getInputAsInt = getInputAsInt;
+function getInputAsBoolean(name, options) {
+    return core.getInput(name, options) === "true";
+}
+exports.getInputAsBoolean = getInputAsBoolean;
 function isCacheFeatureAvailable() {
     if (!cache.isFeatureAvailable()) {
         if (isGhes()) {

dist/save/index.js

@@ -4947,6 +4947,7 @@ var Inputs;
     Inputs["Path"] = "path";
     Inputs["RestoreKeys"] = "restore-keys";
     Inputs["UploadChunkSize"] = "upload-chunk-size";
+    Inputs["ReadOnly"] = "read-only";
 })(Inputs = exports.Inputs || (exports.Inputs = {}));
 var Outputs;
 (function (Outputs) {
@@ -38398,7 +38399,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCacheFeatureAvailable = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.getCacheState = exports.setOutputAndState = exports.setCacheHitOutput = exports.setCacheState = exports.isExactKeyMatch = exports.isGhes = void 0;
+exports.isCacheFeatureAvailable = exports.getInputAsBoolean = exports.getInputAsInt = exports.getInputAsArray = exports.isValidEvent = exports.logWarning = exports.getCacheState = exports.setOutputAndState = exports.setCacheHitOutput = exports.setCacheState = exports.isExactKeyMatch = exports.isGhes = void 0;
 const cache = __importStar(__webpack_require__(692));
 const core = __importStar(__webpack_require__(470));
 const constants_1 = __webpack_require__(196);
@@ -38464,6 +38465,10 @@ function getInputAsInt(name, options) {
     return value;
 }
 exports.getInputAsInt = getInputAsInt;
+function getInputAsBoolean(name, options) {
+    return core.getInput(name, options) === "true";
+}
+exports.getInputAsBoolean = getInputAsBoolean;
 function isCacheFeatureAvailable() {
     if (!cache.isFeatureAvailable()) {
         if (isGhes()) {
@@ -47297,6 +47302,10 @@ function run() {
                 return;
             }
             const state = utils.getCacheState();
+            if (utils.getInputAsBoolean(constants_1.Inputs.ReadOnly)) {
+                core.info(`Cache is read-only, skipping save.`);
+                return;
+            }
             // Inputs are re-evaluted before the post action, so we want the original key used for restore
             const primaryKey = core.getState(constants_1.State.CachePrimaryKey);
             if (!primaryKey) {

src/constants.ts

@@ -2,7 +2,8 @@ export enum Inputs {
     Key = "key",
     Path = "path",
     RestoreKeys = "restore-keys",
-    UploadChunkSize = "upload-chunk-size"
+    UploadChunkSize = "upload-chunk-size",
+    ReadOnly = "read-only"
 }
 
 export enum Outputs {

src/save.ts

@@ -44,6 +44,11 @@ async function run(): Promise<void> {
             required: true
         });
 
+        if (utils.getInputAsBoolean(Inputs.ReadOnly)) {
+          core.info(`Cache is read-only, skipping save.`);
+          return;
+        }
+
         const cacheId = await cache.saveCache(cachePaths, primaryKey, {
             uploadChunkSize: utils.getInputAsInt(Inputs.UploadChunkSize)
         });

src/utils/actionUtils.ts

@@ -76,6 +76,14 @@ export function getInputAsInt(
     return value;
 }
 
+export function getInputAsBoolean(
+  name: string,
+  options?: core.InputOptions
+) : boolean {
+  console.log("ReadOnly was: " + core.getInput(name, options));
+  return !!core.getInput(name, options);
+}
+
 export function isCacheFeatureAvailable(): boolean {
     if (!cache.isFeatureAvailable()) {
         if (isGhes()) {

src/utils/testUtils.ts

@@ -13,6 +13,7 @@ interface CacheInput {
     path: string;
     key: string;
     restoreKeys?: string[];
+    readOnly?: boolean;
 }
 
 export function setInputs(input: CacheInput): void {
@@ -20,6 +21,7 @@ export function setInputs(input: CacheInput): void {
     setInput(Inputs.Key, input.key);
     input.restoreKeys &&
         setInput(Inputs.RestoreKeys, input.restoreKeys.join("\n"));
+    input.readOnly && setInput(Inputs.ReadOnly, "true");
 }
 
 export function clearInputs(): void {