Skip to content

Commit

Permalink
Remove validation failures and warning annotations (#108)
Browse files Browse the repository at this point in the history 
* Update warnings behavior

* Add void return type
  • Loading branch information
Josh Gross authored and GitHub committed Nov 21, 2019
1 parent 639f9d8 commit 95c1798
Show file tree
Hide file tree
Showing 8 changed files with 82 additions and 40 deletions.
10 changes: 10 additions & 0 deletions __tests__/actionUtils.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,16 @@ test("getCacheState with valid state", () => {
expect(getStateMock).toHaveBeenCalledTimes(1);
});

test("logWarning logs a message with a warning prefix", () => {
const message = "A warning occurred.";

const infoMock = jest.spyOn(core, "info");

actionUtils.logWarning(message);

expect(infoMock).toHaveBeenCalledWith(`[warning]${message}`);
});

test("isValidEvent returns false for unknown event", () => {
const event = "foo";
process.env[Events.Key] = event;
Expand Down
22 changes: 7 additions & 15 deletions __tests__/restore.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,16 @@ afterEach(() => {
delete process.env[Events.Key];
});

test("restore with invalid event", async () => {
test("restore with invalid event outputs warning", async () => {
const logWarningMock = jest.spyOn(actionUtils, "logWarning");
const failedMock = jest.spyOn(core, "setFailed");
const invalidEvent = "commit_comment";
process.env[Events.Key] = invalidEvent;
await run();
expect(failedMock).toHaveBeenCalledWith(
expect(logWarningMock).toHaveBeenCalledWith(
`Event Validation Error: The event type ${invalidEvent} is not supported. Only push, pull_request events are supported at this time.`
);
expect(failedMock).toHaveBeenCalledTimes(0);
});

test("restore with no path should fail", async () => {
Expand Down Expand Up @@ -126,7 +128,6 @@ test("restore with no cache found", async () => {
});

const infoMock = jest.spyOn(core, "info");
const warningMock = jest.spyOn(core, "warning");
const failedMock = jest.spyOn(core, "setFailed");
const stateMock = jest.spyOn(core, "saveState");

Expand All @@ -138,7 +139,6 @@ test("restore with no cache found", async () => {
await run();

expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key);
expect(warningMock).toHaveBeenCalledTimes(0);
expect(failedMock).toHaveBeenCalledTimes(0);

expect(infoMock).toHaveBeenCalledWith(
Expand All @@ -153,7 +153,7 @@ test("restore with server error should fail", async () => {
key
});

const warningMock = jest.spyOn(core, "warning");
const logWarningMock = jest.spyOn(actionUtils, "logWarning");
const failedMock = jest.spyOn(core, "setFailed");
const stateMock = jest.spyOn(core, "saveState");

Expand All @@ -168,8 +168,8 @@ test("restore with server error should fail", async () => {

expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key);

expect(warningMock).toHaveBeenCalledTimes(1);
expect(warningMock).toHaveBeenCalledWith("HTTP Error Occurred");
expect(logWarningMock).toHaveBeenCalledTimes(1);
expect(logWarningMock).toHaveBeenCalledWith("HTTP Error Occurred");

expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
expect(setCacheHitOutputMock).toHaveBeenCalledWith(false);
Expand All @@ -187,7 +187,6 @@ test("restore with restore keys and no cache found", async () => {
});

const infoMock = jest.spyOn(core, "info");
const warningMock = jest.spyOn(core, "warning");
const failedMock = jest.spyOn(core, "setFailed");
const stateMock = jest.spyOn(core, "saveState");

Expand All @@ -199,7 +198,6 @@ test("restore with restore keys and no cache found", async () => {
await run();

expect(stateMock).toHaveBeenCalledWith("CACHE_KEY", key);
expect(warningMock).toHaveBeenCalledTimes(0);
expect(failedMock).toHaveBeenCalledTimes(0);

expect(infoMock).toHaveBeenCalledWith(
Expand All @@ -216,7 +214,6 @@ test("restore with cache found", async () => {
});

const infoMock = jest.spyOn(core, "info");
const warningMock = jest.spyOn(core, "warning");
const failedMock = jest.spyOn(core, "setFailed");
const stateMock = jest.spyOn(core, "saveState");

Expand Down Expand Up @@ -281,7 +278,6 @@ test("restore with cache found", async () => {
expect(setCacheHitOutputMock).toHaveBeenCalledWith(true);

expect(infoMock).toHaveBeenCalledWith(`Cache restored from key: ${key}`);
expect(warningMock).toHaveBeenCalledTimes(0);
expect(failedMock).toHaveBeenCalledTimes(0);
});

Expand All @@ -296,7 +292,6 @@ test("restore with a pull request event and cache found", async () => {
process.env[Events.Key] = Events.PullRequest;

const infoMock = jest.spyOn(core, "info");
const warningMock = jest.spyOn(core, "warning");
const failedMock = jest.spyOn(core, "setFailed");
const stateMock = jest.spyOn(core, "saveState");

Expand Down Expand Up @@ -362,7 +357,6 @@ test("restore with a pull request event and cache found", async () => {
expect(setCacheHitOutputMock).toHaveBeenCalledWith(true);

expect(infoMock).toHaveBeenCalledWith(`Cache restored from key: ${key}`);
expect(warningMock).toHaveBeenCalledTimes(0);
expect(failedMock).toHaveBeenCalledTimes(0);
});

Expand All @@ -377,7 +371,6 @@ test("restore with cache found for restore key", async () => {
});

const infoMock = jest.spyOn(core, "info");
const warningMock = jest.spyOn(core, "warning");
const failedMock = jest.spyOn(core, "setFailed");
const stateMock = jest.spyOn(core, "saveState");

Expand Down Expand Up @@ -445,6 +438,5 @@ test("restore with cache found for restore key", async () => {
expect(infoMock).toHaveBeenCalledWith(
`Cache restored from key: ${restoreKey}`
);
expect(warningMock).toHaveBeenCalledTimes(0);
expect(failedMock).toHaveBeenCalledTimes(0);
});
57 changes: 40 additions & 17 deletions __tests__/save.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import * as exec from "@actions/exec";
import * as io from "@actions/io";
import * as path from "path";
import * as cacheHttpClient from "../src/cacheHttpClient";
import { Inputs } from "../src/constants";
import { Events, Inputs } from "../src/constants";
import { ArtifactCacheEntry } from "../src/contracts";
import run from "../src/save";
import * as actionUtils from "../src/utils/actionUtils";
Expand Down Expand Up @@ -32,6 +32,16 @@ beforeAll(() => {
}
);

jest.spyOn(actionUtils, "isValidEvent").mockImplementation(() => {
const actualUtils = jest.requireActual("../src/utils/actionUtils");
return actualUtils.isValidEvent();
});

jest.spyOn(actionUtils, "getSupportedEvents").mockImplementation(() => {
const actualUtils = jest.requireActual("../src/utils/actionUtils");
return actualUtils.getSupportedEvents();
});

jest.spyOn(actionUtils, "resolvePath").mockImplementation(filePath => {
return path.resolve(filePath);
});
Expand All @@ -45,12 +55,29 @@ beforeAll(() => {
});
});

beforeEach(() => {
process.env[Events.Key] = Events.Push;
});

afterEach(() => {
testUtils.clearInputs();
delete process.env[Events.Key];
});

test("save with invalid event outputs warning", async () => {
const logWarningMock = jest.spyOn(actionUtils, "logWarning");
const failedMock = jest.spyOn(core, "setFailed");
const invalidEvent = "commit_comment";
process.env[Events.Key] = invalidEvent;
await run();
expect(logWarningMock).toHaveBeenCalledWith(
`Event Validation Error: The event type ${invalidEvent} is not supported. Only push, pull_request events are supported at this time.`
);
expect(failedMock).toHaveBeenCalledTimes(0);
});

test("save with no primary key in state outputs warning", async () => {
const warningMock = jest.spyOn(core, "warning");
const logWarningMock = jest.spyOn(actionUtils, "logWarning");
const failedMock = jest.spyOn(core, "setFailed");

const cacheEntry: ArtifactCacheEntry = {
Expand All @@ -72,16 +99,15 @@ test("save with no primary key in state outputs warning", async () => {

await run();

expect(warningMock).toHaveBeenCalledWith(
expect(logWarningMock).toHaveBeenCalledWith(
`Error retrieving key from state.`
);
expect(warningMock).toHaveBeenCalledTimes(1);
expect(logWarningMock).toHaveBeenCalledTimes(1);
expect(failedMock).toHaveBeenCalledTimes(0);
});

test("save with exact match returns early", async () => {
const infoMock = jest.spyOn(core, "info");
const warningMock = jest.spyOn(core, "warning");
const failedMock = jest.spyOn(core, "setFailed");

const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
Expand Down Expand Up @@ -112,12 +138,11 @@ test("save with exact match returns early", async () => {

expect(execMock).toHaveBeenCalledTimes(0);

expect(warningMock).toHaveBeenCalledTimes(0);
expect(failedMock).toHaveBeenCalledTimes(0);
});

test("save with missing input outputs warning", async () => {
const warningMock = jest.spyOn(core, "warning");
const logWarningMock = jest.spyOn(actionUtils, "logWarning");
const failedMock = jest.spyOn(core, "setFailed");

const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
Expand All @@ -140,15 +165,15 @@ test("save with missing input outputs warning", async () => {

await run();

expect(warningMock).toHaveBeenCalledWith(
expect(logWarningMock).toHaveBeenCalledWith(
"Input required and not supplied: path"
);
expect(warningMock).toHaveBeenCalledTimes(1);
expect(logWarningMock).toHaveBeenCalledTimes(1);
expect(failedMock).toHaveBeenCalledTimes(0);
});

test("save with large cache outputs warning", async () => {
const warningMock = jest.spyOn(core, "warning");
const logWarningMock = jest.spyOn(actionUtils, "logWarning");
const failedMock = jest.spyOn(core, "setFailed");

const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
Expand Down Expand Up @@ -200,16 +225,16 @@ test("save with large cache outputs warning", async () => {
expect(execMock).toHaveBeenCalledTimes(1);
expect(execMock).toHaveBeenCalledWith(`"tar"`, args);

expect(warningMock).toHaveBeenCalledTimes(1);
expect(warningMock).toHaveBeenCalledWith(
expect(logWarningMock).toHaveBeenCalledTimes(1);
expect(logWarningMock).toHaveBeenCalledWith(
"Cache size of ~1024 MB (1073741824 B) is over the 400MB limit, not saving cache."
);

expect(failedMock).toHaveBeenCalledTimes(0);
});

test("save with server error outputs warning", async () => {
const warningMock = jest.spyOn(core, "warning");
const logWarningMock = jest.spyOn(actionUtils, "logWarning");
const failedMock = jest.spyOn(core, "setFailed");

const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
Expand Down Expand Up @@ -265,14 +290,13 @@ test("save with server error outputs warning", async () => {
expect(saveCacheMock).toHaveBeenCalledTimes(1);
expect(saveCacheMock).toHaveBeenCalledWith(primaryKey, archivePath);

expect(warningMock).toHaveBeenCalledTimes(1);
expect(warningMock).toHaveBeenCalledWith("HTTP Error Occurred");
expect(logWarningMock).toHaveBeenCalledTimes(1);
expect(logWarningMock).toHaveBeenCalledWith("HTTP Error Occurred");

expect(failedMock).toHaveBeenCalledTimes(0);
});

test("save with valid inputs uploads a cache", async () => {
const warningMock = jest.spyOn(core, "warning");
const failedMock = jest.spyOn(core, "setFailed");

const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
Expand Down Expand Up @@ -324,6 +348,5 @@ test("save with valid inputs uploads a cache", async () => {
expect(saveCacheMock).toHaveBeenCalledTimes(1);
expect(saveCacheMock).toHaveBeenCalledWith(primaryKey, archivePath);

expect(warningMock).toHaveBeenCalledTimes(0);
expect(failedMock).toHaveBeenCalledTimes(0);
});
2 changes: 1 addition & 1 deletion package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cache",
"version": "1.0.2",
"version": "1.0.3",
"private": true,
"description": "Cache dependencies and build outputs",
"main": "dist/restore/index.js",
Expand Down
5 changes: 3 additions & 2 deletions src/restore.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ async function run(): Promise<void> {
try {
// Validate inputs, this can cause task failure
if (!utils.isValidEvent()) {
core.setFailed(
utils.logWarning(
`Event Validation Error: The event type ${
process.env[Events.Key]
} is not supported. Only ${utils
.getSupportedEvents()
.join(", ")} events are supported at this time.`
);
return;
}

const cachePath = utils.resolvePath(
Expand Down Expand Up @@ -118,7 +119,7 @@ async function run(): Promise<void> {
`Cache restored from key: ${cacheEntry && cacheEntry.cacheKey}`
);
} catch (error) {
core.warning(error.message);
utils.logWarning(error.message);
utils.setCacheHitOutput(false);
}
} catch (error) {
Expand Down
19 changes: 15 additions & 4 deletions src/save.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,28 @@ import { exec } from "@actions/exec";
import * as io from "@actions/io";
import * as path from "path";
import * as cacheHttpClient from "./cacheHttpClient";
import { Inputs, State } from "./constants";
import { Events, Inputs, State } from "./constants";
import * as utils from "./utils/actionUtils";

async function run(): Promise<void> {
try {
if (!utils.isValidEvent()) {
utils.logWarning(
`Event Validation Error: The event type ${
process.env[Events.Key]
} is not supported. Only ${utils
.getSupportedEvents()
.join(", ")} events are supported at this time.`
);
return;
}

const state = utils.getCacheState();

// Inputs are re-evaluted before the post action, so we want the original key used for restore
const primaryKey = core.getState(State.CacheKey);
if (!primaryKey) {
core.warning(`Error retrieving key from state.`);
utils.logWarning(`Error retrieving key from state.`);
return;
}

Expand Down Expand Up @@ -58,7 +69,7 @@ async function run(): Promise<void> {
const archiveFileSize = utils.getArchiveFileSize(archivePath);
core.debug(`File Size: ${archiveFileSize}`);
if (archiveFileSize > fileSizeLimit) {
core.warning(
utils.logWarning(
`Cache size of ~${Math.round(
archiveFileSize / (1024 * 1024)
)} MB (${archiveFileSize} B) is over the 400MB limit, not saving cache.`
Expand All @@ -68,7 +79,7 @@ async function run(): Promise<void> {

await cacheHttpClient.saveCache(primaryKey, archivePath);
} catch (error) {
core.warning(error.message);
utils.logWarning(error.message);
}
}

Expand Down
5 changes: 5 additions & 0 deletions src/utils/actionUtils.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ export function getCacheState(): ArtifactCacheEntry | undefined {
return undefined;
}

export function logWarning(message: string): void {
const warningPrefix = "[warning]";
core.info(`${warningPrefix}${message}`);
}

export function resolvePath(filePath: string): string {
if (filePath[0] === "~") {
const home = os.homedir();
Expand Down

0 comments on commit 95c1798

Please sign in to comment.