Skip to content

Screenshot and other fixes #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sampeson merged 5 commits into from
Sep 15, 2020
Merged

Screenshot and other fixes #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
147bdb4
Add possibility to configure different directory for log.html in Set …
sampeson Sep 15, 2020
9ddf5ac
java agent documentation fix
sampeson Sep 15, 2020
45d4db9
Set Classpath failure as warnings and add failIfNotFound argument
sampeson Sep 15, 2020
b5c06b3
Use asyncFx for helperfunctions methods, remove waitForFxEvents usage…
sampeson Sep 15, 2020
09054a9
remove deprecated keywords and methods (enhancement #11)
sampeson Sep 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions src/main/java/javafxlibrary/keywords/AdditionalKeywords/ApplicationLauncher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,15 +122,19 @@ private void _addPathToClassPath(String path) {

@RobotKeyword("Loads given path to classpath.\n\n"
+ "``path`` is the path to add.\n\n"
+ "``failIfNotFound`` is either True or False, default False. In case of False error is written as warning.\n\n"
+ "If directory path has asterisk(*) after directory separator all jar files are added from directory.\n"
+ "\nExample:\n"
+ "| Set To Classpath | C:${/}users${/}my${/}test${/}folder | \n"
+ "| Set To Classpath | C:${/}users${/}my${/}test${/}folder${/}* | \n")
@ArgumentNames({ "path" })
public void setToClasspath(String path) {
+ "| Set To Classpath | C:${/}users${/}my${/}test${/}folder${/}* | \n"
+ "| Set To Classpath | C:${/}users${/}my${/}test${/}folder2${/}* | failIfNotFound=${True} | \n")
@ArgumentNames({ "path", "failIfNotFound=False" })
public void setToClasspath(String path, boolean failIfNotFound) {
RobotLog.info("Setting \"" + path + "\" to classpath, failIfNotFound=\"" + failIfNotFound + "\"");
if (path.endsWith("*")) {
path = path.substring(0, path.length() - 1);
RobotLog.info("Adding all jars from directory: " + path);
RobotLog.info("Adding all jars from directory.");
String fullPath = FileSystems.getDefault().getPath(path).normalize().toAbsolutePath().toString();

try {
File directory = new File(path);
Expand All @@ -143,11 +147,20 @@ public void setToClasspath(String path) {
}
}
if (!jarsFound) {
throw new JavaFXLibraryNonFatalException("No jar files found from classpath: "
+ FileSystems.getDefault().getPath(path).normalize().toAbsolutePath().toString());
String jarsNotFoundError = "No jar files found from classpath: " + fullPath;
if (failIfNotFound) {
throw new JavaFXLibraryNonFatalException(jarsNotFoundError);
} else {
RobotLog.warn(jarsNotFoundError);
}
}
} catch (NullPointerException e) {
throw new JavaFXLibraryFatalException("Directory not found: " + path + "\n" + e.getMessage(), e);
String directoryNotFoundError = "Directory not found: " + fullPath;
if (failIfNotFound) {
throw new JavaFXLibraryFatalException(directoryNotFoundError);
} else {
RobotLog.warn(directoryNotFoundError);
}
}
} else {
_addPathToClassPath(path);
Expand Down Expand Up @@ -250,17 +263,6 @@ public String getCurrentApplication() {
}
}

@Deprecated
@RobotKeyword("*DEPRECATED in version 0.6.0!* Use `Get Current Application` keyword instead.\n\n"
+ "Returns the class name of currently active JavaFX Application\n")
public String currentApplication() {
try {
return getCurrentSessionApplicationName();
} catch (Exception e) {
throw new JavaFXLibraryNonFatalException("Problem getting current application name.", e);
}
}

@RobotKeyword("Returns if JavaFXLibrary is started as java agent.")
public boolean isJavaAgent() {
return TestFxAdapter.isAgent;
Expand Down
245 changes: 18 additions & 227 deletions src/main/java/javafxlibrary/keywords/AdditionalKeywords/ConvenienceKeywords.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,30 +54,6 @@
@RobotKeywords
public class ConvenienceKeywords extends TestFxAdapter {

@Deprecated
@RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find` instead.\n\n" +
"finder that mimics _xpath_ style search.\n\n"
+ "``query`` is a query locator, see `3.1 Locator syntax`.\n\n"
+ "``failIfNotFound`` specifies if keyword should fail if nothing is found. By default it's false and "
+ "keyword returns null in case lookup returns nothing.\n\n"
+ "\nExample:\n"
+ " | ${node}= | Find With Path | .main-view[0] .split-pane[0] \\#node-id class=GridPane .toggle-button[3] sometext | ")
@ArgumentNames({"query", "failIfNotFound=False"})
public Object findWithPath(String query, boolean failIfNotFound){

try {
return mapObject(findNode(query));

} catch (JavaFXLibraryNonFatalException e){
if(failIfNotFound)
throw new JavaFXLibraryNonFatalException("Unable to find anything with query: \"" + query + "\"");
return "";

} catch (Exception e) {
throw new JavaFXLibraryNonFatalException("Find operation failed for query: \"" + query + "\"", e);
}
}

@RobotKeyword("Brings the given stage to front\n\n"
+ "``stage`` is an Object:Stage to be set in front of others, see `3.2 Using locators as keyword arguments`. \n\n")
@ArgumentNames({ "stage" })
Expand Down Expand Up @@ -130,116 +106,6 @@ public void callObjectMethodInFxApplicationThread(Object object, String method,
callMethod(object, method, finalArgs, true);
}

@Deprecated
@RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find` instead.\n\n"
+ "Returns the *first* node matching the query. \n\n"
+ "``query`` is the Class name String to use in lookup.\n"
+ "\nExample:\n"
+ "| ${my node}= | Find | javafx.scene.control.Button | # button class |")
@ArgumentNames({ "query" })
public Object findClass(final String query) {
try {
Class<?> clazz = Class.forName(query);
InstanceOfMatcher matcher = new InstanceOfMatcher(clazz);
return mapObject(robot.lookup(matcher).query());
} catch (Exception e) {
RobotLog.trace("Problem has occurred during node lookup: " + e);
return "";
}
}

@Deprecated
@RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find All` instead.\n\n"
+ "Returns *all* descendant nodes of given node matching the query. \n\n"
+ "``node`` is the starting point Object:Node from where to start looking, see `3.2 Using locators as keyword arguments`. \n\n"
+ "``query`` is a query locator, see `3.1 Locator syntax`.\n\n"
+ "``failIfNotFound`` specifies if keyword should fail if nothing is found. By default it's false and "
+ "keyword returns null in case lookup returns nothing.\n\n"
+ "\nExample:\n"
+ "| ${my nodes}= | Find All From Node | ${some node} | .css | \n"
+ "See keyword `Find` for further examples of query usage.\n")
@ArgumentNames({ "node", "query", "failIfNotFound=False" })
public List<Object> findAllFromNode(Object node, String query, boolean failIfNotFound) {
try {
if ( node instanceof Node ) {
RobotLog.info("Trying to find all nodes with query: \"" + query + "\" that are under starting " +
"point node: \"" + node + "\", failIfNotFound= \"" + failIfNotFound + "\"");
return mapObjects(((Node) node).lookupAll(query));
}
// fail in case no valid node argument.
failIfNotFound = true;
throw new JavaFXLibraryNonFatalException("Illegal argument type for node.");
} catch (JavaFXLibraryNonFatalException e){
if(failIfNotFound)
throw e;
return Collections.emptyList();

} catch (Exception e) {
throw new JavaFXLibraryNonFatalException("Find all from node operation failed for node: \"" + node.toString() +
"\" and query: " + query, e);
}
}

@Deprecated
@RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find All` instead.\n\n"
+ "Returns *all* nodes matching query AND given pseudo-class state. \r\n"
+ "``query`` is a query locator, see `3.1 Locator syntax`.\n\n"
+ "``pseudo`` is a String value specifying pseudo class value.\n\n"
+ "``failIfNotFound`` specifies if keyword should fail if nothing is found. By default it's false and "
+ "keyword returns null in case lookup returns nothing.\n\n"
+ "\nExample:\n"
+ "| ${my node}= | Find All With Pseudo Class | .check-box-tree-cell .check-box | selected | \n")
@ArgumentNames({ "query", "pseudo", "failIfNotFound=False" })
public List<Object> findAllWithPseudoClass(String query, String pseudo, boolean failIfNotFound) {
RobotLog.info("Trying to find all nodes with query: \"" + query + "\" that has pseudoclass state as: \"" +
pseudo + "\", failIfNotFound= \"" + failIfNotFound + "\"");
try {
Set<Node> nodes = robot.lookup(query).queryAll();
Set<Node> matches = nodes.stream()
.filter(n -> n.getPseudoClassStates().stream().
map(PseudoClass::getPseudoClassName).anyMatch(pseudo::contains))
.collect(Collectors.toSet());
return mapObjects(matches);

} catch (JavaFXLibraryNonFatalException e){
if(failIfNotFound)
throw e;
return Collections.emptyList();

} catch (Exception e) {
throw new JavaFXLibraryNonFatalException("Find all with pseudo class operation failed for query: \"" +
query + "\" and pseudo: \"" + pseudo + "\"", e);
}
}

@Deprecated
@RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find` instead.\n\n"
+ "Returns the *first* descendant node of given node matching the query. \n\n"
+ "``node`` is the starting point Object:Node from where to start looking, see `3.2 Using locators as keyword arguments`. \n\n"
+ "``query`` is a query locator, see `3.1 Locator syntax`.\n\n"
+ "``failIfNotFound`` specifies if keyword should fail if nothing is found. By default it's false and "
+ "keyword returns null in case lookup returns nothing.\n\n"
+ "\nExample:\n"
+ "| ${my node}= | Find From Node | ${some node} | .css |\n"
+ "See keyword `Find` for further examples of query usage.\n")
@ArgumentNames({ "node", "query", "failIfNotFound=False" })
public Object findFromNode(Node node, String query, boolean failIfNotFound) {
RobotLog.info("Trying to find: \"" + query + "\" from node: \"" + node + "\", failIfNotFound= \"" + failIfNotFound + "\"");
try {
Node childNode = node.lookup(query);
return mapObject(childNode);

} catch (JavaFXLibraryNonFatalException e){
if(failIfNotFound)
throw e;
return "";

} catch (Exception e) {
throw new JavaFXLibraryNonFatalException("Find from node operation failed for node: \"" + node +
"\" and query: " + query, e);
}
}

@RobotKeyword("Lists methods available for given node.\n"
+ "``node`` is the Object:Node which methods to list, see `3.2 Using locators as keyword arguments`. \n\n"
+ "When working with custom components you may use this keyword to discover methods you can call "
Expand Down Expand Up @@ -390,40 +256,6 @@ public Set<PseudoClass> getPseudoClassStates(Object locator) {
}
}

// TODO: Should this be deleted? Find All From Node has the same functionality
@Deprecated
@RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find` instead.\n\n"
+ "Returns *all* descendant nodes of given node matching the given Java class name. \n\n"
+ "``locator`` is either a _query_ or _Object_ for node whose children will be queried, see "
+ "`3.2 Using locators as keyword arguments`. \n\n"
+ "``className`` is the Java class name to look for.\n"
+ "\nExample:\n"
+ "| ${panes}= | Get Node Children By Class Name | ${some node} | BorderPane | \n"
+ "Returns an empty list if none is found. \n")
@ArgumentNames({ "node", "className" })
public Set<Object> getNodeChildrenByClassName(Object locator, String className) {
Node node = objectToNode(locator);
RobotLog.info("Getting node: \"" + node + "\" children by class name: \"" + className + "\"");
try {
Set<Object> keys = new HashSet<>();
Set childNodes = node.lookupAll("*");

for (Object o : childNodes) {
Node childNode = (Node) o;
if (childNode.getClass().getSimpleName().equals(className)) {
RobotLog.trace("Classname: \"" + className + "\" found: \"" + childNode + "\"");
keys.add(mapObject(childNode));
}
}
return keys;
} catch (Exception e) {
if(e instanceof JavaFXLibraryNonFatalException)
throw e;
throw new JavaFXLibraryNonFatalException("Unable to get node children for node: \"" + node.toString() +
"\" with class name: " + className, e);
}
}

@RobotKeyword("Returns text value of the Node. \n\n"
+ "``locator`` is either a _query_ or _Object_ for a node whose getText method will be called, see "
+ "`3. Locating JavaFX Nodes`. \n\n")
Expand All @@ -441,35 +273,6 @@ public String getNodeText(Object locator) {
}
}

@Deprecated
@RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find` instead.\n\n"
+ "Returns height value of the node. \n\n"
+ "``locator`` is either a _query_ or _Object_ for a node whose getHeight method will be called, see "
+ "`3. Locating JavaFX Nodes`. \n\n")
@ArgumentNames({ "locator" })
public String getNodeHeight(Object locator) {
Node node = objectToNode(locator);
try {
Method[] methods = node.getClass().getMethods();
for (Method m : methods) {
if (m.getName().equals("getHeight")) {
try {
Object result = m.invoke(node, (Object) null);
return result.toString();
} catch (Exception e) {
throw new JavaFXLibraryNonFatalException("Problem calling method: .getHeight(): " + e.getMessage(), e);
}
}
}
throw new JavaFXLibraryNonFatalException(
"Get node height failed for node: \"" + node.toString() + "\". Element has no method getHeight()");
} catch (Exception e) {
if (e instanceof JavaFXLibraryNonFatalException)
throw e;
throw new JavaFXLibraryNonFatalException("Unable to get node height for node: " + node.toString(), e);
}
}

@RobotKeyword("Returns image name and path of the node. \n\n"
+ "``locator`` is either a _query_ or _Object_ for a node whose getHeight method will be called, see "
+ "`3. Locating JavaFX Nodes`. \n\n"
Expand Down Expand Up @@ -535,31 +338,6 @@ public String getObjectClassName(Object locator) {
}
}

@Deprecated
@RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Get Scene` instead.\n\n"
+"Returns given locators Scene object. \n\n"
+ "``locator`` is either a _query_ or a _Node_, see `3.2 Using locators as keyword arguments`\n\n")
@ArgumentNames({ "locator" })
public Object getNodesScene(Object locator) {
try {
if (locator instanceof Node){
RobotLog.info("Getting a Scene object for a Node: \"" + locator + "\"");
return mapObject(((Node) locator).getScene());
} else if (locator instanceof String) {
RobotLog.info("Getting a Scene object for a query: \"" + locator + "\"");
Node node = objectToNode(locator);
return mapObject(node.getScene());
}

throw new JavaFXLibraryNonFatalException("Locator type is not a Node or a query string!");

} catch (Exception e) {
if (e instanceof JavaFXLibraryNonFatalException)
throw e;
throw new JavaFXLibraryNonFatalException("Unable to get Scene object for locator: \"" + locator + "\"", e);
}
}

@RobotKeyword("Returns Scene of the given object. \n\n"
+ "``locator`` is either a _query_, a _Node_ or a _Window_, see `3.2 Using locators as keyword arguments`\n\n")
@ArgumentNames({ "locator" })
Expand Down Expand Up @@ -776,11 +554,24 @@ public int getTableColumnCount(Object locator){
}

@RobotKeyword("Sets the screenshot directory for current application\n\n"
+ "``directory`` is a path to a folder which is to be set as current screenshot directory")
@ArgumentNames({ "directory" })
public void setScreenshotDirectory(String dir){
RobotLog.info("Setting new screenshot directory: " + dir);
setCurrentSessionScreenshotDirectory(dir);
+ "Notice that relative paths are from current work dir of JavaFXLibrary:\n"
+ "- In case of Java Agent it comes from Application Under Test (AUT).\n"
+ "- In case of JavaFXLibrary is started with \"java -jar *\" command it uses the current working directory as source.\n"
+ "``directory`` is a path to a folder which is to be set as current screenshot directory in host where "
+ "JavaFXLibrary is run.\n\n"
+ "``logDirectory`` is a path that is put to log.html files that can be used after screenshots are moved "
+ "from target system to e.g. CI workspace. Typically this is relative path.\n\n\n"
+ "Example:\n"
+ "| Set Screenshot Directory | /Users/robotuser/output/AUT-screenshots/ | ./output/AUT-screenshots/ | \n"
+ "or\n"
+ "| Set Screenshot Directory | ./output/AUT-screenshots/ | \n")
@ArgumentNames({ "directory", "logDirectory=" })
public void setScreenshotDirectory(String dir, String logDir){
RobotLog.info("Setting screenshot directory to \"" + dir + "\".");
if (logDir != null && !logDir.isEmpty()) {
RobotLog.info("Log directory is set to \"" + logDir + "\"");
}
setCurrentSessionScreenshotDirectory(dir, logDir);
}

@RobotKeyword("Gets the screenshot directory for current application")
Expand Down
Loading