hil2.dut_cons

  1import json
  2
  3from . import hil_errors
  4
  5
  6# HIL DUT Connection ------------------------------------------------------------------#
  7class HilDutCon:
  8    """The HIL side of a DUT connection"""
  9
 10    def __init__(self, device: str, port: str):
 11        """
 12        :param device: The name of the HIL device (ex: 'RearTester')
 13        :param port: The port name on the HIL device (ex: 'DO7')
 14        """
 15        self.device: str = device
 16        self.port: str = port
 17
 18    @classmethod
 19    def from_json(cls, hil_dut_con: dict) -> "HilDutCon":
 20        """
 21        Create a HilDutCon instance from a JSON dictionary.
 22
 23        :param hil_dut_con: The JSON dictionary representing the HIL DUT connection
 24        :return: A HilDutCon instance
 25        """
 26        match hil_dut_con:
 27            case {"device": device, "port": port}:
 28                return cls(device, port)
 29            case _:
 30                error_msg = f"Invalid HIL DUT connection configuration: {hil_dut_con}"
 31                raise hil_errors.ConfigurationError(error_msg)
 32
 33
 34# Test DUT Connection -----------------------------------------------------------------#
 35class DutCon:
 36    """The tested side of a DUT connection"""
 37
 38    def __init__(self, connector: str, pin: int):
 39        """
 40        :param connector: The name of the DUT connector (ex: 'J3')
 41        :param pin: The pin number on the DUT connector (ex: 9)
 42        """
 43        self.connector: str = connector
 44        self.pin: int = pin
 45
 46    @classmethod
 47    def from_json(cls, dut_con: dict) -> "DutCon":
 48        """
 49        Create a DutCon instance from a JSON dictionary.
 50
 51        :param dut_con: The JSON dictionary representing the DUT connection
 52        :return: A DutCon instance
 53        """
 54        match dut_con:
 55            case {"connector": connector, "pin": pin}:
 56                return cls(connector, pin)
 57            case _:
 58                error_msg = f"Invalid DUT connection configuration: {dut_con}"
 59                raise hil_errors.ConfigurationError(error_msg)
 60
 61
 62# DUT Board Connections ---------------------------------------------------------------#
 63class DutBoardCons:
 64    def __init__(self, harness_connections: dict[DutCon, HilDutCon]):
 65        """
 66        :param harness_connections: A dictionary mapping DUT connections to HIL connections
 67        """
 68        self._harness_connections: dict[DutCon, HilDutCon] = harness_connections
 69
 70    @classmethod
 71    def from_json(cls, harness_connections: list[dict]) -> "DutBoardCons":
 72        """
 73        Create a DutBoardCons instance from a JSON dictionary.
 74
 75        :param harness_connections: A list of dictionaries representing the harness connections
 76        :return: A DutBoardCons instance
 77        """
 78        parsed_connections: dict[DutCon, HilDutCon] = {}
 79
 80        for con in harness_connections:
 81            match con:
 82                case {"dut": dut_con, "hil": hil_con}:
 83                    parsed_connections[DutCon.from_json(dut_con)] = HilDutCon.from_json(
 84                        hil_con
 85                    )
 86                case _:
 87                    error_msg = f"Invalid DUT board connection configuration: {con}"
 88                    raise hil_errors.ConfigurationError(error_msg)
 89
 90        return cls(parsed_connections)
 91
 92    def get_hil_device_connection(self, dut_con: DutCon) -> HilDutCon:
 93        """
 94        Get the HIL device connection for a given DUT connection.
 95
 96        :param dut_con: The DUT connection for which to retrieve the HIL device connection
 97        :return: The corresponding HIL device connection
 98        """
 99        if dut_con in self._harness_connections:
100            return self._harness_connections[dut_con]
101        else:
102            error_msg = (
103                "No HIL connection found for DUT connection: "
104                f"({dut_con.connector}, {dut_con.pin})"
105            )
106            raise hil_errors.ConnectionError(error_msg)
107
108
109# All DUT Connections -----------------------------------------------------------------#
110class DutCons:
111    def __init__(self, dut_connections: dict[str, DutBoardCons]):
112        """
113        :param dut_connections: A dictionary mapping DUT board names to their connections
114        """
115        self._dut_connections: dict[str, DutBoardCons] = dut_connections
116
117    @classmethod
118    def from_json(cls, test_config_path: str) -> "DutCons":
119        """
120        Create a DutCons instance from a JSON configuration file.
121
122        :param test_config_path: The path to the JSON configuration file
123        :return: A DutCons instance
124        """
125        with open(test_config_path, "r") as test_config_file:
126            test_config = json.load(test_config_file)
127
128        board_cons = {}
129        match test_config:
130            case {"dut_connections": dut_connections}:
131                for board_cons in dut_connections:
132                    ...
133                    match board_cons:
134                        case {
135                            "board": board,
136                            "harness_connections": harness_connections,
137                        }:
138                            board_cons[board] = DutBoardCons.from_json(
139                                harness_connections
140                            )
141                        case _:
142                            error_msg = (
143                                "Invalid DUT connections configuration: "
144                                f"{board_cons}"
145                            )
146                            raise hil_errors.ConfigurationError(error_msg)
147            case _:
148                # Not an error to have no DUT connections
149                pass
150
151        return cls(board_cons)
152
153    def get_hil_device_connection(self, board: str, dut_con: DutCon) -> HilDutCon:
154        """
155        Get the HIL device connection for a given DUT connection.
156
157        :param board: The name of the DUT board
158        :param dut_con: The DUT connection for which to retrieve the HIL device connection
159        :return: The corresponding HIL device connection
160        """
161        if board in self._dut_connections:
162            return self._dut_connections[board].get_hil_device_connection(dut_con)
163        else:
164            error_msg = f"No HIL connection found for DUT board: {board}"
165            raise hil_errors.ConnectionError(error_msg)