specman 3.0.0

SpecMan runtime library for dependency mapping, templating, and lifecycle automation.
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

use crate::graph::tree::{ArtifactId, DependencyTree};
use crate::core::env::SpecmanEnv;
use crate::core::error::{LifecycleError, SpecmanError};
use crate::storage::persistence::{ArtifactRemovalStore, RemovedArtifact};

#[derive(Clone, Debug, Default)]
pub struct DeleteOptions {
    pub force: bool,
    pub dry_run: bool,
}

#[derive(Clone, Debug)]
pub enum DeleteResult {
    Removed(RemovedArtifact),
    DryRun(DeletePlan),
}

#[derive(Clone, Debug)]
pub struct DeletePlan {
    pub dependencies: DependencyTree,
    pub blocked: bool,
}

pub fn delete_artifact(
    env: &SpecmanEnv,
    target: &ArtifactId,
    opts: DeleteOptions,
) -> Result<DeleteResult, SpecmanError> {
    // [ENSURES: entity-lifecyclecontroller.requirements:CHECK]
    let dependencies = env.mapping.dependency_tree(target)?;
    let blocked = dependencies.has_blocking_dependents();

    if opts.dry_run {
        return Ok(DeleteResult::DryRun(DeletePlan {
            dependencies,
            blocked,
        }));
    }

    if blocked && !opts.force {
        return Err(LifecycleError::DeletionBlocked { target: target.clone() }.into());
    }

    let removed = env.persistence.remove_artifact(target)?;

    Ok(DeleteResult::Removed(removed))
}