org.safs

Class DCDriverMiscCommands

java.lang.Object

org.safs.Processor

org.safs.DriverCommand

org.safs.DCDriverMiscCommands

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

public class DCDriverMiscCommands
extends DriverCommand

Purpose: DCDriverMiscCommands, process a miscellaneous driver commands, like pause
Lifetime: instantiated by DCDriverCommand

Since:

Sep 23, 2003
Sep 23, 2003 (DBauman) Original Release
Oct 02, 2003 (DBauman) moved to package org.safs because no dependency on rational
Nov 14, 2003 (DBauman) adding breakpoint commands:

    BP  -- Breakpoint -- Set a line as a debugging breakpoint.  Debugger stops
                         before processing of the next line if Breakpoints have
                         been Enabled.
    Breakpoints   ON  -- Enable/Disable stopping at BP records.
    CommandDebug  ON  -- Enable/Disable stopping at Driver Command (C) records.
    TestDebug     ON  -- Enable/Disable stopping at Test (T) records.
    RecordsDebug  ON  -- Enable/Disable stopping at every record.
   
   Nov 17, 2003    (DBauman) adding commands:

    CloseApplication, LaunchApplication,
    CopyVariableValueEx, SetVariableValueEx,
    GetSystemDate, GetSystemDateTime, GetSystemTime,
    SetBenchDirectory, SetDifDirectory, SetProjectDirectory, SetTestDirectory,
    SetRootVerifyDirectory
   
   Nov 18, 2003    (DBauman) adding commands:

    SetVariableValues, StartWebBrowser, ClearClipboard, SaveClipboardToFile
   
   Nov 19, 2003    (DBauman) adding commands:

    SetClipboard
   
   Dec 9, 2003    (DBauman) adding commands:

    VerifyClipboardToFile
   
   MAY 02, 2005    (Carl Nagle) adding command AssignClipboardVariable
   
   JUL 27, 2005    (Carl Nagle) adding command CallRemote contributed by Steve Sampson
   
   AUG 04, 2006    (Carl Nagle) adding commands AppMapChaining, AppMapResolve, GetAppMapValue
   
   AUG 22, 2006    (Bob Lawler) updated application() to call Runtime.exec() with null env params for LaunchApplication
   
   APR 15, 2008    (JunwuMa)added GetCompScreenResolution
   
   MAY 27, 2008    (JunwuMa)added ClearAllVariables 
   
   AUG 26, 2008    (Carl Nagle)Fixed formatted output of GetSystemDate, GetSystemTime, GetSystemDateTime 
   
 NOV 12, 2008    (LeiWang)       Modified method application(): if user want to start a batch file app.bat, but he just
                                                                        give the file name "app" without suffix .bat as parameter, Runtime.getRuntime().exce("app")
                                                                        will not work and throw an exception, so I catch this exception and use 
                                                                        Runtime.getRuntime().exce("cmd /c app") to try again.
   
 MAY 19, 2010    (LeiWang) Modify method application(): Use ProcessConsole to deal the stream of stderr and stdout, and
                                                                 exitValue for Process. Add a parameter timeout, use this timeout
                                                                 to wait for the end of Process.
   
 JUN 04, 2010    (Carl Nagle) In application(), check Process exitValue to check for success or failure in launching app.
                                                                        Reverting to correct use of reverted ProcessConsole.
   
   NOV 15, 2011    (Lei Wang) Modify method getSystemDateTime(): Add an optional parameter to make it convert to the military time.
                                   By default, the method will convert date to AM-PM time as before.
   
   JAN 27, 2014    (Lei Wang) Modify method clearArrayVariables(): don't clear SAFS-reserved variables.
   
   APR 29, 2014    (Lei Wang) Modify method getAppMapValue(): use default map if mapid is not provided;
                                                                   set map item value to testrecord's statusinfo so jsafs user can get it easily.
   
   NOV 26, 2014    (Lei Wang) Modify method saveClipboard()/verifyClipboard(): Call deduceXXXFile() to get test/bench file.
   
   JAN 04, 2015    (Lei Wang) Add method scrollWheel().

Author:

Doug Bauman

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	_command
static java.lang.String	APPMAPCHAINING
static java.lang.String	APPMAPRESOLVE
static java.lang.String	ASSIGNCLIPBOARDVARIABLE
static java.lang.String	BP
static java.lang.String	BREAKPOINTS
static java.lang.String	BROWSER "C:\\Program Files\\Internet Explorer\\iexplore.exe"
static java.lang.String	CALLREMOTE
static java.lang.String	CAPTUREMOUSEPOSITION
static java.lang.String	CLEARALLVARIABLES
static java.lang.String	CLEARARRAYVARIABLES
static java.lang.String	CLEARCLIPBOARD
static java.lang.String	CLOSEAPPLICATION
static java.lang.String	COMMANDDEBUG
static java.lang.String	COPYVARIABLEVALUEEX
static java.lang.String	DELAY
static java.lang.String	GETAPPMAPVALUE
static java.lang.String	GETCOMPSCREENRESOLUTION
static java.lang.String	GETREGISTRYKEYVALUE
static java.lang.String	GETSYSTEMDATE
static java.lang.String	GETSYSTEMDATETIME
static java.lang.String	GETSYSTEMTIME
static java.lang.String	GETVERSION
static java.lang.String	LAUNCHAPPLICATION
static java.lang.String	NOTIFYANDWAIT
static java.lang.String	PAUSE
static java.lang.String	RECORDSDEBUG
static java.lang.String	SAVECLIPBOARDTOFILE
static java.lang.String	SETBENCHDIRECTORY
static java.lang.String	SETCLIPBOARD
static java.lang.String	SETDIFDIRECTORY
static java.lang.String	SETPROJECTDIRECTORY
static java.lang.String	SETROOTVERIFYDIRECTORY
static java.lang.String	SETTESTDIRECTORY
static java.lang.String	SETVARIABLEVALUEEX
static java.lang.String	SETVARIABLEVALUES
static java.lang.String	STARTWEBBROWSER
static java.lang.String	TESTDEBUG
static java.lang.String	VERIFYCLIPBOARDTOFILE
static java.lang.String	WAITFORREGISTRYKEYEXISTS
static java.lang.String	WAITFORREGISTRYKEYVALUE
static java.lang.String	WEB_BROWSER_PATH_VAR "SAFSWebBrowserPath"

Fields inherited from class org.safs.DriverCommand

command, iterator, utils

Fields inherited from class org.safs.Processor

breakpointsOn, CASE_INSENSITIVE_FLAG, CASEINSENSITIVE_FLAG, clearProxiesAlways, commandLineBreakpoint, customStr, customText, DEBUG_MESSAGE, debugStr, debugText, DEFAULT_CUSTOM_PROCESSOR_PACKAGE, DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE, DEFAULT_PROCESSOR_PACKAGE, FAILED_MESSAGE, FAILED_OK_MESSAGE, failedStr, failedText, FAILURE_DETAIL, GENERIC_MESSAGE, genericStr, genericText, LINE_FAILURE_4, log, myBreakpointsOn, otherStr, otherText, PARAM_SIZE_1, PARAM_SIZE_2, PARAM_SIZE_3, PARAM_SIZE_4, params, PASSED_MESSAGE, passedStr, passedText, PRE_TXT_SUCCESS_4, PRE_TXT_SUCCESS_5, processorConfigSet, processorMap, recordProcessed, RECTYPE_DRIVER_COMMAND, RECTYPE_DRIVER_COMMAND_F, RECTYPE_DRIVER_COMMAND_W, RECTYPE_TEST_STEP, RECTYPE_TEST_STEP_F, RECTYPE_TEST_STEP_W, RFSMCache, RFSMOnly, RFT_FIND_SEARCH_MODE_ALGORITHM, RFT_FIND_SEARCH_MODE_CACHE, SAFS_CLEARPROXIESALWAYS_ITEM, SAFS_COMMANDLINEBREAKPOINT_ITEM, SAFS_COMMANDLINEBREAKPOINT_VARIABLE, SAFS_PARAMS_FILE, SAFS_RESBUN_NAME, SAFS_SECSWAITFORCOMPONENT_ITEM, SAFS_SECSWAITFORCOMPONENT_VARIABLE, SAFS_SECSWAITFORWINDOW_ITEM, SAFS_SECSWAITFORWINDOW_VARIABLE, SAFS_TESTDOMAINS_ITEM, SAFS_TESTDOMAINS_VARIABLE, secsWaitForComponent, secsWaitForWindow, SENT_MSG_3, testDomains, testRecordData, testrecordStackable, TXT_FAILURE_1, TXT_FAILURE_2, TXT_FAILURE_3, TXT_FAILURE_4, TXT_FAILURE_5, TXT_SUCCESS_1, TXT_SUCCESS_2, TXT_SUCCESS_2a, TXT_SUCCESS_3, TXT_SUCCESS_3a, TXT_SUCCESS_4, TXT_SUCCESS_5, unexpectedAlertBehaviour, WARNING_MESSAGE, WARNING_OK_MESSAGE, warningStr, warningText

Constructor Summary

Constructors

Constructor and Description
DCDriverMiscCommands() Purpose: constructor, calls super

Method Summary

Modifier and Type

Method and Description

void

process() Side Effects: Processor.testRecordData statusCode is set based on the result of the processing; processedCommand is set to false if we do not recognize this command State Read: Processor.testRecordData, Processor.params Assumptions: none JUL 27, 2005 (Carl Nagle) adding command CallRemote contributed by Steve Sampson AUG 03, 2006 (Carl Nagle) Addition of AppMapResolve and AppMapChaining commands

Methods inherited from class org.safs.DriverCommand

checkGUIExistence, commandProcess, getStandardFailureDetail, getStandardWarningDetail, init, interpretFields, issueActionUsingNegativeMessage, issueActionWarning, issueExecutionNegativeMessage, issueFileErrorFailure, issueGenericSuccess, issueGenericSuccess, issueGenericSuccessUsing, issueParameterCountFailure, issueParameterCountFailure, issueParameterValueFailure, issuePassedSuccess, issueUnknownErrorFailure, isSupportedRecordType, localProcess

Methods inherited from class org.safs.Processor

activateBreakpoint, checkBreakpoints, checkMyBreakpoints, deduceBenchFile, deduceDiffFile, deduceProjectFile, deduceTestFile, delay, distributeConfigInformation, getAbsolutFileName, getAlternateParams, getAppMapItem, getChainedProcessor, getClassInstance, getClearProxiesAlways, getCustomProcClassNames, getCustomProcInstancePath, getLogUtilities, getParams, getProcClassNames, getProcInstance, getProcInstancePath, getRequiredField, getSecsWaitForComponent, getSecsWaitForWindow, getStandardErrorMessage, getTestRecordData, getUnexpectedAlertBehaviour, getVariable, hasChainedProcessor, initProcessorAndProcess, instanceProcessorAndProcess, isBreakpointsOn, isComponentFunctionRecord, isDriverCommandRecord, isEngineCommandRecord, isMyBreakpointsOn, isRecordProcessed, isRFSMCache, isRFSMOnly, issueActionFailure, issueActionOnXFailure, issueErrorPerformingAction, issueErrorPerformingActionOnX, issueErrorPerformingActionUsing, issueInputRecordFailure, issueInputRecordFailure, issuePassedSuccess, logFailureMessage, normalizeTestFileName, paramsFailedMsg, paramsFailedMsg, popTestRecord, processCustomProcessor, processSubclassProcessor, pushTestRecord, setAtEndOfProcess, setBreakpointsOn, setChainedProcessor, setClearProxiesAlways, setCommandLineBreakpoint, setCustomProcInstancePath, setLogUtilities, setMyBreakpointsOn, setParams, setProcInstance, setProcInstancePath, setRecordProcessed, setRFSMCache, setRFSMOnly, setSecsWaitForComponent, setSecsWaitForWindow, setTestDomains, setTestRecordData, setUnexpectedAlertBehaviour, setVariable, standardFailureMessage, substituteVariable, validateParamSize, validProcessorClassName

Methods inherited from class java.lang.Object

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

Field Detail

BROWSER

public static final java.lang.String BROWSER

"C:\\Program Files\\Internet Explorer\\iexplore.exe"

See Also:

Constant Field Values

WEB_BROWSER_PATH_VAR

public static final java.lang.String WEB_BROWSER_PATH_VAR

"SAFSWebBrowserPath"

See Also:

Constant Field Values

APPMAPRESOLVE

public static final java.lang.String APPMAPRESOLVE

See Also:

Constant Field Values

APPMAPCHAINING

public static final java.lang.String APPMAPCHAINING

See Also:

Constant Field Values

GETAPPMAPVALUE

public static final java.lang.String GETAPPMAPVALUE

See Also:

Constant Field Values

PAUSE

public static final java.lang.String PAUSE

See Also:

Constant Field Values

DELAY

public static final java.lang.String DELAY

See Also:

Constant Field Values

GETVERSION

public static final java.lang.String GETVERSION

See Also:

Constant Field Values

BP

public static final java.lang.String BP

See Also:

Constant Field Values

BREAKPOINTS

public static final java.lang.String BREAKPOINTS

See Also:

Constant Field Values

CALLREMOTE

public static final java.lang.String CALLREMOTE

See Also:

Constant Field Values

COMMANDDEBUG

public static final java.lang.String COMMANDDEBUG

See Also:

Constant Field Values

CAPTUREMOUSEPOSITION

public static final java.lang.String CAPTUREMOUSEPOSITION

See Also:

Constant Field Values

TESTDEBUG

public static final java.lang.String TESTDEBUG

See Also:

Constant Field Values

RECORDSDEBUG

public static final java.lang.String RECORDSDEBUG

See Also:

Constant Field Values

CLOSEAPPLICATION

public static final java.lang.String CLOSEAPPLICATION

See Also:

Constant Field Values

LAUNCHAPPLICATION

public static final java.lang.String LAUNCHAPPLICATION

See Also:

Constant Field Values

STARTWEBBROWSER

public static final java.lang.String STARTWEBBROWSER

See Also:

Constant Field Values

COPYVARIABLEVALUEEX

public static final java.lang.String COPYVARIABLEVALUEEX

See Also:

Constant Field Values

SETVARIABLEVALUEEX

public static final java.lang.String SETVARIABLEVALUEEX

See Also:

Constant Field Values

SETVARIABLEVALUES

public static final java.lang.String SETVARIABLEVALUES

See Also:

Constant Field Values

GETSYSTEMDATE

public static final java.lang.String GETSYSTEMDATE

See Also:

Constant Field Values

GETSYSTEMDATETIME

public static final java.lang.String GETSYSTEMDATETIME

See Also:

Constant Field Values

GETSYSTEMTIME

public static final java.lang.String GETSYSTEMTIME

See Also:

Constant Field Values

SETBENCHDIRECTORY

public static final java.lang.String SETBENCHDIRECTORY

See Also:

Constant Field Values

SETDIFDIRECTORY

public static final java.lang.String SETDIFDIRECTORY

See Also:

Constant Field Values

SETPROJECTDIRECTORY

public static final java.lang.String SETPROJECTDIRECTORY

See Also:

Constant Field Values

SETTESTDIRECTORY

public static final java.lang.String SETTESTDIRECTORY

See Also:

Constant Field Values

SETROOTVERIFYDIRECTORY

public static final java.lang.String SETROOTVERIFYDIRECTORY

See Also:

Constant Field Values

ASSIGNCLIPBOARDVARIABLE

public static final java.lang.String ASSIGNCLIPBOARDVARIABLE

See Also:

Constant Field Values

CLEARCLIPBOARD

public static final java.lang.String CLEARCLIPBOARD

See Also:

Constant Field Values

SAVECLIPBOARDTOFILE

public static final java.lang.String SAVECLIPBOARDTOFILE

See Also:

Constant Field Values

SETCLIPBOARD

public static final java.lang.String SETCLIPBOARD

See Also:

Constant Field Values

VERIFYCLIPBOARDTOFILE

public static final java.lang.String VERIFYCLIPBOARDTOFILE

See Also:

Constant Field Values

CLEARALLVARIABLES

public static final java.lang.String CLEARALLVARIABLES

See Also:

Constant Field Values

CLEARARRAYVARIABLES

public static final java.lang.String CLEARARRAYVARIABLES

See Also:

Constant Field Values

GETCOMPSCREENRESOLUTION

public static final java.lang.String GETCOMPSCREENRESOLUTION

See Also:

Constant Field Values

GETREGISTRYKEYVALUE

public static final java.lang.String GETREGISTRYKEYVALUE

See Also:

Constant Field Values

WAITFORREGISTRYKEYEXISTS

public static final java.lang.String WAITFORREGISTRYKEYEXISTS

See Also:

Constant Field Values

WAITFORREGISTRYKEYVALUE

public static final java.lang.String WAITFORREGISTRYKEYVALUE

See Also:

Constant Field Values

NOTIFYANDWAIT

public static final java.lang.String NOTIFYANDWAIT

See Also:

Constant Field Values

_command

java.lang.String _command

Constructor Detail

DCDriverMiscCommands

public DCDriverMiscCommands()

Purpose: constructor, calls super

Method Detail

process

public void process()

Side Effects: Processor.testRecordData statusCode is set based on the result of the processing; processedCommand is set to false if we do not recognize this command
State Read: Processor.testRecordData, Processor.params
Assumptions: none
JUL 27, 2005 (Carl Nagle) adding command CallRemote contributed by Steve Sampson
AUG 03, 2006 (Carl Nagle) Addition of AppMapResolve and AppMapChaining commands

Overrides:

process in class DriverCommand