Fix wrong bool argument parsing in upgrade_image.py script #9452
Conversation
This file contains 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
The upgrade_image.py script defined some bool type arguments. However, "action" is not specified while defining these arguments. The result is that if user pass in arguments like below, the argument will be still be evaluated to True as python by default casting string "False" to bool value True. ./upgrade_image.py --enable-fips Flase The fix is to take advantage of setuptools.distutils.util.strtobool. With tool, any values like below passed in to this type of arguments would be evaluated to integer 0: "n", "no", "No", "NO", "False", "false", "FALSE", "FaLsE", ... Any argument value like below would be evaluated to integer 1: "y", "yes", "Yes", "YES", "True", "true", "TRUE", "TrUe", ... Signed-off-by: Xin Wang <xiwang5@microsoft.com>
|
Cherry-pick PR to 202205: #9454 |
mssonicbld
pushed a commit
to mssonicbld/sonic-mgmt
that referenced
this pull request
Aug 15, 2023
…#9452) Approach What is the motivation for this PR? The upgrade_image.py script defined some bool type arguments. However, "action" is not specified while defining these arguments. The result is that if user pass in arguments like below, the argument will be still be evaluated to True as python by default casting string "False" to bool value True. ./upgrade_image.py --enable-fips Flase How did you do it? The fix is to take advantage of setuptools.distutils.util.strtobool. With tool, any values like below passed in to this type of arguments would be evaluated to integer 0: "n", "no", "No", "NO", "False", "false", "FALSE", "FaLsE", ... Any argument value like below would be evaluated to integer 1: "y", "yes", "Yes", "YES", "True", "true", "TRUE", "TrUe", ... Signed-off-by: Xin Wang <xiwang5@microsoft.com> co-authorized by: jianquanye@microsoft.com
mssonicbld
pushed a commit
to mssonicbld/sonic-mgmt
that referenced
this pull request
Aug 15, 2023
…#9452) Approach What is the motivation for this PR? The upgrade_image.py script defined some bool type arguments. However, "action" is not specified while defining these arguments. The result is that if user pass in arguments like below, the argument will be still be evaluated to True as python by default casting string "False" to bool value True. ./upgrade_image.py --enable-fips Flase How did you do it? The fix is to take advantage of setuptools.distutils.util.strtobool. With tool, any values like below passed in to this type of arguments would be evaluated to integer 0: "n", "no", "No", "NO", "False", "false", "FALSE", "FaLsE", ... Any argument value like below would be evaluated to integer 1: "y", "yes", "Yes", "YES", "True", "true", "TRUE", "TrUe", ... Signed-off-by: Xin Wang <xiwang5@microsoft.com> co-authorized by: jianquanye@microsoft.com
mssonicbld
pushed a commit
to mssonicbld/sonic-mgmt
that referenced
this pull request
Aug 15, 2023
…#9452) Approach What is the motivation for this PR? The upgrade_image.py script defined some bool type arguments. However, "action" is not specified while defining these arguments. The result is that if user pass in arguments like below, the argument will be still be evaluated to True as python by default casting string "False" to bool value True. ./upgrade_image.py --enable-fips Flase How did you do it? The fix is to take advantage of setuptools.distutils.util.strtobool. With tool, any values like below passed in to this type of arguments would be evaluated to integer 0: "n", "no", "No", "NO", "False", "false", "FALSE", "FaLsE", ... Any argument value like below would be evaluated to integer 1: "y", "yes", "Yes", "YES", "True", "true", "TRUE", "TrUe", ... Signed-off-by: Xin Wang <xiwang5@microsoft.com> co-authorized by: jianquanye@microsoft.com
|
Cherry-pick PR to 202012: #9456 |
|
Cherry-pick PR to 202305: #9455 |
This was referenced Aug 15, 2023
mssonicbld
pushed a commit
that referenced
this pull request
Aug 15, 2023
Approach What is the motivation for this PR? The upgrade_image.py script defined some bool type arguments. However, "action" is not specified while defining these arguments. The result is that if user pass in arguments like below, the argument will be still be evaluated to True as python by default casting string "False" to bool value True. ./upgrade_image.py --enable-fips Flase How did you do it? The fix is to take advantage of setuptools.distutils.util.strtobool. With tool, any values like below passed in to this type of arguments would be evaluated to integer 0: "n", "no", "No", "NO", "False", "false", "FALSE", "FaLsE", ... Any argument value like below would be evaluated to integer 1: "y", "yes", "Yes", "YES", "True", "true", "TRUE", "TrUe", ... Signed-off-by: Xin Wang <xiwang5@microsoft.com> co-authorized by: jianquanye@microsoft.com
mssonicbld
added
Included in 202012 branch
and removed
Created PR to 202012 branch
labels
mssonicbld
pushed a commit
that referenced
this pull request
Aug 15, 2023
Approach What is the motivation for this PR? The upgrade_image.py script defined some bool type arguments. However, "action" is not specified while defining these arguments. The result is that if user pass in arguments like below, the argument will be still be evaluated to True as python by default casting string "False" to bool value True. ./upgrade_image.py --enable-fips Flase How did you do it? The fix is to take advantage of setuptools.distutils.util.strtobool. With tool, any values like below passed in to this type of arguments would be evaluated to integer 0: "n", "no", "No", "NO", "False", "false", "FALSE", "FaLsE", ... Any argument value like below would be evaluated to integer 1: "y", "yes", "Yes", "YES", "True", "true", "TRUE", "TrUe", ... Signed-off-by: Xin Wang <xiwang5@microsoft.com> co-authorized by: jianquanye@microsoft.com
mssonicbld
added
Included in 202205 branch
and removed
Created PR to 202205 branch
labels
yejianquan
pushed a commit
that referenced
this pull request
Aug 16, 2023
…9455) Approach What is the motivation for this PR? The upgrade_image.py script defined some bool type arguments. However, "action" is not specified while defining these arguments. The result is that if user pass in arguments like below, the argument will be still be evaluated to True as python by default casting string "False" to bool value True. ./upgrade_image.py --enable-fips Flase How did you do it? The fix is to take advantage of setuptools.distutils.util.strtobool. With tool, any values like below passed in to this type of arguments would be evaluated to integer 0: "n", "no", "No", "NO", "False", "false", "FALSE", "FaLsE", ... Any argument value like below would be evaluated to integer 1: "y", "yes", "Yes", "YES", "True", "true", "TRUE", "TrUe", ... co-authorized by: jianquanye@microsoft.com
AharonMalkin
pushed a commit
to AharonMalkin/sonic-mgmt
that referenced
this pull request
Jan 25, 2024
…#9452) Approach What is the motivation for this PR? The upgrade_image.py script defined some bool type arguments. However, "action" is not specified while defining these arguments. The result is that if user pass in arguments like below, the argument will be still be evaluated to True as python by default casting string "False" to bool value True. ./upgrade_image.py --enable-fips Flase How did you do it? The fix is to take advantage of setuptools.distutils.util.strtobool. With tool, any values like below passed in to this type of arguments would be evaluated to integer 0: "n", "no", "No", "NO", "False", "false", "FALSE", "FaLsE", ... Any argument value like below would be evaluated to integer 1: "y", "yes", "Yes", "YES", "True", "true", "TRUE", "TrUe", ... Signed-off-by: Xin Wang <xiwang5@microsoft.com> co-authorized by: jianquanye@microsoft.com
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of PR
Summary:
Fixes # (issue)
Type of change
Back port request
Approach
What is the motivation for this PR?
The upgrade_image.py script defined some bool type arguments. However, "action" is not specified while defining these arguments.
The result is that if user pass in arguments like below, the argument will be still be evaluated to True as python by default casting string "False" to bool value True.
How did you do it?
The fix is to take advantage of setuptools.distutils.util.strtobool.
With tool, any values like below passed in to this type of arguments would be evaluated to integer 0:
Any argument value like below would be evaluated to integer 1:
How did you verify/test it?
Any platform specific information?
Supported testbed topology if it's a new test case?
Documentation