mantra 0.7.2

`mantra` offers a lightweight approach for requirement tracing and coverage.
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

use std::path::PathBuf;

use crate::{cmd::Cmd, db};

#[derive(clap::Parser)]
pub struct Config {
    #[command(flatten)]
    pub db: db::Config,

    #[command(subcommand)]
    pub cmd: Cmd,
}

#[derive(Debug, Clone, clap::Args)]
pub struct MantraConfigPath {
    #[arg(default_value = "mantra.toml")]
    pub filepath: PathBuf,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct MantraConfigFile {
    #[serde(default)]
    pub requirements: Vec<crate::cmd::requirements::Format>,
    #[serde(default)]
    pub traces: Vec<crate::cmd::trace::TraceKind>,
    pub coverage: Option<crate::cmd::coverage::Config>,
    pub review: Option<crate::cmd::review::ReviewConfig>,
    #[serde(default, skip_serializing_if = "crate::cfg::Project::is_none")]
    pub project: Project,
    #[serde(
        alias = "report-template",
        default,
        skip_serializing_if = "crate::cmd::report::ReportTemplate::is_none"
    )]
    pub report_template: crate::cmd::report::ReportTemplate,
}

#[derive(
    Default,
    Debug,
    Clone,
    PartialEq,
    serde::Serialize,
    serde::Deserialize,
    clap::Args,
    schemars::JsonSchema,
)]
pub struct Project {
    #[arg(id = "project-name", long = "project-name")]
    pub name: Option<String>,
    #[arg(id = "project-version", long = "project-version")]
    pub version: Option<String>,
    #[arg(id = "project-repository", long = "project-repository")]
    pub repository: Option<String>,
    #[arg(id = "project-homepage", long = "project-homepage")]
    pub homepage: Option<String>,
}

impl Project {
    pub(crate) fn is_none(&self) -> bool {
        self.name.is_none()
            && self.version.is_none()
            && self.repository.is_none()
            && self.homepage.is_none()
    }
}

#[derive(Debug, Clone, clap::Args)]
pub struct DeleteOldConfig {
    /// Delete test runs and reviews that have no linked requirement or coverage remaining.
    #[arg(long)]
    pub clean: bool,
}

#[derive(Debug, Clone, clap::Args)]
pub struct DeleteReqsConfig {
    #[arg(long)]
    pub ids: Option<Vec<String>>,
    /// Delete requirements before the set generation.
    #[arg(long)]
    pub before: Option<i64>,
}

#[derive(Debug, Clone, clap::Args)]
pub struct DeleteTracesConfig {
    #[arg(long, alias = "id")]
    pub req_ids: Option<Vec<String>>,
    /// Delete traces before the set generation.
    #[arg(long)]
    pub before: Option<i64>,
}

#[derive(Debug, Clone, clap::Args)]
pub struct DeleteTestRunsConfig {
    #[arg(long, alias = "older-than")]
    pub before: Option<String>,
}

#[derive(Debug, Clone, clap::Args)]
pub struct DeleteCoverageConfig {
    #[arg(long, alias = "id")]
    pub req_ids: Option<Vec<String>>,
}

#[derive(Debug, Clone, clap::Args)]
pub struct DeleteReviewsConfig {
    #[arg(long, alias = "older-than")]
    pub before: Option<String>,
}

#[cfg(test)]
mod test {
    use std::path::PathBuf;

    #[test]
    fn collect_file_syntax() {
        let content = r#"
                            [project]
                            name = "test-proj"
                            version = "0.1.0"
                            repository = "some.link"
                            homepage = "some-other.link"

                            [report-template]
                            base = "base-template.html"
                            req-data = "req-template.html"
                            test-run-data = "test-run-template.html"

                            [[requirements]]
                            root = "reqs.md"
                            origin = "cloud-repo.something"

                            [[requirements]]
                            files = ["extern-reqs.json"]

                            [[traces]]
                            root = ""

                            [[traces]]
                            files = ["extern-traces.json"]

                            [coverage]
                            files = ["coverage.json"]

                            [review]
                            files = ["first_review.toml"]
                            "#;

        let file: crate::cfg::MantraConfigFile = toml::from_str(content).unwrap();

        assert_eq!(
            file.coverage.unwrap().files.first().unwrap(),
            &PathBuf::from("coverage.json"),
            "Coverage info not correctly extracted."
        );
    }
}