org.sahagin.runlib.srctreegen.ASTUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sahagin Show documentation
Show all versions of sahagin Show documentation
Sahagin makes your Selenium script more readable and maintainable.
package org.sahagin.runlib.srctreegen;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang3.tuple.Pair;
import org.eclipse.jdt.core.dom.IAnnotationBinding;
import org.eclipse.jdt.core.dom.IMemberValuePairBinding;
import org.eclipse.jdt.core.dom.IMethodBinding;
import org.eclipse.jdt.core.dom.ITypeBinding;
import org.eclipse.jdt.core.dom.IVariableBinding;
import org.sahagin.runlib.external.CaptureStyle;
import org.sahagin.runlib.external.Locale;
import org.sahagin.runlib.external.Page;
import org.sahagin.runlib.external.Pages;
import org.sahagin.runlib.external.TestDoc;
import org.sahagin.runlib.external.TestDocs;
import org.sahagin.share.AcceptableLocales;
public class ASTUtils {
// Get the method annotation whose class name is equals to annotationClass canonical name.
// Return null if specified name annotation is not found.
public static IAnnotationBinding getAnnotationBinding(
IAnnotationBinding[] annotations, String annotationClassName) {
if (annotations == null) {
return null;
}
if (annotationClassName == null) {
throw new NullPointerException();
}
for (IAnnotationBinding annotation : annotations) {
String qName = annotation.getAnnotationType().getBinaryName();
assert qName != null;
if (qName.equals(annotationClassName)) {
return annotation;
}
}
return null;
}
// Get the method annotation whose class equals to annotationClass.
// Return null if specified name annotation is not found.
public static IAnnotationBinding getAnnotationBinding(
IAnnotationBinding[] annotations, Class annotationClass) {
if (annotationClass == null) {
throw new NullPointerException();
}
return getAnnotationBinding(annotations, annotationClass.getCanonicalName());
}
// returns null if specified varName annotation is not found
public static Object getAnnotationValue(IAnnotationBinding annotation, String varName) {
if (annotation == null) {
throw new NullPointerException();
}
if (varName == null) {
throw new NullPointerException();
}
for (IMemberValuePairBinding value : annotation.getDeclaredMemberValuePairs()) {
if (value.getName() != null && value.getName().equals(varName)) {
assert value.getValue() != null; // annotation value cannot be null
assert !(value.getValue() instanceof IVariableBinding);
return value.getValue();
}
}
return null;
}
// - for example, returns string "STEP_IN" for CaptureStyle.STEP_IN
// returns null if specified varName annotation is not found
public static String getEnumAnnotationFieldName(IAnnotationBinding annotation, String varName) {
if (annotation == null) {
throw new NullPointerException();
}
if (varName == null) {
throw new NullPointerException();
}
for (IMemberValuePairBinding value : annotation.getDeclaredMemberValuePairs()) {
if (value.getName() != null && value.getName().equals(varName)) {
assert value.getValue() != null; // annotation value cannot be null
assert value.getValue() instanceof IVariableBinding;
IVariableBinding varBinding = (IVariableBinding) value.getValue();
assert varBinding.isEnumConstant();
return varBinding.getName();
}
}
return null;
}
// returns default value if varName value is not specified
public static CaptureStyle getAnnotationCaptureStyleValue(
IAnnotationBinding annotation, String varName) {
String fieldName = getEnumAnnotationFieldName(annotation, varName);
if (fieldName == null) {
return CaptureStyle.getDefault();
}
CaptureStyle resultCaptureStyle = CaptureStyle.valueOf(fieldName);
if (resultCaptureStyle == null) {
throw new RuntimeException("invalid captureStyle: " + fieldName);
}
return resultCaptureStyle;
}
// returns default value if varName value is not specified
public static Locale getAnnotationLocaleValue(
IAnnotationBinding annotation, String varName) {
String fieldName = getEnumAnnotationFieldName(annotation, varName);
if (fieldName == null) {
return Locale.getDefault();
}
Locale resultLocale = Locale.valueOf(fieldName);
if (resultLocale == null) {
throw new RuntimeException("invalid locale: " + fieldName);
}
return resultLocale;
}
// return empty list and null pair if no TestDoc is found
private static Pair, CaptureStyle> getAllTestDocs(
IAnnotationBinding[] annotations) {
IAnnotationBinding testDocAnnotation = getAnnotationBinding(annotations, TestDoc.class);
IAnnotationBinding testDocsAnnotation = getAnnotationBinding(annotations, TestDocs.class);
if (testDocAnnotation != null && testDocsAnnotation != null) {
// TODO throw IllegalTestScriptException
throw new RuntimeException("don't use @TestDoc and @TestDocs at the same place");
}
// all testDoc value on @TestDoc and @TestDocs
List allTestDocAnnotations = new ArrayList(2);
CaptureStyle resultCaptureStyle = null;
if (testDocAnnotation != null) {
// get @TestDoc
allTestDocAnnotations.add(testDocAnnotation);
resultCaptureStyle = getAnnotationCaptureStyleValue(testDocAnnotation, "capture");
} else if (testDocsAnnotation != null) {
// get @TestDoc from @TestDocs
Object value = getAnnotationValue(testDocsAnnotation, "value");
Object[] values = (Object[]) value;
for (Object element : values) {
IAnnotationBinding binding = (IAnnotationBinding) element;
if (getEnumAnnotationFieldName(binding, "capture") != null) {
// TODO throw IllegalTestScriptException
throw new RuntimeException(
"capture must be set on not @TestDoc but @TestDocs");
}
allTestDocAnnotations.add(binding);
}
resultCaptureStyle = getAnnotationCaptureStyleValue(testDocsAnnotation, "capture");
}
// get resultTestDocMap
Map resultTestDocMap
= new HashMap(allTestDocAnnotations.size());
for (IAnnotationBinding eachTestDocAnnotation : allTestDocAnnotations) {
Object value = getAnnotationValue(eachTestDocAnnotation, "value");
Locale locale = getAnnotationLocaleValue(eachTestDocAnnotation, "locale");
resultTestDocMap.put(locale, (String) value);
}
return Pair.of(resultTestDocMap, resultCaptureStyle);
}
// return empty list and null pair if no Page is found
private static Map getAllPageTestDocs(
IAnnotationBinding[] annotations) {
IAnnotationBinding pageAnnotation = getAnnotationBinding(annotations, Page.class);
IAnnotationBinding pagesAnnotation = getAnnotationBinding(annotations, Pages.class);
if (pageAnnotation != null && pagesAnnotation != null) {
// TODO throw IllegalTestScriptException
throw new RuntimeException("don't use @Page and @Pages at the same place");
}
// all testDoc value on @Page and @Pages
List allPageAnnotations = new ArrayList(2);
if (pageAnnotation != null) {
// get @Page
allPageAnnotations.add(pageAnnotation);
} else if (pagesAnnotation != null) {
// get @Page from @Pages
Object value = getAnnotationValue(pagesAnnotation, "value");
Object[] values = (Object[]) value;
for (Object element : values) {
allPageAnnotations.add((IAnnotationBinding) element);
}
}
// get resultPageMap
Map resultPageMap
= new HashMap(allPageAnnotations.size());
for (IAnnotationBinding eachPageAnnotation : allPageAnnotations) {
Object value = getAnnotationValue(eachPageAnnotation, "value");
Locale locale = getAnnotationLocaleValue(eachPageAnnotation, "locale");
resultPageMap.put(locale, (String) value);
}
return resultPageMap;
}
// first... value
// second... captureStyle value.
// return null pair if no TestDoc is found
private static Pair getTestDoc(
IAnnotationBinding[] annotations, AcceptableLocales locales) {
Pair, CaptureStyle> allTestDocs = getAllTestDocs(annotations);
Map testDocMap = allTestDocs.getLeft();
if (testDocMap.isEmpty()) {
return Pair.of(null, null); // no @TestDoc found
}
String testDoc = null;
for (Locale locale : locales.getLocales()) {
String value = testDocMap.get(locale);
if (value != null) {
testDoc = value;
break;
}
}
if (testDoc == null) {
// set empty string if no locale matched data is found
return Pair.of("", allTestDocs.getRight());
} else {
return Pair.of(testDoc, allTestDocs.getRight());
}
}
// return null if no Page found
private static String getPageTestDoc(
IAnnotationBinding[] annotations, AcceptableLocales locales) {
Map allPages = getAllPageTestDocs(annotations);
if (allPages.isEmpty()) {
return null; // no @Page found
}
for (Locale locale : locales.getLocales()) {
String value = allPages.get(locale);
if (value != null) {
return value;
}
}
// set empty string if no locale matched data is found
return "";
}
// return null if not found
public static String getPageTestDoc(ITypeBinding type, AcceptableLocales locales) {
return getPageTestDoc(type.getAnnotations(), locales);
}
// return null if not found
public static String getTestDoc(ITypeBinding type, AcceptableLocales locales) {
Pair pair = getTestDoc(type.getAnnotations(), locales);
return pair.getLeft();
}
// return null pair if not found
public static Pair getTestDoc(
IMethodBinding method, AcceptableLocales locales) {
return getTestDoc(method.getAnnotations(), locales);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy