mantra-schema 0.8.0

Schemas for *mantra*.
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

use relative_path::RelativePathBuf;

use crate::{
    FmtHash, Line, LineSpan, Properties,
    annotations::{CoverageExclude, ElementKind, TraceKind, TraceRelatedCodeVariant},
    product::ProductId,
    report::{Aggregated, requirement::RequirementReference},
    requirements::ReqId,
};

#[derive(
    Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize, schemars::JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub struct TraceReference {
    #[schemars(with = "String")]
    pub filepath: RelativePathBuf,
    pub file_hash: FmtHash,
    pub line: Line,
    pub kind: TraceKind,
}

#[derive(
    Debug,
    Clone,
    Copy,
    Default,
    PartialEq,
    serde::Serialize,
    serde::Deserialize,
    schemars::JsonSchema,
)]
pub struct TracesSummary {
    pub total: i64,
    pub satisfies: Aggregated,
    pub verifies: Aggregated,
    pub clarifies: Aggregated,
    pub links: Aggregated,
}

impl TracesSummary {
    pub fn add(&mut self, other: &Self) {
        self.total += other.total;

        self.satisfies.cnt += other.satisfies.cnt;
        self.verifies.cnt += other.verifies.cnt;
        self.clarifies.cnt += other.clarifies.cnt;
        self.links.cnt += other.links.cnt;

        self.update_percentages();
    }

    pub fn update_percentages(&mut self) {
        self.satisfies.update_percentage(self.total);
        self.verifies.update_percentage(self.total);
        self.clarifies.update_percentage(self.total);
        self.links.update_percentage(self.total);
    }
}

#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
#[serde(rename_all = "snake_case")]
pub struct ResolvedAnnotations {
    pub traces: Option<Vec<ResolvedTrace>>,
    pub elements: Option<Vec<ResolvedElement>>,
    pub coverage_excludes: Option<Vec<CoverageExclude>>,
}

#[derive(
    Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize, schemars::JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub struct ResolvedTrace {
    /// The requirement IDs that are referenced by the trace.
    /// [req("trace.id", "trace.mult_reqs")]
    pub resolved_ids: Vec<RequirementReference>,
    pub unknown_ids: Vec<ReqId>,
    /// The line the trace is defined at.
    /// [req("trace.origin")]
    pub line: Line,
    /// Optional related code block or element that is linked to the trace.
    /// [req("trace.code_block", "trace.element")]
    pub related_code: Option<TraceRelatedCodeVariant>,
    /// Trace kind.
    /// [req("trace.kind`")]
    pub kind: TraceKind,
    /// List of custom properties that may be set on a trace.
    /// [req("trace.properties")]
    pub properties: Option<Properties>,
}

#[derive(
    Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize, schemars::JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub struct ResolvedElement {
    /// The fully qualified identifier of the element.
    /// [req("trace.element.ident")]
    pub idents: Option<Vec<ResolvedElementIdent>>,
    /// The element name.
    ///
    /// **Note:** This is not the fully qualified identifier.
    pub name: String,
    /// The line the element is defined at.
    ///
    /// **Note:** This might differ from `span.start`,
    /// because in Rust for example, attributes & doc-comments are part of the span,
    /// but the definition of an element starts below them.
    ///
    /// TODO: trace req
    pub definition_line: Line,
    /// The line span of the element.
    /// [req("trace.element.span")]
    pub span: LineSpan,
    /// The kind of the element.
    /// [req("trace.element.kind")]
    pub kind: ElementKind,
}

#[derive(
    Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize, schemars::JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub struct ResolvedElementIdent {
    pub ident: String,
    pub product_ids: Vec<ProductId>,
}