only-semantic 0.4.0

Semantic analysis for the only task language.
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220

use only_semantic::{GuardKind, compile_document};

#[test]
fn lowers_directives_with_crlf_line_endings() {
    let compiled = compile_document("!shell bash\r\nbuild():\r\n    echo ok\r\n");

    assert!(compiled.diagnostics.is_empty());
    assert!(matches!(
        compiled.document.directives[0],
        only_semantic::DirectiveAst::Shell { .. }
    ));
}

#[test]
fn lowers_task_header_and_commands_into_ast() {
    let compiled = compile_document("build(tag=\"v1\"):\n    echo {{tag}}\n");
    let task = &compiled.document.tasks[0];

    assert_eq!(task.name, "build");
    assert_eq!(task.params[0].name, "tag");
    assert!(!task.params[0].is_slice);
    assert_eq!(task.params[0].default_value.as_deref(), Some("v1"));
    assert_eq!(task.steps.len(), 1);
    assert_eq!(task.steps[0].source(), "echo {{tag}}");
    assert_eq!(task.steps[0].interpolations()[0].name, "tag");
}

#[test]
fn lowers_dependency_arguments() {
    let compiled = compile_document(concat!(
        "build(profile):\n    true\n",
        "ci() & build(\"dev\"):\n    true\n",
    ));
    let dependency = &compiled.document.tasks[1].dependencies[0];

    assert_eq!(dependency.name, "build");
    assert_eq!(dependency.arguments.len(), 1);
    assert_eq!(dependency.arguments[0].value, "dev");
}

#[test]
fn lowers_slice_parameter_suffix() {
    let compiled = compile_document("run(args..):\n    echo {{args}}\n");
    let task = &compiled.document.tasks[0];

    assert_eq!(task.params[0].name, "args");
    assert!(task.params[0].is_slice);
    assert_eq!(task.params[0].default_value, None);
    assert_eq!(task.signature(), "run(args..)");
}

#[test]
fn skips_escaped_interpolation_markers() {
    let compiled = compile_document("build(tag=\"v1\"):\n    echo \\{{tag\\}} {{tag}}\n");
    let task = &compiled.document.tasks[0];

    assert_eq!(task.steps.len(), 1);
    assert_eq!(task.steps[0].interpolations().len(), 1);
    assert_eq!(task.steps[0].interpolations()[0].name, "tag");
}

#[test]
fn keeps_even_backslashes_before_real_interpolation() {
    let compiled = compile_document("build(tag=\"v1\"):\n    echo \\\\{{tag}}\n");
    let task = &compiled.document.tasks[0];

    assert_eq!(task.steps.len(), 1);
    assert_eq!(task.steps[0].interpolations().len(), 1);
    assert_eq!(task.steps[0].interpolations()[0].name, "tag");
}

#[test]
fn lowers_command_block_with_ranges_and_interpolation() {
    let source = "!version 0.2\ngreet(name):\n    | if [ -n \"{{name}}\" ]; then\n    |     echo \"{{name}}\"\n    | fi\n";
    let compiled = compile_document(source);
    let task = &compiled.document.tasks[0];

    assert!(compiled.diagnostics.is_empty());
    assert_eq!(task.steps.len(), 1);
    let only_semantic::TaskStepAst::CommandBlock(block) = &task.steps[0] else {
        panic!("step should be a command block");
    };
    assert_eq!(block.line_ranges.len(), 3);
    assert_eq!(block.interpolations.len(), 2);
    assert_eq!(block.interpolations[0].name, "name");
    assert_eq!(
        &source[usize::from(block.range.start())..usize::from(block.range.end())],
        "    | if [ -n \"{{name}}\" ]; then\n    |     echo \"{{name}}\"\n    | fi\n"
    );
}

#[test]
fn command_blocks_require_version_0_2() {
    for source in [
        "task():\n    | echo ok\n",
        "!version 0.1\ntask():\n    | echo ok\n",
    ] {
        let compiled = compile_document(source);
        assert!(
            compiled
                .diagnostics
                .iter()
                .any(|diagnostic| { diagnostic.code.as_str() == "semantic.command-block-version" })
        );
    }
}

#[test]
fn lowers_multiple_guards_in_order() {
    let compiled =
        compile_document("!version 0.3\ntest() ? @has(\"cargo\") ? @env(\"CI\"):\n    true\n");
    let guards = &compiled.document.tasks[0].guards;

    assert_eq!(guards.len(), 2);
    assert_eq!(guards[0].kind, GuardKind::Has);
    assert_eq!(guards[1].kind, GuardKind::Env);
    assert!(guards[0].range.start() < guards[1].range.start());
}

#[test]
fn lowers_multiline_parameter_list() {
    let compiled = compile_document(
        "!version 0.3\ndeploy(\n    env = \"production\",\n    region = \"global,primary\",\n):\n    true\n",
    );
    let params = &compiled.document.tasks[0].params;

    assert!(
        compiled.diagnostics.is_empty(),
        "{:?}",
        compiled.diagnostics
    );
    assert_eq!(params.len(), 2);
    assert_eq!(params[0].default_value.as_deref(), Some("production"));
    assert_eq!(params[1].default_value.as_deref(), Some("global,primary"));
}

#[test]
fn normalizes_help_fields_and_keeps_block_comments_in_commands() {
    let compiled = compile_document(
        "!version 0.4\n!var dist_dir = \"dist\"\n[help] Deploy artifacts\n[desc] Write to {{dist_dir}}\n[pass] Deploy complete\n[fail] Deploy failed\ndeploy():\n    | # shell comment\n    | echo {{dist_dir}}\n",
    );
    let task = &compiled.document.tasks[0];

    assert!(
        compiled.diagnostics.is_empty(),
        "{:?}",
        compiled.diagnostics
    );
    assert_eq!(task.doc.as_deref(), Some("Deploy artifacts"));
    assert_eq!(task.metadata.desc.as_deref(), Some("Write to {{dist_dir}}"));
    assert_eq!(task.metadata.pass.as_deref(), Some("Deploy complete"));
    assert_eq!(task.metadata.fail.as_deref(), Some("Deploy failed"));
    assert!(task.steps[0].source().contains("# shell comment"));
}

#[test]
fn inherits_variant_metadata() {
    let compiled = compile_document(
        "!version 0.4\n[help] Run tests\n[desc] Use the preferred runner.\n[desc] Keep output ordered.\n[pass] Tests passed.\n[pass] Reports are ready.\n[fail] Tests failed.\ntest() ? @os(\"not-a-real-os\"):\n    true\n\n[desc] Use Cargo.\n[desc] Run every target.\n[pass] Cargo tests passed.\ntest() ? @arch(\"not-a-real-arch\"):\n    true\n\n[fail] Fallback failed.\ntest():\n    true\n",
    );
    let cargo_variant = &compiled.document.tasks[1];
    let fallback = &compiled.document.tasks[2];

    assert!(
        compiled.diagnostics.is_empty(),
        "{:?}",
        compiled.diagnostics
    );
    assert_eq!(cargo_variant.metadata.help.as_deref(), Some("Run tests"));
    assert_eq!(
        cargo_variant.metadata.desc.as_deref(),
        Some("Use Cargo.\nRun every target.")
    );
    assert_eq!(
        cargo_variant.metadata.pass.as_deref(),
        Some("Cargo tests passed.")
    );
    assert_eq!(
        cargo_variant.metadata.fail.as_deref(),
        Some("Tests failed.")
    );

    assert_eq!(fallback.metadata.help.as_deref(), Some("Run tests"));
    assert_eq!(fallback.doc.as_deref(), Some("Run tests"));
    assert_eq!(
        fallback.metadata.desc.as_deref(),
        Some("Use the preferred runner.\nKeep output ordered.")
    );
    assert_eq!(
        fallback.metadata.pass.as_deref(),
        Some("Tests passed.\nReports are ready.")
    );
    assert_eq!(fallback.metadata.fail.as_deref(), Some("Fallback failed."));
}

#[test]
fn plain_comments_are_not_task_help() {
    let compiled =
        compile_document("# Run checks.\n# Use the local toolchain.\ncheck():\n    true\n");
    let task = &compiled.document.tasks[0];

    assert_eq!(task.doc, None);
    assert_eq!(task.metadata.help, None);
}

#[test]
fn rejects_unknown_metadata_fields() {
    let compiled = compile_document("[summary] Build everything\nbuild():\n    true\n");
    let task = &compiled.document.tasks[0];

    assert!(
        compiled
            .diagnostics
            .iter()
            .any(|diagnostic| diagnostic.code.as_str() == "semantic.unknown-metadata-field")
    );
    assert_eq!(task.doc, None);
    assert_eq!(task.metadata.unknown_fields.len(), 1);
    assert_eq!(task.metadata.unknown_fields[0], "summary");
}