provenance-cli 0.2.1

Command-line interface for Provenance requirements traceability
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

use crate::wiki::model::{CodeScan, ImplementationBinding, VerificationSite};
use provenance_core::coverage::{AnchorState, AnnotationResult, BindingResult};

use super::context::Assembler;

impl Assembler<'_> {
    /// The scan this build read, so a page can say which code it looked at
    /// and a page built without a scan can say that instead.
    pub(super) fn code_scan(&self) -> Option<CodeScan> {
        self.coverage.map(|report| CodeScan {
            commit: report.commit.clone(),
        })
    }

    pub(super) fn implementations(&self, rule_id: &str) -> Vec<ImplementationBinding> {
        let scanned_binding = self.coverage.and_then(|report| {
            report.bindings.iter().find(|binding| {
                binding.rule_id == rule_id
                    && binding.verification.is_none()
                    && binding.anchor_state != AnchorState::Gone
            })
        });
        let scanned_annotation = self.coverage.and_then(|report| {
            report.annotations.iter().find(|annotation| {
                annotation.rule_id == rule_id
                    && annotation.verification.is_none()
                    && annotation.anchor_state != AnchorState::Gone
            })
        });
        let mut implementations = Vec::new();
        if let Some(binding) = scanned_binding {
            implementations.push(ImplementationBinding {
                symbol: binding.item_name.clone(),
                location: self.binding_location(binding),
            });
        } else if let Some(annotation) = scanned_annotation {
            implementations.push(ImplementationBinding {
                symbol: annotation.function_name.clone(),
                location: self.annotation_location(annotation),
            });
        }
        for binding in self
            .state
            .implementation_bindings
            .iter()
            .filter(|binding| !binding.retired && binding.rule_id.as_str() == rule_id)
        {
            let matches_scan = scanned_binding.map_or_else(
                || {
                    scanned_annotation.is_some_and(|scanned| {
                        scanned.file_path == binding.file
                            && scanned.function_name.as_deref() == Some(binding.symbol.as_str())
                    })
                },
                |scanned| {
                    scanned.file_path == binding.file
                        && scanned.item_name.as_deref() == Some(binding.symbol.as_str())
                },
            );
            if !matches_scan {
                implementations.push(ImplementationBinding {
                    symbol: Some(binding.symbol.clone()),
                    location: self.resolver.resolve_at(binding.file.as_str(), None),
                });
            }
        }
        implementations
    }

    pub(super) fn verification_sites(&self, rule_id: &str) -> Vec<VerificationSite> {
        let implementation_file = self
            .coverage
            .into_iter()
            .flat_map(|report| &report.bindings)
            .find(|binding| {
                binding.rule_id == rule_id
                    && binding.verification.is_none()
                    && binding.anchor_state != AnchorState::Gone
            })
            .map(|binding| &binding.file_path)
            .or_else(|| {
                self.coverage.and_then(|report| {
                    report
                        .annotations
                        .iter()
                        .find(|annotation| {
                            annotation.rule_id == rule_id
                                && annotation.verification.is_none()
                                && annotation.anchor_state != AnchorState::Gone
                        })
                        .map(|annotation| &annotation.file_path)
                })
            });
        let mut sites = self
            .coverage
            .into_iter()
            .flat_map(|report| &report.bindings)
            .filter(|binding| binding.rule_id == rule_id)
            .filter(|binding| binding.anchor_state != AnchorState::Gone)
            .filter_map(|binding| {
                binding
                    .verification
                    .as_ref()
                    .map(|method| VerificationSite {
                        method: method.clone(),
                        symbol: binding.item_name.clone(),
                        location: self.binding_location(binding),
                        outside_implementation_module: implementation_file
                            .is_some_and(|file| file != &binding.file_path),
                    })
            })
            .collect::<Vec<_>>();
        sites.extend(
            self.coverage
                .into_iter()
                .flat_map(|report| &report.annotations)
                .filter(|annotation| annotation.rule_id == rule_id)
                .filter(|annotation| annotation.anchor_state != AnchorState::Gone)
                .filter_map(|annotation| {
                    annotation
                        .verification
                        .as_ref()
                        .map(|method| VerificationSite {
                            method: method.clone(),
                            symbol: annotation.function_name.clone(),
                            location: self.annotation_location(annotation),
                            outside_implementation_module: implementation_file
                                .is_some_and(|file| file != &annotation.file_path),
                        })
                }),
        );
        for binding in self
            .state
            .verification_bindings
            .iter()
            .filter(|binding| !binding.retired && binding.rule_id.as_str() == rule_id)
        {
            let typed = VerificationSite {
                method: binding.method.to_string(),
                symbol: binding.symbol.clone(),
                location: self.resolver.resolve_at(binding.file.as_str(), None),
                outside_implementation_module: implementation_file
                    .is_some_and(|file| file != &binding.file),
            };
            if !sites.iter().any(|site| {
                site.method == typed.method
                    && site.symbol == typed.symbol
                    && site.location.label == typed.location.label
            }) {
                sites.push(typed);
            }
        }
        sites
    }

    fn binding_location(&self, binding: &BindingResult) -> crate::wiki::links::EvidenceRef {
        let reference = format!("{}:{}", binding.file_path, binding.line);
        self.resolver.resolve_at(
            &reference,
            self.coverage.and_then(|report| report.commit.as_deref()),
        )
    }

    fn annotation_location(
        &self,
        annotation: &AnnotationResult,
    ) -> crate::wiki::links::EvidenceRef {
        let reference = format!("{}:{}", annotation.file_path, annotation.line);
        self.resolver.resolve_at(
            &reference,
            self.coverage.and_then(|report| report.commit.as_deref()),
        )
    }
}