[refactor] OpenWRT dialup interface #168

Closes #168

Author: nemesifier

docs/source/backends/openwrt.rst

@@ -1252,12 +1252,12 @@ Will be rendered as follows::
 
     package network
 
-    config interface 'xdsl'               
+    config interface 'xdsl'
             option ifname 'dsl0'
-            option proto 'pppoe'     
-            option username 'dsluser' 
+            option proto 'pppoe'
+            option username 'dsluser'
             option password 'jf93nf82o023$'
-            option mtu '1448'          
+            option mtu '1448'
 
 Radio settings
 --------------

netjsonconfig/backends/openwrt/converters/interfaces.py

@@ -109,6 +109,12 @@ def __intermediate_interface(self, interface, uci_name):
             del interface['wireless']
         if 'addresses' in interface:
             del interface['addresses']
+        # specific transformation
+        type_ = self._get_uci_name(interface["type"])
+        method = getattr(self, f'_intermediate_{type_}', None)
+        if method:
+            interface = method(interface)
+        return interface
         return interface
 
     _address_keys = ['address', 'mask', 'family', 'gateway']
@@ -225,6 +231,10 @@ def __netjson_interface(self, interface):
             interface['mac'] = interface.pop('macaddr')
         if interface['network'] == self._get_uci_name(interface['name']):
             del interface['network']
+        # specific transformation
+        method = getattr(self, f'_netjson_{interface.get("proto")}', None)
+        if method:
+            interface = method(interface)
         return interface
 
     def __netjson_type(self, interface):
@@ -243,13 +253,17 @@ def __netjson_type(self, interface):
         return 'ethernet'
 
     def __netjson_addresses(self, interface):
-        proto = interface.pop('proto', 'none')
+        proto = interface.get('proto', 'none')
+        address_protos = ['static', 'dhcp', 'dhcpv6', 'none']
+        if 'proto' in interface and proto in address_protos:
+            del interface['proto']
         if 'ipaddr' not in interface and 'ip6addr' not in interface and proto == 'none':
             return interface
-        if proto not in ['static', 'dhcp', 'dhcpv6', 'none']:
-            interface['proto'] = proto
-            interface['type'] = self.__get_special_interface_type(interface)
+        if proto not in address_protos:
+            interface['type'] = 'other'
+        return self._add_netjson_addresses(interface, proto)
 
+    def _add_netjson_addresses(self, interface, proto):
         addresses = []
         ipv4 = interface.pop('ipaddr', [])
         ipv6 = interface.pop('ip6addr', [])
@@ -273,14 +287,9 @@ def __netjson_addresses(self, interface):
             interface['addresses'] = addresses
         return interface
 
-    def __get_special_interface_type(self, interface):
-        username = interface.get('username', False)
-        password = interface.get('password', False)
-
-        if username and password:
-            return 'dialup'
-
-        return 'other'
+    def _netjson_dialup(self, interface):
+        interface['type'] = 'dialup'
+        return interface
 
     def __netjson_address(self, address, interface):
         ip = ip_interface(address)
@@ -308,7 +317,7 @@ def __netjson_parse_ip(self, ip, netmask=32):
         if ip and netmask:
             return '{0}/{1}'.format(ip, netmask)
         else:
-            None
+            return None
 
     def __netjson_dns(self, interface, result):
         key_mapping = {'dns': 'dns_servers', 'dns_search': 'dns_search'}
@@ -320,3 +329,19 @@ def __netjson_dns(self, interface, result):
                 items = items.split()
             result.setdefault(netjson_key, [])
             result[netjson_key] += items
+
+
+for proto in [
+    '3g',
+    '6in4',
+    'aiccu',
+    'l2tp',
+    'ncm',
+    'ppp',
+    'pppoa',
+    'pppoe',
+    'pptp',
+    'qmi',
+    'wwan',
+]:
+    setattr(Interfaces, f'_netjson_{proto}', Interfaces._netjson_dialup)

netjsonconfig/backends/openwrt/schema.py

@@ -126,6 +126,7 @@
                             },
                             "proto": {
                                 "type": "string",
+                                "title": "protocol",
                                 "enum": [
                                     "3g",
                                     "6in4",
@@ -140,7 +141,7 @@
                                     "wwan",
                                 ],
                                 "default": "pppoe",
-                                "propertyOrder": 8,
+                                "propertyOrder": 1.1,
                             },
                             "username": {
                                 "type": "string",

tests/openwrt/test_interfaces.py

@@ -690,7 +690,7 @@ def test_parse_interface_custom_attrs(self):
     option custom_attr 'yes'
     option ifname 'mobile0'
     option mtu '1400'
-    option proto '3g'
+    option proto 'exotic'
 """
         )
         expected = {
@@ -700,7 +700,7 @@ def test_parse_interface_custom_attrs(self):
                     "type": "other",
                     "mtu": 1400,
                     "custom_attr": "yes",
-                    "proto": "3g",
+                    "proto": "exotic",
                 }
             ]
         }