se-edu / addressbook-level4 / 4548
94%

DEFAULT BRANCH: master
Ran
Jobs 1
Files 92
Run time 4s
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
4548

push

travis-ci

pyokagan 
Fix stalling HelpWindowTest

When running `gradlew headless allTests`, gradle will sometimes stall on
HelpWindowTest.

While we do not know the exact cause of this stalling, we have narrowed
it down to the following conditions[1] which must all be present for the
stalling to occur:

  1. The test must be running in headless mode.

  2. There must be two stages created, one with a WebView, and one with
     no scene.

  3. Both stages must be shown.

Since it is pretty difficult and time-consuming to debug and find out
the exact cause of this stalling, let's fix this issue by removing one
of its trigger conditions.

(1) obviously cannot be removed, since we want headless testing to work
on our code. For (2), the HelpWindow needs to have a WebView to show the
user guide, and so we can't remove the WebView.

But really, stepping back a bit, we can see that the whole test setup
which leads to (2) and (3) being present in the first place is pretty
strange:

    // (a)
    guiRobot.interact(() -> helpWindow = new HelpWindow());
    // (b)
    Stage helpWindowStage = FxToolkit.setupStage((stage) -> stage.setScene(helpWindow.getRoot().getScene()));
    // (c)
    FxToolkit.showStage();
    helpWindowHandle = new HelpWindowHandle(helpWindowStage);
    [...]
    // (d)
    guiRobot.interact(helpWindow::show);

In (a), we create an instance of HelpWindow, which has its own Stage
which can be retrieved with HelpWindow#getRoot().

However, in (b) we transfer the HelpWindow's scene to the TestFX's
primary stage, leaving the helpWindow with no scene. But: there is no
reason to use the TestFX's registered primary stage when HelpWindow
already has its own Stage.

And in (c), we show the TestFX primary stage, and then later in (d) we
show the helpWindow. However, given that helpWindow does not have a
scene and is thus not showing anything, it would be deceptive to use it
for tests which are meant to verify that the application works
correctly.

As such, let's fix the s... (continued)

1437 of 1560 relevant lines covered (92.12%)

0.92 hits per line

Jobs
ID Job ID Ran Files Coverage
1 4548.1 0
92.12
 Travis Job 4548.1
Source Files on build 4548
Detailed source file information is not available for this build.