Fix mock_slave and lots of magic numbers #539
Merged
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
This fixes issue #538, "`mock_slave` violates assumptions, causing tests to be ill-defined". Basically, what I've done is to make the user-supplied functions act on the outputs rather than on the internal states. This had quite substantial effects on some of the tests, which depended on the wrong behaviour. To compensate and, to some extent, restore the old behaviour in a "correct" way, I've had to add some new functionality to `mock_slave`, namely: - The possibility to have outputs depend on time as well as inputs. - The possibility to have a custom function called at each time step. Finally, I've taken this opportunity to make some of the tests slightly more readable by replacing magic numbers with named variables/constants. This includes: - Simulator indexes, which were assumed to be sequential in some tests - Variable references, which were assumed to be 0 and 1 for `mock_slave`'s variables The magic numbers were making the tests hard to read, and therefore also to fix. Besides, while the above assumptions are correct at the moment, that need not be the case in the future.
4 tasks
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.
This fixes issue #538, "
mock_slaveviolates assumptions, causing tests to be ill-defined". Basically, what I've done is to make the user-supplied functions act on the outputs rather than on the internal states.This had quite substantial effects on some of the tests, which depended on the wrong behaviour. To compensate and, to some extent, restore the old behaviour in a "correct" way, I've had to add some new functionality to
mock_slave, namely:Finally, I've taken this opportunity to make some of the tests slightly more readable by replacing magic numbers with named variables/constants. This includes:
mock_slave's variablesThe magic numbers were making the tests hard to read, and therefore also to fix. Besides, while the above assumptions are correct at the moment, that need not be the case in the future.