SonarQube为带有断言的单元测试发出“向该测试用例添加至少一个断言”？

Question

我对SonarQube有问题，我的几个单元测试都有问题，引发了以下问题：

为此测试用例添加至少一个断言。

每个测试用例都类似于此格式（其中许多断言被委托给具有公共断言的方法，以避免重复）：

@Test
public void companyNameOneTooLong() throws Exception {
    AddressFormBean formBean = getValidBean();
    formBean.setCompanyNameOne("123456789012345678901234567890123456");

    assertViolation(validator.validate(formBean), "companyNameOne", "length must be between 0 and 35");
}

private void assertViolation(Set<ConstraintViolation<AddressFormBean>> violations, String fieldname, String message) {
    assertThat(violations, hasSize(1));
    assertEquals(fieldname, violations.iterator().next().getPropertyPath().iterator().next().getName());
    assertEquals(message, violations.iterator().next().getMessage());
}

现在，很明显，我可以从私有方法中提取这三个断言，并将它们放在测试方法中，但我正在多次执行相同的检查（在不同的字段上）。

所以，我想我会尝试通过（重新）抛出AssertionError来模拟断言方法的行为：

private void assertViolation(Set<ConstraintViolation<AddressFormBean>> violations, String fieldname, String message) throws AssertionError {
    try {
        assertThat(violations, hasSize(1));
        assertEquals(fieldname, violations.iterator().next().getPropertyPath().iterator().next().getName());
        assertEquals(message, violations.iterator().next().getMessage());
    } catch (AssertionError e) {
        throw e;
    }
 }

不幸的是，这种方法也不起作用。

JUnit断言方法有什么特别之处/SonarQube特别寻找什么来检查是否为每个测试做出了断言？

或者，是否有其他方法可以实现相同的最终结果（避免重复共享断言代码）？

Answer 1

有时您不需要任何代码或断言，例如，成功加载Spring Boot上下文的测试。在这种情况下，为了防止在测试中不会抛出任何异常时出现声纳问题，可以使用以下代码部分：

@Test
void contextLoads() {
    Assertions.assertDoesNotThrow(this::doNotThrowException);
}

private void doNotThrowException(){
    //This method will never throw exception
}

Answer 2

如果您不希望从测试中抛出任何异常，这可以是一种解决方法：

@Test(expected = Test.None.class /* no exception expected */)

或者，可以抑制测试方法/测试类的警告：

@SuppressWarnings("squid:S2699")

Answer 3

SonarQube Java Analyzer的规则S2699（测试应包括断言）不执行跨过程分析，只探索被识别为测试方法的方法体（通常用测试注释）。

因此，如果在执行测试方法时将被调用的唯一断言是由专用方法完成的（以避免重复），那么该规则将引发一个问题。这是规则的已知限制，我们只有在能够有效地执行跨过程分析时才会处理它。

关于SonarQube在这种情况下提出的问题，您可以安全地将它们标记为不会修复。

关于检测到的断言，规则将以下（单元测试）框架中的常规断言方法视为断言：

• JUnit
• 节日（1. x