blob: c99ee344bbd04fef4e210fe377ce04d9fcfb7501 [file] [log] [blame]
Rich Lane3f075972013-03-15 22:56:29 -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.
28import unittest
Rich Lane1d5b0102013-05-10 16:28:17 -070029from testutil import test_serialization
Rich Lanec9fc57d2013-05-16 16:39:12 -070030from testutil import add_datafiles_tests
Rich Lane3f075972013-03-15 22:56:29 -070031
32try:
Rich Lane9d98adf2013-11-29 18:37:24 -080033 import loxi
Rich Lane3f075972013-03-15 22:56:29 -070034 import loxi.of13 as ofp
Rich Lane57026dc2013-05-01 10:13:16 -070035 from loxi.generic_util import OFReader
Rich Lane3f075972013-03-15 22:56:29 -070036except ImportError:
37 exit("loxi package not found. Try setting PYTHONPATH.")
38
39class TestImports(unittest.TestCase):
40 def test_toplevel(self):
41 import loxi
42 self.assertTrue(hasattr(loxi, "ProtocolError"))
Rich Lane00549ea2013-04-25 13:33:16 -070043 self.assertEquals(loxi.version_names[4], "1.3")
Rich Lane3f075972013-03-15 22:56:29 -070044 ofp = loxi.protocol(4)
45 self.assertEquals(ofp.OFP_VERSION, 4)
46 self.assertTrue(hasattr(ofp, "action"))
47 self.assertTrue(hasattr(ofp, "common"))
48 self.assertTrue(hasattr(ofp, "const"))
49 self.assertTrue(hasattr(ofp, "message"))
Rich Lanea22233e2013-04-25 13:18:41 -070050 self.assertTrue(hasattr(ofp, "oxm"))
Rich Lane3f075972013-03-15 22:56:29 -070051
52 def test_version(self):
53 import loxi
54 self.assertTrue(hasattr(loxi.of13, "ProtocolError"))
55 self.assertTrue(hasattr(loxi.of13, "OFP_VERSION"))
56 self.assertEquals(loxi.of13.OFP_VERSION, 4)
57 self.assertTrue(hasattr(loxi.of13, "action"))
58 self.assertTrue(hasattr(loxi.of13, "common"))
59 self.assertTrue(hasattr(loxi.of13, "const"))
60 self.assertTrue(hasattr(loxi.of13, "message"))
Rich Lanea22233e2013-04-25 13:18:41 -070061 self.assertTrue(hasattr(loxi.of13, "oxm"))
Rich Lane3f075972013-03-15 22:56:29 -070062
Rich Lanec9fc57d2013-05-16 16:39:12 -070063# The majority of the serialization tests are created here using the files in
64# the test_data directory.
65class TestDataFiles(unittest.TestCase):
66 pass
67add_datafiles_tests(TestDataFiles, 'of13/', ofp)
Rich Lanee02314c2013-05-02 16:42:04 -070068
Rich Lane3f075972013-03-15 22:56:29 -070069class TestAllOF13(unittest.TestCase):
70 """
71 Round-trips every class through serialization/deserialization.
72 Not a replacement for handcoded tests because it only uses the
73 default member values.
74 """
75
76 def setUp(self):
Rich Laneea693752013-03-18 11:05:45 -070077 mods = [ofp.action,ofp.message,ofp.common,ofp.oxm]
Rich Lane3f075972013-03-15 22:56:29 -070078 self.klasses = [klass for mod in mods
79 for klass in mod.__dict__.values()
Rich Lane9d98adf2013-11-29 18:37:24 -080080 if isinstance(klass, type) and
81 issubclass(klass, loxi.OFObject) and
Rich Lane038c9e62014-01-27 15:33:18 -080082 not hasattr(klass, 'subtypes')]
Rich Lane3f075972013-03-15 22:56:29 -070083 self.klasses.sort(key=lambda x: str(x))
84
85 def test_serialization(self):
86 expected_failures = [
Rich Lanebe90eae2013-07-22 16:44:26 -070087 ofp.action.set_field, # field defaults to None
Rich Lane3f075972013-03-15 22:56:29 -070088 ]
89 for klass in self.klasses:
90 def fn():
91 obj = klass()
92 if hasattr(obj, "xid"): obj.xid = 42
93 buf = obj.pack()
Rich Lane5b2745c2013-11-30 00:36:24 -080094 obj2 = klass.unpack(OFReader(buf))
Rich Lane3f075972013-03-15 22:56:29 -070095 self.assertEquals(obj, obj2)
96 if klass in expected_failures:
97 self.assertRaises(Exception, fn)
98 else:
99 fn()
100
Rich Lane65790d22013-06-14 00:08:52 -0700101 def test_parse_message(self):
102 expected_failures = [
Rich Lane65790d22013-06-14 00:08:52 -0700103 ]
104 for klass in self.klasses:
Rich Lane9d98adf2013-11-29 18:37:24 -0800105 if not issubclass(klass, ofp.message.message):
Rich Lane65790d22013-06-14 00:08:52 -0700106 continue
107 def fn():
108 obj = klass(xid=42)
109 buf = obj.pack()
110 obj2 = ofp.message.parse_message(buf)
111 self.assertEquals(obj, obj2)
112 if klass in expected_failures:
113 self.assertRaises(Exception, fn)
114 else:
115 fn()
116
Rich Lane3f075972013-03-15 22:56:29 -0700117 def test_show(self):
Rich Lane8ca3b772013-04-30 13:36:55 -0700118 expected_failures = []
Rich Lane3f075972013-03-15 22:56:29 -0700119 for klass in self.klasses:
120 def fn():
121 obj = klass()
122 if hasattr(obj, "xid"): obj.xid = 42
123 obj.show()
124 if klass in expected_failures:
125 self.assertRaises(Exception, fn)
126 else:
127 fn()
128
Rich Lane3009c1a2014-11-13 15:43:09 -0800129class TestUtils(unittest.TestCase):
130 def check_bitmap_512(self, value, data):
131 self.assertEquals(data, ofp.util.pack_bitmap_512(set(value)))
132 self.assertEquals(ofp.util.unpack_bitmap_512(OFReader(data)), set(value))
133
134 def test_bitmap_512(self):
135 self.check_bitmap_512([0], "\x00" * 63 + "\x01")
136 self.check_bitmap_512([8], "\x00" * 62 + "\x01\x00")
137 self.check_bitmap_512([63], "\x00" * 56 + "\x80" + "\x00" * 7)
138 self.check_bitmap_512([64], "\x00" * 55 + "\x01" + "\x00" * 8)
139 self.check_bitmap_512([511], "\x80" + "\x00" * 63)
140 self.check_bitmap_512([5, 67, 90], "\x00" * 52 + "\x04\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x20")
141
Rich Lane3f075972013-03-15 22:56:29 -0700142if __name__ == '__main__':
143 unittest.main()