Migrate to JDK 11+ #961

We now require JDK 11+ to keep up to date with Java's development. Since
Java 11+ does not come with JavaFX any more, we bundle JavaFX in our
shadow JAR so users can run it without installing JavaFX separately.

  [1/7] build.gradle: fix checkstyle plugin failure
  [2/7] build.gradle: add platform-specific javafx runtime dependencies
  [3/7] Change the entry point of addressbook
  [4/7] build.gradle: add javafx runtime dependency for all platforms
  [5/7] Workaround headless test failure on Windows OS
  [6/7] Workaround coveralls upload failure on Travis CI
  [7/7] Upgrade to JDK 11

.travis.yml

@@ -1,7 +1,7 @@
 language: java
 matrix:
   include:
-    - jdk: oraclejdk8
+    - jdk: oraclejdk11
 
 script: >-
     ./config/travis/run-checks.sh &&
@@ -14,11 +14,6 @@ deploy:
   on:
     branch: master
 
-addons:
-  apt:
-    packages:
-      - oracle-java8-installer
-
 before_cache:
   - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
   - rm -fr $HOME/.gradle/caches/*/plugin-resolution/

README.adoc

@@ -35,6 +35,6 @@ endif::[]
 
 * Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
 _Marco Jakob_.
-* Libraries used: https://github.com/TestFX/TestFX[TestFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+* Libraries used: https://openjfx.io/[JavaFX], https://github.com/TestFX/TestFX[TestFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
 
 == Licence : link:LICENSE[MIT]

appveyor.yml

@@ -11,7 +11,7 @@ test_script:
     - gradlew.bat --no-daemon headless allTests
 
 environment:
-    JAVA_HOME: C:\Program Files\Java\jdk1.8.0  # Use 64-bit Java
+    JAVA_HOME: C:\Program Files\Java\jdk11  # Use 64-bit Java
 
 # Files/folders to preserve between builds to speed them up
 cache:

build.gradle

@@ -15,10 +15,10 @@ plugins {
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.MainApp'
+mainClassName = 'seedu.address.Main'
 
-sourceCompatibility = JavaVersion.VERSION_1_8
-targetCompatibility = JavaVersion.VERSION_1_8
+sourceCompatibility = JavaVersion.VERSION_11
+targetCompatibility = JavaVersion.VERSION_11
 
 repositories {
     mavenCentral()
@@ -44,6 +44,26 @@ test {
 dependencies {
     String testFxVersion = '4.0.15-alpha'
     String jUnitVersion = '5.4.0'
+    String javaFxVersion = '11'
+
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'linux'
 
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
@@ -52,7 +72,7 @@ dependencies {
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
-    testRuntimeOnly group: 'org.testfx', name: 'openjfx-monocle', version: '8u76-b04'
+    testRuntimeOnly group: 'org.testfx', name: 'openjfx-monocle', version: 'jdk-11+26'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 

config/checkstyle/checkstyle.xml

@@ -26,7 +26,7 @@
   </module>
 
   <module name="SuppressionFilter">
-    <property name="file" value="config/checkstyle/suppressions.xml"/>
+    <property name="file" value="${config_loc}/suppressions.xml"/>
   </module>
 
 

docs/DeveloperGuide.adoc

@@ -20,12 +20,7 @@ By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
 
 === Prerequisites
 
-. *JDK `8`* (revision `1.8.0_201` or later)
-+
-[NOTE]
-Only JDK 8 is supported. +
-This app will not work with later major JDK releases such as JDK 9, 10, 11, etc.
-+
+. *JDK `11`* or above
 . *IntelliJ* IDE
 +
 [NOTE]
@@ -49,7 +44,7 @@ This will generate all resources required by the application and tests.
 
 === Verifying the setup
 
-. Run the `seedu.address.MainApp` and try a few commands
+. Run the `seedu.address.Main` and try a few commands
 . <<Testing,Run the tests>> to ensure they all pass.
 
 === Configurations to do before writing code
@@ -111,7 +106,7 @@ The *_Architecture Diagram_* given above explains the high-level design of the A
 [TIP]
 The `.pptx` files used to create diagrams in this document can be found in the link:{repoURL}/docs/diagrams/[diagrams] folder. To update a diagram, modify the diagram in the pptx file, select the objects of the diagram, and choose `Save as picture`.
 
-`Main` has only one class called link:{repoURL}/src/main/java/seedu/address/MainApp.java[`MainApp`]. It is responsible for,
+`Main` has two classes called link:{repoURL}/src/main/java/seedu/address/Main.java[`Main`] and link:{repoURL}/src/main/java/seedu/address/MainApp.java[`MainApp`]. It is responsible for,
 
 * At app launch: Initializes the components in the correct sequence, and connects them up with each other.
 * At shut down: Shuts down the components and invokes cleanup method where necessary.
@@ -881,7 +876,7 @@ _{More to be added}_
 [appendix]
 == Non Functional Requirements
 
-.  Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `8` (revision `1.8.0_201` or higher) installed.
+.  Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed.
 .  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
 .  A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
 

docs/UserGuide.adoc

@@ -22,12 +22,7 @@ AddressBook Level 4 (AB4) is for those who *prefer to use a desktop app for mana
 
 == Quick Start
 
-.  Ensure you have Java `8` (revision `1.8.0_201` or later) installed in your Computer.
-+
-[NOTE]
-Only Java 8 is supported. +
-This app will not work with later major Java releases such as Java 9, 10, 11, etc.
-+
+.  Ensure you have Java `11` or above installed in your Computer.
 .  Download the latest `addressbook.jar` link:{repoURL}/releases[here].
 .  Copy the file to the folder you want to use as the home folder for your Address Book.
 .  Double-click the file to start the app. The GUI should appear in a few seconds.

gradle.properties

@@ -1,2 +1,6 @@
 org.gradle.parallel=false
 org.gradle.jvmargs=-XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError -Xmx1024m -Dfile.encoding=utf-8
+
+# TODO: This is a workaround for a JDK11 bug which causes test coverage upload to fail.
+# Remove it when https://bugs.openjdk.java.net/browse/JDK-8221253 is fixed.
+systemProp.jdk.tls.client.protocols="TLSv1,TLSv1.1,TLSv1.2"

src/main/java/seedu/address/Main.java

@@ -0,0 +1,25 @@
+package seedu.address;
+
+import javafx.application.Application;
+
+/**
+ * The main entry point to the application.
+ *
+ * This is a workaround for the following error when MainApp is made the
+ * entry point of the application:
+ *
+ *     Error: JavaFX runtime components are missing, and are required to run this application
+ *
+ * The reason is that MainApp extends Application. In that case, the
+ * LauncherHelper will check for the javafx.graphics module to be present
+ * as a named module. We don't use JavaFX via the module system so it can't
+ * find the javafx.graphics module, and so the launch is aborted.
+ *
+ * By having a separate main class (Main) that doesn't extend Application
+ * to be the entry point of the application, we avoid this issue.
+ */
+public class Main {
+    public static void main(String[] args) {
+        Application.launch(MainApp.class, args);
+    }
+}

src/main/java/seedu/address/MainApp.java

@@ -32,7 +32,7 @@
 import seedu.address.ui.UiManager;
 
 /**
- * The main entry point to the application.
+ * Runs the application.
  */
 public class MainApp extends Application {
 
@@ -180,8 +180,4 @@ public void stop() {
             logger.severe("Failed to save preferences " + StringUtil.getDetails(e));
         }
     }
-
-    public static void main(String[] args) {
-        launch(args);
-    }
 }

src/test/java/seedu/address/ui/GuiUnitTest.java

@@ -13,6 +13,15 @@
  * A GUI unit test class for AddressBook.
  */
 public abstract class GuiUnitTest {
+    // TODO: Remove this workaround after using JavaFX version 13 or above
+    // This is a workaround to solve headless test failure on Windows OS
+    // Refer to https://github.com/javafxports/openjdk-jfx/issues/66 for more details.
+    static {
+        if (System.getProperty("os.name").toLowerCase().startsWith("win")) {
+            System.loadLibrary("WindowsCodecs");
+        }
+    }
+
     @RegisterExtension
     public final UiPartExtension uiPartExtension = new UiPartExtension();
 

src/test/java/systemtests/AddressBookSystemTest.java

@@ -46,6 +46,15 @@
  * for test verification.
  */
 public abstract class AddressBookSystemTest {
+    // TODO: Remove this workaround after using JavaFX version 13 or above
+    // This is a workaround to solve headless test failure on Windows OS
+    // Refer to https://github.com/javafxports/openjdk-jfx/issues/66 for more details.
+    static {
+        if (System.getProperty("os.name").toLowerCase().startsWith("win")) {
+            System.loadLibrary("WindowsCodecs");
+        }
+    }
+
     @RegisterExtension
     public static ClockExtension clockExtension = new ClockExtension();