Merge pull request #173 from Drill4J/fix/remove-drill-prefix-for-api-…

…url-and-key-params feat: remove drill_ prefix for api_url and api_key parameters
Drill4J · Sep 5, 2024 · bfbd542 · bfbd542
2 parents 4da2b14 + 228d209
commit bfbd542
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 23 deletions.
diff --git a/java-agent/src/commonMain/kotlin/com/epam/drill/agent/configuration/ParameterDefinitions.kt b/java-agent/src/commonMain/kotlin/com/epam/drill/agent/configuration/ParameterDefinitions.kt
@@ -19,8 +19,8 @@ import com.epam.drill.common.agent.configuration.AgentParameterDefinition
 
 object ParameterDefinitions {
 
-    val DRILL_API_URL = AgentParameterDefinition.forString(name = "drillApiUrl", parser = { if (!it.endsWith("/")) "$it/" else it } )
-    val DRILL_API_KEY = AgentParameterDefinition.forString(name = "drillApiKey")
+    val API_URL = AgentParameterDefinition.forString(name = "apiUrl", parser = { if (!it.endsWith("/")) "$it/" else it } )
+    val API_KEY = AgentParameterDefinition.forString(name = "apiKey")
     val MESSAGE_QUEUE_LIMIT = AgentParameterDefinition.forString(name = "coverageRetentionLimit", defaultValue = "512Mb")
     val SSL_TRUSTSTORE = AgentParameterDefinition.forString(name = "sslTruststore")
     val SSL_TRUSTSTORE_PASSWORD = AgentParameterDefinition.forString(name = "sslTruststorePassword")

diff --git a/java-agent/src/jvmMain/kotlin/com/epam/drill/agent/transport/JvmModuleMessageSender.kt b/java-agent/src/jvmMain/kotlin/com/epam/drill/agent/transport/JvmModuleMessageSender.kt
@@ -43,8 +43,8 @@ actual object JvmModuleMessageSender : AgentMessageSender<AgentMessage> {
 
     private fun messageSender(): QueuedAgentMessageMetadataSender<AgentMessage, ByteArray> {
         val transport = HttpAgentMessageTransport(
-            Configuration.parameters[ParameterDefinitions.DRILL_API_URL],
-            Configuration.parameters[ParameterDefinitions.DRILL_API_KEY],
+            Configuration.parameters[ParameterDefinitions.API_URL],
+            Configuration.parameters[ParameterDefinitions.API_KEY],
             Configuration.parameters[ParameterDefinitions.SSL_TRUSTSTORE].takeIf(String::isNotEmpty)?.let(::resolvePath) ?: "",
             Configuration.parameters[ParameterDefinitions.SSL_TRUSTSTORE_PASSWORD]
         )

diff --git a/...t/src/nativeMain/kotlin/com/epam/drill/agent/configuration/ValidatedParametersProvider.kt b/...t/src/nativeMain/kotlin/com/epam/drill/agent/configuration/ValidatedParametersProvider.kt
@@ -41,8 +41,8 @@ class ValidatedParametersProvider(
         val packagePrefixes by provider
         val packagePrefixesAsList = packagePrefixes?.split(";") ?: emptyList()
         val drillInstallationDir by provider
-        val drillApiUrl by provider
-        val drillApiKey by provider
+        val apiUrl by provider
+        val apiKey by provider
         val logLevel by provider
         val logLevelAsList = logLevel?.split(";") ?: emptyList()
         val logLimit by provider
@@ -61,7 +61,7 @@ class ValidatedParametersProvider(
             identifier()
             minLength(3)
         }
-        ValidatingParameters::drillApiUrl required {
+        ValidatingParameters::apiUrl required {
             validTransportUrl()
         }
         ValidatingParameters::packagePrefixesAsList {
@@ -79,7 +79,7 @@ class ValidatedParametersProvider(
         ValidatingParameters::commitSha ifPresent {
             pattern("^[a-f0-9]{40}\$") hint "must be a valid full commit SHA"
         }
-        ValidatingParameters::drillApiKey ifPresent {
+        ValidatingParameters::apiKey ifPresent {
             minLength(1)
         }
         ValidatingParameters::logLevelAsList onEach {

diff --git a/java-agent/src/nativeMain/kotlin/com/epam/drill/agent/request/HeadersRetriever.kt b/java-agent/src/nativeMain/kotlin/com/epam/drill/agent/request/HeadersRetriever.kt
@@ -21,7 +21,7 @@ import com.epam.drill.common.agent.request.HeadersRetriever
 
 actual object HeadersRetriever : HeadersRetriever {
 
-    private val adminAddress = Configuration.parameters[ParameterDefinitions.DRILL_API_URL]
+    private val adminAddress = Configuration.parameters[ParameterDefinitions.API_URL]
 
     private val agentIdHeader = Configuration.agentMetadata.groupId.takeIf(String::isNotEmpty)
         ?.let { "drill-group-id" to Configuration.agentMetadata.groupId }

diff --git a/...c/nativeTest/kotlin/com/epam/drill/agent/configuration/ValidatedParametersProviderTest.kt b/...c/nativeTest/kotlin/com/epam/drill/agent/configuration/ValidatedParametersProviderTest.kt
@@ -46,7 +46,7 @@ class ValidatedParametersProviderTest {
         assertEquals("1.0.0", result[DefaultParameterDefinitions.BUILD_VERSION.name])
         assertEquals("foo/bar", result[DefaultParameterDefinitions.PACKAGE_PREFIXES.name])
         assertEquals("/data/agent", result[DefaultParameterDefinitions.INSTALLATION_DIR.name])
-        assertEquals("https://localhost/api", result[ParameterDefinitions.DRILL_API_URL.name])
+        assertEquals("https://localhost/api", result[ParameterDefinitions.API_URL.name])
     }
 
     @Test
@@ -63,7 +63,7 @@ class ValidatedParametersProviderTest {
         assertEquals("1.0.0", result[DefaultParameterDefinitions.BUILD_VERSION.name])
         assertEquals("foo/bar", result[DefaultParameterDefinitions.PACKAGE_PREFIXES.name])
         assertEquals("/data/agent", result[DefaultParameterDefinitions.INSTALLATION_DIR.name])
-        assertEquals("https://localhost/api", result[ParameterDefinitions.DRILL_API_URL.name])
+        assertEquals("https://localhost/api", result[ParameterDefinitions.API_URL.name])
     }
 
     @Test
@@ -80,7 +80,7 @@ class ValidatedParametersProviderTest {
         val woPackages = defaultParameters().also { it.remove(DefaultParameterDefinitions.PACKAGE_PREFIXES.name) }
         val woInstallationDir =
             defaultParameters().also { it.remove(DefaultParameterDefinitions.INSTALLATION_DIR.name) }
-        val woAdminAddress = defaultParameters().also { it.remove(ParameterDefinitions.DRILL_API_URL.name) }
+        val woAdminAddress = defaultParameters().also { it.remove(ParameterDefinitions.API_URL.name) }
         runCatching { ValidatedParametersProvider(setOf(SimpleMapProvider(woAgentId))).configuration }
             .onFailure { e = it }
             .onSuccess { e = null }
@@ -138,17 +138,17 @@ class ValidatedParametersProviderTest {
     }
 
     @Test
-    fun `given correct URL validate drillApiUrl should be valid`() {
-        assertTrue(isValid(mapOf(ParameterDefinitions.DRILL_API_URL.name to "https://example.com")))
-        assertTrue(isValid(mapOf(ParameterDefinitions.DRILL_API_URL.name to "https://example.com/api")))
-        assertTrue(isValid(mapOf(ParameterDefinitions.DRILL_API_URL.name to "http://localhost:8090")))
-        assertTrue(isValid(mapOf(ParameterDefinitions.DRILL_API_URL.name to "http://localhost:8090/api")))
+    fun `given correct URL validate apiUrl should be valid`() {
+        assertTrue(isValid(mapOf(ParameterDefinitions.API_URL.name to "https://example.com")))
+        assertTrue(isValid(mapOf(ParameterDefinitions.API_URL.name to "https://example.com/api")))
+        assertTrue(isValid(mapOf(ParameterDefinitions.API_URL.name to "http://localhost:8090")))
+        assertTrue(isValid(mapOf(ParameterDefinitions.API_URL.name to "http://localhost:8090/api")))
     }
 
     @Test
-    fun `given incorrect URL validate drillApiUrl should not be valid`() {
-        assertFalse(isValid(mapOf(ParameterDefinitions.DRILL_API_URL.name to "localhost:8090")))
-        assertFalse(isValid(mapOf(ParameterDefinitions.DRILL_API_URL.name to "//localhost")))
+    fun `given incorrect URL validate apiUrl should not be valid`() {
+        assertFalse(isValid(mapOf(ParameterDefinitions.API_URL.name to "localhost:8090")))
+        assertFalse(isValid(mapOf(ParameterDefinitions.API_URL.name to "//localhost")))
     }
 
     private fun isValid(params: Map<String, String>): Boolean {
@@ -163,15 +163,15 @@ class ValidatedParametersProviderTest {
         DefaultParameterDefinitions.BUILD_VERSION.name to "1.0.0",
         DefaultParameterDefinitions.PACKAGE_PREFIXES.name to "foo/bar",
         DefaultParameterDefinitions.INSTALLATION_DIR.name to "/data/agent",
-        ParameterDefinitions.DRILL_API_URL.name to "https://localhost/api",
-        ParameterDefinitions.DRILL_API_KEY.name to "apikey",
+        ParameterDefinitions.API_URL.name to "https://localhost/api",
+        ParameterDefinitions.API_KEY.name to "apikey",
     )
 
     private fun strictParameters() = mutableMapOf(
         DefaultParameterDefinitions.GROUP_ID.name to "group-id",
         DefaultParameterDefinitions.APP_ID.name to "agent-id",
         DefaultParameterDefinitions.PACKAGE_PREFIXES.name to "foo/bar",
-        ParameterDefinitions.DRILL_API_URL.name to "https://localhost/api",
+        ParameterDefinitions.API_URL.name to "https://localhost/api",
         DefaultParameterDefinitions.INSTALLATION_DIR.name to "/data/agent",
     )