Fix UnicodeDecodeError with non-UTF-8 filenames in SSH operations
#386
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Dany9966
requested changes
Jan 29, 2026
| repos_list = self._exec_cmd_chroot( | ||
| "zypper repos -u | awk -F '|' '/^\s[0-9]+/ {print $2 $7}'" | ||
| ).decode() | ||
| ) |
Contributor
There was a problem hiding this comment.
NIT: can you please put this paranthesis on the end of the previous line?
| LOG.warning( | ||
| "SFTP listdir failed due to non-UTF-8 filename, " | ||
| "falling back to shell command. Error: %s", str(ex)) | ||
| output = exec_ssh_cmd(ssh, "ls -1 %s" % remote_path, get_pty=True) |
Contributor
There was a problem hiding this comment.
I'd prefer to also avoid permission issues, so please add a sudo to the command.
| try: | ||
| sftp = ssh.open_sftp() | ||
| return sftp.listdir(remote_path) | ||
| except UnicodeDecodeError as ex: |
Contributor
There was a problem hiding this comment.
As mentioned below, I'd like to also avoid permission issues, not just decode errors. Catch Exception here, and then attempt the sudo ls -1 command. Make sure to warn about the exception. Use get_exception_details() instead of str(ex) as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix
UnicodeDecodeErrorwith non-UTF-8 filenames in SSH operationsThis PR fixes a critical bug where migrations fail with
UnicodeDecodeErrorwhen source systems contain files or directories with non-UTF-8 characters in
their names.
The fix centralizes UTF-8 decoding with error handling in
exec_ssh_cmd(),which now returns decoded strings with
errors='replace'instead of raw bytes.Invalid UTF-8 sequences are replaced with the
�character, allowing migrationsto continue while logging warnings for monitoring.
Changes:
exec_ssh_cmd()to return strings with safe decodinglist_ssh_dir()for encoding errors.decode()calls on command execution results (15 locations)Impact: