cargo-aprz-lib 0.2.0

Internal library for cargo-aprz
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
use super::Host;
use super::config::Config;
use crate::Result;
use crate::expr::evaluate;
use crate::metrics::default_metrics;
use camino::{Utf8Path, Utf8PathBuf};
use cargo_metadata::MetadataCommand;
use chrono::Local;
use clap::Parser;
use ohno::IntoAppError;
use std::io::Write;

#[derive(Parser, Debug)]
pub struct ValidateArgs {
    /// Path to configuration file (default is `aprz.toml`)
    #[arg(long, short = 'c', value_name = "PATH")]
    pub config: Option<Utf8PathBuf>,

    /// Path to Cargo.toml file
    #[arg(long, default_value = "Cargo.toml", value_name = "PATH")]
    pub manifest_path: Utf8PathBuf,
}

/// Validates a configuration file by loading it and checking expression evaluation
///
/// # Errors
///
/// Returns an error if the config file cannot be loaded, parsed, or if expressions fail to evaluate
fn validate_config_inner(workspace_root: &Utf8Path, config_path: Option<&Utf8PathBuf>) -> Result<()> {
    let config = Config::load(workspace_root, config_path)?;

    // Validate that all expressions can be evaluated against default metrics (only if any are defined)
    if !config.deny_if_any.is_empty() || !config.accept_if_any.is_empty() || !config.accept_if_all.is_empty() {
        let metrics: Vec<_> = default_metrics().collect();

        let _ = evaluate(
            &config.deny_if_any,
            &config.accept_if_any,
            &config.accept_if_all,
            &metrics,
            Local::now(),
        )
        .into_app_err("evaluating configuration expressions")?;
    }

    Ok(())
}

pub fn validate_config<H: Host>(host: &mut H, args: &ValidateArgs) -> Result<()> {
    let config_path = args.config.as_ref();

    // Only resolve workspace root when no explicit config path is provided
    let workspace_root;
    let workspace_root_ref = if config_path.is_some() {
        // When an explicit config is given, workspace root is only used as a
        // base for relative paths inside Config::load, which won't apply here.
        Utf8Path::new(".")
    } else {
        let mut metadata_cmd = MetadataCommand::new();
        let _ = metadata_cmd.manifest_path(&args.manifest_path);
        let metadata = metadata_cmd.exec().into_app_err("unable to retrieve workspace metadata")?;
        workspace_root = metadata.workspace_root;
        &workspace_root
    };

    match validate_config_inner(workspace_root_ref, config_path) {
        Ok(()) => {
            let _ = writeln!(host.output(), "Configuration file is valid");
            if let Some(path) = config_path {
                let _ = writeln!(host.output(), "Config file: {path}");
            } else {
                let _ = writeln!(host.output(), "Using default configuration (no config file found)");
            }
            Ok(())
        }
        Err(e) => {
            let _ = writeln!(host.error(), "❌ Configuration validation failed: {e}");
            host.exit(1);
            Err(e)
        }
    }
}

#[cfg(test)]
#[cfg_attr(coverage_nightly, coverage(off))]
mod tests {
    use super::*;
    use crate::commands::init::{InitArgs, init_config};
    use std::io::Cursor;

    /// Test host that captures output to in-memory buffers
    struct TestHost {
        output_buf: Vec<u8>,
        error_buf: Vec<u8>,
    }

    impl TestHost {
        fn new() -> Self {
            Self {
                output_buf: Vec::new(),
                error_buf: Vec::new(),
            }
        }
    }

    impl Host for TestHost {
        fn output(&mut self) -> impl Write {
            Cursor::new(&mut self.output_buf)
        }

        fn error(&mut self) -> impl Write {
            Cursor::new(&mut self.error_buf)
        }

        fn exit(&mut self, _code: i32) {
            // In tests, don't actually exit
        }
    }

    #[test]
    fn test_default_config_is_valid() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = Utf8PathBuf::from(temp_dir.path().to_string_lossy().to_string()).join("test_config.toml");

        // Generate default configuration using init_config
        let mut init_host = TestHost::new();
        let init_args = InitArgs {
            output: Some(config_path.clone()),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        init_config(&mut init_host, &init_args).expect("init_config should succeed");

        // Validate the generated configuration
        let mut host = TestHost::new();
        let args = ValidateArgs {
            config: Some(config_path),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        let result = validate_config(&mut host, &args);

        assert!(result.is_ok(), "Default configuration should validate successfully: {result:?}");
    }

    #[test]
    fn test_default_config_matches_embedded() {
        // Verify that Config::default() produces the same config as parsing DEFAULT_CONFIG_TOML
        let default_config = Config::default();
        let parsed_config: Config =
            toml::from_str(super::super::config::DEFAULT_CONFIG_TOML).expect("DEFAULT_CONFIG_TOML should parse successfully");

        // Compare the serialized forms to ensure they're equivalent
        let default_toml = toml::to_string(&default_config).expect("default config should serialize");
        let parsed_toml = toml::to_string(&parsed_config).expect("parsed config should serialize");

        assert_eq!(
            default_toml, parsed_toml,
            "Config::default() should match parsing DEFAULT_CONFIG_TOML"
        );
    }

    #[test]
    fn test_invalid_toml_syntax() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = Utf8PathBuf::from(temp_dir.path().to_string_lossy().to_string()).join("invalid_syntax.toml");

        std::fs::write(
            &config_path,
            r#"
# Missing closing bracket
[[deny_if_any]
name = "test"
expression = "true"
"#,
        )
        .expect("Failed to write test config");

        let mut host = TestHost::new();
        let args = ValidateArgs {
            config: Some(config_path),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        let result = validate_config(&mut host, &args);

        assert!(result.is_err(), "Invalid TOML syntax should fail validation");

        // Extract just the error message before the context chain and backtrace
        let error_msg = result.unwrap_err().to_string();
        let without_context = error_msg.split("\n>").next().unwrap_or(&error_msg);
        let snapshot_content = without_context.split("\nBacktrace:").next().unwrap_or(without_context).trim();
        insta::assert_snapshot!(snapshot_content);
    }

    #[test]
    fn test_unknown_field() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = Utf8PathBuf::from(temp_dir.path().to_string_lossy().to_string()).join("unknown_field.toml");

        std::fs::write(
            &config_path,
            r#"
deny_if_any = []
accept_if_any = []
accept_if_all = []
unknown_field = "value"
"#,
        )
        .expect("Failed to write test config");

        let mut host = TestHost::new();
        let args = ValidateArgs {
            config: Some(config_path),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        let result = validate_config(&mut host, &args);

        assert!(result.is_err(), "Unknown field should fail validation");

        // Extract just the error message before the context chain and backtrace
        let error_msg = result.unwrap_err().to_string();
        let without_context = error_msg.split("\n>").next().unwrap_or(&error_msg);
        let snapshot_content = without_context.split("\nBacktrace:").next().unwrap_or(without_context).trim();
        insta::assert_snapshot!(snapshot_content);
    }

    #[test]
    fn test_invalid_expression_syntax() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = Utf8PathBuf::from(temp_dir.path().to_string_lossy().to_string()).join("invalid_expression.toml");

        std::fs::write(
            &config_path,
            r#"
[[deny_if_any]]
name = "invalid_syntax"
description = "Invalid CEL syntax"
expression = "this is not a valid CEL expression !!!"
"#,
        )
        .expect("Failed to write test config");

        let mut host = TestHost::new();
        let args = ValidateArgs {
            config: Some(config_path),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        let result = validate_config(&mut host, &args);

        assert!(result.is_err(), "Invalid expression syntax should fail validation");

        // Extract just the error message before the context chain and backtrace
        let error_msg = result.unwrap_err().to_string();
        let without_context = error_msg.split("\n>").next().unwrap_or(&error_msg);
        let snapshot_content = without_context.split("\nBacktrace:").next().unwrap_or(without_context).trim();
        insta::assert_snapshot!(snapshot_content);
    }

    #[test]
    fn test_invalid_duration_format() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = Utf8PathBuf::from(temp_dir.path().to_string_lossy().to_string()).join("invalid_duration.toml");

        std::fs::write(
            &config_path,
            r#"
crates_cache_ttl = "not a valid duration"
"#,
        )
        .expect("Failed to write test config");

        let mut host = TestHost::new();
        let args = ValidateArgs {
            config: Some(config_path),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        let result = validate_config(&mut host, &args);

        assert!(result.is_err(), "Invalid duration format should fail validation");

        // Extract just the error message before the context chain and backtrace
        let error_msg = result.unwrap_err().to_string();
        let without_context = error_msg.split("\n>").next().unwrap_or(&error_msg);
        let snapshot_content = without_context.split("\nBacktrace:").next().unwrap_or(without_context).trim();
        insta::assert_snapshot!(snapshot_content);
    }

    #[test]
    fn test_expression_with_nonexistent_metric() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = Utf8PathBuf::from(temp_dir.path().to_string_lossy().to_string()).join("nonexistent_metric.toml");

        std::fs::write(
            &config_path,
            r#"
[[accept_if_all]]
name = "nonexistent_metric"
description = "Reference to nonexistent metric"
expression = "this_metric_does_not_exist > 100"
"#,
        )
        .expect("Failed to write test config");

        let mut host = TestHost::new();
        let args = ValidateArgs {
            config: Some(config_path),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        let result = validate_config(&mut host, &args);

        assert!(result.is_err(), "Expression referencing nonexistent metric should fail validation");

        // Extract just the error message before the context chain and backtrace
        let error_msg = result.unwrap_err().to_string();
        let without_context = error_msg.split("\n>").next().unwrap_or(&error_msg);
        let snapshot_content = without_context.split("\nBacktrace:").next().unwrap_or(without_context).trim();
        insta::assert_snapshot!(snapshot_content);
    }

    #[test]
    fn test_expression_with_type_mismatch() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = Utf8PathBuf::from(temp_dir.path().to_string_lossy().to_string()).join("type_mismatch.toml");

        std::fs::write(
            &config_path,
            r#"
[[deny_if_any]]
name = "type_mismatch"
description = "Type mismatch in expression"
expression = "crates.downloads + 'string'"
"#,
        )
        .expect("Failed to write test config");

        let mut host = TestHost::new();
        let args = ValidateArgs {
            config: Some(config_path),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        let result = validate_config(&mut host, &args);

        assert!(result.is_err(), "Expression with type mismatch should fail validation");

        // Extract just the error message before the context chain and backtrace
        let error_msg = result.unwrap_err().to_string();
        let without_context = error_msg.split("\n>").next().unwrap_or(&error_msg);
        let snapshot_content = without_context.split("\nBacktrace:").next().unwrap_or(without_context).trim();
        insta::assert_snapshot!(snapshot_content);
    }

    #[test]
    fn test_expression_returning_non_boolean() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = Utf8PathBuf::from(temp_dir.path().to_string_lossy().to_string()).join("non_boolean.toml");

        std::fs::write(
            &config_path,
            r#"
[[accept_if_all]]
name = "non_boolean"
description = "Expression returns integer not boolean"
expression = "crates.downloads"
"#,
        )
        .expect("Failed to write test config");

        let mut host = TestHost::new();
        let args = ValidateArgs {
            config: Some(config_path),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        let result = validate_config(&mut host, &args);

        assert!(result.is_err(), "Expression returning non-boolean should fail validation");

        // Extract just the error message before the context chain and backtrace
        let error_msg = result.unwrap_err().to_string();
        let without_context = error_msg.split("\n>").next().unwrap_or(&error_msg);
        let snapshot_content = without_context.split("\nBacktrace:").next().unwrap_or(without_context).trim();
        insta::assert_snapshot!(snapshot_content);
    }

    #[test]
    fn test_empty_config_is_valid() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = Utf8PathBuf::from(temp_dir.path().to_string_lossy().to_string()).join("empty.toml");

        std::fs::write(&config_path, "# Empty config file\n").expect("Failed to write test config");

        let mut host = TestHost::new();
        let args = ValidateArgs {
            config: Some(config_path),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        let result = validate_config(&mut host, &args);

        assert!(result.is_ok(), "Empty config should be valid (uses defaults)");
    }

    #[test]
    fn test_config_with_only_ttls() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = Utf8PathBuf::from(temp_dir.path().to_string_lossy().to_string()).join("only_ttls.toml");

        std::fs::write(
            &config_path,
            r#"
crates_cache_ttl = "1h"
hosting_cache_ttl = "2h"
codebase_cache_ttl = "3h"
coverage_cache_ttl = "4h"
advisories_cache_ttl = "5h"
"#,
        )
        .expect("Failed to write test config");

        let mut host = TestHost::new();
        let args = ValidateArgs {
            config: Some(config_path),
            manifest_path: Utf8PathBuf::from("Cargo.toml"),
        };
        let result = validate_config(&mut host, &args);

        assert!(
            result.is_ok(),
            "Config with only TTLs should be valid (expressions default to empty)"
        );
    }
}