slicec 0.4.0

The Slice parser and other core components for Slice compilers.
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247

// Copyright (c) ZeroC, Inc.

use std::error::Error;

use clap::error::ErrorKind;
use clap::Parser;
use slicec::slice_options::SliceOptions;

use test_case::test_case;

mod test_helpers;

#[test_case("foo"; "without trailing separator")]
#[test_case("foo,"; "with trailing separator")]
fn plugins_can_have_no_arguments(value: &str) {
    // Arrange
    let input = ["", "--generator", value];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsed_options = result.unwrap();
    assert_eq!(parsed_options.generators.len(), 1);

    let generator_plugin = &parsed_options.generators[0];
    assert_eq!(generator_plugin.path, "foo");
    assert!(generator_plugin.args.is_empty());
}

#[test]
fn equals_sign_has_no_special_meaning_in_plugin_path() {
    // Arrange
    let input = ["", "--generator", "../=plugin/=/pa=th"];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsed_options = result.unwrap();
    assert_eq!(parsed_options.generators.len(), 1);

    let generator_plugin = &parsed_options.generators[0];
    assert_eq!(generator_plugin.path, "../=plugin/=/pa=th");
    assert!(generator_plugin.args.is_empty());
}

#[test]
fn backslash_escapes_special_characters_in_path() {
    // Arrange
    let input = ["", "--generator", "C:\\my\\,folder\\=cool/\\a"];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsed_options = result.unwrap();
    assert_eq!(parsed_options.generators.len(), 1);

    let generator_plugin = &parsed_options.generators[0];
    assert_eq!(generator_plugin.path, "C:\\my,folder=cool/\\a");
    assert!(generator_plugin.args.is_empty());
}

#[test]
fn backslash_escapes_special_characters_in_arguments() {
    // Arrange
    let input = ["", "--generator", "C:\\plugin,my\\=name\\,=my\\=value\\,,"];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsed_options = result.unwrap();
    assert_eq!(parsed_options.generators.len(), 1);

    let generator_plugin = &parsed_options.generators[0];
    assert_eq!(generator_plugin.path, "C:\\plugin");
    assert_eq!(generator_plugin.args.len(), 1);

    assert_eq!(generator_plugin.args[0].0, "my=name,");
    assert_eq!(generator_plugin.args[0].1, "my=value,");
}

#[test]
fn backslash_does_not_escape_normal_characters() {
    // Arrange
    let input = ["", "--generator", "C:\\Users\\Me\\_plugin,na\\me=\\value\\"];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsed_options = result.unwrap();
    assert_eq!(parsed_options.generators.len(), 1);

    let generator_plugin = &parsed_options.generators[0];
    assert_eq!(generator_plugin.path, "C:\\Users\\Me\\_plugin");
    assert_eq!(generator_plugin.args.len(), 1);

    assert_eq!(generator_plugin.args[0].0, "na\\me");
    assert_eq!(generator_plugin.args[0].1, "\\value\\");
}

#[test_case("C:\\my_plugin,arg1=val1"; "without trailing separator")]
#[test_case("C:\\my_plugin,arg1=val1,"; "with trailing separator")]
fn plugins_can_have_a_single_argument(value: &str) {
    // Arrange
    let input = ["", "--generator", value];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsed_options = result.unwrap();
    assert_eq!(parsed_options.generators.len(), 1);

    let generator_plugin = &parsed_options.generators[0];
    assert_eq!(generator_plugin.path, "C:\\my_plugin");
    assert_eq!(generator_plugin.args.len(), 1);

    assert_eq!(generator_plugin.args[0].0, "arg1");
    assert_eq!(generator_plugin.args[0].1, "val1");
}

#[test]
fn plugins_arguments_have_whitespace_trimmed() {
    // Arrange
    let input = ["", "--generator", "/path/to/plugin,	arg1  = val1 	 "];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsed_options = result.unwrap();
    assert_eq!(parsed_options.generators.len(), 1);

    let generator_plugin = &parsed_options.generators[0];
    assert_eq!(generator_plugin.path, "/path/to/plugin");
    assert_eq!(generator_plugin.args.len(), 1);

    assert_eq!(generator_plugin.args[0].0, "arg1");
    assert_eq!(generator_plugin.args[0].1, "val1");
}

#[test_case("../plugin/path,foo,bar"; "without trailing equals")]
#[test_case("../plugin/path,foo=,bar="; "with trailing equals")]
#[test_case("../plugin/path,foo,bar=,"; "with trailing equals and separator")]
fn plugins_arguments_can_omit_a_value(value: &str) {
    // Arrange
    let input = ["", "--generator", value];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsed_options = result.unwrap();
    assert_eq!(parsed_options.generators.len(), 1);

    let generator_plugin = &parsed_options.generators[0];
    assert_eq!(generator_plugin.path, "../plugin/path");
    assert_eq!(generator_plugin.args.len(), 2);

    assert_eq!(generator_plugin.args[0].0, "foo");
    assert_eq!(generator_plugin.args[0].1, "");
    assert_eq!(generator_plugin.args[1].0, "bar");
    assert_eq!(generator_plugin.args[1].1, "");
}

#[test]
fn plugins_can_have_multiple_arguments() {
    // Arrange
    let input = ["", "--generator", "foo,arg1=val1,arg2, arg3 = val3 "];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsed_options = result.unwrap();
    assert_eq!(parsed_options.generators.len(), 1);

    let generator_plugin = &parsed_options.generators[0];
    assert_eq!(generator_plugin.path, "foo");
    assert_eq!(generator_plugin.args.len(), 3);

    assert_eq!(generator_plugin.args[0].0, "arg1");
    assert_eq!(generator_plugin.args[0].1, "val1");
    assert_eq!(generator_plugin.args[1].0, "arg2");
    assert_eq!(generator_plugin.args[1].1, "");
    assert_eq!(generator_plugin.args[2].0, "arg3");
    assert_eq!(generator_plugin.args[2].1, "val3");
}

#[test_case("    "; "without trailing equals")]
#[test_case("   ,"; "with trailing separator")]
#[test_case(","; "only trailing separator")]
fn plugin_path_must_be_present(generator_arg: &str) {
    // Arrange
    let input = ["", "--generator", generator_arg];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsing_error = result.unwrap_err();
    assert_eq!(parsing_error.kind(), ErrorKind::ValueValidation);

    let error_message = parsing_error.source().unwrap().to_string();
    assert_eq!(error_message, "missing plugin path (ex: 'PATH,KEY=VALUE')");
}

#[test_case("foo,="; "trailing equals")]
#[test_case("foo,=val"; "trailing equals with value")]
#[test_case("foo,,"; "trailing separator")]
fn argument_key_must_be_present(generator_arg: &str) {
    // Arrange
    let input = ["", "--generator", generator_arg];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsing_error = result.unwrap_err();
    assert_eq!(parsing_error.kind(), ErrorKind::ValueValidation);

    let error_message = parsing_error.source().unwrap().to_string();
    assert_eq!(error_message, "missing argument key (ex: 'PATH,KEY=VALUE')");
}

#[test]
fn double_equals_is_disallowed() {
    // Arrange
    let input = ["", "--generator", "/paths/are=/=okay,arg1=key=1"];

    // Act
    let result = SliceOptions::try_parse_from(input);

    // Assert
    let parsing_error = result.unwrap_err();
    assert_eq!(parsing_error.kind(), ErrorKind::ValueValidation);

    let error_message = parsing_error.source().unwrap().to_string();
    assert_eq!(
        error_message,
        "'=' can only appear once per argument (for a literal '=' character, use '\\=')",
    );
}