eclipse / paho.mqtt.java

Eclipse Paho Java MQTT client library. Paho is an Eclipse IoT project.
https://eclipse.org/paho
Other
2.1k stars 880 forks source link

Test Smell: ''assertEquals'' assertions with the wrong parameter order #954

Open TestSmell opened 2 years ago

TestSmell commented 2 years ago

Hi! Description: we detect that some assertions in your test code have the wrong parameter orders. For example, the test case named ''testMsgProperties()'' in ''BasicTest.java'' writes the ''assertEquals'' assertion as image However, referring to the API documentation of ''org.junit.Test'' is ''assertEquals(Object expected, Object actual)''.

Negative: Using ''assertEquals()'' with the wrong parameter order is a bad test practice. Because once the test case fails, the ''assertEquals()'' assertion with the wrong parameter order will give the wrong log information. The log information will say:’’ java.lang.AssertionError: expected [actual value] but found [ excepted value]’’, where it should have said "java.lang.AssertionError: expected [excepted value] but found [actual value]''. This is confusing, to say the least, and you shouldn't have to deal with a possible misdirection of that message.

Solution: Generally, the excepted value should be a known value, such as a real number, a string, etc. The actual value should be the result of the method-under-test. The best way to eliminate the test smell is to exchange the parameter in ''assertEquals'' assertions.

We list other test cases with the same problem as follows:

  1. testMsgProperties() in BasicTest.java
  2. testDecodingComplexMqttSubscribe() in MqttSubscribeTest.java
  3. testConnectTimeout() in SendReceiveAsyncTest.java
  4. testBufferedMessageTopicAlias() in OfflineBufferingTest.java