[fix] Openwrt backend validation problem for property ip_rules/src #96

Fixed issue by defining a new format checker for CIDR notation.

Fixes #96

Author: NoumbissiValere

.gitignore

@@ -54,6 +54,7 @@ target/
 
 # editors
 *.komodoproject
+.vscode
 
 # other
 *.DS_Store*

netjsonconfig/backends/base/backend.py

@@ -1,4 +1,5 @@
 import gzip
+import ipaddress
 import json
 import tarfile
 from collections import OrderedDict
@@ -122,6 +123,14 @@ def _deduplicate_files(self):
             files_dict[file['path']] = file
         self.config['files'] = list(files_dict.values())
 
+    @draft4_format_checker.checks('cidr', AssertionError)
+    def _cidr_notation(value):
+        try:
+            ipaddress.ip_network(value)
+        except ValueError as e:
+            assert False, str(e)
+        return True
+
     def validate(self):
         try:
             Draft4Validator(self.schema, format_checker=draft4_format_checker).validate(

netjsonconfig/backends/openwrt/schema.py

@@ -229,12 +229,14 @@
                             "title": "source subnet",
                             "description": "(CIDR notation)",
                             "propertyOrder": 3,
+                            "format": "cidr",
                         },
                         "dest": {
                             "type": "string",
                             "title": "destination subnet",
                             "description": "(CIDR notation)",
                             "propertyOrder": 4,
+                            "format": "cidr",
                         },
                         "tos": {
                             "type": "integer",

tests/openwrt/test_network.py

@@ -1,6 +1,7 @@
 import unittest
 
 from netjsonconfig import OpenWrt
+from netjsonconfig.exceptions import ValidationError
 from netjsonconfig.utils import _TabsMixin
 
 
@@ -217,37 +218,28 @@ def test_render_rule_wrong(self):
                     "in": "eth0",
                     "out": "eth1",
                     "src": "wrong",
-                    "dest": "wrong",
+                    "dest": "wrong1",
                     "tos": 2,
-                    "action": "blackhole"
+                    "action": "blackhole",
                 }
             ]
         }
         o = OpenWrt(rule)
-        try:
+        with self.assertRaisesRegex(ValidationError, "'wrong' is not a 'cidr'"):
             o.validate()
-        except ValidationError as e:
-            # check error message
-            pass
-        else:
-            self.fail('ValidationError not raised')
-        # fix 'src' and expect wrong 'dest' to fail
-        rule['src'] = '192.168.1.1/24'
+        rule['ip_rules'][0]['src'] = '192.168.1.0/24'
         o = OpenWrt(rule)
-        try:
+        with self.assertRaisesRegexp(ValidationError, "'wrong1' is not a 'cidr'"):
             o.validate()
-        except ValidationError as e:
-            # check error message
-            pass
-        else:
-            self.fail('ValidationError not raised')
         # fix 'dest' and expect no ValidationError raised
-        rule['src'] = '192.168.1.1/24'
+        rule['ip_rules'][0]['dest'] = '192.168.1.0/24'
         o = OpenWrt(rule)
         o.validate()
 
     def test_parse_rules_zone(self):
-        o = OpenWrt(native="""package network
+        with self.assertRaisesRegexp(ValidationError, "'wrong' is not a 'cidr'"):
+            OpenWrt(
+                native="""package network
 
 config rule 'rule1'
     option action 'blackhole'
@@ -256,14 +248,8 @@ def test_parse_rules_zone(self):
     option out 'eth1'
     option src 'wrong'
     option tos '2'
-""")
-        try:
-            o.validate()
-        except ValidationError as e:
-            # check error message
-            pass
-        else:
-            self.fail('ValidationError not raised')
+"""
+            )
 
     _switch_netjson = {
         "switch": [