当单元测试方法有断言而不是异常时,最佳做法是什么?

时间:2015-02-07 08:42:48

标签: java unit-testing exception junit assertions

我们假设您有一个像这样的公共方法

public Sprite spriteAt(int x, int y) 
{
    assert withinBorders(x, y) : "PRE: x and y should be inside the borders";

    return tileAt(x, y).topSprite();
}

对战

public Sprite spriteAt(int x, int y)
{
    if (!withinBorders(x, y)) throw new InvalidArgumentException();

    return tileAt(x, y).topSprite();
}

在底部的情况下,我通常会有一个单元测试用例,用于检查当给出x和/或y的无效值时是否抛出异常,如:

@Test(expected = InvalidArgumentException.class)
public void SpriteAt_InvalidX_ThrowsInvalidArgumentException()
{
    sut.spriteAt(-100, 0);
}

此测试用例是为了确保在方法中实现参数验证逻辑。

然而,对于顶部的断言方法,我不确定我应该做什么。断言不是生产代码,我认为这意味着我不必测试断言。

另一方面,我认为单元测试应该在方法中的逻辑更改失败时通知开发人员。如果我没有编写测试用例来检查是否存在检查无效参数的断言(就像我对异常方法所做的那样),那么当我意外删除代码断言行时,我可能没有意识到我犯了一个错误。

因此,我想要做的是检查断言是否已经到位,如果在启用断言的情况下运行junit并且在未启用断言时不执行任何操作。下面的代码将包含伪代码。

@Test
public void SpriteAt_InvalidX_AssertionThrowsException()
{
    if (assertion is enabled)
    {
        try
        {
             sut.spriteAt(-100, 0);
             fail();    
        }
        catch (AssertionFailureException e)
        {
        }
    }
}

回到我的观点。我想知道单元测试是否应该测试断言。如果是这样,我会朝着正确的方向前进吗?如果没有,如何在没有单元测试的情况下防止意外删除断言代码?

2 个答案:

答案 0 :(得分:2)

有趣的问题。

在我看来,如果您想要测试 xy明显不在范围内的情况,那么您应该抛出IllegalArgumentException而不使用assert。另一方面,您没有方法评论,告诉此方法的调用者xy必须在一个范围内。因此,如果您从调用者的角度看到它,您根本没有权利断言。 :-p

我会使用assert来检查我没有单元测试的前置条件。但另一方面,您应该对该示例进行单元测试。

在一天结束时,assert也会抛出一个RuntimeException,并且 - 正如您所说 - 仅在编译器标志的开发时间内。那么为什么不简单地使用IllegalArgumentException,这似乎是完美的。并且请给方法的调用者提供提示,在这种情况下,它会被@throws注释抛出。

我的结论:assert只要你有良好的单元测试覆盖率就没用了。 仅适用于开发期间的手动测试,以检查您不想要或可以为其编写显式单元测试的前提条件。

答案 1 :(得分:0)

如果使用assert java命令参数打开它,您始终可以测试-ea功能。

assert抛出java.lang.AssertionError

单元测试应该测试行为,而不是实现。因此,如果未在合同(JavaDoc)中明确定义asert行为,则不应对其进行测试。

assert非常无用,几乎从未在真实系统中使用过。