release: 发布 0.3.1 版本.

由于私有仓库所在的服务器出现问题, 所以暂时将仓库改到 Kuku 的那边.
在此感谢 Kuku 提供仓库!

build.gradle.kts

@@ -7,5 +7,5 @@ allprojects {
 
     }
     group = "net.lamgc"
-    version = "0.3.0"
+    version = "0.3.1"
 }

scalabot-app/build.gradle.kts

@@ -36,6 +36,7 @@ dependencies {
 
     testImplementation(kotlin("test"))
     testImplementation("io.mockk:mockk:1.12.3")
+    testImplementation("com.github.stefanbirkner:system-lambda:1.2.1")
 }
 
 tasks.test {

scalabot-app/src/main/kotlin/AppConfigs.kt

@@ -104,7 +104,7 @@ internal data class MetricsConfig(
 internal data class MavenRepositoryConfig(
     val id: String? = null,
     val url: URL,
-    val proxy: Proxy? = Proxy("http", "127.0.0.1", 1080),
+    val proxy: Proxy? = null,
     val layout: String = "default",
     val enableReleases: Boolean = true,
     val enableSnapshots: Boolean = true,

scalabot-app/src/main/kotlin/util/Serializers.kt

@@ -1,7 +1,6 @@
 package net.lamgc.scalabot.util
 
 import com.google.gson.*
-import mu.KotlinLogging
 import net.lamgc.scalabot.MavenRepositoryConfig
 import org.eclipse.aether.artifact.Artifact
 import org.eclipse.aether.artifact.DefaultArtifact
@@ -20,6 +19,9 @@ internal object ProxyTypeSerializer : JsonDeserializer<DefaultBotOptions.ProxyTy
         typeOfT: Type?,
         context: JsonDeserializationContext?
     ): DefaultBotOptions.ProxyType {
+        if (json.isJsonNull) {
+            return DefaultBotOptions.ProxyType.NO_PROXY
+        }
         if (!json.isJsonPrimitive) {
             throw JsonParseException("Wrong configuration value type.")
         }
@@ -52,8 +54,8 @@ internal object ArtifactSerializer : JsonSerializer<Artifact>, JsonDeserializer<
         return JsonPrimitive(gavBuilder.append(':').append(src.version).toString())
     }
 
-    override fun deserialize(json: JsonElement?, typeOfT: Type?, context: JsonDeserializationContext?): Artifact {
-        if (!json!!.isJsonPrimitive) {
+    override fun deserialize(json: JsonElement, typeOfT: Type?, context: JsonDeserializationContext?): Artifact {
+        if (!json.isJsonPrimitive) {
             throw JsonParseException("Wrong configuration value type.")
         }
         return DefaultArtifact(json.asString.trim())
@@ -63,72 +65,29 @@ internal object ArtifactSerializer : JsonSerializer<Artifact>, JsonDeserializer<
 
 internal object AuthenticationSerializer : JsonDeserializer<Authentication> {
 
-    private val log = KotlinLogging.logger { }
-
-    override fun deserialize(json: JsonElement, typeOfT: Type, context: JsonDeserializationContext): Authentication? {
+    override fun deserialize(json: JsonElement, typeOfT: Type, context: JsonDeserializationContext): Authentication {
+        if (json !is JsonObject) {
+            throw JsonParseException("Unsupported JSON type.")
+        }
+        val username = SerializerUtils.checkJsonKey(json, "username")
+        val password = SerializerUtils.checkJsonKey(json, "password")
         val builder = AuthenticationBuilder()
-        when (json) {
-            is JsonArray -> {
-                for (element in json) {
-                    if (element is JsonArray) {
-                        builder.addCustom(jsonArrayToAuthentication(element))
-                    } else if (element is JsonObject) {
-                        jsonToAuthentication(element, builder)
-                    }
-                }
-            }
-            is JsonObject -> {
-                jsonToAuthentication(json, builder)
-            }
-            else -> {
-                throw JsonParseException("Unsupported JSON data type: ${json::class.java}")
-            }
-        }
+        builder.addUsername(username)
+        builder.addPassword(password)
         return builder.build()
     }
 
-    private fun jsonArrayToAuthentication(jsonArray: JsonArray): Authentication {
-        val builder = AuthenticationBuilder()
-        for (element in jsonArray) {
-            when (element) {
-                is JsonObject -> jsonToAuthentication(element, builder)
-                is JsonArray -> builder.addCustom(jsonArrayToAuthentication(element))
-                else -> log.warn { "不支持的 Json 类型: ${element::class.java}" }
-            }
-        }
-        return builder.build()
-    }
-
-    private const val KEY_TYPE = "type"
-
-    private fun jsonToAuthentication(json: JsonObject, builder: AuthenticationBuilder) {
-        if (!json.has(KEY_TYPE)) {
-            log.warn { "缺少 type 字段, 无法判断 Maven 认证信息类型." }
-            return
-        } else if (!json.get(KEY_TYPE).isJsonPrimitive) {
-            log.warn { "type 字段类型错误(应为 Primitive 类型), 无法判断 Maven 认证信息类型.(实际类型: `${json::class.java}`)" }
-            return
-        }
-
-        when (json.get(KEY_TYPE).asString.trim().lowercase()) {
-            "string" -> {
-                builder.addString(checkJsonKey(json, "key"), checkJsonKey(json, "value"))
-            }
-            "secret" -> {
-                builder.addSecret(checkJsonKey(json, "key"), checkJsonKey(json, "value"))
-            }
-        }
-
-    }
 }
 
-private fun checkJsonKey(json: JsonObject, key: String): String {
+private object SerializerUtils {
+    fun checkJsonKey(json: JsonObject, key: String): String {
         if (!json.has(key)) {
             throw JsonParseException("Required field does not exist: $key")
         } else if (!json.get(key).isJsonPrimitive) {
             throw JsonParseException("Wrong field `$key` type: ${json.get(key)::class.java}")
         }
         return json.get(key).asString
+    }
 }
 
 internal object MavenRepositoryConfigSerializer
@@ -143,12 +102,12 @@ internal object MavenRepositoryConfigSerializer
             is JsonObject -> {
                 MavenRepositoryConfig(
                     id = json.get("id")?.asString,
-                    url = URL(checkJsonKey(json, "url")),
+                    url = URL(SerializerUtils.checkJsonKey(json, "url")),
                     proxy = if (json.has("proxy") && json.get("proxy").isJsonObject)
                         context.deserialize<Proxy>(
                             json.getAsJsonObject("proxy"), Proxy::class.java
                         ) else null,
-                    layout = json.get("layout").asString ?: "default",
+                    layout = json.get("layout")?.asString ?: "default",
                     enableReleases = json.get("enableReleases")?.asBoolean ?: true,
                     enableSnapshots = json.get("enableSnapshots")?.asBoolean ?: true,
                     authentication = if (json.has("authentication") && json.get("authentication").isJsonObject)

scalabot-app/src/test/kotlin/AppConfigTest.kt

@@ -1,5 +1,6 @@
 package net.lamgc.scalabot
 
+import com.github.stefanbirkner.systemlambda.SystemLambda
 import com.google.gson.Gson
 import io.mockk.every
 import io.mockk.mockk
@@ -40,23 +41,27 @@ internal class AppPathsTest {
 
     @Test
     fun `Data root path priority`() {
-        System.setProperty("bot.path.data", "A")
+        System.setProperty("bot.path.data", "fromSystemProperties")
 
-        assertEquals("A", AppPaths.DATA_ROOT.file.path, "`DATA_ROOT`没有优先返回 Property 的值.")
+        assertEquals("fromSystemProperties", AppPaths.DATA_ROOT.file.path, "`DATA_ROOT`没有优先返回 Property 的值.")
         System.getProperties().remove("bot.path.data")
-        if (System.getenv("BOT_DATA_PATH") != null) {
+
+        val expectEnvValue = "fromEnvironmentVariable"
+        SystemLambda.withEnvironmentVariable("BOT_DATA_PATH", expectEnvValue).execute {
             assertEquals(
-                System.getenv("BOT_DATA_PATH"), AppPaths.DATA_ROOT.file.path,
-                "`DATA_ROOT`没有返回 env 的值."
+                expectEnvValue, AppPaths.DATA_ROOT.file.path,
+                "`DATA_ROOT`没有优先返回 env 的值."
             )
-        } else {
+        }
+
+        SystemLambda.withEnvironmentVariable("BOT_DATA_PATH", null).execute {
             assertEquals(
                 System.getProperty("user.dir"), AppPaths.DATA_ROOT.file.path,
-                "`DATA_ROOT`没有返回 `user.dir` 的值."
+                "`DATA_ROOT`没有返回 System.properties `user.dir` 的值."
             )
             val userDir = System.getProperty("user.dir")
             System.getProperties().remove("user.dir")
-            assertEquals(".", AppPaths.DATA_ROOT.file.path, "`DATA_ROOT`没有返回 `.`(当前目录).")
+            assertEquals(".", AppPaths.DATA_ROOT.file.path, "`DATA_ROOT`没有返回替补值 `.`(当前目录).")
             System.setProperty("user.dir", userDir)
             assertNotNull(System.getProperty("user.dir"), "环境还原失败!")
         }

scalabot-app/src/test/kotlin/util/ArtifactSerializerTest.kt

@@ -18,13 +18,21 @@ internal class ArtifactSerializerTest {
     }
 
     @Test
-    fun serialize() {
+    fun `Basic format serialization`() {
         val gav = "org.example.software:test:1.0.0-SNAPSHOT"
         val expectArtifact = DefaultArtifact(gav)
         val actualArtifact = DefaultArtifact(ArtifactSerializer.serialize(expectArtifact, null, null).asString)
         assertEquals(expectArtifact, actualArtifact)
     }
 
+    @Test
+    fun `Full format serialization`() {
+        val gav = "org.example.software:test:war:javadoc:1.0.0-SNAPSHOT"
+        val expectArtifact = DefaultArtifact(gav)
+        val actualArtifact = DefaultArtifact(ArtifactSerializer.serialize(expectArtifact, null, null).asString)
+        assertEquals(expectArtifact, actualArtifact)
+    }
+
     @Test
     fun deserialize() {
         val gav = "org.example.software:test:1.0.0-SNAPSHOT"

scalabot-app/src/test/kotlin/util/SerializersKtTest.kt

@@ -0,0 +1,325 @@
+package util
+
+import com.google.gson.*
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.verify
+import net.lamgc.scalabot.MavenRepositoryConfig
+import net.lamgc.scalabot.util.AuthenticationSerializer
+import net.lamgc.scalabot.util.MavenRepositoryConfigSerializer
+import net.lamgc.scalabot.util.ProxyTypeSerializer
+import org.eclipse.aether.repository.Authentication
+import org.eclipse.aether.repository.AuthenticationContext
+import org.eclipse.aether.repository.Proxy
+import org.intellij.lang.annotations.Language
+import org.junit.jupiter.api.Assertions.assertThrows
+import org.telegram.telegrambots.bots.DefaultBotOptions
+import java.lang.reflect.InvocationTargetException
+import java.lang.reflect.Method
+import java.lang.reflect.Type
+import java.net.URL
+import kotlin.test.*
+
+internal class SerializersKtTest {
+
+    private val instance: Any
+    private val method: Method
+
+    init {
+        val clazz = Class.forName("net.lamgc.scalabot.util.SerializerUtils")
+        method = clazz.getDeclaredMethod("checkJsonKey", JsonObject::class.java, String::class.java)
+        method.isAccessible = true
+        instance = clazz.getDeclaredField("INSTANCE").apply {
+            isAccessible = true
+        }.get(null)
+    }
+
+    private fun invoke(json: JsonObject, key: String): String {
+        try {
+            return method.invoke(instance, json, key) as String
+        } catch (e: InvocationTargetException) {
+            throw e.targetException
+        }
+    }
+
+    @Test
+    fun `Json key checker test`() {
+        assertThrows(JsonParseException::class.java) {
+            invoke(JsonObject(), "NOT_EXIST_KEY")
+        }
+        assertThrows(JsonParseException::class.java) {
+            invoke(JsonObject().apply { add("NULL_KEY", JsonNull.INSTANCE) }, "NULL_KEY")
+        }
+        assertThrows(JsonParseException::class.java) {
+            invoke(JsonObject().apply { add("ARRAY_KEY", JsonArray()) }, "ARRAY_KEY")
+        }
+        assertThrows(JsonParseException::class.java) {
+            invoke(JsonObject().apply { add("OBJECT_KEY", JsonObject()) }, "OBJECT_KEY")
+        }
+
+        val expectKey = "TEST"
+        val expectString = "testString"
+        val json = JsonObject().apply { addProperty(expectKey, expectString) }
+
+        assertEquals(expectString, invoke(json, expectKey))
+    }
+}
+
+internal class ProxyTypeSerializerTest {
+
+    @Test
+    fun `serialize test`() {
+        for (type in DefaultBotOptions.ProxyType.values()) {
+            assertEquals(
+                JsonPrimitive(type.name), ProxyTypeSerializer.serialize(type, null, null),
+                "ProxyType 序列化结果与预期不符."
+            )
+        }
+    }
+
+    @Test
+    fun `deserialize test`() {
+        assertThrows(JsonParseException::class.java) {
+            ProxyTypeSerializer.deserialize(JsonObject(), null, null)
+        }
+        assertThrows(JsonParseException::class.java) {
+            ProxyTypeSerializer.deserialize(JsonArray(), null, null)
+        }
+
+        assertThrows(JsonParseException::class.java) {
+            ProxyTypeSerializer.deserialize(JsonPrimitive("NOT_IN_ENUM_VALUE"), null, null)
+        }
+
+        assertEquals(
+            DefaultBotOptions.ProxyType.NO_PROXY,
+            ProxyTypeSerializer.deserialize(JsonNull.INSTANCE, null, null)
+        )
+
+        for (type in DefaultBotOptions.ProxyType.values()) {
+            assertEquals(
+                type, ProxyTypeSerializer.deserialize(JsonPrimitive(type.name), null, null),
+                "ProxyType 反序列化结果与预期不符."
+            )
+
+            assertEquals(
+                type, ProxyTypeSerializer.deserialize(JsonPrimitive("  ${type.name}   "), null, null),
+                "ProxyType 反序列化时未对 Json 字符串进行修剪(trim)."
+            )
+        }
+
+    }
+
+}
+
+internal class MavenRepositoryConfigSerializerTest {
+
+    @Test
+    fun `unsupported json type deserialize test`() {
+        assertThrows(JsonParseException::class.java) {
+            MavenRepositoryConfigSerializer.deserialize(
+                JsonArray(),
+                MavenRepositoryConfig::class.java,
+                TestJsonDeserializationContext
+            )
+        }
+        assertThrows(JsonParseException::class.java) {
+            MavenRepositoryConfigSerializer.deserialize(
+                JsonNull.INSTANCE,
+                MavenRepositoryConfig::class.java,
+                TestJsonDeserializationContext
+            )
+        }
+    }
+
+    @Test
+    fun `json primitive deserialize test`() {
+        val expectRepoUrl = "https://repo.example.org/maven"
+        val config = MavenRepositoryConfigSerializer.deserialize(
+            JsonPrimitive(expectRepoUrl),
+            MavenRepositoryConfig::class.java,
+            TestJsonDeserializationContext
+        )
+
+        assertNull(config.id)
+        assertEquals(URL(expectRepoUrl), config.url)
+        assertNull(config.proxy, "Proxy 默认值不为 null.")
+        assertEquals("default", config.layout)
+        assertTrue(config.enableReleases)
+        assertTrue(config.enableSnapshots)
+        assertNull(config.authentication)
+    }
+
+    @Test
+    fun `json object default deserialize test`() {
+        val expectRepoUrl = "https://repo.example.org/maven"
+        val jsonObject = JsonObject()
+        jsonObject.addProperty("url", expectRepoUrl)
+        val config = MavenRepositoryConfigSerializer.deserialize(
+            jsonObject,
+            MavenRepositoryConfig::class.java,
+            TestJsonDeserializationContext
+        )
+
+        assertNull(config.id)
+        assertEquals(URL(expectRepoUrl), config.url)
+        assertNull(config.proxy, "Proxy 默认值不为 null.")
+        assertEquals("default", config.layout)
+        assertTrue(config.enableReleases)
+        assertTrue(config.enableSnapshots)
+        assertNull(config.authentication)
+    }
+
+    @Test
+    fun `json object deserialize test`() {
+        @Language("JSON5")
+        val looksGoodJsonString = """
+            {
+              "id": "test-repository",
+              "url": "https://repo.example.org/maven",
+              "proxy": {
+                "type": "http",
+                "host": "127.0.1.1",
+                "port": 10800
+              },
+              "layout": "default",
+              "enableReleases": false,
+              "enableSnapshots": true
+            }
+        """.trimIndent()
+
+        val jsonObject = Gson().fromJson(looksGoodJsonString, JsonObject::class.java)
+        var config = MavenRepositoryConfigSerializer.deserialize(
+            jsonObject,
+            MavenRepositoryConfig::class.java,
+            TestJsonDeserializationContext
+        )
+
+        assertEquals(jsonObject["id"].asString, config.id)
+        assertEquals(URL(jsonObject["url"].asString), config.url)
+        assertEquals(Proxy("http", "127.0.1.1", 10800), config.proxy)
+        assertEquals(jsonObject["layout"].asString, config.layout)
+        assertEquals(jsonObject["enableReleases"].asBoolean, config.enableReleases)
+        assertEquals(jsonObject["enableSnapshots"].asBoolean, config.enableSnapshots)
+
+        // ------------------------------------
+
+        jsonObject.add("proxy", JsonNull.INSTANCE)
+        jsonObject.remove("layout")
+
+        config = MavenRepositoryConfigSerializer.deserialize(
+            jsonObject,
+            MavenRepositoryConfig::class.java,
+            TestJsonDeserializationContext
+        )
+
+        assertEquals(jsonObject["id"].asString, config.id)
+        assertEquals(URL(jsonObject["url"].asString), config.url)
+        assertNull(config.proxy)
+        assertEquals("default", config.layout)
+        assertEquals(jsonObject["enableReleases"].asBoolean, config.enableReleases)
+        assertEquals(jsonObject["enableSnapshots"].asBoolean, config.enableSnapshots)
+
+        // ------------------------------------
+
+        jsonObject.add("authentication", JsonArray())
+        jsonObject.add("layout", mockk<JsonPrimitive> {
+            every { asString }.returns(null)
+        })
+
+        config = MavenRepositoryConfigSerializer.deserialize(
+            jsonObject,
+            MavenRepositoryConfig::class.java,
+            TestJsonDeserializationContext
+        )
+
+        assertEquals(jsonObject["id"].asString, config.id)
+        assertEquals(URL(jsonObject["url"].asString), config.url)
+        assertNull(config.proxy)
+        assertEquals("default", config.layout)
+        assertEquals(jsonObject["enableReleases"].asBoolean, config.enableReleases)
+        assertEquals(jsonObject["enableSnapshots"].asBoolean, config.enableSnapshots)
+        assertNull(config.authentication)
+
+        // ------------------------------------
+
+        jsonObject.add("authentication", JsonObject().apply {
+            addProperty("username", "testUsername")
+            addProperty("password", "testPassword")
+        })
+
+        config = MavenRepositoryConfigSerializer.deserialize(
+            jsonObject,
+            MavenRepositoryConfig::class.java,
+            TestJsonDeserializationContext
+        )
+
+        assertEquals(jsonObject["id"].asString, config.id)
+        assertEquals(URL(jsonObject["url"].asString), config.url)
+        assertNull(config.proxy)
+        assertEquals("default", config.layout)
+        assertEquals(jsonObject["enableReleases"].asBoolean, config.enableReleases)
+        assertEquals(jsonObject["enableSnapshots"].asBoolean, config.enableSnapshots)
+        assertNotNull(config.authentication)
+    }
+
+}
+
+private object TestJsonDeserializationContext : JsonDeserializationContext {
+
+    private val gson = GsonBuilder()
+        .registerTypeAdapter(Authentication::class.java, AuthenticationSerializer)
+        .create()
+
+    override fun <T : Any?> deserialize(json: JsonElement, typeOfT: Type): T {
+        return gson.fromJson(json, typeOfT)
+    }
+}
+
+internal class AuthenticationSerializerTest {
+
+    @Test
+    fun `deserialize test`() {
+        assertThrows(JsonParseException::class.java) {
+            AuthenticationSerializer.deserialize(
+                JsonNull.INSTANCE,
+                Authentication::class.java, TestJsonDeserializationContext
+            )
+        }
+        assertThrows(JsonParseException::class.java) {
+            AuthenticationSerializer.deserialize(
+                JsonArray(),
+                Authentication::class.java, TestJsonDeserializationContext
+            )
+        }
+        assertThrows(JsonParseException::class.java) {
+            AuthenticationSerializer.deserialize(
+                JsonPrimitive("A STRING"),
+                Authentication::class.java, TestJsonDeserializationContext
+            )
+        }
+
+        val expectJsonObject = JsonObject().apply {
+            addProperty("username", "testUsername")
+            addProperty("password", "testPassword")
+        }
+
+        val mockContext = mockk<AuthenticationContext> {
+            every { put(any(), any()) }.answers { }
+        }
+
+        val result = AuthenticationSerializer.deserialize(
+            expectJsonObject,
+            Authentication::class.java, TestJsonDeserializationContext
+        )
+
+        assertNotNull(result)
+        result.fill(mockContext, "username", null)
+        result.fill(mockContext, "password", null)
+
+        verify {
+            mockContext.put("username", "testUsername")
+            mockContext.put("password", "testPassword".toCharArray())
+        }
+    }
+
+}

scalabot-app/src/test/kotlin/util/StdOutFilterTest.kt

@@ -0,0 +1,40 @@
+package net.lamgc.scalabot.util
+
+import ch.qos.logback.classic.Level
+import ch.qos.logback.classic.spi.LoggingEvent
+import ch.qos.logback.core.spi.FilterReply
+import io.mockk.every
+import io.mockk.mockk
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class StdOutFilterTest {
+
+    @Test
+    fun filterTest() {
+        val filter = StdOutFilter()
+
+        for (level in listOf(
+            Level.ALL,
+            Level.TRACE,
+            Level.DEBUG,
+            Level.INFO
+        )) {
+            val loggingEvent = mockk<LoggingEvent> {
+                every { this@mockk.level }.returns(level)
+            }
+            assertEquals(FilterReply.ACCEPT, filter.decide(loggingEvent))
+        }
+
+        for (level in listOf(
+            Level.WARN,
+            Level.ERROR
+        )) {
+            val loggingEvent = mockk<LoggingEvent> {
+                every { this@mockk.level }.returns(level)
+            }
+            assertEquals(FilterReply.DENY, filter.decide(loggingEvent))
+        }
+    }
+
+}

scalabot-extension/build.gradle.kts

@@ -40,14 +40,14 @@ tasks.withType<KotlinCompile> {
 publishing {
     repositories {
         if (project.version.toString().endsWith("-SNAPSHOT")) {
-            maven("https://repo.lamgc.moe/repository/maven-snapshots/") {
+            maven("https://nexus.kuku.me/repository/maven-snapshots/") {
                 credentials {
                     username = project.properties["repo.credentials.private.username"].toString()
                     password = project.properties["repo.credentials.private.password"].toString()
                 }
             }
         } else {
-            maven("https://repo.lamgc.moe/repository/maven-releases/") {
+            maven("https://nexus.kuku.me/repository/maven-releases/") {
                 credentials {
                     username = project.properties["repo.credentials.private.username"].toString()
                     password = project.properties["repo.credentials.private.password"].toString()