fallow-engine 3.36.0

Typed analysis engine facade for fallow consumers
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

//! Coverage lookup for private class members (`#name`).

use super::tests::{istanbul_crap_default, make_fn_complexity, write_single_file_istanbul_fixture};
use super::*;

/// istanbul-lib-instrument emits no `fnMap` identity for a private class
/// member, so any candidate that a fallback reaches belongs to an
/// enclosing function.
#[test]
fn private_class_member_never_takes_enclosing_coverage() {
    let temp = tempfile::TempDir::new().unwrap();
    let source_path = temp.path().join("src/vault.js");
    std::fs::create_dir_all(source_path.parent().unwrap()).unwrap();
    std::fs::write(&source_path, "// geometry fixture\n").unwrap();

    let coverage_path = temp.path().join("coverage-final.json");
    write_single_file_istanbul_fixture(
        &coverage_path,
        &source_path,
        &serde_json::json!({
            "0": {
                "name": "(anonymous_0)",
                "line": 7,
                "decl": { "start": { "line": 1, "column": 24 }, "end": { "line": 1, "column": 25 } },
                "loc": { "start": { "line": 7, "column": 5 }, "end": { "line": 7, "column": 20 } }
            }
        }),
        &serde_json::json!({ "0": 1 }),
    );

    let coverage = load_istanbul_coverage(&coverage_path, None, None, false).unwrap();
    let canonical_source = dunce::canonicalize(&source_path).unwrap();
    let file_coverage = coverage.get(&canonical_source).unwrap();

    // `#wipe` sits in the arrow's header span and the arrow ran, but the
    // private member has no record of its own and never ran.
    let mut private_member = make_fn_complexity(1);
    private_member.name = "#wipe".to_string();
    private_member.is_private_member = true;
    private_member.line = 3;
    private_member.col = 9;
    let result = istanbul_crap_default(&[private_member], Some(file_coverage), false);
    assert_eq!(result.matched, 0);
    assert_eq!(
        result.per_function[0].coverage_source,
        fallow_output::CoverageSource::Estimated
    );
    assert_eq!(file_coverage.lookup("<arrow>", 1, 24), Some(100.0));
}

#[test]
fn quoted_hash_method_keeps_exact_istanbul_coverage() {
    let temp = tempfile::TempDir::new().unwrap();
    let source_path = temp.path().join("src/vault.js");
    std::fs::create_dir_all(source_path.parent().unwrap()).unwrap();
    std::fs::write(&source_path, "class Vault { '#wipe'() {} }\n").unwrap();

    let coverage_path = temp.path().join("coverage-final.json");
    write_single_file_istanbul_fixture(
        &coverage_path,
        &source_path,
        &serde_json::json!({
            "0": {
                "name": "#wipe",
                "line": 1,
                "decl": { "start": { "line": 1, "column": 14 }, "end": { "line": 1, "column": 21 } },
                "loc": { "start": { "line": 1, "column": 24 }, "end": { "line": 1, "column": 26 } }
            }
        }),
        &serde_json::json!({ "0": 1 }),
    );

    let coverage = load_istanbul_coverage(&coverage_path, None, None, false).unwrap();
    let canonical_source = dunce::canonicalize(&source_path).unwrap();
    let file_coverage = coverage.get(&canonical_source).unwrap();

    let mut quoted_public_method = make_fn_complexity(1);
    quoted_public_method.name = "#wipe".to_string();
    quoted_public_method.line = 1;
    quoted_public_method.col = 14;
    let result = istanbul_crap_default(&[quoted_public_method], Some(file_coverage), false);
    assert_eq!(result.matched, 1);
    assert_eq!(
        result.per_function[0].coverage_source,
        fallow_output::CoverageSource::Istanbul
    );
    assert_eq!(result.per_function[0].coverage_pct, Some(100.0));
}

/// A private member takes the one record named with its own `#name`, as
/// the V8 converter writes it: `decl` at the key, `loc` at the body, and
/// the extracted position at the parameter list in between (#3816). An
/// uncalled member gets its own zero. Two `#name` records near a member
/// (a private getter and setter) give no coverage.
#[test]
fn private_class_member_takes_its_own_named_record() {
    let temp = tempfile::TempDir::new().unwrap();
    let source_path = temp.path().join("src/vault.js");
    std::fs::create_dir_all(source_path.parent().unwrap()).unwrap();
    std::fs::write(&source_path, "// geometry fixture\n").unwrap();

    let coverage_path = temp.path().join("coverage-final.json");
    write_single_file_istanbul_fixture(
        &coverage_path,
        &source_path,
        &serde_json::json!({
            "0": {
                "name": "#wipe",
                "line": 2,
                "decl": { "start": { "line": 2, "column": 2 }, "end": { "line": 2, "column": 7 } },
                "loc": { "start": { "line": 2, "column": 14 }, "end": { "line": 2, "column": 16 } }
            },
            "1": {
                "name": "#gone",
                "line": 3,
                "decl": { "start": { "line": 3, "column": 2 }, "end": { "line": 3, "column": 7 } },
                "loc": { "start": { "line": 3, "column": 14 }, "end": { "line": 3, "column": 16 } }
            },
            "2": {
                "name": "get #seal",
                "line": 10,
                "decl": { "start": { "line": 10, "column": 6 }, "end": { "line": 10, "column": 11 } },
                "loc": { "start": { "line": 10, "column": 14 }, "end": { "line": 10, "column": 16 } }
            },
            "3": {
                "name": "set #seal",
                "line": 11,
                "decl": { "start": { "line": 11, "column": 6 }, "end": { "line": 11, "column": 11 } },
                "loc": { "start": { "line": 11, "column": 15 }, "end": { "line": 11, "column": 17 } }
            }
        }),
        &serde_json::json!({ "0": 1, "1": 0, "2": 1, "3": 1 }),
    );

    let coverage = load_istanbul_coverage(&coverage_path, None, None, false).unwrap();
    let canonical_source = dunce::canonicalize(&source_path).unwrap();
    let file_coverage = coverage.get(&canonical_source).unwrap();

    let private_member = |name: &str, line: u32, col: u32| {
        let mut function = make_fn_complexity(1);
        function.name = name.to_string();
        function.is_private_member = true;
        function.line = line;
        function.col = col;
        function
    };
    let functions = [
        private_member("#wipe", 2, 7),
        private_member("#gone", 3, 7),
        private_member("#seal", 10, 11),
    ];

    let result = istanbul_crap_default(&functions, Some(file_coverage), false);
    assert_eq!(result.matched, 2);
    assert_eq!(
        result.per_function[0].coverage_source,
        fallow_output::CoverageSource::Istanbul
    );
    assert_eq!(result.per_function[0].coverage_pct, Some(100.0));
    assert_eq!(
        result.per_function[1].coverage_source,
        fallow_output::CoverageSource::Istanbul
    );
    assert_eq!(result.per_function[1].coverage_pct, Some(0.0));
    assert_eq!(
        result.per_function[2].coverage_source,
        fallow_output::CoverageSource::Estimated
    );
}