rspec/rules/S3360/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

48 lines
876 B
Plaintext

== Why is this an issue?
By default, the Maven Surefire plugin only executes test classes with names that end in "Test" or "TestCase". Name your class "TestClassX.java", for instance, and it will be skipped.
This rule raises an issue for each test class with a name not ending in "Test" or "TestCase".
=== Noncompliant code example
[source,java]
----
public class TestClassX { // Noncompliant
@Test
public void testDoTheThing() {
//...
----
=== Compliant solution
[source,java]
----
public class ClassXTest {
@Test
public void testDoTheThing() {
//...
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]