Skip to content

Commit

Permalink
Introduced visitor for JUnit5Testable to get rid of instanceof testing
Browse files Browse the repository at this point in the history
  • Loading branch information
@jlink
jlink committed Nov 5, 2015
1 parent ae2d2b2 commit d3d57db
Show file tree
Hide file tree
Showing 6 changed files with 298 additions and 185 deletions.
29 changes: 29 additions & 0 deletions junit5-engine/src/main/java/org/junit/gen5/engine/junit5/descriptor/JUnit5Class.java
View file
@@ -0,0 +1,29 @@
/*
* Copyright 2015 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v10.html
*/

package org.junit.gen5.engine.junit5.descriptor;

import lombok.Value;

@Value
public class JUnit5Class extends JUnit5Testable {

private final Class<?> javaClass;

JUnit5Class(String uniqueId, Class<?> javaClass) {
super(uniqueId);
this.javaClass = javaClass;
}

public void accept(Visitor visitor) {
visitor.visitClass(getUniqueId(), javaClass);
}

}
33 changes: 33 additions & 0 deletions junit5-engine/src/main/java/org/junit/gen5/engine/junit5/descriptor/JUnit5Method.java
View file
@@ -0,0 +1,33 @@
/*
* Copyright 2015 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v10.html
*/

package org.junit.gen5.engine.junit5.descriptor;

import java.lang.reflect.Method;

import lombok.Value;

@Value
public class JUnit5Method extends JUnit5Testable {

private final Class<?> containerClass;
private final Method javaMethod;

JUnit5Method(String uniqueId, Method javaElement, Class<?> containerClass) {
super(uniqueId);
this.javaMethod = javaElement;
this.containerClass = containerClass;
}

public void accept(Visitor visitor) {
visitor.visitMethod(getUniqueId(), javaMethod, containerClass);
}

}
159 changes: 14 additions & 145 deletions junit5-engine/src/main/java/org/junit/gen5/engine/junit5/descriptor/JUnit5Testable.java
View file
Expand Up @@ -10,173 +10,42 @@


package org.junit.gen5.engine.junit5.descriptor; package org.junit.gen5.engine.junit5.descriptor;


import static org.junit.gen5.commons.util.ReflectionUtils.loadClass;

import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

import lombok.Value;

import org.junit.gen5.commons.util.Preconditions;
import org.junit.gen5.commons.util.ReflectionUtils;

@Value
public class JUnit5Testable {


private static final String SEPARATORS = ":$#"; public abstract class JUnit5Testable {

private static List<String> split(String uniqueId) {
List<String> parts = new ArrayList<>();
String currentPart = "";
for (char c : uniqueId.toCharArray()) {
if (SEPARATORS.contains(Character.toString(c))) {
parts.add(currentPart);
currentPart = "";
}
currentPart += c;
}
parts.add(currentPart);
return parts;
}


public static JUnit5Testable fromUniqueId(String uniqueId, String engineId) { public static JUnit5Testable fromUniqueId(String uniqueId, String engineId) {
Preconditions.notEmpty(uniqueId, "uniqueId must not be empty"); return new JUnit5TestableFactory().fromUniqueId(uniqueId, engineId);
List<String> parts = split(uniqueId);
Preconditions.condition(parts.remove(0).equals(engineId), "uniqueId must start with engineId");

return createElement(uniqueId, parts);
} }


public static JUnit5Testable fromClassName(String className, String engineId) { public static JUnit5Testable fromClassName(String className, String engineId) {
Preconditions.notEmpty(className, "className must not be empty"); return new JUnit5TestableFactory().fromClassName(className, engineId);
Class<?> clazz = classByName(className);
if (clazz == null) {
throwCannotResolveClassNameException(className);
}
return fromClass(clazz, engineId);
} }


public static JUnit5Testable fromClass(Class<?> clazz, String engineId) { public static JUnit5Testable fromClass(Class<?> clazz, String engineId) {
Preconditions.notNull(clazz, "clazz must not be null"); return new JUnit5TestableFactory().fromClass(clazz, engineId);
String uniqueId = engineId + ":" + clazz.getName();
return new JUnit5Testable(uniqueId, clazz, null);
} }


public static JUnit5Testable fromMethod(Method testMethod, Class<?> clazz, String engineId) { public static JUnit5Testable fromMethod(Method testMethod, Class<?> clazz, String engineId) {
String uniqueId = fromClass(clazz, engineId).getUniqueId() + "#" + testMethod.getName() return new JUnit5TestableFactory().fromMethod(testMethod, clazz, engineId);
+ getParameterIdPart(testMethod);
return new JUnit5Testable(uniqueId, testMethod, clazz);
}

public static String getParameterIdPart(Method testMethod) {
String parameterString = Arrays.stream(testMethod.getParameterTypes()).map(Class::getName).collect(
Collectors.joining(","));
return "(" + parameterString + ")";
}

private static JUnit5Testable createElement(String uniqueId, List<String> parts) {
AnnotatedElement currentJavaElement = null;
Class<?> currentJavaContainer = null;
String head = parts.remove(0);
while (true) {
switch (head.charAt(0)) {
case ':':
currentJavaElement = findTopLevelClass(head);
break;
case '$':
currentJavaContainer = (Class<?>) currentJavaElement;
currentJavaElement = findNestedClass(head, (Class<?>) currentJavaElement);
break;
case '#':
currentJavaContainer = (Class<?>) currentJavaElement;
currentJavaElement = findMethod(head, currentJavaContainer, uniqueId);
break;
default:
currentJavaContainer = null;
currentJavaElement = null;
}

if (currentJavaElement == null) {
throwCannotResolveUniqueIdException(uniqueId, head);
}
if (parts.isEmpty())
break;
head = parts.remove(0);
}
return new JUnit5Testable(uniqueId, currentJavaElement, currentJavaContainer);
}

private static Method findMethod(String methodSpecPart, Class<?> clazz, String uniqueId) {
int startParams = methodSpecPart.indexOf('(');
String methodName = methodSpecPart.substring(1, startParams);
int endParams = methodSpecPart.lastIndexOf(')');
String paramsPart = methodSpecPart.substring(startParams + 1, endParams);
Class<?>[] parameterTypes = findParameterTypes(paramsPart, uniqueId);
return findMethod(clazz, methodName, parameterTypes);
}

private static <R> Class<?>[] findParameterTypes(String paramsPart, String uniqueId) {
if (paramsPart.isEmpty()) {
return new Class<?>[0];
}
List<Class<?>> types = Arrays.stream(paramsPart.split(",")).map(typeName -> {
try {
return ReflectionUtils.loadClass(typeName);
}
catch (ClassNotFoundException e) {
throwCannotResolveUniqueIdException(uniqueId, paramsPart);
return null; //cannot happen
}
}).collect(Collectors.toList());
return types.toArray(new Class<?>[types.size()]);
} }


private static Method findMethod(Class<?> clazz, String methodName, Class<?>[] parameterTypes) { private final String uniqueId;
return ReflectionUtils.findMethod(clazz, methodName, parameterTypes).orElseThrow(
() -> new IllegalArgumentException(String.format("No method with 'name' %s and paramter types '%s'",
methodName, Arrays.toString(parameterTypes))));
}

private static Class<?> findNestedClass(String nameExtension, Class<?> containerClass) {
String fullClassName = containerClass.getName() + nameExtension;
return classByName(fullClassName);
}


private static Class<?> findTopLevelClass(String classNamePart) { JUnit5Testable(String uniqueId) {
String className = classNamePart.substring(1); this.uniqueId = uniqueId;
return classByName(className);
} }


private static Class<?> classByName(String className) { abstract void accept(Visitor visitor);
try {
return loadClass(className);
}
catch (ClassNotFoundException e) {
return null;
}
}


private static void throwCannotResolveClassNameException(String className) { public String getUniqueId() {
throw new IllegalArgumentException(String.format("Cannot resolve class name '%s'", className)); return uniqueId;
} }


private static void throwCannotResolveUniqueIdException(String fullUniqueId, String uniqueIdPart) { public interface Visitor {
throw new IllegalArgumentException(
String.format("Cannot resolve part '%s' of unique id '%s'", uniqueIdPart, fullUniqueId));
}


private final String uniqueId; void visitClass(String uniqueId, Class<?> testClass);
private final AnnotatedElement javaElement;
private final Class<?> javaContainer;


private JUnit5Testable(String uniqueId, AnnotatedElement javaElement, Class<?> javaContainer) { void visitMethod(String uniqueId, Method method, Class<?> container);
this.uniqueId = uniqueId;
this.javaElement = javaElement;
this.javaContainer = javaContainer;
} }

} }

0 comments on commit d3d57db

Please sign in to comment.