forge-guard 0.3.3

Pre-deployment smart contract auditing framework for Foundry
Documentation
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
//! Tests for the plugin architecture.
//!
//! Covers: registry creation, built-in plugin registration, listing,
//! enabling/disabling, plugin execution, and IPC protocol types.

#[cfg(test)]
mod tests {
    use forge_guard::core::{Finding, ProjectConfig, Severity};
    use forge_guard::plugins::{
        register_default_plugins, ExamplePlugin, OfflineGuardPlugin, Plugin, PluginContext,
        PluginExecutionStats, PluginInfo, PluginIpcFinding, PluginIpcInput, PluginIpcOutput,
        PluginRegistry, PluginType,
    };
    use std::path::PathBuf;

    // ── Built-in Plugin Tests ────────────────────────────────

    #[test]
    fn test_example_plugin_meta() {
        let plugin = ExamplePlugin;
        assert_eq!(plugin.name(), "forge-guard-example");
        assert_eq!(plugin.version(), "0.1.0");
        assert_eq!(
            plugin.description(),
            "Example plugin demonstrating the plugin API"
        );
        assert!(plugin.supports_offline());
        assert!(!plugin.requires_rpc());
    }

    #[test]
    fn test_offline_guard_plugin_meta() {
        let plugin = OfflineGuardPlugin;
        assert_eq!(plugin.name(), "forge-guard-offline-guard");
        assert!(plugin.supports_offline());
        assert!(!plugin.requires_rpc());
    }

    #[test]
    fn test_example_plugin_execution() {
        let plugin = ExamplePlugin;
        let ctx = PluginContext::new(&ProjectConfig::default(), vec![]);
        let result = plugin.execute(&ctx);
        assert!(result.is_ok());
        assert_eq!(result.unwrap().len(), 0); // Example plugin returns no findings
    }

    #[test]
    fn test_offline_guard_execution_offline() {
        let plugin = OfflineGuardPlugin;
        let ctx =
            PluginContext::new(&ProjectConfig::default(), vec![]).with_metadata("offline", "true");
        let result = plugin.execute(&ctx);
        assert!(result.is_ok());
    }

    // ── Registry Tests ──────────────────────────────────────

    #[test]
    fn test_registry_create_empty() {
        let config = ProjectConfig::default();
        let registry = PluginRegistry::new(&config);
        assert!(registry.is_ok());
        let registry = registry.unwrap();
        assert_eq!(registry.plugin_count(), 0);
        assert!(registry.list_plugins().is_empty());
    }

    #[test]
    fn test_registry_register_builtin() {
        let config = ProjectConfig::default();
        let mut registry = PluginRegistry::new(&config).unwrap();

        assert_eq!(registry.plugin_count(), 0);

        registry.register_builtin(Box::new(ExamplePlugin));
        assert_eq!(registry.plugin_count(), 1);

        registry.register_builtin(Box::new(OfflineGuardPlugin));
        assert_eq!(registry.plugin_count(), 2);
    }

    #[test]
    fn test_register_default_plugins_helper() {
        let config = ProjectConfig::default();
        let mut registry = PluginRegistry::new(&config).unwrap();

        register_default_plugins(&mut registry);

        assert_eq!(registry.plugin_count(), 2);
        let names: Vec<String> = registry
            .list_plugins()
            .iter()
            .map(|p| p.name.clone())
            .collect();
        assert!(names.contains(&"forge-guard-example".to_string()));
        assert!(names.contains(&"forge-guard-offline-guard".to_string()));
    }

    #[test]
    fn test_registry_list_and_get_plugin() {
        let config = ProjectConfig::default();
        let mut registry = PluginRegistry::new(&config).unwrap();
        register_default_plugins(&mut registry);

        let plugins = registry.list_plugins();
        assert_eq!(plugins.len(), 2);
        assert!(plugins
            .iter()
            .all(|p| matches!(p.plugin_type, PluginType::Builtin)));

        // Get specific plugin
        let example = registry.get_plugin("forge-guard-example");
        assert!(example.is_some());
        assert_eq!(example.unwrap().version, "0.1.0");

        // Get non-existent plugin
        assert!(registry.get_plugin("non-existent").is_none());
    }

    #[test]
    fn test_enable_disable_plugin() {
        let config = ProjectConfig::default();
        let mut registry = PluginRegistry::new(&config).unwrap();
        register_default_plugins(&mut registry);

        // Default: both enabled
        assert_eq!(registry.enabled_count(), 2);

        // Disable one
        assert!(registry.disable_plugin("forge-guard-example"));
        assert_eq!(registry.enabled_count(), 1);

        let example = registry.get_plugin("forge-guard-example").unwrap();
        assert!(!example.enabled);

        // Enable it back
        assert!(registry.enable_plugin("forge-guard-example"));
        let example = registry.get_plugin("forge-guard-example").unwrap();
        assert!(example.enabled);

        // Enable non-existent
        assert!(!registry.enable_plugin("non-existent"));
    }

    #[test]
    fn test_registry_disabled_from_config() {
        let mut config = ProjectConfig::default();
        config
            .plugins
            .disabled
            .push("forge-guard-example".to_string());

        let mut registry = PluginRegistry::new(&config).unwrap();
        register_default_plugins(&mut registry);

        let example = registry.get_plugin("forge-guard-example").unwrap();
        assert!(!example.enabled, "Should be disabled via config");

        let guard = registry.get_plugin("forge-guard-offline-guard").unwrap();
        assert!(guard.enabled, "Should still be enabled");
    }

    // ── Plugin Execution Tests ──────────────────────────────

    #[test]
    fn test_execute_all_builtins() {
        let config = ProjectConfig::default();
        let mut registry = PluginRegistry::new(&config).unwrap();
        register_default_plugins(&mut registry);

        let ctx = PluginContext::new(&config, vec![]);
        let results = registry.execute_all(&ctx);

        assert_eq!(results.len(), 2, "Should execute both plugins");

        for result in &results {
            assert!(
                result.success,
                "Plugin '{}' should succeed",
                result.plugin_name
            );
            assert!(
                result.findings.is_empty(),
                "Plugin '{}' should have no findings",
                result.plugin_name
            );
            assert!(
                result.error.is_none(),
                "Plugin '{}' should have no error",
                result.plugin_name
            );
        }
    }

    #[test]
    fn test_execute_skips_disabled_plugins() {
        let mut config = ProjectConfig::default();
        config
            .plugins
            .disabled
            .push("forge-guard-example".to_string());

        let mut registry = PluginRegistry::new(&config).unwrap();
        register_default_plugins(&mut registry);

        let ctx = PluginContext::new(&config, vec![]);
        let results = registry.execute_all(&ctx);

        assert_eq!(results.len(), 1, "Only one plugin should execute");
        assert_eq!(results[0].plugin_name, "forge-guard-offline-guard");
    }

    #[test]
    fn test_execute_with_source_files() {
        let config = ProjectConfig::default();
        let mut registry = PluginRegistry::new(&config).unwrap();
        register_default_plugins(&mut registry);

        let source_files = vec![PathBuf::from("test-contracts/secure/src/Counter.sol")];
        let ctx = PluginContext::new(&config, source_files);
        let results = registry.execute_all(&ctx);

        assert_eq!(results.len(), 2);
        for result in &results {
            assert!(result.success);
        }
    }

    // ── PluginInfo Tests ────────────────────────────────────

    #[test]
    fn test_plugin_info_display() {
        let info = PluginInfo {
            name: "test-plugin".to_string(),
            version: "0.1.0".to_string(),
            description: "A test plugin".to_string(),
            enabled: true,
            plugin_type: PluginType::Builtin,
            path: None,
        };

        assert_eq!(info.name, "test-plugin");
        assert_eq!(info.version, "0.1.0");
        assert!(info.enabled);
        assert_eq!(info.plugin_type, PluginType::Builtin);
    }

    #[test]
    fn test_plugin_type_equality() {
        assert_eq!(PluginType::Builtin, PluginType::Builtin);
        assert_eq!(PluginType::External, PluginType::External);
        assert_ne!(PluginType::Builtin, PluginType::External);
    }

    // ── IPC Protocol Tests ──────────────────────────────────

    #[test]
    fn test_ipc_input_serialization() {
        let input = PluginIpcInput {
            protocol_version: "1.0".to_string(),
            plugin_name: "test-plugin".to_string(),
            context: PluginContext::new(&ProjectConfig::default(), vec![]),
        };

        let json = serde_json::to_string(&input).unwrap();
        assert!(json.contains("\"protocol_version\":\"1.0\""));
        assert!(json.contains("\"plugin_name\":\"test-plugin\""));

        // Round-trip
        let deserialized: PluginIpcInput = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.protocol_version, "1.0");
        assert_eq!(deserialized.plugin_name, "test-plugin");
    }

    #[test]
    fn test_ipc_output_success() {
        let output = PluginIpcOutput {
            success: true,
            findings: vec![],
            error: None,
            stats: PluginExecutionStats {
                files_analyzed: 5,
                duration_ms: 42,
            },
        };

        let json = serde_json::to_string(&output).unwrap();
        assert!(json.contains("\"success\":true"));

        let deserialized: PluginIpcOutput = serde_json::from_str(&json).unwrap();
        assert!(deserialized.success);
        assert!(deserialized.findings.is_empty());
        assert!(deserialized.error.is_none());
        assert_eq!(deserialized.stats.files_analyzed, 5);
    }

    #[test]
    fn test_ipc_output_error() {
        let output = PluginIpcOutput {
            success: false,
            findings: vec![],
            error: Some("Something went wrong".to_string()),
            stats: PluginExecutionStats::default(),
        };

        let json = serde_json::to_string(&output).unwrap();
        assert!(json.contains("\"success\":false"));
        assert!(json.contains("\"error\":\"Something went wrong\""));

        let deserialized: PluginIpcOutput = serde_json::from_str(&json).unwrap();
        assert!(!deserialized.success);
        assert_eq!(deserialized.error.unwrap(), "Something went wrong");
    }

    #[test]
    fn test_ipc_output_with_findings() {
        let output = PluginIpcOutput {
            success: true,
            findings: vec![PluginIpcFinding {
                title: "Test Issue".to_string(),
                description: "A test finding".to_string(),
                severity: "high".to_string(),
                file: Some("Vault.sol".to_string()),
                line: Some(42),
                column: Some(8),
                code_snippet: Some("msg.sender.call{value: amount}(\"\");".to_string()),
                recommendation: Some("Use checks-effects-interactions.".to_string()),
                category: Some("Logic".to_string()),
                blocks_deployment: true,
                references: vec![],
            }],
            error: None,
            stats: PluginExecutionStats::default(),
        };

        let json = serde_json::to_string(&output).unwrap();
        assert!(json.contains("\"title\":\"Test Issue\""));
        assert!(json.contains("\"severity\":\"high\""));
        assert!(json.contains("\"blocks_deployment\":true"));

        // Check IPC finding conversion to core Finding
        let deserialized: PluginIpcOutput = serde_json::from_str(&json).unwrap();
        let finding: Finding = deserialized.findings.into_iter().next().unwrap().into();
        assert_eq!(finding.title, "Test Issue");
        assert_eq!(finding.severity, Severity::High);
        assert_eq!(finding.file, Some("Vault.sol".to_string()));
        assert_eq!(finding.line, Some(42));
        assert!(finding.blocks_deployment);
    }

    #[test]
    fn test_ipc_finding_critical_severity() {
        let ipc_finding = PluginIpcFinding {
            title: "Critical Bug".to_string(),
            description: "test".to_string(),
            severity: "CRITICAL".to_string(),
            file: None,
            line: None,
            column: None,
            code_snippet: None,
            recommendation: None,
            category: None,
            blocks_deployment: true,
            references: vec![],
        };
        let finding: Finding = ipc_finding.into();
        assert_eq!(finding.severity, Severity::Critical);
        assert!(finding.blocks_deployment);
    }

    #[test]
    fn test_ipc_finding_informational_severity() {
        let ipc_finding = PluginIpcFinding {
            title: "Style".to_string(),
            description: "test".to_string(),
            severity: "info".to_string(),
            file: None,
            line: None,
            column: None,
            code_snippet: None,
            recommendation: None,
            category: None,
            blocks_deployment: false,
            references: vec![],
        };
        let finding: Finding = ipc_finding.into();
        assert_eq!(finding.severity, Severity::Informational);
        assert!(!finding.blocks_deployment);
    }

    #[test]
    fn test_ipc_output_empty_findings_default() {
        // Test that empty findings list works with default
        let output = PluginIpcOutput {
            success: true,
            findings: vec![],
            error: None,
            stats: PluginExecutionStats::default(),
        };
        let json = serde_json::to_string(&output).unwrap();
        let deserialized: PluginIpcOutput = serde_json::from_str(&json).unwrap();
        assert!(deserialized.findings.is_empty());
    }

    // ── PluginContext Tests ─────────────────────────────────

    #[test]
    fn test_plugin_context_new() {
        let config = ProjectConfig::default();
        let ctx = PluginContext::new(&config, vec![]);
        assert!(ctx.metadata.is_empty());
        assert!(ctx.source_files.is_empty());
    }

    #[test]
    fn test_plugin_context_with_metadata() {
        let config = ProjectConfig::default();
        let ctx = PluginContext::new(&config, vec![])
            .with_metadata("chain", "ethereum")
            .with_metadata("verbose", "true");

        assert_eq!(ctx.metadata.get("chain").unwrap(), "ethereum");
        assert_eq!(ctx.metadata.get("verbose").unwrap(), "true");
        assert_eq!(ctx.metadata.len(), 2);
    }

    #[test]
    fn test_plugin_context_serialization() {
        let config = ProjectConfig::default();
        let ctx = PluginContext::new(&config, vec![PathBuf::from("contracts/Vault.sol")])
            .with_metadata("chain", "base");

        let json = serde_json::to_string(&ctx).unwrap();
        assert!(json.contains("contracts/Vault.sol"));
        assert!(json.contains("\"chain\":\"base\""));

        let deserialized: PluginContext = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.source_files.len(), 1);
        assert_eq!(deserialized.metadata.get("chain").unwrap(), "base");
    }
}