org.safs

Class SAFSPlus.DriverCommand

java.lang.Object

org.safs.SAFSPlus.DriverCommand

Direct Known Subclasses:

SAFSPlus.Misc

Enclosing class:

SAFSPlus

public static class SAFSPlus.DriverCommand
extends java.lang.Object

Wrapper class providing APIs to handle Driver keywords, like StartWebBrowser, UseWebBrowser, SetPosition etc.

Constructor Summary

Constructors

Constructor and Description
DriverCommand()

Method Summary

Modifier and Type	Method and Description
static boolean	AssignClipboardVariable(java.lang.String varName) Copy the clipboard contents to a DDVariable.
static boolean	CallJUnit(java.lang.String clazzes) Invoke one or more JUnit tests using the provided Class name(s).
static boolean	CallRemote(java.lang.String protocol, java.lang.String system, java.lang.String service, java.lang.String command, java.lang.String resultVar, java.lang.String... params) Execute a command on an external/local system or application.
static boolean	CallScript(java.lang.String path) Execute an external selenium script in the currently running WebDriver. The external selenium script is recorded by a testing tool, such as "Selenium Builder" or "Selenium IDE".
static boolean	CallTestNG(java.lang.String parameters) Invoke TestNG tests using the provided TestNG parameters.
static java.awt.geom.Point2D.Double	CaptureMousePositionOnScreen(java.lang.String variableX, java.lang.String variableY) Capture the location of the mouse pointer relative to the screen and save the x and y components into variables.
static boolean	ClearAllVariables() Clear storage of all DDVariables.
static boolean	ClearAppMapCache() Clear the internal application map cache.
static boolean	ClearArrayVariables(java.lang.String prefix) Clear storage of all SAFS variables containing a specific prefix.
static boolean	ClearClipboard() Clear the contents of the Window's clipboard.
static boolean	CloseApplication(java.lang.String ApplicationID) Close a named application process launched with LaunchApplication.
static boolean	CloseApplicationMap(java.lang.String mapID) By map ID, Close a opened Application Map in App Map chain.
static boolean	CopyVariableValueEx(java.lang.String sourceVar, java.lang.String destVar) Copy the value of a (dynamic) DDVariable to another.
static boolean	Delay(int milliseconds) Pause test-case flow in milliseconds.
static boolean	DeleteNetworkConditions() NOTE: This only works for Chrome browser started with option 'setNetworkConditions'.
static boolean	Expressions(boolean on) Enable and Disable enhanced expressions.
static java.lang.String	GetNetworkConditions() NOTE: This only works for Chrome browser started with option 'setNetworkConditions'.
static java.lang.String	GetRegistryKeyValue(java.lang.String key, java.lang.String keyValue) Get the value of the specified Registry Key to a variable.
static boolean	GetRegistryKeyValue(java.lang.String key, java.lang.String keyValue, java.lang.String result) Assign the value of the specified Registry Key to a variable.
static java.lang.String	GetSystemDate() Get the string value of the system date in the format MM-DD-YYYY
static java.lang.String	GetSystemDateTime(boolean military) Get the string value of the system date-time in the format MM-DD-YYYY HH:MM:SS
static java.lang.String	GetSystemTime(boolean military) Get the string value of the system time in the format HH:MM:SS
static boolean	GetURL(java.lang.String url, java.lang.String variable, java.lang.String... optionals) Send a "GET" HTTP Request by AJAX, and save the response to a variable.
static boolean	Highlight(boolean OnOff) Highlight object
static boolean	LaunchApplication(java.lang.String ApplicationID, java.lang.String ExecutablePath, java.lang.String... params) Identify and Launch a specified application
static java.lang.String	OnGUIExistsGotoBlockID(Component component, java.lang.String blockid, java.lang.String... optionals) Goto the named block in the current table if a GUI component exists.
static java.lang.String	OnGUINotExistGotoBlockID(Component component, java.lang.String blockid, java.lang.String... optionals) Goto the named block in the current table if a GUI component does not exist.
static boolean	Pause(int seconds) Pause test-case flow in seconds.
static boolean	SaveClipboardToFile(java.lang.String file, java.lang.String... optionals) Save the clipboard contents to a text file.
static boolean	SaveURLToFile(java.lang.String url, java.lang.String file, java.lang.String... optionals) Send a "GET" HTTP Request by AJAX, and save the response to a file.
static boolean	ScrollWheel(int wheelAmount) Move mouse wheel forward or backward.
static boolean	SendMail(java.lang.String from, java.lang.String to, java.lang.String subject, java.lang.String message, java.lang.String... attachment) Send email via a mail server, which should be configured by user in the .INI file. This method will not verify the validation of the recipients address.
static boolean	SetApplicationMap(java.lang.String mapID) Load/Set/Change an Application Map and put it on top of App Map chain. No action or command relying on the contents of a particular Application Map will work properly if the Map has not been previously loaded by this command or similar test initialization processes-- like an AppMap.order initialization file.
static boolean	SetClipboard(java.lang.String content) Set a string content to the clipboard.
(package private) static boolean	SetContext(Component component) Give a Window or Component input focus.
(package private) static boolean	SetFocus(Component component) Give a Window or Component input focus.
static boolean	SetImageDebug(boolean on) Enable/Disable verbose debug log during using IBT. Normally, it is off.
static boolean	SetImageFuzzyMatching(boolean on) Enable/Disable IBT Fuzzy Matching. Normally, it is off.
static boolean	SetMillisBetweenRecords(int milliseconds) Set the general pause time between records (SAFSPlus API calls), in milliseconds.
static boolean	SetMultipleThreadSearch(boolean on) Enable/Disable IBT MultiThread Matching. Normally, it is off.
static boolean	SetNetworkConditions(java.lang.String networkConditions) NOTE: This only works for Chrome browser started with option 'setNetworkConditions'.
static boolean	SetVariableValueEx(java.lang.String variable, java.lang.String value) Set the value of a variable/DDVariable; for DDVariable, refer to SAFSPlus Note3. The different between this method and SAFSPlus#SetVariableValue(String, String) is that this method can take a variable or DDVariable as the first parameter, the later one can only take variable.
static boolean	SetVariableValues(java.lang.String varEqualVal, java.lang.String... optionals) Set the value of one or more DDVariables; for DDVariable, refer to SAFSPlus Note3.
static boolean	StartWebBrowser(java.lang.String URL, java.lang.String BrowserID, java.lang.String... params) Start WebBrowser See Detailed Reference
static boolean	StopWebBrowser(java.lang.String BrowserID) Stop WebBrowser by ID.
static boolean	TakeScreenShot(java.lang.String testFile) Take screenshot and save it to a test file.
static boolean	TakeScreenShot(java.lang.String testFile, ImageUtils.SubArea subarea) Take screenshot and save it to a test file.
static boolean	UseWebBrowser(java.lang.String ID) Switch WebBrowser by ID.
static boolean	VerifyClipboardToFile(java.lang.String benchFile, java.lang.String... optionals) Verify the current contents of the Windows clipboard with a benchmark file.
static boolean	VerifyURLContent(java.lang.String url, java.lang.String content, java.lang.String... optionals) Send a "GET" HTTP Request by AJAX, and Verify URL Content with a string content.
static boolean	VerifyURLToFile(java.lang.String url, java.lang.String file, java.lang.String... optionals) Send a "GET" HTTP Request by AJAX, and Verify URL Content with a file.
static boolean	WaitForGUI(Component comp, long time) Wait for a Window or Component to become valid. Note: This API doesn't fit for switching according to GUI existence, please use SAFSPlus.Misc.IsComponentExists(org.safs.model.Component, String...) instead. If the GUI doesn't become valid within timeout, this method will return false. If the execution doesn't end properly, this method will also return false. User cannot distinguish these 2 cases; and in the same time, a failure message will be written into Log.
static boolean	WaitForGUI(Component component, java.lang.String... optionals) Wait for a Window or Component to become valid. Note: This API doesn't fit for switching according to GUI existence, please use SAFSPlus.Misc.IsComponentExists(org.safs.model.Component, String...) instead. If the GUI doesn't become valid within timeout, this method will return false. If the execution doesn't end properly, this method will also return false. User cannot distinguish these 2 cases; and in the same time, a failure message will be written into Log.
static boolean	WaitForGUIGone(Component component, java.lang.String... optionals) Wait for a Window or Component to disappear within timeout. Note: This API doesn't fit for switching according to GUI existence, please use SAFSPlus.Misc.IsComponentExists(org.safs.model.Component, String...) instead. If the GUI never exists, this method will return false, a failure message will be written into Log. If the GUI exists but doesn't disappear within timeout, this method will return false, a warning message will be written into Log. If the execution doesn't end properly, this method will also return false, a failure message will be written into Log. User cannot distinguish these cases.
static boolean	WaitForPropertyValue(Component component, java.lang.String propertyName, java.lang.String expectedValue, java.lang.String... optionals) Wait for a specific Window or Component property value to match an expected value.
static boolean	WaitForPropertyValueGone(Component component, java.lang.String propertyName, java.lang.String expectedValue, java.lang.String... optionals) Wait for a specific Window or Component property value to change from a known value.
static boolean	WaitForRegistryKeyExists(java.lang.String key, java.lang.String... optionals) Wait for a Registry Key to become valid.
static boolean	WaitForRegistryKeyValue(java.lang.String key, java.lang.String value, java.lang.String expectedValue, java.lang.String... optionals) Wait for a specific Registry KeyValue to match an expected value.

Methods inherited from class java.lang.Object

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

Constructor Detail

DriverCommand

public DriverCommand()

Method Detail

AssignClipboardVariable

public static boolean AssignClipboardVariable(java.lang.String varName)

Copy the clipboard contents to a DDVariable. This command can only copy text contents of the clipboard.

Parameters:

varName - The name of the DDvariable variable to hold the clipboard text.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Misc.AssignClipboardVariable(VAR_CLIPBOARD);
 String contents = GetVariableValue(VAR_CLIPBOARD);
 
 

CallJUnit

public static boolean CallJUnit(java.lang.String clazzes)

Invoke one or more JUnit tests using the provided Class name(s).

See Detailed Reference

Parameters:

clazzes - String, the JUnit class names separated by semi-colon, colon, comma, or space.

Returns:

true if executed with a successful result, false if the execution fails.
The JUnit test result will be stored in "status info" of #prevResults, call TestRecordData.getStatusInfo() to get it.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
  //Execute a JUnit Test "com.sas.spock.tests.SpockExperiment"
  boolean success = Misc.CallJUnit("com.sas.spock.tests.SpockExperiment");

  //Execute 2 JUnit Tests "com.sas.spock.tests.SpockExperiment and myapp.tests.AnOtherTest"
  boolean success = Misc.CallJUnit("com.sas.spock.tests.SpockExperiment;myapp.tests.AnOtherTest");

  //JUnitTestClasses is centrally stored in the App Map as "com.sas.spock.tests.SpockExperiment;myapp.tests.AnOtherTest"
  boolean success = Misc.CallScript(Map.JUnitTestClasses());
 
 

CallTestNG

public static boolean CallTestNG(java.lang.String parameters)

Invoke TestNG tests using the provided TestNG parameters.

See Detailed Reference

Parameters:

parameters - String, the TestNG parameters.

Returns:

true if executed with a successful result, false if the execution fails.
The TestNG.main() return code will be stored in "status info" of #prevResults, call TestRecordData.getStatusInfo() to get it.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
  //Execute a TestNG Test "testng.TestNGTest".
  boolean success = Misc.CallTestNG(quote("-testclass testng.TestNGTest"));

  //Execute a TestNG Test "testng.TestNGTest", each test group will be executed exception "othertest".
  boolean success = Misc.CallTestNG(quote("-testclass testng.TestNGTest -excludegroups othertest"));

  //Execute a TestNG Test "testng.TestNGTest", only test group "g1" and "g2" will be executed.
  boolean success = Misc.CallTestNG(quote("-testclass testng.TestNGTest -groups g1,g2"));

  //Execute a TestNG Test defined by "testng.xml".
  boolean success = Misc.CallTestNG(quote("testng.xml"));

 
 

CallScript

public static boolean CallScript(java.lang.String path)

Execute an external selenium script in the currently running WebDriver.
The external selenium script is recorded by a testing tool, such as "Selenium Builder" or "Selenium IDE".
Supported script types are

• Selenium Builder JSON format.
• Selenium IDE or SelRunner HTML format.

Please refer to Using SeleniumScripts for details.

Parameters:

path - -- full absolute path or project-relative path to an existing script to execute.

Returns:

true if successfully executed with a successful result, false if the script reports failure or an error occurred during execution.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
  //Run a JSON script stored centrally in the App Map.
  //-- Map File --------------
  //[ApplicationConstants]
  //CheckBoxJSONScript=C:\Automation\SharedStorage\Selenium\checkbox.json
  //---------------------------
  boolean success = Misc.CallScript(Map.CheckBoxJSONScript());

  //Literal String examples (not recommended):

  //Run a JSON script (checkbox.json), which is in a Scripts sub-directory for the Project.
  boolean success = Misc.CallScript("Scripts\checkbox.json");

  //Run a JSON script (checkbox.json), which is provided using a full absolute path.
  boolean success = Misc.CallScript("C:\Automation\SharedStorage\Selenium\checkbox.json");

  //Run an HTML script (checkbox.html), which is in Scripts sub-directory for the Project.
  boolean success = Misc.CallScript("Scripts\checkbox.html");
 
 

CallRemote

public static boolean CallRemote(java.lang.String protocol,
                                 java.lang.String system,
                                 java.lang.String service,
                                 java.lang.String command,
                                 java.lang.String resultVar,
                                 java.lang.String... params)

Execute a command on an external/local system or application. This command presently supports only the STAF protocol. Command syntax, parameters, and values will be dependent upon the protocol specified and the command issued to the remote (or even local) system.

Parameters:

protocol - -- only "STAF" currently supported. Defaults to "STAF" if null.

system - -- the external/local system name or id to send the command to.

service - -- the service or process on the system targetted.

command - -- the command to be issued to the the service or process.

resultVar - -- the DDVariable name to receive the results of the call.

params - -- additional parameters (String or String[]), if any, to be passed with the command.

See Detailed Reference

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Misc.CallRemote("STAF", "local", "service", "list", STAF_RESULT);
 String resultStr = GetVariableValue(STAF_RESULT);
 
 

Expressions

public static boolean Expressions(boolean on)

Enable and Disable enhanced expressions. When enabled, records are pre-processed for advanced expressions (math and string) conversions with DDVariables. When disabled, records are not pre-processed at all.

Parameters:

on - boolean, true to enable the enhanced expressions; false to disable.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.Expressions(true);
 Logging.LogMessage("Expression On", "58+45");//Log result is 103
 Misc.Expressions(false);//the evaluation of expression will be off until Expressions(true) is called.
 Logging.LogMessage("Expression Off", "58+45");//Log result is '58+45'
 
 

,

 
 Misc.Expressions(true);
 Logging.LogMessage("assign a variable var", "^var=58+45");//only when first letter is ^, the string between ^ and = will be consider as variable name
 String value = SAFSPlus.GetVariableValue("var");
 Logging.LogMessage("get value for variable var", value);
 Logging.LogMessage("the value of variable var is", "^var");//only when first letter is ^, the string between ^ and = will be consider as variable name
 
 

,

 
 Component combobox = new Component(new Component("Window"), "ComboBox");
 Misc.Expressions(true);
 ComboBox.CaptureItemsToFile(combobox, URL+"ComboBoxData.txt", "UTF-8");//Fail to store as UTF8 file, "UTF-8" is processed as an arithmetic expression
 Misc.Expressions(false);
 ComboBox.CaptureItemsToFile(combobox, "ComboBoxData.txt", "UTF-8");//Save as UTF8 file
 
 

SetNetworkConditions

public static boolean SetNetworkConditions(java.lang.String networkConditions)

NOTE: This only works for Chrome browser started with option 'setNetworkConditions'.

Parameters:

networkConditions - String, JSON string contains the 'network conditions' to set.
This JSON can contain keys of "offline"(boolean), "latency"(integer ms), "download_throughput"(integer bps), "upload_throughput"(integer bps). such as {"offline":false, "latency":5, "download_throughput":5000 , "upload_throughput":5000}

Returns:

boolean true if 'network conditions' have been set successfully

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
   SetNetworkConditions("{ \"offline\":false, \"latency\":5, \"download_throughput\":5000 , \"upload_throughput\":5000}");
 
 

GetNetworkConditions

public static java.lang.String GetNetworkConditions()

NOTE: This only works for Chrome browser started with option 'setNetworkConditions'.

Returns:

String, the current network conditions, it is normally a JSON string, such as {"offline":false, "latency":5, "download_throughput":5000 , "upload_throughput":5000}.
it will be null if no 'network conditions' is set.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
   String networkConditions = GetNetworkConditions();
 
 

DeleteNetworkConditions

public static boolean DeleteNetworkConditions()

NOTE: This only works for Chrome browser started with option 'setNetworkConditions'.

Returns:

boolean true if the current 'network condition' has been removed.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
   boolean success = DeleteNetworkConditions();
 
 

CaptureMousePositionOnScreen

public static java.awt.geom.Point2D.Double CaptureMousePositionOnScreen(java.lang.String variableX,
                                                                        java.lang.String variableY)
                                                                 throws SeleniumPlusException

Capture the location of the mouse pointer relative to the screen and save the x and y components into variables.

Parameters:

variableX - String, The name of the DDVariable to store the X component of the mouse position.

variableY - String, The name of the DDVariable to store the Y component of the mouse position.

Returns:

Point2D.Double, the position of the Mouse.

Throws:

SeleniumPlusException

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Point2D.Double mousePosition = Misc.CaptureMousePositionOnScreen("positionX", "positionY");
 Logging.LogMessage("Mouse position: ", "["+mousePosition.x+","+mousePosition.y+"]");
 
 

ClearAllVariables

public static boolean ClearAllVariables()

Clear storage of all DDVariables.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

ClearAppMapCache

public static boolean ClearAppMapCache()

Clear the internal application map cache.

See Detailed Reference

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

ClearArrayVariables

public static boolean ClearArrayVariables(java.lang.String prefix)

Clear storage of all SAFS variables containing a specific prefix.

See Detailed Reference

Parameters:

prefix - String, The variable name prefix to use for the delete.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Misc.ClearArrayVariables("TCAFS.UID.");//All variables beginning with "TCAFS.UID." will be deleted.
 
 

ClearClipboard

public static boolean ClearClipboard()

Clear the contents of the Window's clipboard.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

CloseApplication

public static boolean CloseApplication(java.lang.String ApplicationID)

Close a named application process launched with LaunchApplication.

See Detailed Reference

Parameters:

ApplicationID - String, A text ID to reference the application to close.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Misc.CloseApplication("NotePad");
 
 

CloseApplicationMap

public static boolean CloseApplicationMap(java.lang.String mapID)
                                   throws SeleniumPlusException

By map ID, Close a opened Application Map in App Map chain.

See Detailed Reference

Parameters:

mapID - String, the ID of the map to be closed. The ID is usually the map file name.
It is the same ID that you provide when calling SetApplicationMap(String).

Returns:

true if successful, false otherwise.

Throws:

SeleniumPlusException

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.CloseApplicationMap("App.map");
 
 

CopyVariableValueEx

public static boolean CopyVariableValueEx(java.lang.String sourceVar,
                                          java.lang.String destVar)

Copy the value of a (dynamic) DDVariable to another.

See Detailed Reference

Parameters:

sourceVar - String, The name of the variable to copy.

destVar - String, The name of the variable to receive the copy.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 String var = "myvar";
 String dest = "mydest";
 String value = "myvar_value";
 if(SetVariableValue(var, value) && Misc.CopyVariableValueEx(var, dest))
   if(!GetVariableValue(dest).equals(value)) System.err.println("Error copy value.");
 
 

Delay

public static boolean Delay(int milliseconds)

Pause test-case flow in milliseconds. If you want to pause in seconds, use Pause(int).

Parameters:

milliseconds - int, the milliseconds to pause

Returns:

true if successful, false otherwise.

See Also:

Pause(int)

LaunchApplication

public static boolean LaunchApplication(java.lang.String ApplicationID,
                                        java.lang.String ExecutablePath,
                                        java.lang.String... params)

Identify and Launch a specified application

See Detailed Reference

Parameters:

ApplicationID - String, A text ID to reference the application

ExecutablePath - String, The path, filename, and parameters for the executable OR an ApplicationConstant.

params - --
params[0] -- WorkDir, A Working Directory for the application
params[1] -- CMDLineParam, Separate command line parameters for the application
params[2] -- CMDLineParam, Filename to the Application Map for the application

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 boolean success = Misc.LaunchApplication("NotePad", "notepad.exe c:\\sample.txt");
 
 

GetRegistryKeyValue

public static boolean GetRegistryKeyValue(java.lang.String key,
                                          java.lang.String keyValue,
                                          java.lang.String result)

Assign the value of the specified Registry Key to a variable.

See Detailed Reference

Parameters:

key - String, The registry Key to seek

keyValue - String, The value name under the parent key to seek

result - String, The name of the variable to receive the value of the registry key.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 String key = "HKEY_LOCAL_MACHINE\\SOFTWARE\\JavaSoft\\Java Runtime Environment";
 String keyValue = "CurrentVersion";
 String result = "result";
 if(Misc.GetRegistryKeyValue(key, keyValue, result))
   System.out.println(key+":"+keyValue+" = "+GetVariableValue(result));
 
 

GetURL

public static boolean GetURL(java.lang.String url,
                             java.lang.String variable,
                             java.lang.String... optionals)

Send a "GET" HTTP Request by AJAX, and save the response to a variable.

See Detailed Reference

Parameters:

url - String, The URL to request.

variable - String, The name of the variable holding the content of response
Some suffixes can be appended to the variable name to form new variable holding other values, suffixes list as below:

• .readyState contains 'AJAX Ready State Code', such as "0", "1", "2", "3" and "4".
• .headers contains the response headers
• .status contains the HTTP status code, such as "200", "404" etc.
• .statusText contains the HTTP status text, such as "OK", "Not Found" etc.
• .xml contains the XML response if it exists.

optionals -

• optionals[0] timeout int, "Timeout" in seconds. The default is 120 seconds.
• optionals[1] headerName String, the name of the request header
• optionals[2] headerValue String, the value for the request header

optionals parameters 'headerName' and 'headerValue' must appear in pair, and they can present more than 1 time, which means multiple pair of ('headerName', 'headerValue') can be provided.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 String url = "http://rest.api.url";
 String variable = "response";
 //Get content of url and wait for response with timeout 60 seconds, save result to variable.
 if(Misc.GetURL(url, variable, "60")){
   System.out.println("content of url '"+url+"' has been saved to variable '"+variable+"'.");
   System.out.println("content: \n"+GetVariableValue(variable));
   System.out.println("ready state: "+GetVariableValue(variable+".readyState"));
   System.out.println("status code: "+GetVariableValue(variable+".status"));
   System.out.println("status text: "+GetVariableValue(variable+".statusText"));
   System.out.println("response headers: \n"+GetVariableValue(variable+".headers"));
   System.out.println("XML content: "+GetVariableValue(variable+".xml"));
 }
 //Get content of url with headers ("Accept", "text/*") and ("Accept-Charset", "UTF-8")
 //and wait for response with timeout 60 seconds, save result to variable.
 if(Misc.GetURL(url, variable, "60", "Accept", "text/*", "Accept-Charset", "UTF-8" )){
   System.out.println("content of url '"+url+"' has been saved to variable '"+variable+"'.");
 }
 
 

GetRegistryKeyValue

public static java.lang.String GetRegistryKeyValue(java.lang.String key,
                                                   java.lang.String keyValue)

Get the value of the specified Registry Key to a variable.

Parameters:

key - String, The registry Key to seek

keyValue - String, The value name under the parent key to seek

Returns:

String, the registry key's value. null if not found or execution fails.

See Also:

SAFSPlus.prevResults,

Example:

 
 String key = "HKEY_LOCAL_MACHINE\\SOFTWARE\\JavaSoft\\Java Runtime Environment";
 String keyValue = "CurrentVersion";
 String result = Misc.GetRegistryKeyValue(key, keyValue);
 
 

GetSystemDate

public static java.lang.String GetSystemDate()

Get the string value of the system date in the format MM-DD-YYYY

Returns:

String, the string value of the system date. null if execution fails.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 System.out.println("SystemDate "+Misc.GetSystemDate());
 
 

GetSystemDateTime

public static java.lang.String GetSystemDateTime(boolean military)

Get the string value of the system date-time in the format MM-DD-YYYY HH:MM:SS

Parameters:

military - boolean, if true the hour string will be 24-hours format; otherwise is 12 AM/PM.

Returns:

String, the string value of the system date-time. null if execution fails.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 System.out.println("SystemDateTime "+Misc.GetSystemDateTime(true));
 System.out.println("SystemDateTime "+Misc.GetSystemDateTime(false));
 
 

GetSystemTime

public static java.lang.String GetSystemTime(boolean military)

Get the string value of the system time in the format HH:MM:SS

Parameters:

military - boolean, if true the hour string will be 24-hours format; otherwise is 12 AM/PM.

Returns:

String, the string value of the system time. null if execution fails.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 System.out.println("SystemTime "+Misc.GetSystemTime(true));
 System.out.println("SystemTime "+Misc.GetSystemTime(false));
 
 

Highlight

public static boolean Highlight(boolean OnOff)

Highlight object

Parameters:

OnOff - -- true or false for object highlight

Returns:

true on success

Pause

public static boolean Pause(int seconds)

Pause test-case flow in seconds. If you want to pause in millisecond, use Delay(int).

Parameters:

seconds - int, the seconds to pause

Returns:

true if successfully executed, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo(), Delay(int)

Example:

 
 Pause(20);
 
 

SetMillisBetweenRecords

public static boolean SetMillisBetweenRecords(int milliseconds)

Set the general pause time between records (SAFSPlus API calls), in milliseconds.

Parameters:

milliseconds - int, pause time between records, in milliseconds.

Returns:

boolean if successful, false otherwise

StartWebBrowser

public static boolean StartWebBrowser(java.lang.String URL,
                                      java.lang.String BrowserID,
                                      java.lang.String... params)

Start WebBrowser See Detailed Reference

Parameters:

URL - String,

BrowserID - String, Unique application/browser ID.

params - optional, currently ONLY supported for Selenium WebDriver Engine.

params[0] browser name String, (default is BrowserConstants#DEFAULT_BROWSER), it can be one of:
• Constants.BrowserConstants.BROWSER_NAME_CHROME
• Constants.BrowserConstants.BROWSER_NAME_FIREFOX
• Constants.BrowserConstants.BROWSER_NAME_IE

params[1] timeout int, in seconds. Implicit timeout for search elements
params[2] isRemote boolean, (no longer used -- everything is now "remote")

Following parameters indicate the extra parameters, they MUST be given by PAIR(key, value)

The key can be one of:

Constants.BrowserConstants.getExtraParameterKeys()


params[3] extra parameter key1
params[4] extra parameter value for key1

params[5] extra parameter key2
params[6] extra parameter value for key2

params[7] extra parameter key3
params[8] extra parameter value for key3
...

Returns:

true on success

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo(), StopWebBrowser(String), #SwitchWebBrowser(String)

Example:

 StartWebBrowser("http://www.google.com", "GoogleMain");
 StartWebBrowser("http://www.google.com", "GoogleMain", BrowserConstans.BROWSER_NAME_CHROME);
 StartWebBrowser("http://www.google.com", "GoogleMain", BrowserConstans.BROWSER_NAME_IE, "10");

 
 The following gives some examples to start web browser with "custom profile" and "preferences".
 For the detail explanation of starting browser with "custom profile" and/or "preferences", please visit the section "Start Browser" at Selenium Welcome Document.
 

 //Start firefox browser with custom profile "myprofile" ( Create custom profile)
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        BrowserConstans.BROWSER_NAME_FIREFOX,
                                                        "10",
                                                        "true",
                                                        BrowserConstans.KEY_FIREFOX_PROFILE,
                                                        "myprofile"
                                                        });

 //Start firefox browser with some preference to set.
 String absolutePreferenceFile = "c:\\firefoxPref.json.dat";//A json file containing chrome preferences, like { "intl.accept_languages":"zh-cn", "accessibility.accesskeycausesactivation":false, "browser.download.folderList":2 }
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        BrowserConstans.BROWSER_NAME_FIREFOX,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstans.KEY_FIREFOX_PROFILE_PREFERENCE),
                                                        quote(absolutePreferenceFile)
                                                        });

 //Start chrome browser with default data pool (chrome://version/, see "Profile Path") , and using the last-used user.
 String datapool = "C:\\Users\\some-user\\AppData\\Local\\Google\\Chrome\\User Data";
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        BrowserConstans.BROWSER_NAME_CHROME,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstans.KEY_CHROME_USER_DATA_DIR),
                                                        datapool
                                                        });
 //Start chrome browser with default data pool (chrome://version/, see "Profile Path") , and using the default user.
 String datapool = "C:\\Users\\some-user\\AppData\\Local\\Google\\Chrome\\User Data";
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        BrowserConstans.BROWSER_NAME_CHROME,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstans.KEY_CHROME_USER_DATA_DIR),
                                                        datapool,
                                                        quote(BrowserConstans.KEY_CHROME_PROFILE_DIR),
                                                        "Default"
                                                        });

 //Start chrome browser with custom data, and using the last-used user.
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        BrowserConstans.BROWSER_NAME_CHROME,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstans.KEY_CHROME_USER_DATA_DIR),
                                                        "c:\\chrome_custom_data"//Create custom data pool
                                                        });
 //Start chrome browser with custom data, and using the 1th user.
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        BrowserConstans.BROWSER_NAME_CHROME,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstans.KEY_CHROME_USER_DATA_DIR),
                                                        "c:\\chrome_custom_data",//Create custom data pool
                                                        quote(BrowserConstans.KEY_CHROME_PROFILE_DIR),
                                                        "Profile 1"
                                                        });
 //Start chrome browser with some options to be turned off.
 String optionsToExclude = "disable-component-update";//comma separated options to exclude, like "disable-component-update, ignore-certificate-errors", be careful, there are NO 2 hyphens before options.
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        BrowserConstans.BROWSER_NAME_CHROME,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstans.KEY_CHROME_EXCLUDE_OPTIONS),
                                                        quote(optionsToExclude)
                                                        });
 //Start chrome browser with some chrome-command-line-options/preferences to set.
 String absolutePreferenceFile = "c:\\chromePref.json.dat";//A json file containing chrome command-line-options/preferences, like { "lang":"zh-cn", "start-maximized":"",  "seplus.chrome.preference.json.key":{ "intl.accept_languages":"zh-CN-pseudo", "intl.charset_default"  :"utf-8"} }
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        BrowserConstans.BROWSER_NAME_CHROME,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstans.KEY_CHROME_PREFERENCE),
                                                        quote(absolutePreferenceFile)
                                                        });
 //Start chrome browser out of sandbox (It is NOT suggested to use that way). But it can be used to avoid some chrome crash problem.
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        SelectBrowser.BROWSER_NAME_CHROME,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstants.KEY_CHROME_NO_SANDBOX),
                                                        "true"
                                                        });
 //Start chrome browser with the 'network-conditions' of {"offline":false, "latency":5, "download_throughput":500000, "upload_throughput":500000}
 "latency" is in milliseconds, "download_throughput" is in bps, "upload_throughput" is in bps.

 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        SelectBrowser.BROWSER_NAME_CHROME,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstants.KEY_SET_NETWORK_CONDITIONS),
                                                        "{ \"offline\":false, \"latency\":5, \"download_throughput\":500000 , \"upload_throughput\":500000}"
                                                        });

 //Start chrome browser with an empty 'network-conditions'. This call is needed if you want to adjust (set, get, delete) the 'network-conditions'.
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        SelectBrowser.BROWSER_NAME_CHROME,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstants.KEY_SET_NETWORK_CONDITIONS),
                                                        ""
                                                        });

 //Start chrome browser with a custom-capabilities {"applicationName":"firstTest", "version","latest"}, which will be added to the standard capabilities.
 StartWebBrowser("http://www.google.com", "GoogleMain", new String[]{
                                                        SelectBrowser.BROWSER_NAME_CHROME,
                                                        "10",
                                                        "true",
                                                        quote(BrowserConstants.KEY_CUSTOM_CAPABILITIES),
                                                        "{\"applicationName\":\"firstTest\", \"version\",\"latest\"}"
                                                        });
 

StopWebBrowser

public static boolean StopWebBrowser(java.lang.String BrowserID)

Stop WebBrowser by ID. During test, multiple browsers can be opened by #StartWebBrowser(String, BrowserID, String...)
If user wants to stop one of these opened browser, use can call this method.
This method requires a parameter 'ID', which is given by user when he calls #StartWebBrowser(String, BrowserID, String...)

Parameters:

BrowserID - String, the BrowserID served as key to get the WebDriver from cache.

Returns:

- true on success

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo(), StartWebBrowser(String, String, String...)

Example:

 
 String browserID = "GoogleMain";
 StartWebBrowser("http://www.google.com", browserID);
 //do some testing, then
 StopWebBrowser(browserID);
 
 

SendMail

public static boolean SendMail(java.lang.String from,
                               java.lang.String to,
                               java.lang.String subject,
                               java.lang.String message,
                               java.lang.String... attachment)

Send email via a mail server, which should be configured by user in the .INI file.
This method will not verify the validation of the recipients address.

Parameters:

from - - Sender's email address.

to - - Receiver's email. Multiple receivers allowed by semicolon(";");

subject - - Subject line of the email.

message - - Email message, html default format.

optionals - - Attachment file. Multiple files allowed by semicolon(";").

Returns:

boolean - True on success.

Example:

 

 Prerequisite:
 in test.ini setup following
   [SAFS_DRIVERCOMMANDS]
   OUT_MAILSERVER="mail server"
   OUT_MAILSERVERPORT=25|465|587
   OUT_MAILSERVERPROTOCOL=SMTP|SMTPS|TLS
   OUT_MAILUSER=user.name@mail.com
   OUT_MAILPASS=*******

   [SAFS_DRIVER]
   SMTP="mail server" (deprecated, replaced by OUT_MAILSERVER)
   PORT=25            (deprecated, replaced by OUT_MAILSERVERPORT)

 Misc.SendMail("Sender@email.com", "Recipient1@email.com;@Recipient2@email.com", "Subject line", "Email message",
 "Attachment 1 filename; Attachment 2 filename");

 CountStatusInterface info = Counters.GetCounterStatus("TestCase1") or Counters.StartCounter("test1")
 String message = "Total Records: " + info.getTotalRecords() + "\nTotal Pass: " +
 info.getTestPasses() +"\nTotal Fail: " + info.getTestFailures();
 Misc.SendMail("sender@email.com","to1@email.com", "Test results", message,"Logs\\TestCase1.txt");
 
 

SaveURLToFile

public static boolean SaveURLToFile(java.lang.String url,
                                    java.lang.String file,
                                    java.lang.String... optionals)

Send a "GET" HTTP Request by AJAX, and save the response to a file.

See Detailed Reference

Parameters:

url - String, The URL to request.

file - String, The file to save the response from the server. This can be a full path, a relative path, or a file name. For relative path, it is appended to the project's path to build the full path of the file. For file name, the file is saved under the project's test directory (it is Datapool\Test in SAFS or Actuals in SE+). In any case the parent folder of the file must exist.

optionals -

• optionals[0] timeout int, "Timeout" in seconds. The default is 120 seconds.
• optionals[1] headerName String, the name of the request header
• optionals[2] headerValue String, the value for the request header

optionals parameters 'headerName' and 'headerValue' must appear in pair, and they can present more than 1 time, which means multiple pair of ('headerName', 'headerValue') can be provided.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 String url = "http://rest.api.url";
 String file = "response.html";
 //Get content of url and wait for response with default timeout 120 seconds, save result to file.
 if(Misc.SaveURLToFile(url, file)){
   System.out.println("content of url '"+url+"' has been saved to file '"+file+"'.");
 }
 //Get content of url with headers ("Accept", "text/*") and ("Accept-Charset", "UTF-8")
 //and wait for response with timeout 60 seconds, save result to file.
 if(Misc.SaveURLToFile(url, variable, "60", "Accept", "text/*", "Accept-Charset", "UTF-8" )){
   System.out.println("content of url '"+url+"' has been saved to file '"+file+"'.");
 }
 
 

SetApplicationMap

public static boolean SetApplicationMap(java.lang.String mapID)
                                 throws SeleniumPlusException

Load/Set/Change an Application Map and put it on top of App Map chain.
No action or command relying on the contents of a particular Application Map will work properly if
the Map has not been previously loaded by this command or similar test initialization processes--
like an AppMap.order initialization file.

See Detailed Reference

Parameters:

mapID - String, the ID of the map to open.
It is normally the map file name under the project datapool directory (the "Maps" folder).
It can also be the map file name under the project directory.
It can also be the absolute map file name under whatever directory.

Returns:

true if successful, false otherwise.

Throws:

SeleniumPlusException

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.SetApplicationMap("App.map");
 Misc.SetApplicationMap("d:\\mytest\\App.map");
 
 

SaveClipboardToFile

public static boolean SaveClipboardToFile(java.lang.String file,
                                          java.lang.String... optionals)

Save the clipboard contents to a text file.

See Detailed Reference

Parameters:

file - String, The file name to store the clipboard's content

      Absolute file path.
      Relative file path,
        if it contains file separator, it is relative to datapool or project root.
        otherwise it is relative to the project test folder.
 

optionals - --

optionals[0] String, "Encoding" used to write a file. The default is "UTF-8".

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.SaveClipboardToFile(D:\test\clipboard.txt);
 Misc.SaveClipboardToFile(clipboard.txt);//Save to file under project test folder
 
 

ScrollWheel

public static boolean ScrollWheel(int wheelAmount)

Move mouse wheel forward or backward. The 'mouse wheel scroll' will happen on the focused object, users
needs to click the the object on which he wished the 'mouse wheel scroll' happens.

See Detailed Reference

Parameters:

wheelAmount - int, The amount of wheel to scroll

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.ScrollWheel(25);
 Misc.ScrollWheel(-15);
 
 

SetClipboard

public static boolean SetClipboard(java.lang.String content)

Set a string content to the clipboard.

See Detailed Reference

Parameters:

content - String, The content to set to clipboard.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 String clipboardValue = "THIS IS SOMETHING TO BE SET TO CLIPBOARD!";
 Misc.SetClipboard(clipboardValue);
 
 

SetContext

static boolean SetContext(Component component)
                   throws SeleniumPlusException

Give a Window or Component input focus.

See Detailed Reference

Parameters:

component - org.safs.model.Component, The component to gain focus.

Returns:

true if successful, false otherwise.

Throws:

SeleniumPlusException

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.SetContext(Map.SAPDemoPage.SAPDemoPage);
 Misc.SetContext(Map.SAPDemoPage.Basc_Password);
 
 

SetFocus

static boolean SetFocus(Component component)
                 throws SeleniumPlusException

Give a Window or Component input focus.

See Detailed Reference

Parameters:

component - org.safs.model.Component, The component to gain focus.

Returns:

true if successful, false otherwise.

Throws:

SeleniumPlusException

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.SetFocus(Map.SAPDemoPage.SAPDemoPage);
 Misc.SetFocus(Map.SAPDemoPage.Basc_TextArea);
 
 

SetImageDebug

public static boolean SetImageDebug(boolean on)

Enable/Disable verbose debug log during using IBT.
Normally, it is off. It is ONLY turned on when developer needs more information.

See Detailed Reference

Parameters:

on - boolean, true to turn on; false to turn off.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.SetImageDebug(true);
 
 

SetImageFuzzyMatching

public static boolean SetImageFuzzyMatching(boolean on)

Enable/Disable IBT Fuzzy Matching.
Normally, it is off.

See Detailed Reference

Parameters:

on - boolean, true to turn on; false to turn off.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.SetImageFuzzyMatching(true);
 
 

SetMultipleThreadSearch

public static boolean SetMultipleThreadSearch(boolean on)

Enable/Disable IBT MultiThread Matching.
Normally, it is off.

See Detailed Reference

Parameters:

on - boolean, true to turn on; false to turn off.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.SetMultipleThreadSearch(true);
 
 

SetVariableValueEx

public static boolean SetVariableValueEx(java.lang.String variable,
                                         java.lang.String value)

Set the value of a variable/DDVariable; for DDVariable, refer to SAFSPlus Note3.
The different between this method and SAFSPlus#SetVariableValue(String, String) is that this method
can take a variable or DDVariable as the first parameter, the later one can only take variable.

See Detailed Reference

Parameters:

variable - String, The name of variable or DDVariable that evaluates to a valid variable name.

value - String, The content to set to variable.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo(),

Example:

 
 Misc.Expressions(true);
 String user_name_var = "user.name";//variable
 String user_name = "NewUserName";//value
 //Create a reference "ref_user_name_var" to variable "user.name"
 String refToUsernameVar = "ref_user_name_var";//reference to variable "user.name"
 Misc.SetVariableValueEx(refToUsernameVar, user_name_var);
 //Use the reference to set value to variable "user.name"
 Misc.SetVariableValueEx("^"+refToUsernameVar, user_name);
 if(!username.equals(GetVariableValue(user_name_var))) System.err.println("Fail SetVariableValues");
 
 

SetVariableValues

public static boolean SetVariableValues(java.lang.String varEqualVal,
                                        java.lang.String... optionals)

Set the value of one or more DDVariables; for DDVariable, refer to SAFSPlus Note3.

See Detailed Reference

Parameters:

varEqualVal - String, The DDVariable along with its value.

optionals -

optionals[0] String, "varEqualVal1".
optionals[1] String, "varEqualVal2".
optionals[2] String, "varEqualVal3".
...

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo(),

Example:

 
 Misc.Expressions(true);
 //set value "UserA" to variable "user.name", set "Password1" to "user.password"
 Misc.SetVariableValues("^user.name=UserA","^user.password=Password1");
 //input the value of variable "user.name"
 Component.InputCharacters(Map.AUT.UserInput, "^user.name");
 //input the value of variable "user.password"
 Component.InputCharacters(Map.AUT.PassWord, "^user.password");
 
 

TakeScreenShot

public static boolean TakeScreenShot(java.lang.String testFile,
                                     ImageUtils.SubArea subarea)

Take screenshot and save it to a test file.

See Detailed Reference

Parameters:

testFile - String, The test file name to save the screenshot.

      Absolute file path.
      Relative file path,
        if it contains file separator, it is relative to datapool or project root.
        otherwise it is relative to the project test folder.
 

subarea - SubArea, indicating partial image of the screen to capture

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 //Take a whole screen image
 Misc.TakeScreenShot("D:\test\screenshot.png");
 //Take a sub image of screen
 SubArea subarea = new SubArea(0,0,"20%","30%");
 Misc.TakeScreenShot("sub_screenshot.png", subarea);
 
 

TakeScreenShot

public static boolean TakeScreenShot(java.lang.String testFile)

Take screenshot and save it to a test file.

See Detailed Reference

Parameters:

testFile - String, The test file name to save the screenshot.

      Absolute file path.
      Relative file path,
        if it contains file separator, it is relative to datapool or project root.
        otherwise it is relative to the project test folder.
 

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.TakeScreenShot("D:\test\screenshot.png");
 Misc.TakeScreenShot("screenshot.png");//Save to project test folder
 
 

UseWebBrowser

public static boolean UseWebBrowser(java.lang.String ID)

Switch WebBrowser by ID. During test, multiple browsers can be opened by #StartWebBrowser(String, int, String...)
If user wants to switch between these opened browser, use can call this method.
This method requires a parameter 'ID', which is given by user when he calls #StartWebBrowser(String, int, String...)
See Detailed Reference
This is currently ONLY supported for Selenium WebDriver Engine.

Parameters:

ID - String, the ID served as key to get the WebDriver from cache.

Returns:

true on success

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo(), StartWebBrowser(String, String, String...)

Example:

 
 UseWebBrowser("GoogleNewWindow");
 
 

VerifyClipboardToFile

public static boolean VerifyClipboardToFile(java.lang.String benchFile,
                                            java.lang.String... optionals)

Verify the current contents of the Windows clipboard with a benchmark file.

See Detailed Reference

Parameters:

benchFile - String, The bench file name to compare with the clipboard's content.

      Absolute file path.
      Relative file path,
        if it contains file separator, it is relative to datapool or project root.
        otherwise it is relative to the project bench folder.
 

optionals -

optionals[0] encoding String, "Encoding" used to read the bench file. The default is "UTF-8".

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 Misc.VerifyClipboardToFile("D:\bench\clipboard.txt");
 Misc.VerifyClipboardToFile("clipboard.txt");//Compare with the file under project bench directory
 
 

VerifyURLContent

public static boolean VerifyURLContent(java.lang.String url,
                                       java.lang.String content,
                                       java.lang.String... optionals)

Send a "GET" HTTP Request by AJAX, and Verify URL Content with a string content.

See Detailed Reference

Parameters:

url - String, The URL to request.

content - String, The content to verify with.

optionals -

• optionals[0] timeout int, "Timeout" in seconds. The default is 120 seconds.
• optionals[1] headerName String, the name of the request header
• optionals[2] headerValue String, the value for the request header

optionals parameters 'headerName' and 'headerValue' must appear in pair, and they can present more than 1 time, which means multiple pair of ('headerName', 'headerValue') can be provided.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 String url = "http://rest.api.url";
 String content = "the content returned by url";//for verification
 //Get content of url and wait for response with timeout 60 seconds, and verify with content.
 if(Misc.VerifyURLContent(url, content, "60")){
   System.out.println("content of url '"+url+"' matches with content '"+content+"'.");
 }
 //Get content of url with headers ("Accept", "text/*") and ("Accept-Charset", "UTF-8")
 //and wait for response with default timeout 120 seconds, then verify with content.
 if(Misc.VerifyURLContent(url, content, "", "Accept", "text/*", "Accept-Charset", "UTF-8" )){
   System.out.println("content of url '"+url+"' matches '"+content+"'.");
 }
 
 

VerifyURLToFile

public static boolean VerifyURLToFile(java.lang.String url,
                                      java.lang.String file,
                                      java.lang.String... optionals)

Send a "GET" HTTP Request by AJAX, and Verify URL Content with a file.

See Detailed Reference

Parameters:

url - String, The URL to request.

file - String, The name of the bench file holding the content to be compared with the response sent back from the server. The bench file can be a full path, a relative path, or a file name. For relative path, it is appended to the project's path to build the full path of the file. For file name, the file is supposed under the project's bench directory (it is Datapool\Bench in SAFS or Benchmarks in SE+). In any case the parent folder of the file must exist.

optionals -

• optionals[0] timeout int, "Timeout" in seconds. The default is 120 seconds.
• optionals[1] headerName String, the name of the request header
• optionals[2] headerValue String, the value for the request header

optionals parameters 'headerName' and 'headerValue' must appear in pair, and they can present more than 1 time, which means multiple pair of ('headerName', 'headerValue') can be provided.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 String url = "http://rest.api.url";
 String file = "content.html";//for verification
 //Get content of url and wait for response with timeout 60 seconds, and verify with a file.
 if(Misc.VerifyURLToFile(url, file, "60")){
   System.out.println("content of url '"+url+"' matches with file '"+file+"'.");
 }
 //Get content of url with headers ("Accept", "text/*") and ("Accept-Charset", "UTF-8")
 //and wait for response with default timeout 120 seconds, then verify with a file.
 if(Misc.VerifyURLToFile(url, file, "", "Accept", "text/*", "Accept-Charset", "UTF-8" )){
   System.out.println("content of url '"+url+"' matches with file '"+file+"'.");
 }
 
 

WaitForGUI

public static boolean WaitForGUI(Component comp,
                                 long time)

Wait for a Window or Component to become valid.
Note:
This API doesn't fit for switching according to GUI existence, please use SAFSPlus.Misc.IsComponentExists(org.safs.model.Component, String...) instead.
If the GUI doesn't become valid within timeout, this method will return false.
If the execution doesn't end properly, this method will also return false.
User cannot distinguish these 2 cases; and in the same time, a failure message will be written into Log.

Parameters:

comp - -- Component (from generated Map.java)

time - - time in second

Returns:

true if the GUI appear within the timeout.
false there 2 possibilities:
1. The execution finishes properly but the GUI doesn’t appear within the timeout.
2. The execution doesn't finish properly.

See Also:

SAFSPlus.Misc.IsComponentExists(org.safs.model.Component, String...)

Example:

 
 WaitForGUI(Map.Google.SignIn,10);
 
 

WaitForGUI

public static boolean WaitForGUI(Component component,
                                 java.lang.String... optionals)

Wait for a Window or Component to become valid.
Note:
This API doesn't fit for switching according to GUI existence, please use SAFSPlus.Misc.IsComponentExists(org.safs.model.Component, String...) instead.
If the GUI doesn't become valid within timeout, this method will return false.
If the execution doesn't end properly, this method will also return false.
User cannot distinguish these 2 cases; and in the same time, a failure message will be written into Log.

See Detailed Reference

Parameters:

component - Component, The component to wait.

optionals -

optionals[0] timeout int, timeout in seconds. Default is 15 seconds.

Returns:

true if the GUI appear within the timeout.
false there 2 possibilities:
1. The execution finishes properly but the GUI doesn’t appear within the timeout.
2. The execution doesn't finish properly.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

, SAFSPlus.Misc.IsComponentExists(org.safs.model.Component, String...)

Example:

 
 //wait for at the most 15 seconds until Basc_Button becomes valid.
 Misc.WaitForGUI(Map.SAPDemoPage.Basc_Button);
 //wait for at the most 2 seconds until Basc_Button becomes valid.
 Misc.WaitForGUI(Map.SAPDemoPage.Basc_Button, "2");
 
 

OnGUIExistsGotoBlockID

public static java.lang.String OnGUIExistsGotoBlockID(Component component,
                                                      java.lang.String blockid,
                                                      java.lang.String... optionals)

Goto the named block in the current table if a GUI component exists.

See Detailed Reference

Note: SAFSPlus user does not call this API directly. If it is called, the return code could be used to tell if the component exist or not.

Parameters:

component - Component, The component to check

blockid - String, the BLOCKID to branch

optionals -

optionals[0] timeout int, timeout in seconds. Default is 15 seconds.

Returns:

String, the BLOCKID if it does branch
void string "" if it does not branch.
null if there is something wrong.

See Also:

SAFSPlus.Misc.IsComponentExists(org.safs.model.Component, String...)

OnGUINotExistGotoBlockID

public static java.lang.String OnGUINotExistGotoBlockID(Component component,
                                                        java.lang.String blockid,
                                                        java.lang.String... optionals)

Goto the named block in the current table if a GUI component does not exist.

See Detailed Reference

Note: SAFSPlus user does not call this API directly. If it is called, the return code could be used to tell if the component exist or not.

Parameters:

component - Component, The component to check

blockid - String, the BLOCKID to branch

optionals -

optionals[0] timeout int, timeout in seconds. Default is 15 seconds.

Returns:

String, the BLOCKID if it does branch
void string "" if it does not branch.
null if there is something wrong.

WaitForGUIGone

public static boolean WaitForGUIGone(Component component,
                                     java.lang.String... optionals)

Wait for a Window or Component to disappear within timeout.
Note:
This API doesn't fit for switching according to GUI existence, please use SAFSPlus.Misc.IsComponentExists(org.safs.model.Component, String...) instead.
If the GUI never exists, this method will return false, a failure message will be written into Log.
If the GUI exists but doesn't disappear within timeout, this method will return false, a warning message will be written into Log.
If the execution doesn't end properly, this method will also return false, a failure message will be written into Log.
User cannot distinguish these cases.

See Detailed Reference

Parameters:

component - Component, The component to wait its gone.

optionals -

optionals[0] timeout int, timeout in seconds. Default is 15 seconds.

Returns:

true if the GUI disappear within the timeout.
false there 3 possibilities:
1. The execution finishes properly but the GUI doesn’t disappear within the timeout.
2. The execution finishes properly but the GUI never exists from the beginning.
3. The execution doesn't finish properly.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

, SAFSPlus.Misc.IsComponentExists(org.safs.model.Component, String...)

Example:

 
 //wait for at the most 15 seconds until Basc_Button becomes invalid.
 Misc.WaitForGUIGone(Map.SAPDemoPage.Basc_Button);
 //wait for at the most 2 seconds until Basc_Button becomes invalid.
 Misc.WaitForGUIGone(Map.SAPDemoPage.Basc_Button, "2");
 
 

WaitForPropertyValue

public static boolean WaitForPropertyValue(Component component,
                                           java.lang.String propertyName,
                                           java.lang.String expectedValue,
                                           java.lang.String... optionals)

Wait for a specific Window or Component property value to match an expected value.

See Detailed Reference

Parameters:

component - Component, The component to wait for its property matching.

propertyName - String, Case-sensitive name of object property to watch.

expectedValue - String, Case-sensitive value of the object property to match.

optionals - String

optionals[0] timeout int, timeout in seconds. Default is 15 seconds.
optionals[1] caseInsensitive boolean, match an expected value case insensitively. Default is false. "FALSE" will cause the comparison of the property value and the expected value to ignore case.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

1. Wait for the property value matching with expected value.

 
 Misc.WaitForPropertyValue(Map.windowName.componentName, "propertyValue", "expectedValue");
 
 

2. Wait for the property value matching with expected value with 20 seconds.

 
 Misc.WaitForPropertyValue(Map.windowName.componentName, "propertyValue", "expectedValue", "20");
 
 

3. Wait for the property value matching with expected value with 20 seconds and compare case sensitively.

 
 Misc.WaitForPropertyValue(Map.windowName.componentName, "propertyValue", "expectedValue", "true");
 
 

WaitForPropertyValueGone

public static boolean WaitForPropertyValueGone(Component component,
                                               java.lang.String propertyName,
                                               java.lang.String expectedValue,
                                               java.lang.String... optionals)

Wait for a specific Window or Component property value to change from a known value.

See Detailed Reference

Parameters:

component - Component, The component to wait for its matching property gone.

propertyName - String, Case-sensitive name of object property to watch.

expectedValue - String, Case-sensitive value of the object property to match.

optionals - String

optionals[0] timeout int, timeout in seconds. Default is 15 seconds.
optionals[1] caseInsensitive boolean, match an expected value case insensitively. Default is false. "FALSE" will cause the comparison of the property value and the expected value to ignore case.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

1. Wait for the property value gone with expected value.

 
 Misc.WaitForPropertyValueGone(Map.windowName.componentName, "propertyValue", "expectedValue");
 
 

2. Wait for the property value gone with expected value with 20 seconds.

 
 Misc.WaitForPropertyValueGone(Map.windowName.componentName, "propertyValue", "expectedValue", "20");
 
 

3. Wait for the property value gone with expected value with 20 seconds and compare case sensitively.

 
 Misc.WaitForPropertyValueGone(Map.windowName.componentName, "propertyValue", "expectedValue", "true");
 
 

WaitForRegistryKeyExists

public static boolean WaitForRegistryKeyExists(java.lang.String key,
                                               java.lang.String... optionals)

Wait for a Registry Key to become valid.

See Detailed Reference

Parameters:

key - String, The Registry Key name to seek.

optionals -

optionals[0] value String, The value name under the parent key to seek. optionals[1] timeout int, "Timeout" in seconds.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 String key = "HKEY_LOCAL_MACHINE\\SOFTWARE\\JavaSoft\\Java Runtime Environment";
 String value = "CurrentVersion";
 String result = null;
 if(Misc.WaitForRegistryKeyExists(key, value)){
   result = Misc.GetRegistryKeyValue(key, value);
 }
 
 

WaitForRegistryKeyValue

public static boolean WaitForRegistryKeyValue(java.lang.String key,
                                              java.lang.String value,
                                              java.lang.String expectedValue,
                                              java.lang.String... optionals)

Wait for a specific Registry KeyValue to match an expected value.

See Detailed Reference

Parameters:

key - String, The Registry Key name to seek.

value - String, The value name under the parent key to seek.

expectedValue - String,Case-sensitive value to match with the key value.

optionals -

optionals[0] timeout int, "Timeout" in seconds. optionals[1] caseInsensitive boolean, if true comparison will ignore case.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(),

Example:

 
 String key = "HKEY_LOCAL_MACHINE\\SOFTWARE\\JavaSoft\\Java Runtime Environment";
 String value = "CurrentVersion";
 String expectedValue = "1.7";
 //Wait 'HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Runtime Environment:CurrentVersion' to be "1.7"
 //Program will continue if the value is not detected as "1.7" within timeout 2 seconds.
 if(Misc.WaitForRegistryKeyValue(key, value, expectedValue, "2")){
   System.out.println(key+":"+value+" equals to "+expectedValue);
 }