mantra 0.6.2

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

use cfg::CollectConfig;
use cmd::{
    coverage::CoverageError, report::ReportError, requirements::RequirementsError,
    review::ReviewError, trace::TraceError,
};
use db::DbError;

pub mod cfg;
pub mod cmd;
pub mod db;

#[derive(Debug, thiserror::Error)]
pub enum MantraError {
    #[error("Failed to setup the database for mantra. Cause: {}", .0)]
    DbSetup(DbError),
    #[error("Failed to update trace data. Cause: {}", .0)]
    Trace(TraceError),
    #[error("Failed to extract requirements. Cause: {}", .0)]
    Extract(RequirementsError),
    #[error("Failed to add a new project. Cause: {}", .0)]
    AddProject(DbError),
    #[error("Failed to update coverage data. Cause: {}", .0)]
    Coverage(CoverageError),
    #[error("Failed to deprecate requirements. Cause: {}", .0)]
    DeprecateReq(DbError),
    #[error("Failed to add manual requirements. Cause: {}", .0)]
    AddManualReq(DbError),
    #[error("Failed to delete database entries. Cause: {}", .0)]
    Delete(DbError),
    #[error("Failed to add reviews. Cause: {}", .0)]
    Review(ReviewError),
    #[error("Failed to create the report. Cause: {}", .0)]
    Report(ReportError),
    #[error("Failed to collect mantra data. Cause: {}", .0)]
    Collect(String),
    #[error("Failed to clean the database. Cause: {}", .0)]
    Clean(DbError),
}

pub async fn run(cfg: cfg::Config) -> Result<(), MantraError> {
    let db = db::MantraDb::new(&cfg.db)
        .await
        .map_err(MantraError::DbSetup)?;

    match cfg.cmd {
        cmd::Cmd::Trace(trace_kind) => {
            let changes = cmd::trace::collect(&db, trace_kind)
                .await
                .map_err(MantraError::Trace)?;

            println!("{changes}");

            Ok(())
        }
        cmd::Cmd::Requirements(extract_cfg) => {
            let changes = cmd::requirements::collect(&db, &extract_cfg)
                .await
                .map_err(MantraError::Extract)?;

            println!("{changes}");

            Ok(())
        }
        cmd::Cmd::Coverage(coverage_cfg) => {
            for file in coverage_cfg.data {
                let changes = cmd::coverage::collect_from_path(&db, &file)
                    .await
                    .map_err(MantraError::Coverage)?;

                println!("----- {} -----", file.display());
                println!("{changes}");
            }

            Ok(())
        }
        cmd::Cmd::DeleteOld(delete_old_cfg) => db
            .delete_old_generations(delete_old_cfg.clean)
            .await
            .map_err(MantraError::Delete),
        cmd::Cmd::DeleteReqs(delete_req_cfg) => db
            .delete_reqs(&delete_req_cfg)
            .await
            .map_err(MantraError::Delete),
        cmd::Cmd::DeleteTraces(delete_traces_cfg) => db
            .delete_traces(&delete_traces_cfg)
            .await
            .map_err(MantraError::Delete),
        cmd::Cmd::DeleteTestRuns(delete_test_runs_cfg) => db
            .delete_test_runs(delete_test_runs_cfg)
            .await
            .map_err(MantraError::Delete),
        cmd::Cmd::DeleteReviews(delete_reviews_cfg) => db
            .delete_reviews(delete_reviews_cfg)
            .await
            .map_err(MantraError::Delete),
        cmd::Cmd::Report(report_cfg) => cmd::report::report(&db, report_cfg)
            .await
            .map_err(MantraError::Report),
        cmd::Cmd::Review(review_cfg) => {
            let added_review_cnt = cmd::review::collect(&db, review_cfg)
                .await
                .map_err(MantraError::Review)?;

            if added_review_cnt == 0 {
                println!("No review was added.");
            } else {
                println!("Added '{}' reviews.", added_review_cnt);
            }

            Ok(())
        }
        cmd::Cmd::Collect(collect_cfg) => collect(&db, collect_cfg).await,
        cmd::Cmd::Clean => db.clean().await.map_err(MantraError::Clean),
    }
}

async fn collect(db: &db::MantraDb, cfg: CollectConfig) -> Result<(), MantraError> {
    let collect_cfg = tokio::fs::read_to_string(&cfg.filepath)
        .await
        .map_err(|_| {
            MantraError::Collect(format!("Could not read file '{}'.", cfg.filepath.display()))
        })?;
    let collect_file: cfg::CollectFile = toml::from_str(&collect_cfg).map_err(|err| {
        MantraError::Collect(format!(
            "Could not read the TOML configuration. Cause: {}",
            err
        ))
    })?;

    let req_changes = cmd::requirements::collect(db, &collect_file.requirements)
        .await
        .map_err(MantraError::Extract)?;
    println!("{req_changes}");

    let trace_changes = cmd::trace::collect(db, collect_file.traces)
        .await
        .map_err(MantraError::Trace)?;
    println!("{trace_changes}");

    if let Some(coverage) = collect_file.coverage {
        for file in coverage.data {
            let coverage_changes = cmd::coverage::collect_from_path(db, &file)
                .await
                .map_err(MantraError::Coverage)?;

            println!("{coverage_changes}");
        }
    }

    if let Some(review) = collect_file.reviews {
        let added_review_cnt = cmd::review::collect(db, review)
            .await
            .map_err(MantraError::Review)?;

        if added_review_cnt == 0 {
            println!("No review was added.");
        } else {
            println!("Added '{}' reviews.", added_review_cnt);
        }
    }

    Ok(())
}