如何解决不需要的 TestNG assertEquals 重载

Question

我遇到了一个问题，即某些类 X 扩展了 java.util.AbstractMap，并且还重载了 equals(Object)。调用org.testng.Assert.assertEquals(X a, X b) 解析为assertEquals(Map<?,?>, Map<?,?>)。不是调用“equals”方法，而是比较映射条目。即使a.equals(b) 为假，这也会导致assertEquals(a, b) 通过。

这段代码演示了这个问题：

import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertTrue;

import java.util.AbstractMap;
import java.util.Collections;
import java.util.Set;

import org.testng.annotations.Test;

public class AssertTest {
    static class X extends AbstractMap<String, Object> {
        private int i;

        public X(int i) {
        this.i = i;
        }

        @Override
        public Set<Entry<String, Object>> entrySet() {
        return Collections.EMPTY_SET;
        }

        @Override
        public boolean equals(Object o) {
        return o instanceof X && i == ((X)o).i;
        }

        @Override
        public int hashCode() {
        return i;
        }
    }

    @Test
    public void test() {
        X one = new X(1);
        X two = new X(2);
        assertEquals(one, two); // passes, should fail IMO
        assertTrue(one.equals(two)); // correctly fails
    }
}

解决此问题的最佳方法是什么？一种可能性是记住不要使用 assertEquals 来验证 X 的实例是否匹配，但这非常容易出错。

另一种可能性是简单地制作 testng 的本地副本并重命名重载。这会造成持续的维护问题。

我唯一的另一个想法是创建一个特定于项目的 Assert 类，该类委托给 testng.Assert，但将有问题的重载重命名为“assertCollectionEquals”、“assertMapEquals”等。

Answer 1

org.testng.Assert.assertEquals(X a, X b) 调用 the assertEquals(Map, Map) method 遍历条目集并检查所有条目是否相等，绕过 Map#equals 方法，正如您所注意到的。

简单的强制转换可以避免调用该方法，而是使用X#equals 方法：

assertEquals((Object) one, (Object) two);

您也可以将变量声明为对象以获得相同的结果：

Object one = new X(1);
Object two = new X(2);
assertEquals(one, two);

这并不能真正解决您的问题，因为它仍然容易出错。

为了避免偶尔出现的错误，我可以想到一些解决方法（在这里累了，所以有些可能没有什么意义），使用 assertEquals without cast 调用 x.entrySet() 的事实：

• 编写一些代码来解析 X 类的所有测试文件，并确保有一个适当的类型转换（不简单）或者在 = 的左侧没有声明 X
• 使用模拟框架并在 @BeforeGroups 方法中模拟 X（如果您使用组）并将依赖于该惯用语的每个测试放在同一组中，以便他们将在 entrySet 未通过您的测试时使用模拟 X（并且其他方法按预期工作），或者至少记录/打印一些警告。如果你还需要使用entrySet，同样的方法是行不通的
• 使用模拟框架模拟 TestNG#assertEquals(Map, Map) 以获得所需的行为
• 在所有需要该习惯用法的测试类中，创建一个特别的assertEquals(Map, Map) 方法。如果你有所有 assertEquals 方法的静态导入，你也必须重新实现其他签名:-(
• 让所有这些测试类都继承一个 BaseXTestClass，您可以在其中实现 assertEquals(Map, Map) 方法 - 相同的警告