org.approvaltests.namer.AttributeStackSelector Maven / Gradle / Ivy
package org.approvaltests.namer;
import com.spun.util.FormattedException;
import com.spun.util.ObjectUtils;
import com.spun.util.ThreadUtils;
import com.spun.util.io.StackElementSelector;
import com.spun.util.tests.TestUtils;
import org.approvaltests.integrations.junit5.JUnitUtils;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
public class AttributeStackSelector implements StackElementSelector
{
public static String[] classNames = {"org.testng.annotations.Test",
"org.junit.Test",
"org.junit.jupiter.api.Test",
"org.junit.jupiter.api.TestFactory",
"org.junit.jupiter.api.RepeatedTest",
"org.junit.jupiter.params.ParameterizedTest"};
private List> attributes;
public AttributeStackSelector()
{
attributes = getAvailableAttributes();
}
private List> getAvailableAttributes()
{
ArrayList> attributes = new ArrayList>();
for (String className : classNames)
{
Class clazz = loadClass(className);
if (clazz != null)
{
attributes.add(clazz);
}
}
return attributes;
}
public static Class loadClass(String className)
{
Class clazz = null;
try
{
clazz = (Class) ObjectUtils.loadClass(className);
}
catch (Throwable e)
{
clazz = null;
}
return clazz;
}
@Override
public StackTraceElement selectElement(StackTraceElement[] trace)
{
boolean inTestCase = false;
for (int i = 0; i < trace.length; i++)
{
if (isTestCase(trace[i]))
{
inTestCase = true;
}
else if (inTestCase)
{ return trace[i - 1]; }
}
throw new RuntimeException(
"Could not find Junit/TestNg TestCase you are running, supported frameworks: Junit3, Junit4, Junit5, TestNg");
}
private boolean isTestCase(StackTraceElement element)
{
String fullClassName = element.getClassName();
Class clazz = loadClass(fullClassName);
if (clazz == null)
{ return false; }
if (isJunit3Test(clazz))
{ return true; }
if (isTestAttribute(clazz, TestUtils.unrollLambda(element.getMethodName())))
{ return true; }
if (isTestableMethod(element))
{ return true; }
return false;
}
public static Boolean isJunit5Present = null;
public static boolean isTestableMethod(StackTraceElement element)
{
if (isJunit5Present == null)
{
try
{
Class.forName("org.junit.platform.commons.annotation.Testable");
isJunit5Present = true;
}
catch (ClassNotFoundException e)
{
isJunit5Present = false;
}
}
if (!isJunit5Present)
{ return false; }
return JUnitUtils.isTestableMethodForJunit(element);
}
private boolean isJunit3Test(Class clazz)
{
Class testcase = loadClass("junit.framework.TestCase");
return testcase != null && ObjectUtils.isThisInstanceOfThat(clazz, testcase);
}
private boolean isTestAttribute(Class clazz, String methodName)
{
List methods = getMethodsByName(clazz, methodName);
if (methods.isEmpty())
{ return false; }
for (Method method : methods)
{
for (Class attribute : attributes)
{
if (method.isAnnotationPresent(attribute))
{
checkConditionsForAttribute(attribute);
return true;
}
}
}
return false;
}
// TODO: clean this up, should be pluggable
private static void checkConditionsForAttribute(Class attribute)
{
if ("org.junit.jupiter.api.TestFactory".equals(attribute.getName()))
{
if (!isDynamicWrapperPresent())
{
throw new FormattedException("When using dynamic tests and Approvals, you need to use %s instead.",
"org.approvaltests.integrations.junit5.JupiterApprovals.dynamicTest(String, Executable)");
}
}
}
private static boolean isDynamicWrapperPresent()
{
StackTraceElement[] stackTrace = ThreadUtils.getStackTrace();
for (StackTraceElement stackTraceElement : stackTrace)
{
if ("org.approvaltests.integrations.junit5.JupiterApprovals".equals(stackTraceElement.getClassName()))
{ return true; }
}
return false;
}
public static List getMethodsByName(Class clazz, String methodName)
{
try
{
return Arrays.stream(clazz.getDeclaredMethods()).filter(m -> m.getName().equals(methodName))
.collect(Collectors.toList());
}
catch (Throwable e)
{
return new ArrayList<>();
}
}
@Override
public void increment()
{
//ignore
}
}