Compare commits

...

9 Commits

Author SHA1 Message Date
Sankalp Kotewar f46bb21315
Merge branch 'main' into kotewar/states-input-provider 2023-01-09 11:42:34 +05:30
Sankalp Kotewar 2d5e079d9e
Merge remote-tracking branch 'origin/master' into kotewar/states-input-provider 2023-01-03 10:22:58 +00:00
Sankalp Kotewar 667e98af5a
Fixed test cases 2023-01-03 10:22:38 +00:00
Sankalp Kotewar 5b7eeecaeb
stateinputprovider with pending test cases fix 2023-01-02 07:29:20 +00:00
Vipul 0769f2e443
Merge branch 'main' into master 2022-11-28 23:50:15 -08:00
Vipul 515d10b4fd
Merge pull request #746 from actions/revert-173-add-stack-example
Revert "Add example for Haskell Stack"
2022-02-22 12:44:25 +05:30
Vipul 669e7536d9
Revert "Add example for Haskell Stack" 2022-02-22 12:17:37 +05:30
Vipul 29dbbce762
Merge pull request #173 from malob/add-stack-example
Add example for Haskell Stack
2022-02-22 12:11:06 +05:30
Malo Bourgon ea5981db97 Add example for Haskell Stack 2022-02-21 14:59:28 -08:00
9 changed files with 96 additions and 37 deletions

View File

@ -11,12 +11,12 @@ jest.mock("@actions/cache");
jest.mock("../src/utils/actionUtils"); jest.mock("../src/utils/actionUtils");
beforeAll(() => { beforeAll(() => {
jest.spyOn(core, "getInput").mockImplementation((name, options) => { jest.spyOn(core, "getInput").mockImplementation(name => {
return jest.requireActual("@actions/core").getInput(name, options); return testUtils.getInput(name);
}); });
jest.spyOn(core, "setOutput").mockImplementation((key, value) => { jest.spyOn(core, "getState").mockImplementation(name => {
return jest.requireActual("@actions/core").getInput(key, value); return jest.requireActual("@actions/core").getState(name);
}); });
jest.spyOn(actionUtils, "getInputAsArray").mockImplementation( jest.spyOn(actionUtils, "getInputAsArray").mockImplementation(

View File

@ -1,11 +1,12 @@
import * as core from "@actions/core"; import * as core from "@actions/core";
import { Events, RefKey, State } from "../src/constants"; import { Events, Inputs, RefKey, State } from "../src/constants";
import { import {
IStateProvider, IStateProvider,
NullStateProvider, NullStateProvider,
StateProvider StateProvider
} from "../src/stateProvider"; } from "../src/stateProvider";
import * as testUtils from "../src/utils/testUtils";
jest.mock("@actions/core"); jest.mock("@actions/core");
@ -58,32 +59,43 @@ test("StateProvider saves states", async () => {
}); });
test("NullStateProvider saves outputs", async () => { test("NullStateProvider saves outputs", async () => {
const states = new Map<string, string>();
const getInputMock = jest
.spyOn(core, "getInput")
.mockImplementation(key => testUtils.getInput(key));
const getStateMock = jest const getStateMock = jest
.spyOn(core, "getState") .spyOn(core, "getState")
.mockImplementation(name => .mockImplementation(key => {
jest.requireActual("@actions/core").getState(name) return jest.requireActual("@actions/core").getState(key);
); });
const setOutputMock = jest const setOutputMock = jest
.spyOn(core, "setOutput") .spyOn(core, "setOutput")
.mockImplementation((key, value) => { .mockImplementation((key, value) => {
return jest.requireActual("@actions/core").setOutput(key, value); states.set(key, value);
}); });
const saveStateMock = jest const saveStateMock = jest
.spyOn(core, "saveState") .spyOn(core, "saveState")
.mockImplementation((key, value) => { .mockImplementation((key, value) => {
return jest.requireActual("@actions/core").saveState(key, value); states.set(key, value);
}); });
const cacheMatchedKey = "node-cache"; const cacheMatchedKey = "node-cache";
const cachePrimaryKey = "primary-key";
const nullStateProvider: IStateProvider = new NullStateProvider(); const nullStateProvider: IStateProvider = new NullStateProvider();
nullStateProvider.setState(State.CacheMatchedKey, "outputValue"); testUtils.setInput(Inputs.Key, cachePrimaryKey);
nullStateProvider.setState(State.CachePrimaryKey, cacheMatchedKey); nullStateProvider.setState(State.CachePrimaryKey, cachePrimaryKey);
nullStateProvider.getState("outputKey"); nullStateProvider.setState(State.CacheMatchedKey, cacheMatchedKey);
nullStateProvider.getCacheState(); const output1 = nullStateProvider.getState(State.CachePrimaryKey);
const output2 = nullStateProvider.getCacheState();
expect(getStateMock).toHaveBeenCalledTimes(0); expect(getStateMock).toHaveBeenCalledTimes(0);
expect(getInputMock).toHaveBeenCalledTimes(1);
expect(output1).toBe("primary-key");
expect(output2).toBe(undefined);
expect(setOutputMock).toHaveBeenCalledTimes(2); expect(setOutputMock).toHaveBeenCalledTimes(2);
expect(saveStateMock).toHaveBeenCalledTimes(0); expect(saveStateMock).toHaveBeenCalledTimes(0);
}); });

View File

@ -9413,15 +9413,24 @@ exports.StateProvider = StateProvider;
class NullStateProvider extends StateProviderBase { class NullStateProvider extends StateProviderBase {
constructor() { constructor() {
super(...arguments); super(...arguments);
this.stateToInputMap = new Map([
[constants_1.State.CachePrimaryKey, constants_1.Inputs.Key]
]);
this.stateToOutputMap = new Map([ this.stateToOutputMap = new Map([
[constants_1.State.CacheMatchedKey, constants_1.Outputs.CacheMatchedKey], [constants_1.State.CacheMatchedKey, constants_1.Outputs.CacheMatchedKey],
[constants_1.State.CachePrimaryKey, constants_1.Outputs.CachePrimaryKey] [constants_1.State.CachePrimaryKey, constants_1.Outputs.CachePrimaryKey]
]); ]);
this.setState = (key, value) => { this.setState = (key, value) => {
core.setOutput(this.stateToOutputMap.get(key), value); if (this.stateToOutputMap.has(key)) {
core.setOutput(this.stateToOutputMap.get(key), value);
}
};
this.getState = (key) => {
if (!this.stateToInputMap.has(key)) {
return "";
}
return core.getInput(this.stateToInputMap.get(key));
}; };
// eslint-disable-next-line @typescript-eslint/no-unused-vars
this.getState = (key) => "";
} }
} }
exports.NullStateProvider = NullStateProvider; exports.NullStateProvider = NullStateProvider;

15
dist/restore/index.js vendored
View File

@ -9413,15 +9413,24 @@ exports.StateProvider = StateProvider;
class NullStateProvider extends StateProviderBase { class NullStateProvider extends StateProviderBase {
constructor() { constructor() {
super(...arguments); super(...arguments);
this.stateToInputMap = new Map([
[constants_1.State.CachePrimaryKey, constants_1.Inputs.Key]
]);
this.stateToOutputMap = new Map([ this.stateToOutputMap = new Map([
[constants_1.State.CacheMatchedKey, constants_1.Outputs.CacheMatchedKey], [constants_1.State.CacheMatchedKey, constants_1.Outputs.CacheMatchedKey],
[constants_1.State.CachePrimaryKey, constants_1.Outputs.CachePrimaryKey] [constants_1.State.CachePrimaryKey, constants_1.Outputs.CachePrimaryKey]
]); ]);
this.setState = (key, value) => { this.setState = (key, value) => {
core.setOutput(this.stateToOutputMap.get(key), value); if (this.stateToOutputMap.has(key)) {
core.setOutput(this.stateToOutputMap.get(key), value);
}
};
this.getState = (key) => {
if (!this.stateToInputMap.has(key)) {
return "";
}
return core.getInput(this.stateToInputMap.get(key));
}; };
// eslint-disable-next-line @typescript-eslint/no-unused-vars
this.getState = (key) => "";
} }
} }
exports.NullStateProvider = NullStateProvider; exports.NullStateProvider = NullStateProvider;

View File

@ -9469,15 +9469,24 @@ exports.StateProvider = StateProvider;
class NullStateProvider extends StateProviderBase { class NullStateProvider extends StateProviderBase {
constructor() { constructor() {
super(...arguments); super(...arguments);
this.stateToInputMap = new Map([
[constants_1.State.CachePrimaryKey, constants_1.Inputs.Key]
]);
this.stateToOutputMap = new Map([ this.stateToOutputMap = new Map([
[constants_1.State.CacheMatchedKey, constants_1.Outputs.CacheMatchedKey], [constants_1.State.CacheMatchedKey, constants_1.Outputs.CacheMatchedKey],
[constants_1.State.CachePrimaryKey, constants_1.Outputs.CachePrimaryKey] [constants_1.State.CachePrimaryKey, constants_1.Outputs.CachePrimaryKey]
]); ]);
this.setState = (key, value) => { this.setState = (key, value) => {
core.setOutput(this.stateToOutputMap.get(key), value); if (this.stateToOutputMap.has(key)) {
core.setOutput(this.stateToOutputMap.get(key), value);
}
};
this.getState = (key) => {
if (!this.stateToInputMap.has(key)) {
return "";
}
return core.getInput(this.stateToInputMap.get(key));
}; };
// eslint-disable-next-line @typescript-eslint/no-unused-vars
this.getState = (key) => "";
} }
} }
exports.NullStateProvider = NullStateProvider; exports.NullStateProvider = NullStateProvider;
@ -41164,8 +41173,7 @@ function saveImpl(stateProvider) {
} }
// If restore has stored a primary key in state, reuse that // If restore has stored a primary key in state, reuse that
// Else re-evaluate from inputs // Else re-evaluate from inputs
const primaryKey = stateProvider.getState(constants_1.State.CachePrimaryKey) || const primaryKey = stateProvider.getState(constants_1.State.CachePrimaryKey);
core.getInput(constants_1.Inputs.Key);
if (!primaryKey) { if (!primaryKey) {
utils.logWarning(`Key is not specified.`); utils.logWarning(`Key is not specified.`);
return; return;

18
dist/save/index.js vendored
View File

@ -9413,15 +9413,24 @@ exports.StateProvider = StateProvider;
class NullStateProvider extends StateProviderBase { class NullStateProvider extends StateProviderBase {
constructor() { constructor() {
super(...arguments); super(...arguments);
this.stateToInputMap = new Map([
[constants_1.State.CachePrimaryKey, constants_1.Inputs.Key]
]);
this.stateToOutputMap = new Map([ this.stateToOutputMap = new Map([
[constants_1.State.CacheMatchedKey, constants_1.Outputs.CacheMatchedKey], [constants_1.State.CacheMatchedKey, constants_1.Outputs.CacheMatchedKey],
[constants_1.State.CachePrimaryKey, constants_1.Outputs.CachePrimaryKey] [constants_1.State.CachePrimaryKey, constants_1.Outputs.CachePrimaryKey]
]); ]);
this.setState = (key, value) => { this.setState = (key, value) => {
core.setOutput(this.stateToOutputMap.get(key), value); if (this.stateToOutputMap.has(key)) {
core.setOutput(this.stateToOutputMap.get(key), value);
}
};
this.getState = (key) => {
if (!this.stateToInputMap.has(key)) {
return "";
}
return core.getInput(this.stateToInputMap.get(key));
}; };
// eslint-disable-next-line @typescript-eslint/no-unused-vars
this.getState = (key) => "";
} }
} }
exports.NullStateProvider = NullStateProvider; exports.NullStateProvider = NullStateProvider;
@ -41108,8 +41117,7 @@ function saveImpl(stateProvider) {
} }
// If restore has stored a primary key in state, reuse that // If restore has stored a primary key in state, reuse that
// Else re-evaluate from inputs // Else re-evaluate from inputs
const primaryKey = stateProvider.getState(constants_1.State.CachePrimaryKey) || const primaryKey = stateProvider.getState(constants_1.State.CachePrimaryKey);
core.getInput(constants_1.Inputs.Key);
if (!primaryKey) { if (!primaryKey) {
utils.logWarning(`Key is not specified.`); utils.logWarning(`Key is not specified.`);
return; return;

View File

@ -28,9 +28,7 @@ async function saveImpl(stateProvider: IStateProvider): Promise<number | void> {
// If restore has stored a primary key in state, reuse that // If restore has stored a primary key in state, reuse that
// Else re-evaluate from inputs // Else re-evaluate from inputs
const primaryKey = const primaryKey = stateProvider.getState(State.CachePrimaryKey);
stateProvider.getState(State.CachePrimaryKey) ||
core.getInput(Inputs.Key);
if (!primaryKey) { if (!primaryKey) {
utils.logWarning(`Key is not specified.`); utils.logWarning(`Key is not specified.`);

View File

@ -1,6 +1,6 @@
import * as core from "@actions/core"; import * as core from "@actions/core";
import { Outputs, State } from "./constants"; import { Inputs, Outputs, State } from "./constants";
export interface IStateProvider { export interface IStateProvider {
setState(key: string, value: string): void; setState(key: string, value: string): void;
@ -33,14 +33,25 @@ export class StateProvider extends StateProviderBase {
} }
export class NullStateProvider extends StateProviderBase { export class NullStateProvider extends StateProviderBase {
stateToInputMap = new Map<string, string>([
[State.CachePrimaryKey, Inputs.Key]
]);
stateToOutputMap = new Map<string, string>([ stateToOutputMap = new Map<string, string>([
[State.CacheMatchedKey, Outputs.CacheMatchedKey], [State.CacheMatchedKey, Outputs.CacheMatchedKey],
[State.CachePrimaryKey, Outputs.CachePrimaryKey] [State.CachePrimaryKey, Outputs.CachePrimaryKey]
]); ]);
setState = (key: string, value: string) => { setState = (key: string, value: string) => {
core.setOutput(this.stateToOutputMap.get(key) as string, value); if (this.stateToOutputMap.has(key)) {
core.setOutput(this.stateToOutputMap.get(key) as string, value);
}
};
getState = (key: string) => {
if (!this.stateToInputMap.has(key)) {
return "";
}
return core.getInput(this.stateToInputMap.get(key) as string);
}; };
// eslint-disable-next-line @typescript-eslint/no-unused-vars
getState = (key: string) => "";
} }

View File

@ -9,6 +9,10 @@ export function setInput(name: string, value: string): void {
process.env[getInputName(name)] = value; process.env[getInputName(name)] = value;
} }
export function getInput(name: string): string {
return process.env[getInputName(name)] as string;
}
interface CacheInput { interface CacheInput {
path: string; path: string;
key: string; key: string;