[CAY-2717] Refactor MockChannelListener in DataContextDataChannelEventsIT to improve test logic

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Assignee: Unassigned
• Reporter: Xiao Wang
• Created: 03/Aug/21 04:24
• Updated: 03/Aug/21 04:24

Description

Description

I noticed that there is a test class MockChannelListener implements production interface DataChannelListener to assist testing the ineractions among commitChanges(), commitChangesToParent() and rollbackChanges(). This might not be the best practice in testing and can be improved by leveraging mocking frameworks.

Current Implementation

• MockChannelListener implements DataChannelListener. The sub test class creates three fields to keep tracking the invocation status of three overridden methods.
• In test cases, an instance of MockChannelListener is passed to EventUtil.listenForChannelEvents(DataChannel, DataChannelListener). The new fields in test sub class are used in assertion statements to assert test sub class's behavior.

Proposed Implementation

• Replace MockChannelListener with a mocking object created by Mockito.
• Remove the fields created in test subclass to make test logic more clear.
• Remove the redundant method overrides to make test logic more clear.
• Use Mockito.verify() to directly verify the behavior of the mocking object and make test condition more explict.

Motivation

• Decoupling test class MockChannelListener from production interface DataChannelListener
• Making test condition more clear by removing redundant overridden methods and new fields.
• Use Mockito.verify() to directly verify the behavior of the mocking object and make test condition more explict.