extern/devicetype-library
1
0
Fork 0
mirror of https://github.com/netbox-community/devicetype-library.git synced 2025-08-08 22:54:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updating comments and error messages for better readability and validation (#1457)

Browse Source
This commit is contained in:
Daniel W. Anner
2023-07-14 15:38:14 -04:00
committed by GitHub
parent de70c1edde
commit 4ac4c79ab1
2 changed files with 19 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
tests/device_types.py
View File

@ -17,9 +17,6 @@ class DeviceType:
self._slug_part_number = self._slugify_part_number()
self.failureMessage = None
def get_manufacturer(self):
return self.manufacturer
def _slugify_manufacturer(self):
return self.manufacturer.casefold().replace(" ", "-").replace("sfp+", "sfpp").replace("poe+", "poep").replace("-+", "-plus-").replace("+", "-plus").replace("_", "-").replace("!", "").replace("/", "-").replace(",", "").replace("'", "").replace("*", "-").replace("&", "and")
@ -28,18 +25,12 @@ class DeviceType:
return self.slug
return None
def get_model(self):
return self.model
def _slugify_model(self):
slugified = self.model.casefold().replace(" ", "-").replace("sfp+", "sfpp").replace("poe+", "poep").replace("-+", "-plus").replace("+", "-plus-").replace("_", "-").replace("&", "-and-").replace("!", "").replace("/", "-").replace(",", "").replace("'", "").replace("*", "-")
if slugified.endswith("-"):
slugified = slugified[:-1]
return slugified
def get_part_number(self):
return self.part_number
def _slugify_part_number(self):
slugified = self.part_number.casefold().replace(" ", "-").replace("-+", "-plus").replace("+", "-plus-").replace("_", "-").replace("&", "-and-").replace("!", "").replace("/", "-").replace(",", "").replace("'", "").replace("*", "-")
if slugified.endswith("-"):
@ -52,17 +43,17 @@ class DeviceType:
def verify_slug(self):
# Verify the slug is unique, and not already known
if self.slug in KNOWN_SLUGS:
self.failureMessage = f'{self.file_path} device type has duplicate slug "{self.slug}"'
self.failureMessage = f'{self.file_path} has a duplicate slug "{self.slug}"'
return False
# Verify the manufacturer is appended to the slug
if not self.slug.startswith(self._slug_manufacturer):
self.failureMessage = f'{self.file_path} device type has slug "{self.slug}" which does not start with manufacturer "{self.manufacturer}"'
self.failureMessage = f'{self.file_path} contains slug "{self.slug}". Does not start with manufacturer: "{self.manufacturer.casefold()}-"'
return False
# Verify the slug ends with either the model or part number
if not (self.slug.endswith(self._slug_model) or self.slug.endswith(self._slug_part_number)):
self.failureMessage = f'{self.file_path} has slug "{self.slug}". Does not end with the model "{self._slug_model}" or part number "{self._slug_part_number}"'
self.failureMessage = f'{self.file_path} has slug "{self.slug}". Does not end with the model "{self._slug_model}" or part_number "{self._slug_part_number}"'
return False
# Add the slug to the list of known slugs
@ -82,9 +73,6 @@ class ModuleType:
self.part_number = definition.get('part_number', "")
self._slug_part_number = self._slugify_part_number()
def get_manufacturer(self):
return self.manufacturer
def get_filepath(self):
return self.file_path
@ -105,7 +93,7 @@ def verify_filename(device: (DeviceType or ModuleType)):
filename = tail.rsplit(".", 1)[0].casefold()
if not (filename == device._slug_model or filename == device._slug_part_number or filename == device.part_number.casefold()):
device.failureMessage = f'{device.file_path} file is not either the model "{device._slug_model}" or part_number "{device.part_number} / {device._slug_part_number}"'
device.failureMessage = f'{device.file_path} file name is invalid. Must be either the model "{device._slug_model}" or part_number "{device.part_number} / {device._slug_part_number}"'
return False
return True