【问题标题】:Testing private static method that internally uses another private static method in Java在 Java 中测试内部使用另一个私有静态方法的私有静态方法
【发布时间】:2016-06-28 08:14:22
【问题描述】:

我有一个 A 类,如下所示:

public class A {

  // there is a public API that uses both
  // method1 and method2, but that's not important
  // in this question.
  public Integer publicApi(Integer a, Integer b) {
    // a bunch of other stuff is done that is 
    // not related to method1 or method2 here.
    // However, method1 IS used somewhere in here.
    // For now, I don't want to test other
    // implementation details for this API, I only
    // am interested in testing method1.

    return method1(a, b);
  }

  private static Integer method1(Integer a, Integer b) {
    if(method2(a, b, 10) == null) {
      return -1;
    }
    return 10 + method2(a, b, 10);
  }

  private static Integer method2(Integer a, Integer b, Integer c) {
    // some complicated logic with multiple values 
    // to return (based on various conditions).

    // however, I want to simply test what happens
    // when this method returns null (which is a possibility).
    return a+b+c;
  }
}

正如给出的那样,我的 A 类有一个公共 API,它(有点)复杂的逻辑,我不想测试(出于这个问题的目的)。假设我只对测试method1 感兴趣。

这是我的测试代码(我正在使用 PowerMockito):

import org.junit.Test;
import org.junit.runner.RunWith;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.PowerMockRunner;

import java.lang.reflect.Method;
import static org.junit.Assert.assertNull;
import static org.powermock.api.mockito.PowerMockito.spy;
import static org.powermock.api.mockito.PowerMockito.when;
import static org.powermock.api.support.membermodification.MemberMatcher.method;

@RunWith(PowerMockRunner.class)
@PrepareForTest(A.class)
public class SimpleTest {

  @Test
  public void testMethod1Invocation() throws Exception {

    spy(A.class);

    when(A.class, method(A.class,
        "method2", Integer.class,
        Integer.class, Integer.class))
        .withArguments(1, 2, 10)
        .thenReturn(null);

    // use reflection to call method1
    Method method1 = A.class.getDeclaredMethod(
        "method1",
        Integer.class, Integer.class
    );

    method1.setAccessible(true);
    Object ret = method1.invoke(1, 2);
    assertEquals(-1, ret);
  }
}

但是,我收到以下错误:

com.apple.geo.tart.A.method1(java.lang.Integer, java.lang.Integer, java.lang.Integer)
java.lang.NoSuchMethodException: com.apple.geo.tart.A.method1(java.lang.Integer, java.lang.Integer, java.lang.Integer)
    at java.lang.Class.getDeclaredMethod(Class.java:2130)
    at com.apple.geo.tart.SimpleTest.testMethod1Invocation(SimpleTest.java:32)

我看不出我在这里做错了什么。在我看来,这里需要三件事:

  1. 监视A,这样我就可以模拟when/thenReturn on the static 方法。
  2. 模拟我感兴趣的私有静态方法(在本例中为method2)。
  3. 使用反射访问method1,然后调用它。

然后我如何模拟私有静态方法(method2),以便我可以测试依赖于第一个的同一类的另一个私有静态方法(method1)?

【问题讨论】:

  • 是否绝对有必要测试私有方法?一般来说,您应该只为公共方法编写测试。您可以输入verify 以查看是否在私有方法中调用了您的任何模拟。
  • 异常表示您使用 3 个参数查找 method1,而您的代码显示 2 个参数调用。尝试重新编译你的项目——看起来代码没有引用被测试的二进制文件。
  • @SergeyGrinev 我确实尝试过,清除了构建目录,并重新组装了代码(使用 Gradle)。但我仍然得到同样的错误。
  • @all,发现问题了。问题是method1.invoke(...)。它采用的第一个参数是调用方法的 object,而不是实际的 args!测试类的静态方法时,通常是null。将该方法调用更改为 method1.invoke(null, 1, 2) 会产生预期的结果。

标签: java junit powermockito


【解决方案1】:

在我们讨论它的可测试性之前,我对这段代码有一些问题:

  • method2 实际上将永远返回null。如果它的任何输入是null,您将得到一个NullPointerException,因为Java 试图解开null。因此,您尝试测试的条件是毫无意义的。
  • 隐藏这些方法确实没有任何价值。它们似乎在进行业务级计算,因此具有测试价值。

对于您最初的情况,我会这么说:我没有遇到与您相同的错误。从我在 Java 8 中看到的情况来看,您的 invoke 方法调用缺少一个参数,您需要使用该参数传递 method1 。

Object ret = method1.invoke(method1, 1, 2);

但是,我根本不推荐这样做。让我们将其分解为几个测试。

首先,让我们放宽对这些方法的限制。它们很可能是私有的,因为我们不会在其他地方暴露它们的行为,但如果我们将其弱化为包私有,可能不会有任何害处。从这些方法中删除 private 标记。

其次,实际测试这些方法!这些方法可能会受到null 的影响,您应该针对该场景进行测试。

第三,也是唯一在之后,您测试了其他两种方法,如果您回到您的publicApi 方法。此时,您所关心的只是使用正确的参数调用该方法。

【讨论】:

  • 感谢您的回答。关于你开头的第一个要点,正如我在method2 的评论中提到的,null 在我的用例中是一种可能性。例如:if(b == (a+c)/2) return null; 关于你的其他观点,我想我同意。将它们限制为包私有是一种方法。
  • 我建议不要在这种情况下返回null。肯定有更好的东西——比如一个数字——比如零——返回?
  • 所以你可能已经猜到了,我在上面的例子中掩盖了很多东西。我没有在我的应用程序中使用Integer 参数,但我只是在这里使用它们,因为我认为它们是一个很好的例子。在我的应用程序中,我实际上是在传入/传出自定义 Java 对象,并使用 null 作为 method2 中出现问题的标记。
  • 如果出现问题,请引发异常。这就是例外的原因。但这是我的建议。
  • 感谢您的 cmets!我根据您在答案中的建议重构了一些代码(删除了private 修饰符,现在我可以在测试中调用A.method1() 和A.method2() 等),这对于我的班级@987654341 来说似乎是一个合理的布局@。将此标记为已接受的答案。
猜你喜欢
  • 1970-01-01
  • 2012-07-14
  • 2022-11-20
  • 1970-01-01
  • 1970-01-01
  • 2023-04-01
  • 2015-04-17
  • 1970-01-01
  • 2010-11-04
相关资源
最近更新 更多