Test assertions using null comparison can be simplified

Docs > Code Analysis > Static Analysis Rules > Test assertions using null comparison can be simplified

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Metadata

ID: java-best-practices/simplify-test-assertions-null

Language: Java

Severity: Notice

Category: Best Practices

Description

Test assertions can be made more concise through the use of a more specialized assertion method.

In this rule, we check for null comparisons in assertTrue or assertFalse methods and suggest replacing with either an assertNull or assertNonNull method.

This enhances the error message clarity and improves the overall readability of the assertion for other developers.

Non-Compliant Code Examples

import org.junit.Test;
import static org.junit.Assert.*;

class Foo {
    Object a,b;
    @Test
    void testFoo() {
        assertTrue(a == null); // could be assertNull(a);
        assertTrue(a != null); // could be assertNotNull(a);

        assertFalse(a == null); // could be assertNotNull(a);
        assertFalse(a != null); // could be assertNull(a);
    }
}

Compliant Code Examples

import org.junit.Test;
import static org.junit.Assert.*;

class Foo {
    Object a,b;
    @Test
    void testFoo() {
        assertNull(a);
        assertNotNull(a);

        assertNotNull(a);
        assertNull(a);
    }
}

How to use this rule

1
2
rulesets:
  - java-best-practices     # Rules to enforce Java best practices.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Analysis scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Analysis documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products