FilesExpand file tree

main

/

cache-save.test.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

266 lines (224 loc) · 8.35 KB

main

/

cache-save.test.ts

Copy path

Top

File metadata and controls

• Code
• Blame

266 lines (224 loc) · 8.35 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

import * as core from '@actions/core';

import * as cache from '@actions/cache';

import * as exec from '@actions/exec';

import {run} from '../src/cache-save';

import {State} from '../src/cache-distributions/cache-distributor';

describe('run', () => {

const pipFileLockHash =

'd1dd6218299d8a6db5fc2001d988b34a8b31f1e9d0bb4534d377dde7c19f64b3';

const requirementsHash =

'd8110e0006d7fb5ee76365d565eef9d37df1d11598b912d3eb66d398d57a1121';

const requirementsLinuxHash =

'2d0ff7f46b0e120e3d3294db65768b474934242637b9899b873e6283dfd16d7c';

const poetryLockHash =

'571bf984f8d210e6a97f854e479fdd4a2b5af67b5fdac109ec337a0ea16e7836';

// core spy

let infoSpy: jest.SpyInstance;

let warningSpy: jest.SpyInstance;

let debugSpy: jest.SpyInstance;

let saveStateSpy: jest.SpyInstance;

let getStateSpy: jest.SpyInstance;

let getInputSpy: jest.SpyInstance;

let setFailedSpy: jest.SpyInstance;

// cache spy

let saveCacheSpy: jest.SpyInstance;

// exec spy

let getExecOutputSpy: jest.SpyInstance;

let inputs = {} as any;

beforeEach(() => {

process.env['RUNNER_OS'] = process.env['RUNNER_OS'] ?? 'linux';

infoSpy = jest.spyOn(core, 'info');

infoSpy.mockImplementation(input => undefined);

warningSpy = jest.spyOn(core, 'warning');

warningSpy.mockImplementation(input => undefined);

debugSpy = jest.spyOn(core, 'debug');

debugSpy.mockImplementation(input => undefined);

saveStateSpy = jest.spyOn(core, 'saveState');

saveStateSpy.mockImplementation(input => undefined);

getStateSpy = jest.spyOn(core, 'getState');

getStateSpy.mockImplementation(input => {

if (input === State.CACHE_PATHS) {

return JSON.stringify([__dirname]);

}

return requirementsHash;

});

setFailedSpy = jest.spyOn(core, 'setFailed');

getInputSpy = jest.spyOn(core, 'getInput');

getInputSpy.mockImplementation(input => inputs[input]);

getExecOutputSpy = jest.spyOn(exec, 'getExecOutput');

getExecOutputSpy.mockImplementation((input: string) => {

if (input.includes('pip')) {

return {stdout: 'pip', stderr: '', exitCode: 0};

}

return {stdout: '', stderr: 'Error occured', exitCode: 2};

});

saveCacheSpy = jest.spyOn(cache, 'saveCache');

saveCacheSpy.mockImplementation(() => undefined);

});

describe('Package manager validation', () => {

it('Package manager is not provided, skip caching', async () => {

inputs['cache'] = '';

await run();

expect(getInputSpy).toHaveBeenCalled();

expect(infoSpy).not.toHaveBeenCalled();

expect(saveCacheSpy).not.toHaveBeenCalled();

expect(setFailedSpy).not.toHaveBeenCalled();

});

});

describe('Validate unchanged cache is not saved', () => {

it('should not save cache for pip', async () => {

inputs['cache'] = 'pip';

inputs['python-version'] = '3.10.0';

await run();

expect(getInputSpy).toHaveBeenCalled();

expect(debugSpy).toHaveBeenCalledWith(

`paths for caching are ${__dirname}`

);

expect(getStateSpy).toHaveBeenCalledTimes(3);

expect(infoSpy).toHaveBeenCalledWith(

`Cache hit occurred on the primary key ${requirementsHash}, not saving cache.`

);

expect(setFailedSpy).not.toHaveBeenCalled();

});

it('should not save cache for pipenv', async () => {

inputs['cache'] = 'pipenv';

inputs['python-version'] = '3.10.0';

await run();

expect(getInputSpy).toHaveBeenCalled();

expect(debugSpy).toHaveBeenCalledWith(

`paths for caching are ${__dirname}`

);

expect(getStateSpy).toHaveBeenCalledTimes(3);

expect(infoSpy).toHaveBeenCalledWith(

`Cache hit occurred on the primary key ${requirementsHash}, not saving cache.`

);

expect(setFailedSpy).not.toHaveBeenCalled();

});

});

describe('action saves the cache', () => {

it('saves cache from pip', async () => {

inputs['cache'] = 'pip';

inputs['python-version'] = '3.10.0';

getStateSpy.mockImplementation((name: string) => {

if (name === State.CACHE_MATCHED_KEY) {

return requirementsHash;

} else if (name === State.CACHE_PATHS) {

return JSON.stringify([__dirname]);

} else {

return pipFileLockHash;

}

});

await run();

expect(getInputSpy).toHaveBeenCalled();

expect(getStateSpy).toHaveBeenCalledTimes(3);

expect(infoSpy).not.toHaveBeenCalledWith(

`Cache hit occurred on the primary key ${requirementsHash}, not saving cache.`

);

expect(saveCacheSpy).toHaveBeenCalled();

expect(infoSpy).toHaveBeenLastCalledWith(

`Cache saved with the key: ${pipFileLockHash}`

);

expect(setFailedSpy).not.toHaveBeenCalled();

});

it('saves cache from pipenv', async () => {

inputs['cache'] = 'pipenv';

inputs['python-version'] = '3.10.0';

getStateSpy.mockImplementation((name: string) => {

if (name === State.CACHE_MATCHED_KEY) {

return pipFileLockHash;

} else if (name === State.CACHE_PATHS) {

return JSON.stringify([__dirname]);

} else {

return requirementsHash;

}

});

await run();

expect(getInputSpy).toHaveBeenCalled();

expect(getStateSpy).toHaveBeenCalledTimes(3);

expect(infoSpy).not.toHaveBeenCalledWith(

`Cache hit occurred on the primary key ${pipFileLockHash}, not saving cache.`

);

expect(saveCacheSpy).toHaveBeenCalled();

expect(infoSpy).toHaveBeenLastCalledWith(

`Cache saved with the key: ${requirementsHash}`

);

expect(setFailedSpy).not.toHaveBeenCalled();

});

it('saves cache from poetry', async () => {

inputs['cache'] = 'poetry';

inputs['python-version'] = '3.10.0';

getStateSpy.mockImplementation((name: string) => {

if (name === State.CACHE_MATCHED_KEY) {

return poetryLockHash;

} else if (name === State.CACHE_PATHS) {

return JSON.stringify([__dirname]);

} else {

return requirementsHash;

}

});

await run();

expect(getInputSpy).toHaveBeenCalled();

expect(getStateSpy).toHaveBeenCalledTimes(3);

expect(infoSpy).not.toHaveBeenCalledWith(

`Cache hit occurred on the primary key ${poetryLockHash}, not saving cache.`

);

expect(saveCacheSpy).toHaveBeenCalled();

expect(infoSpy).toHaveBeenLastCalledWith(

`Cache saved with the key: ${requirementsHash}`

);

expect(setFailedSpy).not.toHaveBeenCalled();

});

it('saves with -1 cacheId , should not fail workflow', async () => {

inputs['cache'] = 'poetry';

inputs['python-version'] = '3.10.0';

getStateSpy.mockImplementation((name: string) => {

if (name === State.STATE_CACHE_PRIMARY_KEY) {

return poetryLockHash;

} else if (name === State.CACHE_PATHS) {

return JSON.stringify([__dirname]);

} else {

return requirementsHash;

}

});

saveCacheSpy.mockImplementation(() => {

return -1;

});

await run();

expect(getInputSpy).toHaveBeenCalled();

expect(getStateSpy).toHaveBeenCalledTimes(3);

expect(infoSpy).not.toHaveBeenCalled();

expect(saveCacheSpy).toHaveBeenCalled();

expect(infoSpy).not.toHaveBeenLastCalledWith(

`Cache saved with the key: ${poetryLockHash}`

);

expect(setFailedSpy).not.toHaveBeenCalled();

});

it('saves with error from toolkit, should not fail the workflow', async () => {

inputs['cache'] = 'npm';

inputs['python-version'] = '3.10.0';

getStateSpy.mockImplementation((name: string) => {

if (name === State.STATE_CACHE_PRIMARY_KEY) {

return poetryLockHash;

} else if (name === State.CACHE_PATHS) {

return JSON.stringify([__dirname]);

} else {

return requirementsHash;

}

});

saveCacheSpy.mockImplementation(() => {

throw new cache.ValidationError('Validation failed');

});

await run();

expect(getInputSpy).toHaveBeenCalled();

expect(getStateSpy).toHaveBeenCalledTimes(3);

expect(infoSpy).not.toHaveBeenCalledWith();

expect(saveCacheSpy).toHaveBeenCalled();

expect(setFailedSpy).not.toHaveBeenCalled();

});

});

afterEach(() => {

jest.resetAllMocks();

jest.clearAllMocks();

inputs = {};

});

});