apache / incubator-heron

Apache Heron (Incubating) is a realtime, distributed, fault-tolerant stream processing engine from Twitter
https://heron.apache.org/
Apache License 2.0
3.65k stars 599 forks source link

Test Smell: testing private methods is not a good test practice. #3848

Open TestSmell opened 1 year ago

TestSmell commented 1 year ago

Hi! I notice that in your test code, you try to use reflection to assess and test the private method. For example,

  1. the test methods named ''testExecuteTasksOnWakeup()'' in ''WakeableLooperTest.java'' uses the reflection method to test a private method named ''private void executeTasksOnWakeup()'' in ''WakeableLooper.java''.
  2. the test methods named ''testRunOnce()'' in ''WakeableLooperTest.java'' uses the reflection method to test a private method named ''private void runOnce()'' in ''WakeableLooper.java''.

But, the problem of testing private methods has a wide discussion in Stack Overflow, and the majority of answers think it is a bad test practice. Because it may cause many problems:

  1. many answers believe that if you need to test private methods, it means your production code is not well designed, i.e., design smell.
  2. testing private methods breaks the encapsulation.
  3. Many answers mention that private methods are invoked by public ones, so test methods just need to test public methods. Otherwise, if a private method needs to be tested separately, it may be dead code.
  4. Testing implementation details (private methods) directly would make the tests harder to maintain and the code-under-test more difficult to refactor.

Although several methods are used to access private methods (e.g., reflection methods, mock tests, changing the modifier to make it visible), refactoring the corresponding code is regarded as the best practice to eliminate this bad test practice.

So, we kindly suggest you refactor the corresponding source code instead of using the reflection method to test the private method.