-
Notifications
You must be signed in to change notification settings - Fork 1k
Fix non-deterministic convert_from_registers mutating the caller's registers list #2951
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
gaoflow
wants to merge
1
commit into
pymodbus-dev:dev
Choose a base branch
from
gaoflow:fix-convert-from-registers-mutation
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+38
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -366,6 +366,41 @@ def test_client_mixin_convert_1234(self, datatype, registers, value): | |
| assert result == value | ||
| assert regs == registers | ||
|
|
||
| @pytest.mark.parametrize("word_order", ["big", "little"]) | ||
| @pytest.mark.parametrize( | ||
| ("datatype", "value"), | ||
| [ | ||
| (ModbusClientMixin.DATATYPE.STRING, "Hello"), | ||
| (ModbusClientMixin.DATATYPE.STRING, "abcdefghij"), | ||
| (ModbusClientMixin.DATATYPE.BITS, [True, False, True] + [False] * 17), | ||
| (ModbusClientMixin.DATATYPE.INT32, 123456), | ||
| (ModbusClientMixin.DATATYPE.INT32, [1, 2, 3, 4]), | ||
| ], | ||
| ) | ||
| def test_client_mixin_convert_from_registers_no_mutation( | ||
| self, datatype, value, word_order | ||
| ): | ||
| """convert_from_registers must not mutate input and stay deterministic. | ||
|
|
||
| Regression: for STRING/BITS with word_order="little" the registers list | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We do not explain bugs in comments! doing that would make the comments larger than the code and with nothing more than historic value. Seems to continue, please remove all comments that either only have historic value, or explain what the code does without adding value. |
||
| was reversed in place, corrupting the caller's data so a second identical | ||
| call decoded garbage (non-deterministic output). | ||
| """ | ||
| registers = ModbusClientMixin.convert_to_registers( | ||
| value, datatype, word_order=word_order | ||
| ) | ||
| snapshot = list(registers) | ||
| first = ModbusClientMixin.convert_from_registers( | ||
| registers, datatype, word_order=word_order | ||
| ) | ||
| # Decoding must leave the caller's list untouched ... | ||
| assert registers == snapshot | ||
| # ... so repeating the identical call yields the identical result. | ||
| second = ModbusClientMixin.convert_from_registers( | ||
| registers, datatype, word_order=word_order | ||
| ) | ||
| assert first == second | ||
|
|
||
| def test_client_mixin_convert_fail(self): | ||
| """Test convert fail.""" | ||
| with pytest.raises(TypeError): | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need for this comment, it does not provide more information than the the code