DiffNodeFieldAnnotationsTest.groovy unit tests

Author: Gabor Nagy

src/main/java/de/danielbechler/diff/introspection/PropertyAccessor.java

@@ -103,12 +103,16 @@ private Set<Annotation> getFieldAnnotations(final Class<?> clazz) {
 	}
 
 	/**
-	 * @return The annotations of the field.
+	 * @return The annotations of the field, or an empty set if there is no field with the name derived from the getter.
 	 */
 	public Set<Annotation> getFieldAnnotations() {
 		return getFieldAnnotations(readMethod.getDeclaringClass());
 	}
 
+	/**
+	 * @return The given annotation of the field, or null if not annotated or if there is no field with the name derived
+	 * from the getter.
+	 */
 	public <T extends Annotation> T getFieldAnnotation(final Class<T> annotationClass) {
 		final Set<? extends Annotation> annotations = getFieldAnnotations();
 		assert (annotations != null) : "Something is wrong here. " +

src/main/java/de/danielbechler/diff/node/DiffNode.java

@@ -448,7 +448,7 @@ public final void visitParents(final Visitor visitor)
 	 *
 	 * Only works for fields having a name that matches the name derived from the getter.
 	 *
-	 * @return A set of annotations of this nodes property field or an empty set.
+	 * @return The annotations of the field, or an empty set if there is no field with the name derived from the getter.
 	 */
 	public Set<Annotation> getFieldAnnotations()
 	{
@@ -459,6 +459,12 @@ public Set<Annotation> getFieldAnnotations()
 		return unmodifiableSet(Collections.<Annotation>emptySet());
 	}
 
+	/**
+	 * @param annotationClass the annotation we are looking for
+	 * @param <T>
+	 * @return The given annotation of the field, or null if not annotated or if there is no field with the name derived
+	 * from the getter.
+	 */
 	public <T extends Annotation> T getFieldAnnotation(final Class<T> annotationClass)
 	{
 		if (accessor instanceof PropertyAwareAccessor)

src/test/java/de/danielbechler/diff/node/DiffNodeFieldAnnotationsTest.groovy

@@ -0,0 +1,129 @@
+/*
+ * Copyright 2014 Daniel Bechler
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package de.danielbechler.diff.node
+
+import de.danielbechler.diff.access.Accessor
+import de.danielbechler.diff.introspection.PropertyAccessor
+import de.danielbechler.diff.selector.BeanPropertyElementSelector
+import spock.lang.Specification
+
+class DiffNodeFieldAnnotationsTest extends Specification {
+
+	def 'getFieldAnnotation(): returns null if not PropertyAwareAccessor'() {
+		given:
+            def accessor = Mock(Accessor) {
+                getElementSelector() >> new BeanPropertyElementSelector('f')
+            }
+		    def diffNode = new DiffNode(null, accessor, A)
+		expect:
+			diffNode.fieldAnnotations.size() == 0
+		    diffNode.getFieldAnnotation(SomeFieldAnnotation) == null
+	}
+
+	def 'getFieldAnnotation(): class has the field and annotated'() {
+		given:
+			def accessor = new PropertyAccessor("f", A.getMethod("getF"), A.getMethod("setF", String))
+			def diffNode = new DiffNode(null, accessor, A)
+		expect:
+			diffNode.fieldAnnotations.size() == 1
+			diffNode.getFieldAnnotation(SomeFieldAnnotation) != null
+			diffNode.getFieldAnnotation(SomeFieldAnnotation).annotationType() == SomeFieldAnnotation
+	}
+
+	def 'getFieldAnnotation(): class does not have the field, or different name'() {
+		given:
+            def accessor = new PropertyAccessor("F", ADiffName.getMethod("getF"), null)
+            def diffNode = new DiffNode(null, accessor, ADiffName)
+		expect:
+			diffNode.fieldAnnotations.size() == 0
+            diffNode.getFieldAnnotation(SomeFieldAnnotation) == null
+	}
+
+	def 'getFieldAnnotation(): inheritance'() {
+		given:
+		def accessor = new PropertyAccessor("f", AB.getMethod("getF"), AB.getMethod("setF", String))
+		def diffNode = new DiffNode(null, accessor, AB)
+		expect:
+		diffNode.fieldAnnotations.size() == 1
+		diffNode.getFieldAnnotation(SomeFieldAnnotation) != null
+		diffNode.getFieldAnnotation(SomeFieldAnnotation).annotationType() == SomeFieldAnnotation
+	}
+
+	def 'getFieldAnnotation(): inheritance, overridden getter'() {
+		given:
+		def accessor = new PropertyAccessor("f", ABGetter.getMethod("getF"), ABGetter.getMethod("setF", String))
+		def diffNode = new DiffNode(null, accessor, ABGetter)
+		expect:
+		diffNode.fieldAnnotations.size() == 1
+		diffNode.getFieldAnnotation(SomeFieldAnnotation) != null
+		diffNode.getFieldAnnotation(SomeFieldAnnotation).annotationType() == SomeFieldAnnotation
+	}
+
+	def 'getFieldAnnotation(): inheritance, not annotated'() {
+		given:
+		def accessor = new PropertyAccessor("f", NAB.getMethod("getF"), NAB.getMethod("setF", String))
+		def diffNode = new DiffNode(null, accessor, NAB)
+		expect:
+		diffNode.fieldAnnotations.size() == 0
+		diffNode.getFieldAnnotation(SomeFieldAnnotation) == null
+	}
+
+	def 'getFieldAnnotation(): inheritance, overridden getter, not annotated'() {
+		given:
+		def accessor = new PropertyAccessor("f", NABGetter.getMethod("getF"), NABGetter.getMethod("setF", String))
+		def diffNode = new DiffNode(null, accessor, NABGetter)
+		expect:
+		diffNode.fieldAnnotations.size() == 0
+		diffNode.getFieldAnnotation(SomeFieldAnnotation) == null
+	}
+
+	public static class A {
+		@SomeFieldAnnotation
+		String f;
+	}
+
+	public static class NA {
+		String f;
+	}
+
+    public static class ADiffName {
+        public String getF() {
+            return null;
+        }
+    }
+
+	public static class AB extends A {
+	}
+
+	public static class ABGetter extends A {
+		@Override
+		public String getF() {
+			return null;
+		}
+	}
+
+	public static class NAB extends NA {
+	}
+
+	public static class NABGetter extends NA {
+		@Override
+		public String getF() {
+			return null;
+		}
+	}
+
+}

src/test/java/de/danielbechler/diff/node/SomeFieldAnnotation.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2013 Daniel Bechler
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package de.danielbechler.diff.node;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+public @interface SomeFieldAnnotation {
+}