test.ruleset.xml

<?xml version="1.0"?>
<ruleset name="emu-test-ruleset"
		xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
    <description>Emu ruleset for testing code</description>

    <rule ref="category/java/bestpractices.xml">
        <!-- Avoid reporting pedantic tests -->
        <exclude name="UnitTestContainsTooManyAsserts" />
    </rule>

    <rule ref="category/java/codestyle.xml">
        <!-- Avoid reporting variables with a short name -->
        <exclude name="ShortVariable" />
        <!-- Avoid reporting test classes without constructors -->
        <exclude name="AtLeastOneConstructor" />
        <!-- Avoid reporting class names not declared in camel case -->
        <exclude name="ClassNamingConventions" />
        <!-- Avoid reporting field name not declared in camel case -->
        <exclude name="FieldNamingConventions" />
        <!-- Avoid reporting method names not declared in camel case -->
        <exclude name="MethodNamingConventions" />
        <!-- Avoid reporting variables not declared in camel case -->
        <exclude name="LocalVariableNamingConventions" />
        <!-- Avoid reporting method/lambda parameters not declared in camel case -->
        <exclude name="FormalParameterNamingConventions" />
        <!-- Avoid reporting methods and fields with "confusing" names -->
        <exclude name="LinguisticNaming" />
    </rule>

    <!-- Avoid reporting variables with a long name -->
    <rule ref="category/java/codestyle.xml/LongVariable">
        <properties>
            <property name="minimum" value="30" />
        </properties>
    </rule>

    <rule ref="category/java/design.xml">
        <!-- Avoid reporting classes with too many imports -->
        <exclude name="ExcessiveImports" />
        <!-- Avoid reporting usage of classes from outside the package hierarchy -->
        <exclude name="LoosePackageCoupling" />
        <!-- Avoid reporting usage of data coming from "too far away" -->
        <exclude name="LawOfDemeter" />
        <!-- Avoid reporting big test files -->
        <exclude name="TooManyMethods" />
        <!-- Avoid reporting methods that are "too complex" -->
        <exclude name="CognitiveComplexity" />
        <!-- Avoid reporting methods that are "too complex" -->
        <exclude name="CyclomaticComplexity" />
        <!-- Avoid reporting methods that are "too complex" -->
        <exclude name="NPathComplexity" />
    </rule>

    <rule ref="category/java/documentation.xml">
        <!-- Avoid reporting comments with too many lines -->
        <exclude name="CommentSize" />
        <!-- Avoid reporting missing comments on private fields -->
        <exclude name="CommentRequired" />
    </rule>

    <rule ref="category/java/errorprone.xml">
        <!-- Avoid reporting methods with the same name of a field -->
        <exclude name="AvoidFieldNameMatchingMethodName" />
        <!-- Avoid reporting the usage of null in test setup -->
        <exclude name="NullAssignment" />
    </rule>

    <rule ref="category/java/errorprone.xml/AvoidDuplicateLiterals">
        <properties>
            <property name="maxDuplicateLiterals" value="5" />
            <property name="minimumLength" value="3" />
            <property name="skipAnnotations" value="true" />
            <property name="exceptionList" value="" />
        </properties>
    </rule>

    <rule ref="category/java/multithreading.xml">
        <!-- Avoid reporting anything related to java.lang.Thread or Executors -->
        <exclude name="DoNotUseThreads" />
    </rule>

    <rule ref="category/java/performance.xml">
        <!-- Avoid reporting redundant field initialization -->
        <exclude name="RedundantFieldInitializer" />
        <!-- Avoid reporting "slow" string appends in tests -->
        <exclude name="UseStringBufferForStringAppends" />
        <!-- Avoid reporting object creations in loops -->
        <exclude name="AvoidInstantiatingObjectsInLoops" />
    </rule>

    <rule ref="category/java/security.xml" />
</ruleset>