feat(metrics): 运行指标服务端支持设置 HTTP 认证.

支持对运行指标服务端设置 HTTP 认证, 以防止运行指标被非法获取.
2025-07-03 05:47:24 +00:00 · 2022-06-18 09:20:46 +08:00
parent c5fe96c02d
commit 215a4670db
4 changed files with 187 additions and 7 deletions
--- a/scalabot-app/src/test/kotlin/util/UsernameAuthenticatorTest.kt
+++ b/scalabot-app/src/test/kotlin/util/UsernameAuthenticatorTest.kt
@ -0,0 +1,114 @@
+package net.lamgc.scalabot.util
+
+import com.google.gson.*
+import org.junit.jupiter.api.assertThrows
+import kotlin.test.*
+
+class UsernameAuthenticatorTest {
+
+    @Test
+    fun checkCredentialsTest() {
+        val authenticator = UsernameAuthenticator("testUser", "testPassword")
+        assertTrue(authenticator.checkCredentials("testUser", "testPassword"))
+        assertFalse(authenticator.checkCredentials("falseUser", "testPassword"))
+        assertFalse(authenticator.checkCredentials("testUser", "falsePassword"))
+    }
+
+    @Test
+    fun toJsonObjectTest() {
+        val authenticator = UsernameAuthenticator("testUser", "testPassword")
+        val jsonObject = authenticator.toJsonObject()
+        assertEquals("testUser", jsonObject["username"]?.asString)
+        assertEquals("testPassword", jsonObject["password"]?.asString)
+    }
+
+    @Test
+    fun equalsTest() {
+        val authenticator = UsernameAuthenticator("testUser", "testPassword")
+        assertEquals(authenticator, UsernameAuthenticator("testUser", "testPassword"))
+        assertEquals(authenticator.hashCode(), UsernameAuthenticator("testUser", "testPassword").hashCode())
+        assertNotEquals(authenticator, UsernameAuthenticator("testUser", "falsePassword"))
+        assertNotEquals(authenticator.hashCode(), UsernameAuthenticator("testUser", "falsePassword").hashCode())
+        assertNotEquals(authenticator, UsernameAuthenticator("falseUser", "testPassword"))
+        assertNotEquals(authenticator.hashCode(), UsernameAuthenticator("falseUser", "testPassword").hashCode())
+        assertNotEquals(authenticator, UsernameAuthenticator("falseUser", "falsePassword"))
+        assertNotEquals(authenticator.hashCode(), UsernameAuthenticator("falseUser", "falsePassword").hashCode())
+        assertFalse(authenticator.equals(null))
+    }
+
+}
+
+class UsernameAuthenticatorSerializerTest {
+
+    @Test
+    fun serializeTest() {
+        val authenticator = UsernameAuthenticator("testUser", "testPassword")
+        val jsonElement = UsernameAuthenticatorSerializer.serialize(authenticator, null, null)
+        assertTrue(jsonElement.isJsonObject)
+        val jsonObject = jsonElement.asJsonObject
+        assertEquals("testUser", jsonObject["username"]?.asString)
+        assertEquals("testPassword", jsonObject["password"]?.asString)
+    }
+
+    @Test
+    fun deserializeTest() {
+        assertThrows<JsonParseException> {
+            UsernameAuthenticatorSerializer.deserialize(JsonArray(), null, null)
+        }
+        assertThrows<JsonParseException> {
+            UsernameAuthenticatorSerializer.deserialize(JsonPrimitive(""), null, null)
+        }
+        assertNull(UsernameAuthenticatorSerializer.deserialize(JsonNull.INSTANCE, null, null))
+        assertThrows<JsonParseException> {
+            UsernameAuthenticatorSerializer.deserialize(JsonObject().apply {
+                addProperty("username", "testUser")
+            }, null, null)
+        }
+        assertThrows<JsonParseException> {
+            UsernameAuthenticatorSerializer.deserialize(JsonObject().apply {
+                addProperty("username", "testUser")
+                add("password", JsonArray())
+            }, null, null)
+        }
+        assertThrows<JsonParseException> {
+            UsernameAuthenticatorSerializer.deserialize(JsonObject().apply {
+                addProperty("password", "testPassword")
+            }, null, null)
+        }
+        assertThrows<JsonParseException> {
+            UsernameAuthenticatorSerializer.deserialize(JsonObject().apply {
+                add("username", JsonArray())
+                addProperty("password", "testPassword")
+            }, null, null)
+        }
+        assertThrows<JsonParseException> {
+            UsernameAuthenticatorSerializer.deserialize(JsonObject().apply {
+                addProperty("username", "")
+                addProperty("password", "")
+            }, null, null)
+        }
+        assertThrows<JsonParseException> {
+            UsernameAuthenticatorSerializer.deserialize(JsonObject().apply {
+                addProperty("username", "testUser")
+                addProperty("password", "")
+            }, null, null)
+        }
+        assertThrows<JsonParseException> {
+            UsernameAuthenticatorSerializer.deserialize(JsonObject().apply {
+                addProperty("username", "")
+                addProperty("password", "testPassword")
+            }, null, null)
+        }
+
+        val authenticator = UsernameAuthenticatorSerializer.deserialize(JsonObject().apply {
+            addProperty("username", "testUser")
+            addProperty("password", "testPassword")
+        }, null, null)
+        assertNotNull(authenticator)
+
+        assertTrue(authenticator.checkCredentials("testUser", "testPassword"))
+        assertFalse(authenticator.checkCredentials("falseUser", "testPassword"))
+        assertFalse(authenticator.checkCredentials("testUser", "falsePassword"))
+    }
+
+}