-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathscanFile.test.ts
More file actions
255 lines (201 loc) · 8.19 KB
/
scanFile.test.ts
File metadata and controls
255 lines (201 loc) · 8.19 KB
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
import { describe, it, expect } from 'vitest';
import { scanFile } from '../../../../src/core/scan/scanFile.js';
import type { ScanOptions } from '../../../../src/config/types.js';
describe('scanFile', () => {
const baseOpts: ScanOptions = {
cwd: '/test/project',
include: [],
exclude: [],
ignore: [],
ignoreRegex: [],
files: [],
secrets: false,
ignoreUrls: [],
json: false,
};
it('detects process.env.VAR usage', () => {
const content = 'const apiKey = process.env.API_KEY;';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages).toHaveLength(1);
expect(usages[0]).toMatchObject({
variable: 'API_KEY',
file: 'src/app.js',
line: 1,
pattern: 'process.env',
isLogged: false,
});
});
it('detects multiple env variables in same file', () => {
const content = `
const key = process.env.API_KEY;
const url = process.env.DATABASE_URL;
const port = process.env.PORT;
`;
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages).toHaveLength(3);
expect(usages[0]?.variable).toBe('API_KEY');
expect(usages[1]?.variable).toBe('DATABASE_URL');
expect(usages[2]?.variable).toBe('PORT');
});
it('detects import.meta.env variables', () => {
const content = 'const apiUrl = import.meta.env.VITE_API_URL;';
const usages = scanFile('/test/project/src/app.ts', content, baseOpts);
expect(usages).toHaveLength(1);
expect(usages[0]).toMatchObject({
variable: 'VITE_API_URL',
pattern: 'import.meta.env',
});
});
it('calculates correct line and column numbers', () => {
const content = `const x = 1;
const y = 2;
const key = process.env.API_KEY;`;
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages[0]).toMatchObject({
variable: 'API_KEY',
line: 3,
column: expect.any(Number),
});
});
it('skips env variables with ignore comment on same line', () => {
const content = 'const key = process.env.SECRET_KEY; // dotenv-diff-ignore';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages).toHaveLength(0);
});
it('skips env variables with ignore comment on previous line', () => {
const content = `// dotenv-diff-ignore
const key = process.env.SECRET_KEY;`;
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages).toHaveLength(0);
});
it('detects when env variable is used in console.log', () => {
const content = 'console.log(process.env.DEBUG_MODE);';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages).toHaveLength(1);
expect(usages[0]?.isLogged).toBe(true);
});
it('detects when env variable is used in console.error', () => {
const content = 'console.error("Failed:", process.env.API_KEY);';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages[0]?.isLogged).toBe(true);
});
it('detects when env variable is used in console.warn', () => {
const content = 'console.warn(process.env.WARNING);';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages[0]?.isLogged).toBe(true);
});
it('ignores env usage on likely minified lines', () => {
const minifiedLine = `${'x'.repeat(520)}process.env.API_KEY`;
const usages = scanFile('/test/project/src/app.js', minifiedLine, baseOpts);
expect(usages).toHaveLength(0);
});
it('ignores console.log env usage on likely minified lines', () => {
const minifiedLine = `${'x'.repeat(520)}console.log(process.env.API_KEY)`;
const usages = scanFile('/test/project/src/app.js', minifiedLine, baseOpts);
expect(usages).toHaveLength(0);
});
it('does not mark as logged when not in console statement', () => {
const content = 'const key = process.env.API_KEY;';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages[0]?.isLogged).toBe(false);
});
it('extracts $env imports from SvelteKit files', () => {
const content = `import { API_KEY } from '$env/static/private';
const key = API_KEY;`;
const usages = scanFile('/test/project/src/app.svelte', content, baseOpts);
expect(usages[0]?.imports).toContain('$env/static/private');
});
it('extracts multiple $env imports', () => {
const content = `import { KEY1 } from '$env/static/private';
import { KEY2 } from '$env/dynamic/public';
const x = KEY1 + KEY2;`;
const usages = scanFile('/test/project/src/app.svelte', content, baseOpts);
expect(usages[0]?.imports).toEqual([
'$env/static/private',
'$env/dynamic/public',
]);
});
it('handles different $env import variations', () => {
const content = `import SECRET from '$env/static/private';
import * as env from '$env/dynamic/private';`;
const usages = scanFile('/test/project/src/app.svelte', content, baseOpts);
// Should find the imports even if no env variables matched
expect(usages.length).toBeGreaterThanOrEqual(0);
});
it('returns empty array when no env variables found', () => {
const content = 'const x = 1;\nconst y = 2;';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages).toEqual([]);
});
it('handles empty file content', () => {
const content = '';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages).toEqual([]);
});
it('includes context line in usage', () => {
const content = 'const key = process.env.API_KEY;';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages[0]?.context).toBe('const key = process.env.API_KEY;');
});
it('handles file path relative to cwd', () => {
const content = 'const key = process.env.API_KEY;';
const usages = scanFile(
'/test/project/src/nested/app.js',
content,
baseOpts,
);
expect(usages[0]?.file).toBe('src/nested/app.js');
});
it('handles undefined variable match gracefully', () => {
// This tests the continue when variable is falsy
const content = 'const x = process.env;'; // No .VAR
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
// Should not crash, just skip undefined variables
expect(usages).toEqual([]);
});
it('handles undefined lines array access gracefully', () => {
const content = 'const key = process.env.API_KEY;';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
// Should handle when accessing lines that might be undefined
expect(usages).toHaveLength(1);
});
it('calculates column number for first line correctly', () => {
const content = 'const key = process.env.API_KEY;';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages[0]?.column).toBeGreaterThan(0);
});
it('detects env variables with different patterns', () => {
const content = `
process.env.VAR1;
import.meta.env.VAR2;
`;
const usages = scanFile('/test/project/src/app.ts', content, baseOpts);
expect(usages).toHaveLength(2);
expect(usages[0]?.pattern).toBe('process.env');
expect(usages[1]?.pattern).toBe('import.meta.env');
});
it('handles multiline code correctly', () => {
const content = `const config = {
apiKey: process.env.API_KEY,
dbUrl: process.env.DATABASE_URL,
port: process.env.PORT
};`;
const usages = scanFile('/test/project/src/config.js', content, baseOpts);
expect(usages).toHaveLength(3);
expect(usages[0]?.line).toBe(2);
expect(usages[1]?.line).toBe(3);
expect(usages[2]?.line).toBe(4);
});
it('handles prevLine being undefined for first line', () => {
const content = 'const key = process.env.API_KEY;';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
// Should not crash when accessing previous line of first line
expect(usages).toHaveLength(1);
});
it('handles contextLine being undefined gracefully', () => {
// Edge case where line might be out of bounds
const content = 'const key = process.env.API_KEY;';
const usages = scanFile('/test/project/src/app.js', content, baseOpts);
expect(usages[0]?.context).toBeTruthy();
});
});