Merge pull request #7 from CSC207-2022F-UofT/feat-checkstyle

[+] Add checkstyle

Author: jerryzhu509

.github/checkstyle.xml

@@ -0,0 +1,30 @@
+name: Gradle Checkstyle CI
+
+on: [push]
+
+permissions:
+  checks: write
+  actions: read
+  contents: read
+
+jobs:
+  build:
+    name: Gradle Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Java JDK
+        uses: actions/setup-java@v3
+        with:
+          java-version: '19'
+          distribution: 'adopt'
+
+      - name: Gradle Wrapper Validation
+        uses: gradle/wrapper-validation-action@v1
+
+      - name: Setup Gradle with Dependency Cache
+        uses: gradle/[email protected]
+
+      - name: Gradle Checkstyle
+        run: ./gradlew check

.github/workflows/gradle-check.yml

@@ -9,12 +9,20 @@ import java.util.*
 import kotlin.text.Charsets.UTF_8
 import io.ktor.client.*
 import io.ktor.client.engine.cio.*
+import io.ktor.client.plugins.*
 import io.ktor.client.request.*
 
 
 val GSON = Gson()
 val HTTP = OkHttpClient()
-val KTOR = HttpClient(CIO)
+val KTOR = HttpClient(CIO) {
+    install(HttpTimeout) {
+        requestTimeoutMillis = 5000
+    }
+    install(HttpRequestRetry) {
+        retryOnServerErrors(maxRetries = 5)
+    }
+}
 
 /**
  * fromJson patch for Kotlin

backups/kotlin/CreateTeam.kt

@@ -1,6 +1,7 @@
 plugins {
     id 'java'
     id 'maven-publish'
+    id 'checkstyle'
 }
 
 group 'org.hydev.csc207'
@@ -16,6 +17,15 @@ java {
     }
 }
 
+checkstyle {
+    // assign the latest checkstyle version explicitly, since the default version is very old
+    toolVersion = '10.3.4'
+    configFile = rootProject.file('.github/checkstyle.xml')
+
+    ignoreFailures = false
+    maxWarnings = 5
+}
+
 
 dependencies {
     // Apache HTTP Client

build.gradle

@@ -1,7 +1,6 @@
 package org.hydev.mcpm.client;
 
 import java.io.File;
-import java.util.List;
 import java.util.Map;
 
 /**

src/main/java/org/hydev/mcpm/client/Downloader.java

@@ -2,8 +2,6 @@
 
 import org.hydev.mcpm.client.models.Plugin;
 
-import javax.xml.crypto.Data;
-import java.io.File;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

src/main/java/org/hydev/mcpm/client/database/DatabaseLoader.java

@@ -1,6 +1,5 @@
 package org.hydev.mcpm.client.database;
 
-import org.hydev.mcpm.client.models.Plugin;
 import org.hydev.mcpm.client.models.PluginVersion;
 
 import java.io.File;

src/main/java/org/hydev/mcpm/client/database/LocalPluginTracker.java

@@ -6,7 +6,9 @@
 import org.yaml.snakeyaml.constructor.Constructor;
 import org.yaml.snakeyaml.representer.Representer;
 
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Map;
+import java.util.Objects;
 
 /**
  * POJO model for plugin.yml inside each Minecraft Bukkit/Spigot plugin.
@@ -247,7 +249,8 @@ public boolean equals(Object o)
     @Override
     public int hashCode()
     {
-        return Objects.hash(main, name, version, description, apiVersion, load, author, authors, website, depend, prefix, softdepend, loadbefore, libraries, commands, permissions);
+        return Objects.hash(main, name, version, description, apiVersion, load, author, authors,
+            website, depend, prefix, softdepend, loadbefore, libraries, commands, permissions);
     }
 
     @Override

src/main/java/org/hydev/mcpm/client/models/PluginYml.java

@@ -21,6 +21,7 @@
 import java.util.stream.StreamSupport;
 
 import static java.lang.String.format;
+import static java.nio.file.Files.createSymbolicLink;
 import static org.hydev.mcpm.Constants.JACKSON;
 import static org.hydev.mcpm.utils.GeneralUtils.makeUrl;
 
@@ -33,7 +34,8 @@
 public class SpigetCrawler
 {
     private final String spiget = "https://api.spiget.org/v2";
-    private final String userAgent = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36";
+    private final String userAgent = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) " +
+        "AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36";
     private final long mtDelay = 1000;
     private final File dataDir;
     private final StoredHashMap<Long, String> blacklist;
@@ -56,15 +58,17 @@ private List<JsonNode> crawlResourcesPage(long i)
         {
             // Send request
             var resp = Request.get(makeUrl(spiget + "/resources", "size", 500, "sort", "+id", "page", i,
-                    "fields", "id,name,tag,external,likes,testedVersions,links,contributors,premium,price,currency,version,releaseDate,updateDate,downloads,existenceStatus"))
+                    "fields", "id,name,tag,external,likes,testedVersions,links,contributors,premium," +
+                        "price,currency,version,releaseDate,updateDate,downloads,existenceStatus"))
                 .addHeader("User-Agent", userAgent).execute().returnContent().asString();
 
             // Parse JSON
             ArrayNode page = (ArrayNode) JACKSON.readTree(resp);
 
             // Print debug info
             if (!page.isEmpty())
-                System.out.printf("Page %s done, page len: %s, last id: %s\n", i, page.size(), page.get(page.size() - 1).get("id").asLong());
+                System.out.printf("Page %s done, page len: %s, last id: %s\n",
+                    i, page.size(), page.get(page.size() - 1).get("id").asLong());
             else
                 System.out.printf("Page %s is empty\n", i);
 
@@ -268,7 +272,7 @@ public void links()
 
                     // Create new link
                     linkPath.getParentFile().mkdirs();
-                    Files.createSymbolicLink(linkPath.toPath(), linkPath.getParentFile().toPath().relativize(ver.toPath()));
+                    createSymbolicLink(linkPath.toPath(), linkPath.getParentFile().toPath().relativize(ver.toPath()));
                 }
                 catch (IOException e)
                 {
@@ -280,6 +284,11 @@ public void links()
         });
     }
 
+    /**
+     * Execute server crawler
+     *
+     * @param args Arguments (Unused)
+     */
     public static void main(String[] args)
     {
         var crawler = new SpigetCrawler(new File(".mcpm"));

src/main/java/org/hydev/mcpm/server/crawlers/SpigetCrawler.java

@@ -2,18 +2,15 @@
 
 import org.hydev.mcpm.client.models.PluginYml;
 import org.jetbrains.annotations.NotNull;
-import org.yaml.snakeyaml.Yaml;
-import org.yaml.snakeyaml.constructor.Constructor;
 
 import java.io.File;
 import java.io.IOException;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
-import java.util.Map;
 import java.util.zip.ZipFile;
 
 /**
- * Static utility functions for reading Java archives (jar)
+ * Static utility functions for reading Java archives (jar).
  *
  * @author Azalea (https://github.com/hykilpikonna)
  * @since 2022-10-02
@@ -31,7 +28,7 @@ public PluginJarFile(@NotNull File file, int mode, @NotNull Charset charset) thr
     }
 
     /**
-     * Read the content of a file inside a jar/zip file
+     * Read the content of a file inside a jar/zip file.
      *
      * @param innerPath Local path inside the jar/zip file (e.g. "./plugins.yml")
      * @return File content as byte array
@@ -43,7 +40,7 @@ public byte[] readBytes(String innerPath) throws IOException
     }
 
     /**
-     * Read the content of a file inside a jar/zip file
+     * Read the content of a file inside a jar/zip file.
      *
      * @param innerPath Local path inside the jar/zip file (e.g. "./plugins.yml")
      * @return File content as string using UTF-8 encoding