com.tplan.robot.scripting.interpret

Class AbstractTestScriptInterpret

java.lang.Object

com.tplan.robot.scripting.interpret.AbstractTestScriptInterpret

All Implemented Interfaces:

Plugin, ScriptTypeProvider, TestScriptInterpret, ScriptedExecutable, EventListener, DocumentListener

Direct Known Subclasses:

PlainTextInterpret

public abstract class AbstractTestScriptInterpret
extends Object
implements TestScriptInterpret, Plugin, DocumentListener, ScriptTypeProvider

Base test script interpret class providing a basic event framework.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BACKUP_FILE_SUFFIX

Fields inherited from interface com.tplan.robot.scripting.interpret.TestScriptInterpret

TYPE_JAVA, TYPE_PROPRIETARY, TYPE_UNKNOWN

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener cl)
String	applyVariablesToCommand(String command, ScriptingContext repository)
void	backUp()
void	changedUpdate(DocumentEvent e) Gives notification that an attribute or set of attributes changed.
void	checkDependencies(PluginManager manager) Check whether all dependencies are installed.
void	deleteBackup()
void	deleteBackup(URI uri) Delete the back up file associated with the specified script file.
void	destroy() Clean up method.
File	getBackup(File scriptFile)
String	getCode() Get plugin code.
ScriptingContext	getCompilationContext() Get context from the last compilation.
Date	getDate() Get plugin release date.
ScriptingContext	getExecutionContext() Get context from the last execution.
long	getFileLastModified() Get the last modification time (in millis) of the file that the interpret owns.
Class	getImplementedInterface() Get Class of the exposed functional interface that this plugin implements.
int[]	getLowestSupportedVersion() Get the lowest required version of T-Plan Robot Enterprise.
String	getMessageAfterInstall() Get text of a message to be displayed after installation of this plugin.
String	getMessageBeforeInstall() Get text of a message to be displayed before installation of this plugin.
ScriptManager	getScriptManager() Get the script manager associated with this test interpret instance.
URI	getSourceURI() Get the URI.
String	getSupportContact() Get support contact.
String	getUID() Get the test script unique Id (UID).
URI	getURI() Get test script source code URI.
String	getVendorHomePage() Get the vendor home page.
String	getVendorName() Get vendor (provider) name to be displayed in the GUI.
int[]	getVersion() Get plugin version in form of an integer array.
boolean	hasSource() Find out if the interpret has access to the source code.
void	insertUpdate(DocumentEvent e) Gives notification that there was an insert into the document.
boolean	isDestroyed() Test out whether the interpret has been destroyed by a call of TestScriptInterpret.destroy().
boolean	isEditable(String extension) Find out if a test script file of the given extension is a text one (source code) and can be edited in the script editor.This method allows to prevent users from opening of binary test scripts, such as for example Java byte code (.class).
boolean	isExecuting() Find out whether the test script is currently executing.
boolean	isManualStop() Indicates whether the script execution was stopped manually by the user.
boolean	isModified() Find out if the script is modified or not.
boolean	isPartiallyExecuting() Indicates whether the interpret is currently executing a subset of code.
boolean	isPause() Indicates whether the script is currently paused/suspended.
boolean	isRunning() Find out if the script is currently running, i.e.
boolean	isStop() Indicates whether the execution was stopped.
boolean	isSupportedTestScript() Test whether the interpret is a supported script, i.e.
void	reload() Reload the content from the URI set through the setURI(java.net.URI, boolean) method.
void	removeChangeListener(ChangeListener cl)
void	removeUpdate(DocumentEvent e) Gives notification that a portion of the document has been removed.
boolean	requiresRestart() Indicate whether installation of this plugin requires application restart.
void	save()
void	save(File f)
void	save(String text, File f)
void	setFileLastModified(long time) Set the last modification time (in millis) of the file that the interpret owns.
void	setModified(boolean modified) Indicate that the test script has been modified.
void	setPause(Object source, boolean pause, String reason) Pause or resume the executing script.
void	setScriptManager(ScriptManager sm) Set the script manager associated with this test script interpret.
void	setScriptOwner(ScriptOwner owner) Set the script owner, typically the GUI editor.
void	setSourceURI(URI sourceURI) Set the source URI.
void	setStop(Object source, boolean stop, boolean isManual, String manualStopJustification) Request to stop the script execution.
void	setURI(URI uri, boolean load) Set the test script URI.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tplan.robot.scripting.interpret.TestScriptInterpret

compile, execute, getDocument, getSupportedFileExtensions, getType, getTypeDescription, isPartialExecutionAllowed, isPartialExecutionAllowed, resetSelection, setSelection

Methods inherited from interface com.tplan.robot.plugin.Plugin

getDescription, getDisplayName, getUniqueId

Methods inherited from interface com.tplan.robot.scripting.interpret.ScriptTypeProvider

getType

Field Detail

BACKUP_FILE_SUFFIX

public static final String BACKUP_FILE_SUFFIX

See Also:

Constant Field Values

Method Detail

addChangeListener

public void addChangeListener(ChangeListener cl)

removeChangeListener

public void removeChangeListener(ChangeListener cl)

getURI

public URI getURI()

Description copied from interface: TestScriptInterpret

Get test script source code URI.

Specified by:

getURI in interface TestScriptInterpret

Returns:

test script source code URI

setURI

public void setURI(URI uri,
                   boolean load)
            throws IOException

Description copied from interface: TestScriptInterpret

Set the test script URI. If the load argument is true, the interpret should load content from the URI to the document. A value of false is usually used in "Save As" operations where the URI changes for the current document content. Saving of the file is however not performed by this method.

Specified by:

setURI in interface TestScriptInterpret

Parameters:

uri - test script URI.

load - whether to open the URI in the current document (see TestScriptInterpret.getDocument()).

Throws:

IOException - if the load parameter is true and loading of test script fails.

save

public void save()
          throws FileNotFoundException,
                 UnsupportedEncodingException,
                 BadLocationException

Throws:

FileNotFoundException

UnsupportedEncodingException

BadLocationException

reload

public void reload()
            throws IOException

Reload the content from the URI set through the setURI(java.net.URI, boolean) method.

Specified by:

reload in interface TestScriptInterpret

Throws:

IOException - on an I/O error.

isModified

public boolean isModified()

Description copied from interface: TestScriptInterpret

Find out if the script is modified or not.

Specified by:

isModified in interface TestScriptInterpret

Returns:

true if the test script code has been modified or false otherwise.

backUp

public void backUp()

deleteBackup

public void deleteBackup()

deleteBackup

public void deleteBackup(URI uri)

Delete the back up file associated with the specified script file.

Parameters:

uri - the script file URI.

Since:

4.4.4

getBackup

public File getBackup(File scriptFile)

setModified

public void setModified(boolean modified)

Description copied from interface: TestScriptInterpret

Indicate that the test script has been modified. Though the interpret owns the document and it gets notified when it gets updated, the method is used by the GUI to notify the interpret that the script has been saved to a file and thus should be handled as unchanged.

Specified by:

setModified in interface TestScriptInterpret

Parameters:

modified - true sets the script status to modified, false to unmodified.

setScriptOwner

public void setScriptOwner(ScriptOwner owner)

Description copied from interface: TestScriptInterpret

Set the script owner, typically the GUI editor.

Specified by:

setScriptOwner in interface TestScriptInterpret

Parameters:

owner - the owner.

save

public void save(String text,
                 File f)
          throws IOException

Throws:

IOException

save

public void save(File f)
          throws IOException

Throws:

IOException

getFileLastModified

public long getFileLastModified()

Description copied from interface: TestScriptInterpret

Get the last modification time (in millis) of the file that the interpret owns. This is typically used to check whether someone else has updated the file.

Specified by:

getFileLastModified in interface TestScriptInterpret

Returns:

last time of saving of the script to the file.

setFileLastModified

public void setFileLastModified(long time)

Description copied from interface: TestScriptInterpret

Set the last modification time (in millis) of the file that the interpret owns.

Specified by:

setFileLastModified in interface TestScriptInterpret

Parameters:

time - last time of saving of the script to the file.

setScriptManager

public void setScriptManager(ScriptManager sm)

Description copied from interface: TestScriptInterpret

Set the script manager associated with this test script interpret.

Specified by:

setScriptManager in interface TestScriptInterpret

Parameters:

sm - a script manager.

getCode

public String getCode()

Description copied from interface: Plugin

Get plugin code. This string serves as an identifier of the functionality delivered by the plugin. For example, desktop client plugins return protocol name like "RFB" or "RDP" as their code.

Plugin code is used by pluggable instance factories to identify a particular plugin. It may be used to replace internal plugins with third party code. For example if you develop a class which implements this and the com.tplan.robot.remoteclient.RemoteDesktop interfaces and the getCode() method returns "RFB", it will replace the internal implementation of the RFB (VNC) client.

Specified by:

getCode in interface Plugin

Returns:

plugin code (identifier). The name must not be null.

getVendorName

public String getVendorName()

Description copied from interface: Plugin

Get vendor (provider) name to be displayed in the GUI.

Specified by:

getVendorName in interface Plugin

Returns:

vendor name. May be null.

getSupportContact

public String getSupportContact()

Description copied from interface: Plugin

Get support contact. If the contact is a valid mail link like "mailto:<mailaddress>" or an HTTP link like "http://<link>", the application may follow it with appropriate program (mail client or web browser).

Specified by:

getSupportContact in interface Plugin

Returns:

support contact. May be null or a text to be displayed by the GUI or a valid URI.

getVersion

public int[] getVersion()

Description copied from interface: Plugin

Get plugin version in form of an integer array. Major version numbers are first. For example, version 1.2.3 should be represented as new int[] { 1, 2, 3 }.

Specified by:

getVersion in interface Plugin

Returns:

version number.

getImplementedInterface

public Class getImplementedInterface()

Description copied from interface: Plugin

Get Class of the exposed functional interface that this plugin implements. For example remote desktop clients return com.tplan.robot.remoteclient.RemoteDesktopClient.class.

Specified by:

getImplementedInterface in interface Plugin

Returns:

class instance of the implemented functional interface.

requiresRestart

public boolean requiresRestart()

Description copied from interface: Plugin

Indicate whether installation of this plugin requires application restart. If it returns true, users are asked to restart after plugin installation via GUI.

Specified by:

requiresRestart in interface Plugin

Returns:

true if installation of the plugin requires application restart, false otherwise.

getVendorHomePage

public String getVendorHomePage()

Description copied from interface: Plugin

Get the vendor home page. If the contact is a valid HTTP link like "http://<link>", the application may follow it with appropriate program (typically web browser).

Specified by:

getVendorHomePage in interface Plugin

Returns:

vendor home page URL.

getDate

public Date getDate()

Description copied from interface: Plugin

Get plugin release date.

Specified by:

getDate in interface Plugin

Returns:

plugin release date.

getLowestSupportedVersion

public int[] getLowestSupportedVersion()

Description copied from interface: Plugin

Get the lowest required version of T-Plan Robot Enterprise. If user attempts to install the plugin on a lower version, an error is reported.

Specified by:

getLowestSupportedVersion in interface Plugin

Returns:

the lowest T-Plan Robot Enterprise version supported by this plugin.

getMessageBeforeInstall

public String getMessageBeforeInstall()

Description copied from interface: Plugin

Get text of a message to be displayed before installation of this plugin. It may contain any relevant user information.

Specified by:

getMessageBeforeInstall in interface Plugin

Returns:

message to be displayed before installation.

getMessageAfterInstall

public String getMessageAfterInstall()

Description copied from interface: Plugin

Get text of a message to be displayed after installation of this plugin. It may contain any relevant user information.

Specified by:

getMessageAfterInstall in interface Plugin

Returns:

message to be displayed after installation.

checkDependencies

public void checkDependencies(PluginManager manager)
                       throws DependencyMissingException

Check whether all dependencies are installed.

Specified by:

checkDependencies in interface Plugin

Parameters:

manager - plugin manager instance.

Throws:

DependencyMissingException - when one or more required dependencies is not installed.

getScriptManager

public ScriptManager getScriptManager()

Description copied from interface: TestScriptInterpret

Get the script manager associated with this test interpret instance.

Specified by:

getScriptManager in interface TestScriptInterpret

Returns:

script manager associated with this test interpret

getExecutionContext

public ScriptingContext getExecutionContext()

Description copied from interface: TestScriptInterpret

Get context from the last execution. If the script hasn't been executed through TestScriptInterpret.execute(ScriptingContext), the method should return null.

Specified by:

getExecutionContext in interface TestScriptInterpret

Returns:

context from the last execution.

getCompilationContext

public ScriptingContext getCompilationContext()

Description copied from interface: TestScriptInterpret

Get context from the last compilation. If the script hasn't been compiled through TestScriptInterpret.compile(ScriptingContext), the method should return null.

Specified by:

getCompilationContext in interface TestScriptInterpret

Returns:

context from the last compilation.

isExecuting

public boolean isExecuting()

Description copied from interface: TestScriptInterpret

Find out whether the test script is currently executing.

Specified by:

isExecuting in interface TestScriptInterpret

Specified by:

isExecuting in interface ScriptedExecutable

Returns:

true if executing.

isRunning

public boolean isRunning()

Description copied from interface: TestScriptInterpret

Find out if the script is currently running, i.e. either executing (see TestScriptInterpret.isExecuting() or it is in the post-execution phase involving posting of final events, result creating and cleaning up.

Specified by:

isRunning in interface TestScriptInterpret

Returns:

true if the script has been started and hasn't finished yet.

isPartiallyExecuting

public boolean isPartiallyExecuting()

Description copied from interface: TestScriptInterpret

Indicates whether the interpret is currently executing a subset of code. For example, the TPR interpret can execute just a block of code highlighted in the editor.

Specified by:

isPartiallyExecuting in interface TestScriptInterpret

Returns:

true if executing part of the code or false otherwise.

isStop

public boolean isStop()

Description copied from interface: TestScriptInterpret

Indicates whether the execution was stopped.

Specified by:

isStop in interface TestScriptInterpret

Specified by:

isStop in interface ScriptedExecutable

Returns:

true if stopped.

isManualStop

public boolean isManualStop()

Description copied from interface: TestScriptInterpret

Indicates whether the script execution was stopped manually by the user.

Specified by:

isManualStop in interface TestScriptInterpret

Returns:

true if the user stopped the script or false otherwise.

setStop

public void setStop(Object source,
                    boolean stop,
                    boolean isManual,
                    String manualStopJustification)

Description copied from interface: TestScriptInterpret

Request to stop the script execution. The method is not supposed to stop the automated task immediately. It is rather expected to set an internal "stop" flag. The interpret should periodically test the flag, for example between individual command calls, and stop the execution as soon as possible.

The method should not fire a stop event through the ScriptListener interface. It should be rather fired when the execution is really stopped, not when the request is made.

Specified by:

setStop in interface TestScriptInterpret

Specified by:

setStop in interface ScriptedExecutable

Parameters:

source - request source.

stop - true stops (false doesn't really make sense).

isManual - this is additional flag allowing to specify whether the stop is manual, i.e. requested by the user either through GUI controls or by pressing Ctrl+C in CLI. This information is saved to the context for the benefit of report providers and doesn't affect the way the stop action is carried out.

manualStopJustification - optional string describing why or how the script was stopped. It is used just for reporting purposes.

isPause

public boolean isPause()

Description copied from interface: TestScriptInterpret

Indicates whether the script is currently paused/suspended.

Specified by:

isPause in interface TestScriptInterpret

Specified by:

isPause in interface ScriptedExecutable

Returns:

true if paused.

setPause

public void setPause(Object source,
                     boolean pause,
                     String reason)

Description copied from interface: TestScriptInterpret

Pause or resume the executing script.

Specified by:

setPause in interface TestScriptInterpret

Specified by:

setPause in interface ScriptedExecutable

Parameters:

source - the object requesting the pause (for tracking purposes only)

pause - true to pause, false to resume

reason - optional string describing why or how the script was paused or resumed.

insertUpdate

public void insertUpdate(DocumentEvent e)

Gives notification that there was an insert into the document. The range given by the DocumentEvent bounds the freshly inserted region.

Specified by:

insertUpdate in interface DocumentListener

Parameters:

e - the document event

removeUpdate

public void removeUpdate(DocumentEvent e)

Gives notification that a portion of the document has been removed. The range is given in terms of what the view last saw (that is, before updating sticky positions).

Specified by:

removeUpdate in interface DocumentListener

Parameters:

e - the document event

changedUpdate

public void changedUpdate(DocumentEvent e)

Gives notification that an attribute or set of attributes changed.

Specified by:

changedUpdate in interface DocumentListener

Parameters:

e - the document event

destroy

public void destroy()

Description copied from interface: TestScriptInterpret

Clean up method. A call of this method indicates that the interpret will not be used any more. Interprets are expected to perform an internal cleanup on a call of this method and get removed from listener lists and caches.

Specified by:

destroy in interface TestScriptInterpret

isDestroyed

public boolean isDestroyed()

Description copied from interface: TestScriptInterpret

Test out whether the interpret has been destroyed by a call of TestScriptInterpret.destroy().

Specified by:

isDestroyed in interface TestScriptInterpret

Returns:

true if destroyed or false otherwise.

isEditable

public boolean isEditable(String extension)

Description copied from interface: TestScriptInterpret

Find out if a test script file of the given extension is a text one (source code) and can be edited in the script editor.This method allows to prevent users from opening of binary test scripts, such as for example Java byte code (.class).

Specified by:

isEditable in interface TestScriptInterpret

Parameters:

extension - the file extension.

Returns:

true if the script is a text one and can be edited or false otherwise.

isSupportedTestScript

public boolean isSupportedTestScript()

Description copied from interface: TestScriptInterpret

Test whether the interpret is a supported script, i.e. whether it is executable. This flag enables multiple GUI features. There may be interprets which return false to disable these features. For example, if you open a .txt file in the Robot script editor it gets encapsulated in a dummy plain text interpret which disables all scripting functionality through this and other flags.

Specified by:

isSupportedTestScript in interface TestScriptInterpret

Returns:

true if the interpret supports automation.

applyVariablesToCommand

public String applyVariablesToCommand(String command,
                                      ScriptingContext repository)

getSourceURI

public URI getSourceURI()

Get the URI. Used by the interprets which compile the source code into a binary format.

Returns:

the sourceURI

setSourceURI

public void setSourceURI(URI sourceURI)

Set the source URI.

Parameters:

sourceURI - the sourceURI to set

hasSource

public boolean hasSource()

Description copied from interface: TestScriptInterpret

Find out if the interpret has access to the source code. This can be used to determine whether it can be opened in the script editor or not. For example, a Java test script interpret may contain just the test class instance and not the source code.

Specified by:

hasSource in interface TestScriptInterpret

Returns:

true if the interpret has access to the source code, false if not.

getUID

public String getUID()

Get the test script unique Id (UID).

Specified by:

getUID in interface TestScriptInterpret

Returns:

the test script UID.

Since:

4.4.4