blob: 9eb37649410a98fc363e6663f37e4fbcdd03de9c [file] [log] [blame]
Rich Lanea06d0c32013-03-25 08:52:03 -07001#!/usr/bin/env python
2# Copyright 2013, Big Switch Networks, Inc.
3#
4# LoxiGen is licensed under the Eclipse Public License, version 1.0 (EPL), with
5# the following special exception:
6#
7# LOXI Exception
8#
9# As a special exception to the terms of the EPL, you may distribute libraries
10# generated by LoxiGen (LoxiGen Libraries) under the terms of your choice, provided
11# that copyright and licensing notices generated by LoxiGen are not altered or removed
12# from the LoxiGen Libraries and the notice provided below is (i) included in
13# the LoxiGen Libraries, if distributed in source code form and (ii) included in any
14# documentation for the LoxiGen Libraries, if distributed in binary form.
15#
16# Notice: "Copyright 2013, Big Switch Networks, Inc. This library was generated by the LoxiGen Compiler."
17#
18# You may not use this file except in compliance with the EPL or LOXI Exception. You may obtain
19# a copy of the EPL at:
20#
21# http://www.eclipse.org/legal/epl-v10.html
22#
23# Unless required by applicable law or agreed to in writing, software
24# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
25# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
26# EPL for the specific language governing permissions and limitations
27# under the EPL.
28
Rich Lane569338c2013-06-17 15:51:24 -070029import sys
30import os
Rich Lanea06d0c32013-03-25 08:52:03 -070031import unittest
Rich Lane569338c2013-06-17 15:51:24 -070032
33root_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), '..')
34sys.path.insert(0, root_dir)
35
Rich Lanea06d0c32013-03-25 08:52:03 -070036import pyparsing
37import loxi_front_end.parser as parser
38
39class StructTests(unittest.TestCase):
40 def test_empty(self):
41 src = """\
42struct foo { };
43"""
44 ast = parser.parse(src)
Andreas Wundsam529e6c52013-08-03 13:41:48 -070045 self.assertEquals(ast, [['struct', 'foo', [], None, []]])
Rich Lanea06d0c32013-03-25 08:52:03 -070046
47 def test_one_field(self):
48 src = """\
49struct foo {
50 uint32_t bar;
51};
52"""
53 ast = parser.parse(src)
Rich Lane43b2a902013-05-09 13:47:07 -070054 self.assertEquals(ast,
Andreas Wundsam529e6c52013-08-03 13:41:48 -070055 [['struct', 'foo', [], None, [['data', 'uint32_t', 'bar']]]])
Rich Lanea06d0c32013-03-25 08:52:03 -070056
Andreas Wundsam7e5b0e72013-08-03 20:23:43 -070057 def test_struct_align_arg(self):
58 src = """\
59struct foo(align=8) {
60 uint32_t bar;
61};
62"""
63 ast = parser.parse(src)
64 self.assertEquals(ast,
65 [['struct', 'foo', [['align', '8']], None, [['data', 'uint32_t', 'bar']]]])
66
Rich Lanea06d0c32013-03-25 08:52:03 -070067 def test_multiple_fields(self):
68 src = """\
69struct foo {
70 uint32_t bar;
71 uint8_t baz;
72 uint64_t abc;
73};
74"""
75 ast = parser.parse(src)
Rich Lane43b2a902013-05-09 13:47:07 -070076 self.assertEquals(ast,
Andreas Wundsam529e6c52013-08-03 13:41:48 -070077 [['struct', 'foo', [], None,
Rich Lanef424e972013-05-09 21:00:13 -070078 [['data', 'uint32_t', 'bar'],
79 ['data', 'uint8_t', 'baz'],
80 ['data', 'uint64_t', 'abc']]]])
Rich Lanea06d0c32013-03-25 08:52:03 -070081
82 def test_array_type(self):
83 src = """\
84struct foo {
85 uint32_t[4] bar;
86};
87"""
88 ast = parser.parse(src)
Rich Lane43b2a902013-05-09 13:47:07 -070089 self.assertEquals(ast,
Andreas Wundsam529e6c52013-08-03 13:41:48 -070090 [['struct', 'foo', [], None, [['data', 'uint32_t[4]', 'bar']]]])
Rich Lanea06d0c32013-03-25 08:52:03 -070091
92 def test_list_type(self):
93 src = """\
94struct foo {
95 list(of_action_t) bar;
96};
97"""
98 ast = parser.parse(src)
Rich Lane43b2a902013-05-09 13:47:07 -070099 self.assertEquals(ast,
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700100 [['struct', 'foo', [], None, [['data', 'list(of_action_t)', 'bar']]]])
Rich Lanea06d0c32013-03-25 08:52:03 -0700101
Rich Lane32142872013-05-09 21:16:47 -0700102 def test_pad_member(self):
Rich Lanee4d04ea2013-05-09 11:27:06 -0700103 src = """\
104struct foo {
105 pad(1);
106};
107"""
108 ast = parser.parse(src)
109 self.assertEquals(ast,
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700110 [['struct', 'foo', [], None, [['pad', 1]]]])
Rich Lanee4d04ea2013-05-09 11:27:06 -0700111
Rich Lane32142872013-05-09 21:16:47 -0700112 def test_type_member(self):
113 src = """\
114struct foo {
115 uint16_t foo == 0x10;
116};
117"""
118 ast = parser.parse(src)
119 self.assertEquals(ast,
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700120 [['struct', 'foo', [], None, [['type', 'uint16_t', 'foo', 0x10]]]])
Rich Lanebd431502013-06-21 16:30:20 -0700121
122 def test_inheritance(self):
123 src = """\
124struct foo : bar {
125 uint16_t foo == 0x10;
126};
127"""
128 ast = parser.parse(src)
129 self.assertEquals(ast,
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700130 [['struct', 'foo', [], 'bar', [['type', 'uint16_t', 'foo', 0x10]]]])
Rich Lane32142872013-05-09 21:16:47 -0700131
Andreas Wundsam7e5b0e72013-08-03 20:23:43 -0700132 def test_discriminator(self):
133 src = """\
134struct foo {
135 uint16_t foo == ?;
136};
137"""
138 ast = parser.parse(src)
139 self.assertEquals(ast,
140 [['struct', 'foo', [], None, [['discriminator', 'uint16_t', 'foo']]]])
141
Rich Lane517506c2013-04-08 14:08:31 -0700142class EnumTests(unittest.TestCase):
143 def test_empty(self):
144 src = """\
145enum foo {
146};
147"""
148 ast = parser.parse(src)
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700149 self.assertEquals(ast, [['enum', 'foo', [], []]])
Rich Lane517506c2013-04-08 14:08:31 -0700150
151 def test_one(self):
152 src = """\
153enum foo {
154 BAR = 1
155};
156"""
157 ast = parser.parse(src)
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700158 self.assertEquals(ast, [['enum', 'foo', [], [['BAR', [], 1]]]])
Rich Lane517506c2013-04-08 14:08:31 -0700159
Andreas Wundsam7e5b0e72013-08-03 20:23:43 -0700160 def test_params(self):
161 src = """\
162enum foo(wire_type=uint32, bitmask=False, complete=False) {
163 BAR = 1
164};
165"""
166 ast = parser.parse(src)
167 self.assertEquals(ast, [['enum', 'foo',
168 [ ['wire_type', 'uint32'], ['bitmask','False'], ['complete', 'False']],
169 [['BAR', [], 1]]]])
170
Rich Lane517506c2013-04-08 14:08:31 -0700171 def test_multiple(self):
172 src = """\
173enum foo {
174 OFP_A = 1,
175 OFP_B = 2,
176 OFP_C = 3
177};
178"""
179 ast = parser.parse(src)
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700180 self.assertEquals(ast, [['enum', 'foo', [], [['OFP_A', [], 1], ['OFP_B', [], 2], ['OFP_C', [], 3]]]])
Rich Lane517506c2013-04-08 14:08:31 -0700181
182 def test_trailing_comma(self):
183 src = """\
184enum foo {
185 OFP_A = 1,
186 OFP_B = 2,
187 OFP_C = 3,
188};
189"""
190 ast = parser.parse(src)
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700191 self.assertEquals(ast, [['enum', 'foo', [], [['OFP_A', [], 1], ['OFP_B', [], 2], ['OFP_C', [], 3]]]])
Rich Lane517506c2013-04-08 14:08:31 -0700192
Rich Lanea06d0c32013-03-25 08:52:03 -0700193class TestMetadata(unittest.TestCase):
194 def test_version(self):
195 src = """\
196#version 1
197"""
198 ast = parser.parse(src)
Rich Lane43b2a902013-05-09 13:47:07 -0700199 self.assertEquals(ast, [['metadata', 'version', '1']])
Rich Lanea06d0c32013-03-25 08:52:03 -0700200
201class TestToplevel(unittest.TestCase):
202 def test_multiple_structs(self):
203 src = """\
204struct foo { };
205struct bar { };
206"""
207 ast = parser.parse(src)
Rich Lane43b2a902013-05-09 13:47:07 -0700208 self.assertEquals(ast,
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700209 [['struct', 'foo', [], None, []], ['struct', 'bar', [], None, []]])
Rich Lanea06d0c32013-03-25 08:52:03 -0700210
211 def test_comments(self):
212 src = """\
213// comment 1
214struct foo { //comment 2
215// comment 3
Andreas Wundsam53256162013-05-02 14:05:53 -0700216 uint32_t a; //comment 5
Rich Lanea06d0c32013-03-25 08:52:03 -0700217// comment 6
218};
219// comment 4
220"""
221 ast = parser.parse(src)
Rich Lane43b2a902013-05-09 13:47:07 -0700222 self.assertEquals(ast,
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700223 [['struct', 'foo', [], None, [['data', 'uint32_t', 'a']]]])
Rich Lanea06d0c32013-03-25 08:52:03 -0700224
225 def test_mixed(self):
226 src = """\
227#version 1
228struct foo { };
229#version 2
230struct bar { };
231"""
232 ast = parser.parse(src)
Rich Lane43b2a902013-05-09 13:47:07 -0700233 self.assertEquals(ast,
Rich Lanea06d0c32013-03-25 08:52:03 -0700234 [['metadata', 'version', '1'],
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700235 ['struct', 'foo', [], None, []],
Rich Lanea06d0c32013-03-25 08:52:03 -0700236 ['metadata', 'version', '2'],
Andreas Wundsam529e6c52013-08-03 13:41:48 -0700237 ['struct', 'bar', [], None, []]])
Rich Lanea06d0c32013-03-25 08:52:03 -0700238
239class TestErrors(unittest.TestCase):
240 def syntax_error(self, src, regex):
241 with self.assertRaisesRegexp(pyparsing.ParseSyntaxException, regex):
242 parser.parse(src)
243
244 def test_missing_struct_syntax(self):
245 self.syntax_error('struct { uint32_t bar; };',
246 'Expected identifier \(at char 7\)')
247 self.syntax_error('struct foo uint32_t bar; };',
248 'Expected "{" \(at char 11\)')
249 self.syntax_error('struct foo { uint32_t bar; ;',
250 'Expected "}" \(at char 27\)')
251 self.syntax_error('struct foo { uint32_t bar; }',
252 'Expected ";" \(at char 28\)')
253
254 def test_invalid_type_name(self):
255 self.syntax_error('struct foo { list<of_action_t> bar; }',
256 'Expected "\(" \(at char 17\)')
257 self.syntax_error('struct foo { uint32_t[10 bar; }',
258 'Expected "\]" \(at char 24\)')
259
260 def test_invalid_member_syntax(self):
261 self.syntax_error('struct foo { bar; }',
262 'Expected identifier \(at char 16\)')
263 self.syntax_error('struct foo { uint32_t bar baz; }',
264 'Expected ";" \(at char 26\)')
265
266
267if __name__ == '__main__':
268 unittest.main()