diff --git a/.gitattributes b/.gitattributes index 35efda5..08b6e8e 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,3 @@ -# https://git-scm.com/docs/gitattributes -# unix line feeds to every file (if dos linefeeds needed can be overridden) +# https://git-scm.com/docs/gitattributes +# unix line feeds to every file (if dos linefeeds needed can be overridden) * -text \ No newline at end of file diff --git a/.gitignore b/.gitignore index f960d0f..889580c 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,11 @@ JavaFXLib-*.png .idea *.iml report-images +*.DS_Store # temporary pom file by shade plugin dependency-reduced-pom.xml + +# TODO: put logs to some other location, e.g. under target that gets cleaned +# docker demo environment robot reports +src/test/robotframework/results/ \ No newline at end of file diff --git a/AUTHORS.txt b/AUTHORS.txt index 8566740..9a5e4bc 100644 --- a/AUTHORS.txt +++ b/AUTHORS.txt @@ -1,7 +1,11 @@ Core contributors: -Jukka Haavisto 2017 - -Sami Pesonen 2017 - -Pasi Saikkonen 2017 - +Jukka Haavisto 2017 - +Sami Pesonen 2017 - +Pasi Saikkonen 2017 - Other contributors: -Tatu Lahtela Find All With Pseudo Class and Find Class keywords \ No newline at end of file +Tatu Lahtela Find All With Pseudo Class and Find Class keywords +Sakari Hoisko Dockerized linux env with X +Juho Lehtonen Optimized docker environment. +Juho Saarinen Package improvements, initial monocle support, screenshot bug fix +Turo Soisenniemi Initial java agent support diff --git a/BUILD.md b/BUILD.md index 903c64e..34497f5 100644 --- a/BUILD.md +++ b/BUILD.md @@ -16,8 +16,8 @@ JavaFXLibrary uses Apache Maven as a build tool. are being used by both JavaFXLibrary and the AUT. It's not uncommon that a specific version is needed for AUT and another version of the same dependency is required for JavaFXLibrary(e.g. TestFX dependency for Google Guava). Not always are these dependencies backwards compatible and therefore JavaFXLibrary has adopted Apache Maven Shade Plugin to cope with this issue. - Currently the package com.google.common has been renamed in JavaFXLibrary as shaded.com.google.common to avoid version - mismatches with Google Guava dependencies. See https://maven.apache.org/plugins/maven-shade-plugin/ for more info. + Currently the package com.google.common has been renamed in JavaFXLibrary as shaded.com.google.common and org.apache.commons as shaded.org.apache.commons to avoid version + mismatches with dependencies in AUT and internally. See https://maven.apache.org/plugins/maven-shade-plugin/ for more info. ## Releasing @@ -25,6 +25,7 @@ JavaFXLibrary uses Apache Maven as a build tool. * update library version to x.x.x in pom.xml * run tests ``mvn clean verify`` * copy target/robotframework/libdoc/javafxlibrary.html under docs directory (check that README.md links to correct file) +* update links in README.md to point correct version in maven central * ``git commit -m "version to x.x.x" pom.xml docs/javafxlibrary.html`` * create tag ``git tag -a x.x.x`` * push ``git push origin master`` and ``git push origin x.x.x`` @@ -58,8 +59,12 @@ JavaFXLibrary uses Apache Maven as a build tool. ```` * Release snapshot or actual release (depending what is in version tag in pom.xml)``mvn clean deploy -P release`` + * In case of release log in to https://oss.sonatype.org: + * from left choose `Staging repositories` and scroll down, choose `robotframework-*` repository and review + * choose from top toolbar `Release`, add to reason field `x.y.z release` and submit + * sync takes typically hours before visible in Maven Central * snapshots can be found from https://oss.sonatype.org/content/repositories/snapshots/org/robotframework/javafxlibrary/ - * actual releases can be found from https://search.maven.org/ and typing `javafxlibrary` in the search field. + * actual releases can be found from https://search.maven.org/ and typing `javafxlibrary` in the search field. ## Announcements diff --git a/Dockerfile_build b/Dockerfile_build new file mode 100644 index 0000000..834ae4e --- /dev/null +++ b/Dockerfile_build @@ -0,0 +1,26 @@ +FROM ubuntu:16.04 as builder +ENV DEBIAN_FRONTEND noninteractive +RUN apt-get -qq update && apt-get dist-upgrade -y && apt-get install -qq --no-install-recommends --allow-unauthenticated -y \ + openjdk-8-jdk \ + openjfx \ + python3-pip \ + maven \ + git-all \ + && rm -rf /var/lib/apt/lists/* \ + && mkdir code +COPY . /code +WORKDIR /code +RUN mvn package +# ENTRYPOINT java -jar /code/target/javafxlibrary-*-SNAPSHOT-jar-with-dependencies.jar + +FROM ubuntu:16.04 +COPY --from=builder /code/target/javafxlibrary-*-jar-with-dependencies.jar / +COPY --from=builder /code/target/javafxlibrary-*-tests.jar / +RUN echo "Built following jar files" && ls -latr /*.jar +COPY entrypoint_build.sh /. +RUN apt-get -qq update && apt-get dist-upgrade -y && apt-get install -qq --no-install-recommends --allow-unauthenticated -y \ + openjdk-8-jre \ + openjfx \ + && rm -rf /var/lib/apt/lists/* && chmod 555 /javafxlibrary-*-jar-with-dependencies.jar /entrypoint_build.sh +EXPOSE 8270 +ENTRYPOINT /entrypoint_build.sh diff --git a/Dockerfile_release b/Dockerfile_release new file mode 100644 index 0000000..094df9d --- /dev/null +++ b/Dockerfile_release @@ -0,0 +1,24 @@ +THIS IS JUST DRAFT!!! + +FROM ubuntu:16.04 as builder +ENV DEBIAN_FRONTEND noninteractive +RUN apt-get -qq update && apt-get dist-upgrade -y && apt-get install -qq --no-install-recommends --allow-unauthenticated -y \ + openjdk-8-jdk \ + openjfx \ + python3-pip \ + maven \ + git-all \ + && mkdir code +RUN wget latest https://github.com/eficode/JavaFXLibrary/releases Source code.zip && unzip +WORKDIR /code +RUN mvn package + +FROM ubuntu:16.04 +RUN apt-get -qq update && apt-get dist-upgrade -y && apt-get install -qq --no-install-recommends --allow-unauthenticated -y \ + openjdk-8-jre \ + openjfx \ + && rm -rf /var/lib/apt/lists/* +COPY --from=builder /code/target/JAVAFX:n testisoftat +RUN wget https://github.com/eficode/JavaFXLibrary/releases JavaFXLibrary-0.4.1.jar +EXPOSE 8270 +ENTRYPOINT java -jar JavaFXLibrary-0.4.1.jar jolle sisäään myös testisofta jarrit class pathinä/etc? diff --git a/README.md b/README.md index 644b8ec..6d74771 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,103 @@ # JavaFXLibrary -[Robot Framework](http://robotframework.org) library for testing and connecting to a JavaFX java process and using [TestFX](https://github.com/TestFX/TestFX). +[TestFX](https://github.com/TestFX/TestFX) based [Robot Framework](http://robotframework.org) library for testing JavaFX Applications. -This library allows you to use robot/pybot (Python version of Robot Framework) to run test cases over remote library interface although it also works if you are running with jybot (Jython version of Robot Framework). This means that you can use your other pure Python libraries in your test cases that will not work when runnin with Jython. - -JavaFXLibrary is tested to work with Robot Framework 3.0.2 or later. - -You can connect to applications running on your local machine or even on a different machine. +JavaFXLibrary works with both Jython (local and remote use) and Python (remote only) versions of Robot Framework. This means JavaFXLibrary can be used with Jython incompatible test libraries too by importing it as a remote library. +JavaFXLibrary is tested to work with Java 8 and Robot Framework 3.2.1 or later. ## Keyword documentation -See keyword [documentation](https://eficode.github.io/JavaFXLibrary/javafxlibrary.html). - -## Installation - -1. Download latest JavaFXLibrary and documentation from https://github.com/robotframework/JavaFXLibrary/releases/ -2. Copy(if needed) JAR to desired location and run from command line using - ``` - java -jar javafxlibrary-.jar - - ``` -3. JavaFXLibrary in RemoteServer mode should now be running in port [8270](http://localhost:8270) -4. Optionally JAR can be launched with port number as an optional argument: - ``` - java -jar javafxlibrary-.jar 1234 - ``` -5. JavaFXLibrary in RemoteServer mode should now be running in port [1234](http://localhost:1234) +See keyword [documentation](https://repo1.maven.org/maven2/org/robotframework/javafxlibrary/0.7.1/javafxlibrary-0.7.1.html). -## Usage in Robot suite settings +For editors (IDEs) keyword documentation can be obtained from [here](https://repo1.maven.org/maven2/org/robotframework/javafxlibrary/0.7.1/javafxlibrary-0.7.1.xml). -Import the library: +## Taking the library into use +### As a local library +1. Download JavaFXLibrary jar file from [releases](https://github.com/eficode/JavaFXLibrary/releases/) or [Maven Central](https://search.maven.org/artifact/org.robotframework/javafxlibrary). +2. Import JavaFXLibrary in test settings: ``` -***Settings*** -Library Remote http://localhost:8270/ WITH NAME JavaFXLibrary +*** Settings *** +Library JavaFXLibrary ``` -Now the keywords can be used as usual: +3. Add library jar to Jython [module search path](http://robotframework.org/robotframework/3.1.2/RobotFrameworkUserGuide.html#configuring-where-to-search-libraries-and-other-extensions) and run your tests: ``` -Launch Javafx Application javafxlibrary.testapps.TestClickRobot +jython -J-cp javafxlibrary-.jar -m robot.run tests.robot ``` -In case of duplicate keywords(multiple keywords found with same name) use e.g. `JavaFXLibrary.'Keyword Name'` to get rid of warnings. - -## Using multiple remote libraries - -If you need to use the Remote library multiple times in a test suite, or just want to give it a more descriptive name, you can import it using the WITH NAME syntax. +### As a remote library +1. Download JavaFXLibrary jar file from [releases](https://github.com/eficode/JavaFXLibrary/releases/) or [Maven Central](https://search.maven.org/artifact/org.robotframework/javafxlibrary). +2. Start JavaFXLibrary as a remote library: `java -jar javafxlibrary-.jar` + - Remote library starts in port [8270](http://localhost:8270) by default. + - Port number can also be defined in the start command: `java -jar javafxlibrary-.jar 1234` +3. Import JavaFXLibrary in test settings: ``` -***Settings*** -Library Remote http://localhost:8270/ WITH NAME client1 -Library Remote http://localhost:8272/ WITH NAME client2 +*** Settings *** +Library Remote http://127.0.0.1:8270 WITH NAME JavaFXLibrary ``` +4. Run your tests: `robot tests.robot` -Now the keywords can be used as `client1.List Windows` and `client2.List Windows` +## Using JavaFXLibrary on macOS Mojave +MacOS Mojave introduced changes to security settings and disabled some of the features JavaFXLibrary uses by default. +To use JavaFXLibrary on macOS Mojave you must enable the accessibility features for terminal in system preferences: +- Navigate to `Apple menu > System Preferences > Security & Privacy > Privacy > Accessibility` +- Click the lock and enter your password to change these settings +- If terminal has requested accessibility features before it should show in the list +- If not, add it by clicking :heavy_plus_sign: and selecting `Applications > Utilities > Terminal` +- Enable accessibility features by checking the box: :white_check_mark: Terminal -## JavaFX UI objects +## Identifying JavaFX UI objects +[Scenic View](https://github.com/JonathanGiles/scenic-view) is a tool that allows you to inspect the JavaFX application scenegraph. This can be useful especially when you do not have access to the source code. -With [Scenic View](http://fxexperience.com/scenic-view/) you can see all your JavaFX applications UI objects. -See [keyword documentation](#keyword-documentation) for additional info how to use them with keywords. +See [keyword documentation](https://eficode.github.io/JavaFXLibrary/javafxlibrary.html#3.%20Locating%20JavaFX%20Nodes) for detailed information about handling UI elements with the library. ## JavaFXLibrary demo -This can be also used as JavaFXLibrary demo. +Library's acceptance test suite can be used as a JavaFXLibrary demo. Running the test suite requires [Maven](https://maven.apache.org) installation. -Generic way with Maven (in repository root): -``` -mvn verify -``` +### Running the demo locally +- Clone the repository: `git clone https://github.com/eficode/JavaFXLibrary.git` +- Run acceptance tests (in repository root): `mvn verify` -Windows command line: +### Running the demo using Docker +#### Requirements: +* Docker CE: https://docs.docker.com/install/ +* Docker-compose: https://docs.docker.com/compose/install/ +* Port 80 is free in your machine + +#### Running the tests +1. Build & start the Dockerized environment: `docker-compose up -d robot-framework javafxcompile` +2. Open browser to +3. Open xterm from Start menu > System tools > xterm +4. Execute tests: `test.sh` + +Executing _test.sh_ runs the acceptance suite twice: first using JavaFXLibrary as a local Robot Framework library on Jython, and after that using the library in remote mode executing the same tests on python version of Robot Framework. + +If you want the suite to run only once, you can define which type of library to use by including **local** or **remote** as an argument. For example command `test.sh remote` will execute the suite only in remote mode. + +## Experimental: Headless support +Library supports headless operation utilizing [Monocle](https://wiki.openjdk.java.net/display/OpenJFX/Monocle). The support for this is still at experimental level. + +### Main issues with headless function +* Scrolling doesn't work same way as with screen + * "Tick" (amount of scrolling) is much smaller in headless than normally + * Vertical (left/right) scrolling is not working +* Separate app windows' can't be closed (unless app offers that functionality itself) +* Swing applications can't be tested in headless mode. + +### Enabling headless mode +Headless mode can be enabled by setting first library initialization to "True". + +Locally: ``` -java -cp "target\javafxlibrary-.jar" org.robotframework.RobotFramework --include smoke src\test\robotframework/ +*** Settings *** +Library JavaFXLibrary ${True} ``` -Linux/OSX command line: +Remote: ``` -java -cp "target/javafxlibrary-.jar" org.robotframework.RobotFramework --include smoke src/test/robotframework/ - +*** Settings *** +Library Remote http://127.0.0.1:8270 ${True} WITH NAME JavaFXLibrary ``` -## Known issues - -* If the remote library server and tests are running on the same machine, the server must be restarted between test executions. If the server is not restarted, test applications will launch behind other windows, causing tests to fail when robot is trying to interact with them. +## Experimental: Java agent support +Library can be used as java agent. Launch application with `-javaagent:/path/to/javafxlibrary-.jar`. Default port is 8270 and can be changed with adding `=` to java agent command. Only remote library is supported. Using launch keyword is still required but instead of starting new application keyword initializes Stage for library. diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..016492d --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,52 @@ +version: '2' +services: + + robot-framework: + build: + context: ./docker/robot-javafx-demo + ports: + - '80:80' + volumes: + - './src/test/robotframework/:/robot' + - screen-thing:/tmp/.X11-unix + - javafxbinaryshare:/javafxbinary + networks: + - testapp + environment: + - RESOLUTION=1920x1080 + - X11VNC_ARGS=-multiptr + + javafxcompile: + build: + context: ./ + dockerfile: Dockerfile_build + restart: on-failure + networks: + - testapp + volumes: + - './src/test/robotframework/:/robot' # Required for executing tests from robot-framework container + - screen-thing:/tmp/.X11-unix + - javafxbinaryshare:/javafxbinary + environment: + - DISPLAY=:1 + +# javafxrelease: +# build: +# context: ./ +# dockerfile: Dockerfile_release +# restart: on-failure +# networks: +# testapp: +# aliases: +# - javafxcompile +# volumes: +# - './src/:/src' # ScreenCapturingTest.robot require this. +# - screen-thing:/tmp/.X11-unix +# environment: +# - DISPLAY=:20.0 + +networks: + testapp: +volumes: + screen-thing: + javafxbinaryshare: diff --git a/docker/robot-javafx-demo/Dockerfile b/docker/robot-javafx-demo/Dockerfile new file mode 100644 index 0000000..0e75a4a --- /dev/null +++ b/docker/robot-javafx-demo/Dockerfile @@ -0,0 +1,27 @@ +FROM dorowu/ubuntu-desktop-lxde-vnc:bionic + +ENV DEBIAN_FRONTEND noninteractive + +RUN apt-get -qq update && apt-get dist-upgrade -y && apt-get install -qq --no-install-recommends --allow-unauthenticated -y \ + openssh-client \ + xterm \ + python-pip \ + git \ + python-setuptools \ + wget \ + openjdk-8-jre \ + # Install older version of openjfx, current version is incompatible with openjdk8 + # Bug ticket: https://bugs.launchpad.net/ubuntu/+source/openjfx/+bug/1799946 + openjfx=8u161-b12-1ubuntu2 \ + libopenjfx-java=8u161-b12-1ubuntu2 \ + libopenjfx-jni=8u161-b12-1ubuntu2 \ + openjfx-source=8u161-b12-1ubuntu2 \ + && apt-get clean && rm -rf /var/lib/apt/lists/* + +COPY test.sh /bin/test.sh +RUN pip install --no-cache-dir \ + robotframework && chmod 555 /bin/test.sh + + +EXPOSE 5900 80 +ENTRYPOINT ["/startup.sh"] diff --git a/docker/robot-javafx-demo/entrypoint.sh b/docker/robot-javafx-demo/entrypoint.sh new file mode 100644 index 0000000..f175d17 --- /dev/null +++ b/docker/robot-javafx-demo/entrypoint.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env bash +xhost + +/usr/bin/fluxbox diff --git a/docker/robot-javafx-demo/test.sh b/docker/robot-javafx-demo/test.sh new file mode 100644 index 0000000..59d1baf --- /dev/null +++ b/docker/robot-javafx-demo/test.sh @@ -0,0 +1,65 @@ +#!/bin/bash +EXIT_VALUE=0 + +function local() { + echo "**********************" + echo "INFO: Local execution:" + file=$(ls -1 /javafxbinary/javafxlibrary-*-jar-with-dependencies.jar) + testJar=$(ls -1 /javafxbinary/javafxlibrary-*-tests.jar) + java -cp ${file} org.robotframework.RobotFramework -d /robot/results/local --include smoke --variable appJar:${testJar} $@ /robot/acceptance +# $@ #just to testing script + if [[ "$?" != "0" ]]; then + EXIT_VALUE=$((EXIT_VALUE+1)) + fi +} + +function remote() { + echo "***********************" + echo "INFO: Remote execution:" + testJar=$(ls -1 /javafxbinary/javafxlibrary-*-tests.jar) + robot -d /robot/results/remote --include smoke --variable appJar:${testJar} $@ /robot/acceptance +# $@ #just to testing script + if [[ "$?" != "0" ]]; then + EXIT_VALUE=$((EXIT_VALUE+2)) + fi +} + + +case $1 in + local | LOCAL ) + shift + local $@ + ;; + remote | REMOTE | demo | DEMO) + shift + remote $@ + ;; + "" | all | ALL ) + echo "INFO: All execution:" + shift + local $@ + remote $@ + ;; + * ) + echo "ERROR:$@ is not supported parameter" + echo "Supported parameters: local, remote, all, demo ...and same with capitals" + echo "From README.md more info about usage" + EXIT_VALUE=$((EXIT_VALUE+4)) + ;; +esac +echo "*************************************************" +case ${EXIT_VALUE} in + 0 ) + echo "INFO: All fine, tests PASS" + ;; + 1 ) + echo "ERROR: Local library tests fail" + ;; + 2 ) + echo "ERROR: Remote library tests fail" + ;; + 3 ) + echo "ERROR: Local and Remote library tests fails" + ;; +esac +exit ${EXIT_VALUE} diff --git a/docs/javafxlibrary.html b/docs/javafxlibrary.html index b5c22bd..b2179aa 100644 --- a/docs/javafxlibrary.html +++ b/docs/javafxlibrary.html @@ -1,911 +1,921 @@ - - - - - - - - - - - - - - - - - - - -Codestin Search App - - - -

Opening library documentation failed

Verify that you have JavaScript enabled in your browser.
Make sure you are using a modern enough browser. Firefox 3.5, IE 8, or equivalent is required, newer browsers are recommended.
Check are there messages in your browser's JavaScript error log. Please report the problem if you suspect you have encountered a bug.

- - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +Codestin Search App + + + +

Opening library documentation failed

Verify that you have JavaScript enabled in your browser.
Make sure you are using a modern enough browser. If using Internet Explorer, version 8 or newer is required.
Check are there messages in your browser's JavaScript error log. Please report the problem if you suspect you have encountered a bug.

+ + + + + + + + + + + + + + + + + + + + + + diff --git a/entrypoint_build.sh b/entrypoint_build.sh new file mode 100644 index 0000000..a4ba273 --- /dev/null +++ b/entrypoint_build.sh @@ -0,0 +1,6 @@ +#!/usr/bin/env bash +rm -rvf /javafxbinary/* +cp -vf /javafxlibrary-*-jar-with-dependencies.jar /javafxbinary/. +cp -vf /javafxlibrary-*-tests.jar /javafxbinary/. +chmod 555 /javafxbinary/* +java -jar /javafxlibrary-*-jar-with-dependencies.jar diff --git a/pom.xml b/pom.xml index b959089..ec9144e 100644 --- a/pom.xml +++ b/pom.xml @@ -21,9 +21,10 @@ org.robotframework javafxlibrary jar - 0.5.0 + 0.7.1 UTF-8 + 1.44 ${project.groupId}:${project.artifactId} @@ -79,7 +80,7 @@ org.apache.maven.plugins maven-source-plugin - 3.0.1 + 3.2.1 attach-sources @@ -92,7 +93,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.0.1 + 3.2.0 attach-javadocs @@ -102,6 +103,33 @@ + + + org.codehaus.mojo + build-helper-maven-plugin + 3.2.0 + + + attach-artifacts + package + + attach-artifact + + + + + ${project.build.directory}/${project.artifactId}.html + html + + + ${project.build.directory}/${project.artifactId}.xml + xml + + + + + + org.apache.maven.plugins maven-gpg-plugin @@ -137,11 +165,37 @@ + + + src/main/resources + true + + **/*.properties + + + + src/main/resources + false + + **/*.properties + + + + + org.apache.maven.plugins + maven-surefire-plugin + 2.22.2 + + + -javaagent:${settings.localRepository}/org/jmockit/jmockit/${jmockit.version}/jmockit-${jmockit.version}.jar + + + org.sonatype.plugins nexus-staging-maven-plugin - 1.6.7 + 1.6.8 true ossrh @@ -151,7 +205,7 @@ maven-compiler-plugin - 3.6.1 + 3.8.1 1.8 1.8 @@ -160,13 +214,16 @@ org.apache.maven.plugins maven-jar-plugin - 3.0.2 + 3.2.0 true JavaFXLibrary + + JavaFXLibrary + @@ -178,8 +235,9 @@ + org.apache.maven.plugins maven-assembly-plugin - 3.0.0 + 3.3.0 package @@ -202,7 +260,7 @@ org.robotframework robotframework-maven-plugin - 1.4.7 + 1.7.1 acceptance tests @@ -217,8 +275,14 @@ not-ready + + monocle-issue + TRACE:INFO false + + appJar:${project.build.directory}/${project.artifactId}*tests.jar + @@ -229,6 +293,7 @@ + ${project.build.directory} ${project.artifactId}.html JavaFXLibrary ${project.version} @@ -243,6 +308,7 @@ + ${project.build.directory} ${project.artifactId}.xml JavaFXLibrary ${project.version} @@ -254,7 +320,7 @@ org.apache.maven.plugins maven-shade-plugin - 3.1.0 + 3.2.4 package @@ -263,7 +329,8 @@ - + JavaFXLibrary @@ -272,6 +339,10 @@ com.google.common shaded.com.google.common + + org.apache.commons + shaded.org.apache.commons + @@ -299,38 +370,38 @@ org.apache.maven maven-model - 3.3.9 + 3.6.3 org.jmockit jmockit test - 1.38 + ${jmockit.version} junit junit - 4.12 + 4.13.1 org.testfx testfx-core - 4.0.13-alpha + 4.0.16-alpha org.testfx - testfx-junit - 4.0.13-alpha + openjfx-monocle + 8u76-b04 org.robotframework javalib-core - 1.2.1 + 2.0.3 org.robotframework robotframework - 3.0.2 + 3.2.1 org.hamcrest @@ -338,29 +409,19 @@ 1.3 - org.awaitility - awaitility - 3.0.0 - - - com.google.guava - guava - 23.0 - - - com.github.ombre42 + org.robotframework jrobotremoteserver - 3.0 + 4.0.1 org.apache.commons commons-lang3 - 3.7 + 3.11 commons-io commons-io - 2.6 + 2.7 diff --git a/src/.gitignore b/src/.gitignore deleted file mode 100644 index 7dd6e6b..0000000 --- a/src/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -target -.idea -*.iml \ No newline at end of file diff --git a/src/main/java/JavaFXLibrary.java b/src/main/java/JavaFXLibrary.java index 2949350..2b54eb9 100644 --- a/src/main/java/JavaFXLibrary.java +++ b/src/main/java/JavaFXLibrary.java @@ -15,34 +15,34 @@ * limitations under the License. */ -import java.io.File; -import java.io.IOException; -import java.net.BindException; -import java.net.InetAddress; -import java.net.UnknownHostException; -import java.util.*; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import java.util.concurrent.atomic.AtomicReference; - import javafxlibrary.exceptions.JavaFXLibraryFatalException; import javafxlibrary.exceptions.JavaFXLibraryNonFatalException; import javafxlibrary.exceptions.JavaFXLibraryTimeoutException; import javafxlibrary.keywords.AdditionalKeywords.RunOnFailure; import javafxlibrary.utils.HelperFunctions; import javafxlibrary.utils.RobotLog; +import javafxlibrary.utils.TestFxAdapter; import javafxlibrary.utils.TestListener; import org.apache.commons.io.FileUtils; import org.python.google.common.base.Throwables; import org.robotframework.javalib.annotation.Autowired; import org.robotframework.javalib.library.AnnotationLibrary; -import org.robotframework.remoteserver.RemoteServer; -import org.testfx.util.WaitForAsyncUtils; import javax.script.ScriptEngine; import javax.script.ScriptEngineManager; import javax.script.ScriptException; -import static javafxlibrary.utils.HelperFunctions.*; +import java.io.File; +import java.io.IOException; +import java.net.BindException; +import java.net.InetAddress; +import java.net.UnknownHostException; +import java.util.*; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.concurrent.atomic.AtomicReference; + +import static javafxlibrary.utils.HelperFunctions.getLibraryKeywordTimeout; +import static org.testfx.util.WaitForAsyncUtils.*; public class JavaFXLibrary extends AnnotationLibrary { @@ -50,73 +50,189 @@ public class JavaFXLibrary extends AnnotationLibrary { public static final String ROBOT_LIBRARY_VERSION = loadRobotLibraryVersion(); public static final TestListener ROBOT_LIBRARY_LISTENER = new TestListener(); + static List noLibraryKeywordTimeoutKeywords = new ArrayList() {{ + add("launchJavafxApplication"); + add("launchSwingApplication"); + add("launchSwingApplicationInSeparateThread"); + add("closeJavafxApplication"); + add("closeSwingApplication"); + add("waitForEventsInFxApplicationThread"); + add("waitUntilElementDoesNotExists"); + add("waitUntilElementExists"); + add("waitUntilNodeIsEnabled"); + add("waitUntilNodeIsNotEnabled"); + add("waitUntilNodeIsNotVisible"); + add("waitUntilNodeIsVisible"); + add("waitUntilProgressBarIsFinished"); + }}; + + static List noWrappedAsyncFxKeywords = new ArrayList() {{ + add("callObjectMethodInFxApplicationThread"); + add("captureImage"); + add("capturePrimaryScreen"); + add("captureSceneContainingNode"); + add("clearObjectMap"); + add("closeJavafxApplication"); + add("closeSwingApplication"); + add("dragFrom"); + add("dropTo"); + add("dropToCoordinates"); + add("getCurrentApplication"); + add("getLibraryVersion"); + add("getScreenshot Directory"); + add("getScreenshotDirectory"); + add("getSystemProperty"); + add("isJavaAgent"); + add("launchJavafxApplication"); + add("launchSwingApplication"); + add("launchSwingApplicationInSeparateThread"); + add("logApplicationClasspath"); + add("logSystemProperties"); + add("moveTo"); + add("nodeShouldBeHoverable"); + add("nodeShouldNotBeHoverable"); + add("pushManyTimes"); + add("scrollHorizontally"); + add("scrollVertically"); + add("setImageLogging"); + add("setSafeClicking"); + add("setScreenshotDirectory"); + add("setSystemProperty"); + add("setTimeout"); + add("setToClasspath"); + add("setWriteSpeed"); + add("waitForEventsInFxApplicationThread"); + add("waitUntilElementDoesNotExists"); + add("waitUntilElementExists"); + add("waitUntilNodeIsEnabled"); + add("waitUntilNodeIsNotEnabled"); + add("waitUntilNodeIsNotVisible"); + add("waitUntilNodeIsVisible"); + add("waitUntilProgressBarIsFinished"); + add("writeTo"); + }}; + static List includePatterns = new ArrayList() {{ add("javafxlibrary/keywords/AdditionalKeywords/*.class"); add("javafxlibrary/keywords/Keywords/*.class"); add("javafxlibrary/keywords/*.class"); add("javafxlibrary/tests/*.class"); - }}; + }}; public JavaFXLibrary() { + this(false); + } + + public JavaFXLibrary(boolean headless) { super(includePatterns); - deleteScreenshotsFrom("report-images/imagecomparison"); - } + if (headless) { + System.setProperty("testfx.robot", "glass"); + System.setProperty("testfx.headless", "true"); + System.setProperty("prism.order", "sw"); + System.setProperty("prism.text", "t2k"); + TestFxAdapter.isHeadless = true; + } else { + // v4.0.15-alpha sets default robot as glass, which breaks rolling + // Forcing usage of awt robot as previous versions + System.setProperty("testfx.robot", "awt"); + } + } + + public static String loadRobotLibraryVersion() { + try { + return ResourceBundle.getBundle(JavaFXLibrary.class.getCanonicalName().replace(".", File.separator)) + .getString("version"); + } catch (RuntimeException e) { + return "unknown"; + } + } @Autowired protected RunOnFailure runOnFailure; - // overriding the run method to catch the control in case of failure, so that desired runOnFailureKeyword - // can be executed in controlled manner. @Override - public Object runKeyword(String keywordName, Object[] args) { + public Object runKeyword(String keywordName, List args, Map kwargs) { + if (kwargs == null) { + kwargs = new HashMap(); + } + List finalArgs; + Map finalKwargs; - Object[] finalArgs; // JavalibCore changes arguments of Call Method keywords to Strings after this check, so they need to handle their own objectMapping - if (!(keywordName.equals("callObjectMethod") || keywordName.equals("callObjectMethodInFxApplicationThread"))) + if (!(keywordName.equals("callObjectMethod") || keywordName.equals("callObjectMethodInFxApplicationThread"))) { finalArgs = HelperFunctions.useMappedObjects(args); - else + finalKwargs = HelperFunctions.useMappedObjects(kwargs); + } else { finalArgs = args; + finalKwargs = kwargs; + } + // Run keyword either in async or asyncFx thread with or without timeout + // Execution collects retval and retExcep from keyword AtomicReference