Merge pull request #20 from alt-art/tests

Tests and small things

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
         steps:
         - name: Checkout
           uses: actions/checkout@v4
-        - name: Set up JDK 8
+        - name: Set up JDK 17
           uses: actions/setup-java@v4
           with:
             java-version: '8'

.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        steps:
+        - name: Checkout
+          uses: actions/checkout@v4
+        - name: Set up JDK 17
+          uses: actions/setup-java@v4
+          with:
+              java-version: '17'
+              distribution: 'corretto'
+        - name: Run tests
+          run: ./gradlew
+        - name: Report test results
+          uses: mikepenz/action-junit-report@v4
+          if: success() || failure()
+          with:
+            report_paths: '**/build/test-results/test/TEST-*.xml'

CONFIG.md

@@ -33,4 +33,6 @@ deathEvent: true
 advancementEvent: true
 # Log player sleep in telegram chat
 sleepEvent: false
+# Log when server starts and stops in telegram chat
+serverStartStop: false
 ```

build.gradle

@@ -1,6 +1,7 @@
 plugins {
     id 'java'
     id 'com.github.johnrengelman.shadow' version '8.1.1'
+    id 'idea'
 }
 
 shadowJar {
@@ -27,14 +28,16 @@ dependencies {
     implementation 'org.telegram:telegrambots:6.9.7.1'
     implementation 'org.xerial:sqlite-jdbc:3.45.3.0'
     compileOnly 'org.jetbrains:annotations:24.1.0'
-    compileOnly 'org.spigotmc:spigot-api:1.18.2-R0.1-SNAPSHOT'
+    implementation 'org.spigotmc:spigot-api:1.18.2-R0.1-SNAPSHOT'
+    testImplementation platform('org.junit:junit-bom:5.10.2')
+    testImplementation 'org.junit.jupiter:junit-jupiter'
+    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+    implementation 'org.mockito:mockito-core:5.12.0'
 }
 
 def targetJavaVersion = 8
 java {
     def javaVersion = JavaVersion.toVersion(targetJavaVersion)
-    sourceCompatibility = javaVersion
-    targetCompatibility = javaVersion
     if (JavaVersion.current() < javaVersion) {
         toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion)
     }
@@ -48,6 +51,13 @@ tasks.withType(JavaCompile).configureEach {
     }
 }
 
+test {
+    useJUnitPlatform()
+    testLogging {
+        events "passed", "skipped", "failed"
+    }
+}
+
 processResources {
     def props = [version: version]
     inputs.properties props

src/main/java/org/altart/telegrambridge/TelegramBridge.java

@@ -7,8 +7,10 @@
 import org.altart.telegrambridge.database.SQLite;
 import org.altart.telegrambridge.events.ChatEvent;
 import org.altart.telegrambridge.events.GameEvent;
+import org.altart.telegrambridge.utils.Format;
 import org.bukkit.Bukkit;
 import org.bukkit.command.PluginCommand;
+import org.bukkit.entity.Player;
 import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.telegram.telegrambots.meta.TelegramBotsApi;
@@ -47,34 +49,51 @@ public void onEnable() {
             TelegramBotsApi telegramBotsApi = new TelegramBotsApi(DefaultBotSession.class);
             botSession = telegramBotsApi.registerBot(telegramBot);
             log.info("Telegram bot registered");
+            if (config.sendToTelegram && config.serverStartStop) {
+                telegramBot.broadcastMessage(translations.get().serverStart);
+            }
+
+            Bukkit.getPluginManager().registerEvents(new ChatEvent(), plugin);
+            Bukkit.getPluginManager().registerEvents(new GameEvent(), plugin);
+            try {
+                Objects.requireNonNull(getCommand("tbreload")).setExecutor(new ReloadCommand());
+                PluginCommand replyCommand = Objects.requireNonNull(getCommand("tbreply"));
+                replyCommand.setExecutor(new ReplyCommand());
+                replyCommand.setTabCompleter(new UserTabCompletion(2));
+                PluginCommand mentionCommand = Objects.requireNonNull(getCommand("tbmention"));
+                mentionCommand.setExecutor(new MentionCommand());
+                mentionCommand.setTabCompleter(new UserTabCompletion(1));
+                PluginCommand configCommand = Objects.requireNonNull(getCommand("tbconfig"));
+                configCommand.setExecutor(new ConfigCommand());
+                configCommand.setTabCompleter(new ConfigTabCompletion());
+            } catch (NullPointerException e) {
+                log.severe("Error registering command: " + e.getMessage());
+                Arrays.stream(e.getStackTrace()).forEach(line -> TelegramBridge.log.severe(line.toString()));
+            }
         } catch (Exception e) {
             log.severe("Error registering bot: " + e.getMessage());
             Arrays.stream(e.getStackTrace()).forEach(line -> log.severe(line.toString()));
         }
-
-        Bukkit.getPluginManager().registerEvents(new ChatEvent(), plugin);
-        Bukkit.getPluginManager().registerEvents(new GameEvent(), plugin);
-        try {
-            Objects.requireNonNull(getCommand("tbreload")).setExecutor(new ReloadCommand());
-            PluginCommand replyCommand = Objects.requireNonNull(getCommand("tbreply"));
-            replyCommand.setExecutor(new ReplyCommand());
-            replyCommand.setTabCompleter(new UserTabCompletion(2));
-            PluginCommand mentionCommand = Objects.requireNonNull(getCommand("tbmention"));
-            mentionCommand.setExecutor(new MentionCommand());
-            mentionCommand.setTabCompleter(new UserTabCompletion(1));
-            PluginCommand configCommand = Objects.requireNonNull(getCommand("tbconfig"));
-            configCommand.setExecutor(new ConfigCommand());
-            configCommand.setTabCompleter(new ConfigTabCompletion());
-        } catch (NullPointerException e) {
-            log.severe("Error registering command: " + e.getMessage());
-            Arrays.stream(e.getStackTrace()).forEach(line -> TelegramBridge.log.severe(line.toString()));
-        }
     }
 
     @Override
     public void onDisable() {
         database.close();
         if (botSession != null) {
+            if (config.sendToTelegram) {
+                if (config.joinAndLeaveEvent) {
+                    StringBuilder message = new StringBuilder();
+                    for (Player player : Bukkit.getOnlinePlayers()) {
+                        message.append(Format.string(translations.get().leave, "playername", player.getDisplayName())).append("\n");
+                    }
+                    if (message.length() > 0) {
+                        telegramBot.broadcastMessage(message.toString());
+                    }
+                }
+                if (config.serverStartStop) {
+                    telegramBot.broadcastMessage(translations.get().serverStop);
+                }
+            }
             botSession.stop();
         }
     }

src/main/java/org/altart/telegrambridge/bot/TelegramBot.java

@@ -32,11 +32,11 @@ public class TelegramBot extends TelegramLongPollingBot {
     private final Plugin plugin;
     private final Map<String, TelegramCommandExecutor> commands = new HashMap<>();
 
-    private final List<TelegramFeature> features = new ArrayList<>();
+    public List<TelegramFeature> features = new ArrayList<>();
 
-    public final PinMessage pinMessageFeature = new PinMessage(this);
-    public final UserAutocomplete userAutocompleteFeature = new UserAutocomplete(this);
-    public final MessageListener messageListenerFeature = new MessageListener(this);
+    public PinMessage pinMessageFeature = new PinMessage(this);
+    public UserAutocomplete userAutocompleteFeature = new UserAutocomplete(this);
+    public MessageListener messageListenerFeature = new MessageListener(this);
     public final SentMedia sentMediaFeature = new SentMedia(this);
 
     public TelegramBot(Plugin plugin) {
@@ -88,7 +88,7 @@ public void onUpdateReceived(@NotNull Update update) {
         }
     }
 
-    private boolean isNotAdmin(String chatId, Long userId) {
+    public boolean isNotAdmin(String chatId, Long userId) {
         GetChatAdministrators getChatAdministrators = new GetChatAdministrators();
         getChatAdministrators.setChatId(chatId);
         try {
@@ -172,7 +172,7 @@ public void pinMessage(String chatId, Integer messageId) {
         }
     }
 
-    public void unpinMessage(String chatId, Integer messageId) {
+    public void unpinMessage(@NotNull String chatId, Integer messageId) {
         try {
             execute(new UnpinChatMessage(chatId, messageId));
         } catch (TelegramApiException e) {
@@ -198,7 +198,7 @@ public void editSystemMessage(String message, String chatId, Integer messageId)
         }
     }
 
-    public void deleteMessage(String chatId, Integer messageId) {
+    public void deleteMessage(@NotNull String chatId, @NotNull Integer messageId) {
         try {
             execute(new DeleteMessage(chatId, messageId));
         } catch (TelegramApiException e) {
@@ -208,9 +208,9 @@ public void deleteMessage(String chatId, Integer messageId) {
     }
 
     public class CommandSender {
-        public Plugin plugin;
-        public Message message;
-        public TelegramBot bot;
+        public final Plugin plugin;
+        public final Message message;
+        public final TelegramBot bot;
 
         private CommandSender(Message message, Plugin plugin, TelegramBot bot) {
             this.message = message;

src/main/java/org/altart/telegrambridge/bot/TelegramCommandExecutor.java

@@ -1,9 +1,12 @@
 package org.altart.telegrambridge.bot;
 
 abstract public class TelegramCommandExecutor {
-    public boolean requirePermission;
+    public final boolean requirePermission;
+
     public TelegramCommandExecutor(boolean requirePermission) {
         this.requirePermission = requirePermission;
     }
-    public void onCommand(TelegramBot.CommandSender sender, String[] args) {}
+
+    public void onCommand(TelegramBot.CommandSender sender, String[] args) {
+    }
 }

src/main/java/org/altart/telegrambridge/bot/commands/TimeCommand.java

@@ -31,7 +31,7 @@ public void onCommand(TelegramBot.CommandSender sender, String[] args) {
         sender.sendMessage(response);
     }
 
-    public HashMap<String, String> makeTimeMap(String time, String emoji, int day, int month, int year) {
+    private HashMap<String, String> makeTimeMap(String time, String emoji, int day, int month, int year) {
         HashMap<String, String> values = new HashMap<>();
         values.put("time", time);
         values.put("emoji", emoji);

src/main/java/org/altart/telegrambridge/bot/commands/UnsetPinCommand.java

@@ -15,9 +15,11 @@ public void onCommand(TelegramBot.CommandSender sender, String[] args) {
         String chatId = String.valueOf(sender.message.getChatId());
         for (Config.Chat chat : TelegramBridge.config.chats) {
             if (chat.id.equals(chatId)) {
+                if (chat.pinnedMessageId != null) {
+                    sender.bot.unpinMessage(chatId, chat.pinnedMessageId);
+                    sender.bot.deleteMessage(chatId, chat.pinnedMessageId);
+                }
                 TelegramBridge.config.setPinnedMessageId(chatId, null);
-                sender.bot.unpinMessage(chatId, chat.pinnedMessageId);
-                sender.bot.deleteMessage(chatId, chat.pinnedMessageId);
             }
         }
     }

src/main/java/org/altart/telegrambridge/bot/feature/MessageListener.java

@@ -75,7 +75,7 @@ public void onUpdateReceived(@NotNull Update update) {
 
                     Message reply = message.getReplyToMessage();
                     if (reply != null && reply.hasText()) {
-                        String replyUsername = reply.getFrom().getUserName();
+                        String replyUsername = getUserName(message);
                         String replyMessage = reply.getText();
                         finalComponent.addExtra(replyComponent(replyUsername, replyMessage, lang));
                     }
@@ -122,11 +122,6 @@ public void onUpdateReceived(@NotNull Update update) {
                 username += " " + message.getFrom().getLastName();
             }
         }
-
-        if (username.trim().isEmpty()) {
-            username = "Anonymous";
-        }
-
         return username;
     }
 
@@ -155,10 +150,10 @@ private static TextComponent replyComponent(String username, String message, @Nu
     }
 
     private static class MessageInfo {
-        public String chatId;
-        public Integer messageId;
-        public String message;
-        public String username;
+        public final String chatId;
+        public final Integer messageId;
+        public final String message;
+        public final String username;
 
         public MessageInfo(String chatId, Integer messageId, String message, String username) {
             this.chatId = chatId;

src/main/java/org/altart/telegrambridge/bot/feature/PinMessage.java

@@ -13,7 +13,6 @@ public class PinMessage extends TelegramFeature {
 
     public PinMessage(TelegramBot telegramBot) {
         super(telegramBot);
-        updatePinnedMessage();
     }
 
     static public String buildPinnedMessage() {

src/main/java/org/altart/telegrambridge/bot/feature/SentMedia.java

@@ -22,17 +22,17 @@ public SentMedia(TelegramBot telegramBot) {
 
     @Override
     public void onUpdateReceived(@NotNull Update update) {
-        Message message = update.getMessage();
-        if (isMedia(message)) {
-            String username = message.getFrom().getUserName();
-            String caption = message.getCaption();
-            caption = caption == null ? "" : "\n" + caption;
-            if (TelegramBridge.config.sendToChat) {
+        if (TelegramBridge.config.sendToChat) {
+            Message message = update.getMessage();
+            if (isMedia(message)) {
+                String username = message.getFrom().getUserName();
+                String caption = message.getCaption();
+                caption = caption == null ? "" : "\n" + caption;
+                HashMap<String, String> values = new HashMap<>();
+                values.put("caption", caption);
+                values.put("user", username);
                 for (Player player : Bukkit.getOnlinePlayers()) {
                     if (player.hasPermission(Permissions.RECEIVE.getString())) {
-                        HashMap<String, String> values = new HashMap<>();
-                        values.put("user", username);
-                        values.put("caption", caption);
                         String lang = TelegramBridge.database.getLang(player.getUniqueId());
                         values.put("type", determineMediaType(message, lang));
                         String text = Format.string(TelegramBridge.translations.get(lang).telegramMedia, values);

src/main/java/org/altart/telegrambridge/commands/ConfigCommand.java

@@ -17,7 +17,7 @@ public boolean onCommand(@NotNull CommandSender sender, @NotNull Command _comman
         if (args[0].equals("default-lang")) {
             if (!sender.hasPermission(Permissions.DEFAULT_TRANSLATION_CONFIG.getString())) {
                 sender.sendMessage("You do not have permission to use this command.");
-                return true;
+                return false;
             }
             try {
                 TelegramBridge.translations.setDefaultLang(args[1]);
@@ -31,14 +31,14 @@ public boolean onCommand(@NotNull CommandSender sender, @NotNull Command _comman
         if (args[0].equals("lang")) {
             if (!sender.hasPermission(Permissions.TRANSLATION_CONFIG.getString())) {
                 sender.sendMessage("You do not have permission to use this command.");
-                return true;
+                return false;
             }
             try {
                 if (sender instanceof Player) {
                     TelegramBridge.database.setLang(((Player) sender).getUniqueId(), args[1]);
                 } else {
                     sender.sendMessage("This command can only be used by players.");
-                    return true;
+                    return false;
                 }
             } catch (Exception e) {
                 sender.sendMessage(e.getMessage());

src/main/java/org/altart/telegrambridge/commands/UserTabCompletion.java

@@ -11,7 +11,7 @@
 import java.util.List;
 
 public class UserTabCompletion implements TabCompleter {
-    int argLength;
+    final int argLength;
 
     public UserTabCompletion(int argLength) {
         this.argLength = argLength;