rspec/rules/S2699/apex/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

57 lines
1.1 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

== Why is this an issue?
A test case without assertions ensures only that no exceptions are thrown. Beyond basic runnability, it ensures nothing about the behavior of the code under test.
 
This rule raises an issue when a function with an ``++@isTest++`` annotation does not call at least one of the following functions once:
* ``++System.assert++``
* ``++System.assertEquals++``
* ``++System.assertNotEquals++``
=== Noncompliant code example
[source,apex]
----
@isTest()
class ApexTests {
@isTest
private static void mytest() { // Noncompliant
MyClass.createTask();
}
}
----
=== Compliant solution
[source,apex]
----
@isTest()
class ApexTests {
@isTest
private static void mytest() {
Task task = MyClass.createTask();
System.assert("expected subject", task.subject, "task has not the expected subject");
}
}
----
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[]