Allow to clear extra routes from router

Ensure that we can handle None field for routes as no
neutron client has the ability to clear arbitrary
fields.

Some refactoring for the unit tests is done to reduce
duplication.

Fixes bug #1193143

Change-Id: I067e70ee87354e50a5a7d91c383449464bb33eb0

diff --git a/neutron/extensions/extraroute.py b/neutron/extensions/extraroute.py
index d7c9dbc3f0b9c14a08ee1834792f174f79553e93..5f2c7a8c708f8679a9870653f0dabe699e4415d9 100644 (file)
--- a/neutron/extensions/extraroute.py
+++ b/neutron/extensions/extraroute.py
@@ -40,6 +40,7 @@ EXTENDED_ATTRIBUTES_2_0 = {
     'routers': {
         'routes': {'allow_post': False, 'allow_put': True,
                    'validate': {'type:hostroutes': None},
+                   'convert_to': attr.convert_none_to_empty_list,
                    'is_visible': True, 'default': attr.ATTR_NOT_SPECIFIED},
     }
 }

diff --git a/neutron/tests/unit/test_extension_extraroute.py b/neutron/tests/unit/test_extension_extraroute.py
index 7136e6e250bb41ebe14de53cbb9f72dffe24cf56..4ea4c83cd774a696c73271461ae8fcbc5c992118 100644 (file)
--- a/neutron/tests/unit/test_extension_extraroute.py
+++ b/neutron/tests/unit/test_extension_extraroute.py
@@ -76,52 +76,57 @@ class ExtraRouteDBTestCase(test_l3.L3NatDBTestCase):
         notifier_api._drivers = None
         cfg.CONF.set_override("notification_driver", [test_notifier.__name__])
 
+    def _routes_update_prepare(self, router_id, subnet_id,
+                               port_id, routes, skip_add=False):
+        if not skip_add:
+            self._router_interface_action('add', router_id, subnet_id, port_id)
+        self._update('routers', router_id, {'router': {'routes': routes}})
+        return self._show('routers', router_id)
+
+    def _routes_update_cleanup(self, port_id, subnet_id, router_id, routes):
+        self._update('routers', router_id, {'router': {'routes': routes}})
+        self._router_interface_action('remove', router_id, subnet_id, port_id)
+
     def test_route_update_with_one_route(self):
+        routes = [{'destination': '135.207.0.0/16', 'nexthop': '10.0.1.3'}]
         with self.router() as r:
             with self.subnet(cidr='10.0.1.0/24') as s:
                 with self.port(subnet=s, no_delete=True) as p:
-                    body = self._show('routers', r['router']['id'])
-                    body = self._router_interface_action('add',
-                                                         r['router']['id'],
-                                                         None,
-                                                         p['port']['id'])
-
-                    routes = [{'destination': '135.207.0.0/16',
-                               'nexthop': '10.0.1.3'}]
-
+                    body = self._routes_update_prepare(r['router']['id'],
+                                                       None, p['port']['id'],
+                                                       routes)
+                    self.assertEqual(body['router']['routes'], routes)
+                    self._routes_update_cleanup(p['port']['id'],
+                                                None, r['router']['id'], [])
+
+    def test_route_clear_routes_with_None(self):
+        routes = [{'destination': '135.207.0.0/16',
+                   'nexthop': '10.0.1.3'},
+                  {'destination': '12.0.0.0/8',
+                   'nexthop': '10.0.1.4'},
+                  {'destination': '141.212.0.0/16',
+                   'nexthop': '10.0.1.5'}]
+        with self.router() as r:
+            with self.subnet(cidr='10.0.1.0/24') as s:
+                with self.port(subnet=s, no_delete=True) as p:
+                    self._routes_update_prepare(r['router']['id'],
+                                                None, p['port']['id'], routes)
                     body = self._update('routers', r['router']['id'],
-                                        {'router': {'routes': routes}})
-
-                    body = self._show('routers', r['router']['id'])
-                    self.assertEqual(body['router']['routes'],
-                                     routes)
-                    self._update('routers', r['router']['id'],
-                                 {'router': {'routes': []}})
-                    # clean-up
-                    self._router_interface_action('remove',
-                                                  r['router']['id'],
-                                                  None,
-                                                  p['port']['id'])
+                                        {'router': {'routes': None}})
+                    self.assertEqual(body['router']['routes'], [])
+                    self._routes_update_cleanup(p['port']['id'],
+                                                None, r['router']['id'], [])
 
     def test_router_interface_in_use_by_route(self):
+        routes = [{'destination': '135.207.0.0/16',
+                   'nexthop': '10.0.1.3'}]
         with self.router() as r:
             with self.subnet(cidr='10.0.1.0/24') as s:
                 with self.port(subnet=s, no_delete=True) as p:
-                    body = self._router_interface_action('add',
-                                                         r['router']['id'],
-                                                         None,
-                                                         p['port']['id'])
-
-                    routes = [{'destination': '135.207.0.0/16',
-                               'nexthop': '10.0.1.3'}]
-
-                    body = self._update('routers', r['router']['id'],
-                                        {'router': {'routes': routes}})
-
-                    body = self._show('routers', r['router']['id'])
-                    self.assertEqual(body['router']['routes'],
-                                     routes)
-
+                    body = self._routes_update_prepare(r['router']['id'],
+                                                       None, p['port']['id'],
+                                                       routes)
+                    self.assertEqual(body['router']['routes'], routes)
                     self._router_interface_action(
                         'remove',
                         r['router']['id'],
@@ -129,95 +134,54 @@ class ExtraRouteDBTestCase(test_l3.L3NatDBTestCase):
                         p['port']['id'],
                         expected_code=exc.HTTPConflict.code)
 
-                    self._update('routers', r['router']['id'],
-                                 {'router': {'routes': []}})
-                    # clean-up
-                    self._router_interface_action('remove',
-                                                  r['router']['id'],
-                                                  None,
-                                                  p['port']['id'])
+                    self._routes_update_cleanup(p['port']['id'],
+                                                None, r['router']['id'], [])
 
     def test_route_update_with_multi_routes(self):
+        routes = [{'destination': '135.207.0.0/16',
+                   'nexthop': '10.0.1.3'},
+                  {'destination': '12.0.0.0/8',
+                   'nexthop': '10.0.1.4'},
+                  {'destination': '141.212.0.0/16',
+                   'nexthop': '10.0.1.5'}]
         with self.router() as r:
             with self.subnet(cidr='10.0.1.0/24') as s:
                 with self.port(subnet=s, no_delete=True) as p:
-                    body = self._router_interface_action('add',
-                                                         r['router']['id'],
-                                                         None,
-                                                         p['port']['id'])
-
-                    routes = [{'destination': '135.207.0.0/16',
-                               'nexthop': '10.0.1.3'},
-                              {'destination': '12.0.0.0/8',
-                               'nexthop': '10.0.1.4'},
-                              {'destination': '141.212.0.0/16',
-                               'nexthop': '10.0.1.5'}]
-
-                    body = self._update('routers', r['router']['id'],
-                                        {'router': {'routes': routes}})
-
-                    body = self._show('routers', r['router']['id'])
+                    body = self._routes_update_prepare(r['router']['id'],
+                                                       None, p['port']['id'],
+                                                       routes)
                     self.assertEqual(sorted(body['router']['routes']),
                                      sorted(routes))
-
-                    # clean-up
-                    self._update('routers', r['router']['id'],
-                                 {'router': {'routes': []}})
-                    self._router_interface_action('remove',
-                                                  r['router']['id'],
-                                                  None,
-                                                  p['port']['id'])
+                    self._routes_update_cleanup(p['port']['id'],
+                                                None, r['router']['id'], [])
 
     def test_router_update_delete_routes(self):
+        routes_orig = [{'destination': '135.207.0.0/16',
+                        'nexthop': '10.0.1.3'},
+                       {'destination': '12.0.0.0/8',
+                        'nexthop': '10.0.1.4'},
+                       {'destination': '141.212.0.0/16',
+                        'nexthop': '10.0.1.5'}]
+        routes_left = [{'destination': '135.207.0.0/16',
+                        'nexthop': '10.0.1.3'},
+                       {'destination': '141.212.0.0/16',
+                        'nexthop': '10.0.1.5'}]
         with self.router() as r:
             with self.subnet(cidr='10.0.1.0/24') as s:
                 with self.port(subnet=s, no_delete=True) as p:
-                    body = self._router_interface_action('add',
-                                                         r['router']['id'],
-                                                         None,
-                                                         p['port']['id'])
-
-                    routes_orig = [{'destination': '135.207.0.0/16',
-                                    'nexthop': '10.0.1.3'},
-                                   {'destination': '12.0.0.0/8',
-                                    'nexthop': '10.0.1.4'},
-                                   {'destination': '141.212.0.0/16',
-                                    'nexthop': '10.0.1.5'}]
-
-                    body = self._update('routers', r['router']['id'],
-                                        {'router': {'routes':
-                                                    routes_orig}})
-
-                    body = self._show('routers', r['router']['id'])
+                    body = self._routes_update_prepare(r['router']['id'],
+                                                       None, p['port']['id'],
+                                                       routes_orig)
                     self.assertEqual(sorted(body['router']['routes']),
                                      sorted(routes_orig))
-
-                    routes_left = [{'destination': '135.207.0.0/16',
-                                    'nexthop': '10.0.1.3'},
-                                   {'destination': '141.212.0.0/16',
-                                    'nexthop': '10.0.1.5'}]
-
-                    body = self._update('routers', r['router']['id'],
-                                        {'router': {'routes':
-                                                    routes_left}})
-
-                    body = self._show('routers', r['router']['id'])
+                    body = self._routes_update_prepare(r['router']['id'],
+                                                       None, p['port']['id'],
+                                                       routes_left,
+                                                       skip_add=True)
                     self.assertEqual(sorted(body['router']['routes']),
                                      sorted(routes_left))
-
-                    body = self._update('routers', r['router']['id'],
-                                        {'router': {'routes': []}})
-
-                    body = self._show('routers', r['router']['id'])
-                    self.assertEqual(body['router']['routes'], [])
-
-                    # clean-up
-                    self._update('routers', r['router']['id'],
-                                 {'router': {'routes': []}})
-                    self._router_interface_action('remove',
-                                                  r['router']['id'],
-                                                  None,
-                                                  p['port']['id'])
+                    self._routes_update_cleanup(p['port']['id'],
+                                                None, r['router']['id'], [])
 
     def _test_malformed_route(self, routes):
         with self.router() as r: