Merge pull request #215 from Bram-Hub/add_checkstyle

Add checkstyle and GitHub action

.github/workflows/gradle.yml

@@ -5,9 +5,7 @@ name: Java CI with Gradle
 
 on:
   push:
-    branches: [ master ]
   pull_request:
-    branches: [ master ]
 
 jobs:
   build:
@@ -24,3 +22,17 @@ jobs:
       run: chmod +x gradlew
     - name: Build with Gradle
       run: ./gradlew build -x test
+
+  checkstyle:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: gradlew executable
+        run: chmod +x gradlew
+      - name: Run checkstyle
+        run: ./gradlew check

build.gradle

@@ -2,6 +2,7 @@ version '2.0.0'
 
 apply plugin: 'java'
 apply plugin: 'application'
+apply plugin: 'checkstyle'
 mainClassName = 'edu.rpi.legup.Legup'
 
 sourceCompatibility = 1.8

config/checkstyle/checkstyle.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!DOCTYPE module PUBLIC
+        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+        "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<module name="Checker">
+    <module name="TreeWalker">
+        <property name="tabWidth" value="4"/>
+        <module name="LeftCurly"/>
+        <module name="RightCurly">
+            <property name="option" value="alone"/>
+            <property name="tokens" value="LITERAL_IF, LITERAL_ELSE, LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, METHOD_DEF"/>
+        </module>
+        <module name="NeedBraces">
+            <property name="allowSingleLineStatement" value="true"/>
+        </module>
+        <module name="EmptyCatchBlock"/>
+    </module>
+</module>

legup-update/src/main/java/edu/rpi/legupupdate/Update.java

@@ -46,7 +46,8 @@ public class Update {
         try {
             version = reader.readLine();
             reader.close();
-        } catch (IOException e) {
+        }
+        catch (IOException e) {
             logger.severe("An error occurred while attempting to read the version\n" + e.getMessage());
         }
         VERSION = version;
@@ -75,31 +76,37 @@ public boolean checkUpdate() {
                  InputStreamReader reader = new InputStreamReader(in)) {
                 releaseData = new JsonParser().parse(reader).getAsJsonObject();
                 JsonElement tagElement = releaseData.get("tag_name");
-                if (tagElement == null)
+                if (tagElement == null) {
                     return false;
+                }
                 updateVersion = tagElement.getAsString();
                 logger.info("Current version: " + VERSION);
                 logger.info("Latest version:  " + updateVersion);
                 if (NetUtil.versionCompare(VERSION, updateVersion) < 0) {
                     logger.info("Update available");
                     return true;
-                } else
+                }
+                else {
                     logger.info("No update available");
+                }
             }
-        } catch (IOException e) {
+        }
+        catch (IOException e) {
             logger.severe("Failed to check for update\n" + e.getMessage());
         }
         return false;
     }
 
     private String getAssetUrl(String assetName) {
         JsonArray array = releaseData.get("assets").getAsJsonArray();
-        if (array == null)
+        if (array == null) {
             return null;
+        }
         for (int i = 0; i < array.size(); ++i) {
             JsonObject asset = array.get(i).getAsJsonObject();
-            if (asset.get("name").getAsString().equals(assetName))
+            if (asset.get("name").getAsString().equals(assetName)) {
                 return asset.get("browser_download_url").getAsString();
+            }
         }
         return null;
     }
@@ -111,15 +118,18 @@ private void getLibs(String urlStr, HashMap<String, String> set) throws IOExcept
              BufferedReader reader = new BufferedReader(isr)) {
             String line;
             while ((line = reader.readLine()) != null) {
-                if (!line.contains(LIBRARY_LINE_ID))
+                if (!line.contains(LIBRARY_LINE_ID)) {
                     continue;
+                }
                 Matcher m = LIB_PATTERN.matcher(line);
-                if (!m.find())
+                if (!m.find()) {
                     continue;
+                }
                 line = m.group();
                 String[] split = line.split(":");
-                if (split.length != 3)
+                if (split.length != 3) {
                     throw new IOException("Invalid library list in remote repository");
+                }
                 String groupId = split[0].replaceAll("\\.", "/");
                 String artifactId = split[1];
                 String version = split[2];
@@ -146,8 +156,9 @@ private void downloadFile(String urlStr, File destination) throws IOException {
     }
 
     public boolean update() {
-        if (releaseData == null)
+        if (releaseData == null) {
             return false;
+        }
         if (guessDevEnvironment()) {
             logger.warning("Legup appears to be running in a development environment so automatic updating has been disabled");
 //            return false;
@@ -159,8 +170,9 @@ public boolean update() {
             progress.setDescription("Starting update");
         }
         String jarUrl = getAssetUrl(updateStream.assetName);
-        if (jarUrl == null)
+        if (jarUrl == null) {
             return false;
+        }
         try {
             HashMap<String, String> libs = getLibs();
             if (!downloadDir.exists() && !downloadDir.mkdirs()) {
@@ -184,13 +196,14 @@ public boolean update() {
                 downloadFile(lib.getValue(), new File(libDir, lib.getKey()));
                 current++;
             }
-            if(progress != null) {
+            if (progress != null) {
                 progress.setCurrentDownload(current);
                 progress.setDescription("Download complete!");
             }
             logger.info("Download complete");
             return true;
-        } catch (IOException e) {
+        }
+        catch (IOException e) {
             logger.severe("Failed to update Legup\n" + e.getMessage());
             return false;
         }
@@ -203,11 +216,14 @@ private void unzipFile(File file) throws IOException {
                 ZipEntry entry = entries.nextElement();
                 File entryDestination = new File(downloadDir, entry.getName());
                 if (entry.isDirectory()) {
-                    if (!entryDestination.exists() && !entryDestination.mkdirs())
+                    if (!entryDestination.exists() && !entryDestination.mkdirs()) {
                         throw new IOException("Failed to unzip file: " + file.getCanonicalPath());
-                } else {
-                    if (!entryDestination.getParentFile().exists() && !entryDestination.getParentFile().mkdirs())
+                    }
+                }
+                else {
+                    if (!entryDestination.getParentFile().exists() && !entryDestination.getParentFile().mkdirs()) {
                         throw new IOException("Failed to unzip file: " + file.getCanonicalPath());
+                    }
                     try (InputStream in = zipFile.getInputStream(entry);
                          OutputStream out = new FileOutputStream(entryDestination)) {
                         IOUtils.copy(in, out);

src/main/java/edu/rpi/legup/.metadata/.plugins/org.eclipse.jdt.ui/dialog_settings.xml

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <section name="Workbench">
-	<section name="org.eclipse.jdt.internal.ui.packageview.PackageExplorerPart">
-		<item value="2" key="layout"/>
-		<item value="true" key="group_libraries"/>
-		<item value="&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#x0A;&lt;packageExplorer group_libraries=&quot;1&quot; layout=&quot;2&quot; linkWithEditor=&quot;0&quot; rootMode=&quot;1&quot; workingSetName=&quot;Aggregate for window 1571854382528&quot;&gt;&#x0A;&lt;customFilters userDefinedPatternsEnabled=&quot;false&quot;&gt;&#x0A;&lt;xmlDefinedFilters&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.StaticsFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.mylyn.java.ui.MembersFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.NonJavaProjectsFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer_patternFilterId_.*&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.NonSharedProjectsFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.SyntheticMembersFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.ContainedLibraryFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.internal.ui.PackageExplorer.HideInnerClassFilesFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.internal.ui.PackageExplorer.EmptyInnerPackageFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.m2e.MavenModuleFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.ClosedProjectsFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.EmptyLibraryContainerFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.PackageDeclarationFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.ImportDeclarationFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.NonJavaElementFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.LibraryFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.CuAndClassFileFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.internal.ui.PackageExplorer.EmptyPackageFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.NonPublicFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.LocalTypesFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.FieldsFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;/xmlDefinedFilters&gt;&#x0A;&lt;/customFilters&gt;&#x0A;&lt;/packageExplorer&gt;" key="memento"/>
-		<item value="1" key="rootMode"/>
-		<item value="false" key="linkWithEditor"/>
-	</section>
+    <section name="org.eclipse.jdt.internal.ui.packageview.PackageExplorerPart">
+        <item value="2" key="layout"/>
+        <item value="true" key="group_libraries"/>
+        <item value="&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#x0A;&lt;packageExplorer group_libraries=&quot;1&quot; layout=&quot;2&quot; linkWithEditor=&quot;0&quot; rootMode=&quot;1&quot; workingSetName=&quot;Aggregate for window 1571854382528&quot;&gt;&#x0A;&lt;customFilters userDefinedPatternsEnabled=&quot;false&quot;&gt;&#x0A;&lt;xmlDefinedFilters&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.StaticsFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.mylyn.java.ui.MembersFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.NonJavaProjectsFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer_patternFilterId_.*&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.NonSharedProjectsFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.SyntheticMembersFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.ContainedLibraryFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.internal.ui.PackageExplorer.HideInnerClassFilesFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.internal.ui.PackageExplorer.EmptyInnerPackageFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.m2e.MavenModuleFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.ClosedProjectsFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.EmptyLibraryContainerFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.PackageDeclarationFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.ImportDeclarationFilter&quot; isEnabled=&quot;true&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.NonJavaElementFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.LibraryFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.CuAndClassFileFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.internal.ui.PackageExplorer.EmptyPackageFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.NonPublicFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.LocalTypesFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;child filterId=&quot;org.eclipse.jdt.ui.PackageExplorer.FieldsFilter&quot; isEnabled=&quot;false&quot;/&gt;&#x0A;&lt;/xmlDefinedFilters&gt;&#x0A;&lt;/customFilters&gt;&#x0A;&lt;/packageExplorer&gt;"
+              key="memento"/>
+        <item value="1" key="rootMode"/>
+        <item value="false" key="linkWithEditor"/>
+    </section>
 </section>

src/main/java/edu/rpi/legup/.metadata/.plugins/org.eclipse.m2e.logback.configuration/logback.1.6.0.20150526-2032.xml

@@ -1,43 +1,43 @@
 <configuration scan="true">
-  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
-    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
-      <pattern>%date [%thread] %-5level %logger{35} - %msg%n</pattern>
-    </encoder>
-    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
-      <level>OFF</level> <!-- change to DEBUG to mimic '-consolelog' behaviour -->
-    </filter>
-  </appender>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
+            <pattern>%date [%thread] %-5level %logger{35} - %msg%n</pattern>
+        </encoder>
+        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
+            <level>OFF</level> <!-- change to DEBUG to mimic '-consolelog' behaviour -->
+        </filter>
+    </appender>
 
-  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
-    <File>${org.eclipse.m2e.log.dir}/0.log</File>
-    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
-      <FileNamePattern>${org.eclipse.m2e.log.dir}/%i.log</FileNamePattern>
-      <MinIndex>1</MinIndex>
-      <MaxIndex>10</MaxIndex>
-    </rollingPolicy>
-    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
-      <MaxFileSize>100MB</MaxFileSize>
-    </triggeringPolicy>
-    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
-      <pattern>%date [%thread] %-5level %logger{35} - %msg%n</pattern>
-    </encoder>
-  </appender>
+    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <File>${org.eclipse.m2e.log.dir}/0.log</File>
+        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
+            <FileNamePattern>${org.eclipse.m2e.log.dir}/%i.log</FileNamePattern>
+            <MinIndex>1</MinIndex>
+            <MaxIndex>10</MaxIndex>
+        </rollingPolicy>
+        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
+            <MaxFileSize>100MB</MaxFileSize>
+        </triggeringPolicy>
+        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
+            <pattern>%date [%thread] %-5level %logger{35} - %msg%n</pattern>
+        </encoder>
+    </appender>
 
-  <appender name="EclipseLog" class="org.eclipse.m2e.logback.appender.EclipseLogAppender">
-    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
-      <level>WARN</level>
-    </filter>
-  </appender>
+    <appender name="EclipseLog" class="org.eclipse.m2e.logback.appender.EclipseLogAppender">
+        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
+            <level>WARN</level>
+        </filter>
+    </appender>
 
-  <appender name="MavenConsoleLog" class="org.eclipse.m2e.logback.appender.MavenConsoleAppender">
-  </appender>
-
-  <root level="INFO">
-    <appender-ref ref="FILE" />
-    <appender-ref ref="STDOUT" />
-    <appender-ref ref="EclipseLog" />
-    <appender-ref ref="MavenConsoleLog" />
-  </root>
+    <appender name="MavenConsoleLog" class="org.eclipse.m2e.logback.appender.MavenConsoleAppender">
+    </appender>
 
-  <logger name="com.ning.http.client" level="INFO" />
+    <root level="INFO">
+        <appender-ref ref="FILE"/>
+        <appender-ref ref="STDOUT"/>
+        <appender-ref ref="EclipseLog"/>
+        <appender-ref ref="MavenConsoleLog"/>
+    </root>
+
+    <logger name="com.ning.http.client" level="INFO"/>
 </configuration>

src/main/java/edu/rpi/legup/.metadata/.plugins/org.eclipse.ui.ide/dialog_settings.xml

@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <section name="Workbench">
-	<section name="WORKBENCH_SETTINGS">
-		<list key="ENABLED_TRANSFERS">
-		</list>
-	</section>
-	<section name="ChooseWorkspaceDialogSettings">
-		<item value="216" key="DIALOG_X_ORIGIN"/>
-		<item value="222" key="DIALOG_Y_ORIGIN"/>
-	</section>
+    <section name="WORKBENCH_SETTINGS">
+        <list key="ENABLED_TRANSFERS">
+        </list>
+    </section>
+    <section name="ChooseWorkspaceDialogSettings">
+        <item value="216" key="DIALOG_X_ORIGIN"/>
+        <item value="222" key="DIALOG_Y_ORIGIN"/>
+    </section>
 </section>

src/main/java/edu/rpi/legup/.metadata/.plugins/org.eclipse.ui.workbench/dialog_settings.xml

@@ -1,15 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <section name="Workbench">
-	<section name="org.eclipse.ui.internal.QuickAccess">
-		<item value="-1" key="dialogHeight"/>
-		<item value="-1" key="dialogWidth"/>
-		<list key="textEntries">
-		</list>
-		<list key="orderedElements">
-		</list>
-		<list key="orderedProviders">
-		</list>
-		<list key="textArray">
-		</list>
-	</section>
+    <section name="org.eclipse.ui.internal.QuickAccess">
+        <item value="-1" key="dialogHeight"/>
+        <item value="-1" key="dialogWidth"/>
+        <list key="textEntries">
+        </list>
+        <list key="orderedElements">
+        </list>
+        <list key="orderedProviders">
+        </list>
+        <list key="textArray">
+        </list>
+    </section>
 </section>

src/main/java/edu/rpi/legup/.metadata/.plugins/org.eclipse.ui.workbench/workingsets.xml

@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <workingSetManager>
-<workingSet aggregate="true" factoryID="org.eclipse.ui.internal.WorkingSetFactory" id="1571854382529_0" label="Window Working Set" name="Aggregate for window 1571854382528"/>
+    <workingSet aggregate="true" factoryID="org.eclipse.ui.internal.WorkingSetFactory" id="1571854382529_0"
+                label="Window Working Set" name="Aggregate for window 1571854382528"/>
 </workingSetManager>