org.safs.rational.ft

Class DynamicEnabler

java.lang.Object

org.safs.rational.ft.DynamicEnabler

public class DynamicEnabler
extends java.lang.Object

IBM Rational Functional Tester V6 and later supports the testing of Win32 and .NET windows and applications. However, these environments are not enabled for testing in the traditional means as seen for Java and other environments. These environments require what Rational calls 'dynamic enabling'.

Essentially, we must already know a window handle, process ID, or process name before we can tell FT to inject itself into that process and enable testing. Since a testing framework that is application-independent cannot be hard-coded to know the desired processname, and cannot readily make assumptions about the correct Window handle or process ID, we are going to effectively enable as many Win32 and .NET environments as we can properly identify.

There is an issue, of course, when attempting to distribute and use this new feature in older XDE Tester and RobotJ environments that do not have this functionality. SAFS code attempting to use it must be wrapped in try\catch(Throwable) blocks because XDE Tester and RobotJ will NOT be able to properly load and initialize this class and they will issue an Error, not an Exception.

This class uses external resource files (text files) to indicate which classes running on the system are to be enabled, and which classes are to be ignored. These files do not represent an all-inclusive list and are subject to updates. There are seperate text files for Windows and Unix. These text files are:

• WindowsClassMap.dat
• WindowsIgnoreClassMap.dat

• UnixClassMap.dat
• UnixIgnoreClassMap.dat

The WindowsClassMap and WindowsIgnoreClassMap files are provided in the distributed JAR file. The Unix files are not yet distributed as their contents has not yet been deduced.

This class allows a user or tester to place an identically named resource file in the same directory where the JAR file is found and that external file will add additional mappings and ignores to those in the JAR file.

Author:

Carl Nagle SEP 02, 2005, Carl Nagle NOV 12, 2007 Added support for custom DAT files in Class & JAR directory., WangLei NOV 07, 2008 Added .net related field and methods enableNetWindows(), Carl Nagle APR 03, 2009 Refactored primarily removing need for ClassMap.dat files on Windows. Also added JNA usage to help find ALL processes that can be enabled., Carl Nagle Jun 04, 2009 Added getJNAProtectedDomainTopObjects, Carl Nagle Aug 07, 2009 Added Process= support to enable only one or more specific processes., Carl Nagle Apr 16, 2010 Handle NullPointerExceptions in loadWinEnabled when RFT starts to act up., LeiWang Sep 14, 2011 Modify method simpleEnableTopWindows(): Don't enable 'System Idle Process'. Copyright (C) (SAS) All rights reserved. General Public License: http://www.opensource.org/licenses/gpl-license.php

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DOTNET_CLASS_MAP "DotNetClassMap.dat"
static java.lang.String	DEFAULT_SWT_CLASS_MAP "SWTClassMap.dat"
static java.lang.String	DEFAULT_UNIX_CLASS_MAP "UnixClassMap.dat"
static java.lang.String	DEFAULT_UNIX_IGNORE_CLASS_MAP "UnixIgnoreClassMap.dat"
static java.lang.String	DEFAULT_WINDOWS_CLASS_MAP "WindowsClassMap.dat"
static java.lang.String	DEFAULT_WINDOWS_IGNORE_CLASS_MAP "WindowsIgnoreClassMap.dat"
(package private) static java.util.Vector	enabledomains
(package private) static java.util.Vector	enablenet .NET classes that CAN be enabled.
(package private) static java.util.Vector	enableprocs Strings.
(package private) static java.util.Vector	enableswt SWT classes that CAN be enabled.
(package private) static java.util.Vector	enablewins Window classes or processes that CAN be enabled.
(package private) static java.lang.String	GENERIC_WILDCARD "*"
(package private) static boolean	ignore_classmap_read
(package private) static java.lang.String	ignoremap
(package private) static java.util.Vector	ignorewins Window classes or processes that should be ignored.
(package private) static java.lang.String	mainmap
(package private) static boolean	net_classmap_read
(package private) static java.lang.String	netmap
(package private) static java.lang.String	REGEX_WILDCARD ".*"
(package private) static com.rational.test.ft.object.interfaces.RootTestObject	rto FT 6.x Unique Class object for dynamic enabling
(package private) static boolean	swt_classmap_read
(package private) static java.lang.String	swtmap
(package private) static boolean	win_classmap_read
(package private) static java.util.Vector	winenabled Window classes or processes that HAVE already been enabled.

Constructor Summary

Constructors

Constructor and Description
DynamicEnabler()

Method Summary

Modifier and Type	Method and Description
static void	addEnabledDomain(java.lang.String domainname)
static void	addEnabledProc(java.lang.String procname)
static void	clearEnabledDomains()
static void	clearEnabledProcs()
static java.util.Vector	enableNetWindows()
static java.util.Vector	enableSWTWindows()
protected static int	enableUniqueWinsWithJNA()
static java.util.Vector	enableWinWindows()
static com.rational.test.ft.object.interfaces.TestObject[]	getJNAProtectedDomainTopObjects(com.rational.test.ft.object.interfaces.DomainTestObject domain) Calls domain.getTopObjects() ONLY if the domain's process is determined to have active UI resources.
static java.util.ArrayList	getRootTestObjectWindows(java.util.Vector classes) Returns all found matching classes in the provided domain as an ArrayList of TestObjects.
static boolean	hasEnabledDomain()
static boolean	hasEnabledProc()
static boolean	ignoreTopWindow(java.lang.String classname) Determine if a particular classname is one we know to ignore.
static boolean	isEnabledDomain(java.lang.String domainname)
static boolean	isEnabledProc(java.lang.String procname)
static boolean	isTopParentWinFocused(Script script, int processID) Try to "find" the TopLevelWindow associated with a processID and return true if it is the topmost window-- the one with keyboard focus.
protected static void	loadWinEnabled()
protected static long	simpleEnableTopWindows() Dynamically enable all Top Windows or processes.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WINDOWS_CLASS_MAP

public static final java.lang.String DEFAULT_WINDOWS_CLASS_MAP

"WindowsClassMap.dat"

See Also:

Constant Field Values

DEFAULT_WINDOWS_IGNORE_CLASS_MAP

public static final java.lang.String DEFAULT_WINDOWS_IGNORE_CLASS_MAP

"WindowsIgnoreClassMap.dat"

See Also:

Constant Field Values

DEFAULT_SWT_CLASS_MAP

public static final java.lang.String DEFAULT_SWT_CLASS_MAP

"SWTClassMap.dat"

See Also:

Constant Field Values

DEFAULT_DOTNET_CLASS_MAP

public static final java.lang.String DEFAULT_DOTNET_CLASS_MAP

"DotNetClassMap.dat"

See Also:

Constant Field Values

DEFAULT_UNIX_CLASS_MAP

public static final java.lang.String DEFAULT_UNIX_CLASS_MAP

"UnixClassMap.dat"

See Also:

Constant Field Values

DEFAULT_UNIX_IGNORE_CLASS_MAP

public static final java.lang.String DEFAULT_UNIX_IGNORE_CLASS_MAP

"UnixIgnoreClassMap.dat"

See Also:

Constant Field Values

rto

static com.rational.test.ft.object.interfaces.RootTestObject rto

FT 6.x Unique Class object for dynamic enabling

ignorewins

static java.util.Vector ignorewins

Window classes or processes that should be ignored.

ignore_classmap_read

static boolean ignore_classmap_read

enablewins

static java.util.Vector enablewins

Window classes or processes that CAN be enabled.

win_classmap_read

static boolean win_classmap_read

enableswt

static java.util.Vector enableswt

SWT classes that CAN be enabled.

swt_classmap_read

static boolean swt_classmap_read

enablenet

static java.util.Vector enablenet

.NET classes that CAN be enabled.

net_classmap_read

static boolean net_classmap_read

winenabled

static java.util.Vector winenabled

Window classes or processes that HAVE already been enabled.

swtmap

static java.lang.String swtmap

mainmap

static java.lang.String mainmap

netmap

static java.lang.String netmap

ignoremap

static java.lang.String ignoremap

enableprocs

static java.util.Vector enableprocs

Strings. process names to enable.

enabledomains

static java.util.Vector enabledomains

REGEX_WILDCARD

static java.lang.String REGEX_WILDCARD

".*"

GENERIC_WILDCARD

static java.lang.String GENERIC_WILDCARD

"*"

Constructor Detail

DynamicEnabler

public DynamicEnabler()

Method Detail

clearEnabledProcs

public static void clearEnabledProcs()

clearEnabledDomains

public static void clearEnabledDomains()

addEnabledProc

public static void addEnabledProc(java.lang.String procname)

hasEnabledProc

public static boolean hasEnabledProc()

isEnabledProc

public static boolean isEnabledProc(java.lang.String procname)

addEnabledDomain

public static void addEnabledDomain(java.lang.String domainname)

hasEnabledDomain

public static boolean hasEnabledDomain()

isEnabledDomain

public static boolean isEnabledDomain(java.lang.String domainname)

enableSWTWindows

public static java.util.Vector enableSWTWindows()

enableWinWindows

public static java.util.Vector enableWinWindows()

enableNetWindows

public static java.util.Vector enableNetWindows()

getRootTestObjectWindows

public static java.util.ArrayList getRootTestObjectWindows(java.util.Vector classes)

Returns all found matching classes in the provided domain as an ArrayList of TestObjects. As of RFT 2.0 the act of locating the matching class and converting it to a TestObject also "enables" that process. So attempting to "enable" then "find" is a duplicated effort.

Parameters:

classes -

domain -

Returns:

ArrayList of TestObjects or an empty ArrayList

isTopParentWinFocused

public static boolean isTopParentWinFocused(Script script,
                                            int processID)

Try to "find" the TopLevelWindow associated with a processID and return true if it is the topmost window-- the one with keyboard focus. In the process of "finding" the window the process should be enabled for testing.

Parameters:

script -

processID -

Returns:

true if the process has the window with the current keyboard focus.

See Also:

RDDGUIUtilities.getParentTestObject(TestObject)

loadWinEnabled

protected static void loadWinEnabled()

enableUniqueWinsWithJNA

protected static int enableUniqueWinsWithJNA()

simpleEnableTopWindows

protected static long simpleEnableTopWindows()

Dynamically enable all Top Windows or processes. However, if enableprocs contains one or more process names then we will only enable windows and processes matching the names in enableprocs.

Returns:

long number of top windows enabled or 0 if not successful.

See Also:

#getRootTestObjectWindows(Vector, String), enableprocs

ignoreTopWindow

public static boolean ignoreTopWindow(java.lang.String classname)

Determine if a particular classname is one we know to ignore. For example, a class that is always used by the true target class, like a tooltip class.

Parameters:

classname - of an object found within the list of all running classes.

Returns:

true if the provided classname exists in our ignorewins list.

getJNAProtectedDomainTopObjects

public static com.rational.test.ft.object.interfaces.TestObject[] getJNAProtectedDomainTopObjects(com.rational.test.ft.object.interfaces.DomainTestObject domain)

Calls domain.getTopObjects() ONLY if the domain's process is determined to have active UI resources. However, if there are any problems in determining if the process is using UI resources then we typically will just call domain.getTopObjects() anyways.

Parameters:

domain -

Returns: