Added unit tests for MicroSwitchController class #304
Closed
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
|
Ava seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
Ed0827
reviewed
Feb 3, 2025
| @@ -64,4 +64,9 @@ public void removeEventListener() | |||
| microSwitchInputListener = null; | |||
| } | |||
| } | |||
|
|
|||
| public void setLog(Logger log) { | |||
There was a problem hiding this comment.
Great job on this! This will help when troubleshooting your code by setting up a logger.
| @@ -10,7 +10,7 @@ | |||
| */ | |||
| public class MicroSwitchHelper { | |||
|
|
|||
| private static final Logger log = LoggerFactory.getLogger(MicroSwitchHelper.class); | |||
There was a problem hiding this comment.
This provides flexibility to modify logger messages.
yrlmanoharreddy
requested changes
Feb 4, 2025
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.
Fixes #302
Description:
Adds unit tests for the MicroSwitchHelper using JUnit 5 and Mockito, checking its initialization, state updates and event listener management. Also introduces logger injection to confirm the correct log message ('Initializing Micro Switch') is being produced.
What was changed:
In MicroSwitchHelper the logger was converted from static final to static with a new setLog(Logger newLog) method, this enables the use of a custom logger for testing.
Unit tests were implemented to verify initialization logic, state updates, and event listener management, and tests to confirm the expected log message.
How it was changed:
The logger in MicroSwitchHelper was changed from a static final to an instance level with the new setLog method. Unit tests were implemented using JUnit 5 and Mockito in order to simulate different kinds of digital input and to verify specific fields are correct upon initialization. Verified the initial listener in the initialize methods updates isPressed state correctly when the input state is changed. New tests to confirm that the add and remove event listener methods work correctly. New logging tests to check that the expected log messa