128 lines
4.4 KiB
Python
128 lines
4.4 KiB
Python
import json
|
|
import uuid
|
|
from datetime import datetime
|
|
from pathlib import Path
|
|
from typing import Optional, List, Any
|
|
|
|
# iottb modules
|
|
from iottb.definitions import ReturnCodes, DEVICE_METADATA_FILE
|
|
from iottb.logger import logger
|
|
# 3rd party libs
|
|
|
|
IMMUTABLE_FIELDS = {"device_name", "device_short_name", "device_id", "date_created"}
|
|
|
|
|
|
class DeviceMetadata:
|
|
# Required fields
|
|
device_name: str
|
|
device_short_name: str
|
|
device_id: str = lambda: str(uuid.uuid4())
|
|
date_created: str = lambda: datetime.now().strftime('%d-%m-%YT%H:%M:%S').lower()
|
|
|
|
device_root_path: Path
|
|
# Optional Fields
|
|
aliases: Optional[List[str]] = None
|
|
device_type: Optional[str] = None
|
|
device_serial_number: Optional[str] = None
|
|
device_firmware_version: Optional[str] = None
|
|
date_updated: Optional[str] = None
|
|
|
|
capture_files: Optional[List[str]] = []
|
|
|
|
def __init__(self, device_name: str, device_root_dir: Path):
|
|
self.device_name = device_name
|
|
self.device_short_name = device_name.lower().replace(" ", "_")
|
|
# assert dir_contains_device_metadata(device_root_dir), \
|
|
# f"Directory {device_root_dir} is missing a {DEVICE_METADATA_FILE} file"
|
|
self.device_root_dir = device_root_dir
|
|
logger.debug(f"Device name: {device_name}")
|
|
logger.debug(f"Device short_name: {self.device_short_name}")
|
|
logger.debug(f"Device root dir: {device_root_dir}")
|
|
logger.info(f"Initialized DeviceMetadata model: {device_name}")
|
|
|
|
def get_device_id(self) -> str:
|
|
return self.device_id
|
|
|
|
def get_device_name(self) -> str:
|
|
return self.device_name
|
|
|
|
def get_device_short_name(self) -> str:
|
|
return self.device_short_name
|
|
|
|
def get_device_type(self) -> str:
|
|
return self.device_type
|
|
|
|
def get_device_serial_number(self) -> str:
|
|
return self.device_serial_number
|
|
|
|
def get_device_firmware_version(self) -> str:
|
|
return self.device_firmware_version
|
|
|
|
def get_date_updated(self) -> str:
|
|
return self.date_updated
|
|
|
|
def get_capture_files(self) -> List[str]:
|
|
return self.capture_files
|
|
|
|
def get_aliases(self) -> List[str]:
|
|
return self.aliases
|
|
|
|
def set_device_type(self, device_type: str) -> None:
|
|
self.device_type = device_type
|
|
self.date_updated = datetime.now().strftime('%d-%m-%YT%H:%M:%S')
|
|
|
|
def set_device_serial_number(self, device_serial_number: str) -> None:
|
|
self.device_serial_number = device_serial_number
|
|
self.date_updated = datetime.now().strftime('%d-%m-%YT%H:%M:%S')
|
|
|
|
def set_device_firmware_version(self, device_firmware_version: str) -> None:
|
|
self.device_firmware_version = device_firmware_version
|
|
self.date_updated = datetime.now().strftime('%d-%m-%YT%H:%M:%S')
|
|
|
|
def set_device_name(self, device_name: str) -> None:
|
|
self.device_name = device_name
|
|
self.device_short_name = device_name.lower().replace(" ", "_")
|
|
self.date_updated = datetime.now().strftime('%d-%m-%YT%H:%M:%S')
|
|
|
|
@classmethod
|
|
def load_from_json(cls, device_file_path: Path):
|
|
logger.info(f"Loading DeviceMetadata from JSON file: {device_file_path}")
|
|
assert device_file_path.is_file(), f"{device_file_path} is not a file"
|
|
assert device_file_path.name == DEVICE_METADATA_FILE, f"{device_file_path} is not a {DEVICE_METADATA_FILE}"
|
|
device_meta_filename = device_file_path
|
|
|
|
with device_meta_filename.open('r') as file:
|
|
metadata_json = json.load(file)
|
|
metadata_model_obj = cls.model_validate_json(metadata_json)
|
|
return metadata_model_obj
|
|
|
|
def save_to_json(self, file_path: Path):
|
|
logger.info(f"Saving DeviceMetadata to JSON file: {file_path}")
|
|
if file_path.is_file():
|
|
print(f"File {file_path} already exists, update instead.")
|
|
return ReturnCodes.FILE_ALREADY_EXISTS
|
|
metadata = self.model_dump_json(indent=2)
|
|
with file_path.open('w') as file:
|
|
json.dump(metadata, file)
|
|
return ReturnCodes.SUCCESS
|
|
|
|
|
|
@classmethod
|
|
def model_validate_json(cls, metadata_json):
|
|
pass
|
|
|
|
def model_dump_json(self, indent):
|
|
pass
|
|
|
|
|
|
def dir_contains_device_metadata(dir_path: Path):
|
|
if not dir_path.is_dir():
|
|
return False
|
|
else:
|
|
meta_file_path = dir_path / DEVICE_METADATA_FILE
|
|
print(f"Device metadata file path {str(meta_file_path)}")
|
|
if not meta_file_path.is_file():
|
|
return False
|
|
else:
|
|
return True
|