cargo-quickstart 0.1.4

A cargo subcommand for quickly generating Rust project scaffolds
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
//! Check for dependency issues in the project

use crate::commands::doctor::diagnosis::Check;
use crate::commands::doctor::types::{Diagnostic, Severity};
#[cfg(test)]
use mockall;
use std::process::{Command, Output};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use which;

/// Constants for dependency checking
const CARGO_OUTDATED_RECOMMENDATION: &str = "Install cargo-outdated: cargo install cargo-outdated";
const CARGO_UDEPS_RECOMMENDATION: &str = "Install cargo-udeps: cargo install cargo-udeps";

/// Trait for executing cargo commands, allowing for easier mocking in tests
#[cfg_attr(test, allow(clippy::disallowed_methods))]
#[cfg_attr(test, mockall::automock)]
pub trait CommandExecutor: Send + Sync {
    fn execute_outdated(&self) -> std::io::Result<Output>;
    fn execute_udeps(&self) -> std::io::Result<Output>;
    fn is_command_available(&self, command: &str) -> bool;
}

/// Default implementation that calls the actual cargo commands
pub struct RealCommandExecutor {
    is_running: Arc<AtomicBool>,
}

impl RealCommandExecutor {
    fn new() -> Self {
        Self {
            is_running: Arc::new(AtomicBool::new(false)),
        }
    }
}

impl Drop for RealCommandExecutor {
    fn drop(&mut self) {
        if self.is_running.load(Ordering::SeqCst) {
            // Ensure any running processes are cleaned up
            if let Ok(ps) = std::process::Command::new("ps").args(["aux"]).output() {
                let output = String::from_utf8_lossy(&ps.stdout);
                for line in output.lines() {
                    if line.contains("cargo outdated") || line.contains("cargo udeps") {
                        if let Some(pid) = line.split_whitespace().nth(1) {
                            if let Ok(pid) = pid.parse::<i32>() {
                                unsafe {
                                    libc::kill(pid, libc::SIGTERM);
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

impl CommandExecutor for RealCommandExecutor {
    fn execute_outdated(&self) -> std::io::Result<Output> {
        self.is_running.store(true, Ordering::SeqCst);
        let output = Command::new("cargo")
            .args(["outdated", "--exit-code", "1"])
            .output();
        self.is_running.store(false, Ordering::SeqCst);
        output
    }

    fn execute_udeps(&self) -> std::io::Result<Output> {
        self.is_running.store(true, Ordering::SeqCst);
        let output = Command::new("cargo")
            .args(["udeps", "--", "--no-run", "--no-fail-fast"])
            .output();
        self.is_running.store(false, Ordering::SeqCst);
        output
    }

    fn is_command_available(&self, command: &str) -> bool {
        which::which(command).is_ok()
    }
}

/// Check for dependency issues in the project
pub struct DependenciesCheck {
    executor: Box<dyn CommandExecutor>,
}

impl Drop for DependenciesCheck {
    fn drop(&mut self) {
        // No need to explicitly drop the executor as it will be dropped automatically
    }
}

impl DependenciesCheck {
    /// Create a new DependenciesCheck with the default command executor
    pub fn new() -> Self {
        Self {
            executor: Box::new(RealCommandExecutor::new()),
        }
    }

    /// Create a new DependenciesCheck with a custom command executor (for testing)
    #[cfg(test)]
    pub fn with_executor(executor: Box<dyn CommandExecutor>) -> Self {
        Self { executor }
    }

    /// Check for outdated dependencies using cargo-outdated
    fn check_outdated(&self) -> Diagnostic {
        // First check if cargo-outdated is installed
        if !self.executor.is_command_available("cargo-outdated") {
            return Diagnostic::new(
                self.name(),
                Severity::Suggestion,
                "cargo-outdated is not installed",
                self.category(),
            )
            .with_suggestion(CARGO_OUTDATED_RECOMMENDATION);
        }

        match self.executor.execute_outdated() {
            Ok(output) => {
                if output.status.success() {
                    Diagnostic::new(
                        self.name(),
                        Severity::Info,
                        "All dependencies are up to date",
                        self.category(),
                    )
                } else {
                    Diagnostic::new(
                        self.name(),
                        Severity::Warning,
                        "Outdated dependencies found",
                        self.category(),
                    )
                    .with_suggestion("Run 'cargo outdated' to see details and update dependencies")
                }
            }
            Err(_) => Diagnostic::new(
                self.name(),
                Severity::Suggestion,
                "Could not check for outdated dependencies",
                self.category(),
            )
            .with_suggestion(CARGO_OUTDATED_RECOMMENDATION),
        }
    }

    /// Check for unused dependencies using cargo-udeps
    fn check_unused(&self) -> Diagnostic {
        // First check if cargo-udeps is installed
        if !self.executor.is_command_available("cargo-udeps") {
            return Diagnostic::new(
                self.name(),
                Severity::Suggestion,
                "cargo-udeps is not installed",
                self.category(),
            )
            .with_suggestion(CARGO_UDEPS_RECOMMENDATION);
        }

        match self.executor.execute_udeps() {
            Ok(output) => {
                if output.status.success() {
                    Diagnostic::new(
                        self.name(),
                        Severity::Info,
                        "No unused dependencies found",
                        self.category(),
                    )
                } else {
                    // Parse output to find unused dependencies
                    let output_str = String::from_utf8_lossy(&output.stderr);
                    Diagnostic::new(
                        self.name(),
                        Severity::Warning,
                        "Unused dependencies found",
                        self.category(),
                    )
                    .with_details(output_str.to_string())
                    .with_suggestion(
                        "Run 'cargo udeps' to see details and remove unused dependencies",
                    )
                }
            }
            Err(_) => Diagnostic::new(
                self.name(),
                Severity::Suggestion,
                "Could not check for unused dependencies",
                self.category(),
            )
            .with_suggestion(CARGO_UDEPS_RECOMMENDATION),
        }
    }

    /// Check that all dependencies have explicit versions
    fn check_dependency_versions(&self) -> Diagnostic {
        // In a real implementation, this would parse Cargo.toml
        // For now, just a placeholder
        Diagnostic::new(
            self.name(),
            Severity::Info,
            "All dependencies have explicit versions",
            self.category(),
        )
    }
}

impl Check for DependenciesCheck {
    fn run(&self) -> Vec<Diagnostic> {
        vec![
            self.check_outdated(),
            self.check_unused(),
            self.check_dependency_versions(),
        ]
    }

    fn name(&self) -> &str {
        "Dependencies"
    }

    fn description(&self) -> &str {
        "Check for dependency issues (outdated, unused)"
    }

    fn category(&self) -> &str {
        "dependencies"
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use pretty_assertions::assert_eq;
    use std::os::unix::process::ExitStatusExt;

    fn success_output() -> Output {
        Output {
            status: std::process::ExitStatus::from_raw(0),
            stdout: Vec::new(),
            stderr: Vec::new(),
        }
    }

    fn failure_output() -> Output {
        Output {
            status: std::process::ExitStatus::from_raw(1),
            stdout: Vec::new(),
            stderr: b"errors found".to_vec(),
        }
    }

    #[test]
    fn test_name_method() {
        let check = DependenciesCheck::new();
        assert_eq!(check.name(), "Dependencies");
    }

    #[test]
    fn test_description_method() {
        let check = DependenciesCheck::new();
        assert_eq!(
            check.description(),
            "Check for dependency issues (outdated, unused)"
        );
    }

    #[test]
    fn test_category_method() {
        let check = DependenciesCheck::new();
        assert_eq!(check.category(), "dependencies");
    }

    #[test]
    fn test_outdated_command_not_available() {
        let mut mock = MockCommandExecutor::new();
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-outdated"))
            .return_const(false);
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-udeps"))
            .return_const(true);
        mock.expect_execute_udeps()
            .return_once(|| Ok(success_output()));

        let check = DependenciesCheck::with_executor(Box::new(mock));
        let diagnostics = check.run();

        assert_eq!(diagnostics[0].severity, Severity::Suggestion);
        assert!(diagnostics[0].message.contains("not installed"));
    }

    #[test]
    fn test_udeps_command_not_available() {
        let mut mock = MockCommandExecutor::new();
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-outdated"))
            .return_const(true);
        mock.expect_execute_outdated()
            .return_once(|| Ok(success_output()));
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-udeps"))
            .return_const(false);

        let check = DependenciesCheck::with_executor(Box::new(mock));
        let diagnostics = check.run();

        assert_eq!(diagnostics[1].severity, Severity::Suggestion);
        assert!(diagnostics[1].message.contains("not installed"));
    }

    #[test]
    fn test_outdated_command_success() {
        let mut mock = MockCommandExecutor::new();
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-outdated"))
            .return_const(true);
        mock.expect_execute_outdated()
            .return_once(|| Ok(success_output()));
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-udeps"))
            .return_const(true);
        mock.expect_execute_udeps()
            .return_once(|| Ok(success_output()));

        let check = DependenciesCheck::with_executor(Box::new(mock));
        let diagnostics = check.run();

        assert_eq!(diagnostics[0].severity, Severity::Info);
        assert!(diagnostics[0].message.contains("up to date"));
    }

    #[test]
    fn test_outdated_command_failure() {
        let mut mock = MockCommandExecutor::new();
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-outdated"))
            .return_const(true);
        mock.expect_execute_outdated()
            .return_once(|| Ok(failure_output()));
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-udeps"))
            .return_const(true);
        mock.expect_execute_udeps()
            .return_once(|| Ok(success_output()));

        let check = DependenciesCheck::with_executor(Box::new(mock));
        let diagnostics = check.run();

        assert_eq!(diagnostics[0].severity, Severity::Warning);
        assert!(diagnostics[0]
            .message
            .contains("Outdated dependencies found"));
    }

    #[test]
    fn test_udeps_command_success() {
        let mut mock = MockCommandExecutor::new();
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-outdated"))
            .return_const(true);
        mock.expect_execute_outdated()
            .return_once(|| Ok(success_output()));
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-udeps"))
            .return_const(true);
        mock.expect_execute_udeps()
            .return_once(|| Ok(success_output()));

        let check = DependenciesCheck::with_executor(Box::new(mock));
        let diagnostics = check.run();

        assert_eq!(diagnostics[1].severity, Severity::Info);
        assert!(diagnostics[1].message.contains("No unused dependencies"));
    }

    #[test]
    fn test_udeps_command_failure() {
        let mut mock = MockCommandExecutor::new();
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-outdated"))
            .return_const(true);
        mock.expect_execute_outdated()
            .return_once(|| Ok(success_output()));
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-udeps"))
            .return_const(true);
        mock.expect_execute_udeps()
            .return_once(|| Ok(failure_output()));

        let check = DependenciesCheck::with_executor(Box::new(mock));
        let diagnostics = check.run();

        assert_eq!(diagnostics[1].severity, Severity::Warning);
        assert!(diagnostics[1].message.contains("Unused dependencies found"));
    }

    #[test]
    fn test_outdated_command_error() {
        let mut mock = MockCommandExecutor::new();
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-outdated"))
            .return_const(true);
        mock.expect_execute_outdated()
            .return_once(|| Err(std::io::Error::other("command failed")));
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-udeps"))
            .return_const(true);
        mock.expect_execute_udeps()
            .return_once(|| Ok(success_output()));

        let check = DependenciesCheck::with_executor(Box::new(mock));
        let diagnostics = check.run();

        assert_eq!(diagnostics[0].severity, Severity::Suggestion);
        assert!(diagnostics[0]
            .message
            .contains("Could not check for outdated dependencies"));
    }

    #[test]
    fn test_udeps_command_error() {
        let mut mock = MockCommandExecutor::new();
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-outdated"))
            .return_const(true);
        mock.expect_execute_outdated()
            .return_once(|| Ok(success_output()));
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-udeps"))
            .return_const(true);
        mock.expect_execute_udeps()
            .return_once(|| Err(std::io::Error::other("command failed")));

        let check = DependenciesCheck::with_executor(Box::new(mock));
        let diagnostics = check.run();

        assert_eq!(diagnostics[1].severity, Severity::Suggestion);
        assert!(diagnostics[1]
            .message
            .contains("Could not check for unused dependencies"));
    }

    #[test]
    fn test_run_returns_diagnostics() {
        let mut mock = MockCommandExecutor::new();
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-outdated"))
            .return_const(true);
        mock.expect_execute_outdated()
            .return_once(|| Ok(success_output()));
        mock.expect_is_command_available()
            .with(mockall::predicate::eq("cargo-udeps"))
            .return_const(true);
        mock.expect_execute_udeps()
            .return_once(|| Ok(success_output()));

        let check = DependenciesCheck::with_executor(Box::new(mock));
        let diagnostics = check.run();
        assert_eq!(diagnostics.len(), 3);
    }
}