rspec/rules/S2701/java/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.
2023-06-22 10:38:01 +02:00

47 lines
1.0 KiB
Plaintext

== Why is this an issue?
There's no reason to use literal boolean values or nulls in assertions. Instead of using them with _assertEquals_, _assertNotEquals_ and similar methods, you should be using _assertTrue_, _assertFalse_, _assertNull_ or _assertNotNull_ instead (or _isNull_ etc. when using Fest). Using them with assertions unrelated to equality (such as _assertNull_) is most likely a bug.
Supported frameworks:
* JUnit3
* JUnit4
* JUnit5
* Fest assert
=== Noncompliant code example
[source,java]
----
Assert.assertTrue(true); // Noncompliant
assertThat(null).isNull(); // Noncompliant
assertEquals(true, something()); // Noncompliant
assertNotEquals(null, something()); // Noncompliant
----
=== Compliant solution
[source,java]
----
assertTrue(something());
assertNotNull(something());
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]