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
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

use specman::{
    FilesystemStructureIndexer, FilesystemWorkspaceLocator, StructureQuery, WorkspacePaths,
};
use std::fs;
use tempfile::tempdir;

fn make_workspace() -> WorkspacePaths {
    let temp = tempdir().unwrap();
    let root = temp.path().join("workspace");
    fs::create_dir_all(root.join(".specman").join("scratchpad")).unwrap();
    fs::create_dir_all(root.join("spec")).unwrap();
    fs::create_dir_all(root.join("impl")).unwrap();

    let root = root.canonicalize().unwrap();
    let dot = root.join(".specman");
    std::mem::forget(temp);
    WorkspacePaths::new(root, dot)
}

#[test]
fn render_constraint_group_includes_inline_refs() {
    // [ENSURES: concept-specifications.concepts-and-entities.structure:TEST]
    // [ENSURES: concept-concept-entity-headings.structure:TEST]
    let workspace = make_workspace();
    fs::create_dir_all(workspace.spec_dir().join("render_refs")).unwrap();
    fs::write(
        workspace.spec_dir().join("render_refs").join("spec.md"),
        r#"---
name: render_refs
version: '1.0.0'
---
# Concept: A
Context for A.
!constraints.a:
- Must do X (see [Concept: B](#concept-b)).

# Concept: B
Details of B.
"#,
    )
    .unwrap();

    let indexer = FilesystemStructureIndexer::new(FilesystemWorkspaceLocator::new(
        workspace.dot_specman().to_path_buf(),
    ));
    let index = indexer.build_once_with_workspace(&workspace).unwrap();

    let group_id = index
        .list_constraint_groups()
        .into_iter()
        .find(|id| id.group == "constraints.a")
        .expect("constraints.a not found");

    let rendered = index.render_constraint_group(&group_id).unwrap();

    assert!(
        rendered.contains("# Concept: A"),
        "Should contain parent heading A\n{rendered}"
    );
    assert!(
        rendered.contains("Context for A"),
        "Should contain parent content\n{rendered}"
    );
    assert!(
        rendered.contains("# Concept: B"),
        "Should contain referenced heading B\n{rendered}"
    );
    assert!(
        rendered.contains("Details of B"),
        "Should contain referenced content B\n{rendered}"
    );
}

#[test]
fn render_constraint_group_is_transitive() {
    // [ENSURES: concept-constraints.identifiers.generation:TEST]
    let workspace = make_workspace();
    fs::create_dir_all(workspace.spec_dir().join("transitive")).unwrap();
    fs::write(
        workspace.spec_dir().join("transitive").join("spec.md"),
        r#"---
name: transitive
version: '1.0.0'
---
# Root
!c.root:
- Link to [Child](#child).

# Child
Link to [Grandchild](#grandchild).

# Grandchild
Deep content.
"#,
    )
    .unwrap();

    let indexer = FilesystemStructureIndexer::new(FilesystemWorkspaceLocator::new(
        workspace.dot_specman().to_path_buf(),
    ));
    let index = indexer.build_once_with_workspace(&workspace).unwrap();

    let group_id = index
        .list_constraint_groups()
        .into_iter()
        .find(|id| id.group == "c.root")
        .unwrap();

    let rendered = index.render_constraint_group(&group_id).unwrap();

    assert!(rendered.contains("# Root"), "{rendered}");
    assert!(rendered.contains("# Child"), "{rendered}");
    assert!(
        rendered.contains("# Grandchild"),
        "Should contain recursive reference Grandchild\n{rendered}"
    );
}