Skip to content

Commit

Permalink
[sonic-device-data] Convert Python files to Python 3 (sonic-net#5816)
Browse files Browse the repository at this point in the history 
- Convert config_checker, media_checker and platform_json_checker scripts to Python 3
- Reorganize imports per PEP8 standard
- Two blank lines precede functions per PEP8 standard
  • Loading branch information
@jleveque @santhosh-kt
jleveque authored and santhosh-kt committed Feb 25, 2021
1 parent 006f01d commit 9faa4d3
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 59 deletions.
20 changes: 12 additions & 8 deletions src/sonic-device-data/tests/config_checker
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
#!/usr/bin/env python
#!/usr/bin/env python3

import glob
import re
import sys
import glob

permitted_properties = []


def usage():
print "Usage: " + sys.argv[0] + " <config_file>"
print("Usage: " + sys.argv[0] + " <config_file>")
sys.exit(1)

def check_property(p):

def check_property(p):
if p in permitted_properties:
return True
return False


def check_file(file_name):
try:
file_ok = True
Expand Down Expand Up @@ -58,14 +61,14 @@ def check_file(file_name):

if not check_property(p):
file_ok = False
print("[line %d] Error: %s is not permitted" % (lineno, p))
print("[line {}] Error: {} is not permitted".format(lineno, p))
if file_ok:
print "Result: " + file_name + " PASSED the config check!"
print("Result: " + file_name + " PASSED the config check!")
else:
print "Result: " + file_name + " FAILED the config check!"
print("Result: " + file_name + " FAILED the config check!")
return file_ok
except IOError:
print "Error: Cannot open file " + file_name
print("Error: Cannot open file " + file_name)
return False


Expand Down Expand Up @@ -93,5 +96,6 @@ def main(argv):
if not all_good:
sys.exit(-1)


if __name__ == "__main__":
main(sys.argv[1:])
52 changes: 30 additions & 22 deletions src/sonic-device-data/tests/media_checker
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
#!/usr/bin/env python
import re
import sys
#!/usr/bin/env python3

import glob
import json
import re
import sys

level1_keys = ["GLOBAL_MEDIA_SETTINGS","PORT_MEDIA_SETTINGS"]
setting_keys = ["preemphasis","idriver","ipredriver"]
lane_prefix = "lane"
comma_separator = ","
range_separator = "-"


def check_lane_and_value(lane_name, lane_value):
if lane_prefix in lane_name:
try:
Expand All @@ -18,30 +20,32 @@ def check_lane_and_value(lane_name, lane_value):
return True

except ValueError:
print "Invalid lane values " + lane_name + " " + lane_value
print("Invalid lane values " + lane_name + " " + lane_value)
return False

else:
return False


def usage():
print "Usage: " + sys.argv[0] + " <media_settings_file>"
print("Usage: " + sys.argv[0] + " <media_settings_file>")
sys.exit(1)


def check_media_dict(vendor_dict):
if len(vendor_dict) == 0:
print "Expecting values for media type " + keys
print("Expecting values for media type " + keys)
return False

for vendor_key in vendor_dict:
value_dict = vendor_dict[vendor_key]
if len(value_dict) == 0:
print "Expecting settings for vendor type " + vendor_key
print("Expecting settings for vendor type " + vendor_key)
return False

for value_key in value_dict:
if value_key not in setting_keys:
print "Unknown media setting " + value_key
print("Unknown media setting " + value_key)
return False

lane_dict = value_dict[value_key]
Expand All @@ -50,24 +54,27 @@ def check_media_dict(vendor_dict):
return False
return True


def check_valid_port(port_name):
try:
val = int(port_name.strip())
return True
except ValueError:
return False


def check_port_keys(port_media_dict):
for port in port_media_dict:

if not check_valid_port(port):
print "Invalid port name " + port
print("Invalid port name " + port)
return False

if not check_media_dict(port_media_dict[port]):
return False
return True


def check_global_keys(global_media_dict):
for keys in global_media_dict:
if comma_separator in keys:
Expand All @@ -77,22 +84,22 @@ def check_global_keys(global_media_dict):
range_list = port.split(range_separator)
for port_val in range_list:
if not check_valid_port(port_val):
print "Error: Unrecognized port number " + port_val
print "Invalid range " + port
print("Error: Unrecognized port number " + port_val)
print("Invalid range " + port)
return False
else:
if not check_valid_port(port):
print "Error: Unrecognized portname " + port
print("Error: Unrecognized portname " + port)
return False
elif range_separator in keys:
range_list = keys.split(range_separator)
for port_val in range_list:
if not check_valid_port(port_val):
print "Error: Unrecognized portname " + port_val
print "Invalid range " + keys
print("Error: Unrecognized portname " + port_val)
print("Invalid range " + keys)
return False
else:
print "Invalid range " + keys
print("Invalid range " + keys)
return False

if not check_media_dict(global_media_dict[keys]):
Expand All @@ -110,7 +117,7 @@ def check_file(media_settings_file):

for key_l1 in media_dict:
if key_l1 not in level1_keys:
print "Error: Unknown key " + key_l1 + " at top level"
print("Error: Unknown key " + key_l1 + " at top level")
return False
if "GLOBAL_MEDIA_SETTINGS" in media_dict:
if not check_global_keys(media_dict["GLOBAL_MEDIA_SETTINGS"]):
Expand All @@ -121,11 +128,11 @@ def check_file(media_settings_file):


except IOError:
print "Error: Cannot open file " + media_settings_file
print("Error: Cannot open file " + media_settings_file)
return False
except ValueError,e:
print "Error in parsing json file " + media_settings_file + " "
print str(e)
except ValueError as e:
print("Error in parsing json file " + media_settings_file + " ")
print(str(e))
return False

return True
Expand All @@ -146,14 +153,15 @@ def main(argv):
for f in files:
good = check_file(f)
if good:
print "File " + f + " passed validity check"
print("File " + f + " passed validity check")
else:
print "File " + f + " failed validity check"
print("File " + f + " failed validity check")

all_good = all_good and good

if not all_good:
sys.exit(-1)


if __name__ == "__main__":
main(sys.argv[1:])
54 changes: 25 additions & 29 deletions src/sonic-device-data/tests/platform_json_checker
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
#!/usr/bin/env python
try:
import re
import sys
import glob
import json
except ImportError as e:
raise ImportError (str(e) + "- required module not found")

# TODO: need to remove basestring once migrate to Python 3 and just change to str
try:
basestring
except NameError:
basestring = str
#!/usr/bin/env python3

import glob
import json
import re
import sys

# Global variable
PORT_ATTRIBUTES = ["index", "lanes", "alias_at_lanes", "breakout_modes"]
Expand All @@ -20,24 +12,26 @@ PORT_REG = "Ethernet(\d+)"
PLATFORM_JSON = '*platform.json'
INTF_KEY = "interfaces"


def usage():
print "Usage: " + sys.argv[0] + " <platform_json_file>"
print("Usage: " + sys.argv[0] + " <platform_json_file>")
sys.exit(1)


def check_port_attr(port_attr):
for each_key in port_attr:
if each_key not in PORT_ATTRIBUTES:
print "Error: "+ each_key + " is not the correct Port attribute."
print("Error: "+ each_key + " is not the correct Port attribute.")
return False
if not port_attr[each_key]:
print "Error: "+ each_key + " has no value."
print("Error: "+ each_key + " has no value.")
return False
# TODO: need to remove basestring once migrate to Python 3 and just change to str
if not isinstance(port_attr[each_key], basestring):
print "Error:value type of "+ each_key + " must be string."
if not isinstance(port_attr[each_key], str):
print("Error:value type of "+ each_key + " must be string.")
return False
return True


def check_file(platform_json_file):
try:
platform_cap_file = open(platform_json_file,"r")
Expand All @@ -48,29 +42,30 @@ def check_file(platform_json_file):
# Validate port at top level
port_id = re.search(PORT_REG, each_port)
if port_id is None:
print "Error: Unknown Interface " + str(each_port) + " at top level"
print("Error: Unknown Interface " + str(each_port) + " at top level")
return False

total_attr = len(port_dict[INTF_KEY][each_port].keys())
total_attr = len(list(port_dict[INTF_KEY][each_port].keys()))
port_attr = port_dict[INTF_KEY][each_port]

if total_attr != ATTR_LEN:
missing_attr = ', '.join(set(PORT_ATTRIBUTES).difference(list(port_attr)))
print "Error: " + missing_attr + " of " + each_port + " is/are missing"
print("Error: " + missing_attr + " of " + each_port + " is/are missing")
return False

#Validate port attributes for each port
if not check_port_attr(port_attr):
return False
except IOError:
print "Error: Cannot open file " + platform_json_file
print("Error: Cannot open file " + platform_json_file)
return False
except ValueError,e:
print "Error in parsing json file " + platform_json_file + " "
print str(e)
except ValueError as e:
print("Error in parsing json file " + platform_json_file + " ")
print(str(e))
return False
return True


def main(argv):
if len(argv) > 0 and argv[0] == "-h":
usage()
Expand All @@ -86,14 +81,15 @@ def main(argv):
for f in files:
good = check_file(f)
if good:
print "File " + f + " passed validity check"
print("File " + f + " passed validity check")
else:
print "File " + f + " failed validity check"
print("File " + f + " failed validity check")

all_good = all_good and good

if not all_good:
sys.exit(-1)


if __name__ == "__main__":
main(sys.argv[1:])

0 comments on commit 9faa4d3

Please sign in to comment.