Resolve CR comments

Author: benle7

sonic_platform_base/bmc_base.py

@@ -327,7 +327,6 @@ def get_version(self):
             Returns 'N/A' if the BMC firmware version cannot be retrieved
         """
         ret = 0
-        version = 'N/A'
         try:
             ret, version = self._get_firmware_version(self._get_firmware_id())
             if ret != RedfishClient.ERR_CODE_OK:

sonic_platform_base/chassis_base.py

@@ -795,8 +795,7 @@ def get_bmc(self):
         Get bmc device on this chassis
 
         Returns:
-            An object derived from BMCBase representing the hardware
-            eeprom device
+            An object derived from BMCBase representing the BMC device
         """
         return self._bmc
 

sonic_platform_base/redfish_client.py

@@ -75,8 +75,8 @@ class RedfishClient:
     Constructor
     Callbacks are provided because:
     1. Each BMC instance may have its own BMC users management mechanism.
-    1. Password is not allowed to be saved for security concern.
-    2. If token expires or becomes invalid for some reason (for example, being revoked from BMC web interface),
+    2. Password is not allowed to be saved for security concern.
+    3. If token expires or becomes invalid for some reason (for example, being revoked from BMC web interface),
     RedfishClient will do login retry in which password is required anyway. It will get password from an external password provider,
     for example class BMC which holds the responsibility of generating password from TPM.
 
@@ -127,7 +127,7 @@ def __build_logout_cmd(self):
         return cmd
 
     '''
-    Build the POST command to do firmware upgdate-multipart
+    Build the POST command to do firmware update-multipart
 
     Args:
         fw_image: A string, path to the firmware image file
@@ -328,7 +328,7 @@ def __obfuscate_auth_token(self, cmd):
         return obfuscation_cmd
 
     '''
-    Obfuscate password while aksing for password change
+    Obfuscate password while asking for password change
 
     Args:
         cmd: A string, the cURL command to be obfuscated
@@ -424,7 +424,7 @@ def __get_headers_and_body_from_curl_output(self, curl_output):
     Returns:
         An integer, RedfishClient error code
     '''
-    def __curl_errors_to_redfish_erros_translation(self, curl_error):
+    def __curl_errors_to_redfish_errors_translation(self, curl_error):
         return self.CURL_TO_REDFISH_ERROR_MAP.get(
                     curl_error, RedfishClient.ERR_CODE_CURL_FAILURE)
 
@@ -506,7 +506,7 @@ def __exec_curl_cmd_internal(self, cmd):
         else:
             logger.log_notice(f'cURL error:')
             self.log_multi_line_str(error_str)
-            ret = self.__curl_errors_to_redfish_erros_translation(ret)
+            ret = self.__curl_errors_to_redfish_errors_translation(ret)
 
         return (ret, http_status_code, output_str, error_str)
 
@@ -967,7 +967,6 @@ def login(self):
                 except Exception as e:
                     logger.log_error(f'Login failure: Exception during parsing body: {str(e)}')
                     self.log_multi_line_str(response)
-                    pass
 
             # Extract both token and session ID from headers
             token = headers.get('X-Auth-Token')
@@ -1223,7 +1222,7 @@ def redfish_api_trigger_bmc_debug_log_dump(self):
     Get BMC debug log dump file
 
     Args:
-        task_id: A string, the task ID returned from redfish_api_trigger_bmc_debug
+        task_id: A string, the task ID returned from redfish_api_trigger_bmc_debug_log_dump
         filename: A string, the output file name
         file_path: A string, the output file path
         timeout: An integer, overall timeout in seconds
@@ -1357,9 +1356,6 @@ def redfish_api_get_eeprom_info(self, component_name):
     def redfish_api_change_login_password(self, new_password, user=None):
         logger.log_notice('Changing BMC password\n')
         cmd = self.__build_change_password_cmd(new_password, user)
-        ret = RedfishClient.ERR_CODE_OK
-        response = ''
-        error = ''
         ret, _, response, error = self.exec_curl_cmd(cmd)
 
         if (ret != RedfishClient.ERR_CODE_OK):
@@ -1387,7 +1383,7 @@ def redfish_api_change_login_password(self, new_password, user=None):
                 if '@Message.ExtendedInfo' in json_response:
                     for info in json_response['@Message.ExtendedInfo']:
                         if info['MessageId'].endswith('Success'):
-                            logger.log_notice('Password changed sucessfully')
+                            logger.log_notice('Password changed successfully')
                             return (RedfishClient.ERR_CODE_OK, '')
 
                 msg = 'Error: Unexpected response format'

tests/redfish_client_test.py

@@ -51,7 +51,7 @@ def password_callback(self):
         return TestRedfishClient.BMC_NOS_ACCOUNT_DEFAULT_PASSWORD
 
     @mock.patch('subprocess.Popen')
-    def test_login_sucess(self, mock_popen):
+    def test_login_success(self, mock_popen):
         """Test successful login"""
         side_effects = []
         for fname in ['mock_bmc_login_token_response', \