No coverage – use PowerMockAgent

Wer eine gewisse Zeit mit Powermock arbeitet, wird irgendwann auf folgende Problemsituation stoßen.

Nehmen wir an, unser zu testender Code sieht wie folgt aus:

private int returnResponseCode(String url) throws Exception {
   URL obj = new URL(url);
   HttpURLConnection con = (HttpURLConnection) obj.openConnection();
   ...
   int responseCode = con.getResponseCode();
   return responseCode;
}

Es wird also in der markierten Zeile ein neues Objekt erzeugt und dann im Folgenden verwendet, aber NICHT zurückgegeben.

Im Test werden wir also die Erstellung dieses Objekts mocken müssen. Dazu verwendet man PowerMock. Eine allgemeine Beschreibung von PowerMock findet sich hier.

Der Testcode könnte wie folgt aussehen:

...
mockURL = PowerMockito.mock(URL.class);
PowerMockito.whenNew(URL.class).withArguments(url).thenReturn(mockURL);
mockConnection = mock(HttpURLConnection.class);
when(mockURL.openConnection()).thenReturn(mockConnection);
...

In den markierten Zeilen wird PowerMock benutzt und deshalb müssen wir einerseits den PowerMockRunner verwenden und andererseits die Klasse, die das new aufruft für Powermock vorbereiten:

@RunWith(PowerMockRunner.class)
@PrepareForTest({ MyClass.class, URL.class })
public class MyClassTest {
...
}

Doch genau darin besteht das Problem.

Wenn die vorzubereitende Klasse nämlich genau die ist, die getestet wird, ist das JaCoCo Maven Plugin von EclEmma (oder Sonar) nicht mehr in der Lage die Code Coverage dieser Klasse zu bestimmen.

Die ermittelte Code Coverage liegt bei 0%, was ja nicht ganz der Wahrheit entspricht.

Alternativ zu der @RunWith Deklaration könnte man jedoch mit sogenannten JUnit Rules arbeiten. Es gibt nämlich auch für Powermock eine solche PowermockRule:

@PrepareForTest({ MyClass.class })
public class MyClassTest {

    @Rule
    public PowerMockRule rule = new PowerMockRule();
    ...
}

Wie genau die PowerMockRule in Projekten eingebunden werden kann, findet sich hier.

Die Checkliste für Maven-JUnit-basierte Projekte ist simpel:

1. Füge die Dependency hinzu:

   <dependency>
      <groupId>org.powermock</groupId>
      <artifactId>powermock-module-junit4-rule-agent</artifactId>
      <version>LATEST</version>
      <scope>test</scope>
   </dependency>
   

2. Stelle sicher, dass diese Dependency VOR JUnit geladen wird.
3. Importiere die Rule:

   import org.powermock.modules.junit4.rule.PowerMockRule;
   

In einigen Fällen funktioniert diese Lösung leider nicht direkt, weil beim Ausführen des Tests folgender Fehler geworfen wird:

java.lang.VerifyError: Expecting a stackmap frame at branch target ***
Exception Details:
Location:
...
Reason:
Expected stackmap frame at this location.
Bytecode:
0x0000000: 2a2b b600 2c4d 2cc1 002e 9900 0b2c c000
0x0000010: 2eb6 0031 b001 b0

at java.lang.Class.getDeclaredConstructors0(Native Method)
...
at org.powermock.modules.junit4.rule.PowerMockStatement.evaluate(PowerMockRule.java:63)
...
at org.eclipse.jdt.internal.junit4.runner.JUnit4TestReference.run(JUnit4TestReference.java:50)

Je nach JDK Version gibt es nun unterschiedliche Möglichkeiten, diesen Fehler zu verhindern:

• JDK 7 JVM-Option: -XX:UseSplitVerifier
• JDK 8 JVM-Option: -Xverify:none

Es scheint ein Problem mit der ByteCode Manipulation durch ASM (javassist-3.8.1) zu geben.