xbp-analysis 10.57.0

Language-agnostic static analysis (error-handling / Aspirator-style) for XBP
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

use super::{base_caps, concepts_of, finding_from_concept};
use crate::domain::concepts::ConceptKind;
use crate::domain::model::LanguageModel;
use crate::domain::rule::{Rule, RuleMeta};
use crate::domain::types::{Confidence, Finding, Severity};
use std::sync::OnceLock;

#[derive(Default)]
pub struct LoggingOnlyHandlerRule;

impl Rule for LoggingOnlyHandlerRule {
    fn meta(&self) -> &RuleMeta {
        static META: OnceLock<RuleMeta> = OnceLock::new();
        META.get_or_init(|| RuleMeta {
            id: "logging-only-handler".into(),
            name: "Logging-only handler".into(),
            description: "Error is logged then converted to success / ignored.".into(),
            default_severity: Severity::Medium,
            required_capabilities: base_caps(),
            autofix_safe: false,
        })
    }

    fn evaluate(&self, model: &LanguageModel) -> Vec<Finding> {
        concepts_of(model, ConceptKind::LoggingOnly)
            .chain(concepts_of(model, ConceptKind::ErrorHandler).filter(|(_, c)| c.logs_only))
            .map(|(lang, c)| {
                finding_from_concept(
                    &self.meta().id,
                    lang,
                    c,
                    Severity::Medium,
                    Confidence::Medium,
                    "Error is logged but not propagated or recovered from.",
                    "Operators see logs while the system continues in a bad state.",
                    "Propagate the error or enter a defined degraded mode after logging.",
                )
            })
            .collect()
    }
}