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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297

// Copyright (c) ZeroC, Inc.

mod test_helpers;

mod output {
    use crate::test_helpers::parse;
    use slicec::compilation_state::CompilationState;
    use slicec::diagnostic_emitter::DiagnosticEmitter;
    use slicec::diagnostics::{Diagnostic, Error, Lint};
    use slicec::slice_options::{DiagnosticFormat, SliceOptions};

    #[test]
    fn output_to_json() {
        // Arrange
        let slice = r#"
        module Foo

        interface I {
            /// @param x: this is an x
            op()
        }

        enum E : int8 {}
        "#;

        // Set the output format to JSON.
        let options = SliceOptions {
            diagnostic_format: DiagnosticFormat::Json,
            ..Default::default()
        };

        // Parse the Slice file.
        let state = parse(slice, Some(&options));
        let diagnostics = state.get_annotated_diagnostics(&options);

        let mut output: Vec<u8> = Vec::new();
        let mut emitter = DiagnosticEmitter::new(&mut output, &options);

        // Act
        emitter.emit_diagnostics(&diagnostics).unwrap();

        // Assert
        let expected = concat!(
            r#"{"message":"incorrect doc comment: comment has a 'param' tag for 'x', but operation 'op' has no parameter with that name","severity":"warning","snippet":{"span":{"start":{"row":5,"col":17},"end":{"row":5,"col":25},"file":"string-0"},"text":"  |\n5 |             /// @param x: this is an x\n  |                 --------\n  |"},"notes":[],"error_code":"IncorrectDocComment","reported_by":["slicec"]}"#,
            "\n",
            r#"{"message":"invalid enum 'E': enums must contain at least one enumerator","severity":"error","snippet":{"span":{"start":{"row":9,"col":9},"end":{"row":9,"col":15},"file":"string-0"},"text":"  |\n9 |         enum E : int8 {}\n  |         ------\n  |"},"notes":[],"error_code":"E008","reported_by":["slicec"]}"#,
            "\n",
        );
        assert_eq!(expected, String::from_utf8(output).unwrap());
    }

    #[test]
    fn output_to_console() {
        // Arrange
        let slice = "
        module Foo

        interface I {
            /// @param x: this is an x
            op1()

            op2(tag(1)
    x:
                    int32, tag(2) y: bool?,
            )
        }

        enum E : int8 {}
        ";

        // Disable ANSI color codes.
        let options = SliceOptions {
            disable_color: true,
            ..Default::default()
        };

        // Parse the Slice file.
        let state = parse(slice, Some(&options));
        let diagnostics = state.get_annotated_diagnostics(&options);

        let mut output: Vec<u8> = Vec::new();
        let mut emitter = DiagnosticEmitter::new(&mut output, &options);

        // Act
        emitter.emit_diagnostics(&diagnostics).unwrap();

        // Assert
        let expected = "\
warning [IncorrectDocComment]: incorrect doc comment: comment has a 'param' tag for 'x', but operation 'op1' has no parameter with that name
  Reported by: [slicec]
 --> string-0:5:17
  |
5 |             /// @param x: this is an x
  |                 --------
  |
error [E016]: invalid tag on member 'x': tagged members must be optional
  Reported by: [slicec]
 --> string-0:8:17
   |
8  |             op2(tag(1)
   |                 ------
9  |     x:
   | ------
10 |                     int32, tag(2) y: bool?,
   | -------------------------
   |
error [E008]: invalid enum 'E': enums must contain at least one enumerator
  Reported by: [slicec]
 --> string-0:14:9
   |
14 |         enum E : int8 {}
   |         ------
   |
";

        assert_eq!(expected, String::from_utf8(output).unwrap());
    }

    #[test]
    fn duplicate_diagnostics_are_merged_together() {
        // Arrange

        // All of these diagnostics are equal.
        //
        let mut diagnostic1_1 = Diagnostic::from_lint(Lint::Other {
            message: "This is a test".to_owned(),
        });
        diagnostic1_1.plugin = Some("foo".to_owned());

        let mut diagnostic1_2 = Diagnostic::from_lint(Lint::Other {
            message: "This is a test".to_owned(),
        });
        diagnostic1_2.plugin = Some("/path/bar.exe".to_owned());

        let mut diagnostic1_3 = Diagnostic::from_lint(Lint::Other {
            message: "This is a test".to_owned(),
        });
        diagnostic1_3.plugin = None; // should map to 'slicec' when converted.

        // This diagnostic is unique, there should be no other diagnostics equal to it.
        //
        let mut diagnostic2_1 = Diagnostic::from_lint(Lint::Other {
            message: "This is also a test".to_owned(),
        });
        diagnostic2_1.plugin = Some("/path/bar.exe".to_owned());

        // These 2 diagnostics are equal.
        //
        let mut diagnostic3_1 = Diagnostic::from_error(Error::CompactStructCannotBeEmpty);
        diagnostic3_1.plugin = None; // should map to 'slicec' when converted.

        let mut diagnostic3_2 = Diagnostic::from_error(Error::CompactStructCannotBeEmpty);
        diagnostic3_2.plugin = Some("foo".to_owned());

        // This diagnostic should not be equal to diagnostic 3, since this one has a note.
        //
        let mut diagnostic4_1 = Diagnostic::from_error(Error::CompactStructCannotBeEmpty)
            .add_note("This diagnostic is different because it has a note", None);
        diagnostic4_1.plugin = Some("foo".to_owned());

        // Manually set the diagnostics in our compilation state.
        let mut state = CompilationState::create();
        state.diagnostics.extend([
            diagnostic1_1,
            diagnostic1_2,
            diagnostic2_1,
            diagnostic3_1,
            diagnostic4_1,
            diagnostic1_3,
            diagnostic3_2,
        ]);

        // Act
        let converted_diagnostics = state.get_annotated_diagnostics(&SliceOptions::default());

        // Assert
        assert_eq!(converted_diagnostics.len(), 4);
        assert_eq!(converted_diagnostics[0].message, "This is a test");
        assert_eq!(converted_diagnostics[0].reported_by, ["foo", "bar", "slicec"]);
        assert_eq!(converted_diagnostics[1].message, "This is also a test");
        assert_eq!(converted_diagnostics[1].reported_by, ["bar"]);
        assert_eq!(converted_diagnostics[2].message, "compact structs must be non-empty");
        assert_eq!(converted_diagnostics[2].reported_by, ["slicec", "foo"]);
        assert_eq!(converted_diagnostics[3].message, "compact structs must be non-empty");
        assert_eq!(converted_diagnostics[3].reported_by, ["foo"]);

        let (warnings, errors) = DiagnosticEmitter::get_totals(&converted_diagnostics);
        assert_eq!(warnings, 2);
        assert_eq!(errors, 2);
    }

    #[test]
    fn allow_all_lints_flag() {
        // Arrange
        let slice = "
            module Foo

            interface I {
                /// {@link Fake}
                /// @param x: this is an x
                op()
            }
        ";

        let options = SliceOptions {
            diagnostic_format: DiagnosticFormat::Json,
            allowed_lints: vec!["All".to_owned()],
            ..Default::default()
        };

        // Parse the Slice file.
        let state = parse(slice, Some(&options));
        let diagnostics = state.get_annotated_diagnostics(&options);

        let mut output: Vec<u8> = Vec::new();
        let mut emitter = DiagnosticEmitter::new(&mut output, &options);

        // Act
        emitter.emit_diagnostics(&diagnostics).unwrap();

        // Assert
        assert_eq!("", String::from_utf8(output).unwrap());
    }

    #[test]
    fn allow_specific_lint_flag() {
        // Arrange
        let slice = "
            module Foo

            interface I {
                /// {@link Fake}
                /// @param x: this is an x
                op()
            }
        ";

        // Set the output format to JSON.
        let options = SliceOptions {
            diagnostic_format: DiagnosticFormat::Json,
            allowed_lints: vec!["BrokenDocLink".to_owned()],
            ..Default::default()
        };

        // Parse the Slice file.
        let state = parse(slice, Some(&options));
        let diagnostics = state.get_annotated_diagnostics(&options);

        let mut output: Vec<u8> = Vec::new();
        let mut emitter = DiagnosticEmitter::new(&mut output, &options);

        // Act
        emitter.emit_diagnostics(&diagnostics).unwrap();

        // Assert: Only one of the two lints should be allowed.
        let expected = concat!(
            r#"{"message":"incorrect doc comment: comment has a 'param' tag for 'x', but operation 'op' has no parameter with that name","severity":"warning","snippet":{"span":{"start":{"row":6,"col":21},"end":{"row":6,"col":29},"file":"string-0"},"text":"  |\n6 |                 /// @param x: this is an x\n  |                     --------\n  |"},"notes":[],"error_code":"IncorrectDocComment","reported_by":["slicec"]}"#,
            "\n",
        );
        assert_eq!(expected, String::from_utf8(output).unwrap());
    }

    #[test]
    fn crlf_line_endings() {
        // Arrange
        let slice = "module Foo \r\n   enum\r\n E\r : uint8\r\n{}\r\n\r";

        // Disable ANSI color codes.
        let options = SliceOptions {
            disable_color: true,
            ..Default::default()
        };

        let state = parse(slice, Some(&options));
        let diagnostics = state.get_annotated_diagnostics(&options);

        let mut output: Vec<u8> = Vec::new();
        let mut emitter = DiagnosticEmitter::new(&mut output, &options);

        // Act
        emitter.emit_diagnostics(&diagnostics).unwrap();

        // Assert
        let expected = "\
error [E008]: invalid enum 'E': enums must contain at least one enumerator
  Reported by: [slicec]
 --> string-0:2:4
  |
2 |    enum
  |    ----
3 |  E\r : uint8
  | --
  |
";
        assert_eq!(expected, String::from_utf8(output).unwrap());
    }
}