Merge pull request #1398 from krmahadevan/krmahadevan-fix-1394

Exclude Object class from ClassHelper.getAvailableMethods()

CHANGES.txt

@@ -1,4 +1,5 @@
 Current
+Fixed: GITHUB-1394: Optimize ClassHelper.getAvailableMethods() to exclude Object class(Nathan Reynolds & Krishnan Mahadevan)
 Fixed: GITHUB-1396: Order established by IMethodInterceptor not honored when running with parallel='instances' (Ryan Scott)
 Fixed: GITHUB-1287: Parallel (methods) execution with dependsOn running in unexpected order (Kevyn Reinholt)
 Fixed: GITHUB-1362: Ensure AfterGroups methods get executed when involving Method Interceptors (Krishnan Mahadevan)

src/main/java/org/testng/internal/ClassHelper.java

@@ -182,17 +182,19 @@ public static Set<Method> getAvailableMethods(Class<?> clazz) {
     }
 
     Class<?> parent = clazz.getSuperclass();
-    while (null != parent) {
-      Set<Map.Entry<String, Set<Method>>> extractedMethods = extractMethods(clazz, parent, methods).entrySet();
-      for (Map.Entry<String, Set<Method>> extractedMethod : extractedMethods){
-        Set<Method> m = methods.get(extractedMethod.getKey());
-        if (m == null) {
-          methods.put(extractedMethod.getKey(), extractedMethod.getValue());
-        } else {
-          m.addAll(extractedMethod.getValue());
+    if (null != parent) {
+      while (!Object.class.equals(parent)) {
+        Set<Map.Entry<String, Set<Method>>> extractedMethods = extractMethods(clazz, parent, methods).entrySet();
+        for (Map.Entry<String, Set<Method>> extractedMethod : extractedMethods) {
+          Set<Method> m = methods.get(extractedMethod.getKey());
+          if (m == null) {
+            methods.put(extractedMethod.getKey(), extractedMethod.getValue());
+          } else {
+            m.addAll(extractedMethod.getValue());
+          }
         }
+        parent = parent.getSuperclass();
       }
-      parent = parent.getSuperclass();
     }
 
     Set<Method> returnValue = Sets.newHashSet();

src/test/java/test/issue1339/BabyPanda.java

@@ -0,0 +1,27 @@
+package test.issue1339;
+
+public class BabyPanda extends LittlePanda {
+    String name;
+
+    @Override
+    public String toString() {
+        return "BabyPanda{" +
+                "name='" + name + '\'' +
+                '}';
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        BabyPanda babyPanda = (BabyPanda) o;
+
+        return name != null ? name.equals(babyPanda.name) : babyPanda.name == null;
+    }
+
+    @Override
+    public int hashCode() {
+        return name != null ? name.hashCode() : 0;
+    }
+}

src/test/java/test/issue1339/ClassHelperTest.java

@@ -5,6 +5,7 @@
 import org.testng.internal.ClassHelper;
 
 import java.lang.reflect.Method;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Set;
@@ -13,20 +14,36 @@ public class ClassHelperTest {
 
     @Test
     public void testGetAvailableMethods() {
-        List<String> expected = Arrays.asList(
-            "finalize", "toString", "clone", "announcer", "hashCode", "equals",
-            "announcer", "notify", "wait", "wait", "wait", "getClass",
-            "inheritable", "inheritable", "notifyAll"
-        );
-        Set<Method> methods = ClassHelper.getAvailableMethods(LittlePanda.class);
+        runTest(getExpected(), LittlePanda.class);
+    }
+
+    @Test
+    public void testGetAvailableMethodsWhenOverrdingIsInvolved() {
+        List<String> expected = getExpected("equals","hashCode","toString");
+        runTest(expected, BabyPanda.class);
+    }
+
+    private static void runTest(List<String> expected, Class<?> whichClass) {
+        Set<Method> methods = ClassHelper.getAvailableMethods(whichClass);
         //Intentionally not using assertEquals because when this test is executed via gradle an additional method
         //called "jacocoInit()" is getting added, which does not get added when this test is executed individually
-        Assert.assertTrue(methods.size() >= 15, "Number of methods found should have been atleast 15.");
+        int size = expected.size();
+        Assert.assertTrue(methods.size() >= size, "Number of methods found should have been atleast " + size);
         for (Method method : methods) {
             if ("$jacocoInit".equalsIgnoreCase(method.getName())) {
                 continue;
             }
             Assert.assertTrue(expected.contains(method.getName()));
         }
     }
+
+    private static List<String> getExpected(String... additionalMethods) {
+        String[] defaultMethods = new String[]{"announcer", "announcer", "inheritable", "inheritable"};
+        if (additionalMethods == null) {
+            return Arrays.asList(defaultMethods);
+        }
+        List<String> expected = new ArrayList<>(Arrays.asList(defaultMethods));
+        expected.addAll(Arrays.asList(additionalMethods));
+        return expected;
+    }
 }