编写 Junit 测试以覆盖异常和 catch 块

Question

我已经为以下功能编写了 Junit 测试用例。当检查 JACOCO 测试覆盖率时。它显示只有 try 块被测试用例覆盖。我是编写测试用例的新手。如何在测试用例中覆盖异常和 catch 块

这是一个方法

  public static List<Student> readCsvFile(String fileName)
    {

       BufferedReader fileReader = null;

//logic to read file    
}
catch (Exception e)
{
   System.out.println("Error in CsvFileReader !!!");
   e.printStackTrace();
        } finally
        {
            try
            {
                fileReader.close();
            } catch (IOException e)
            {
                System.out.println("Error while closing fileReader !!!");
                e.printStackTrace();
            }
        }
        return students;
    }

和测试方法

@Test
    public void ReadCsvFileTest()
    {
        String fileName = "test.csv";
        List<Student> result = new ArrayList<Student>();
        result = CsvFileReader.readCsvFile(fileName);

        Student student1 = null;

        Iterator<Student> it = result.iterator();
        while (it.hasNext())
        {
            Student s = it.next();
            if ("471908US".equals(s.getId()))
            {
                student1 = s;
                break;
            }
        }

        assertTrue(student1 != null);
    }

Answer 1

在这种情况下，您可能经常考虑为您的类引入额外的依赖项。这是我用一个粗略的例子的意思。为读者创建工厂：

interface BufferedReaderFactory
{
    public BufferedReader createBufferedReader(String fileName) throws IOException;
}

然后您将拥有一个几乎不需要任何测试的简单实现，例如类似的东西：

class BufferedReaderFactoryImpl implements BufferedReaderFactory
{
    @Override
    public BufferedReader createBufferedReader(String fileName) throws IOException
    {
        return new BufferedReader(new FileReader(fileName));
    }
}

然后你必须想办法把这个依赖注入你的类。我通常在日常工作中使用Guice，但您可以尝试一些简单的方法，例如使用构造函数注入并使您的方法非静态。这是一个例子：

class CsvFileReader
{
    private final BufferedReaderFactory factory;

    public CsvFileReader(BufferedReaderFactory factory)
    {
        this.factory = factory;
    }

    public List<Student> readCsvFile(String fileName)
    {

        BufferedReader fileReader = null;
        try
        {
            fileReader = factory.createBufferedReader(fileName);
            ...
        }
        catch(IOException e)
        {
            ...
        }
        finally
        {
            ...
        }
        return new LinkedList<>();
    }
}

使用像Mockito 这样的模拟框架，这个类在IOException-s 的情况下的行为现在更容易测试（请注意，您也可能返回从工厂抛出异常的模拟）。这是一个示例：

@RunWith(MockitoJUnitRunner.class)
public class MyTest
{
    @Mock
    private BufferedReaderFactory mockFactroy;

    @Test
    public void testIOException() throws IOException
    {
        String ivalidFileName = "invalid.txt";
        //throw exception in case that invalid file name is passed to the factory
        Mockito.when(mockFactroy.createBufferedReader(ivalidFileName)).thenThrow(new IOException("Hello!"));

        CsvFileReader csvFileReader = new CsvFileReader(mockFactroy);
        //invoke with a factory that throws exceptions
        csvFileReader.readCsvFile(ivalidFileName);
        //...
        //and make a sensible test here, e.g. check that empty list is returned, or proper message is logged, etc.
    }
}

当然，您可以在没有 Mockito 的情况下做到这一点 - 通过实现一个测试工厂。但这更麻烦，尤其是在更复杂的用例中。抛出 IOException 后，您将获得 JaCoCo 的相应覆盖率报告。

还请注意 here 中提到的 JaCoCo 的限制，在 带有异常的源代码行部分显示没有覆盖。为什么？

Answer 2

鉴于您被测方法的当前签名，要全面覆盖并不容易：您的 catch 块仅在您的 try 块中引发异常时才会执行。

解决这个问题的一种方法：不要传入文件名，而是传入阅读器对象本身。喜欢：

public static List<Student> readCsvFile(String fileName) {
  return readCsvFile(new BufferedReader(fileName));
}

static List<Student> readCsvFile(BufferedReader reader) { 
  try {
    ...
  } catch( ...

现在您可以为第二种方法编写几个特定的​​单元测试。你保持你的测试只是做“正确”的阅读；但是你在传入一个模拟的阅读器对象的地方添加了一个......它只是在某个时候抛出一个异常。请注意，我使这个新方法只是包保护 - 你可能不想使用那个“公共”；并将其设为私有会阻止它进行单元测试。

这应该可以帮助您实现全面覆盖。当然，你还需要至少一个测试来“覆盖”取弦方法。

一些注意事项：

1. 小心重新发明轮子。已经有许多现有的 CSV 解析器。请放心：编写一个能够处理所有“正确”输入 CSV 的 正确 CSV 解析器比听起来要难得多。如果这不是出于“学习目的”，我强烈建议您不要编写自己的 CSV 解析器。
2. 小心静态。如前所述，真正的 CSV 解析器是一件复杂的事情，值得拥有自己的完整课程。所以没有静态辅助方法 - 您实例化的普通类，然后在其上调用方法（这也将用于使用 dependency injection 这将有助于解决您所询问的问题......在其中抛出异常尝试块）
3. 您在代码示例中遇到了 Exception。不要那样做 - 尝试准确捕获您的代码实际产生的那些异常（在您的情况下可能是 IOException）。