|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.webmbt.plugin.PluginAncestor
com.webmbt.plugin.SeqOutPlugin
public class SeqOutPlugin
writes mscript to seqout
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface com.webmbt.plugin.MScriptInterface |
|---|
MScriptInterface.MSCRIPT_METHOD |
| Constructor Summary | |
|---|---|
SeqOutPlugin()
|
|
| Method Summary | |
|---|---|
void |
addCustomField(java.lang.String fieldName_p,
java.lang.String fieldValue_p)
adds a custom field to the seqout. |
java.lang.String |
addOsCmdLink(java.lang.String osCmd_p,
java.lang.String cmdName_p)
adds a anchor to run an OS command on a TestOptimal server when clicked. |
java.lang.String |
click(java.lang.String locator_p)
simulate click on the element. |
java.lang.String |
click(java.lang.String locator_p,
java.lang.String shiftCtrlAlt_p)
simulate click on the element with option of holding down shift, ctrl or alt key. |
java.lang.String |
click(java.lang.String locator_p,
java.lang.String coordX_p,
java.lang.String coordY_p)
simulate click on the element that supports coordinates, for example an image. |
void |
close()
closes the plugin, before it does that, it generates the test case documents with the format specified. |
java.lang.String |
containsText(java.lang.String text_p)
returns true if current page contains the text passed in. |
java.lang.String |
count(java.lang.String locator_p)
returns count of number of objects for the element locator passed in. |
java.lang.String |
doubleClick(java.lang.String locator_p)
double click on the element. |
java.lang.String |
dragAndDrop(java.lang.String fromLocator_p,
java.lang.String toLocator_p)
release mouse while on the element locator_p |
java.lang.String |
getAlertText()
returns the message in the alert popup dialog if present. |
java.lang.String |
getAttr(java.lang.String locator_p,
java.lang.String attrName_p)
Returns the value of HTML attribute value defined in the element. |
java.lang.String |
getConfirmText()
returns the message in the confirm popup dialog if present. |
java.lang.String |
getCookie(java.lang.String cookieName_p)
returns the value of the cookie. |
java.lang.String |
getItemFormat(java.lang.String tagMethod)
|
java.lang.String |
getPluginID()
INTERNAL USE ONLY. |
java.lang.String |
getText(java.lang.String locator_p)
Returns the text of the element. |
java.lang.String |
getTitle()
returns the title of the current window/page. |
java.lang.String |
getValue(java.lang.String locator_p)
|
void |
init(com.webmbt.scxml.ScxmlNode scxmlNode_p,
java.lang.String[] pluginParams_p)
performs the plugin specific initialization. |
java.lang.String |
isAlertPresent()
retusn true if the alert dialog has been displayed(triggered). |
java.lang.String |
isChecked(java.lang.String locator_p)
returns true if the locator_p is checked: radio button or checkbox only. |
java.lang.String |
isConfirmPresent()
retusn true if the confirm dialog has been displayed(triggered). |
java.lang.String |
isDisabled(java.lang.String locator_p)
returns true if any of the elements found is disabled. |
boolean |
isError(java.lang.Exception e_p)
INTERNAL USE ONLY. |
java.lang.String |
isPresent(java.lang.String locator_p)
returns true if the element exists in the current page/frame/window. |
java.lang.String |
isVisible(java.lang.String locator_p)
returns true if any of the elements is visible. |
java.lang.String |
js(java.lang.String winLocator_p,
java.lang.String javascript_p)
executes javascript passed in on the window identified in winLocator_p. |
java.lang.String |
mouseDown(java.lang.String locator_p)
trigger mouse down event on element locator_p |
java.lang.String |
mouseOver(java.lang.String locator_p)
trigger mouse over event on the element locator_p |
java.lang.String |
mouseUp(java.lang.String locator_p)
trigger mouse up event on the element locator_p |
void |
noOut(java.lang.String msg_p)
forces not to generate any output. |
java.lang.String |
refresh()
|
java.lang.String |
replaceToken(java.lang.String format,
java.lang.String token,
java.lang.String replaceString)
|
java.lang.String |
rightClick(java.lang.String locator_p)
rightClick on the element |
java.lang.String |
selectFrame(java.lang.String frameName_p)
select the named frame as the current default frame. |
java.lang.String |
selectOption(java.lang.String locator_p,
java.lang.String optionLocator_p)
selects the option |
java.lang.String |
selectWindow(java.lang.String windowName_p)
select the named window as the current default window. |
void |
seqout(java.lang.String msg_p)
writes the message to the SeqOut output stream (xml). |
java.lang.String |
setCheckBox(java.lang.String locator_p,
java.lang.String checked_p)
sets the checkbox |
void |
setFormatField(java.lang.String fieldName_p,
java.lang.String fieldValue_p)
sets the format field to override the definition from seqout.fmt file. |
void |
setInitParams(java.lang.String[] paramList_p)
INTERNAL USE ONLY. |
void |
setOsCmdHostPort(java.lang.String hostPort_p)
sets the host and port# of TestOptimal server to execute osCmd. |
void |
setPathFlag(java.lang.String flag_p)
either to prevent the current test case (path) from being removed as duplicates or forces the current test case (path) to be removed. |
java.lang.String |
setRadioButton(java.lang.String locator_p,
java.lang.String checked_p)
sets the radio button |
java.lang.String |
setupAlert()
prepare system to handle alert popup. |
java.lang.String |
setupConfirmResponse(java.lang.String bool_p)
prepare system to handle the confirmation dialog with OK/Yes or Cancel/No. |
static void |
shutdown()
|
java.lang.String |
sizeOf(java.lang.String locator_p)
returns the number options in the select |
java.lang.String |
snapScreen(java.lang.String fileName_p)
INTERNAL USE ONLY. |
void |
start()
INTERNAL USE ONLY. |
java.lang.String |
type(java.lang.String locator_p,
java.lang.String keyString_p)
type the string to the element if the element is an input field. |
java.lang.String |
type(java.lang.String locator_p,
java.lang.String shiftCtrlAlt_p,
java.lang.String keyString_p)
type the string to the element with the option to have shift/control/alt key pressed. |
java.lang.String |
waitForPageToLoad()
INTERNAL USE ONLY. |
void |
waitForPageToLoad(java.lang.String timeoutMillis_p)
Waits until the page (Html dom) is fully loaded. |
java.lang.String |
webAuth(java.lang.String authType_p,
java.lang.String userID_p,
java.lang.String password_p,
java.lang.String waitMillis_p,
java.lang.String gotoURL_p)
performs HTTP basic authentication. |
void |
write(com.webmbt.mscript.ActionScript script)
|
void |
write(com.webmbt.mscript.AssertScript script)
write tags |
void |
write(com.webmbt.mscript.ElseScript script)
|
void |
write(com.webmbt.mscript.IfScript script)
|
void |
write(com.webmbt.mscript.LogScript script)
|
void |
write(java.lang.String tagName_p,
java.lang.String[] params_p)
|
void |
write(com.webmbt.mscript.ThenScript script)
|
void |
write(com.webmbt.mscript.WhileScript script)
|
void |
writeTagCheck(java.lang.String reqTag_p,
java.lang.String[] params_p)
|
void |
writeTriggerBegin(com.webmbt.ScriptDesc script_p)
|
void |
writeTriggerEnd(com.webmbt.ScriptDesc script_p)
|
| Methods inherited from class com.webmbt.plugin.PluginAncestor |
|---|
addException, getCurScript, getData, getData, getDataMgr, getDataSetRowNum, getInitParams, getMethodList, getMScriptAPI, getMScriptMethodList, getNativeMethod, getNativePluginObj, getPathVar, getScriptExecutor, getVar, initialize, isReady, next, registerVarChangeListener, replaceEscapeChar, rewind, setData, setPathVar, setReady, setVar, snapScreen, uiLocatorMap |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SeqOutPlugin()
| Method Detail |
|---|
public void setInitParams(java.lang.String[] paramList_p)
throws java.lang.Exception
PluginAncestor
setInitParams in class PluginAncestorjava.lang.Exception
public void init(com.webmbt.scxml.ScxmlNode scxmlNode_p,
java.lang.String[] pluginParams_p)
throws java.lang.Exception
PluginAncestor
java.lang.Exception
public void start()
throws java.lang.Exception
PluginAncestor
start in class PluginAncestorjava.lang.Exceptionpublic void close()
close in class PluginAncestorpublic static void shutdown()
public void writeTriggerBegin(com.webmbt.ScriptDesc script_p)
throws java.lang.Exception
java.lang.Exception
public void writeTriggerEnd(com.webmbt.ScriptDesc script_p)
throws java.lang.Exception
java.lang.Exception
public java.lang.String snapScreen(java.lang.String fileName_p)
throws java.lang.Exception
PluginAncestor
snapScreen in class PluginAncestorjava.lang.Exceptionpublic java.lang.String getPluginID()
PluginAncestor
getPluginID in class PluginAncestorpublic boolean isError(java.lang.Exception e_p)
PluginAncestor
isError in class PluginAncestorpublic java.lang.String waitForPageToLoad()
PluginAncestor
waitForPageToLoad in class PluginAncestor
public void waitForPageToLoad(java.lang.String timeoutMillis_p)
throws com.webmbt.MBTException
timeoutMillis_p - max number of milliseconds to wait until it timesout.
com.webmbt.MBTExceptionpublic java.lang.String getItemFormat(java.lang.String tagMethod)
public java.lang.String replaceToken(java.lang.String format,
java.lang.String token,
java.lang.String replaceString)
public void write(com.webmbt.mscript.ActionScript script)
throws java.lang.Exception
java.lang.Exception
public void write(com.webmbt.mscript.AssertScript script)
throws java.lang.Exception
assertScript -
java.lang.Exception
public void write(com.webmbt.mscript.IfScript script)
throws java.lang.Exception
java.lang.Exception
public void write(com.webmbt.mscript.ThenScript script)
throws java.lang.Exception
java.lang.Exception
public void write(com.webmbt.mscript.ElseScript script)
throws java.lang.Exception
java.lang.Exception
public void write(com.webmbt.mscript.WhileScript script)
throws java.lang.Exception
java.lang.Exception
public void write(com.webmbt.mscript.LogScript script)
throws java.lang.Exception
java.lang.Exception
public void writeTagCheck(java.lang.String reqTag_p,
java.lang.String[] params_p)
throws java.lang.Exception
java.lang.Exception
public void write(java.lang.String tagName_p,
java.lang.String[] params_p)
throws java.lang.Exception
java.lang.Exception
public java.lang.String getValue(java.lang.String locator_p)
throws com.webmbt.MBTException
com.webmbt.MBTException
public java.lang.String getText(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <log msg="$getText('id=rowTitle')"/>
com.webmbt.MBTException
public java.lang.String isPresent(java.lang.String locator_p)
throws com.webmbt.MBTException
Example:
<if val1="$isPresent('checkbox1')" op="eq" val2="true"/>
<log msg="checkbox1 is present on this page">
</if>
com.webmbt.MBTException
public java.lang.String count(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <log msg="$found $count('name=paymentType') payment types on the screen"/>
com.webmbt.MBTException
public java.lang.String isDisabled(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <log msg="Field F1 disabled?: $isDisabled('id=F1')."/>
com.webmbt.MBTException
public java.lang.String isVisible(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <log msg="Field F1 visible?: $isVisible('id=F1')."/>
com.webmbt.MBTException
public java.lang.String getAttr(java.lang.String locator_p,
java.lang.String attrName_p)
throws com.webmbt.MBTException
Example: <log msg="Field attribute: $getAttr('id=F1','class')."/>
Each type of HTML element has a set of attributes but it also allows user defined attributes. For example "table" element has these attributes "id", "name", "width", "height", "class", etc. These are standard attributes to define a table in HTML. You may add any user attributes like "customerNumber", "orderNumber", "firstName", etc. These user defined attributes are also accessible by getAttr().
com.webmbt.MBTExceptionhttp://www.w3schools.com/tags/default.asp
public java.lang.String click(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <action code="$click('id=F1')"/>
com.webmbt.MBTException
public java.lang.String click(java.lang.String locator_p,
java.lang.String shiftCtrlAlt_p)
throws com.webmbt.MBTException
Example: <action code="$click('id=F1','S')"/>
shiftCtrlAlt_p - S for shift, C for ctrl, A for alt, for example "SA" for holding down Shift and Alt key.locator_p - shiftCtrlAlt_p -
com.webmbt.MBTException
public java.lang.String click(java.lang.String locator_p,
java.lang.String coordX_p,
java.lang.String coordY_p)
throws com.webmbt.MBTException
Example: <action code="$click('id=F1','100','200')"/>
Notice that even though coordX_p and coordY_p are integer parameters, they must be enclosed by a set of single quote.
locator_p - coordX_p - coordY_p -
com.webmbt.MBTException
public java.lang.String doubleClick(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <action code="$doubleClick('id=F1')"/>
com.webmbt.MBTException
public java.lang.String rightClick(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <action code="$rightClick('id=F1')"/>
com.webmbt.MBTException
public java.lang.String type(java.lang.String locator_p,
java.lang.String keyString_p)
throws com.webmbt.MBTException
Example: <action code="$type('id=F1','abc')"/>
com.webmbt.MBTException
public java.lang.String type(java.lang.String locator_p,
java.lang.String shiftCtrlAlt_p,
java.lang.String keyString_p)
throws com.webmbt.MBTException
Example: <action code="$type('id=F1','S','abc')"/>
locator_p - shiftCtrlAlt_p - include char "c" for control key, "a" for alt key and "s" for shift key. For example
"cs" to have control and shift keys pressed.keyString_p -
com.webmbt.MBTException
public java.lang.String mouseOver(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <action code="$mouseOver('id=F1')"/>
com.webmbt.MBTException
public java.lang.String mouseDown(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <action code="$mouseDown('id=F1')"/>
locator_p -
com.webmbt.MBTException
public java.lang.String mouseUp(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <action code="$mouseUp('id=F1')"/>
locator_p -
com.webmbt.MBTException
public java.lang.String dragAndDrop(java.lang.String fromLocator_p,
java.lang.String toLocator_p)
throws com.webmbt.MBTException
Example: <action code="$dragAndDrop('id=F1','id=F2')"/>
fromLocator_p - toLocator_p -
com.webmbt.MBTException
public java.lang.String selectOption(java.lang.String locator_p,
java.lang.String optionLocator_p)
throws com.webmbt.MBTException
Example: <action code="$selectOption('id=selectF1','value=2')"/>
locator_p - locator for the elementoptionLocator_p - locator for the option to be selected.
For example, label=regexp:^[Oo]ther
For example, value=other
id=option1
index=2
com.webmbt.MBTException
public java.lang.String setCheckBox(java.lang.String locator_p,
java.lang.String checked_p)
throws com.webmbt.MBTException
Example: <action code="$setCheckBox('id=F1','true')"/>
locator_p - locator to the checkbox elementchecked_p - true or false
com.webmbt.MBTException
public java.lang.String isChecked(java.lang.String locator_p)
throws com.webmbt.MBTException
Example: <log msg="The checkbox F1 checked? $isChecked('id=F1')"/>
locator_p - locator to the checkbox
com.webmbt.MBTException
public java.lang.String setRadioButton(java.lang.String locator_p,
java.lang.String checked_p)
throws com.webmbt.MBTException
Example: <action code="$setRadioButton('id=F1','true')"/>
locator_p - locator to the radiobutton elementchecked_p - true or false
com.webmbt.MBTException
public java.lang.String getTitle()
throws com.webmbt.MBTException
Example: <log msg="Page title is: $getTitle()"/>
com.webmbt.MBTException
public java.lang.String containsText(java.lang.String text_p)
throws com.webmbt.MBTException
Example: <log msg="Page contains text XXXX? $containsText('XXXX')"/>
com.webmbt.MBTException
public java.lang.String selectWindow(java.lang.String windowName_p)
throws com.webmbt.MBTException
Example: <action code="$selectWindow('mainWin')"/>
windowName_p - name of the window
com.webmbt.MBTExceptionpublic java.lang.String refresh()
public java.lang.String selectFrame(java.lang.String frameName_p)
throws com.webmbt.MBTException
Example: <action code="$selectFrame('frame1')"/>
frameName_p - name of the frame
com.webmbt.MBTException
public java.lang.String sizeOf(java.lang.String locator_p)
throws com.webmbt.MBTException
com.webmbt.MBTException
public java.lang.String getCookie(java.lang.String cookieName_p)
throws com.webmbt.MBTException
com.webmbt.MBTException
public java.lang.String setupConfirmResponse(java.lang.String bool_p)
throws com.webmbt.MBTException
com.webmbt.MBTException
public java.lang.String setupAlert()
throws com.webmbt.MBTException
com.webmbt.MBTException
public java.lang.String getAlertText()
throws com.webmbt.MBTException
com.webmbt.MBTException
public java.lang.String getConfirmText()
throws com.webmbt.MBTException
com.webmbt.MBTException
public java.lang.String isAlertPresent()
throws com.webmbt.MBTException
com.webmbt.MBTException
public java.lang.String isConfirmPresent()
throws com.webmbt.MBTException
com.webmbt.MBTException
public java.lang.String js(java.lang.String winLocator_p,
java.lang.String javascript_p)
throws com.webmbt.MBTException
winLocator_p - locator for the window where the javascript will be executed on. win=windowName. Null or blank to run
on current (top) window.javascript_p -
com.webmbt.MBTException
public java.lang.String webAuth(java.lang.String authType_p,
java.lang.String userID_p,
java.lang.String password_p,
java.lang.String waitMillis_p,
java.lang.String gotoURL_p)
throws java.lang.Exception
authType_p - "HttpBasicAuth", more authentication types may be added in the future.userID_p - user id/namepassword_p - passwordwaitMillis_p - number of milliseconds to wait for the authentication to executegotoURL_p - AUT url
java.lang.Exception
public void addCustomField(java.lang.String fieldName_p,
java.lang.String fieldValue_p)
For example, the following mScript adds a custom field later to be used in xsl:
Then in xsl, you would use this syntax to print the custom field:
This is equivalent to adding the following line to the seqout.fmt file except that
using this mScript function is specific to each model while seqout.fmt is for all models.
@myField=myVal
Note no duplication is checked.
fieldName_p - name of the fieldfieldValue_p - value of the field
public void setFormatField(java.lang.String fieldName_p,
java.lang.String fieldValue_p)
fieldName_p - fieldValue_p - public void setPathFlag(java.lang.String flag_p)
Be aware that a test case (path) consists of multiple transitions. Example: $setPathFlag('keep') or $setPathFlag('discard')
flag_p - either keep or discard.public void seqout(java.lang.String msg_p)
Example: $seqout('$get('var1')')
msg_p - public void noOut(java.lang.String msg_p)
Example:
msg_p - public void setOsCmdHostPort(java.lang.String hostPort_p)
Example: $setOsCmdHostPort('localhost:8888')
hostPort_p -
public java.lang.String addOsCmdLink(java.lang.String osCmd_p,
java.lang.String cmdName_p)
Example: $addOsCmdLink('link name','abc.bat')
osCmd_p - cmdName_p -
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||