Add automated screenshots

[koppor]

Working on creating automated screenshots to builds/screenshots.

[tobiasdiez]

Is it really necessary to overwrite the Globals.prefs ?

The current code also writes to the active preferences, which means that normal JabRef installations are affected as well.

[koppor]

Overwriting: This basically is

jabref/src/main/java/org/jabref/JabRefMain.java

Line 56 in 43f533b

Globals.prefs = preferences;

. - I tried to start a full JabRef as the screenshots will show a complete JabRef and not some mocked part.

Next step is to mock the preferences. Did not find out to do it in my JabRef timeslot (especially

jabref/src/main/java/org/jabref/preferences/JabRefPreferences.java

Line 438 in 43f533b

prefs = Preferences.userNodeForPackage(PREFS_BASE_CLASS);

caused me headaches. Why is it in the constructor?). (Refs #2768.) I think, whole JabRef has to be rewritten to rely on

jabref/src/main/java/org/jabref/preferences/PreferencesService.java

Line 30 in 43f533b

public interface PreferencesService {

. Maybe, that is too much and I just have to mock JabRefPreferences.

Thus, I went for the quick way to show an end-to-end way to get screenshots. In case I cannot do that "in time", I would suggest to split up the PR: A) work on having a clean way for the preferences B) finish the basis for others to add new screenshots.

[tobiasdiez]

The saveScreenshot​(javafx.stage.Screen screen, ...) method should be more appropriate as you then capture only the JabRef window (instead of the complete screen).

[codecov]

Codecov Report

Merging #6089 into master will decrease coverage by 0.23%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master    #6089      +/-   ##
============================================
- Coverage     41.52%   41.29%   -0.24%     
+ Complexity     6873     6842      -31     
============================================
  Files          1092     1092              
  Lines         46342    46337       -5     
  Branches       5563     5563              
============================================
- Hits          19245    19133     -112     
- Misses        25650    25758     +108     
+ Partials       1447     1446       -1

Impacted Files	Coverage Δ	Complexity Δ
src/main/java/org/jabref/gui/JabRefFrame.java	0.17% <ø> (ø)	1 <0> (ø)	⬇️
src/main/java/org/jabref/JabRefMain.java	0% <ø> (ø)	0 <0> (ø)	⬇️
...ava/org/jabref/gui/util/JabRefResourceLocator.java	0% <0%> (-100%)	0% <0%> (-3%)
...org/jabref/gui/edit/ManageKeywordsDisplayType.java	0% <0%> (-100%)	0% <0%> (-1%)
.../main/java/org/jabref/gui/icon/JabRefIconView.java	0% <0%> (-73.34%)	0% <0%> (-4%)
...a/org/jabref/gui/fieldeditors/EditorTextField.java	0% <0%> (-53.34%)	0% <0%> (-2%)
.../logic/importer/fetcher/IsbnViaEbookDeFetcher.java	58.33% <0%> (-41.67%)	3% <0%> (-2%)
...org/jabref/logic/importer/fetcher/IsbnFetcher.java	52.63% <0%> (-36.85%)	7% <0%> (-1%)
...va/org/jabref/gui/fieldeditors/EditorTextArea.java	0% <0%> (-36.37%)	0% <0%> (-2%)
...ref/gui/util/component/TemporalAccessorPicker.java	0% <0%> (-21.96%)	0% <0%> (-2%)
... and 14 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d5ee20b...3dc2dd9. Read the comment docs.

[tobiasdiez]

The following needs to be done:

• Fix loading of theme
• Fix ServiceLoader @koppor: https://stackoverflow.com/questions/28805688/in-java-how-can-i-mock-a-service-loaded-using-serviceloader might work
• Place buildTest.properties file an a proper folder (is this really needed or can we simply use the one generated by gradle anyway?)
• Mock more dependencies in DefaultTestInjector
• Improve bounds of screenshot (to capture only the window)
• Make screenshots of more dialogs

[koppor]

One more link for the ADR regarding the service loader: https://stackoverflow.com/q/16104786/873282

[koppor]

I think, #6089 (comment) was a show-stopper for me. Thus, no automated screenshots in 2020