make improvement about util/check_valid.py

Change-Id: Ib1f22eb180e6df138b5891ef5ca070224ace219e
Signed-off-by: Harry Huang <huangxiangyu5@huawei.com>

diff --git a/util/check_valid.py b/util/check_valid.py
index ad5437f..87cd57e 100644 (file)
--- a/util/check_valid.py
+++ b/util/check_valid.py
@@ -5,7 +5,7 @@ import sys
 import traceback
 
 
-def init(file):
+def load_file(file):
     with open(file) as fd:
         try:
             return yaml.load(fd)
@@ -18,7 +18,10 @@ def err_print(info):
     print '\033[0;31m%s\033[0m' % info
 
 
-def check_ip(ip):
+def is_valid_ip(ip):
+    """return True if the given string is a well-formed IP address
+       currently only support IPv4
+    """
     if not ip:
         return False
     res = re.search(
@@ -27,52 +30,94 @@ def check_ip(ip):
     return res
 
 
-def check_mac(mac):
+def is_valid_mac(mac):
+    """return True if the given string is a well-formed MAC address
+    """
     if not mac:
         return False
     res = re.search("^([a-zA-Z0-9]{2}:){5}[a-zA-Z0-9]{2}$", mac) is not None
     return res
 
 
-def check_network(network):
-    for i in network.get('ip_settings'):
-        if not (check_ip(i['cidr']) and check_ip(
-                i['ip_ranges'][0][0]) and check_ip(i['ip_ranges'][0][1])):
-            return False
-        if i['name'] == 'external' and not check_ip(i['gw']):
-            return False
-
-    if not check_ip(network['internal_vip']['ip']):
-        return False
-
-    if not check_ip(network['public_vip']['ip']):
-        return False
-
-    if not check_ip(network['public_net_info']['external_gw']):
-        return False
-
-    if not check_ip(network['public_net_info']['floating_ip_cidr']):
-        return False
-
-    if not check_ip(network['public_net_info']['floating_ip_start']):
-        return False
-
-    if not check_ip(network['public_net_info']['floating_ip_end']):
+def check_network_file(network):
+    invalid = False
+    for i in network['ip_settings']:
+        if not is_valid_ip(i['cidr']):
+            err_print('''invalid address:
+                ip_settings:
+                  - name: %s
+                    cidr: %s''' % (i['name'], i['cidr']))
+            invalid = True
+        if not is_valid_ip(i['ip_ranges'][0][0]):
+            err_print('''invalid address:
+                ip_settings:
+                  - name: %s
+                    ip_ranges:
+                    - - %s''' % (i['name'], i['ip_ranges'][0][0]))
+            invalid = True
+        if not is_valid_ip(i['ip_ranges'][0][1]):
+            err_print('''invalid address:
+                ip_settings:
+                  - name: %s
+                    ip_ranges:
+                    - %s''' % (i['name'], i['ip_ranges'][0][1]))
+            invalid = True
+        if i['name'] == 'external' and not is_valid_ip(i['gw']):
+            err_print(i['gw'])
+            err_print('''invalid address:
+                ip_settings:
+                  - name: %s
+                    gw: %s''' % (i['name'], i['gw']))
+            invalid = True
+
+    for i in network['public_net_info'].keys():
+        if i in ('external_gw', 'floating_ip_cidr',
+                 'floating_ip_start', 'floating_ip_end'):
+            if not is_valid_ip(network['public_net_info'][i]):
+                err_print('''invalid address:
+                public_net_info:
+                  %s: %s''' % (i, network['public_net_info'][i]))
+                invalid = True
+
+    if not invalid:
+        return True
+    else:
         return False
 
-    return True
 
-
-def check_dha(dha):
+def check_dha_file(dha):
+    invalid = False
     if dha['TYPE'] == 'baremetal':
         for i in dha['hosts']:
-            if not (check_mac(i['mac']) and check_mac(
-                    i['interfaces'][0]['eth1']) and check_ip(i['ipmiIp'])):
-                return False
-    return True
+            if not is_valid_mac(i['mac']):
+                err_print('''invalid address:
+                hosts:
+                 - name: %s
+                   mac: %s''' % (i['name'], i['mac']))
+                invalid = True
+            for j in i['interfaces']:
+                if not is_valid_mac(j.values()[0]):
+                    err_print('''invalid address:
+                    hosts:
+                        - name: %s
+                          interfaces:
+                            - %s: %s''' % (i['name'], j.keys()[0], j.values()[0]))
+                    invalid = True
+            if not is_valid_ip(i['ipmiIp']):
+                err_print('''invalid address:
+                hosts:
+                 - name: %s
+                   ipmiIp: %s''' % (i['name'], i['ipmiIp']))
+                invalid = True
+
+    if not invalid:
+        return True
+    else:
+        return False
 
 if __name__ == "__main__":
-    flag = 0
+
+    has_invalid = False
 
     if len(sys.argv) != 3:
         err_print('input file error')
@@ -81,26 +126,30 @@ if __name__ == "__main__":
     _, dha_file, network_file = sys.argv
 
     if not os.path.exists(dha_file):
+        err_print("DHA file doesn't exit")
         sys.exit(1)
     else:
-        dha = init(dha_file)
+        dha = load_file(dha_file)
         if not dha:
-            err_print('format error in DHA')
+            err_print('format error in DHA: %s' % dha_file)
+            has_invalid = True
         else:
-            if not check_dha(dha):
-                err_print('invalid address in DHA')
-                flag = 1
+            if not check_dha_file(dha):
+                err_print('in DHA: %s' % dha_file)
+                has_invalid = True
 
     if not os.path.exists(network_file):
+        err_print("NETWORK file doesn't exit")
         sys.exit(1)
     else:
-        network = init(network_file)
+        network = load_file(network_file)
         if not network:
-            err_print('format error in NETWORK')
+            err_print('format error in NETWORK: %s' % network_file)
+            has_invalid = True
         else:
-            if not check_network(network):
-                err_print('invalid address in NETWORK')
-                flag = 1
+            if not check_network_file(network):
+                err_print('in NETWORK: %s' % network_file)
+                has_invalid = True
 
-    if flag == 1:
+    if has_invalid:
         sys.exit(1)