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, 530 insertions, 0 deletions

diff --git a/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/CommonEventHeaderParserTest.kt b/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/CommonEventHeaderParserTest.kt
new file mode 100644
index 00000000..3a33c44a
--- /dev/null
+++ b/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/CommonEventHeaderParserTest.kt
@@ -0,0 +1,82 @@
+/*
+ * ============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.ves.message.generator.impl
+
+import arrow.core.Option
+import arrow.core.identity
+import com.google.protobuf.util.JsonFormat
+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.onap.dcae.collectors.veshv.domain.VesEventDomain.STATE_CHANGE
+import org.onap.dcae.collectors.veshv.tests.utils.commonHeader
+import org.onap.ves.VesEventOuterClass.CommonEventHeader
+import java.io.ByteArrayInputStream
+import javax.json.Json
+import kotlin.test.fail
+
+class CommonEventHeaderParserTest : Spek({
+
+    describe("Common event header parser") {
+        val parser = CommonEventHeaderParser()
+
+        given("valid header in JSON format") {
+            val commonEventHeader = commonHeader(
+                    domain = STATE_CHANGE,
+                    id = "sample-event-id")
+            val json = JsonFormat.printer().print(commonEventHeader).byteInputStream()
+
+            it("should parse common event header") {
+                val result =
+                        parser.parse(jsonObject(json))
+                                .fold({ fail() }, ::identity)
+
+                assertThat(result).describedAs("common event header").isEqualTo(commonEventHeader)
+            }
+        }
+
+        given("invalid header in JSON format") {
+            val json = "{}".byteInputStream()
+
+            it("should throw exception") {
+                val result = parser.parse(jsonObject(json))
+
+                assertFailed(result)
+            }
+        }
+
+        given("invalid JSON") {
+            val json = "{}}}}".byteInputStream()
+
+            it("should throw exception") {
+                val result = parser.parse(jsonObject(json))
+
+                assertFailed(result)
+            }
+        }
+    }
+})
+
+fun assertFailed(result: Option<CommonEventHeader>) =
+        result.fold({}, { fail() })
+
+fun jsonObject(json: ByteArrayInputStream) = Json.createReader(json).readObject()!!
\ No newline at end of file
diff --git a/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/MessageGeneratorImplTest.kt b/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/MessageGeneratorImplTest.kt
new file mode 100644
index 00000000..e2aec7df
--- /dev/null
+++ b/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/MessageGeneratorImplTest.kt
@@ -0,0 +1,227 @@
+/*
+ * ============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.ves.message.generator.impl
+
+import com.google.protobuf.ByteString
+import com.google.protobuf.InvalidProtocolBufferException
+import org.assertj.core.api.Assertions.assertThat
+import org.assertj.core.api.Assertions.assertThatExceptionOfType
+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.ByteData
+import org.onap.dcae.collectors.veshv.domain.WireFrameMessage
+import org.onap.dcae.collectors.veshv.domain.VesEventDomain.PERF3GPP
+import org.onap.dcae.collectors.veshv.domain.VesEventDomain.FAULT
+import org.onap.dcae.collectors.veshv.domain.VesEventDomain.HEARTBEAT
+import org.onap.dcae.collectors.veshv.tests.utils.commonHeader
+import org.onap.dcae.collectors.veshv.ves.message.generator.api.MessageGenerator
+import org.onap.dcae.collectors.veshv.ves.message.generator.api.MessageParameters
+import org.onap.dcae.collectors.veshv.ves.message.generator.api.MessageType
+import org.onap.ves.VesEventOuterClass.CommonEventHeader
+import org.onap.ves.VesEventOuterClass.VesEvent
+import reactor.test.test
+
+/**
+ * @author Jakub Dudycz <jakub.dudycz@nokia.com>
+ * @since June 2018
+ */
+object MessageGeneratorImplTest : Spek({
+    describe("message factory") {
+        val maxPayloadSizeBytes = 1024
+        val generator = MessageGeneratorImpl(PayloadGenerator(), maxPayloadSizeBytes)
+        given("single message parameters") {
+
+            on("messages amount not specified in parameters") {
+                it("should create infinite flux") {
+                    val limit = 1000L
+                    generator
+                            .createMessageFlux(listOf(MessageParameters(
+                                    commonHeader(PERF3GPP),
+                                    MessageType.VALID
+                            )))
+                            .take(limit)
+                            .test()
+                            .expectNextCount(limit)
+                            .verifyComplete()
+                }
+            }
+
+            on("messages amount = 0 specified in parameters") {
+                it("should create empty message flux") {
+                    generator
+                            .createMessageFlux(listOf(MessageParameters(
+                                    commonHeader(PERF3GPP),
+                                    MessageType.VALID,
+                                    0
+                            )))
+                            .test()
+                            .verifyComplete()
+                }
+            }
+
+            on("messages amount specified in parameters") {
+                it("should create message flux of specified size") {
+                    generator
+                            .createMessageFlux(listOf(MessageParameters(
+                                    commonHeader(PERF3GPP),
+                                    MessageType.VALID,
+                                    5
+                            )))
+                            .test()
+                            .expectNextCount(5)
+                            .verifyComplete()
+                }
+            }
+
+            on("message type requesting valid message") {
+                it("should create flux of valid messages with given domain") {
+                    generator
+                            .createMessageFlux(listOf(MessageParameters(
+                                    commonHeader(FAULT),
+                                    MessageType.VALID,
+                                    1
+                            )))
+                            .test()
+                            .assertNext {
+                                assertThat(it.isValid()).isTrue()
+                                assertThat(it.payloadSize).isLessThan(maxPayloadSizeBytes)
+                                assertThat(extractCommonEventHeader(it.payload).domain).isEqualTo(FAULT.domainName)
+                            }
+                            .verifyComplete()
+                }
+            }
+
+            on("message type requesting too big payload") {
+                it("should create flux of messages with given domain and payload exceeding threshold") {
+
+                    generator
+                            .createMessageFlux(listOf(MessageParameters(
+                                    commonHeader(PERF3GPP),
+                                    MessageType.TOO_BIG_PAYLOAD,
+                                    1
+                            )))
+                            .test()
+                            .assertNext {
+                                assertThat(it.isValid()).isTrue()
+                                assertThat(it.payloadSize).isGreaterThan(maxPayloadSizeBytes)
+                                assertThat(extractCommonEventHeader(it.payload).domain).isEqualTo(PERF3GPP.domainName)
+                            }
+                            .verifyComplete()
+                }
+            }
+
+            on("message type requesting invalid GPB data ") {
+                it("should create flux of messages with invalid payload") {
+                    generator
+                            .createMessageFlux(listOf(MessageParameters(
+                                    commonHeader(PERF3GPP),
+                                    MessageType.INVALID_GPB_DATA,
+                                    1
+                            )))
+                            .test()
+                            .assertNext {
+                                assertThat(it.isValid()).isTrue()
+                                assertThat(it.payloadSize).isLessThan(maxPayloadSizeBytes)
+                                assertThatExceptionOfType(InvalidProtocolBufferException::class.java)
+                                        .isThrownBy { extractCommonEventHeader(it.payload) }
+                            }
+                            .verifyComplete()
+                }
+            }
+
+            on("message type requesting invalid wire frame ") {
+                it("should create flux of messages with invalid version") {
+                    generator
+                            .createMessageFlux(listOf(MessageParameters(
+                                    commonHeader(PERF3GPP),
+                                    MessageType.INVALID_WIRE_FRAME,
+                                    1
+                            )))
+                            .test()
+                            .assertNext {
+                                assertThat(it.isValid()).isFalse()
+                                assertThat(it.payloadSize).isLessThan(maxPayloadSizeBytes)
+                                assertThat(extractCommonEventHeader(it.payload).domain).isEqualTo(PERF3GPP.domainName)
+                                assertThat(it.versionMajor).isNotEqualTo(WireFrameMessage.SUPPORTED_VERSION_MINOR)
+                            }
+                            .verifyComplete()
+                }
+            }
+
+            on("message type requesting fixed payload") {
+                it("should create flux of valid messages with fixed payload") {
+                    generator
+                            .createMessageFlux(listOf(MessageParameters(
+                                    commonHeader(FAULT),
+                                    MessageType.FIXED_PAYLOAD,
+                                    1
+                            )))
+                            .test()
+                            .assertNext {
+                                assertThat(it.isValid()).isTrue()
+                                assertThat(it.payloadSize).isLessThan(maxPayloadSizeBytes)
+                                assertThat(extractEventFields(it.payload).size()).isEqualTo(MessageGenerator.FIXED_PAYLOAD_SIZE)
+                                assertThat(extractCommonEventHeader(it.payload).domain).isEqualTo(FAULT.domainName)
+                            }
+                            .verifyComplete()
+                }
+            }
+        }
+        given("list of message parameters") {
+            it("should create concatenated flux of messages") {
+                val singleFluxSize = 5L
+                val messageParameters = listOf(
+                        MessageParameters(commonHeader(PERF3GPP), MessageType.VALID, singleFluxSize),
+                        MessageParameters(commonHeader(FAULT), MessageType.TOO_BIG_PAYLOAD, singleFluxSize),
+                        MessageParameters(commonHeader(HEARTBEAT), MessageType.VALID, singleFluxSize)
+                )
+                generator.createMessageFlux(messageParameters)
+                        .test()
+                        .assertNext {
+                            assertThat(it.payloadSize).isLessThan(maxPayloadSizeBytes)
+                            assertThat(extractCommonEventHeader(it.payload).domain).isEqualTo(PERF3GPP.domainName)
+                        }
+                        .expectNextCount(singleFluxSize - 1)
+                        .assertNext {
+                            assertThat(it.payloadSize).isGreaterThan(maxPayloadSizeBytes)
+                            assertThat(extractCommonEventHeader(it.payload).domain).isEqualTo(FAULT.domainName)
+                        }
+                        .expectNextCount(singleFluxSize - 1)
+                        .assertNext {
+                            assertThat(it.payloadSize).isLessThan(maxPayloadSizeBytes)
+                            assertThat(extractCommonEventHeader(it.payload).domain).isEqualTo(HEARTBEAT.domainName)
+                        }
+                        .expectNextCount(singleFluxSize - 1)
+                        .verifyComplete()
+            }
+        }
+    }
+})
+
+fun extractCommonEventHeader(bytes: ByteData): CommonEventHeader =
+        VesEvent.parseFrom(bytes.unsafeAsArray()).commonEventHeader
+
+
+fun extractEventFields(bytes: ByteData): ByteString =
+        VesEvent.parseFrom(bytes.unsafeAsArray()).eventFields
+
diff --git a/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/MessageParametersParserTest.kt b/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/MessageParametersParserTest.kt
new file mode 100644
index 00000000..134ebb2d
--- /dev/null
+++ b/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/MessageParametersParserTest.kt
@@ -0,0 +1,64 @@
+/*
+ * ============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.ves.message.generator.impl
+
+import org.assertj.core.api.Assertions.assertThat
+import org.assertj.core.api.Assertions.fail
+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.ves.message.generator.api.MessageType
+
+private const val EXPECTED_MESSAGES_AMOUNT = 25000L
+
+/**
+ * @author Jakub Dudycz <jakub.dudycz@nokia.com>
+ * @since July 2018
+ */
+object MessageParametersParserTest : Spek({
+    describe("Messages parameters parser") {
+        val messageParametersParser = MessageParametersParserImpl()
+
+        given("parameters json array") {
+            on("valid parameters json") {
+                it("should parse MessagesParameters object successfully") {
+                    val result = messageParametersParser.parse(validMessagesParametesJson())
+
+                    result.fold({ fail("should have succeeded") }) { rightResult ->
+                        assertThat(rightResult).hasSize(2)
+                        val firstMessage = rightResult.first()
+                        assertThat(firstMessage.messageType).isEqualTo(MessageType.VALID)
+                        assertThat(firstMessage.amount).isEqualTo(EXPECTED_MESSAGES_AMOUNT)
+
+                    }
+                }
+            }
+
+            on("invalid parameters json") {
+                it("should throw exception") {
+                    val result = messageParametersParser.parse(invalidMessagesParametesJson())
+                    assertThat(result.isLeft()).describedAs("is left").isTrue()
+                }
+            }
+        }
+    }
+})
diff --git a/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/PayloadGeneratorTest.kt b/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/PayloadGeneratorTest.kt
new file mode 100644
index 00000000..bb91245d
--- /dev/null
+++ b/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/PayloadGeneratorTest.kt
@@ -0,0 +1,51 @@
+/*
+ * ============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.ves.message.generator.impl
+
+import org.assertj.core.api.Assertions.assertThat
+import org.jetbrains.spek.api.Spek
+import org.jetbrains.spek.api.dsl.given
+import org.jetbrains.spek.api.dsl.it
+import org.jetbrains.spek.api.dsl.on
+
+object PayloadGeneratorTest : Spek({
+
+    given("payload factory object") {
+        val payloadGenerator = PayloadGenerator()
+
+        on("raw payload generation") {
+            val size = 100
+            val generatedPayload = payloadGenerator.generateRawPayload(size)
+
+            it("should generate sequence of zeros") {
+                assertThat(generatedPayload.size()).isEqualTo(size)
+                assertThat(generatedPayload.toByteArray()).isEqualTo(ByteArray(size))
+            }
+        }
+
+        on("two generated payloads") {
+            val generatedPayload0 = payloadGenerator.generatePayload()
+            val generatedPayload1 = payloadGenerator.generatePayload()
+            it("should be different") {
+                assertThat(generatedPayload0 != generatedPayload1).isTrue()
+            }
+        }
+    }
+})
diff --git a/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/parameters.kt b/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/parameters.kt
new file mode 100644
index 00000000..78cfa028
--- /dev/null
+++ b/sources/hv-collector-ves-message-generator/src/test/kotlin/org/onap/dcae/collectors/veshv/ves/message/generator/impl/parameters.kt
@@ -0,0 +1,106 @@
+/*
+ * ============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.ves.message.generator.impl
+
+import javax.json.Json
+
+private const val validMessageParameters =
+"""[
+        {
+          "commonEventHeader": {
+            "version": "sample-version",
+            "domain": "perf3gpp",
+            "sequence": 1,
+            "priority": 1,
+            "eventId": "sample-event-id",
+            "eventName": "sample-event-name",
+            "eventType": "sample-event-type",
+            "startEpochMicrosec": 120034455,
+            "lastEpochMicrosec": 120034455,
+            "nfNamingCode": "sample-nf-naming-code",
+            "nfcNamingCode": "sample-nfc-naming-code",
+            "reportingEntityId": "sample-reporting-entity-id",
+            "reportingEntityName": "sample-reporting-entity-name",
+            "sourceId": "sample-source-id",
+            "sourceName": "sample-source-name",
+            "vesEventListenerVersion": "another-version"
+          },
+          "messageType": "VALID",
+          "messagesAmount": 25000
+        },
+        {
+          "commonEventHeader": {
+            "version": "sample-version",
+            "domain": "perf3gpp",
+            "sequence": 1,
+            "priority": 1,
+            "eventId": "sample-event-id",
+            "eventName": "sample-event-name",
+            "eventType": "sample-event-type",
+            "startEpochMicrosec": 120034455,
+            "lastEpochMicrosec": 120034455,
+            "nfNamingCode": "sample-nf-naming-code",
+            "nfcNamingCode": "sample-nfc-naming-code",
+            "reportingEntityId": "sample-reporting-entity-id",
+            "reportingEntityName": "sample-reporting-entity-name",
+            "sourceId": "sample-source-id",
+            "sourceName": "sample-source-name",
+            "vesEventListenerVersion": "another-version"
+          },
+          "messageType": "TOO_BIG_PAYLOAD",
+          "messagesAmount": 100
+        }
+        ]
+"""
+
+private const val invalidMessageParameters =
+"""
+    [
+        {
+          "commonEventHeader": {
+            "version": "sample-version",
+            "domain": "perf3gpp",
+            "sequence": 1,
+            "priority": 1,
+            "eventId": "sample-event-id",
+            "eventName": "sample-event-name",
+            "eventType": "sample-event-type",
+            "startEpochMicrosec": 120034455,
+            "lastEpochMicrosec": 120034455,
+            "nfNamingCode": "sample-nf-naming-code",
+            "nfcNamingCode": "sample-nfc-naming-code",
+            "reportingEntityId": "sample-reporting-entity-id",
+            "reportingEntityName": "sample-reporting-entity-name",
+            "sourceId": "sample-source-id",
+            "sourceName": "sample-source-name",
+            "vesEventListenerVersion": "another-version"
+          },
+          "messagesAmount": 3
+        }
+        ]
+"""
+
+fun validMessagesParametesJson() = Json
+        .createReader(validMessageParameters.reader())
+        .readArray()!!
+
+fun invalidMessagesParametesJson() = Json
+        .createReader(invalidMessageParameters.reader())
+        .readArray()!!