Unit Testing

.github/test.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Setup API Server
+git clone https://github.com/CodeMC/API build/tmp/CodeMC-API
+chmod +x ./build/tmp/CodeMC-API/.github/test.sh
+
+# Run API Server
+cd build/tmp/CodeMC-API
+./.github/test.sh
+cd ../../../

.github/workflows/build.yml

@@ -3,7 +3,7 @@ name: Build Project
 on: [push, pull_request, workflow_dispatch]
 
 jobs:
-  build:
+  setup:
     runs-on: ubuntu-latest
     timeout-minutes: 30
 
@@ -21,5 +21,104 @@ jobs:
         run: chmod +x ./gradlew
       - name: Gradle Information
         run: ./gradlew tasks project dependencies
+
+  build:
+    needs: setup
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    name: Gradle Build
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          cache: 'gradle'
+      - name: Change Permissions
+        run: chmod +x ./gradlew
       - name: Gradle Build
-        run: ./gradlew build
+        run: ./gradlew build -x test
+
+  test:
+    needs: setup
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    name: Gradle Test
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          cache: 'gradle'
+      - name: Change Permissions
+        run: chmod +x ./gradlew
+      - name: Setup Servers
+        run: bash .github/test.sh
+      - name: Gradle Test
+        run: ./gradlew test
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Stop Servers
+        if: success() || failure()
+        run: |
+          rm -rf /tmp/admin.password
+
+          docker stop jenkins-rest
+          docker rm jenkins-rest
+
+          docker stop nexus-rest
+          docker rm nexus-rest
+
+          docker stop mariadb
+          docker rm mariadb
+
+          docker network rm codemc
+      - name: Archive Test Reports
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-report
+          path: build/reports/tests/test/
+      - name: Collect JaCoCo Report
+        if: ${{ github.event_name != 'pull_request' }}
+        id: jacoco_reporter
+        uses: PavanMudigonda/[email protected]
+        with:
+          coverage_results_path: build/jacoco.xml
+          coverage_report_name: Code Coverage
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          skip_check_run: false
+          minimum_coverage: 80
+          fail_below_threshold: false
+          publish_only_summary: false
+
+      - name: Print JaCoCo Report
+        if: ${{ github.event_name != 'pull_request' }}
+        run: |
+          echo "| Outcome | Value |" >> $GITHUB_STEP_SUMMARY
+          echo "| --- | --- |" >> $GITHUB_STEP_SUMMARY
+          echo "| Code Coverage % | ${{ steps.jacoco_reporter.outputs.coverage_percentage }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| :heavy_check_mark: Number of Lines Covered | ${{ steps.jacoco_reporter.outputs.covered_lines }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| :x: Number of Lines Missed | ${{ steps.jacoco_reporter.outputs.missed_lines }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| Total Number of Lines | ${{ steps.jacoco_reporter.outputs.total_lines }} |" >> $GITHUB_STEP_SUMMARY
+
+      - name: Upload Code Coverage Artifacts (Push)
+        if: ${{ github.event_name != 'pull_request' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: "*/coverage-results.md"
+
+      - name: Upload Code Coverage Artifacts (Pull Request)
+        if: ${{ github.event_name == 'pull_request' }}
+        uses: madrapps/[email protected]
+        with:
+          paths: build/jacoco.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+          pass-emoji: ✅
+          min-coverage-overall: 80
+          min-coverage-changed-files: 85

.gitignore

@@ -158,4 +158,4 @@ build/
 .vscode/
 
 # Copied configuration
-config.json
+/config.json

build.gradle

@@ -20,6 +20,7 @@ plugins {
     id "java"
     id "application"
     id "com.github.johnrengelman.shadow" version "8.1.1"
+    id "jacoco"
 }
 
 group 'io.codemc'
@@ -34,6 +35,7 @@ repositories {
     maven { url = 'https://repo.codemc.io/repository/codemc' }
     maven { url = 'https://repo.codemc.io/repository/codemc' }
     maven { url = 'https://m2.chew.pro/releases' }
+    maven { url = 'https://m2.coly.dev/releases' }
 }
 
 dependencies {
@@ -45,12 +47,47 @@ dependencies {
     implementation group: 'pw.chew', name: 'jda-chewtils-command', version: '2.0'
     implementation group: 'org.spongepowered', name: 'configurate-gson', version: '4.1.2'
 
-    implementation group: 'io.codemc.api', name: 'codemc-api', version: '1.1.1'
+    implementation group: 'io.codemc.api', name: 'codemc-api', version: '1.2.0'
     implementation group: 'org.jetbrains.kotlinx', name: 'kotlinx-coroutines-core', version: '1.9.0'
     implementation group: 'org.jetbrains.kotlinx', name: 'kotlinx-serialization-json', version: '1.7.3'
     implementation group: 'org.mariadb.jdbc', name: 'mariadb-java-client', version: '3.5.1'
     implementation group: 'org.jetbrains.exposed', name: 'exposed-core', version: '0.56.0'
     implementation group: 'org.jetbrains.exposed', name: 'exposed-jdbc', version: '0.56.0'
+
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.11.3'
+    testImplementation group: 'dev.coly', name: 'JDATesting', version: '0.7.0'
+    testImplementation group: 'org.mockito', name: 'mockito-core', version: '5.14.2'
+}
+
+tasks {
+    clean {
+        delete "logs"
+    }
+
+    test {
+        useJUnitPlatform()
+
+        testLogging {
+            events "passed", "skipped", "failed"
+            showStandardStreams = true
+        }
+
+        finalizedBy jacocoTestReport
+    }
+
+    jacocoTestReport {
+        dependsOn test
+
+        reports {
+            csv.required = false
+
+            xml.required = true
+            xml.outputLocation = layout.buildDirectory.file("jacoco.xml").get().asFile
+
+            html.required = true
+            html.outputLocation = layout.buildDirectory.dir("jacocoHtml").get().asFile
+        }
+    }
 }
 
 artifacts {

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.11-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

src/main/java/io/codemc/bot/CodeMCBot.java

@@ -34,6 +34,8 @@
 import net.dv8tion.jda.api.entities.Activity;
 import net.dv8tion.jda.api.requests.GatewayIntent;
 import net.dv8tion.jda.api.utils.MemberCachePolicy;
+
+import org.jetbrains.annotations.VisibleForTesting;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -42,8 +44,11 @@
 
 public class CodeMCBot{
 
-    private final Logger logger = LoggerFactory.getLogger(CodeMCBot.class);
-    private final ConfigHandler configHandler = new ConfigHandler();
+    @VisibleForTesting
+    Logger logger = LoggerFactory.getLogger(CodeMCBot.class);
+
+    @VisibleForTesting
+    ConfigHandler configHandler = new ConfigHandler();
 
     public static void main(String[] args){
         try{
@@ -53,51 +58,69 @@ public static void main(String[] args){
         }
     }
 
-    private void start() throws LoginException{
+    @VisibleForTesting
+    void start() throws LoginException{
+        loadConfig();
+        validateConfig();
+
+        String token = configHandler.getString("bot_token");
+        long owner = configHandler.getLong("users", "owner");
+        long guildId = configHandler.getLong("server");
+
+        CommandClientBuilder clientBuilder = new CommandClientBuilder().setActivity(null).forceGuildOnly(guildId);
+
+        clientBuilder.setOwnerId(owner);
+
+        List<Long> coOwners = configHandler.getLongList("users", "co_owners");
+
+        if(coOwners != null && !coOwners.isEmpty()){
+            logger.info("Adding {} Co-Owner(s) to the bot.", coOwners.size());
+            // Annoying, but setCoOwnerIds has no overload with a Collection<Long>...
+            long[] coOwnerIds = new long[coOwners.size()];
+            for(int i = 0; i < coOwnerIds.length; i++){
+                coOwnerIds[i] = coOwners.get(i);
+            }
+
+            clientBuilder.setCoOwnerIds(coOwnerIds);
+        }
+
+        initializeAPI();
+        login(clientBuilder, token);
+    }
+
+    private void loadConfig() {
         if(!configHandler.loadConfig()){
             logger.warn("Unable to load config.json! See previous logs for any errors.");
             System.exit(1);
             return;
         }
 
+        logger.info("Loaded config.json");
+    }
+
+    @VisibleForTesting
+    public final void validateConfig() {
         String token = configHandler.getString("bot_token");
         if(token == null || token.isEmpty()){
             logger.warn("Received invalid Bot Token!");
             System.exit(1);
             return;
         }
 
-        long owner = configHandler.getLong("users", "owner");
-        if(owner == -1L){
+        if(configHandler.getLong("users", "owner") == -1L){
             logger.warn("Unable to retrieve Owner ID. This value is required!");
             System.exit(1);
             return;
         }
 
-        long guildId = configHandler.getLong("server");
-        if(guildId == -1L){
+        if(configHandler.getLong("server") == -1L){
             logger.warn("Unable to retrieve Server ID. This value is required!");
             System.exit(1);
-            return;
-        }
-
-        CommandClientBuilder clientBuilder = new CommandClientBuilder().setActivity(null).forceGuildOnly(guildId);
-
-        clientBuilder.setOwnerId(owner);
-
-        List<Long> coOwners = configHandler.getLongList("users", "co_owners");
-
-        if(coOwners != null && !coOwners.isEmpty()){
-            logger.info("Adding {} Co-Owner(s) to the bot.", coOwners.size());
-            // Annoying, but setCoOwnerIds has no overload with a Collection<Long>...
-            long[] coOwnerIds = new long[coOwners.size()];
-            for(int i = 0; i < coOwnerIds.length; i++){
-                coOwnerIds[i] = coOwners.get(i);
-            }
-
-            clientBuilder.setCoOwnerIds(coOwnerIds);
         }
+    }
 
+    @VisibleForTesting
+    final void initializeAPI() {
         logger.info("Initializing API...");
         JenkinsConfig jenkins = new JenkinsConfig(
                 configHandler.getString("jenkins", "url"),
@@ -124,15 +147,15 @@ private void start() throws LoginException{
 
         boolean jenkinsPing = JenkinsAPI.ping();
         if (!jenkinsPing) {
-            logger.error("Failed to connect to Jenkins at {}!", jenkins.getUrl());
+            logger.error("Failed to connect to Jenkins at '{}'!", jenkins.getUrl());
             System.exit(1);
             return;
         }
         logger.info("Connected to Jenkins at {}", jenkins.getUrl());
 
         boolean nexusPing = NexusAPI.ping();
         if (!nexusPing) {
-            logger.error("Failed to connect to Nexus at {}!", nexus.getUrl());
+            logger.error("Failed to connect to Nexus at '{}'!", nexus.getUrl());
             System.exit(1);
             return;
         }
@@ -143,7 +166,9 @@ private void start() throws LoginException{
             logger.warn("GitHub API Token is empty! This may cause issues with GitHub API requests.");
         else
             logger.info("GitHub API Token set");
-
+    }
+
+    private void login(CommandClientBuilder clientBuilder, String token) throws LoginException{
         logger.info("Adding commands...");
         clientBuilder.addSlashCommands(
             new CmdApplication(this),

src/main/java/io/codemc/bot/commands/CmdApplication.java

@@ -32,6 +32,8 @@
 
 import java.util.List;
 
+import org.jetbrains.annotations.VisibleForTesting;
+
 public class CmdApplication extends BotCommand{
 
     public CmdApplication(CodeMCBot bot){
@@ -54,7 +56,8 @@ public void withModalReply(SlashCommandEvent event){}
     @Override
     public void withHookReply(InteractionHook hook, SlashCommandEvent event, Guild guild, Member member){}
 
-    private static class Accept extends BotCommand{
+    @VisibleForTesting
+    static class Accept extends BotCommand{
 
         public Accept(CodeMCBot bot){
             super(bot);
@@ -81,7 +84,7 @@ public void withHookReply(InteractionHook hook, SlashCommandEvent event, Guild g
             }
 
             try {
-                long messageId = -1L;
+                long messageId;
                 if (message.contains("-"))
                     messageId = Long.parseLong(message.split("-")[1]);
                 else
@@ -99,7 +102,8 @@ public void withHookReply(InteractionHook hook, SlashCommandEvent event, Guild g
         }
     }
 
-    private static class Deny extends BotCommand{
+    @VisibleForTesting
+    static class Deny extends BotCommand{
 
         public Deny(CodeMCBot bot){
             super(bot);
@@ -127,7 +131,7 @@ public void withHookReply(InteractionHook hook, SlashCommandEvent event, Guild g
             }
 
             try {
-                long messageId = -1L;
+                long messageId;
                 if (message.contains("-"))
                     messageId = Long.parseLong(message.split("-")[1]);
                 else