https://github.com/bensofficial/javafx-example

https://github.com/bensofficial/javafx-example

Last synced: 19 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/bensofficial/javafx-example
• Owner: bensofficial
• Created: 2024-11-19T19:35:38.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-07T13:50:11.000Z (about 1 month ago)
• Last Synced: 2024-12-07T14:28:14.626Z (about 1 month ago)
• Language: Java
• Size: 64.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Secure testing of JavaFX applications in the context of Computer Science Education

This repository contains an example of how a JavaFX application can be tested securely using TestFX and Ares.

## Running the application

```

gradle clean run

```

## Running the tests

You can run the tests locally (e.g., on a system with a graphical interface) using: `./gradlew testLocally`

To start the tests in the headless mode, use: `./gradlew test`

If you want to run the tests in headless mode inside a Docker container (to replicate the behavior of the Continuous Integration System), use: `docker run -it --rm -v ./:/app -w /app ls1tum/artemis-maven-template:java17-20 /bin/bash -c "apt-get update && apt-get install -y libpango1.0-0 && ./gradlew clean test"`

## Writing tests

As a testing framework for testing the JavaFX application, we use [TestFX](https://github.com/TestFX/TestFX).

The main features of TestFX are as stated on the website:

TestFX provides a simple-to-use API for setting up the test robot to interact with the application.

Additionally, it provides a set of matchers to verify the app's state right.

This integration provides a readable language to define such GUI tests.

This example of how it might look like is taken from _Best Practices for Efficient Development of JavaFX Applications_ (Kruk et al., 2018):

```java

rightClickOn("#desktop").moveTo("New").clickOn("Text Document");

write("myTextfile.txt").push(ENTER);

drag(".file").dropTo("#trash-can");

verifyThat("#desktop", hasChildren(0, ".file"));

```

You can also capture screenshots using:

```java

captureAndSaveScreenshot("testInput/1");

```

## Securing the tests

We generally use [Ares](https://github.com/ls1intum/Ares) to secure our test execution.

We had to adapt a few things to make Ares compatible with our JavaFX application.

Currently, this repo contains a hard fork of Ares.

We are working on integrating the changes to Ares.