blob: 84bed7269d487c04c15d87c7bfc345cfda4ca569 [file] [log] [blame]
Dan Talaycodba244e2010-02-15 14:08:53 -08001"""
Dan Talayco79f36082010-03-11 16:53:53 -08002Basic protocol and dataplane test cases
Dan Talaycodba244e2010-02-15 14:08:53 -08003
Dan Talayco48370102010-03-03 15:17:33 -08004It is recommended that these definitions be kept in their own
5namespace as different groups of tests will likely define
6similar identifiers.
7
Dan Talaycodba244e2010-02-15 14:08:53 -08008Current Assumptions:
9
Dan Talayco41eae8b2010-03-10 13:57:06 -080010 The function test_set_init is called with a complete configuration
11dictionary prior to the invocation of any tests from this file.
12
Dan Talaycodba244e2010-02-15 14:08:53 -080013 The switch is actively attempting to contact the controller at the address
14indicated oin oft_config
15
16"""
17
Dan Talaycodba244e2010-02-15 14:08:53 -080018import time
Dan Talayco710438c2010-02-18 15:16:07 -080019import signal
Dan Talaycodba244e2010-02-15 14:08:53 -080020import sys
Dan Talayco48370102010-03-03 15:17:33 -080021import logging
Dan Talaycodba244e2010-02-15 14:08:53 -080022
Dan Talayco2c0dba32010-03-06 22:47:06 -080023import unittest
24
25import oftest.controller as controller
26import oftest.cstruct as ofp
27import oftest.message as message
28import oftest.dataplane as dataplane
29import oftest.action as action
30
Dan Talayco6ce963a2010-03-07 21:58:13 -080031from testutils import *
32
33#@var basic_port_map Local copy of the configuration map from OF port
34# numbers to OS interfaces
Dan Talayco48370102010-03-03 15:17:33 -080035basic_port_map = None
Dan Talayco6ce963a2010-03-07 21:58:13 -080036#@var basic_logger Local logger object
Dan Talayco48370102010-03-03 15:17:33 -080037basic_logger = None
Dan Talayco6ce963a2010-03-07 21:58:13 -080038#@var basic_config Local copy of global configuration data
Dan Talayco48370102010-03-03 15:17:33 -080039basic_config = None
40
Dan Talaycoc24aaae2010-07-08 14:05:24 -070041test_prio = {}
42
Dan Talayco48370102010-03-03 15:17:33 -080043def test_set_init(config):
44 """
45 Set up function for basic test classes
46
47 @param config The configuration dictionary; see oft
Dan Talayco48370102010-03-03 15:17:33 -080048 """
49
50 global basic_port_map
51 global basic_logger
52 global basic_config
53
54 basic_logger = logging.getLogger("basic")
55 basic_logger.info("Initializing test set")
56 basic_port_map = config["port_map"]
57 basic_config = config
Dan Talayco48370102010-03-03 15:17:33 -080058
Dan Talayco6ce963a2010-03-07 21:58:13 -080059class SimpleProtocol(unittest.TestCase):
Dan Talaycodba244e2010-02-15 14:08:53 -080060 """
61 Root class for setting up the controller
62 """
63
Dan Talaycoef701f42010-05-07 09:22:35 -070064 def sig_handler(self, v1, v2):
Dan Talayco48370102010-03-03 15:17:33 -080065 basic_logger.critical("Received interrupt signal; exiting")
Dan Talayco710438c2010-02-18 15:16:07 -080066 print "Received interrupt signal; exiting"
Dan Talayco2c0dba32010-03-06 22:47:06 -080067 self.clean_shutdown = False
68 self.tearDown()
Dan Talayco710438c2010-02-18 15:16:07 -080069 sys.exit(1)
70
Dan Talaycodba244e2010-02-15 14:08:53 -080071 def setUp(self):
Dan Talayco551befa2010-07-15 17:05:32 -070072 self.logger = basic_logger
Dan Talayco285a8382010-07-20 14:06:55 -070073 self.config = basic_config
Dan Talayco710438c2010-02-18 15:16:07 -080074 signal.signal(signal.SIGINT, self.sig_handler)
Dan Talayco9f47f4d2010-06-03 13:54:37 -070075 basic_logger.info("** START TEST CASE " + str(self))
Dan Talayco2c0dba32010-03-06 22:47:06 -080076 self.controller = controller.Controller(
77 host=basic_config["controller_host"],
78 port=basic_config["controller_port"])
Dan Talaycof8f41402010-03-12 22:17:39 -080079 # clean_shutdown should be set to False to force quit app
Dan Talayco2c0dba32010-03-06 22:47:06 -080080 self.clean_shutdown = True
Dan Talayco710438c2010-02-18 15:16:07 -080081 self.controller.start()
Dan Talaycoef701f42010-05-07 09:22:35 -070082 #@todo Add an option to wait for a pkt transaction to ensure version
83 # compatibilty?
Dan Talayco710438c2010-02-18 15:16:07 -080084 self.controller.connect(timeout=20)
Dan Talaycoef701f42010-05-07 09:22:35 -070085 if not self.controller.active:
86 print "Controller startup failed; exiting"
87 sys.exit(1)
Dan Talayco48370102010-03-03 15:17:33 -080088 basic_logger.info("Connected " + str(self.controller.switch_addr))
Dan Talaycodba244e2010-02-15 14:08:53 -080089
90 def tearDown(self):
Dan Talayco9f47f4d2010-06-03 13:54:37 -070091 basic_logger.info("** END TEST CASE " + str(self))
Dan Talaycodba244e2010-02-15 14:08:53 -080092 self.controller.shutdown()
Dan Talayco2c0dba32010-03-06 22:47:06 -080093 #@todo Review if join should be done on clean_shutdown
Dan Talaycof8f41402010-03-12 22:17:39 -080094 if self.clean_shutdown:
95 self.controller.join()
Dan Talaycodba244e2010-02-15 14:08:53 -080096
97 def runTest(self):
Dan Talayco710438c2010-02-18 15:16:07 -080098 # Just a simple sanity check as illustration
Dan Talayco48370102010-03-03 15:17:33 -080099 basic_logger.info("Running simple proto test")
Dan Talayco710438c2010-02-18 15:16:07 -0800100 self.assertTrue(self.controller.switch_socket is not None,
Dan Talaycodba244e2010-02-15 14:08:53 -0800101 str(self) + 'No connection to switch')
102
Dan Talayco9f47f4d2010-06-03 13:54:37 -0700103 def assertTrue(self, cond, msg):
104 if not cond:
105 basic_logger.error("** FAILED ASSERTION: " + msg)
106 unittest.TestCase.assertTrue(self, cond, msg)
107
Dan Talaycoc24aaae2010-07-08 14:05:24 -0700108test_prio["SimpleProtocol"] = 1
109
Dan Talayco6ce963a2010-03-07 21:58:13 -0800110class SimpleDataPlane(SimpleProtocol):
Dan Talaycodba244e2010-02-15 14:08:53 -0800111 """
112 Root class that sets up the controller and dataplane
113 """
114 def setUp(self):
Dan Talayco6ce963a2010-03-07 21:58:13 -0800115 SimpleProtocol.setUp(self)
Dan Talayco2c0dba32010-03-06 22:47:06 -0800116 self.dataplane = dataplane.DataPlane()
Dan Talayco48370102010-03-03 15:17:33 -0800117 for of_port, ifname in basic_port_map.items():
Dan Talaycodba244e2010-02-15 14:08:53 -0800118 self.dataplane.port_add(ifname, of_port)
119
120 def tearDown(self):
Dan Talayco48370102010-03-03 15:17:33 -0800121 basic_logger.info("Teardown for simple dataplane test")
Dan Talayco6ce963a2010-03-07 21:58:13 -0800122 SimpleProtocol.tearDown(self)
Dan Talayco2c0dba32010-03-06 22:47:06 -0800123 self.dataplane.kill(join_threads=self.clean_shutdown)
Dan Talayco48370102010-03-03 15:17:33 -0800124 basic_logger.info("Teardown done")
Dan Talaycodba244e2010-02-15 14:08:53 -0800125
126 def runTest(self):
Dan Talayco710438c2010-02-18 15:16:07 -0800127 self.assertTrue(self.controller.switch_socket is not None,
Dan Talaycodba244e2010-02-15 14:08:53 -0800128 str(self) + 'No connection to switch')
129 # self.dataplane.show()
130 # Would like an assert that checks the data plane
131
Dan Talayco551befa2010-07-15 17:05:32 -0700132class DataPlaneOnly(unittest.TestCase):
133 """
134 Root class that sets up only the dataplane
135 """
136
137 def sig_handler(self, v1, v2):
138 basic_logger.critical("Received interrupt signal; exiting")
139 print "Received interrupt signal; exiting"
140 self.clean_shutdown = False
141 self.tearDown()
142 sys.exit(1)
143
144 def setUp(self):
145 self.clean_shutdown = False
146 self.logger = basic_logger
Dan Talayco285a8382010-07-20 14:06:55 -0700147 self.config = basic_config
Dan Talayco551befa2010-07-15 17:05:32 -0700148 signal.signal(signal.SIGINT, self.sig_handler)
149 basic_logger.info("** START DataPlaneOnly CASE " + str(self))
150 self.dataplane = dataplane.DataPlane()
151 for of_port, ifname in basic_port_map.items():
152 self.dataplane.port_add(ifname, of_port)
153
154 def tearDown(self):
155 basic_logger.info("Teardown for simple dataplane test")
156 self.dataplane.kill(join_threads=self.clean_shutdown)
157 basic_logger.info("Teardown done")
158
159 def runTest(self):
Dan Talayco285a8382010-07-20 14:06:55 -0700160 print "DataPlaneOnly"
161 # self.dataplane.show()
Dan Talayco551befa2010-07-15 17:05:32 -0700162 # Would like an assert that checks the data plane
163
Dan Talayco6ce963a2010-03-07 21:58:13 -0800164class Echo(SimpleProtocol):
Dan Talaycodba244e2010-02-15 14:08:53 -0800165 """
166 Test echo response with no data
167 """
168 def runTest(self):
Dan Talayco2c0dba32010-03-06 22:47:06 -0800169 request = message.echo_request()
Dan Talaycoe226eb12010-02-18 23:06:30 -0800170 response, pkt = self.controller.transact(request)
Dan Talayco2c0dba32010-03-06 22:47:06 -0800171 self.assertEqual(response.header.type, ofp.OFPT_ECHO_REPLY,
Dan Talaycoa92e75b2010-02-16 20:53:56 -0800172 'response is not echo_reply')
Dan Talaycodba244e2010-02-15 14:08:53 -0800173 self.assertEqual(request.header.xid, response.header.xid,
174 'response xid != request xid')
175 self.assertEqual(len(response.data), 0, 'response data non-empty')
176
Dan Talayco6ce963a2010-03-07 21:58:13 -0800177class EchoWithData(SimpleProtocol):
Dan Talaycodba244e2010-02-15 14:08:53 -0800178 """
179 Test echo response with short string data
180 """
181 def runTest(self):
Dan Talayco2c0dba32010-03-06 22:47:06 -0800182 request = message.echo_request()
Dan Talaycodba244e2010-02-15 14:08:53 -0800183 request.data = 'OpenFlow Will Rule The World'
Dan Talaycoe226eb12010-02-18 23:06:30 -0800184 response, pkt = self.controller.transact(request)
Dan Talayco2c0dba32010-03-06 22:47:06 -0800185 self.assertEqual(response.header.type, ofp.OFPT_ECHO_REPLY,
Dan Talaycoa92e75b2010-02-16 20:53:56 -0800186 'response is not echo_reply')
Dan Talaycodba244e2010-02-15 14:08:53 -0800187 self.assertEqual(request.header.xid, response.header.xid,
188 'response xid != request xid')
189 self.assertEqual(request.data, response.data,
190 'response data does not match request')
191
Dan Talayco6ce963a2010-03-07 21:58:13 -0800192class PacketIn(SimpleDataPlane):
Dan Talaycodba244e2010-02-15 14:08:53 -0800193 """
194 Test packet in function
Dan Talayco6ce963a2010-03-07 21:58:13 -0800195
196 Send a packet to each dataplane port and verify that a packet
197 in message is received from the controller for each
Dan Talaycodba244e2010-02-15 14:08:53 -0800198 """
199 def runTest(self):
200 # Construct packet to send to dataplane
Dan Talaycoe226eb12010-02-18 23:06:30 -0800201 # Send packet to dataplane, once to each port
Dan Talaycodba244e2010-02-15 14:08:53 -0800202 # Poll controller with expect message type packet in
Dan Talaycoe226eb12010-02-18 23:06:30 -0800203
Dan Talayco6ce963a2010-03-07 21:58:13 -0800204 rc = delete_all_flows(self.controller, basic_logger)
205 self.assertEqual(rc, 0, "Failed to delete all flows")
206
Dan Talayco48370102010-03-03 15:17:33 -0800207 for of_port in basic_port_map.keys():
208 basic_logger.info("PKT IN test, port " + str(of_port))
Dan Talayco41eae8b2010-03-10 13:57:06 -0800209 pkt = simple_tcp_packet()
Dan Talaycodba244e2010-02-15 14:08:53 -0800210 self.dataplane.send(of_port, str(pkt))
Dan Talaycoe226eb12010-02-18 23:06:30 -0800211 #@todo Check for unexpected messages?
Dan Talayco2c0dba32010-03-06 22:47:06 -0800212 (response, raw) = self.controller.poll(ofp.OFPT_PACKET_IN, 2)
Dan Talaycodba244e2010-02-15 14:08:53 -0800213
Dan Talaycoe226eb12010-02-18 23:06:30 -0800214 self.assertTrue(response is not None,
Dan Talayco6ce963a2010-03-07 21:58:13 -0800215 'Packet in message not received on port ' +
216 str(of_port))
Dan Talayco48370102010-03-03 15:17:33 -0800217 if str(pkt) != response.data:
Dan Talaycoef701f42010-05-07 09:22:35 -0700218 basic_logger.debug("pkt len " + str(len(str(pkt))) +
219 ": " + str(pkt))
220 basic_logger.debug("resp len " +
221 str(len(str(response.data))) +
222 ": " + str(response.data))
Dan Talayco48370102010-03-03 15:17:33 -0800223
224 self.assertEqual(str(pkt), response.data,
Dan Talayco6ce963a2010-03-07 21:58:13 -0800225 'Response packet does not match send packet' +
226 ' for port ' + str(of_port))
Dan Talaycodba244e2010-02-15 14:08:53 -0800227
Dan Talayco6ce963a2010-03-07 21:58:13 -0800228class PacketOut(SimpleDataPlane):
Dan Talaycodba244e2010-02-15 14:08:53 -0800229 """
230 Test packet out function
Dan Talayco6ce963a2010-03-07 21:58:13 -0800231
232 Send packet out message to controller for each dataplane port and
233 verify the packet appears on the appropriate dataplane port
Dan Talaycodba244e2010-02-15 14:08:53 -0800234 """
235 def runTest(self):
236 # Construct packet to send to dataplane
237 # Send packet to dataplane
238 # Poll controller with expect message type packet in
Dan Talayco41eae8b2010-03-10 13:57:06 -0800239
240 rc = delete_all_flows(self.controller, basic_logger)
241 self.assertEqual(rc, 0, "Failed to delete all flows")
Dan Talaycodba244e2010-02-15 14:08:53 -0800242
243 # These will get put into function
Dan Talayco41eae8b2010-03-10 13:57:06 -0800244 outpkt = simple_tcp_packet()
Dan Talayco48370102010-03-03 15:17:33 -0800245 of_ports = basic_port_map.keys()
246 of_ports.sort()
247 for dp_port in of_ports:
Dan Talayco2c0dba32010-03-06 22:47:06 -0800248 msg = message.packet_out()
Dan Talayco48370102010-03-03 15:17:33 -0800249 msg.data = str(outpkt)
Dan Talayco2c0dba32010-03-06 22:47:06 -0800250 act = action.action_output()
Dan Talayco48370102010-03-03 15:17:33 -0800251 act.port = dp_port
252 self.assertTrue(msg.actions.add(act), 'Could not add action to msg')
Dan Talaycodba244e2010-02-15 14:08:53 -0800253
Dan Talayco48370102010-03-03 15:17:33 -0800254 basic_logger.info("PacketOut to: " + str(dp_port))
255 rv = self.controller.message_send(msg)
256 self.assertTrue(rv == 0, "Error sending out message")
Dan Talaycodba244e2010-02-15 14:08:53 -0800257
Dan Talayco48370102010-03-03 15:17:33 -0800258 (of_port, pkt, pkt_time) = self.dataplane.poll(timeout=1)
Dan Talaycodba244e2010-02-15 14:08:53 -0800259
Dan Talayco48370102010-03-03 15:17:33 -0800260 self.assertTrue(pkt is not None, 'Packet not received')
261 basic_logger.info("PacketOut: got pkt from " + str(of_port))
262 if of_port is not None:
263 self.assertEqual(of_port, dp_port, "Unexpected receive port")
264 self.assertEqual(str(outpkt), str(pkt),
265 'Response packet does not match send packet')
Dan Talaycodba244e2010-02-15 14:08:53 -0800266
Dan Talayco6ce963a2010-03-07 21:58:13 -0800267class FlowStatsGet(SimpleProtocol):
268 """
269 Get stats
Dan Talayco2c0dba32010-03-06 22:47:06 -0800270
Dan Talayco6ce963a2010-03-07 21:58:13 -0800271 Simply verify stats get transaction
272 """
273 def runTest(self):
274 basic_logger.info("Running StatsGet")
Dan Talayco41eae8b2010-03-10 13:57:06 -0800275 basic_logger.info("Inserting trial flow")
276 request = message.flow_mod()
277 request.match.wildcards = ofp.OFPFW_ALL
278 request.buffer_id = 0xffffffff
279 rv = self.controller.message_send(request)
280 self.assertTrue(rv != -1, "Failed to insert test flow")
281
282 basic_logger.info("Sending flow request")
Dan Talayco6ce963a2010-03-07 21:58:13 -0800283 request = message.flow_stats_request()
284 request.out_port = ofp.OFPP_NONE
Dan Talayco41eae8b2010-03-10 13:57:06 -0800285 request.table_id = 0xff
286 request.match.wildcards = 0 # ofp.OFPFW_ALL
Dan Talayco6ce963a2010-03-07 21:58:13 -0800287 response, pkt = self.controller.transact(request, timeout=2)
288 self.assertTrue(response is not None, "Did not get response")
Dan Talaycob3f43fe2010-05-13 14:24:20 -0700289 basic_logger.debug(response.show())
Dan Talayco6ce963a2010-03-07 21:58:13 -0800290
Dan Talayco79c6c4d2010-06-08 14:01:53 -0700291class TableStatsGet(SimpleProtocol):
292 """
293 Get table stats
294
295 Simply verify table stats get transaction
296 """
297 def runTest(self):
298 basic_logger.info("Running TableStatsGet")
299 basic_logger.info("Inserting trial flow")
300 request = message.flow_mod()
301 request.match.wildcards = ofp.OFPFW_ALL
302 request.buffer_id = 0xffffffff
303 rv = self.controller.message_send(request)
304 self.assertTrue(rv != -1, "Failed to insert test flow")
305
306 basic_logger.info("Sending table stats request")
307 request = message.table_stats_request()
308 response, pkt = self.controller.transact(request, timeout=2)
309 self.assertTrue(response is not None, "Did not get response")
310 basic_logger.debug(response.show())
311
Dan Talayco6ce963a2010-03-07 21:58:13 -0800312class FlowMod(SimpleProtocol):
313 """
314 Insert a flow
315
316 Simple verification of a flow mod transaction
317 """
318
319 def runTest(self):
320 basic_logger.info("Running " + str(self))
321 request = message.flow_mod()
Dan Talayco6ce963a2010-03-07 21:58:13 -0800322 request.match.wildcards = ofp.OFPFW_ALL
323 request.buffer_id = 0xffffffff
324 rv = self.controller.message_send(request)
Dan Talayco41eae8b2010-03-10 13:57:06 -0800325 self.assertTrue(rv != -1, "Error installing flow mod")
326
Dan Talaycob3f43fe2010-05-13 14:24:20 -0700327class PortConfigMod(SimpleProtocol):
328 """
329 Modify a bit in port config and verify changed
330
331 Get the switch configuration, modify the port configuration
332 and write it back; get the config again and verify changed.
333 Then set it back to the way it was.
334 """
335
336 def runTest(self):
337 basic_logger.info("Running " + str(self))
Dan Talayco9f47f4d2010-06-03 13:54:37 -0700338 for of_port, ifname in basic_port_map.items(): # Grab first port
339 break
Dan Talaycob3f43fe2010-05-13 14:24:20 -0700340
Dan Talayco9f47f4d2010-06-03 13:54:37 -0700341 (hw_addr, config, advert) = \
342 port_config_get(self.controller, of_port, basic_logger)
343 self.assertTrue(config is not None, "Did not get port config")
344
345 basic_logger.debug("No flood bit port " + str(of_port) + " is now " +
346 str(config & ofp.OFPPC_NO_FLOOD))
347
348 rv = port_config_set(self.controller, of_port,
349 config ^ ofp.OFPPC_NO_FLOOD, ofp.OFPPC_NO_FLOOD,
350 basic_logger)
Dan Talaycob3f43fe2010-05-13 14:24:20 -0700351 self.assertTrue(rv != -1, "Error sending port mod")
352
353 # Verify change took place with same feature request
Dan Talayco9f47f4d2010-06-03 13:54:37 -0700354 (hw_addr, config2, advert) = \
355 port_config_get(self.controller, of_port, basic_logger)
356 basic_logger.debug("No flood bit port " + str(of_port) + " is now " +
357 str(config2 & ofp.OFPPC_NO_FLOOD))
358 self.assertTrue(config2 is not None, "Did not get port config2")
359 self.assertTrue(config2 & ofp.OFPPC_NO_FLOOD !=
360 config & ofp.OFPPC_NO_FLOOD,
361 "Bit change did not take")
Dan Talaycob3f43fe2010-05-13 14:24:20 -0700362 # Set it back
Dan Talayco9f47f4d2010-06-03 13:54:37 -0700363 rv = port_config_set(self.controller, of_port, config,
364 ofp.OFPPC_NO_FLOOD, basic_logger)
365 self.assertTrue(rv != -1, "Error sending port mod")
Dan Talaycob3f43fe2010-05-13 14:24:20 -0700366
Dan Talaycodba244e2010-02-15 14:08:53 -0800367if __name__ == "__main__":
Dan Talayco2c0dba32010-03-06 22:47:06 -0800368 print "Please run through oft script: ./oft --test_spec=basic"