Create custom rule to report public modifiers in impl

Change-Id: I383ca27a835943bd2dc2508425264ad7f64c7725
Signed-off-by: Izabela Zawadzka <izabela.zawadzka@nokia.com>
Issue-ID: DCAEGEN2-1430

1 files changed, 122 insertions, 0 deletions

diff --git a/build/hv-collector-analysis/src/test/kotlin/org/onap/dcae/collectors/veshv/analysis/PublicModifiersInImplTest.kt b/build/hv-collector-analysis/src/test/kotlin/org/onap/dcae/collectors/veshv/analysis/PublicModifiersInImplTest.kt
new file mode 100644
index 00000000..b3de1a2e
--- /dev/null
+++ b/build/hv-collector-analysis/src/test/kotlin/org/onap/dcae/collectors/veshv/analysis/PublicModifiersInImplTest.kt
@@ -0,0 +1,122 @@
+/*
+ * ============LICENSE_START=======================================================
+ * dcaegen2-collectors-veshv
+ * ================================================================================
+ * Copyright (C) 2019 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.analysis
+
+import io.gitlab.arturbosch.detekt.test.assertThat
+import io.gitlab.arturbosch.detekt.test.lint
+import org.jetbrains.spek.api.Spek
+import org.jetbrains.spek.api.dsl.describe
+import org.jetbrains.spek.api.dsl.it
+
+internal class PublicModifiersInImplTest: Spek({
+    fun checkPassingCase(code: String, cut: PublicModifiersInImpl = PublicModifiersInImpl()) {
+        describe(code) {
+            val findings = cut.lint(code)
+
+            it("should pass") {
+                assertThat(findings).isEmpty()
+            }
+        }
+    }
+
+    fun checkFailingCase(code: String, cut: PublicModifiersInImpl = PublicModifiersInImpl()) {
+        describe(code) {
+            val findings = cut.lint(code)
+
+            it("should fail") {
+                assertThat(findings).isNotEmpty
+            }
+        }
+    }
+
+    describe("passing cases") {
+        checkPassingCase(ExemplaryCode.publicModifiersOutsideImplPackage)
+        checkPassingCase(ExemplaryCode.internalTopLevelModifiersInsideImplPackage)
+        checkPassingCase(ExemplaryCode.privateTopLevelModifiersInsideImplPackage)
+        checkPassingCase(ExemplaryCode.protectedTopLevelModifiersInsideImplPackage)
+    }
+
+    describe("failing cases") {
+        checkFailingCase(ExemplaryCode.publicTopLevelModifiersInsideImplPackage)
+    }
+})
+
+private object ExemplaryCode {
+    val publicModifiersOutsideImplPackage = """
+        package a.b.c
+
+        class SampleClass {
+
+        }
+
+        object SampleObject {
+
+        }
+    """.trimIndent()
+
+    val internalTopLevelModifiersInsideImplPackage = """
+        package a.impl.b
+
+        internal fun sampleFunction() = true
+
+        internal val sampleProperty = true
+
+        internal class SampleClass {
+            fun someFunction() = true
+        }
+    """.trimIndent()
+
+    val privateTopLevelModifiersInsideImplPackage = """
+        package a.impl.b
+
+        private fun sampleFunction() = true
+
+        private val sampleProperty = true
+
+        private class SampleClass {
+            fun someFunction() = true
+        }
+    """.trimIndent()
+
+    val protectedTopLevelModifiersInsideImplPackage = """
+        package a.impl.b
+
+        protected fun sampleFunction() = true
+
+        protected val sampleProperty = true
+
+        protected class SampleClass {
+            fun someFunction() = true
+        }
+    """.trimIndent()
+
+    val publicTopLevelModifiersInsideImplPackage = """
+        package a.impl.b
+
+        fun sampleFunction() = true
+
+        val sampleProperty = true
+
+        class SampleClass {
+            private fun someFunction() = true
+        }
+    """.trimIndent()
+}
\ No newline at end of file