FilesExpand file tree

mbg/all-action-state

/

fingerprints.test.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

253 lines (228 loc) · 7.04 KB

mbg/all-action-state

/

fingerprints.test.ts

Copy path

Top

File metadata and controls

• Code
• Blame

253 lines (228 loc) · 7.04 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

import * as fs from "fs";

import * as path from "path";

import * as ava from "ava";

import test from "ava";

import * as fingerprints from "./fingerprints";

import { getRunnerLogger } from "./logging";

import * as sarif from "./sarif";

import { setupTests } from "./testing-utils";

import * as util from "./util";

setupTests(test);

async function testHash(

t: ava.Assertions,

input: string,

expectedHashes: string[],

) {

await util.withTmpDir(async (tmpDir) => {

const tmpFile = path.resolve(tmpDir, "testfile");

fs.writeFileSync(tmpFile, input);

let index = 0;

const callback = function (lineNumber: number, hash: string) {

t.is(lineNumber, index + 1);

t.is(hash, expectedHashes[index]);

index++;

};

await fingerprints.hash(callback, tmpFile);

t.is(index, input.split(/\r\n|\r|\n/).length);

});

}

test("hash", async (t: ava.Assertions) => {

// Try empty file

await testHash(t, "", ["c129715d7a2bc9a3:1"]);

// Try various combinations of newline characters

await testHash(t, " a\nb\n \t\tc\n d", [

"271789c17abda88f:1",

"54703d4cd895b18:1",

"180aee12dab6264:1",

"a23a3dc5e078b07b:1",

]);

await testHash(t, " hello; \t\nworld!!!\n\n\n \t\tGreetings\n End", [

"8b7cf3e952e7aeb2:1",

"b1ae1287ec4718d9:1",

"bff680108adb0fcc:1",

"c6805c5e1288b612:1",

"b86d3392aea1be30:1",

"e6ceba753e1a442:1",

]);

await testHash(t, " hello; \t\nworld!!!\n\n\n \t\tGreetings\n End\n", [

"e9496ae3ebfced30:1",

"fb7c023a8b9ccb3f:1",

"ce8ba1a563dcdaca:1",

"e20e36e16fcb0cc8:1",

"b3edc88f2938467e:1",

"c8e28b0b4002a3a0:1",

"c129715d7a2bc9a3:1",

]);

await testHash(t, " hello; \t\nworld!!!\r\r\r \t\tGreetings\r End\r", [

"e9496ae3ebfced30:1",

"fb7c023a8b9ccb3f:1",

"ce8ba1a563dcdaca:1",

"e20e36e16fcb0cc8:1",

"b3edc88f2938467e:1",

"c8e28b0b4002a3a0:1",

"c129715d7a2bc9a3:1",

]);

await testHash(

t,

" hello; \t\r\nworld!!!\r\n\r\n\r\n \t\tGreetings\r\n End\r\n",

[

"e9496ae3ebfced30:1",

"fb7c023a8b9ccb3f:1",

"ce8ba1a563dcdaca:1",

"e20e36e16fcb0cc8:1",

"b3edc88f2938467e:1",

"c8e28b0b4002a3a0:1",

"c129715d7a2bc9a3:1",

],

);

await testHash(t, " hello; \t\nworld!!!\r\n\n\r \t\tGreetings\r End\r\n", [

"e9496ae3ebfced30:1",

"fb7c023a8b9ccb3f:1",

"ce8ba1a563dcdaca:1",

"e20e36e16fcb0cc8:1",

"b3edc88f2938467e:1",

"c8e28b0b4002a3a0:1",

"c129715d7a2bc9a3:1",

]);

// Try repeating line that will generate identical hashes

await testHash(t, "Lorem ipsum dolor sit amet.\n".repeat(10), [

"a7f2ff13bc495cf2:1",

"a7f2ff13bc495cf2:2",

"a7f2ff13bc495cf2:3",

"a7f2ff13bc495cf2:4",

"a7f2ff13bc495cf2:5",

"a7f2ff13bc495cf2:6",

"a7f2ff1481e87703:1",

"a9cf91f7bbf1862b:1",

"55ec222b86bcae53:1",

"cc97dc7b1d7d8f7b:1",

"c129715d7a2bc9a3:1",

]);

await testHash(

t,

"x = 2\nx = 1\nprint(x)\nx = 3\nprint(x)\nx = 4\nprint(x)\n",

[

"e54938cc54b302f1:1",

"bb609acbe9138d60:1",

"1131fd5871777f34:1",

"5c482a0f8b35ea28:1",

"54517377da7028d2:1",

"2c644846cb18d53e:1",

"f1b89f20de0d133:1",

"c129715d7a2bc9a3:1",

],

);

});

function testResolveUriToFile(uri: any, index: any, artifactsURIs: any[]) {

const location = { uri, index };

const artifacts = artifactsURIs.map((artifactURI) => ({

location: { uri: artifactURI },

}));

return fingerprints.resolveUriToFile(

location,

artifacts,

process.cwd(),

getRunnerLogger(true),

);

}

test("resolveUriToFile", (t) => {

// The resolveUriToFile method checks that the file exists and is in the right directory

// so we need to give it real files to look at. We will use this file as an example.

// For this to work we require the current working directory to be a parent, but this

// should generally always be the case so this is fine.

const filepath = __filename.split(path.sep).join("/");

const relativeFilepath = path

.relative(process.cwd(), __filename)

.split(path.sep)

.join("/");

// Absolute paths are unmodified

t.is(testResolveUriToFile(filepath, undefined, []), filepath);

t.is(testResolveUriToFile(`file://${filepath}`, undefined, []), filepath);

// Relative paths are made absolute

t.is(

testResolveUriToFile(relativeFilepath, undefined, [])

?.split(path.sep)

.join("/"),

filepath,

);

t.is(

testResolveUriToFile(`file://${relativeFilepath}`, undefined, [])

?.split(path.sep)

.join("/"),

filepath,

);

// Absolute paths outside the src root are discarded

t.is(testResolveUriToFile("/src/foo/bar.js", undefined, []), undefined);

t.is(

testResolveUriToFile("file:///src/foo/bar.js", undefined, []),

undefined,

);

// Other schemes are discarded

t.is(testResolveUriToFile(`https://${filepath}`, undefined, []), undefined);

t.is(testResolveUriToFile(`ftp://${filepath}`, undefined, []), undefined);

// Invalid URIs are discarded

t.is(testResolveUriToFile(1, undefined, []), undefined);

t.is(testResolveUriToFile(undefined, undefined, []), undefined);

// Non-existent files are discarded

t.is(testResolveUriToFile(`${filepath}2`, undefined, []), undefined);

// Index is resolved

t.is(testResolveUriToFile(undefined, 0, [filepath]), filepath);

t.is(testResolveUriToFile(undefined, 1, ["foo", filepath]), filepath);

// Invalid indexes are discarded

t.is(testResolveUriToFile(undefined, 1, [filepath]), undefined);

t.is(testResolveUriToFile(undefined, "0", [filepath]), undefined);

// Directories are discarded

const dirpath = __dirname;

t.is(testResolveUriToFile(dirpath, undefined, []), undefined);

t.is(testResolveUriToFile(`file://${dirpath}`, undefined, []), undefined);

});

test("addFingerprints", async (t) => {

// Run an end-to-end test on a test file

const input = JSON.parse(

fs

.readFileSync(`${__dirname}/../src/testdata/fingerprinting.input.sarif`)

.toString(),

) as sarif.Log;

const expected = JSON.parse(

fs

.readFileSync(

`${__dirname}/../src/testdata/fingerprinting.expected.sarif`,

)

.toString(),

);

// The URIs in the SARIF files resolve to files in the testdata directory

const sourceRoot = path.normalize(`${__dirname}/../src/testdata`);

t.deepEqual(

await fingerprints.addFingerprints(

input,

sourceRoot,

getRunnerLogger(true),

),

expected,

);

});

test("missingRegions", async (t) => {

// Run an end-to-end test on a test file

const input = JSON.parse(

fs

.readFileSync(`${__dirname}/../src/testdata/fingerprinting2.input.sarif`)

.toString(),

) as sarif.Log;

const expected = JSON.parse(

fs

.readFileSync(

`${__dirname}/../src/testdata/fingerprinting2.expected.sarif`,

)

.toString(),

);

// The URIs in the SARIF files resolve to files in the testdata directory

const sourceRoot = path.normalize(`${__dirname}/../src/testdata`);

t.deepEqual(

await fingerprints.addFingerprints(

input,

sourceRoot,

getRunnerLogger(true),

),

expected,

);

});