現(xiàn)象
最近在補單測覆蓋率的過程中遇到了一個奇怪的錯誤, 在添加了PowerMock(版本2.0.9)的@PrepareOnlyThisForTest注解后, 出現(xiàn)了一個奇怪的錯誤: "No tests found ....". 然而明明加了@Test注解. 代碼示例如下:
/**
* 類的實現(xiàn)描述: 一個靜態(tài)類
*/
public class ConstantUtil {
public static int getCount() {
return 100;
}
}
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PrepareOnlyThisForTest;
import org.powermock.modules.junit4.PowerMockRunner;
/**
* 類的實現(xiàn)描述: 一個測試類
*/
@RunWith(PowerMockRunner.class)
public class AbcUnitTest {
@Test
public void testA() {
Assert.assertEquals(1, 1);
}
@Test
@PrepareOnlyThisForTest(ConstantUtil.class)
public void testB() {
PowerMockito.mockStatic(ConstantUtil.class);
PowerMockito.when(ConstantUtil.getCount()).thenReturn(50);
Assert.assertEquals(50, ConstantUtil.getCount());
}
}
這個錯誤非常奇怪, 而更奇怪的是我用mvn test運行時確沒有這個異常(開始是用IDEA運行的). 網(wǎng)上找了半天也沒一個合理的解釋. 于是跟蹤代碼看了一下.
排查
跟蹤后發(fā)現(xiàn)異常來自類PowerMockJUnit44RunnerDelegateImpl.
@Override
public void filter(Filter filter) throws NoTestsRemainException {
for (Iterator<Method> iter = testMethods.iterator(); iter.hasNext(); ) {
Method method = iter.next();
if (!filter.shouldRun(methodDescription(method)))
iter.remove();
}
if (testMethods.isEmpty())
throw new NoTestsRemainException();
}
PowerMock在運行單測時, 會根據(jù)單測類的源代碼,本例中就是AbcUnitTest, 生成若干個Delegate. 每一個Delegate中都會有對應的testMethods, 本例中照理說應該是testA,和testA兩個方法(為什么說是照理說? 因為這里就是錯誤的原因). Delegate會把testMethods中的每一個方法跟需要運行的方法對比, 如果不是需要運行的方法, 就從testMethods中移除, 最后如果testMethods中一個方法都沒有, 就拋出"No tests found ....". 那現(xiàn)在問題就變成了為什么這個Delegate中沒有需要運行的方法(也就是testB)呢?
首先debug代碼驗證一下拋出異常的Delegate中是否只有方法testA?
符合期望. 猜測@PrepareOnlyThisForTest注解使得PowerMock把原來的代碼切割成了兩個Delegate, 每個Delegate只包含一個方法. 那這個切割是在哪里做的呢?
最后發(fā)現(xiàn)在類AbstractCommonTestSuiteChunkerImpl中有一個方法putMethodToChunk, 這個方法會根據(jù)源代碼中@Test注解的方法添加到不同的chunk中, 而最終一個chunk會對應一個Delegate. 該方法的代碼如下:
private void putMethodToChunk(TestCaseEntry testCaseEntry, Class<?> testClass, Method method) {
if (shouldExecuteTestForMethod(testClass, method)) {
currentTestIndex++;
if (hasChunkAnnotation(method)) {
LinkedList<Method> methodsInThisChunk = new LinkedList<Method>();
methodsInThisChunk.add(method);
final ClassLoader mockClassloader = createClassLoaderForMethod(testClass, method);
final TestChunkImpl chunk = new TestChunkImpl(mockClassloader, methodsInThisChunk);
testCaseEntry.getTestChunks().add(chunk);
updatedIndexes();
} else {
testCaseEntry.getTestChunks().get(0).getTestMethodsToBeExecutedByThisClassloader().add(method);
// currentClassloaderMethods.add(method);
final int currentDelegateIndex = internalSuites.size() - 1;
/*
* Add this test index to the main junit runner
* delegator.
*/
List<Integer> testList = testAtDelegateMapper.get(currentDelegateIndex);
if (testList == null) {
testList = new LinkedList<Integer>();
testAtDelegateMapper.put(currentDelegateIndex, testList);
}
testList.add(currentTestIndex);
}
}
}
可以看到這個方法中有兩個分值, 根據(jù)條件hasChunkAnnotation(method)來決定是否新建一個chunk, 是就新建, 否則放入已有的chunk. 查看方法hasChunkAnnotation(method), 代碼如下;
private boolean hasChunkAnnotation(Method method) {
return method.isAnnotationPresent(PrepareForTest.class) || method.isAnnotationPresent(SuppressStaticInitializationFor.class)
|| method.isAnnotationPresent(PrepareOnlyThisForTest.class) || method.isAnnotationPresent(PrepareEverythingForTest.class);
}
非常簡單的函數(shù), 根據(jù)注解來決定是否新建chunk, 而其中恰恰包含PrepareForTest注解.
原因找到, 這也可以解釋為什么mvn test運行時不會報錯, 因為mvn test運行時, 兩個方法testA和testB都是需要運行的方法, 兩個Delegate中各包含一個需要運行的方法. 而解決方法也相當容易, 把注解加到類上即可(事實上這個方法在stackoverflow上有人提了(https://stackoverflow.com/questions/34956084/junit-test-with-runwithpowermockrunner-class-fails-no-tests-found-matching/40287112#40287112), 因為提問者沒有采納, 所以當時沒有放在心上, 而更郁悶的是答案下面有兩個評論說"saved my day". 而我被這個錯誤糾纏了半天, 因為一開始一直覺得是版本問題, 試了各種各樣的版本, 不相信PowerMock會有這樣的bug(個人認為這應該算是bug).
