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>

3 files changed, 417 insertions, 0 deletions

diff --git a/sources/hv-collector-main/src/test/kotlin/org/onap/dcae/collectors/veshv/main/ArgVesHvConfigurationTest.kt b/sources/hv-collector-main/src/test/kotlin/org/onap/dcae/collectors/veshv/main/ArgVesHvConfigurationTest.kt
new file mode 100644
index 00000000..1aac6a09
--- /dev/null
+++ b/sources/hv-collector-main/src/test/kotlin/org/onap/dcae/collectors/veshv/main/ArgVesHvConfigurationTest.kt
@@ -0,0 +1,138 @@
+/*
+ * ============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.main
+
+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.domain.JdkKeys
+import org.onap.dcae.collectors.veshv.model.ServerConfiguration
+import org.onap.dcae.collectors.veshv.tests.utils.parseExpectingFailure
+import org.onap.dcae.collectors.veshv.tests.utils.parseExpectingSuccess
+import org.onap.dcae.collectors.veshv.utils.commandline.WrongArgumentError
+import java.time.Duration
+import kotlin.test.assertNotNull
+
+/**
+ * @author Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
+ * @since May 2018
+ */
+object ArgVesHvConfigurationTest : Spek({
+    lateinit var cut: ArgVesHvConfiguration
+    val healthCheckApiPort = "6070"
+    val configurationUrl = "http://test-address/test"
+    val firstRequestDelay = "10"
+    val requestInterval = "5"
+    val listenPort = "6969"
+    val keyStorePassword = "kspass"
+    val trustStorePassword = "tspass"
+
+    beforeEachTest {
+        cut = ArgVesHvConfiguration()
+    }
+
+    describe("parsing arguments") {
+        given("all parameters are present in the long form") {
+            lateinit var result: ServerConfiguration
+
+            beforeEachTest {
+                result = cut.parseExpectingSuccess(
+                        "--health-check-api-port", healthCheckApiPort,
+                        "--listen-port", listenPort,
+                        "--config-url", configurationUrl,
+                        "--first-request-delay", firstRequestDelay,
+                        "--request-interval", requestInterval,
+                        "--key-store", "/tmp/keys.p12",
+                        "--trust-store", "/tmp/trust.p12",
+                        "--key-store-password", keyStorePassword,
+                        "--trust-store-password", trustStorePassword
+                )
+            }
+
+            it("should set proper listen port") {
+                assertThat(result.serverListenAddress.port).isEqualTo(listenPort.toInt())
+            }
+
+
+            it("should set default listen address") {
+                assertThat(result.serverListenAddress.address.hostAddress).isEqualTo("0.0.0.0")
+            }
+
+            it("should set proper health check api port") {
+                assertThat(result.healthCheckApiListenAddress.port).isEqualTo(healthCheckApiPort.toInt())
+            }
+
+            it("should set default health check api address") {
+                assertThat(result.healthCheckApiListenAddress.address.hostAddress).isEqualTo("0.0.0.0")
+            }
+
+            it("should set proper first consul request delay") {
+                assertThat(result.configurationProviderParams.firstRequestDelay)
+                        .isEqualTo(Duration.ofSeconds(firstRequestDelay.toLong()))
+            }
+
+            it("should set proper consul request interval") {
+                assertThat(result.configurationProviderParams.requestInterval)
+                        .isEqualTo(Duration.ofSeconds(requestInterval.toLong()))
+            }
+
+            it("should set proper config url") {
+                assertThat(result.configurationProviderParams.configurationUrl)
+                        .isEqualTo(configurationUrl)
+            }
+
+            it("should set proper security configuration") {
+                assertThat(result.securityConfiguration.sslDisable).isFalse()
+
+                val keys = result.securityConfiguration.keys.orNull() as JdkKeys
+                assertNotNull(keys.keyStore)
+                assertNotNull(keys.trustStore)
+                assertThat(keys.keyStorePassword).isEqualTo(keyStorePassword.toCharArray())
+                assertThat(keys.trustStorePassword).isEqualTo(trustStorePassword.toCharArray())
+            }
+        }
+
+        describe("required parameter is absent") {
+            on("missing listen port") {
+                it("should throw exception") {
+                    assertThat(cut.parseExpectingFailure(
+                            "--config-url", configurationUrl,
+                            "--ssl-disable",
+                            "--first-request-delay", firstRequestDelay,
+                            "--request-interval", requestInterval)
+                    ).isInstanceOf(WrongArgumentError::class.java)
+                }
+            }
+            on("missing configuration url") {
+                it("should throw exception") {
+                    assertThat(cut.parseExpectingFailure(
+                            "--listen-port", listenPort,
+                            "--ssl-disable",
+                            "--first-request-delay", firstRequestDelay,
+                            "--request-interval", requestInterval)
+                    ).isInstanceOf(WrongArgumentError::class.java)
+                }
+            }
+        }
+    }
+})
\ No newline at end of file
diff --git a/sources/hv-collector-main/src/test/kotlin/org/onap/dcae/collectors/veshv/main/MicrometerMetricsTest.kt b/sources/hv-collector-main/src/test/kotlin/org/onap/dcae/collectors/veshv/main/MicrometerMetricsTest.kt
new file mode 100644
index 00000000..a379933e
--- /dev/null
+++ b/sources/hv-collector-main/src/test/kotlin/org/onap/dcae/collectors/veshv/main/MicrometerMetricsTest.kt
@@ -0,0 +1,191 @@
+/*
+ * ============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.main
+
+import arrow.core.Try
+import io.micrometer.core.instrument.Counter
+import io.micrometer.core.instrument.Gauge
+import io.micrometer.core.instrument.search.RequiredSearch
+import io.micrometer.core.instrument.simple.SimpleMeterRegistry
+import org.assertj.core.api.Assertions.assertThat
+import org.assertj.core.data.Percentage
+import org.jetbrains.spek.api.Spek
+import org.jetbrains.spek.api.dsl.describe
+import org.jetbrains.spek.api.dsl.it
+import org.jetbrains.spek.api.dsl.on
+
+/**
+ * @author Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
+ * @since June 2018
+ */
+object MicrometerMetricsTest : Spek({
+    val doublePrecision = Percentage.withPercentage(0.5)
+    lateinit var registry: SimpleMeterRegistry
+    lateinit var cut: MicrometerMetrics
+
+    beforeEachTest {
+        registry = SimpleMeterRegistry()
+        cut = MicrometerMetrics(registry)
+    }
+
+    fun registrySearch() = RequiredSearch.`in`(registry)
+
+    fun <M, T> verifyMeter(search: RequiredSearch, map: (RequiredSearch) -> M, verifier: (M) -> T) =
+            Try {
+                map(search)
+            }.fold(
+                    { ex -> assertThat(ex).doesNotThrowAnyException() },
+                    verifier
+            )
+
+    fun <T> verifyGauge(name: String, verifier: (Gauge) -> T) =
+            verifyMeter(registrySearch().name(name), RequiredSearch::gauge, verifier)
+
+    fun <T> verifyCounter(search: RequiredSearch, verifier: (Counter) -> T) =
+            verifyMeter(search, RequiredSearch::counter, verifier)
+
+    fun <T> verifyCounter(name: String, verifier: (Counter) -> T) =
+            verifyCounter(registrySearch().name(name), verifier)
+
+    fun verifyAllCountersAreUnchangedBut(vararg changedCounters: String) {
+        registry.meters
+                .filter { it is Counter }
+                .filterNot { it.id.name in changedCounters }
+                .forEach { assertThat((it as Counter).count()).isCloseTo(0.0, doublePrecision) }
+    }
+
+    describe("notifyBytesReceived") {
+
+        on("data.received.bytes counter") {
+            val counterName = "data.received.bytes"
+
+            it("should increment counter") {
+                val bytes = 128
+                cut.notifyBytesReceived(bytes)
+
+                verifyCounter(counterName) { counter ->
+                    assertThat(counter.count()).isCloseTo(bytes.toDouble(), doublePrecision)
+                }
+            }
+
+            it("should leave all other counters unchanged") {
+                cut.notifyBytesReceived(128)
+                verifyAllCountersAreUnchangedBut(counterName)
+            }
+        }
+    }
+
+    describe("notifyMessageReceived") {
+        on("messages.received.count counter") {
+            val counterName = "messages.received.count"
+
+            it("should increment counter") {
+                cut.notifyMessageReceived(777)
+
+                verifyCounter(counterName) { counter ->
+                    assertThat(counter.count()).isCloseTo(1.0, doublePrecision)
+                }
+            }
+        }
+
+        on("messages.received.bytes counter") {
+            val counterName = "messages.received.bytes"
+
+            it("should increment counter") {
+                val bytes = 888
+                cut.notifyMessageReceived(bytes)
+
+                verifyCounter(counterName) { counter ->
+                    assertThat(counter.count()).isCloseTo(bytes.toDouble(), doublePrecision)
+                }
+            }
+        }
+
+        it("should leave all other counters unchanged") {
+            cut.notifyMessageReceived(128)
+            verifyAllCountersAreUnchangedBut("messages.received.count", "messages.received.bytes")
+        }
+    }
+
+    describe("notifyMessageSent") {
+        val topicName = "dmaap_topic_name"
+        val counterName = "messages.sent.count"
+
+        on("$counterName counter") {
+
+            it("should increment counter") {
+                cut.notifyMessageSent(topicName)
+
+                verifyCounter(counterName) { counter ->
+                    assertThat(counter.count()).isCloseTo(1.0, doublePrecision)
+                }
+            }
+        }
+
+        on("$counterName[topic=$topicName] counter") {
+
+            it("should increment counter") {
+                cut.notifyMessageSent(topicName)
+
+                verifyCounter(registrySearch().name(counterName).tag("topic", topicName)) { counter ->
+                    assertThat(counter.count()).isCloseTo(1.0, doublePrecision)
+                }
+            }
+        }
+
+        it("should leave all other counters unchanged") {
+            cut.notifyMessageSent(topicName)
+            verifyAllCountersAreUnchangedBut(counterName)
+        }
+    }
+
+    describe("processing gauge") {
+        it("should show difference between sent and received messages") {
+
+            on("positive difference") {
+                cut.notifyMessageReceived(128)
+                cut.notifyMessageReceived(256)
+                cut.notifyMessageReceived(256)
+                cut.notifyMessageSent("perf3gpp")
+                verifyGauge("messages.processing.count") { gauge ->
+                    assertThat(gauge.value()).isCloseTo(2.0, doublePrecision)
+                }
+            }
+
+            on("zero difference") {
+                cut.notifyMessageReceived(128)
+                cut.notifyMessageSent("perf3gpp")
+                verifyGauge("messages.processing.count") { gauge ->
+                    assertThat(gauge.value()).isCloseTo(0.0, doublePrecision)
+                }
+            }
+
+            on("negative difference") {
+                cut.notifyMessageReceived(128)
+                cut.notifyMessageSent("fault")
+                cut.notifyMessageSent("perf3gpp")
+                verifyGauge("messages.processing.count") { gauge ->
+                    assertThat(gauge.value()).isCloseTo(0.0, doublePrecision)
+                }
+            }
+        }
+    }
+
+})
diff --git a/sources/hv-collector-main/src/test/kotlin/org/onap/dcae/collectors/veshv/main/NioBuffersTest.kt b/sources/hv-collector-main/src/test/kotlin/org/onap/dcae/collectors/veshv/main/NioBuffersTest.kt
new file mode 100644
index 00000000..4eef28bb
--- /dev/null
+++ b/sources/hv-collector-main/src/test/kotlin/org/onap/dcae/collectors/veshv/main/NioBuffersTest.kt
@@ -0,0 +1,88 @@
+/*
+ * ============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.main
+
+import org.jetbrains.spek.api.Spek
+import org.jetbrains.spek.api.dsl.describe
+import org.jetbrains.spek.api.dsl.it
+import org.jetbrains.spek.api.dsl.xdescribe
+import java.nio.ByteBuffer
+
+object NioBuffersTest : Spek({
+
+    fun Int.toKibibytes(): Int = this * 1024
+    fun Int.toMebibytes(): Int = this * 1024 * 1024
+
+    val BUFFER_SIZES = listOf(128.toKibibytes(), 512.toKibibytes(), 1.toMebibytes(), 2.toMebibytes())
+    val NUMBER_OF_ITERATIONS = 100
+
+    fun measureCopyTimeInNanos(bb1: ByteBuffer, bb2: ByteBuffer): Double {
+        bb1.clear()
+        bb2.clear()
+        val start = System.nanoTime()
+        while (bb2.remaining() > 0)
+            bb2.putInt(bb1.getInt())
+        val time = System.nanoTime() - start
+        val operations = bb1.capacity() / Integer.BYTES
+        return time.toDouble() / operations
+    }
+
+    fun measureAverageCopyTimeInNanos(bb1: ByteBuffer, bb2: ByteBuffer): Double =
+            (0..NUMBER_OF_ITERATIONS).map { measureCopyTimeInNanos(bb1, bb2) }.average()
+
+    fun measureAndPrintAverageCopyTime(message: String, bb1: ByteBuffer, bb2: ByteBuffer) {
+        val avg = measureAverageCopyTimeInNanos(bb1, bb2)
+        System.out.printf("Each putInt+getInt for %s took an average of %.1f ns%n", message, avg)
+    }
+
+    for (singleBufferSize in BUFFER_SIZES) {
+
+        xdescribe("$singleBufferSize bytes buffers") {
+            describe("direct buffers") {
+
+                val bb1 = ByteBuffer.allocateDirect(singleBufferSize)
+                val bb2 = ByteBuffer.allocateDirect(singleBufferSize)
+
+                it("should be heated up") {
+                    measureAverageCopyTimeInNanos(bb1, bb2)
+                }
+
+                it("should work fast") {
+                    measureAndPrintAverageCopyTime("direct buffers of $singleBufferSize bytes", bb1, bb2)
+                }
+            }
+
+            describe("on-heap buffers") {
+
+                val bb1 = ByteBuffer.allocate(singleBufferSize)
+                val bb2 = ByteBuffer.allocate(singleBufferSize)
+
+                it("should be heated up") {
+                    measureAverageCopyTimeInNanos(bb1, bb2)
+                }
+
+                it("should work fast") {
+                    measureAndPrintAverageCopyTime("onheap buffers of $singleBufferSize bytes", bb1, bb2)
+                }
+            }
+        }
+    }
+
+})
\ No newline at end of file