mantra 0.2.14

Tool to trace requirements down to implementation and tests.
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

//! Contains functionality for the `status` command.
//!
//! [req:status]

use std::path::PathBuf;

use clap::Args;

use crate::wiki::{Wiki, WikiError};

mod branch;
mod cmp;

/// Parameters for the `status` command.
///
/// [req:status]
#[derive(Args, Debug, Clone)]
pub struct StatusParameter {
    /// The folder that is searched recursively for defined requirements.
    ///
    /// [req:wiki]
    #[arg(index = 1, required = true)]
    pub req_folder: PathBuf,

    /// The branch name to create the overview for.
    /// Is used as first branch for comparisons.
    ///
    /// [req:status.branch], [req:status.cmp]
    #[arg(long, alias = "branch-name", required = false, default_value = "main")]
    pub branch: String,

    /// Optional repository name for the `branch` option in case multiple repositories point to the same wiki.
    ///
    /// [req:wiki.ref_list.repo]
    #[arg(long, alias = "repo")]
    pub repo_name: Option<String>,

    /// An optional branch to compare against the branch set with `--branch`.
    ///
    /// [req:status.cmp]
    #[arg(long)]
    pub cmp_branch: Option<String>,

    /// Optional repository name for the `cmp-branch` option in case multiple repositories point to the same wiki.
    ///
    /// [req:wiki.ref_list.repo]
    #[arg(long, alias = "cmp-repo")]
    pub cmp_repo_name: Option<String>,

    /// Flag to output detailed information about *ready* requirements.
    ///
    /// [req:status.branch]
    #[arg(long)]
    pub detail_ready: bool,

    /// Flag to output detailed information about *active* requirements.
    ///
    /// [req:status.branch]
    #[arg(long)]
    pub detail_active: bool,

    /// Flag to output detailed information about *deprecated* requirements.
    ///
    /// [req:status.branch]
    #[arg(long)]
    pub detail_deprecated: bool,

    /// Flag to output detailed information about requirements flagged
    /// to require *manual* verification.
    ///
    /// [req:status.branch]
    #[arg(long)]
    pub detail_manual: bool,
}

/// Command to output an overview for the wiki.
///
/// [req:status]
pub fn status(param: &StatusParameter) -> Result<(), StatusError> {
    let wiki = Wiki::try_from(&param.req_folder)?;

    let overview = match &param.cmp_branch {
        Some(branch_b) => self::cmp::status_cmp(
            &wiki,
            param.repo_name.as_deref(),
            &param.branch,
            param.cmp_repo_name.as_deref(),
            branch_b,
        ),
        None => self::branch::status_branch(&wiki, param),
    };

    println!("{overview}");

    Ok(())
}

/// Possible errors that may occure while creating a status overview.
#[derive(Debug, thiserror::Error, logid::ErrLogId)]
pub enum StatusError {
    #[error("Failed to parse the wiki.")]
    WikiSetup,
}

impl From<WikiError> for StatusError {
    fn from(_value: WikiError) -> Self {
        StatusError::WikiSetup
    }
}