org.opendaylight.persistence.util.test

Class TestUtil

java.lang.Object

org.opendaylight.persistence.util.test.TestUtil

public final class TestUtil
extends Object

Utility methods.

Author:

Fabiel Zuniga, Nachiket Abhyankar

Method Summary

Methods

Modifier and Type	Method and Description
static StackTraceElement	getExecutingMethod() Gets the current executing method name.
static <T,E> E	getPrivateField(String fieldName, T obj) Gets a private field using reflection.
static <T,E> E	getPrivateField(String fieldName, T obj, Class<? super T> declaredFieldClass) Gets a private field using reflection.
static <T> void	setPrivateField(String fieldName, Object fieldValue, T obj) Updates the value of a private field using reflection.
static <T> void	setPrivateField(String fieldName, Object fieldValue, T obj, Class<? super T> declaredFieldClass) Updates the value of a private field using reflection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setPrivateField

public static <T> void setPrivateField(String fieldName,
                       Object fieldValue,
                       T obj)
                            throws SecurityException,
                                   NoSuchFieldException,
                                   IllegalArgumentException,
                                   IllegalAccessException

Updates the value of a private field using reflection. The private field must be declared in the object's class and not in a predecessor.

The purpose of this method is to set mocks for dependency objects created internally by the class being tested or injected by frameworks like OSGi. Reflection should not be used to update fields which by design are private.

Parameters:

fieldName - field name

fieldValue - new field's value

obj - instance to update the field on

Throws:

SecurityException - If a security manager, s, is present and any of the following conditions is met: - invocation of s.checkMemberAccess(this, Member.DECLARED) denies access to the declared field - the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of s.checkPackageAccess() denies access to the package of this class.

NoSuchFieldException - if a field with the specified name is not found

IllegalArgumentException - if fieldName is null

IllegalAccessException - if the underlying field is inaccessible

NullPointerException - if either the fieldName or obj is null

setPrivateField

public static <T> void setPrivateField(String fieldName,
                       Object fieldValue,
                       T obj,
                       Class<? super T> declaredFieldClass)
                            throws SecurityException,
                                   NoSuchFieldException,
                                   IllegalArgumentException,
                                   IllegalAccessException

Updates the value of a private field using reflection. The private field must be declared in the declaredFieldClass class and not in a predecessor or ancestor.

The purpose of this method is to set mocks for dependency objects created internally by the class being tested or injected by frameworks like OSGi. Reflection should not be used to update fields which by design are private.

Parameters:

fieldName - field name

fieldValue - new field's value

obj - instance to update the field on

declaredFieldClass - class where the field is located

Throws:

SecurityException - If a security manager, s, is present and any of the following conditions is met: - invocation of s.checkMemberAccess(this, Member.DECLARED) denies access to the declared field - the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of s.checkPackageAccess() denies access to the package of this class.

NoSuchFieldException - if a field with the specified name is not found

IllegalArgumentException - if either the fieldName or obj is null, or if fieldName is empty

IllegalAccessException - if the underlying field is inaccessible

getPrivateField

public static <T,E> E getPrivateField(String fieldName,
                      T obj)
                         throws SecurityException,
                                NoSuchFieldException,
                                IllegalArgumentException,
                                IllegalAccessException

Gets a private field using reflection. The private field must be declared in the object's class and not in a predecessor.

Parameters:

fieldName - field name

obj - instance to get the field from

Returns:

the private field's value

Throws:

SecurityException - If a security manager, s, is present and any of the following conditions is met: - invocation of s.checkMemberAccess(this, Member.DECLARED) denies access to the declared field - the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of s.checkPackageAccess() denies access to the package of this class.

NoSuchFieldException - if a field with the specified name is not found

IllegalArgumentException - if either the fieldName or obj is null, or if fieldName is empty

IllegalAccessException - if the underlying field is inaccessible

getPrivateField

public static <T,E> E getPrivateField(String fieldName,
                      T obj,
                      Class<? super T> declaredFieldClass)
                         throws SecurityException,
                                NoSuchFieldException,
                                IllegalArgumentException,
                                IllegalAccessException

Gets a private field using reflection. The private field must be declared in the declaredFieldClass class and not in a predecessor or ancestor.

Parameters:

fieldName - field name

obj - instance to get the field from

declaredFieldClass - class where the field is located

Returns:

the private field's value

Throws:

SecurityException - If a security manager, s, is present and any of the following conditions is met: - invocation of s.checkMemberAccess(this, Member.DECLARED) denies access to the declared field - the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of s.checkPackageAccess() denies access to the package of this class.

NoSuchFieldException - if a field with the specified name is not found

IllegalArgumentException - if either the fieldName or obj is null, or if fieldName is null

IllegalAccessException - if the underlying field is inaccessible

getExecutingMethod

public static StackTraceElement getExecutingMethod()

Gets the current executing method name. The following example prints: "my.package.MyClassTest.testMyMethod(MyClassTest.java:21)"

 public class MyClassTest {

     @Test
     public void testMyMethod() {
         StackTraceElement executingMethod = TestUtil.getExecutingMethod();
         System.out.println(executingMethod.toString());
     }
 }

 

Returns:

the current method name