rspec/rules/S5969/java/rule.adoc

88 lines
1.6 KiB
Plaintext
Raw Normal View History

2021-04-28 16:49:39 +02:00
If you end up mocking every non-private method of a class in order to write tests, it is a strong sign that your test became too complex, or that you misunderstood the way you are supposed to use the mocking mechanism.
You should either refactor the test code into multiple units, or consider using the class itself, by either directly instantiating it, or creating a new one inheriting from it, with the expected behavior.
This rule reports an issue when every member of a given class are mocked.
2021-04-28 16:49:39 +02:00
== Noncompliant Code Example
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
@Test
void test_requiring_MyClass() {
MyClass myClassMock = mock(MyClass.class); // Noncompliant
when(myClassMock.f()).thenReturn(1);
when(myClassMock.g()).thenReturn(2);
//...
}
abstract class MyClass {
abstract int f();
abstract int g();
}
----
2021-04-28 16:49:39 +02:00
== Compliant Solution
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
@Test
void test_requiring_MyClass() {
MyClass myClass = new MyClassForTest();
//...
}
class MyClassForTest extends MyClass {
@Override
int f() {
return 1;
}
@Override
int g() {
return 2;
}
}
----
or
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
@Test
void test_requiring_f() {
MyClass myClassMock = mock(MyClass.class);
when(myClassMock.f()).thenReturn(1);
//...
}
@Test
void test_requiring_g() {
MyClass myClassMock = mock(MyClass.class);
when(myClassMock.g()).thenReturn(2);
//...
}
abstract class MyClass {
abstract int f();
abstract int g();
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
include::highlighting.adoc[]
endif::env-github,rspecator-view[]