org.safs.selenium.spc

Class SPJVMInjector

java.lang.Object

org.safs.SAFSPlus

org.safs.selenium.webdriver.SeleniumPlus

org.safs.selenium.spc.SPJVMInjector

public class SPJVMInjector
extends SeleniumPlus

Provides the ability for any Java application running in a compatible JVM to launch and use SeleniumPlus.

When properly invoked via the inject() Method an instance of SeleniumPlus is launched in a separate daemon Thread. That instance can be used directly along with all the traditional classes and methods available via SeleniumPlus.

When the application is expected to shutdown--or whenever the SeleniumPlus instance is no longer needed-- the caller should invoke the shutdown() method to allow the SeleniumPlus daemon Thread to gracefully shutdown.

Configuring your Java application to use SeleniumPlus:

• Tell SeleniumPlus where to find its test configuration file:
  This is done via a JVM VM argument, String[] args, or Java System Property:
  1. JVM VM Argument: -Dsafs.project.config=<pathTo>/test.ini
     
     (INI file can have any name desired.)
     JVM Argument is passed in when launching your Java application.
  2. System Property: key: safs.project.config, value: <pathTo>/test.ini
     
     (INI file can have any path/name desired.)
     Set by JVM VM Argument or explicitly by user Java code: System.setProperty(key, value).
  3. SPJVMInjector.inject(args);
     
     Any and all command-line args supported by SeleniumPlus can be passed in.
• In that SeleniumPlus configuration file, specify the SeleniumPlus project info:
  
  1. Specify the DriverRoot directory where default config information already exists.
  2. Specify the ProjectRoot directory for the SeleniumPlus project to be used.
     This is the project whose directories, App Maps, Benchmarks, and Log files will be used.
  3. Specify any other test configuration info desired or needed by SeleniumPlus.

  Example: "MyInjector.INI"

       [SAFS_DRIVER]
       DriverRoot="%SELENIUM_PLUS%\extra\automation"
       
       [SAFS_PROJECT]
       ProjectRoot="C:\Automation\MySePlusProject"
       
       [SAFS_TEST]
       TestName="MyInjectorTest"
       CycleLogMode="TEXTLOG CONSOLELOG XMLLOG"
       
       [STAF]
       EmbedDebug="MyInjectorDebug.log"
       

• Include 3 SeleniumPlus JAR dependencies in your Java Project or CLASSPATH:
  
  1. %SELENIUM_PLUS%\libs\seleniumplus.jar
  2. %SELENIUM_PLUS%\libs\JSTAFEmbedded.jar
  3. %SELENIUM_PLUS%\libs\selenium-server-standalone-3.xx.jar
     (Specify the selenium-standalone-server installed.)

Having configured your Java project/application and INI files, a sample invocation of your app using SeleniumPlus might look like:

 set CLASSPATH=<YourJarFiles>;<SeleniumPlusJarFiles>
 java -cp %CLASSPATH% -Dsafs.project.config=C:/Automation/MySePlusProject/MyInjector.INI MyJavaApplicationClass
 

And the code inside your Java app to instantiate and then use SeleniumPlus:

 < your application code >
 
 SPJVMInjector seleniumplus = SPJVMInjector.inject(new String[0]);
 
 < do more stuff with or without SeleniumPlus >
 
 seleniumplus.StartWebBrowser("https://www.google.com", "Google", "chrome");
 
 < do more stuff until it's time to shutdown SeleniumPlus >
 
 seleniumplus.shutdown();
 
 < allow your application to exit >
 

FEB 11, 2019 (Carl Nagle) Initial Release

See Also:

inject(String[]), shutdown()

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.selenium.webdriver.SeleniumPlus

SeleniumPlus.Assert, SeleniumPlus.CheckBox, SeleniumPlus.ComboBox, SeleniumPlus.Component, SeleniumPlus.Counters, SeleniumPlus.EditBox, SeleniumPlus.Files, SeleniumPlus.ListView, SeleniumPlus.Logging, SeleniumPlus.Menu, SeleniumPlus.Misc, SeleniumPlus.Rest, SeleniumPlus.ScrollBar, SeleniumPlus.Strings, SeleniumPlus.TabControl, SeleniumPlus.Tree, SeleniumPlus.WDTimeOut, SeleniumPlus.Window

Nested classes/interfaces inherited from class org.safs.SAFSPlus

SAFSPlus.DriverCommand

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	BROWSER_ID_ROOT
(package private) static java.lang.String	PRODUCT_DESCRIPTION
(package private) static java.lang.String	PRODUCT_NAME
(package private) static java.lang.String	PRODUCT_VERSION
(package private) WebDriverGUIUtilities	utils Provide access to WebDriverGUIUtilities used by the running instance.

Fields inherited from class org.safs.selenium.webdriver.SeleniumPlus

Runner, TEMP_SELENIUM_PLUS_RS_VAR

Fields inherited from class org.safs.SAFSPlus

_autorun, _autorunClassProvided, _injectDataAwareness, _isInjected, _isSPC, _junit, allowExit, ARG_AUTORUN, ARG_AUTORUN_CLASS, ARG_JUNIT, ARG_SAFSVAR, DefaultRunner, exitCode, normalizeTextForInput, prevResults, RELATIVE_TO_PARENT, RELATIVE_TO_SCREEN, springApplicationContext

Constructor Summary

Constructors

Constructor and Description
SPJVMInjector() Used internally.
SPJVMInjector(WebDriverGUIUtilities utils) Used internally.

Method Summary

Modifier and Type	Method and Description
WebDriverGUIUtilities	getUtils() Only viable AFTER the call to inject() has produced a running instance of SeleniumPlus.
static SPJVMInjector	inject(java.lang.String[] args) Primary user entry point. Use this to inject SeleniumPlus into your running JVM. SeleniumPlus will be launched in a separate daemon Thread and the instance will be returned to the caller.
void	runTest() Used internally.
void	shutdown() Clears the "running" flag signaling the separate SeleniumPlus Thread to shutdown. The routine provides a short delay before returning giving SeleniumPlus some time to shutdown.

Methods inherited from class org.safs.selenium.webdriver.SeleniumPlus

AbortTest, AltLeftDrag, Click, ClickUnverified, CtrlAltLeftDrag, CtrlClick, CtrlLeftDrag, CtrlRightClick, CtrlShiftLeftDrag, deduceFilterAreas, DoubleClick, executeAsyncScript, ExecuteScript, executeScript, GetGUIImage, GetGUIImage, getObject, getObject, GetVariableValue, Highlight, HoverScreenLocation, LeftDrag, main, Pause, PrintTestCaseSummary, PrintTestSuiteSummary, RightClick, RightDrag, SetVariableValue, ShiftClick, ShiftLeftDrag, StartTestCase, StartTestSuite, StartWebBrowser, StopTestCase, StopWebBrowser, SwitchWebBrowser, TypeChars, TypeEncryption, TypeKeys, VerifyBinaryFileToFile, VerifyFileToFile, VerifyGUIImageToFile, VerifyTextFileToFile, VerifyValueContains, VerifyValueContainsIgnoreCase, VerifyValueDoesNotContain, VerifyValues, VerifyValuesIgnoreCase, VerifyValuesNotEqual, WaitForGUI, WebDriver

Methods inherited from class org.safs.SAFSPlus

_getMappedValue, _getVariable, _processArgs, _resolveDDVariables, _setVariable, action, actionGUILess, autorun, back, combineParams, command, debug, error, forward, getAllowExit, getExitCode, getRunner, iDriver, normalizeTextForInput, quote, quotePath, replaceSeparator, setAllowExit, setExitCode, setLeveledTest, setNormalizeTextForInput, setRunner, testStatusCode

Methods inherited from class java.lang.Object

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

Field Detail

utils

WebDriverGUIUtilities utils

Provide access to WebDriverGUIUtilities used by the running instance.

See Also:

getUtils()

BROWSER_ID_ROOT

static final java.lang.String BROWSER_ID_ROOT

See Also:

Constant Field Values

PRODUCT_NAME

static final java.lang.String PRODUCT_NAME

See Also:

Constant Field Values

PRODUCT_VERSION

static final java.lang.String PRODUCT_VERSION

See Also:

Constant Field Values

PRODUCT_DESCRIPTION

static final java.lang.String PRODUCT_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

SPJVMInjector

public SPJVMInjector()

Used internally. Must be public to support SAFSPlus clazz.newInstance()

SPJVMInjector

public SPJVMInjector(WebDriverGUIUtilities utils)

Used internally. Must be public to support SAFSPlus clazz.newInstance()

Parameters:

utils -

Method Detail

getUtils

public WebDriverGUIUtilities getUtils()

Only viable AFTER the call to inject() has produced a running instance of SeleniumPlus.

Returns:

WebDriverGUIUtilities used by the running SeleniumPlus instance.

runTest

public void runTest()
             throws java.lang.Throwable

Used internally. As a specialized remote driver of SeleniumPlus, this method has been designed to:

• Set the "running" flag to true.
  A call to the shutdown() method will reset this flag to false.

• Store the SeleniumPlus runtime instance locally for the inject() method to return to the caller.

• Install a JVM Shutdown Hook.
  This allows us a chance to perform SeleniumPlus shutdown, if the shutdown() method is not called by the user.

• Periodically poll the "running" flag to see if we should shutdown.

• Reset the SeleniumPlus runtime instance following the shutdown.

Specified by:

runTest in class SAFSPlus

Throws:

java.lang.Throwable

See Also:

inject(String[]), shutdown()

inject

public static SPJVMInjector inject(java.lang.String[] args)

Primary user entry point.
Use this to inject SeleniumPlus into your running JVM.
SeleniumPlus will be launched in a separate daemon Thread and the instance will be returned to the caller.

Parameters:

args - String[] as might be desired to initialize SeleniumPlus.

Returns:

SPJVMInjector -- a SeleniumPlus instance allowing use of SeleniumPlus in any Java Application.

See Also:

shutdown()

shutdown

public void shutdown()

Clears the "running" flag signaling the separate SeleniumPlus Thread to shutdown.
The routine provides a short delay before returning giving SeleniumPlus some time to shutdown.