refs #256: Add Ktlint and Detekt for Kotlin code (#267)

Author: JaidenAshmore

build.gradle.kts

@@ -1,13 +1,18 @@
 import com.jashmore.gradle.JacocoCoverallsPlugin
 import com.jashmore.gradle.ReleasePlugin
 import com.jashmore.gradle.release
+import io.gitlab.arturbosch.detekt.detekt
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
     java
     `java-library`
     id("com.github.spotbugs") version "4.4.5"
     checkstyle
     jacoco
+    kotlin("jvm") version "1.3.72" apply false
+    id("org.jlleitschuh.gradle.ktlint") apply false
+    id("io.gitlab.arturbosch.detekt") version "1.10.0" apply false
 }
 
 allprojects {
@@ -16,6 +21,7 @@ allprojects {
 
     repositories {
         mavenCentral()
+        jcenter()
     }
 }
 
@@ -26,6 +32,14 @@ subprojects {
     if (!isKotlinProject) {
         apply(plugin = "com.github.spotbugs")
         apply(plugin = "checkstyle")
+    } else {
+        apply(plugin = "kotlin")
+        apply(plugin = "org.jlleitschuh.gradle.ktlint")
+        apply(plugin = "io.gitlab.arturbosch.detekt")
+
+        tasks.withType<KotlinCompile>().configureEach {
+            kotlinOptions.jvmTarget = "1.8"
+        }
     }
 
     dependencies {
@@ -115,6 +129,12 @@ subprojects {
         spotbugs {
             excludeFilter.set(file("${project.rootDir}/configuration/spotbugs/bugsExcludeFilter.xml"))
         }
+    } else {
+        detekt {
+            failFast = true
+            buildUponDefaultConfig = true
+            config = files("${project.rootDir}/configuration/detekt/detekt-configuration.yml")
+        }
     }
 
     tasks.withType<Test> {
@@ -150,7 +170,7 @@ subprojects {
         violationRules {
             rule {
                 excludes = listOf(
-                        "com.jashmore.sqs.examples*"
+                    "com.jashmore.sqs.examples*"
                 )
                 element = "PACKAGE"
                 limit {

configuration/detekt/detekt-configuration.yml

@@ -0,0 +1,7 @@
+formatting:
+  MaximumLineLength:
+    maxLineLength: 160
+
+style:
+  MaxLineLength:
+    maxLineLength: 160

examples/core-kotlin-example/build.gradle.kts

@@ -1,13 +1,6 @@
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 description = "Example of using the Core library with the Kotlin DSL, this should be equivalent to the core-examples."
 
-plugins {
-    kotlin("jvm") version "1.3.72"
-}
-
-apply(plugin = "kotlin")
-
 dependencies {
     implementation(kotlin("stdlib-jdk8"))
     implementation(project(":java-dynamic-sqs-listener-core"))
@@ -21,10 +14,6 @@ dependencies {
     implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
 }
 
-tasks.withType<KotlinCompile>().configureEach {
-    kotlinOptions.jvmTarget = "1.8"
-}
-
 tasks.create<JavaExec>("runApp") {
     classpath = sourceSets.main.get().runtimeClasspath
 

examples/core-kotlin-example/src/main/kotlin/com/jashmore/sqs/examples/KotlinConcurrentBrokerExample.kt

@@ -1,4 +1,5 @@
 @file:JvmName("KotlinConcurrentBrokerExample")
+@file:Suppress("MatchingDeclarationName", "MagicNumber")
 package com.jashmore.sqs.examples
 
 import brave.Tracing
@@ -25,8 +26,8 @@ import java.util.concurrent.atomic.AtomicInteger
 import kotlin.random.Random
 
 private val log: Logger = LoggerFactory.getLogger("example")
-private val concurrencyLevelPeriod = Duration.ofSeconds(5)
-private const val concurrencyLimit = 10
+private val CONCURRENCY_LEVEL_PERIOD = Duration.ofSeconds(5)
+private const val CONCURRENCY_LIMIT = 10
 
 private val objectMapper = ObjectMapper().registerModule(KotlinModule())
 
@@ -40,26 +41,28 @@ private val objectMapper = ObjectMapper().registerModule(KotlinModule())
  * <p>While this is running you should see the messages being processed and the number of messages that are concurrently being processed. This will highlight
  * how the concurrency can change during the running of the application.
  */
+@Suppress("LongMethod")
 fun main() {
     val sqsAsyncClient = ElasticMqSqsAsyncClient()
     val queueUrl = sqsAsyncClient.createRandomQueue()
-            .get()
-            .queueUrl()
+        .get()
+        .queueUrl()
 
     val tracing = Tracing.newBuilder()
-            .currentTraceContext(ThreadLocalCurrentTraceContext.newBuilder()
-                    .addScopeDecorator(MDCScopeDecorator.get())
-                    .build()
-            )
-            .build()
+        .currentTraceContext(
+            ThreadLocalCurrentTraceContext.newBuilder()
+                .addScopeDecorator(MDCScopeDecorator.get())
+                .build()
+        )
+        .build()
     tracing.isNoop = true
 
     val container = coreMessageListener("core-example-container", sqsAsyncClient, queueUrl) {
         broker = concurrentBroker {
             concurrencyLevel = cached(Duration.ofSeconds(10)) {
-                Random.nextInt(concurrencyLimit)
+                Random.nextInt(CONCURRENCY_LIMIT)
             }
-            concurrencyPollingRate = { concurrencyLevelPeriod }
+            concurrencyPollingRate = { CONCURRENCY_LEVEL_PERIOD }
             errorBackoffTime = { Duration.ofMillis(500) }
         }
         retriever = prefetchingMessageRetriever {
@@ -84,19 +87,24 @@ fun main() {
 
     val count = AtomicInteger(0)
     val scheduledExecutorService = Executors.newScheduledThreadPool(1)
-    scheduledExecutorService.scheduleAtFixedRate({
-        sqsAsyncClient.sendMessageBatch { batchBuilder ->
-            batchBuilder.queueUrl(queueUrl)
-                    .entries((0..9).map { index ->
-                        val request = Request("key_${count.getAndIncrement()}")
-                        SendMessageBatchRequestEntry.builder()
+    scheduledExecutorService.scheduleAtFixedRate(
+        {
+            sqsAsyncClient.sendMessageBatch { batchBuilder ->
+                batchBuilder.queueUrl(queueUrl)
+                    .entries(
+                        (0..9).map { index ->
+                            val request = Request("key_${count.getAndIncrement()}")
+                            SendMessageBatchRequestEntry.builder()
                                 .id("$index")
                                 .messageBody(objectMapper.writeValueAsString(request))
                                 .build()
-                    })
-        }
-        log.info("Put 10 messages onto queue")
-    }, 0, 2, TimeUnit.SECONDS)
+                        }
+                    )
+            }
+            log.info("Put 10 messages onto queue")
+        },
+        0, 2, TimeUnit.SECONDS
+    )
 
     log.info("Running application for 3 minutes. Ctrl + C to exit...")
     Thread.sleep(3 * 60 * 1000.toLong())

examples/ktor-example/build.gradle.kts

@@ -1,17 +1,6 @@
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 description = "Contains examples for connection to SQS in an Ktor Application"
 
-plugins {
-    kotlin("jvm") version "1.3.72"
-}
-
-repositories {
-    jcenter()
-}
-
-apply(plugin = "kotlin")
-
 dependencies {
     implementation(project(":java-dynamic-sqs-listener-core"))
     implementation(project(":core-kotlin-dsl"))
@@ -22,10 +11,6 @@ dependencies {
     implementation("ch.qos.logback:logback-classic")
 }
 
-tasks.withType<KotlinCompile>().configureEach {
-    kotlinOptions.jvmTarget = "1.8"
-}
-
 tasks.create<JavaExec>("runApp") {
     classpath = sourceSets.main.get().runtimeClasspath
 

examples/ktor-example/src/main/kotlin/com/jashmore/sqs/examples/KtorApplicationExample.kt

@@ -1,4 +1,5 @@
 @file:JvmName("KtorApplicationExample")
+@file:Suppress("MagicNumber")
 package com.jashmore.sqs.examples
 
 import com.jashmore.sqs.container.MessageListenerContainer
@@ -24,6 +25,7 @@ import kotlinx.coroutines.launch
 import software.amazon.awssdk.services.sqs.model.Message
 import java.time.Duration
 
+@Suppress("LongMethod", "ComplexMethod")
 fun main() {
     val sqsAsyncClient = ElasticMqSqsAsyncClient()
 
@@ -66,7 +68,7 @@ fun main() {
         val thirdContainer = batchingMessageListener("batching-listener", sqsAsyncClient, thirdQueueUrl) {
             concurrencyLevel = { 2 }
             batchSize = { 5 }
-            batchingPeriod =  { Duration.ofSeconds(5) }
+            batchingPeriod = { Duration.ofSeconds(5) }
 
             processor = asyncLambdaProcessor {
                 method { message ->
@@ -116,10 +118,9 @@ fun main() {
 
                 container.start()
 
-                call.respondText("Container ${queueIdentifier} started", ContentType.Text.Html)
+                call.respondText("Container $queueIdentifier started", ContentType.Text.Html)
             }
 
-
             get("/stop/{queue}") {
                 val queueIdentifier = call.parameters["queue"]
                 val container: MessageListenerContainer? = when (queueIdentifier) {
@@ -136,14 +137,16 @@ fun main() {
 
                 container.stop()
 
-                call.respondText("Container ${queueIdentifier} stopped", ContentType.Text.Html)
+                call.respondText("Container $queueIdentifier stopped", ContentType.Text.Html)
             }
         }
     }
     server.start()
-    Runtime.getRuntime().addShutdownHook(Thread {
-        server.stop(1, 30_000)
-    })
+    Runtime.getRuntime().addShutdownHook(
+        Thread {
+            server.stop(1, 30_000)
+        }
+    )
     Thread.currentThread().join()
 }
 

extensions/core-kotlin-dsl/build.gradle.kts

@@ -1,13 +1,5 @@
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 description = "Kotlin DSL for building the Core message listeners"
 
-plugins {
-    kotlin("jvm") version "1.3.72"
-}
-
-apply(plugin = "kotlin")
-
 dependencies {
     implementation(kotlin("stdlib-jdk8"))
     api(project(":java-dynamic-sqs-listener-core"))
@@ -17,7 +9,3 @@ dependencies {
     testImplementation("com.nhaarman.mockitokotlin2:mockito-kotlin:2.2.0")
     testImplementation("com.fasterxml.jackson.module:jackson-module-kotlin")
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    kotlinOptions.jvmTarget = "1.8"
-}

extensions/core-kotlin-dsl/src/main/kotlin/com/jashmore/sqs/core/kotlin/dsl/MessageListenerDsl.kt

@@ -1,3 +1,4 @@
+@file:Suppress("MatchingDeclarationName")
 package com.jashmore.sqs.core.kotlin.dsl
 
 import com.jashmore.sqs.argument.ArgumentResolverService

extensions/core-kotlin-dsl/src/main/kotlin/com/jashmore/sqs/core/kotlin/dsl/argument/CoreArgumentResolverServiceDslBuilder.kt

@@ -17,8 +17,8 @@ class CoreArgumentResolverServiceDslBuilder(private val objectMapper: ObjectMapp
 
     override fun invoke(): ArgumentResolverService {
         return CoreArgumentResolverService(
-                JacksonPayloadMapper(objectMapper),
-                objectMapper
+            JacksonPayloadMapper(objectMapper),
+            objectMapper
         )
     }
 }
@@ -33,5 +33,5 @@ class CoreArgumentResolverServiceDslBuilder(private val objectMapper: ObjectMapp
  *
  * @param init the DSL function for configuring this processor
  */
-fun coreArgumentResolverService(objectMapper: ObjectMapper = ObjectMapper(), init: CoreArgumentResolverServiceDslBuilder.() -> Unit = { })
-        = initComponent(CoreArgumentResolverServiceDslBuilder(objectMapper), init)
+fun coreArgumentResolverService(objectMapper: ObjectMapper = ObjectMapper(), init: CoreArgumentResolverServiceDslBuilder.() -> Unit = { }) =
+    initComponent(CoreArgumentResolverServiceDslBuilder(objectMapper), init)

extensions/core-kotlin-dsl/src/main/kotlin/com/jashmore/sqs/core/kotlin/dsl/argument/DelegatingArgumentResolverServiceDslBuilder.kt

@@ -1,9 +1,6 @@
 package com.jashmore.sqs.core.kotlin.dsl.argument
 
 import com.fasterxml.jackson.databind.ObjectMapper
-import com.jashmore.sqs.core.kotlin.dsl.ArgumentResolverServiceDslBuilder
-import com.jashmore.sqs.core.kotlin.dsl.MessageListenerComponentDslMarker
-import com.jashmore.sqs.core.kotlin.dsl.initComponent
 import com.jashmore.sqs.argument.ArgumentResolver
 import com.jashmore.sqs.argument.ArgumentResolverService
 import com.jashmore.sqs.argument.DelegatingArgumentResolverService
@@ -13,6 +10,9 @@ import com.jashmore.sqs.argument.message.MessageArgumentResolver
 import com.jashmore.sqs.argument.messageid.MessageIdArgumentResolver
 import com.jashmore.sqs.argument.payload.PayloadArgumentResolver
 import com.jashmore.sqs.argument.payload.mapper.JacksonPayloadMapper
+import com.jashmore.sqs.core.kotlin.dsl.ArgumentResolverServiceDslBuilder
+import com.jashmore.sqs.core.kotlin.dsl.MessageListenerComponentDslMarker
+import com.jashmore.sqs.core.kotlin.dsl.initComponent
 import com.jashmore.sqs.processor.MessageProcessor
 
 /**
@@ -73,7 +73,7 @@ class DelegatingArgumentResolverServiceDslBuilder : ArgumentResolverServiceDslBu
 
     override fun invoke(): ArgumentResolverService {
         return DelegatingArgumentResolverService(
-                argumentResolvers
+            argumentResolvers
         )
     }
 }
@@ -91,5 +91,5 @@ class DelegatingArgumentResolverServiceDslBuilder : ArgumentResolverServiceDslBu
  *
  * @param init the DSL function for configuring this processor
  */
-fun delegatingArgumentResolverService(init: DelegatingArgumentResolverServiceDslBuilder.() -> Unit)
-        = initComponent(DelegatingArgumentResolverServiceDslBuilder(), init)
+fun delegatingArgumentResolverService(init: DelegatingArgumentResolverServiceDslBuilder.() -> Unit) =
+    initComponent(DelegatingArgumentResolverServiceDslBuilder(), init)