python-ipmi 0.5.7__tar.gz → 0.5.8__tar.gz

{python_ipmi-0.5.7/python_ipmi.egg-info → python_ipmi-0.5.8}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-ipmi
-Version: 0.5.7
+Version: 0.5.8
 Summary: Pure python IPMI library
 Home-page: https://github.com/kontron/python-ipmi
-Download-URL: https://github.com/kontron/python-ipmi/tarball/0.5.7
+Download-URL: https://github.com/kontron/python-ipmi/tarball/0.5.8
 Author: Michael Walle, Heiko Thiery
 Author-email: michael.walle@kontron.com, heiko.thiery@kontron.com
 License: LGPLv2+
@@ -24,6 +24,16 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 License-File: COPYING
 License-File: AUTHORS
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: summary
 
 Pure Python IPMI Library
 ========================

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/__init__.py

@@ -48,11 +48,7 @@ except ImportError:
 def create_connection(interface):
     session = Session()
     session.interface = interface
-    ipmi = Ipmi()
-    ipmi.interface = interface
-    ipmi.session = session
-    ipmi.requester = NullRequester()
-    return ipmi
+    return Ipmi(interface=interface, session=session)
 
 
 class Requester(object):
@@ -164,14 +160,41 @@ class Ipmi(bmc.Bmc, chassis.Chassis, dcmi.Dcmi, fru.Fru, picmg.Picmg, hpm.Hpm,
            sdr.Sdr, sensor.Sensor, event.Event, sel.Sel, lan.Lan,
            messaging.Messaging):
 
-    def __init__(self):
-        self._interface = None
-        self._session = None
-        self._target = None
+    def __init__(self, interface=None, target=None, session=Session(),
+                 requester=NullRequester()):
+        self._interface = interface
+
+        # we need a session, set if not passed
+        if session is None:
+            session = Session()
+        self._session = session
+        # session needs an interface
+        self._session.interface = interface
+
+        self._target = target
+        self.requester = requester
 
         for base in Ipmi.__bases__:
             base.__init__(self)
 
+    def __enter__(self):
+        self.open()
+        return self
+
+    def __exit__(self, exception_type, exception_value, traceback):
+        self.close()
+        return False
+
+    def open(self):
+        self.interface.open()
+        if self.session is not None:
+            self.session.establish()
+
+    def close(self):
+        if self.session is not None:
+            self.session.close()
+        self.interface.close()
+
     def is_ipmc_accessible(self):
         return self.interface.is_ipmc_accessible(self.target)
 

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/bmc.py

@@ -89,7 +89,7 @@ class Watchdog(State):
     TIMEOUT_ACTION_POWER_CYCLE = 3
 
     __properties__ = [
-        # (propery, description)
+        # (property, description)
         ('timer_use', ''),
         ('dont_stop', ''),
         ('is_running', ''),

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/errors.py

@@ -69,7 +69,7 @@ class DescriptionError(Exception):
 
 
 class RetryError(Exception):
-    """Maxium number of retries exceeded."""
+    """Maximum number of retries exceeded."""
     pass
 
 
@@ -90,3 +90,21 @@ class IpmiConnectionError(Exception):
 
     def __str__(self):
         return "{}".format(self.msg)
+
+
+class IpmiLongPasswordError(Exception):
+    """Password longer than 20 bytes."""
+    def __init__(self, msg=None):
+        self.msg = msg
+
+    def __str__(self):
+        return "{}".format(self.msg)
+
+
+class AuthenticationError(Exception):
+    """Authentication error."""
+    def __init__(self, msg=None):
+        self.msg = msg
+
+    def __str__(self):
+        return "{}".format(self.msg)

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/fields.py

@@ -64,7 +64,7 @@ def _unpack6bitascii(data):
 
 class TypeLengthString(object):
     """
-    This is the TYPE/LENGTH BYTE FORMAT field represenation according the
+    This is the TYPE/LENGTH BYTE FORMAT field representation according the
     Platform Management FRU Information Storage Definition v1.0.
 
     In addition the difference to the 'FRU Information Storage Definition' to

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/fru.py

@@ -88,9 +88,9 @@ class Fru(object):
     def read_fru_data_full(self, fru_id=0):
         return self.read_fru_data(fru_id=fru_id)
 
-    def get_fru_inventory_header(self, fru_id=0):
+    def get_fru_inventory_header(self, fru_id=0, ignore_checksum=False):
         data = self.read_fru_data(offset=0, count=8, fru_id=fru_id)
-        return InventoryCommonHeader(data)
+        return InventoryCommonHeader(data, ignore_checksum=ignore_checksum)
 
     def _read_fru_area(self, offset, fru_id=0):
         # read the area header
@@ -99,26 +99,30 @@ class Fru(object):
         count = data[1] * 8
         return self.read_fru_data(offset=offset, count=count, fru_id=fru_id)
 
-    def get_fru_chassis_area(self, fru_id=0):
-        header = self.get_fru_inventory_header(fru_id=fru_id)
+    def get_fru_chassis_area(self, fru_id=0, ignore_checksum=False):
+        header = self.get_fru_inventory_header(fru_id=fru_id,
+                                               ignore_checksum=ignore_checksum)
         data = self._read_fru_area(offset=header.chassis_info_area_offset,
                                    fru_id=fru_id)
-        return InventoryChassisInfoArea(data)
+        return InventoryChassisInfoArea(data, ignore_checksum=ignore_checksum)
 
-    def get_fru_board_area(self, fru_id=0):
-        header = self.get_fru_inventory_header(fru_id=fru_id)
+    def get_fru_board_area(self, fru_id=0, ignore_checksum=False):
+        header = self.get_fru_inventory_header(fru_id=fru_id,
+                                               ignore_checksum=ignore_checksum)
         data = self._read_fru_area(offset=header.board_info_area_offset,
                                    fru_id=fru_id)
-        return InventoryBoardInfoArea(data)
+        return InventoryBoardInfoArea(data, ignore_checksum=ignore_checksum)
 
-    def get_fru_product_area(self, fru_id=0):
-        header = self.get_fru_inventory_header(fru_id=fru_id)
+    def get_fru_product_area(self, fru_id=0, ignore_checksum=False):
+        header = self.get_fru_inventory_header(fru_id=fru_id,
+                                               ignore_checksum=ignore_checksum)
         data = self._read_fru_area(offset=header.product_info_area_offset,
                                    fru_id=fru_id)
-        return InventoryProductInfoArea(data)
+        return InventoryProductInfoArea(data, ignore_checksum=ignore_checksum)
 
-    def get_fru_multirecord_area(self, fru_id=0):
-        header = self.get_fru_inventory_header(fru_id=fru_id)
+    def get_fru_multirecord_area(self, fru_id=0, ignore_checksum=False):
+        header = self.get_fru_inventory_header(fru_id=fru_id,
+                                               ignore_checksum=ignore_checksum)
 
         # we have to determine the length of the area first
         offset = header.multirecord_area_offset
@@ -137,31 +141,47 @@ class Fru(object):
         # now read the full area
         offset = header.multirecord_area_offset
         data = self.read_fru_data(offset=offset, count=count)
-        return InventoryMultiRecordArea(data)
+        return InventoryMultiRecordArea(data, ignore_checksum=ignore_checksum)
 
-    def get_fru_inventory(self, fru_id=0):
+    def get_fru_inventory(self, fru_id=0, ignore_checksum=False):
         """
         Get the full parsed FRU inventory data.
         """
         fru = FruInventory()
-        header = self.get_fru_inventory_header(fru_id=fru_id)
+
+        header = self.get_fru_inventory_header(
+            fru_id=fru_id,
+            ignore_checksum=ignore_checksum
+        )
 
         if header.chassis_info_area_offset:
-            fru.chassis_info_area = self.get_fru_chassis_area(fru_id=fru_id)
+            fru.chassis_info_area = self.get_fru_chassis_area(
+                fru_id=fru_id,
+                ignore_checksum=ignore_checksum
+            )
 
         if header.board_info_area_offset:
-            fru.board_info_area = self.get_fru_board_area(fru_id=fru_id)
+            fru.board_info_area = self.get_fru_board_area(
+                fru_id=fru_id,
+                ignore_checksum=ignore_checksum
+            )
 
         if header.product_info_area_offset:
-            fru.product_info_area = self.get_fru_product_area(fru_id=fru_id)
+            fru.product_info_area = self.get_fru_product_area(
+                fru_id=fru_id,
+                ignore_checksum=ignore_checksum
+            )
 
         if header.multirecord_area_offset:
-            fru.multirecord_area = self.get_fru_multirecord_area(fru_id=fru_id)
+            fru.multirecord_area = self.get_fru_multirecord_area(
+                fru_id=fru_id,
+                ignore_checksum=ignore_checksum
+            )
 
         return fru
 
 
-def get_fru_inventory_from_file(filename):
+def get_fru_inventory_from_file(filename, ignore_checksum=False):
     try:
         file = open(filename, "rb")
     except IOError:
@@ -173,7 +193,7 @@ def get_fru_inventory_from_file(filename):
     file_data = file.read(file_size)
     data = array.array('B', file_data)
     file.close()
-    return FruInventory(data)
+    return FruInventory(data, ignore_checksum=ignore_checksum)
 
 
 CUSTOM_FIELD_END = 0xc1
@@ -190,18 +210,18 @@ def _decode_custom_fields(data):
 
 
 class FruData(object):
-    def __init__(self, data=None):
+    def __init__(self, data=None, ignore_checksum=False):
         if data:
             if isinstance(data, str):
                 data = [ord(c) for c in data]
             self.data = data
             if hasattr(self, '_from_data'):
-                self._from_data(data)
+                self._from_data(data, ignore_checksum=ignore_checksum)
 
 
 class InventoryCommonHeader(FruData):
-    def _from_data(self, data):
-        if len(data) != 8:
+    def _from_data(self, data, ignore_checksum=False):
+        if len(data) < 8:
             raise DecodingError('InventoryCommonHeader length != 8')
         self.format_version = data[0] & 0x0f
         self.internal_use_area_offset = data[1] * 8 or None
@@ -209,18 +229,18 @@ class InventoryCommonHeader(FruData):
         self.board_info_area_offset = data[3] * 8 or None
         self.product_info_area_offset = data[4] * 8 or None
         self.multirecord_area_offset = data[5] * 8 or None
-        if sum(data) % 256 != 0:
-            raise DecodingError('InventoryCommonHeader checksum failed')
+        if sum(data[:8]) % 256 != 0 and ignore_checksum is False:
+            raise DecodingError(f'InventoryCommonHeader checksum failed {sum(data) % 0x10}')
 
 
 class CommonInfoArea(FruData):
-    def _from_data(self, data):
+    def _from_data(self, data, ignore_checksum=False):
         self.format_version = data[0] & 0x0f
         if self.format_version != 1:
             raise DecodingError('unsupported format version (%d)' %
                                 self.format_version)
         self.length = data[1] * 8
-        if sum(data[:self.length]) % 256 != 0:
+        if sum(data[:self.length]) % 256 != 0 and ignore_checksum is False:
             raise DecodingError('checksum failed')
 
 
@@ -249,7 +269,7 @@ class InventoryChassisInfoArea(CommonInfoArea):
     TYPE_RAID_CHASSIS = 22
     TYPE_RACK_MOUNT_CHASSIS = 23
 
-    def _from_data(self, data):
+    def _from_data(self, data, ignore_checksum=False):
         CommonInfoArea._from_data(self, data)
         self.type = data[2]
         offset = 3
@@ -261,8 +281,8 @@ class InventoryChassisInfoArea(CommonInfoArea):
 
 
 class InventoryBoardInfoArea(CommonInfoArea):
-    def _from_data(self, data):
-        CommonInfoArea._from_data(self, data)
+    def _from_data(self, data, ignore_checksum=False):
+        CommonInfoArea._from_data(self, data, ignore_checksum=ignore_checksum)
         self.language_code = data[2]
         minutes = data[5] << 16 | data[4] << 8 | data[3]
         self.mfg_date = (datetime.datetime(1996, 1, 1)
@@ -282,7 +302,7 @@ class InventoryBoardInfoArea(CommonInfoArea):
 
 
 class InventoryProductInfoArea(CommonInfoArea):
-    def _from_data(self, data):
+    def _from_data(self, data, ignore_checksum=False):
         CommonInfoArea._from_data(self, data)
         self.language_code = data[2]
         offset = 3
@@ -318,17 +338,17 @@ class FruDataMultiRecord(FruData):
         return '%02x: %s' % (self.record_type_id,
                              ' '.join('%02x' % b for b in self.raw))
 
-    def _from_data(self, data):
+    def _from_data(self, data, ignore_checksum=False):
         if len(data) < 5:
             raise DecodingError('data too short')
         self.record_type_id = data[0]
         self.format_version = data[1] & 0x0f
         self.end_of_list = bool(data[1] & 0x80)
         self.length = data[2]
-        if sum(data[:5]) % 256 != 0:
+        if sum(data[:5]) % 256 != 0 and ignore_checksum is False:
             raise DecodingError('FruDataMultiRecord header checksum failed')
         self.raw = data[5:5+self.length]
-        if (sum(self.raw) + data[3]) % 256 != 0:
+        if (sum(self.raw) + data[3]) % 256 != 0 and ignore_checksum is False:
             raise DecodingError('FruDataMultiRecord record checksum failed')
 
     @staticmethod
@@ -386,11 +406,11 @@ class FruPicmgRecord(FruDataMultiRecord):
 
         return FruPicmgRecord(data)
 
-    def _from_data(self, data):
+    def _from_data(self, data, ignore_checksum=False):
         if len(data) < 10:
             raise DecodingError('data too short')
         data = array.array('B', data)
-        FruDataMultiRecord._from_data(self, data)
+        FruDataMultiRecord._from_data(self, data, ignore_checksum=ignore_checksum)
         self.manufacturer_id = \
             data[5] | data[6] << 8 | data[7] << 16
         self.picmg_record_type_id = data[8]
@@ -398,7 +418,7 @@ class FruPicmgRecord(FruDataMultiRecord):
 
 
 class FruPicmgPowerModuleCapabilityRecord(FruPicmgRecord):
-    def _from_data(self, data):
+    def _from_data(self, data, ignore_checksum=False):
         if len(data) < 12:
             raise DecodingError('data too short')
         FruPicmgRecord._from_data(self, data)
@@ -407,11 +427,11 @@ class FruPicmgPowerModuleCapabilityRecord(FruPicmgRecord):
 
 
 class InventoryMultiRecordArea(object):
-    def __init__(self, data):
+    def __init__(self, data, ignore_checksum=False):
         if data:
             self._from_data(data)
 
-    def _from_data(self, data):
+    def _from_data(self, data, ignore_checksum=False):
         self.records = list()
         offset = 0
         while True:
@@ -423,31 +443,35 @@ class InventoryMultiRecordArea(object):
 
 
 class FruInventory(object):
-    def __init__(self, data=None):
+    def __init__(self, data=None, ignore_checksum=False):
         self.chassis_info_area = None
         self.board_info_area = None
         self.product_info_area = None
         self.multirecord_area = None
 
         if data:
-            self._from_data(data)
+            self._from_data(data, ignore_checksum=ignore_checksum)
 
-    def _from_data(self, data):
+    def _from_data(self, data, ignore_checksum=False):
         self.raw = data
         self.common_header = InventoryCommonHeader(data[:8])
 
         if self.common_header.chassis_info_area_offset:
             self.chassis_info_area = InventoryChassisInfoArea(
-                data[self.common_header.chassis_info_area_offset:])
+                data[self.common_header.chassis_info_area_offset:],
+                ignore_checksum=ignore_checksum)
 
         if self.common_header.board_info_area_offset:
             self.board_info_area = InventoryBoardInfoArea(
-                data[self.common_header.board_info_area_offset:])
+                data[self.common_header.board_info_area_offset:],
+                ignore_checksum=ignore_checksum)
 
         if self.common_header.product_info_area_offset:
             self.product_info_area = InventoryProductInfoArea(
-                data[self.common_header.product_info_area_offset:])
+                data[self.common_header.product_info_area_offset:],
+                ignore_checksum=ignore_checksum)
 
         if self.common_header.multirecord_area_offset:
             self.multirecord_area = InventoryMultiRecordArea(
-                data[self.common_header.multirecord_area_offset:])
+                data[self.common_header.multirecord_area_offset:],
+                ignore_checksum=ignore_checksum)

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/helper.py

@@ -85,7 +85,7 @@ def get_sdr_data_helper(reserve_fn, get_fn, record_id, reservation_id=None):
             (next_id, data) = get_fn(reservation_id, record_id, offset, length)
         except CompletionCodeError as e:
             if e.cc == constants.CC_CANT_RET_NUM_REQ_BYTES:
-                # reduce max lenght
+                # reduce max length
                 max_req_len -= 4
                 if max_req_len <= 0:
                     retry = 0

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/hpm.py

@@ -314,7 +314,7 @@ class Hpm(object):
         # tbd check version
 
         ####################################################
-        # compare current revision with upgrade image earlist comp rev
+        # compare current revision with upgrade image earliest comp rev
         targetCap = self.get_target_upgrade_capabilities()
         # tbd check version
 

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/interfaces/aardvark.py

@@ -44,23 +44,32 @@ class Aardvark(object):
                                'use this interface.')
 
         self.slave_address = slave_address
+        self.port = port
+        self.serial_number = serial_number
+        self.i2c_pullups = enable_i2c_pullups
+        self.target_power = enable_target_power
+        self.fastmode = enable_fastmode
         self.timeout = 0.25
         self.max_retries = 3
         self.next_sequence_number = 0
 
-        self._dev = pyaardvark.open(port, serial_number)
+    def open(self):
+        self._dev = pyaardvark.open(self.port, self.serial_number)
         self._dev.enable_i2c_slave(self.slave_address >> 1)
 
-        if enable_i2c_pullups:
-            self.enable_pullups(enable_i2c_pullups)
-        if enable_target_power:
-            self.enable_target_power(enable_target_power)
+        if self.i2c_pullups:
+            self.enable_pullups(self.i2c_pullups)
+        if self.target_power:
+            self.enable_target_power(self.target_power)
 
-        if enable_fastmode is not None:
-            self.enable_fastmode(enable_fastmode)
+        if self.fastmode is not None:
+            self.enable_fastmode(self.fastmode)
         else:
             self.enable_fastmode(False)
 
+    def close(self):
+        self._dev.close()
+
     def enable_pullups(self, enabled):
         self._dev.i2c_pullups = enabled
 
@@ -77,11 +86,10 @@ class Aardvark(object):
         self._dev.i2c_master_write(address, data)
 
     def establish_session(self, session):
-        # just remember session parameters here
-        self._session = session
+        pass
 
     def close_session(self):
-        self._dev.close()
+        pass
 
     def is_ipmc_accessible(self, target):
         header = IpmbHeaderReq()

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/interfaces/ipmb.py

@@ -149,7 +149,7 @@ def encode_ipmb_msg(header, data):
 
 
 def encode_send_message(payload, rq_sa, rs_sa, channel, seq, tracking=1):
-    """Encode a send message command and embedd the message to be send.
+    """Encode a send message command and embed the message to be send.
 
     payload: the message to be send as bytestring
     rq_sa: the requester source address
@@ -178,7 +178,7 @@ def encode_send_message(payload, rq_sa, rs_sa, channel, seq, tracking=1):
 
 
 def encode_bridged_message(routing, header, payload, seq):
-    """Encode a (multi-)bridged command and embedd the message to be send.
+    """Encode a (multi-)bridged command and embed the message to be send.
 
     routing:
     payload: the message to be send as bytestring

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/interfaces/ipmbdev.py

@@ -17,18 +17,22 @@ class IpmbDev(object):
     def __init__(self, slave_address=0x20, port='/dev/ipmb-0'):
         # TODO: slave address is currently not defined here
         self.slave_address = slave_address
+        self.port = port
         self.timeout = 0.25
         self.max_retries = 3
         self.next_sequence_number = 0
 
-        self._dev = os.open(port, os.O_RDWR)
+    def open(self):
+        self._dev = os.open(self.port, os.O_RDWR)
+
+    def close(self):
+        os.close(self._dev)
 
     def establish_session(self, session):
-        # just remember session parameters here
-        self._session = session
+        pass
 
     def close_session(self):
-        os.close(self._dev)
+        pass
 
     def is_ipmc_accessible(self, target):
         header = IpmbHeaderReq()

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/interfaces/ipmitool.py

@@ -21,7 +21,12 @@ from subprocess import Popen, PIPE
 from array import array
 
 from ..session import Session
-from ..errors import IpmiTimeoutError, IpmiConnectionError
+from ..errors import (
+    IpmiTimeoutError,
+    IpmiConnectionError,
+    IpmiLongPasswordError,
+    AuthenticationError,
+)
 from ..logger import log
 from ..msgs import encode_message, decode_message, create_message
 from ..msgs.constants import CC_OK
@@ -62,13 +67,24 @@ class Ipmitool(object):
                 r".*Unable to establish.*")
         self.re_could_not_open = re.compile(
                 r".*Could not open device.*")
-
+        self.re_long_password = re.compile(
+                r".*password is longer than.*")
+        self.re_authentication_error = re.compile(
+                r".*RAKP [0-9]+ HMAC.*")
         self._session = None
 
+    def open(self):
+        pass
+
+    def close(self):
+        pass
+
     def establish_session(self, session):
-        # just remember session parameters here
         self._session = session
 
+    def close_session(self):
+        pass
+
     def rmcp_ping(self):
 
         if self._interface_type == 'serial-terminal':
@@ -80,6 +96,7 @@ class Ipmitool(object):
         cmd += (' -I %s' % self._interface_type)
         cmd += (' -H %s' % self._session.rmcp_host)
         cmd += (' -p %s' % self._session.rmcp_port)
+        cmd += (' -v')
         if self._session.auth_type == Session.AUTH_TYPE_NONE:
             cmd += (' -A NONE')
         elif self._session.auth_type == Session.AUTH_TYPE_PASSWORD:
@@ -108,6 +125,9 @@ class Ipmitool(object):
             # Don't try to parse ipmitool error messages
             if 'failed' in line:
                 continue
+            # Don't try to parse spurious ipmitool output
+            if 'Received a response with unexpected ID' in line:
+                continue
 
             # Check for timeout
             if self.re_timeout.match(line):
@@ -127,13 +147,22 @@ class Ipmitool(object):
             if self.re_could_not_open.match(line):
                 raise RuntimeError('ipmitool failed: {}'.format(output))
 
+            if self.re_long_password.match(line):
+                raise IpmiLongPasswordError(line)
+
+            if self.re_authentication_error.match(line):
+                raise AuthenticationError('Authentication error')
+
             hexstr += line.replace('\r', '').strip() + ' '
 
         hexstr = hexstr.strip()
         if len(hexstr):
-            rsp = array('B', [
-                int(value, 16) for value in hexstr.split(' ')
-            ])
+            try:
+                rsp = array('B', [
+                    int(value, 16) for value in hexstr.split(' ')
+                ])
+            except ValueError:
+                pass
 
         return cc, rsp
 
@@ -235,6 +264,7 @@ class Ipmitool(object):
         cmd += (' -I %s' % self._interface_type)
         cmd += (' -H %s' % self._session.rmcp_host)
         cmd += (' -p %s' % self._session.rmcp_port)
+        cmd += (' -v')
 
         cmd += self._build_ipmitool_priv_level(self._session.priv_level)
 

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/interfaces/mock.py

@@ -6,6 +6,12 @@ class Mock(object):
     def __init__(self):
         pass
 
+    def open(self):
+        pass
+
+    def close(self):
+        pass
+
     def establish_session(self, session):
         pass
 

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/interfaces/rmcp.py

@@ -248,7 +248,7 @@ class IpmiMsg(object):
         return struct.unpack("<I", struct.pack(">I", seq))[0]
 
     def _padd_password(self):
-        """Padd the password.
+        """Pad the password.
 
         The password/key is 0 padded to 16-bytes for all specified
         authentication types.
@@ -393,12 +393,10 @@ class Rmcp(object):
         """
         self.host = None
         self.port = None
-        self._sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
         self.seq_number = 0xff
         self.slave_address = slave_address
         self.host_target = Target(host_target_address)
         self.max_retries = max_retries
-        self.set_timeout(2.0)
         self.next_sequence_number = 0
         self.keep_alive_interval = keep_alive_interval
         self._stop_keep_alive = None
@@ -408,6 +406,13 @@ class Rmcp(object):
         self.ignore_sdu_length = quirks_cfg.get('rmcp_ignore_sdu_length', False)
         self.ignore_rq_seq = quirks_cfg.get('rmcp_ignore_rq_seq', False)
 
+    def open(self):
+        self._sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        self.set_timeout(2.0)
+
+    def close(self):
+        pass
+
     def _send_rmcp_msg(self, sdu, class_of_msg):
         rmcp = RmcpMsg(class_of_msg)
         pdu = rmcp.pack(sdu, self.seq_number)

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/ipmitool.py

@@ -474,7 +474,7 @@ Options:
   -I <interface>   Set interface (available: rmcp, aardvark, ipmitool, ipmbdev)
   -H <host>        Set RMCP host
   -U <user>        Set RMCP user
-  -L <level>       Set RMCP priviledge level
+  -L <level>       Set RMCP privilege level
   -P <password>    Set RMCP password
   -o <options>     Set interface specific options (name=value, separated
                    by commas, see below for available options).
@@ -644,9 +644,8 @@ def main():
         if rmcp_priv_level is not None:
             ipmi.session.set_priv_level(rmcp_priv_level)
 
-        ipmi.session.establish()
-
     try:
+        ipmi.open()  # this will open interface and session
         cmd(ipmi, args)
     except pyipmi.errors.CompletionCodeError as e:
         print('Command returned with completion code 0x%02x' % e.cc)
@@ -664,8 +663,7 @@ def main():
         sys.exit(1)
 
     finally:
-        if rmcp_host is not None:
-            ipmi.session.close()
+        ipmi.close()  # this will close interface and session
 
 
 COMMANDS = (

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/messaging.py

@@ -196,3 +196,4 @@ class UserAccess(State):
         s += '  IPMI messaging: %s\n' % self.ipmi_messaging
         s += '  Link Auth.: %s\n' % self.link_auth
         s += '  Callback only: %s' % self.callback_only
+        return s

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/msgs/message.py

@@ -54,7 +54,7 @@ class ByteArray(BaseField):
     def encode(self, obj, data):
         a = getattr(obj, self.name)
         if len(a) != self._length(obj):
-            raise EncodingError('Array must be exaclty %d bytes long '
+            raise EncodingError('Array must be exactly %d bytes long '
                                 '(but is %d long)' %
                                 (self._length(obj), len(a)))
         for i in range(self._length(obj)):
@@ -320,7 +320,7 @@ class Message(object):
 
         buf -- option message buffer to decode
 
-        Optional keyword arguments corresponts to members to set (matching
+        Optional keyword arguments corresponds to members to set (matching
         fields in self.__fields__, or 'data').
         """
         # create message fields

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/pyipmi/version.py

@@ -1,2 +1,2 @@
 # This file was autogenerated by setup.py
-__version__ = '0.5.7'
+__version__ = '0.5.8'

{python_ipmi-0.5.7 → python_ipmi-0.5.8/python_ipmi.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-ipmi
-Version: 0.5.7
+Version: 0.5.8
 Summary: Pure python IPMI library
 Home-page: https://github.com/kontron/python-ipmi
-Download-URL: https://github.com/kontron/python-ipmi/tarball/0.5.7
+Download-URL: https://github.com/kontron/python-ipmi/tarball/0.5.8
 Author: Michael Walle, Heiko Thiery
 Author-email: michael.walle@kontron.com, heiko.thiery@kontron.com
 License: LGPLv2+
@@ -24,6 +24,16 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 License-File: COPYING
 License-File: AUTHORS
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: summary
 
 Pure Python IPMI Library
 ========================

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/python_ipmi.egg-info/SOURCES.txt

@@ -61,6 +61,7 @@ tests/test_bmc.py
 tests/test_chassis.py
 tests/test_device_messaging.py
 tests/test_errors.py
+tests/test_event.py
 tests/test_fields.py
 tests/test_fru.py
 tests/test_helper.py

python_ipmi-0.5.8/tests/test_event.py

@@ -0,0 +1,38 @@
+from unittest.mock import MagicMock
+
+from pyipmi import interfaces, create_connection
+from pyipmi.msgs.event import (SetEventReceiverRsp, GetEventReceiverRsp)
+
+
+class TestEvent(object):
+
+    def setup_method(self):
+        self.mock_send_recv = MagicMock()
+
+        interface = interfaces.create_interface('mock')
+        self.ipmi = create_connection(interface)
+        self.ipmi.send_message = self.mock_send_recv
+
+    def test_set_event_receiver(self):
+
+        rsp = SetEventReceiverRsp()
+        rsp.completion_code = 0
+        self.mock_send_recv.return_value = rsp
+
+        self.ipmi.set_event_receiver(ipmb_address=0xb0, lun=1)
+        args, _ = self.mock_send_recv.call_args
+        req = args[0]
+        assert req.event_receiver.ipmb_i2c_slave_address == 0xb0
+        assert req.event_receiver.lun == 1
+
+    def test_get_event_receiver(self):
+
+        rsp = GetEventReceiverRsp()
+        rsp.completion_code = 0
+        rsp.event_receiver.ipmb_i2c_slave_address = 0xc0
+        rsp.event_receiver.lun = 2
+        self.mock_send_recv.return_value = rsp
+
+        (addr, lun) = self.ipmi.get_event_receiver()
+        assert addr == 0xc0
+        assert lun == 2

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/tests/test_fru.py

@@ -1,12 +1,19 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 import os
+import pytest
 
-from pyipmi.fru import (FruData, FruPicmgPowerModuleCapabilityRecord,
+from pyipmi.errors import (DecodingError)
+
+from pyipmi.fru import (FruData, FruInventory,
+                        FruPicmgPowerModuleCapabilityRecord,
                         InventoryCommonHeader, InventoryBoardInfoArea,
                         get_fru_inventory_from_file)
 
 
+this_file_path = os.path.dirname(os.path.abspath(__file__))
+
+
 def test_frudata_object():
     fru_field = FruData((0, 1, 2, 3))
     assert fru_field.data[0] == 0
@@ -25,16 +32,21 @@ def test_commonheader_object():
     InventoryCommonHeader((0, 1, 2, 3, 4, 5, 6, 235))
 
 
+def test_commonheader_object_invalid_checksum():
+    with pytest.raises(DecodingError):
+        InventoryCommonHeader((0, 1, 2, 3, 4, 5, 6, 0))
+
+    InventoryCommonHeader((0, 1, 2, 3, 4, 5, 6, 0), ignore_checksum=True)
+
+
 def test_fru_inventory_from_file():
-    path = os.path.dirname(os.path.abspath(__file__))
-    fru_file = os.path.join(path, 'fru_bin/kontron_am4010.bin')
+    fru_file = os.path.join(this_file_path, 'fru_bin/kontron_am4010.bin')
     fru = get_fru_inventory_from_file(fru_file)
     assert fru.chassis_info_area is None
 
 
 def test_board_area():
-    path = os.path.dirname(os.path.abspath(__file__))
-    fru_file = os.path.join(path, 'fru_bin/kontron_am4010.bin')
+    fru_file = os.path.join(this_file_path, 'fru_bin/kontron_am4010.bin')
     fru = get_fru_inventory_from_file(fru_file)
 
     board_area = fru.board_info_area
@@ -45,8 +57,7 @@ def test_board_area():
 
 
 def test_product_area():
-    path = os.path.dirname(os.path.abspath(__file__))
-    fru_file = os.path.join(path, 'fru_bin/kontron_am4010.bin')
+    fru_file = os.path.join(this_file_path, 'fru_bin/kontron_am4010.bin')
     fru = get_fru_inventory_from_file(fru_file)
 
     product_area = fru.product_info_area
@@ -57,8 +68,7 @@ def test_product_area():
 
 
 def test_multirecord_with_power_module_capability_record():
-    path = os.path.dirname(os.path.abspath(__file__))
-    fru_file = os.path.join(path, 'fru_bin/vadatech_utc017.bin')
+    fru_file = os.path.join(this_file_path, 'fru_bin/vadatech_utc017.bin')
     fru = get_fru_inventory_from_file(fru_file)
     assert len(fru.multirecord_area.records) == 1
     record = fru.multirecord_area.records[0]
@@ -72,3 +82,15 @@ def test_BoardInfoArea():
     assert area.product_name.string == 'PowerEdge R515                '
     assert area.serial_number.string == 'CN717033AI0058'
     assert area.part_number.string == '0RMRF7A05'
+
+
+def test_FruInventory_ignore_checksum_error():
+    data = b'\x01\x00\x00\x01\x04\x00\x00\xfa\x01\x03\x00vq\xb4\xcaASRockRack\xc0\xc0\xc0\xc0\xc1\x00\x1b\x01\x03\x00\xcaASRockRack\xc0\xc0\xc0\xc0\xc0\xc0\xc1\x00\x00M\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
+
+    with pytest.raises(DecodingError):
+        FruInventory(data, ignore_checksum=False)
+
+    inv = FruInventory(data, ignore_checksum=True)
+
+    assert inv.board_info_area.manufacturer.string == 'ASRockRack'
+    assert inv.product_info_area.manufacturer.string == 'ASRockRack'

{python_ipmi-0.5.7 → python_ipmi-0.5.8}/tests/test_ipmi.py

@@ -5,7 +5,8 @@ from unittest.mock import MagicMock
 
 import pytest
 
-from pyipmi import interfaces, create_connection, Target, Routing
+from pyipmi import (Ipmi, interfaces, create_connection, NullRequester, Routing,
+                    Session, Target)
 from pyipmi.errors import CompletionCodeError, RetryError
 from pyipmi.msgs.bmc import GetDeviceIdReq, GetDeviceIdRsp
 from pyipmi.msgs.sensor import GetSensorReadingReq, GetSensorReadingRsp
@@ -88,6 +89,40 @@ def test_target_set_routing_from_string():
     assert target.routing[1].channel == 0x23
 
 
+def test_create_connection():
+    interface = interfaces.create_interface('mock')
+
+    ipmi = create_connection(interface)
+    assert ipmi.interface is not None
+    assert isinstance(ipmi.interface, interfaces.mock.Mock)
+    assert isinstance(ipmi.session, Session)
+    assert isinstance(ipmi.session.interface, interfaces.mock.Mock)
+    assert isinstance(ipmi.requester, NullRequester)
+
+
+def test_ipmi():
+    ipmi = Ipmi()
+    assert ipmi.interface is None
+    assert isinstance(ipmi.session, Session)
+    assert isinstance(ipmi.requester, NullRequester)
+
+    interface = interfaces.create_interface('mock')
+    ipmi = Ipmi(interface=interface)
+    assert isinstance(ipmi.interface, interfaces.mock.Mock)
+    assert isinstance(ipmi.session, Session)
+    assert isinstance(ipmi.session.interface, interfaces.mock.Mock)
+    assert isinstance(ipmi.requester, NullRequester)
+
+
+def test_ipmi_with_statemetn():
+    interface = interfaces.create_interface('mock')
+
+    with Ipmi(interface=interface) as ipmi:
+        assert ipmi.interface is not None
+        assert isinstance(ipmi.session, Session)
+        assert isinstance(ipmi.requester, NullRequester)
+
+
 def test_ipmi_send_message_retry():
     req = GetDeviceIdReq()
     rsp = GetDeviceIdRsp()