tdl-xoa-driver 1.2.0__tar.gz → 1.3.0__tar.gz

{tdl_xoa_driver-1.2.0/tdl_xoa_driver.egg-info → tdl_xoa_driver-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tdl-xoa-driver
-Version: 1.2.0
+Version: 1.3.0
 Summary: XOA Driver is a Python library providing user-friendly communication interfaces to Xena Traffic Generation test equipment. It provides a rich collection of programming interfaces that can be used to either write test scripts or develop applications.
 Home-page: https://github.com/xenanetworks/tdl-xoa-driver
 Author: Leonard Yu

{tdl_xoa_driver-1.2.0 → tdl_xoa_driver-1.3.0/tdl_xoa_driver.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tdl-xoa-driver
-Version: 1.2.0
+Version: 1.3.0
 Summary: XOA Driver is a Python library providing user-friendly communication interfaces to Xena Traffic Generation test equipment. It provides a rich collection of programming interfaces that can be used to either write test scripts or develop applications.
 Home-page: https://github.com/xenanetworks/tdl-xoa-driver
 Author: Leonard Yu

tdl_xoa_driver-1.3.0/xoa_driver/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "1.3.0"
+__short_version__ = "1.3"

{tdl_xoa_driver-1.2.0 → tdl_xoa_driver-1.3.0}/xoa_driver/enums.py

@@ -197,6 +197,7 @@ from .internals.commands.enums import (
     # MACSecVLANMode,
     ModifierEndianness,
     MACSecPNMode,
+    ModuleConfigStatus,
 )
 
 __all__ = (
@@ -396,4 +397,5 @@ __all__ = (
     # "MACSecVLANMode",
     "ModifierEndianness",
     "MACSecPNMode",
+    "ModuleConfigStatus",
 )

{tdl_xoa_driver-1.2.0 → tdl_xoa_driver-1.3.0}/xoa_driver/functions/exceptions.py

@@ -59,6 +59,12 @@ class NotSupportPortSpeed(ConfigError):
         self.msg = f"This module {module_id} does not support the port-speed configuration under its current media configuration!"
 
 
+class NotSupportMediaPortSpeed(ConfigError):
+    def __init__(self, module: GenericAnyModule) -> None:
+        module_id = module.module_id
+        self.msg = f"This module {module_id} does not support this module configuration!"
+
+
 __all__ = (
     "ConfigError",
     "NotConnectedError",
@@ -69,4 +75,5 @@ __all__ = (
     "NotSupportPcsPmaError",
     "NotSupportMedia",
     "NotSupportPortSpeed",
+    "NotSupportMediaPortSpeed",
 )

{tdl_xoa_driver-1.2.0 → tdl_xoa_driver-1.3.0}/xoa_driver/functions/mgmt.py

@@ -11,6 +11,7 @@ from xoa_driver.testers import GenericAnyTester, L23Tester
 from .exceptions import (
     NotSupportMedia,
     NotSupportPortSpeed,
+    NotSupportMediaPortSpeed,
 )
 from .tools import MODULE_EOL_INFO
 from itertools import chain  # type: ignore[Pylance false warning]
@@ -171,7 +172,7 @@ def get_module_supported_media(
     item = {}
 
     for media_item in module.info.media_info_list:  # type: ignore
-        for sub_item in media_item.available_speeds:
+        for sub_item in media_item.supported_configs:
             item = dict()
             item["media"] = media_item.cage_type
             item["port_count"] = sub_item.port_count
@@ -209,7 +210,8 @@ async def set_module_media_config(
     # set the module media if the target media is found in supported media
     for item in supported_media_list:
         if item["media"] == media:
-            await module.media.set(media_config=media)
+            await module.config.media.set(media_config=media)
+            await release_module(module, False)
             return None
 
     # raise exception is the target media is not found in the supported media
@@ -239,14 +241,13 @@ async def set_module_port_config(
     """
 
     # reserve the module first
-    await release_module(module, True)
     await reserve_module(module, force)
 
     # get the supported media by the module
     supported_media_list = get_module_supported_media(module)
 
     # get the current media of the module
-    reply = await module.media.get()
+    reply = await module.config.media.get()
     current_media = reply.media_config
 
     # set the module port speed if we can find the port-speed in the corresponding media
@@ -259,12 +260,57 @@ async def set_module_port_config(
             )
         ):
             portspeed_list = [port_count] + port_count * [port_speed]
-            await module.cfp.config.set(portspeed_list=portspeed_list)
+            await module.config.port_speed.set(portspeed_list=portspeed_list)
             await release_module(module, False)
             return None
     raise NotSupportPortSpeed(module)
 
 
+async def set_module_config(
+    module: t.Union[GenericL23Module, ModuleChimera],
+    media: enums.MediaConfigurationType,
+    port_count: int,
+    port_speed: int,
+    force: bool = True,
+) -> None:
+    """Change the module configuration to the target media, port count and port speed.
+
+    :param module: the module object
+    :type module: t.Union[GenericL23Module, ModuleChimera]
+    :param media: the target media for the module
+    :type media: enums.MediaConfigurationType
+    :param port_count: the target port count
+    :type port_count: int
+    :param port_speed: the target port speed in Mbps, e.g. 40000 for 40G
+    :type port_speed: int
+    :param force: should forcibly reserve the module, defaults to True
+    :type force: bool, optional
+    :raises NotSupportMediaPortSpeed: the provided media, port count and port speed configuration is not supported by the module
+    """
+
+    # reserve the module first
+    await reserve_module(module, force)
+
+    # get the supported media
+    supported_media_list = get_module_supported_media(module)
+
+    # set the module media if the target media is found in supported media
+    for item in supported_media_list:
+        if all(
+            (
+                item["media"] == media,
+                item["port_count"] == port_count,
+                item["port_speed"] == port_speed,
+            )
+        ):
+            portspeed_list = [port_count] + port_count * [port_speed]
+            await module.config.media.set(media_config=media)
+            await module.config.port_speed.set(portspeed_list=portspeed_list)
+            await release_module(module, False)
+            return None
+    raise NotSupportMediaPortSpeed(module)
+
+
 async def get_module_eol_date(module: GenericAnyModule) -> str:
     """
     Get module's End-of-Life date

{tdl_xoa_driver-1.2.0 → tdl_xoa_driver-1.3.0}/xoa_driver/internals/commands/enums.py

@@ -1064,7 +1064,10 @@ class MediaConfigurationType(IntEnum):
     """QSFP-DD, 25G serdes, L1/ANLT"""
 
     OSFP_NRZ_ANLT = 122
-    """OSFP, 25G serdes, L1/ANLT"""    
+    """OSFP, 25G serdes, L1/ANLT"""
+
+    QSFP28_NRZ_ANLT = 123
+    """QSFP28, 25G serdes, L1/ANLT"""
 
     UNKNOWN = 255
 
@@ -3177,6 +3180,12 @@ class ModuleModelName(IntEnum):
     Z_800_Q_FREYA   = 10
     Z_800_O_FREYA   = 11
     E_100_Q_CHIMERA = 12
+
+class ModuleConfigStatus(IntEnum):
+    UNKNOWN = 0
+    SUCCESS = 1
+    PROGRESSING = 2
+    FAILED = 3
     
 # endregion
 

{tdl_xoa_driver-1.2.0 → tdl_xoa_driver-1.3.0}/xoa_driver/internals/commands/m_commands.py

@@ -45,7 +45,8 @@ from .enums import (
     ImpairmentLatencyMode,
     PPMSweepStatus,
     PPMSweepMode,
-    ModuleModelName
+    ModuleModelName,
+    ModuleConfigStatus,
 )
 
 
@@ -1859,13 +1860,44 @@ class M_MODEL_NAME:
 
     class GetDataAttr(ResponseBodyStruct):
         name:  ModuleModelName = field(XmpInt())
-        """ModuleModelName, model name of the Xena module."""
+        """Module Model Name, model name of the Xena module."""
 
     def get(self) -> Token[GetDataAttr]:
         """Get the Xena chassis model name.
 
         :return: the model name of the Xena tester
-        :rtype: C_MODEL_NAME.GetDataAttr
+        :rtype: M_MODEL_NAME.GetDataAttr
         """
 
         return Token(self._connection, build_get_request(self, module=self._module))
+
+
+@register_command
+@dataclass
+class M_RECONFIG_STATUS:
+    """
+    Show the test module configuration status when the user has configured the test module to a different configuration than the one it is currently running. 
+    """
+
+    code: typing.ClassVar[int] = 399
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        status:  ModuleConfigStatus = field(XmpByte())
+        """Module configuration status."""
+
+        progress: int = field(XmpInt())
+        """Progress in units of 0.1%, i.e. valid range 0-1000. Increments are module-specific, the value may in some cases jump directly from 0 to 1000, or in other cases progress more smoothly.
+        """
+
+    def get(self) -> Token[GetDataAttr]:
+        """Show the test module configuration status when the user has configured the test module to a different configuration than the one it is currently running.
+
+        :return: the model name of the Xena tester
+        :rtype: M_RECONFIG_STATUS.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module))

{tdl_xoa_driver-1.2.0 → tdl_xoa_driver-1.3.0}/xoa_driver/internals/hli_v1/modules/module_chimera.py

@@ -23,6 +23,7 @@ from xoa_driver.internals.commands import (
     M_CFPCONFIGEXT,
     M_UPGRADEPAR,
     M_VERSIONSTR,
+    M_RECONFIG_STATUS,
 )
 
 from xoa_driver.internals.hli_v1 import revisions
@@ -71,13 +72,20 @@ class ChCFP:
 
         :type: M_CFPTYPE
         """
-        self.config = CfpModule(conn, module)
-        """
-        The CFP configuration of the test module.
 
-        :type: CfpModule
-        """
 
+class ChConfig:
+    """Configuration test module (Chimera)."""
+
+    def __init__(self, conn: "itf.IConnection", module: typing.Union["ModuleL23", "ModuleChimera"]) -> None:
+        self.media = MediaModule(conn, module)
+        """Test module's media type configuration."""
+
+        self.port_speed = CfpModule(conn, module)
+        """Test module's port speed configuration."""
+
+        self.status = M_RECONFIG_STATUS(conn, module.module_id)
+        """Test module's configuration status."""
 
 class ChUpgrade:
     """
@@ -220,13 +228,7 @@ class ModuleChimera(bm.BaseModule["modules_state.ModuleLocalState"]):
         :type: M_VERSIONSTR
         """
 
-        self.media = MediaModule(conn, self)
-        """Test module's media type.
-
-        :type: MediaModule
-        """
-
-        self.available_speeds = M_MEDIASUPPORT(conn, self.module_id)
+        self.supported_configs = M_MEDIASUPPORT(conn, self.module_id)
         """Test module's available speeds.
 
         :type: M_MEDIASUPPORT
@@ -238,6 +240,9 @@ class ModuleChimera(bm.BaseModule["modules_state.ModuleLocalState"]):
         :type: M_NAME
         """
 
+        self.config = ChConfig(conn, self)
+        """Test module's configuration."""
+
         self.ports: pm.PortsManager["ports.PortChimera"] = pm.PortsManager(
             conn=conn,
             ports_type=ports.PortChimera,

{tdl_xoa_driver-1.2.0 → tdl_xoa_driver-1.3.0}/xoa_driver/internals/hli_v1/modules/modules_l23/module_l23_base.py

@@ -29,6 +29,7 @@ from xoa_driver.internals.commands import (
     M_TXCLOCKFILTER_NEW,
     M_UPGRADEPAR,
     M_VERSIONSTR,
+    M_RECONFIG_STATUS,
 )
 
 from xoa_driver.internals.utils import attributes as utils
@@ -161,12 +162,20 @@ class CFP:
         :type: M_CFPTYPE
         """
 
-        self.config = CfpModule(conn, module)
-        """The CFP configuration of the test module.
 
-        :type: CfpModule
-        """
 
+class ModuleConfig:
+    """Test module CFP"""
+
+    def __init__(self, conn: "itf.IConnection", module: typing.Union["ModuleL23", "ModuleChimera"]) -> None:
+        self.media = MediaModule(conn, module)
+        """Test module's media type configuration."""
+
+        self.port_speed = CfpModule(conn, module)
+        """Test module's port speed configuration."""
+
+        self.status = M_RECONFIG_STATUS(conn, module.module_id)
+        """Test module's configuration status."""
 
 class MTiming:
     """Test module timing and clock configuration"""
@@ -249,13 +258,7 @@ class ModuleL23(bm.BaseModule["modules_state.ModuleL23LocalState"]):
         :type: M_STATUS
         """
 
-        self.media = MediaModule(conn, self)
-        """Test module's media type.
-
-        :type: ModuleMedia
-        """
-
-        self.available_speeds = M_MEDIASUPPORT(conn, self.module_id)
+        self.supported_configs = M_MEDIASUPPORT(conn, self.module_id)
         """Test module's available speeds.
 
         :type: M_MEDIASUPPORT
@@ -303,6 +306,9 @@ class ModuleL23(bm.BaseModule["modules_state.ModuleL23LocalState"]):
         :type: CFP
         """
 
+        self.config = ModuleConfig(conn, self)
+        """Test module's configuration."""
+
         self.upgrade = MUpgrade(conn, self.module_id)
         """Test module's upgrade settings.
 

{tdl_xoa_driver-1.2.0 → tdl_xoa_driver-1.3.0}/xoa_driver/internals/state_storage/modules_state.py

@@ -80,7 +80,7 @@ class MediaInfo:
     :rtype: MediaConfigurationType
     """
 
-    available_speeds: List["ModuleSpeed"] = field(default_factory=list)
+    supported_configs: List["ModuleSpeed"] = field(default_factory=list)
     """List of module's port-speed information
 
     :return: list of module's port-speed information

tdl_xoa_driver-1.2.0/xoa_driver/__init__.py

@@ -1,2 +0,0 @@
-__version__ = "1.2.0"
-__short_version__ = "1.2"