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

//! Contains the cli struct, and invocation points to all supported commands.

use clap::{Parser, Subcommand};

use crate::{
    check::CheckParameter, release::ReleaseParameter, status::StatusParameter, sync::SyncParameter,
};

const HELP_TEMPLATE: &str = r#"
{before-help}{name} {version} - {about-with-newline}
Created by: {author-with-newline}
{usage-heading} {usage}

{all-args}{after-help}"#;

#[derive(Parser)]
#[command(help_template = HELP_TEMPLATE, author, version, about, long_about = None)]
pub struct Cli {
    #[command(subcommand)]
    command: Option<Command>,
}

impl Cli {
    pub fn run_cmd(&self) -> Result<(), CmdError> {
        match &self.command {
            Some(cmd) => cmd.run(),
            None => Err(CmdError::MissingCmd),
        }
    }
}

#[derive(Subcommand)]
enum Command {
    /// Synchronizes references between wiki and project.
    ///
    /// [req:sync]
    #[command(name = "sync")]
    Sync {
        /// Parameters for synchronization.
        #[command(flatten)]
        param: SyncParameter,
    },

    /// Checks wiki structure and references in the project.
    ///
    /// [req:check]
    #[command(name = "check")]
    Check {
        /// Parameters for validation of wiki and references.
        #[command(flatten)]
        param: CheckParameter,
    },

    /// Creates status overview of the wiki.
    ///
    /// [req:status]
    #[command(name = "status")]
    Status {
        /// Parameters for the status command.
        #[command(flatten)]
        param: StatusParameter,
    },

    /// Creates a release report.
    ///
    /// [req:release]
    #[command(name = "release")]
    Release {
        /// Parameters for the release command.
        #[command(flatten)]
        param: ReleaseParameter,
    },
}

impl Command {
    fn run(&self) -> Result<(), CmdError> {
        match self {
            Command::Sync { param } => crate::sync::sync(param).map_err(|_| CmdError::SyncError),
            Command::Check { param } => {
                crate::check::check(param).map_err(|_| CmdError::CheckError)
            }
            Command::Status { param } => {
                crate::status::status(param).map_err(|_| CmdError::StatusError)
            }
            Command::Release { param } => {
                crate::release::release(param).map_err(|_| CmdError::ReleaseError)
            }
        }
    }
}

#[derive(Debug, thiserror::Error, logid::ErrLogId)]
pub enum CmdError {
    #[error("Synchronization between wiki and project failed.")]
    SyncError,

    #[error("Validation of wiki and/or references in the project failed.")]
    CheckError,

    #[error("Creating status overview for wiki failed.")]
    StatusError,

    #[error("Failed to create a release report.")]
    ReleaseError,

    #[error("No command was given. Use '-h' or '--help' for help.")]
    MissingCmd,
}