Issue sevntu-checkstyle#610: added CheckstyleTestMakeupCheck

kariem · Jul 26, 2018 · 6219538 · 6219538
1 parent 1e5c804
commit 6219538
Show file tree

Hide file tree

Showing 10 changed files with 838 additions and 0 deletions.
diff --git a/...vntu-plugin/src/com/github/sevntu/checkstyle/checks/design/checkstyle-metadata.properties b/...vntu-plugin/src/com/github/sevntu/checkstyle/checks/design/checkstyle-metadata.properties
@@ -50,3 +50,8 @@ HideUtilityClassConstructorCheck.desc = Make sure that utility classes (classes
 
 InnerClassCheck.name = Inner Class
 InnerClassCheck.desc = Check nested (internal) classes to be declared at the bottom of the class after all methods (fields) declaration.
+
+CheckstyleTestMakeupCheck.name = Checkstyle Test Makeup
+CheckstyleTestMakeupCheck.desc = Custom check to ensure Checkstyle tests are designed correctly.
+CheckstyleTestMakeupCheck.createMethodRegexp = Regular expression for matching a create configuration method by name.
+CheckstyleTestMakeupCheck.verifyMethodRegexp = Regular expression for matching a verify method by name.
diff --git a/...secs-sevntu-plugin/src/com/github/sevntu/checkstyle/checks/design/checkstyle-metadata.xml b/...secs-sevntu-plugin/src/com/github/sevntu/checkstyle/checks/design/checkstyle-metadata.xml
@@ -160,5 +160,24 @@
       <message-key key="arrangement.members.before.inner"/>
     </rule-metadata>
 
+    <rule-metadata name="%CheckstyleTestMakeupCheck.name" internal-name="CheckstyleTestMakeupCheck" parent="TreeWalker">
+      <alternative-name internal-name="com.github.sevntu.checkstyle.checks.design.CheckstyleTestMakeupCheck"/>
+      <description>%CheckstyleTestMakeupCheck.desc</description>
+
+      <property-metadata name="createMethodRegexp" datatype="Regex" default-value="create(Root|Module)Config|getModuleConfig">
+        <description>%CheckstyleTestMakeupCheck.createMethodRegexp</description>
+      </property-metadata>
+
+      <property-metadata name="verifyMethodRegexp" datatype="Regex" default-value="verify(Warns|Suppressed)?">
+        <description>%CheckstyleTestMakeupCheck.verifyMethodRegexp</description>
+      </property-metadata>
+
+      <message-key key="tester.config.not.assigned"/>
+      <message-key key="tester.config.not.assigned.with"/>
+      <message-key key="tester.config.not.assigned.properly"/>
+      <message-key key="tester.unknown.property"/>
+      <message-key key="tester.config.not.found"/>
+    </rule-metadata>
+
   </rule-group-metadata>
 </checkstyle-metadata>
diff --git a/sevntu-checks/sevntu-checks.xml b/sevntu-checks/sevntu-checks.xml
@@ -188,6 +188,7 @@
     <module name="com.github.sevntu.checkstyle.checks.design.NestedSwitchCheck"/>
     <module name="com.github.sevntu.checkstyle.checks.design.AvoidConditionInversionCheck"/>
     <module name="com.github.sevntu.checkstyle.checks.design.CauseParameterInExceptionCheck"/>
+    <module name="com.github.sevntu.checkstyle.checks.design.CheckstyleTestMakeupCheck"/>
 
     <!-- Naming -->
     <module name="com.github.sevntu.checkstyle.checks.naming.InterfaceTypeParameterNameCheck">