Fix database tests and enable running using GitHub workflows

.github/workflows/check-outdated-dependencies.yml

@@ -0,0 +1,29 @@
+name: Check dependencies
+
+on: 
+  schedule:
+    - cron:  '0 0 * * 0' # Run every Sunday
+
+jobs:
+  checkDependencies:
+    name: Check dependencies
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v1
+      with:
+        depth: 1
+        submodules: false
+    - name: Set up JDK
+      uses: actions/setup-java@v1
+      with:
+        java-version: 13
+    - name: Look for outdated dependencies
+      run: ./gradlew -q checkOutdatedDependencies
+    - name: Report issues
+      if: failure()
+      uses: JasonEtco/create-an-issue@master
+      env: 
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        filename: .github/outdatedDependencies.md

.github/workflows/checkstyle.yml

@@ -0,0 +1,33 @@
+name: Checkstyle
+
+on: [push]
+
+jobs:
+  test:
+    name: Checkstyle
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v1
+      with:
+        depth: 1
+        submodules: false
+    - name: Set up JDK
+      uses: actions/setup-java@v1
+      with:
+        java-version: 13
+    - uses: actions/cache@v1
+      with:
+        path: ~/.gradle/caches
+        key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
+        restore-keys: |
+          ${{ runner.OS }}-gradle-${{ env.cache-name }}-
+          ${{ runner.OS }}-gradle-
+          ${{ runner.OS }}-
+    - uses: actions/cache@v1
+      name: Cache gradle wrapper
+      with:
+        path: ~/.gradle/wrapper
+        key: ${{ runner.os }}-gradle-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }}
+    - name: Run checkstyle test
+      run: ./gradlew checkstyleMain checkstyleTest checkstyleJmh

.github/workflows/deployment.yml

@@ -54,6 +54,11 @@ jobs:
           ${{ runner.OS }}-gradle-${{ env.cache-name }}-
           ${{ runner.OS }}-gradle-
           ${{ runner.OS }}-
+    - uses: actions/cache@v1
+      name: Cache gradle wrapper
+      with:
+        path: ~/.gradle/wrapper
+        key: ${{ runner.os }}-gradle-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }}
     - name: Download jpackage
       # We need to download jpackage from https://jdk.java.net/jpackage/
       run: |

.github/workflows/tests.yml

@@ -0,0 +1,84 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:10.8
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: postgres
+        ports:
+          - 5432:5432
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+      - name: Set up JDK
+        uses: actions/setup-java@v1
+        with:
+          java-version: 13
+      - name: Checkout source
+        uses: actions/checkout@v1
+        with:
+          depth: 1
+          submodules: false
+      - uses: actions/cache@v1
+        with:
+          path: ~/.gradle/caches
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
+          restore-keys: |
+            ${{ runner.OS }}-gradle-${{ env.cache-name }}-
+            ${{ runner.OS }}-gradle-
+            ${{ runner.OS }}-
+      - uses: actions/cache@v1
+        name: Cache gradle wrapper
+        with:
+          path: ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }}
+      - name: Run basic tests (without checkstyle)
+        run: xvfb-run --auto-servernum ./gradlew check -x checkstyleJmh -x checkstyleMain -x checkstyleTest
+      - name: Run tests on PostgreSQL
+        run: ./gradlew databaseTest
+        env:
+          DBMS: "postgresql"
+      - name: Update test coverage metrics
+        run: xvfb-run --auto-servernum ./gradlew jacocoTestReport && bash <(curl -s https://codecov.io/bash);
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+          DBMS: "postgresql"
+      - name: Update test coverage metrics (in case of failure)
+        run: xvfb-run --auto-servernum ./gradlew jacocoTestReport && bash <(curl -s https://codecov.io/bash);
+        if: failure()
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+          DBMS: "postgresql"
+      - name: Shutdown Ubuntu MySQL
+        run: sudo service mysql stop # Shutdown the Default MySQL, "sudo" is necessary, please not remove it
+      - name: Start custom MySQL
+        uses: mirromutth/mysql-action@v1.1
+        with:
+          host port: 3800
+          container port: 3307
+          character set server: 'utf8'
+          collation server: 'utf8_general_ci'
+          mysql version: '8.0'
+          mysql database: 'jabref'
+          mysql root password: 'root'
+      - name: Run tests on MySQL
+        run: ./gradlew databaseTest
+        env:
+          DBMS: "mysql"
+      - name: Run fetcher tests
+        run: ./gradlew fetcherTest
+      - name: Run GUI tests
+        run: xvfb-run --auto-servernum ./gradlew guiTest
+      - name: Format failed test results
+        if: failure()
+        run: |
+          sudo apt-get install -qq -y xml-twig-tools xsltproc
+          scripts/after-failure.sh

build.gradle

@@ -24,6 +24,9 @@ plugins {
     id 'org.javamodularity.moduleplugin' version '1.5.0'
     id 'org.openjfx.javafxplugin' version '0.0.8'
     id 'org.beryx.jlink' version '2.16.4'
+
+    // nicer test outputs during running and completion
+    id 'com.adarshr.test-logger' version '2.0.0'
 }
 
 gradle.startParameter.showStacktrace = org.gradle.api.logging.configuration.ShowStacktrace.ALWAYS
@@ -438,7 +441,6 @@ javadoc {
 
 localization.script = 'scripts/syncLang.py'
 
-// Test tasks
 test {
     useJUnitPlatform {
         excludeTags 'DatabaseTest', 'FetcherTest', 'GUITest'
@@ -452,6 +454,10 @@ test {
     }
 }
 
+testlogger {
+    showPassed false
+}
+
 task databaseTest(type: Test) {
     useJUnitPlatform {
         includeTags 'DatabaseTest'
@@ -524,8 +530,9 @@ jacocoTestReport {
     dependsOn jacocoMerge
 
     reports {
-        xml.enabled = true // coveralls plugin depends on xml format report
+        csv.enabled = true
         html.enabled = true
+        xml.enabled = true // coveralls plugin depends on xml format report
     }
 }
 

docs/testing.md

@@ -0,0 +1,25 @@
+# How to test
+
+## Database tests
+
+### PostgreSQL
+
+To quickly host a local PostgreSQL database, execute following statement:
+
+```shell command
+docker run -d -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=postgres -p 5432:5432 --name db postgres:10 postgres -c log_statement=all
+```
+
+Set the environment variable `DBMS` to `postgres` (or leave it unset)
+
+Then, all DBMS Tests (annotated with `@org.jabref.testutils.category.DatabaseTest`) run properly.
+
+### MySQL
+
+A MySQL DBMS can be started using following command:
+
+``´shell command
+docker run -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=jabref -p 3800:3307 mysql:8.0 --port=3307
+```
+
+Set the environment variable `DBMS` to `mysql`.

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

scripts/after-failure.sh

@@ -1,12 +1,8 @@
 #!/bin/bash
-# taken from https://github.com/lhotari/travis-gradle-test-failures-to-console/blob/master/travis/junit-errors-to-stdout.sh
+# based on https://github.com/lhotari/travis-gradle-test-failures-to-console/blob/master/travis/junit-errors-to-stdout.sh
 IFS='
 '
 DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
-if [ "$TRAVIS" = "true" ]; then
-	#echo 'Installing xml-twig-tools and xsltproc....'
-	sudo apt-get install -qq -y --force-yes xml-twig-tools xsltproc > /dev/null
-fi
 ROOTDIR="$1"
 if [ -z "$ROOTDIR" ]; then
 	ROOTDIR="."