-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathcli-tool-registry.test.ts
More file actions
1960 lines (1608 loc) · 63.4 KB
/
cli-tool-registry.test.ts
File metadata and controls
1960 lines (1608 loc) · 63.4 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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Tests for CLI tool registry
*/
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from 'fs';
import { join } from 'path';
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp';
import { z } from 'zod';
import {
registerCLITool,
defaultCLIResultProcessor,
createCodeQLSchemas,
createQLTSchemas,
createBQRSResultProcessor,
createDatabaseResultProcessor,
CLIToolDefinition
} from '../../../src/lib/cli-tool-registry';
import { CLIExecutionResult } from '../../../src/lib/cli-executor';
import { createTestTempDir } from '../../utils/temp-dir';
// Mock the CLI executor
vi.mock('../../../src/lib/cli-executor', () => ({
executeCodeQLCommand: vi.fn(),
executeQLTCommand: vi.fn()
}));
describe('defaultCLIResultProcessor', () => {
it('should format successful results with stdout', () => {
const result: CLIExecutionResult = {
stdout: 'Success output',
stderr: '',
success: true
};
const formatted = defaultCLIResultProcessor(result, {});
expect(formatted).toBe('Success output');
});
it('should format successful results with both stdout and stderr', () => {
const result: CLIExecutionResult = {
stdout: 'Success output',
stderr: 'Warning message',
success: true
};
const formatted = defaultCLIResultProcessor(result, {});
expect(formatted).toBe('Success output\n\nWarnings/Info:\nWarning message');
});
it('should format failed results', () => {
const result: CLIExecutionResult = {
stdout: '',
stderr: 'Error message',
success: false,
error: 'Command failed',
exitCode: 1
};
const formatted = defaultCLIResultProcessor(result, {});
expect(formatted).toBe('Command failed (exit code 1):\nCommand failed');
});
it('should handle empty output', () => {
const result: CLIExecutionResult = {
stdout: '',
stderr: '',
success: true
};
const formatted = defaultCLIResultProcessor(result, {});
expect(formatted).toBe('Command executed successfully (no output)');
});
});
describe('createCodeQLSchemas', () => {
it('should create database schema', () => {
const schema = createCodeQLSchemas.database();
expect(schema).toBeInstanceOf(z.ZodString);
});
it('should create query schema', () => {
const schema = createCodeQLSchemas.query();
expect(schema).toBeInstanceOf(z.ZodString);
});
it('should create output format schema', () => {
const schema = createCodeQLSchemas.outputFormat();
expect(schema).toBeInstanceOf(z.ZodOptional);
});
it('should create threads schema', () => {
const schema = createCodeQLSchemas.threads();
expect(schema).toBeInstanceOf(z.ZodOptional);
});
it('should create positional args schema with transformation', () => {
const schema = createCodeQLSchemas.positionalArgs();
expect(schema).toBeDefined();
// Test the transformation
const parsed = schema.parse(['arg1', 'arg2']);
expect(parsed).toEqual({ _positional: ['arg1', 'arg2'] });
});
});
describe('createQLTSchemas', () => {
it('should create language schema', () => {
const schema = createQLTSchemas.language();
expect(schema).toBeInstanceOf(z.ZodString);
});
it('should create template schema', () => {
const schema = createQLTSchemas.template();
expect(schema).toBeInstanceOf(z.ZodOptional);
});
it('should create force schema', () => {
const schema = createQLTSchemas.force();
expect(schema).toBeInstanceOf(z.ZodOptional);
});
});
describe('createBQRSResultProcessor', () => {
it('should format BQRS results with output path', () => {
const processor = createBQRSResultProcessor();
const result: CLIExecutionResult = {
stdout: 'BQRS decoded successfully',
stderr: '',
success: true
};
const formatted = processor(result, { output: '/path/to/output.csv' });
expect(formatted).toContain('BQRS decoded successfully');
expect(formatted).toContain('Results saved to: /path/to/output.csv');
});
it('should handle failed BQRS results', () => {
const processor = createBQRSResultProcessor();
const result: CLIExecutionResult = {
stdout: '',
stderr: 'BQRS error',
success: false,
error: 'Failed to decode',
exitCode: 1
};
const formatted = processor(result, {});
expect(formatted).toContain('Command failed (exit code 1)');
expect(formatted).toContain('Failed to decode');
});
});
describe('createDatabaseResultProcessor', () => {
it('should format database creation results', () => {
const processor = createDatabaseResultProcessor();
const result: CLIExecutionResult = {
stdout: 'Database created',
stderr: 'Info: Using Java extractor',
success: true
};
const formatted = processor(result, { database: '/path/to/db' });
expect(formatted).toContain('Database creation completed successfully');
expect(formatted).toContain('Database location: /path/to/db');
expect(formatted).toContain('Output:\nDatabase created');
expect(formatted).toContain('Additional information:\nInfo: Using Java extractor');
});
it('should handle positional database argument', () => {
const processor = createDatabaseResultProcessor();
const result: CLIExecutionResult = {
stdout: 'Database created',
stderr: '',
success: true
};
const formatted = processor(result, { _positional: ['my-database'] });
expect(formatted).toContain('Database location: my-database');
});
});
describe('registerCLITool', () => {
let mockServer: McpServer;
beforeEach(() => {
vi.clearAllMocks();
mockServer = {
registerTool: vi.fn()
} as unknown as McpServer;
});
it('should register a CodeQL tool correctly', () => {
const definition: CLIToolDefinition = {
name: 'test_codeql_tool',
description: 'Test CodeQL tool',
command: 'codeql',
subcommand: 'query run',
inputSchema: {
query: z.string(),
database: z.string()
}
};
registerCLITool(mockServer, definition);
// Verify the tool is registered with the right name, description, and a
// schema that normalizes camelCase keys (behaviour-level assertion instead
// of inspecting Zod internals like _def.typeName).
expect(mockServer.registerTool).toHaveBeenCalledWith(
'test_codeql_tool',
expect.objectContaining({
description: 'Test CodeQL tool',
inputSchema: expect.any(Object),
}),
expect.any(Function)
);
// Verify the schema normalizes a camelCase key to its canonical form
const registeredSchema = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][1].inputSchema;
const parsed = registeredSchema.safeParse({ query: 'q', database: 'db' });
expect(parsed.success).toBe(true);
});
it('should register a QLT tool correctly', () => {
const definition: CLIToolDefinition = {
name: 'test_qlt_tool',
description: 'Test QLT tool',
command: 'qlt',
subcommand: 'query generate',
inputSchema: {
language: z.string(),
output: z.string().optional()
}
};
registerCLITool(mockServer, definition);
// Behaviour-level assertion: verify registration and schema parsing
expect(mockServer.registerTool).toHaveBeenCalledWith(
'test_qlt_tool',
expect.objectContaining({
description: 'Test QLT tool',
inputSchema: expect.any(Object),
}),
expect.any(Function)
);
const registeredSchema = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][1].inputSchema;
const parsed = registeredSchema.safeParse({ language: 'java' });
expect(parsed.success).toBe(true);
});
it('should use custom result processor if provided', () => {
const customProcessor = vi.fn().mockReturnValue('Custom result');
const definition: CLIToolDefinition = {
name: 'test_custom_tool',
description: 'Test tool with custom processor',
command: 'codeql',
subcommand: 'test',
inputSchema: {},
resultProcessor: customProcessor
};
registerCLITool(mockServer, definition);
// Verify the tool was registered
expect(mockServer.registerTool).toHaveBeenCalled();
});
});
describe('registerCLITool handler behavior', () => {
let mockServer: McpServer;
let executeCodeQLCommand: ReturnType<typeof vi.fn>;
beforeEach(async () => {
vi.clearAllMocks();
mockServer = {
registerTool: vi.fn()
} as unknown as McpServer;
// Get the mocked function
const cliExecutor = await import('../../../src/lib/cli-executor');
executeCodeQLCommand = cliExecutor.executeCodeQLCommand as ReturnType<typeof vi.fn>;
});
it('should handle qlref parameter as positional argument for codeql_resolve_qlref', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_resolve_qlref',
description: 'Resolve qlref files',
command: 'codeql',
subcommand: 'resolve qlref',
inputSchema: {
qlref: z.string()
}
};
registerCLITool(mockServer, definition);
// Get the handler function that was registered
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
// Mock successful command execution
executeCodeQLCommand.mockResolvedValueOnce({
stdout: '/path/to/resolved.ql',
stderr: '',
success: true
});
// Call the handler with qlref parameter
const result = await handler({ qlref: '/path/to/test.qlref' });
// Verify the command was called with the qlref as positional argument
// executeCodeQLCommand signature: (subcommand, options, additionalArgs, cwd)
expect(executeCodeQLCommand).toHaveBeenCalledWith(
'resolve qlref',
expect.any(Object),
['/path/to/test.qlref'],
undefined
);
expect(result.content[0].text).toBe('/path/to/resolved.ql');
});
it('should handle database parameter as positional argument for codeql_resolve_database', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_resolve_database',
description: 'Resolve database',
command: 'codeql',
subcommand: 'resolve database',
inputSchema: {
database: z.string()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: '{"languages": ["javascript"]}',
stderr: '',
success: true
});
await handler({ database: '/path/to/db' });
// executeCodeQLCommand signature: (subcommand, options, additionalArgs, cwd)
expect(executeCodeQLCommand).toHaveBeenCalledWith(
'resolve database',
expect.any(Object),
['/path/to/db'],
undefined
);
});
it('should auto-resolve single-child database directory for codeql_resolve_database', async () => {
// Create a parent directory with one database subdirectory
const parentDir = createTestTempDir('db-resolve-single-');
const dbDir = join(parentDir, 'javascript');
mkdirSync(dbDir, { recursive: true });
writeFileSync(join(dbDir, 'codeql-database.yml'), 'primaryLanguage: javascript\n');
const definition: CLIToolDefinition = {
name: 'codeql_resolve_database',
description: 'Resolve database',
command: 'codeql',
subcommand: 'resolve database',
inputSchema: { database: z.string() }
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: '{"languages": ["javascript"]}',
stderr: '',
success: true
});
await handler({ database: parentDir });
// Should resolve to the child directory
expect(executeCodeQLCommand).toHaveBeenCalledWith(
'resolve database',
expect.any(Object),
[dbDir],
undefined
);
// Cleanup
rmSync(parentDir, { recursive: true, force: true });
});
it('should error on ambiguous multi-database directory for codeql_resolve_database', async () => {
// Create a parent directory with two database subdirectories
const parentDir = createTestTempDir('db-resolve-ambiguous-');
for (const lang of ['javascript', 'python']) {
const dbDir = join(parentDir, lang);
mkdirSync(dbDir, { recursive: true });
writeFileSync(join(dbDir, 'codeql-database.yml'), `primaryLanguage: ${lang}\n`);
}
const definition: CLIToolDefinition = {
name: 'codeql_resolve_database',
description: 'Resolve database',
command: 'codeql',
subcommand: 'resolve database',
inputSchema: { database: z.string() }
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
const result = await handler({ database: parentDir });
// Should return an error about ambiguous databases
expect(result.isError).toBe(true);
expect(result.content[0].text).toContain('Ambiguous database path');
expect(result.content[0].text).toContain('javascript');
expect(result.content[0].text).toContain('python');
// Cleanup
rmSync(parentDir, { recursive: true, force: true });
});
it('should handle database parameter as positional argument for codeql_database_create', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_database_create',
description: 'Create database',
command: 'codeql',
subcommand: 'database create',
inputSchema: {
database: z.string(),
language: z.string().optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: 'Database created successfully',
stderr: '',
success: true
});
await handler({ database: '/path/to/new-db', language: 'javascript' });
// executeCodeQLCommand signature: (subcommand, options, additionalArgs, cwd)
expect(executeCodeQLCommand).toHaveBeenCalledWith(
'database create',
expect.objectContaining({
language: 'javascript'
}),
['/path/to/new-db'],
undefined
);
});
it('should handle database and queries parameters as positional arguments for codeql_database_analyze', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_database_analyze',
description: 'Analyze database',
command: 'codeql',
subcommand: 'database analyze',
inputSchema: {
database: z.string(),
queries: z.string(),
format: z.string().optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: 'Analysis complete',
stderr: '',
success: true
});
await handler({ database: '/path/to/db', queries: 'security-queries', format: 'sarif-latest' });
// executeCodeQLCommand signature: (subcommand, options, additionalArgs, cwd)
expect(executeCodeQLCommand).toHaveBeenCalledWith(
'database analyze',
expect.objectContaining({
format: 'sarif-latest'
}),
['/path/to/db', 'security-queries'],
undefined
);
});
it('should handle query parameter as positional argument for codeql_generate_query-help', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_generate_query-help',
description: 'Generate query help',
command: 'codeql',
subcommand: 'generate query-help',
inputSchema: {
query: z.string(),
format: z.string().optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: '# Query Help\nThis is help content',
stderr: '',
success: true
});
await handler({ query: '/path/to/query.ql', format: 'markdown' });
// executeCodeQLCommand signature: (subcommand, options, additionalArgs, cwd)
expect(executeCodeQLCommand).toHaveBeenCalledWith(
'generate query-help',
expect.objectContaining({
format: 'markdown'
}),
['/path/to/query.ql'],
undefined
);
});
it('should enable --dump-dil by default for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: 'Compilation successful',
stderr: '',
success: true
});
await handler({ query: '/path/to/query.ql' });
const call = executeCodeQLCommand.mock.calls[0];
const options = call[1] as Record<string, unknown>;
// --dump-dil should be enabled by default
expect(options['dump-dil']).toBe(true);
});
it('should respect dump-dil: false for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: 'Compilation successful',
stderr: '',
success: true
});
await handler({ query: '/path/to/query.ql', 'dump-dil': false });
const call = executeCodeQLCommand.mock.calls[0];
const options = call[1] as Record<string, unknown>;
// --dump-dil should not be injected when explicitly disabled;
// buildCodeQLArgs skips false booleans so --dump-dil won't appear on CLI
expect(options['dump-dil']).toBe(false);
});
it('should not inject --dump-dil when --no-dump-dil is in additionalArgs for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: 'Compilation successful',
stderr: '',
success: true
});
await handler({ query: '/path/to/query.ql', additionalArgs: ['--no-dump-dil'] });
const call = executeCodeQLCommand.mock.calls[0];
const options = call[1] as Record<string, unknown>;
const positionalArgs = call[2] as string[];
// --no-dump-dil should be normalized into options['dump-dil'] = false
expect(options['dump-dil']).toBe(false);
// --no-dump-dil should be filtered from raw CLI args (not duplicated)
expect(positionalArgs).not.toContain('--no-dump-dil');
expect(positionalArgs).not.toContain('--dump-dil');
});
it('should not inject --dump-dil when --dump-dil is already in additionalArgs for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: 'Compilation successful',
stderr: '',
success: true
});
await handler({ query: '/path/to/query.ql', additionalArgs: ['--dump-dil'] });
const call = executeCodeQLCommand.mock.calls[0];
const options = call[1] as Record<string, unknown>;
const positionalArgs = call[2] as string[];
// --dump-dil should be normalized into options['dump-dil'] = true
expect(options['dump-dil']).toBe(true);
// --dump-dil should be filtered from raw CLI args (not duplicated)
expect(positionalArgs).not.toContain('--dump-dil');
expect(positionalArgs).not.toContain('--no-dump-dil');
});
it('should save DIL output to a .dil file for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
const dilContent = 'DIL:\n predicate#abc123\n SCAN table\n SELECT col1, col2';
executeCodeQLCommand.mockResolvedValueOnce({
stdout: dilContent,
stderr: '',
success: true
});
const codeqlQueryLogDir = createTestTempDir('codeql-query-log-dir');
const originalCodeqlQueryLogDir = process.env.CODEQL_QUERY_LOG_DIR;
process.env.CODEQL_QUERY_LOG_DIR = codeqlQueryLogDir;
try {
const result = await handler({ query: '/path/to/MyQuery.ql' });
// Response should contain the DIL file path
expect(result.content[0].text).toContain('DIL file:');
expect(result.content[0].text).toContain('MyQuery.dil');
// Extract the DIL file path from the response
const match = result.content[0].text.match(/DIL file: (.+)/);
expect(match).not.toBeNull();
const dilFilePath = match![1];
// Verify the .dil file was created with the correct content
expect(existsSync(dilFilePath)).toBe(true);
expect(dilFilePath.startsWith(`${codeqlQueryLogDir}/`) || dilFilePath.startsWith(`${codeqlQueryLogDir}\\`)).toBe(true);
const fileContent = readFileSync(dilFilePath, 'utf8');
expect(fileContent).toBe(dilContent);
} finally {
if (originalCodeqlQueryLogDir === undefined) {
delete process.env.CODEQL_QUERY_LOG_DIR;
} else {
process.env.CODEQL_QUERY_LOG_DIR = originalCodeqlQueryLogDir;
}
rmSync(codeqlQueryLogDir, { recursive: true, force: true });
}
});
it('should not save DIL file when dump-dil is explicitly false for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: 'Compilation successful',
stderr: '',
success: true
});
const result = await handler({ query: '/path/to/MyQuery.ql', 'dump-dil': false });
// Response should NOT contain DIL file path since dump-dil is disabled
expect(result.content[0].text).not.toContain('DIL file:');
});
it('should not leave empty log directory when codeql_query_compile fails', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
// Simulate compilation failure
executeCodeQLCommand.mockResolvedValueOnce({
stdout: '',
stderr: 'Compilation error: syntax error',
success: false,
exitCode: 1
});
const codeqlQueryLogDir = createTestTempDir('codeql-query-log-dir');
const originalCodeqlQueryLogDir = process.env.CODEQL_QUERY_LOG_DIR;
process.env.CODEQL_QUERY_LOG_DIR = codeqlQueryLogDir;
try {
const result = await handler({ query: '/path/to/MyQuery.ql' });
// Should report failure
expect(result.isError).toBe(true);
// No new subdirectories should be created inside the log dir
// since DIL persistence is deferred to post-success
const { readdirSync } = await import('fs');
const entries = readdirSync(codeqlQueryLogDir);
expect(entries).toHaveLength(0);
} finally {
if (originalCodeqlQueryLogDir === undefined) {
delete process.env.CODEQL_QUERY_LOG_DIR;
} else {
process.env.CODEQL_QUERY_LOG_DIR = originalCodeqlQueryLogDir;
}
rmSync(codeqlQueryLogDir, { recursive: true, force: true });
}
});
it('should not save DIL file when --no-dump-dil is in additionalArgs for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: 'Compilation successful',
stderr: '',
success: true
});
const result = await handler({ query: '/path/to/MyQuery.ql', additionalArgs: ['--no-dump-dil'] });
// Response should NOT contain DIL file path since --no-dump-dil disables DIL
expect(result.content[0].text).not.toContain('DIL file:');
});
it('should let --dump-dil in additionalArgs override dump-dil: false for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
const dilContent = 'DIL:\n predicate#abc123\n SCAN table';
executeCodeQLCommand.mockResolvedValueOnce({
stdout: dilContent,
stderr: '',
success: true
});
const codeqlQueryLogDir = createTestTempDir('codeql-query-log-dir');
const originalCodeqlQueryLogDir = process.env.CODEQL_QUERY_LOG_DIR;
process.env.CODEQL_QUERY_LOG_DIR = codeqlQueryLogDir;
try {
const result = await handler({
query: '/path/to/MyQuery.ql',
'dump-dil': false,
additionalArgs: ['--dump-dil']
});
const call = executeCodeQLCommand.mock.calls[0];
const options = call[1] as Record<string, unknown>;
const positionalArgs = call[2] as string[];
// additionalArgs --dump-dil should override the named dump-dil: false
expect(options['dump-dil']).toBe(true);
// --dump-dil should be filtered from raw CLI args (not duplicated)
expect(positionalArgs).not.toContain('--dump-dil');
expect(positionalArgs).not.toContain('--no-dump-dil');
// DIL output should be saved since dump-dil is effectively enabled
expect(result.content[0].text).toContain('DIL file:');
expect(result.content[0].text).toContain('MyQuery.dil');
} finally {
if (originalCodeqlQueryLogDir === undefined) {
delete process.env.CODEQL_QUERY_LOG_DIR;
} else {
process.env.CODEQL_QUERY_LOG_DIR = originalCodeqlQueryLogDir;
}
rmSync(codeqlQueryLogDir, { recursive: true, force: true });
}
});
it('should let --no-dump-dil in additionalArgs override dump-dil: true for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: 'Compilation successful',
stderr: '',
success: true
});
const result = await handler({
query: '/path/to/MyQuery.ql',
'dump-dil': true,
additionalArgs: ['--no-dump-dil']
});
const call = executeCodeQLCommand.mock.calls[0];
const options = call[1] as Record<string, unknown>;
const positionalArgs = call[2] as string[];
// additionalArgs --no-dump-dil should override the named dump-dil: true
expect(options['dump-dil']).toBe(false);
// --no-dump-dil should be filtered from raw CLI args (not duplicated)
expect(positionalArgs).not.toContain('--dump-dil');
expect(positionalArgs).not.toContain('--no-dump-dil');
// DIL output should NOT be saved since dump-dil is effectively disabled
expect(result.content[0].text).not.toContain('DIL file:');
});
it('should filter --dump-dil from additionalArgs when passed without named param for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: '',
stderr: '',
success: true
});
await handler({ query: '/path/to/query.ql', additionalArgs: ['--dump-dil'] });
const call = executeCodeQLCommand.mock.calls[0];
const options = call[1] as Record<string, unknown>;
const positionalArgs = call[2] as string[];
// --dump-dil should be normalized into the options object
expect(options['dump-dil']).toBe(true);
// --dump-dil should be filtered from raw CLI args to avoid duplication
expect(positionalArgs).not.toContain('--dump-dil');
});
it('should filter --no-dump-dil from additionalArgs when passed without named param for codeql_query_compile', async () => {
const definition: CLIToolDefinition = {
name: 'codeql_query_compile',
description: 'Compile query',
command: 'codeql',
subcommand: 'query compile',
inputSchema: {
query: z.string(),
'dump-dil': z.boolean().optional(),
additionalArgs: z.array(z.string()).optional()
}
};
registerCLITool(mockServer, definition);
const handler = (mockServer.registerTool as ReturnType<typeof vi.fn>).mock.calls[0][2];
executeCodeQLCommand.mockResolvedValueOnce({
stdout: 'Compilation successful',
stderr: '',
success: true
});
await handler({ query: '/path/to/query.ql', additionalArgs: ['--no-dump-dil'] });