Custom detekt rule for logger usage check

Check if logger invocations don't use unoptimal invocations, eg.
concatenation `debug("a=" + a)` instead of lambda use `debug {"a=" + a}`

Unfortunately to avoid defining dependencies in many places and having
circural dependencies it was necessarry to reorganize the maven module
structure. The goal was to have `sources` module with production code and
`build` module with build-time tooling (detekt rules among them).

Issue-ID: DCAEGEN2-1002
Change-Id: I36e677b98972aaae6905d722597cbce5e863d201
Signed-off-by: Piotr Jaszczyk <piotr.jaszczyk@nokia.com>

5 files changed, 595 insertions, 0 deletions

diff --git a/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/arrow/CoreKtTest.kt b/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/arrow/CoreKtTest.kt
new file mode 100644
index 00000000..2eb11b27
--- /dev/null
+++ b/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/arrow/CoreKtTest.kt
@@ -0,0 +1,141 @@
+/*
+ * ============LICENSE_START=======================================================
+ * dcaegen2-collectors-veshv
+ * ================================================================================
+ * Copyright (C) 2018 NOKIA
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+package org.onap.dcae.collectors.veshv.utils.arrow
+
+import arrow.core.None
+import arrow.core.Option
+import arrow.core.Some
+import org.assertj.core.api.Assertions.assertThat
+import org.jetbrains.spek.api.Spek
+import org.jetbrains.spek.api.dsl.describe
+import org.jetbrains.spek.api.dsl.given
+import org.jetbrains.spek.api.dsl.it
+import org.jetbrains.spek.api.dsl.on
+import java.util.concurrent.atomic.AtomicReference
+
+
+/**
+ * @author Piotr Jaszczyk <piotr.jaszczyk></piotr.jaszczyk>@nokia.com>
+ * @since August 2018
+ */
+internal class CoreKtTest : Spek({
+    describe("AtomicReference.getOption") {
+        given("empty atomic reference") {
+            val atomicReference = AtomicReference<String>()
+
+            on("getOption") {
+                val result = atomicReference.getOption()
+
+                it("should be None") {
+                    assertThat(result).isEqualTo(None)
+                }
+            }
+        }
+        given("non-empty atomic reference") {
+            val initialValue = "reksio"
+            val atomicReference = AtomicReference(initialValue)
+
+            on("getOption") {
+                val result = atomicReference.getOption()
+
+                it("should be Some($initialValue)") {
+                    assertThat(result).isEqualTo(Some(initialValue))
+                }
+            }
+        }
+    }
+
+    describe("Option.fromNullablesChain") {
+        given("one non-null element") {
+            val just = "some text"
+            on("calling factory") {
+                val result = Option.fromNullablesChain(just)
+
+                it("should return Some($just)") {
+                    assertThat(result).isEqualTo(Some(just))
+                }
+            }
+        }
+
+        given("one null element") {
+            val just: String? = null
+            on("calling factory") {
+                val result = Option.fromNullablesChain(just)
+
+                it("should return None") {
+                    assertThat(result).isEqualTo(None)
+                }
+            }
+        }
+
+        given("first non-null element") {
+            val first = "some text"
+            val second: String? = null
+            var secondAskedForValue = false
+            on("calling factory") {
+                val result = Option.fromNullablesChain(first, { secondAskedForValue = true; second })
+
+                it("should return Some($first)") {
+                    assertThat(result).isEqualTo(Some(first))
+                }
+
+                it("should have not called second provider (should be lazy)") {
+                    assertThat(secondAskedForValue).isFalse()
+                }
+            }
+        }
+
+        given("two non-null elements") {
+            val first = "some text"
+            val second = "another text"
+            on("calling factory") {
+                val result = Option.fromNullablesChain(first, { second })
+
+                it("should return Some($first)") {
+                    assertThat(result).isEqualTo(Some(first))
+                }
+            }
+        }
+
+        given("two null elements") {
+            val first: String? = null
+            val second: String? = null
+            on("calling factory") {
+                val result = Option.fromNullablesChain(first, { second })
+
+                it("should return None") {
+                    assertThat(result).isEqualTo(None)
+                }
+            }
+        }
+
+        given("second non-null element") {
+            val first: String? = null
+            val second = "another text"
+            on("calling factory") {
+                val result = Option.fromNullablesChain(first, { second })
+
+                it("should return Some($second)") {
+                    assertThat(result).isEqualTo(Some(second))
+                }
+            }
+        }
+    }
+})
diff --git a/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/CommandLineOptionTest.kt b/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/CommandLineOptionTest.kt
new file mode 100644
index 00000000..f36df043
--- /dev/null
+++ b/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/CommandLineOptionTest.kt
@@ -0,0 +1,62 @@
+/*
+ * ============LICENSE_START=======================================================
+ * dcaegen2-collectors-veshv
+ * ================================================================================
+ * Copyright (C) 2018 NOKIA
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+package org.onap.dcae.collectors.veshv.utils.commandline
+
+import org.assertj.core.api.Assertions.assertThat
+import org.jetbrains.spek.api.Spek
+import org.jetbrains.spek.api.dsl.describe
+import org.jetbrains.spek.api.dsl.given
+import org.jetbrains.spek.api.dsl.it
+import org.jetbrains.spek.api.dsl.on
+
+/**
+ * @author Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
+ * @since September 2018
+ */
+class CommandLineOptionTest : Spek({
+    describe("command line options enum") {
+        describe("environment variables") {
+            given("sample option and prefix") {
+                val opt = CommandLineOption.KAFKA_SERVERS
+                val prefix = "CONFIG"
+
+                on("calling environmentVariableName") {
+                    val result = opt.environmentVariableName(prefix)
+
+                    it("should return prefixed upper snake cased long option name") {
+                        assertThat(result).isEqualTo("CONFIG_KAFKA_BOOTSTRAP_SERVERS")
+                    }
+                }
+            }
+
+            given("sample option without prefix") {
+                val opt = CommandLineOption.DUMMY_MODE
+
+                on("calling environmentVariableName") {
+                    val result = opt.environmentVariableName()
+
+                    it("should return prefixed upper snake cased long option name") {
+                        assertThat(result).isEqualTo("VESHV_DUMMY")
+                    }
+                }
+            }
+        }
+    }
+})
diff --git a/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/WrongArgumentErrorTest.kt b/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/WrongArgumentErrorTest.kt
new file mode 100644
index 00000000..63d9eb82
--- /dev/null
+++ b/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/WrongArgumentErrorTest.kt
@@ -0,0 +1,61 @@
+/*
+ * ============LICENSE_START=======================================================
+ * dcaegen2-collectors-veshv
+ * ================================================================================
+ * Copyright (C) 2018 NOKIA
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+package org.onap.dcae.collectors.veshv.utils.commandline
+
+import org.assertj.core.api.Assertions.assertThat
+import org.jetbrains.spek.api.Spek
+import org.jetbrains.spek.api.dsl.describe
+import org.jetbrains.spek.api.dsl.given
+import org.jetbrains.spek.api.dsl.it
+import org.jetbrains.spek.api.dsl.on
+import org.onap.dcae.collectors.veshv.utils.commandline.CommandLineOption.HEALTH_CHECK_API_PORT
+import org.onap.dcae.collectors.veshv.utils.commandline.CommandLineOption.LISTEN_PORT
+
+class WrongArgumentErrorTest : Spek ({
+
+    describe("help message logic test") {
+
+        given("at least one required option") {
+            val filledOptionList = listOf(
+                    HEALTH_CHECK_API_PORT,
+                    LISTEN_PORT)
+            on("help message preparation") {
+                val requiredParameters = WrongArgumentError.generateRequiredParametersNote(filledOptionList)
+
+                it("should print out required fields") {
+                    assertThat(requiredParameters).isEqualTo("Required parameters: p")
+                }
+            }
+        }
+
+        given("no required option") {
+            val filledOptionList = listOf(HEALTH_CHECK_API_PORT)
+
+            on("help message preparation") {
+                val requiredParameters = WrongArgumentError.generateRequiredParametersNote(filledOptionList)
+
+                it("should not print required fields") {
+                    assertThat(requiredParameters).isEqualTo("")
+                }
+            }
+        }
+    }
+
+})
\ No newline at end of file
diff --git a/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/http/ResponsesTest.kt b/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/http/ResponsesTest.kt
new file mode 100644
index 00000000..f9f716a1
--- /dev/null
+++ b/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/http/ResponsesTest.kt
@@ -0,0 +1,101 @@
+/*
+ * ============LICENSE_START=======================================================
+ * dcaegen2-collectors-veshv
+ * ================================================================================
+ * Copyright (C) 2018 NOKIA
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+package org.onap.dcae.collectors.veshv.utils.http
+
+import org.assertj.core.api.Assertions.assertThat
+import org.jetbrains.spek.api.Spek
+import org.jetbrains.spek.api.dsl.describe
+import org.jetbrains.spek.api.dsl.given
+import org.jetbrains.spek.api.dsl.it
+import org.jetbrains.spek.api.dsl.on
+import java.util.*
+import javax.json.JsonObject
+
+/**
+ * @author Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
+ * @since September 2018
+ */
+internal class ResponsesTest : Spek({
+    describe("response factory") {
+        describe("accepted response") {
+            given("uuid") {
+                val uuid = UUID.randomUUID()
+
+                on("calling acceptedResponse") {
+                    val result = Responses.acceptedResponse(uuid)
+
+                    it ("should have ACCEPTED status") {
+                        assertThat(result.status).isEqualTo(HttpStatus.ACCEPTED)
+                    }
+
+                    it ("should have text body") {
+                        assertThat(result.content.type).isEqualTo(ContentType.TEXT)
+                    }
+
+                    it ("should contain UUID text in the body") {
+                        val serialized = result.content.serializer.run { result.content.value.show() }
+                        assertThat(serialized).isEqualTo(uuid.toString())
+                    }
+                }
+            }
+        }
+        describe("status response") {
+            given("all params are specified") {
+                val status = "ok"
+                val message = "good job"
+                val httpStatus = HttpStatus.OK
+
+                on("calling statusResponse") {
+                    val result = Responses.statusResponse(status, message, httpStatus)
+                    val json = result.content.value as JsonObject
+
+                    it ("should have OK status") {
+                        assertThat(result.status).isEqualTo(HttpStatus.OK)
+                    }
+
+                    it ("should have json body") {
+                        assertThat(result.content.type).isEqualTo(ContentType.JSON)
+                    }
+
+                    it ("should contain status as string") {
+                        assertThat(json.getString("status")).isEqualTo(status)
+                    }
+
+                    it ("should contain message") {
+                        assertThat(json.getString("message")).isEqualTo(message)
+                    }
+                }
+            }
+
+            given("default params are omitted") {
+                val status = "ok"
+                val message = "good job"
+
+                on("calling statusResponse") {
+                    val result = Responses.statusResponse(status, message)
+
+                    it ("should have OK status") {
+                        assertThat(result.status).isEqualTo(HttpStatus.OK)
+                    }
+                }
+            }
+        }
+    }
+})
diff --git a/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/logging/LoggerTest.kt b/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/logging/LoggerTest.kt
new file mode 100644
index 00000000..c27fb8c8
--- /dev/null
+++ b/sources/hv-collector-utils/src/test/kotlin/org/onap/dcae/collectors/veshv/utils/logging/LoggerTest.kt
@@ -0,0 +1,230 @@
+/*
+ * ============LICENSE_START=======================================================
+ * dcaegen2-collectors-veshv
+ * ================================================================================
+ * Copyright (C) 2018 NOKIA
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+package org.onap.dcae.collectors.veshv.utils.logging
+
+import com.nhaarman.mockitokotlin2.mock
+import com.nhaarman.mockitokotlin2.verify
+import com.nhaarman.mockitokotlin2.verifyNoMoreInteractions
+import com.nhaarman.mockitokotlin2.whenever
+import org.jetbrains.spek.api.Spek
+import org.jetbrains.spek.api.dsl.describe
+import org.jetbrains.spek.api.dsl.it
+
+/**
+ * @author Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
+ * @since May 2018
+ */
+object LoggerTest : Spek({
+
+    lateinit var slf4jLogger: org.slf4j.Logger
+    lateinit var cut: Logger
+
+    beforeEachTest {
+        slf4jLogger = mock()
+        cut = Logger(slf4jLogger)
+    }
+
+    afterEachTest {
+        verifyNoMoreInteractions(slf4jLogger)
+    }
+
+    describe("Thin Kotlin logging facade for Slf4j") {
+        val message = "sample message"
+        val exception = Exception("fail")
+
+        describe("debug levels") {
+            it("should log message") {
+                cut.debug(message)
+                verify(slf4jLogger).debug(message)
+            }
+
+            it("should log message with exception") {
+                cut.debug(message, exception)
+                verify(slf4jLogger).debug(message, exception)
+            }
+
+            describe("lazy logging message") {
+
+                it("should log when debug is ON") {
+                    whenever(slf4jLogger.isDebugEnabled).thenReturn(true)
+                    cut.debug { message }
+                    verify(slf4jLogger).isDebugEnabled
+                    verify(slf4jLogger).debug(message)
+                }
+
+                it("should not log when debug is OFF") {
+                    whenever(slf4jLogger.isDebugEnabled).thenReturn(false)
+                    cut.debug { message }
+                    verify(slf4jLogger).isDebugEnabled
+                }
+            }
+
+            describe("lazy logging message with exception") {
+
+                it("should log when debug is ON") {
+                    whenever(slf4jLogger.isDebugEnabled).thenReturn(true)
+                    cut.debug(exception) { message }
+                    verify(slf4jLogger).isDebugEnabled
+                    verify(slf4jLogger).debug(message, exception)
+                }
+
+                it("should not log when debug is OFF") {
+                    whenever(slf4jLogger.isDebugEnabled).thenReturn(false)
+                    cut.debug(exception) { message }
+                    verify(slf4jLogger).isDebugEnabled
+                }
+            }
+        }
+
+        describe("info levels") {
+            it("should log message") {
+                cut.info(message)
+                verify(slf4jLogger).info(message)
+            }
+
+            it("should log message with exception") {
+                cut.info(message, exception)
+                verify(slf4jLogger).info(message, exception)
+            }
+
+            describe("lazy logging message") {
+
+                it("should log when debug is ON") {
+                    whenever(slf4jLogger.isInfoEnabled).thenReturn(true)
+                    cut.info { message }
+                    verify(slf4jLogger).isInfoEnabled
+                    verify(slf4jLogger).info(message)
+                }
+
+                it("should not log when debug is OFF") {
+                    whenever(slf4jLogger.isInfoEnabled).thenReturn(false)
+                    cut.info { message }
+                    verify(slf4jLogger).isInfoEnabled
+                }
+            }
+
+            describe("lazy logging message with exception") {
+
+                it("should log when debug is ON") {
+                    whenever(slf4jLogger.isInfoEnabled).thenReturn(true)
+                    cut.info(exception) { message }
+                    verify(slf4jLogger).isInfoEnabled
+                    verify(slf4jLogger).info(message, exception)
+                }
+
+                it("should not log when debug is OFF") {
+                    whenever(slf4jLogger.isInfoEnabled).thenReturn(false)
+                    cut.info(exception) { message }
+                    verify(slf4jLogger).isInfoEnabled
+                }
+            }
+        }
+
+        describe("warning levels") {
+            it("should log message") {
+                cut.warn(message)
+                verify(slf4jLogger).warn(message)
+            }
+
+            it("should log message with exception") {
+                cut.warn(message, exception)
+                verify(slf4jLogger).warn(message, exception)
+            }
+
+            describe("lazy logging message") {
+
+                it("should log when debug is ON") {
+                    whenever(slf4jLogger.isWarnEnabled).thenReturn(true)
+                    cut.warn { message }
+                    verify(slf4jLogger).isWarnEnabled
+                    verify(slf4jLogger).warn(message)
+                }
+
+                it("should not log when debug is OFF") {
+                    whenever(slf4jLogger.isWarnEnabled).thenReturn(false)
+                    cut.warn { message }
+                    verify(slf4jLogger).isWarnEnabled
+                }
+            }
+
+            describe("lazy logging message with exception") {
+
+                it("should log when debug is ON") {
+                    whenever(slf4jLogger.isWarnEnabled).thenReturn(true)
+                    cut.warn(exception) { message }
+                    verify(slf4jLogger).isWarnEnabled
+                    verify(slf4jLogger).warn(message, exception)
+                }
+
+                it("should not log when debug is OFF") {
+                    whenever(slf4jLogger.isWarnEnabled).thenReturn(false)
+                    cut.warn(exception) { message }
+                    verify(slf4jLogger).isWarnEnabled
+                }
+            }
+        }
+
+        describe("error levels") {
+            it("should log message") {
+                cut.error(message)
+                verify(slf4jLogger).error(message)
+            }
+
+            it("should log message with exception") {
+                cut.error(message, exception)
+                verify(slf4jLogger).error(message, exception)
+            }
+
+            describe("lazy logging message") {
+
+                it("should log when debug is ON") {
+                    whenever(slf4jLogger.isErrorEnabled).thenReturn(true)
+                    cut.error { message }
+                    verify(slf4jLogger).isErrorEnabled
+                    verify(slf4jLogger).error(message)
+                }
+
+                it("should not log when debug is OFF") {
+                    whenever(slf4jLogger.isErrorEnabled).thenReturn(false)
+                    cut.error { message }
+                    verify(slf4jLogger).isErrorEnabled
+                }
+            }
+
+            describe("lazy logging message with exception") {
+
+                it("should log when debug is ON") {
+                    whenever(slf4jLogger.isErrorEnabled).thenReturn(true)
+                    cut.error(exception) { message }
+                    verify(slf4jLogger).isErrorEnabled
+                    verify(slf4jLogger).error(message, exception)
+                }
+
+                it("should not log when debug is OFF") {
+                    whenever(slf4jLogger.isErrorEnabled).thenReturn(false)
+                    cut.error(exception) { message }
+                    verify(slf4jLogger).isErrorEnabled
+                }
+            }
+        }
+
+
+    }
+})