org.safs.cukes.ai.selenium

Class AISearchBase

java.lang.Object

org.safs.SAFSPlus

org.safs.selenium.webdriver.SeleniumPlus

org.safs.cukes.ai.selenium.AISearchBase

Direct Known Subclasses:

AIComponent, AIDebugActions

public class AISearchBase
extends SeleniumPlus

The base class on which many AI Search Algorithms will subclass.

There can be no invokable step definition methods in this class since no true step definition file is allowed to be extended.

To execute a Cucumber test based on this class:

1. Your SeleniumPlus test class might EXTEND this AISearchBase class,
2. That subclass must implement/override the SeleniumPlus.runTest() method,
3. the runTest() method will call the runCukesTest(String, String) method with appropriate glue and feature file parameters.

Alternatively, you might be able to call the static runCukesTest(String, String) method from anywhere to run one or more Cucumber invocations.

The following JARs must be in the JVM CLASSPATH for such a Unit test invocation. This is the same as any other SeleniumPlus test invocation:

         pathTo/yourClasses/bin or yourTest.jar,
         pathTo/seleniumplus.jar,
         pathTo/JSTAFEmbedded.jar, (or JSTAF.jar if using STAF and other external tools or engines.)
 

Then, you can execute this test with an invocation similar to:

         java -cp %CLASSPATH% td.testcases.stepdefs.AISearchBase
 

See Also:

SeleniumPlus.main(java.lang.String[]), SAFSPlus.runTest(), runCukesTest(String, String)

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
protected static boolean	_abort_on_assert_failure default: false
protected static boolean	_abort_on_find_failure default: true
protected static boolean	_case_does_not_matter default: false
protected static boolean	_log_details default: true
protected static boolean	_substring_matches_allowed default: false
protected static boolean	_using_cached_component default: false
protected java.util.Map<java.lang.String,Component>	cachedLibComponents a cache holding the library component
static java.lang.String	DEFAULT_SEPLUS_AI_DEFINITIONS org.safs.cukes.ai.selenium The default package containing the step definitions.
protected static java.util.List<Arbre<SearchObject.FrameElement>>	frames a list of frame nodes, each node contains its parent frames to the root.
protected static Arbre<SearchObject.FrameElement>	frameTree the frame tree of the whole html document
static java.lang.String	GLUE_OPT --glue the option for cucumber runtime builder.
protected org.openqa.selenium.SearchContext	searchContext The context to find WebElements. It is normally a WebDriver but it also can be a WebElement (the WebElement representing the parent) if we specify the recognition string as parent.child format.

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

PRODUCT_DESCRIPTION, PRODUCT_NAME, PRODUCT_VERSION, 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
AISearchBase()

Method Summary

Modifier and Type	Method and Description
static java.util.List<org.openqa.selenium.WebElement>	addNonRepeatedElements(java.util.List<org.openqa.selenium.WebElement> results, java.util.List<org.openqa.selenium.WebElement> elements) Find the non-repeated elements from the parameter 'elements' and add them into 'results'. Currently we compare the web-element's id, if 2 elements have the same ID, we consider them same.
static java.util.List<java.lang.String>	convertElementArrayToList(Element[] elements) Get the text of each element object in an array, and add it to a list, then return the list.
protected java.io.File	deduceBenchFile(java.lang.String filename) Deduce the absolute full path bench-relative file.
protected java.io.File	deduceDiffFile(java.lang.String filename) Deduce the absolute full path Diff-relative file.
protected java.io.File	deduceProjectFile(java.lang.String filename) Deduce the absolute full path to a project-relative file.
protected java.io.File	deduceTestFile(java.lang.String filename) Deduce the absolute full path test-relative file.
static org.openqa.selenium.WebElement	findElementInParent(org.openqa.selenium.WebElement baseElement, java.lang.String xpath, int index) Try to find the Nth matched element from the sub-nodes of parent of current node, if not found then we go to the grand-parent to search again, and so on.
protected java.util.List<org.openqa.selenium.WebElement>	findElements(Criteria criteria) Find the WebElements according to the search Criteria. In this method we firstly find the WebElements by SeleniumPlus-Library (the frame may get switched if the RS containing information about frame). In not found, we try to find WebElements in AI way, Criteria's component RS will be treated as the anchor-label to search components around.
static java.util.List<org.openqa.selenium.WebElement>	findElementsInParent(org.openqa.selenium.WebElement baseElement, java.lang.String xpath) Try to find the matched elements from the sub-nodes of parent of current node, if not found then we go to the grand-parent to search again, and so on.
org.openqa.selenium.WebElement	findSelectableItemFromText(java.lang.String text) Find the first WebElement whose text matches the provided text. The search will be tried on each frame until we find the first matched element. Note: Once this method is done, we should have switched to a certain frame. If substring matches are enabled, then we will also attempt partial substring matches. If the search is slow, this might be caused by the timeout, we can accelerate by calling AIMiscActions.do_not_wait_if_a_component_is_not_ready().
protected Component	getCachedLibComponent(Criteria criteria) get the cached Component according to the key, which can be a text-label, xpath or css-selector ect.
static org.openqa.selenium.WebElement	getFirstIFrame(RemoteDriver selenium) Deprecated. please use initializeFrames(WebDriver) instead.
protected java.lang.String	getXpathType(java.lang.String type)
protected java.util.List<Arbre<SearchObject.FrameElement>>	initializeFrames(org.openqa.selenium.WebDriver selenium) This method will generate the frame-tree and assign it to static field frameTree traverse the frameTree in pre-order and put each frame node into a static list frames
static void	logElementIdInfo(org.openqa.selenium.WebElement element) Collect and log important recognition information on an element and then log it for review. Information like:
static void	logElementProperties(org.openqa.selenium.WebElement element) Log 'properties' info on the provided WebElement as collected by WDLibrary.getProperties. Also see the logElementIdInfo method for a comparison of items collected.
static void	logListElementsInfo(java.util.List<org.openqa.selenium.WebElement> elements)
static void	logMapKeyValues(java.util.Map<java.lang.String,java.lang.Object> map) Log Map key=value pairs to the debug log for review. Called internally by certain info collecting methods.
static void	main(java.lang.String[] args) Invokes SeleniumPlus.main(args) when called by the JVM as the startup class.
protected boolean	matched(org.openqa.selenium.WebElement element, java.lang.String type) Test if the element's type can match what is expected.
protected void	resetFrames() Reset the static field frames and frameTree to null.
static void	runCukesTest(java.lang.String features) Starts a Cucumber Runtime and executes Cucumber test(s) with the default step definitions in package DEFAULT_SEPLUS_AI_DEFINITIONS.
static void	runCukesTest(java.lang.String features, java.lang.String... glues) Starts a Cucumber Runtime and executes Cucumber test(s) with the glues and feature file specs provided.
static void	runCukesTest(java.lang.String glue, java.lang.String features) Starts a Cucumber Runtime and executes Cucumber test(s) with the glue and feature file specs provided.
void	runTest() Currently does nothing.
protected void	saveCachedLibComponent(Criteria criteria, Component component) put the Component into the cache by the key, which can be a text-label, xpath or css-selector ect.

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, 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

_substring_matches_allowed

protected static boolean _substring_matches_allowed

default: false

_case_does_not_matter

protected static boolean _case_does_not_matter

default: false

_abort_on_find_failure

protected static boolean _abort_on_find_failure

default: true

_abort_on_assert_failure

protected static boolean _abort_on_assert_failure

default: false

_using_cached_component

protected static boolean _using_cached_component

default: false

_log_details

protected static boolean _log_details

default: true

cachedLibComponents

protected java.util.Map<java.lang.String,Component> cachedLibComponents

a cache holding the library component

searchContext

protected org.openqa.selenium.SearchContext searchContext

The context to find WebElements.
It is normally a WebDriver but it also can be a WebElement (the WebElement representing the parent) if we specify the recognition string as parent.child format.

See Also:

findElements(Criteria)

frameTree

protected static Arbre<SearchObject.FrameElement> frameTree

the frame tree of the whole html document

frames

protected static java.util.List<Arbre<SearchObject.FrameElement>> frames

a list of frame nodes, each node contains its parent frames to the root.

GLUE_OPT

public static final java.lang.String GLUE_OPT

--glue the option for cucumber runtime builder.

See Also:

Constant Field Values

DEFAULT_SEPLUS_AI_DEFINITIONS

public static final java.lang.String DEFAULT_SEPLUS_AI_DEFINITIONS

org.safs.cukes.ai.selenium The default package containing the step definitions.

See Also:

Constant Field Values

Constructor Detail

AISearchBase

public AISearchBase()

Method Detail

getCachedLibComponent

protected Component getCachedLibComponent(Criteria criteria)

get the cached Component according to the key, which can be a text-label, xpath or css-selector ect.

saveCachedLibComponent

protected void saveCachedLibComponent(Criteria criteria,
                                      Component component)

put the Component into the cache by the key, which can be a text-label, xpath or css-selector ect.

findElements

protected java.util.List<org.openqa.selenium.WebElement> findElements(Criteria criteria)

Find the WebElements according to the search Criteria.
In this method we firstly find the WebElements by SeleniumPlus-Library (the frame may get switched if the RS containing information about frame).
In not found, we try to find WebElements in AI way, Criteria's component RS will be treated as the anchor-label to search components around.

Parameters:

criteria - Criteria, the conditions helping to find elements

Returns:

List a list of matched elements

logMapKeyValues

public static void logMapKeyValues(java.util.Map<java.lang.String,java.lang.Object> map)

Log Map key=value pairs to the debug log for review.
Called internally by certain info collecting methods.

Parameters:

map -

See Also:

logElementProperties(WebElement), logElementIdInfo(WebElement)

logElementProperties

public static void logElementProperties(org.openqa.selenium.WebElement element)

Log 'properties' info on the provided WebElement as collected by WDLibrary.getProperties.
Also see the logElementIdInfo method for a comparison of items collected.

Parameters:

element -

See Also:

SearchObject.getProperties(WebElement), logMapKeyValues(Map), logElementIdInfo(WebElement)

logElementIdInfo

public static void logElementIdInfo(org.openqa.selenium.WebElement element)

Collect and log important recognition information on an element and then log it for review.
Information like:

• tag
• id
• class
• name
• placeholder
• text
• value
• etc..

Parameters:

element - - WebElement to collect and log important attributes.

See Also:

logMapKeyValues(Map)

logListElementsInfo

public static void logListElementsInfo(java.util.List<org.openqa.selenium.WebElement> elements)

Parameters:

elements - -- List of WebElements to be iteratively sent to logElementIdInfo

See Also:

logElementIdInfo(WebElement)

getFirstIFrame

@Deprecated
public static org.openqa.selenium.WebElement getFirstIFrame(RemoteDriver selenium)

Deprecated. please use initializeFrames(WebDriver) instead.

Switch to (make active) the first 'iframe' element found in the current window/doc/frame.
Does NOT currently set/change the WebDriver lastFrame reference. Though we should consider doing that.
May want to search on frame or frameset if these are found to be needed in the future.

Parameters:

selenium - - RemoteDriver controlling the web session of interest.

Returns:

the 'iframe' WebElement if found and switched, or null if not found.

getXpathType

protected java.lang.String getXpathType(java.lang.String type)

Parameters:

type - String, represents the WebElement's type, such as "ComboBox", "Button" etc.

Returns:

String, represents the XPATH according to which to find the WebElement. For example XPATH.relativeDescendants(XPATH.COMBOBOX) is used to find the ComboBox elements.

matched

protected boolean matched(org.openqa.selenium.WebElement element,
                          java.lang.String type)

Test if the element's type can match what is expected.

Parameters:

element - WebElement, the element to check.

type - String, the expected type, such as EditBox, RadioButton, ComboBox etc.

Returns:

boolean true if the web-element matches the expected type.

resetFrames

protected void resetFrames()

Reset the static field frames and frameTree to null.

initializeFrames

protected java.util.List<Arbre<SearchObject.FrameElement>> initializeFrames(org.openqa.selenium.WebDriver selenium)

This method will

1. generate the frame-tree and assign it to static field frameTree
2. traverse the frameTree in pre-order and put each frame node into a static list frames

Parameters:

selenium - WebDriver

Returns:

List<Arbre<FrameElement>>, a list of frames of the whole page.

findElementsInParent

public static java.util.List<org.openqa.selenium.WebElement> findElementsInParent(org.openqa.selenium.WebElement baseElement,
                                                                                  java.lang.String xpath)

Try to find the matched elements from the sub-nodes of parent of current node, if not found then we go to the grand-parent to search again, and so on.

Parameters:

baseElement - WebElement, from whose parent to search

xpath - String, the xpath served as search-conditions

Returns:

List, the matched elements. null if cannot be found.

findElementInParent

public static org.openqa.selenium.WebElement findElementInParent(org.openqa.selenium.WebElement baseElement,
                                                                 java.lang.String xpath,
                                                                 int index)

Try to find the Nth matched element from the sub-nodes of parent of current node, if not found then we go to the grand-parent to search again, and so on.

Parameters:

baseElement - WebElement, from whose parent to search

xpath - String, the xpath served as search-conditions

index - int, the Nth matched item

Returns:

WebElement, the matched Nth element or null if cannot be found.

findSelectableItemFromText

public org.openqa.selenium.WebElement findSelectableItemFromText(java.lang.String text)

Find the first WebElement whose text matches the provided text.
The search will be tried on each frame until we find the first matched element.
Note:

1. Once this method is done, we should have switched to a certain frame.
2. If substring matches are enabled, then we will also attempt partial substring matches.
   
3. If the search is slow, this might be caused by the timeout, we can accelerate by calling AIMiscActions.do_not_wait_if_a_component_is_not_ready().

Parameters:

text - String

Returns:

WebElement matching requested text or null if not found.

See Also:

AIMiscActions.accept_partial_text_matches(), AIMiscActions.deny_partial_text_matches(), AIMiscActions.do_not_wait_if_a_component_is_not_ready()

addNonRepeatedElements

public static java.util.List<org.openqa.selenium.WebElement> addNonRepeatedElements(java.util.List<org.openqa.selenium.WebElement> results,
                                                                                    java.util.List<org.openqa.selenium.WebElement> elements)

Find the non-repeated elements from the parameter 'elements' and add them into 'results'.
Currently we compare the web-element's id, if 2 elements have the same ID, we consider them same.

Parameters:

results - List<WebElement>, the destination list into which we add elements

elements - List<WebElement>, the list of elements to be added

Returns:

List<WebElement>, the result list

deduceTestFile

protected java.io.File deduceTestFile(java.lang.String filename)
                               throws SAFSException

Deduce the absolute full path test-relative file.

Parameters:

filename, - String, the test/actual file name. If there are any File.separators in the relative path then the path is actually considered relative to the Datapool directory unless it does not exist, or is already an absolute file path.

If a relative directory path does not exist relative to the Datapool directory then the final path will be relative to the Project directory.

If it is an absolute path, and contains a root path that includes the Bench directory, then the file will be converted to a comparable relative path off the Test directory.

Returns:

File, the absolute full path test file.

Throws:

SAFSException

See Also:

FileUtilities.deduceFile(String, int, RuntimeDataInterface)

deduceDiffFile

protected java.io.File deduceDiffFile(java.lang.String filename)
                               throws SAFSException

Deduce the absolute full path Diff-relative file.

Parameters:

filename, - String, the diff file name. If there are any File.separators in the relative path then the path is actually considered relative to the Datapool directory unless it does not exist, or is already an absolute file path.

If a relative directory path does not exist relative to the Datapool directory then the final path will be relative to the Project directory.

If it is an absolute path, and contains a root path that includes the Bench directory, then the file will be converted to a comparable relative path off the Diff directory.

Returns:

File, the absolute full path diff file.

Throws:

SAFSException

See Also:

FileUtilities.deduceFile(String, int, RuntimeDataInterface)

deduceBenchFile

protected java.io.File deduceBenchFile(java.lang.String filename)
                                throws SAFSException

Deduce the absolute full path bench-relative file.

Parameters:

filename, - String, the test file name. If there are any File.separators in the relative path then the path is actually considered relative to the Datapool directory unless it does not exist, or is already an absolute file path. If a relative directory path does not exist relative to the Datapool directory then the final path will be relative to the Project directory.

Returns:

File, the absolute full path bench file.

Throws:

SAFSException

See Also:

FileUtilities.deduceFile(String, int, RuntimeDataInterface)

deduceProjectFile

protected java.io.File deduceProjectFile(java.lang.String filename)
                                  throws SAFSException

Deduce the absolute full path to a project-relative file.

Parameters:

filename, - String, the test file name. The path is ALWAYS considered relative to the project root directory regardless of the absence or presence of File.separators unless the file is already an absolute path.

Returns:

File, the absolute full path bench file.

Throws:

SAFSException

See Also:

FileUtilities.deduceFile(String, int, RuntimeDataInterface)

convertElementArrayToList

public static java.util.List<java.lang.String> convertElementArrayToList(Element[] elements)

Get the text of each element object in an array, and add it to a list, then return the list.

Parameters:

elements - Element[], an array of element object

Returns:

List, a list of element's text

runCukesTest

public static void runCukesTest(java.lang.String features)
                         throws java.lang.Throwable

Starts a Cucumber Runtime and executes Cucumber test(s) with the default step definitions in package DEFAULT_SEPLUS_AI_DEFINITIONS. Examples:

• Using the default Step Definition files defined in DEFAULT_SEPLUS_AI_DEFINITIONS, and locates the single AltSearchAI.feature file to runs that test in Cucumber.
  runCukesTest("./Tests/td/testcases/features/AltSearchAI.feature");
• Using the default Step Definition files defined in DEFAULT_SEPLUS_AI_DEFINITIONS, and locates the ./resources/features directory to runs tests based on the feature files found there.
  runCukesTest("./resources/features");

Parameters:

features - String, the path to the directory of feature files, or the specific feature file to run.

Throws:

java.lang.Throwable

runCukesTest

public static void runCukesTest(java.lang.String glue,
                                java.lang.String features)
                         throws java.lang.Throwable

Starts a Cucumber Runtime and executes Cucumber test(s) with the glue and feature file specs provided.

Examples:

runCukesTest( "td", "./Tests/td/testcases/features/AltSearchAI.feature");
Searches the "td" Java package and all subpackages for usable Step Definition files.
Locates the single AltSearchAI.feature file and runs that test in Cucumber.
runCukesTest( "org.mine.steps", "./resources/features");
Searches the "org.mine.steps" Java package and all subpackages for usable Step Definition files.
Locates the ./resources/features directory and runs tests based on the feature files found there.

Step Definition files are sought using the calling Thread's context ClassLoader.

Parameters:

glue - String, the Java package root containing the Java Step Definition files to use.

features - String, the path to the directory of feature files, or the specific feature file to run.

Throws:

java.lang.Throwable

See Also:

java.lang.Thread#getContextClassLoader()}

runCukesTest

public static void runCukesTest(java.lang.String features,
                                java.lang.String... glues)
                         throws java.lang.Throwable

Starts a Cucumber Runtime and executes Cucumber test(s) with the glues and feature file specs provided.

Examples:

runCukesTest("./Tests/td/testcases/features/AltSearchAI.feature", "td", "org.mine.steps");
Searches the "td" and "org.mine.steps" Java packages and all subpackages for usable Step Definition files.
Locates the single AltSearchAI.feature file and runs that test in Cucumber.
runCukesTest("./resources/features", "td", "org.mine.steps");
Searches the "td" and "org.mine.steps" Java packages and all subpackages for usable Step Definition files.
Locates the ./resources/features directory and runs tests based on the feature files found there.

Step Definition files are sought using the calling Thread's context ClassLoader.

Parameters:

features - String, the path to the directory of feature files, or the specific feature file to run.

glues - String[], the Java packages containing the Java Step Definition files to use.

Throws:

java.lang.Throwable

See Also:

java.lang.Thread#getContextClassLoader()}

runTest

public void runTest()
             throws java.lang.Throwable

Currently does nothing. Subclasses can override to provide unit tests, etc...

Specified by:

runTest in class SAFSPlus

Throws:

java.lang.Throwable

main

public static void main(java.lang.String[] args)

Invokes SeleniumPlus.main(args) when called by the JVM as the startup class.

Parameters:

args -