master: Adjusted IdNaming to correct unnecessary Switch case. Added t…

…ests for the CheckBox case
brightec · Nov 5, 2019 · 3dfd613 · 3dfd613
1 parent cfd66f6
commit 3dfd613
Show file tree

Hide file tree

Showing 5 changed files with 110 additions and 6 deletions.
diff --git a/src/main/kotlin/uk/co/brightec/xmlcheck/rules/attr/android/IdNaming.kt b/src/main/kotlin/uk/co/brightec/xmlcheck/rules/attr/android/IdNaming.kt
@@ -50,17 +50,14 @@ class IdNaming : AttrRule(
         if (className == "RadioButton") {
             return attrId == "radio" || attrId.startsWith("radio_")
         }
+        if (className.contains("CheckBox")) {
+            return attrId == "check_box" || attrId.startsWith("check_box_")
+        }
 
         // General rules
         if (words.contains("Button")) {
             return attrId == "button" || attrId.startsWith("button_")
         }
-        if (words.contains("CheckBox")) {
-            return attrId == "check_box" || attrId.startsWith("check_box_")
-        }
-        if (words.contains("Switch")) {
-            return attrId == "switch" || attrId.startsWith("switch_")
-        }
         if (words.contains("Card")) {
             return attrId == "card" || attrId.startsWith("card_")
         }

diff --git a/src/test/kotlin/uk/co/brightec/xmlcheck/EndToEndTest.kt b/src/test/kotlin/uk/co/brightec/xmlcheck/EndToEndTest.kt
@@ -346,6 +346,10 @@ private class EndToEndTest {
             IdNaming-Words.xml PASSED
             """.trimIndent()
         assertContains(expectedLog5, outputOut)
+        val expectedLog6 = """
+            IdNaming-CheckBox.xml PASSED
+            """.trimIndent()
+        assertContains(expectedLog6, outputOut)
         val outputErr = errContent.toString()
         assertEquals("", outputErr)
     }
@@ -392,6 +396,11 @@ private class EndToEndTest {
             (IdNaming) Line:3: android:id="@+id/something" - Id for SomeOtherClassName doesn't conform to naming convention
             """.trimIndent()
         assertContains(expectedLog5, outputErr)
+        val expectedLog6 = """
+            ./src/test/resources/files/failures/IdNaming/IdNaming-CheckBox.xml
+            (IdNaming) Line:3: android:id="@+id/something" - Id for CheckBox doesn't conform to naming convention
+            """.trimIndent()
+        assertContains(expectedLog6, outputErr)
     }
 
     @Test
@@ -428,6 +437,10 @@ private class EndToEndTest {
             IdNaming-Words.xml PASSED
             """.trimIndent()
         assertContains(expectedLog5, outputOut)
+        val expectedLog6 = """
+            IdNaming-CheckBox.xml PASSED
+            """.trimIndent()
+        assertContains(expectedLog6, outputOut)
         val outputErr = errContent.toString()
         assertEquals("", outputErr)
     }

diff --git a/src/test/kotlin/uk/co/brightec/xmlcheck/rules/attr/android/IdNamingTest.kt b/src/test/kotlin/uk/co/brightec/xmlcheck/rules/attr/android/IdNamingTest.kt
@@ -422,6 +422,91 @@ private class IdNamingTest {
         assertNull(result)
     }
 
+    @ParameterizedTest
+    @MethodSource("createArgumentsCheckBox")
+    fun `Given tagName CheckBox and naming failure | When run check | Then failure`(
+        tagName: String,
+        parentTagName: String?
+    ) {
+        // GIVEN
+        val parentTagAttr = mockk<Attr> {
+            every { value } returns parentTagName
+        }
+        val owner = mockk<Element> {
+            every { this@mockk.tagName } returns tagName
+            every {
+                attributes.getNamedItem("$ATTR_NAMESPACE_TOOLS:parentTag")
+            } returns parentTagAttr
+        }
+        val node = mockk<Attr> {
+            every { value } returns "@+id/other"
+            every { ownerElement } returns owner
+        }
+
+        // WHEN
+        val result = rule.run(node)
+
+        // THEN
+        val expected = rule.failure(node, "Id for ${owner.tagName} doesn't conform to naming convention")
+        assertEquals(expected, result)
+    }
+
+    @ParameterizedTest
+    @MethodSource("createArgumentsCheckBox")
+    fun `Given tagName CheckBox and naming exact correct | When run check | Then no failure`(
+        tagName: String,
+        parentTagName: String?
+    ) {
+        // GIVEN
+        val parentTagAttr = mockk<Attr> {
+            every { value } returns parentTagName
+        }
+        val owner = mockk<Element> {
+            every { this@mockk.tagName } returns tagName
+            every {
+                attributes.getNamedItem("$ATTR_NAMESPACE_TOOLS:parentTag")
+            } returns parentTagAttr
+        }
+        val node = mockk<Attr> {
+            every { value } returns "@+id/check_box"
+            every { ownerElement } returns owner
+        }
+
+        // WHEN
+        val result = rule.run(node)
+
+        // THEN
+        assertNull(result)
+    }
+
+    @ParameterizedTest
+    @MethodSource("createArgumentsCheckBox")
+    fun `Given tagName CheckBox and naming correct | When run check | Then no failure`(
+        tagName: String,
+        parentTagName: String?
+    ) {
+        // GIVEN
+        val parentTagAttr = mockk<Attr> {
+            every { value } returns parentTagName
+        }
+        val owner = mockk<Element> {
+            every { this@mockk.tagName } returns tagName
+            every {
+                attributes.getNamedItem("$ATTR_NAMESPACE_TOOLS:parentTag")
+            } returns parentTagAttr
+        }
+        val node = mockk<Attr> {
+            every { value } returns "@+id/check_box_anything"
+            every { ownerElement } returns owner
+        }
+
+        // WHEN
+        val result = rule.run(node)
+
+        // THEN
+        assertNull(result)
+    }
+
     @ParameterizedTest
     @MethodSource("createArgumentsSomeButton")
     fun `Given tagName SomeButton and naming failure | When run check | Then failure`(
@@ -639,6 +724,9 @@ private class IdNamingTest {
         @JvmStatic
         fun createArgumentsGuideline() = createArguments("Guideline")
 
+        @JvmStatic
+        fun createArgumentsCheckBox() = createArguments("CheckBox")
+
         @JvmStatic
         fun createArgumentsSomeButton() = createArguments("SomeButton")
 

diff --git a/src/test/resources/files/failures/IdNaming/IdNaming-CheckBox.xml b/src/test/resources/files/failures/IdNaming/IdNaming-CheckBox.xml
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+<CheckBox xmlns:android="http://schemas.android.com/apk/res/android"
+    android:id="@+id/something" />
diff --git a/src/test/resources/files/success/IdNaming/IdNaming-CheckBox.xml b/src/test/resources/files/success/IdNaming/IdNaming-CheckBox.xml
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+<CheckBox xmlns:android="http://schemas.android.com/apk/res/android"
+    android:id="@+id/check_box_something" />