rustqual 1.0.0

Comprehensive Rust code quality analyzer — seven dimensions: IOSP, Complexity, DRY, SRP, Coupling, Test Quality, Architecture
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

//! Contract tests for the `SuppressionParser` port.

use crate::domain::{Dimension, SourceUnit, Suppression};
use crate::ports::{SuppressionParseError, SuppressionParser};
use std::path::PathBuf;

struct FakeParser {
    returns: Vec<Suppression>,
}

impl SuppressionParser for FakeParser {
    fn parse(&self, _unit: &SourceUnit) -> Result<Vec<Suppression>, SuppressionParseError> {
        Ok(self.returns.clone())
    }
}

#[test]
fn port_is_object_safe() {
    let _boxed: Box<dyn SuppressionParser> = Box::new(FakeParser { returns: vec![] });
}

#[test]
fn port_requires_send_and_sync() {
    let _: Box<dyn Send + Sync> = Box::new(FakeParser { returns: vec![] });
}

#[test]
fn fake_parser_returns_injected_suppressions() {
    const FIXTURE_LINE: usize = 10;
    let sup = Suppression {
        line: FIXTURE_LINE,
        dimensions: vec![Dimension::Architecture],
        reason: Some("migration".into()),
    };
    let parser = FakeParser {
        returns: vec![sup.clone()],
    };
    let unit = SourceUnit::new(PathBuf::from("x.rs"), "".into());
    let parsed = parser.parse(&unit).unwrap();
    assert_eq!(parsed, vec![sup]);
}

// qual:allow(test_quality) reason: "contract test verifying Display on Error variants does not call a SUT method by design"
#[test]
fn parse_error_variants_carry_diagnostic_information() {
    let e = SuppressionParseError::Malformed {
        file: "x.rs".into(),
        line: 5,
        message: "bad syntax".into(),
    };
    let s = e.to_string();
    assert!(s.contains("x.rs"));
    assert!(s.contains("5"));
    assert!(s.contains("bad syntax"));

    let e = SuppressionParseError::UnknownDimension {
        file: "y.rs".into(),
        line: 12,
        dimension: "quality".into(),
    };
    let s = e.to_string();
    assert!(s.contains("y.rs"));
    assert!(s.contains("quality"));
}