如何编写JUNIT测试案例以进行比较代码覆盖

Question

我有一个使用比较器界面的分类机制，如下所示：

    public class SortByEmployeeIdByDesc implements Comparator<Employee> {

    public int compare(Employee a, Employee b)
    {
        return b.getEmpId().compareTo(a.getEmpId());
    }

   }

这是我的员工类：

    @Builder
    @AllArgsConstructor
    @NoArgsConstructor
    public class Employee {
      @Getter
      private String empId;

      private String empName;

      private Date createdTime;

      @Getter
      private Date lastUpdatedTime;
    }

我已经为上述比较器书写了类似的测试用例：

    @ExtendWith(MockitoExtension.class)
    public void EmployeeSortTest{

    @Test
    public void sortEmpDescloyeeTest() {
    
    Employee emp1 = new Employee("abc", "test", "2020-10-10", "2010-10-10");
    Employee emp2 = new Employee("xyz", "test2", "2022-03-04", "2022-03-04");
    
    List<Employee> sortEmp = new ArrayList<>();
    sortEmp.add(emp1);
    sortEmp.add(emp2);
    
    Collections.sort(sortEmp, new SortByEmployeeIdByDesc());
    assertEquals(emp1, sortEmp.get(1));
}
}

上面的测试案例成功运行，但是当我在Sonar中检查时，它并不能涵盖代码。是否有更好的JUNIT测试方法，以便覆盖范围至少增加到90％？

Answer 1

我已经对语言版本和依赖项做出了一些假设，并运行您的代码：

• Java 8+（语言级别8）
• Junit 5（jupiter）

您的new Employee（...）构造仪不起作用，因为您的@allargsconstructor期望date对象而不是String。

假设您使用的是Java8+，则应使用localdate而不是date。

代码覆盖范围得出以下结果。

员工Java：50％
未覆盖的行：

@Builder
@NoArgsConstructor
// omitted for brevity
@Getter
private LocalDate lastUpdatedTime;

sortbyeMployeeIdByDesc：100％

要涵盖新行，您应该考虑更改测试类，如下（例如）：

@ExtendWith(MockitoExtension.class)
class SortByEmployeeIdByDescTest {

    private static final LocalDate MIN_CREATED = LocalDate.of(2020, 10, 10);
    private static final LocalDate MIN_LASTUPDATED = LocalDate.of(2020, 10, 10);

    @Test
    void sortEmpDescloyeeTest() {
        Employee emp1 = new Employee("abc", "test", MIN_CREATED, MIN_LASTUPDATED);
        Employee emp2 = new Employee("xyz", "test2", LocalDate.of(2022, 3, 4), LocalDate.of(2022, 3, 4));

        List<Employee> sortEmp = new ArrayList<>();
        sortEmp.add(emp1);
        sortEmp.add(emp2);

        sortEmp.sort(new SortByEmployeeIdByDesc());
        assertEquals(emp1, sortEmp.get(1));
    }

    @Test
    void noArgsConstructorTest() {
        Employee employee = new Employee();
        assertNull(employee.getEmpId());
        assertNull(employee.getLastUpdatedTime());
    }

    @Test
    void builderTest() {
        Employee expectedEmployee = new Employee("testId", "test", MIN_CREATED, MIN_LASTUPDATED);
        Employee employee = Employee.builder()
            .empId("testId")
            .empName("test")
            .createdTime(MIN_CREATED)
            .lastUpdatedTime(MIN_LASTUPDATED)
            .build();
        assertEquals(expectedEmployee.getEmpId(), employee.getEmpId());
        assertEquals(expectedEmployee.getLastUpdatedTime(), employee.getLastUpdatedTime());
    }
}

因为您仅声明@getter其中两个字段，您无法在BuilderTest中测试其他字段。

如果要比较所有字段可以执行以下操作：

1. 添加@equalsandhashcode雇员上的注释 -

     @builder
    @AllargSconstructor
    @noargsconstructor
    @equalsandhashcode //此注释添加了平等和哈希码方法
    公共班员工
    //简短省略
    

2. 更改builderTest代码，如下所示 -

     @test
    void builderTest（）{
        员工Expectee Employee =新员工（“ testID”，“ test”，min_created，min_lastupded）;
        员工雇员=雇员.builder（）
            .empid（“ testID”）
            .empname（“测试”）
            。
            。
            。建造（）;
        assertequals（预期员工，雇员）； //您现在使用平等
                                                  //而不是测试
                                                  //每个字段 
                                                  //单独
    }
    

这两种方法（使用或不使用@equalsandhashcode注释）产生100％代码覆盖范围。请记住，除非您在守望者和二传手中具有逻辑，否则覆盖它们通常被认为是微不足道的，因为您本质上是在测试Java分配，这可能会假定工作。

Answer 2

要测试比较器，第一个想法可能是将一些项目添加到列表中，对列表进行排序，然后确保对项目进行正确排序。

但是，这种方法的缺点很差：排序列表会尽可能少地比较，这与您要完成的工作完全相反。另外，根据排序算法，您无法确定完全比较了哪些组合。

我曾经写过comparatterter，该列出了元素列表，然后将每个元素与每个元素进行比较。它还确保比较器是反射性，反对称性和及时性的。

当我谷歌搜索comparatortester时，我发现 firebase的实现，它与我自己的实现非常相似，因为它使用了完全相同的想法。这就是您应该遵循的方法。

在琐碎的用例中，您甚至不需要编写自己的比较器类，这是Java 8之前的一件事。如今，通过单个属性进行排序变成了一个单元：

employees.sort(Comparator.comparing(Employee::getEmpId).reversed());

Answer 3

comparator.compare（t o1，t o2） javadoc state （添加了强调）：

返回：A 负整数，零或正面整数
因为第一个论点小于，等于或大于
第二。

因此，在最小上，您的测试需要涵盖上述三个条件：

class SortByEmployeeIdByDescTest {

    @Test
    void compareEmployees() {
        final List<Employee> employees = Stream.of("2", "1", "3", "2")
                .map(id -> Employee.builder().empId(id).build())
                .collect(Collectors.toList());

        Collections.sort(employees, new SortByEmployeeIdByDesc());

        assertThat(employees).extracting(Employee::getEmpId)
                .containsExactly("3", "2", "2", "1");
    }
}

我正在使用 assertj 在此示例中，强烈建议您在项目中使用它。

此外，您的员工ID是字符串。因此，您需要进行测试，以便它是null。然后，您将获得所需的覆盖范围。