This page and its subpages are outdated partially.
For a more up-to-date documentation regarding UI tests for Magnolia 6.1 and higher, please also check the documentation on bitbucket.
You need the docker-engine installed on your local machine. (For macOS have a look here)
All UI-Tests are located in the bundles under either
We use Selenium for testing our ui and HtmlUnit for our integration tests. The UI-Tests will are part of
magnolia-integration-test/tests and use its
test-public-webapp. UI-Tests are only triggered if you specify the corresponding maven profile
In short, use the following command to automatically run all UI-Tests
..../magnolia-integration-tests/tests mvn clean install -P ui-tests
..../magnolia-integration-tests/tests mvn clean install -P ui-tests -DfailIfNoTests=false -Dit.test=MyTestClass
..../magnolia-integration-tests/tests mvn clean install -P ui-tests -DfailIfNoTests=false -Dit.test=MyTestClass#myTest
If you want to run the ui tests manually to debug the ui-test code you could basically just run the test in our IDE. The drawback with this simple approach is that the whole environment with the web & selenium containers including magnolia installation is done with every start.
So to have a smaller footprint we first have to start just the web container with magnolia and the selenium host with the following script
$ mvn clean install $ ./localtest.sh
(It's important to run install before because
localtest.sh will take the produced webapp wars and create a docker image out of it)
Then you have to launch the test with
-Dsetup.test.env=false so the test environment is not started and stopped with every test launch (thats what you have already done with
To observe the browser with the test execution launch a VNC client and connect to
localhost:5901 with password "
secret". (Under macOS that easily done with the app Screen Sharing)
|Giving Docker more resources than the default seems to help making the local testing environment more stable and faster. E.g.|
If Docker performance on MacOS is questionable in your case then you would want this setup method, which is:
+ Start test webapps locally
+ Run Selenium server locally
+ Run UI tests from your IDE and monitoring test execution with local Chrome browser
macos:selenium user$ ls -l total 69216 -rwxr-xr-x 1 user staff 12012868 Mar 1 2018 chromedriver -rw-r--r--@ 1 user staff 23422300 Mar 16 2018 selenium-server-standalone-3.11.0.jar macos:selenium user$ java -jar selenium-server-standalone-3.11.0.jar
-ea -Dsetup.test.env=false -Dselenium.hub.name=localhost -Dselenium.hub.host=localhost -DcontainerHttpPort=8080 -DprivateHostName=localhost -Dserver.public.port=8080
Here is Junit test template that applied to all new test profile.
Test will be executed in a new Chrome browser window.
Another alternative method to run UI Tests without relying too much on Docker. This method has some advantages compared to the previous No docker setup:
+ Don't have to manually setup selenium every times
+ UI clients moved to docker so we can avoid test browser to be opened randomly on active monitors.
Step 1: Prepare Docker containers
docker network create uitest docker run -d --network uitest -p 4444:4444 --name hub selenium/hub docker run -d --network uitest -e HUB_PORT_4444_TCP_ADDR=hub -e HUB_PORT_4444_TCP_PORT=4444 -p 5901:5900 --name client1 selenium/node-chrome-debug docker run -d --network uitest -e HUB_PORT_4444_TCP_ADDR=hub -e HUB_PORT_4444_TCP_PORT=4444 -p 5902:5900 --name client2 selenium/node-chrome-debug
+ Create two docker virtual UI clients (client1, client2) which connect to one docker selenium hub (in the same shared network called "uitest". The reason for two virtual clients is that with only one client, there would be higher chances of unclear slow down and un-responsive. With two clients, selenium hub will automatically switch back/forth and tests run smoother.
Step 2: Apply patch to by-pass docker environment setup in ce
Step 3: Manually start Magnolia webapps as described in above No Docker Setup
Step 4: Run ui-tests with additional VM options
-ea -Dsetup.test.env=false -Dselenium.hub.name=localhost -Dselenium.hub.host=localhost -DcontainerHttpPort=8080 -DprivateContainerHttpPort=8080 -DprivateHostName=<one-of-host-real-ip>
Our ui tests are placed in the ce-bundle/magnolia-integration-tests/tests because all the required setup (install and start an author and public instance) is already there.
Some of those tests are very sensitive - when running them on your local machine, make sure to not do anything else while they're running. e.g. don't switch to any application or type anything. This can be enough to make some of the UI tests fail.
You need docker installed as well as both the tomcat container as well as the browser for the ui-tests are started as docker containers. (For macOS have a look here)
We use Selenium for testing our ui. The UITest will be part of magnolia-integration-test/tests and use its test-webapp & test-public-webapp. UITests are only triggered if you specify the corresponding profile (ui-tests).
In short, use the following command to automatically run the ui tests
..../magnolia-integration-tests/tests mvn clean install -P ui-tests -DseleniumBrowser=chrome
..../magnolia-integration-tests/tests mvn clean install -P ui-tests -DseleniumBrowser=chrome -DfailIfNoTests=false -Dit.test=MyTestClass
(Note that this will also trigger the crawling after the test, it would be nice to figure out a command that runs one class, but does not trigger the crawling.)
..../magnolia-integration-tests/tests mvn clean install -P ui-tests -DseleniumBrowser=chrome -DfailIfNoTests=false -Dit.test=MyTestClass#myTest
If you want to run the ui tests manually from within your IDE you can start the author and public tests instance with
..../magnolia-integration-tests/tests mvn clean install -P manual-tests
Once this is running, then you can simply run or debug with JUnit in your IDE as you would a normal unit test.
Our UI tests are implemented with selenium. Despite the fact that this tool is really mature, those tests aren't as reproducible as ordinary unit-tests. Here's a list of hints that should help to write stable magnolia ui tests:
|Element cannot be found although it's there||querying for an element (|
|Element is found although it should be gone||unlike in the case where we check for existence of an element we don't have any implicit or explicit delay here - if the element needs some time to go away (e.g. Overlay fadeout) we have to add an explicit delay. use |
|Input field value cannot be queried with xpath||dont use xpath||input[@class = 'classname' and @value = 'form input...'] could be changed to input[@class = 'classname] and use a condition like |
|Form validation fails, even if fields are properly entered||ensure blur / change||after filling an input with sendKeys, one should explicitly blur the field - i.e. click anywhere else - and allow some time for the change event to occur. Only then, pressing 'save changes' will be properly aware of the modifications.|
|Getting another element instead of the expected one||scope XPath queries||making dead simple queries like //input[@class='v-textfield'] should be carefully considered, there may be more elements of same kind (inputs, buttons) currently loaded in the UI. Try to scope selectors at least to subApp level.|
|Querying for descendent elements||use .// XPath prefix||invoking |
If you find it hard to create XPath queries,
you might find the following helpful:
Our framework is rigged to generate a screenshot and save it during the test - this can help debug what went wrong with the test. These images are stored in tests/target/surefire-reports/
Even on hudson you can access these screenshots: