编写 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

考虑到您正在测试的方法的当前签名，实现全面覆盖并不容易：您的 catch 块仅在 try 块中抛出异常时执行。

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

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

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

现在您可以为第二种方法编写几个特定的单元测试。您保留只做 "correct" 阅读的测试；但是您在传入模拟的 reader 对象的地方添加了一个...它只是在某个时候抛出异常。请注意，我只将新方法设置为受保护的包——您可能不想使用它 "public"；并将其设为私有会阻止对其进行单元测试。

这应该可以帮助您实现全面覆盖。当然，您还需要至少对 "cover" 字符串获取方法进行一次测试。

一些注意事项：

小心重复发明轮子。已经有许多现有的 CSV 解析器。请放心：编写一个能够处理所有 "correct" 输入 CSV 的 correct CSV 解析器比听起来要难得多。如果这不是 "learning purposes" 我强烈建议不要编写你自己的 CSV 解析器。
小心做这样的事情静态。如前所述，真正的 CSV 解析器是一件复杂的事情，值得拥有它 class。所以没有静态辅助方法 - 一个正常的 class 实例化然后调用它的方法（这也将用于使用 依赖注入 这将有助于解决你正在询问的问题...在 try 块中抛出异常）
您在代码示例中遇到了 Exception。不要那样做 - 尝试准确捕获您的代码实际可能产生的那些异常（在您的情况下可能是 IOException）。

Answer 2

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

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));
    }
}

然后你必须找到一种方法将这种依赖关系注入你的 class。我通常在日常工作中使用 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 这样的模拟框架，class 在 IOException-s 的情况下的行为现在更容易测试（请注意，您也可以 return从工厂抛出异常的模拟）。这是一个示例：

@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 的适当覆盖率报告。

还要注意在节中提到的 JaCoCo 的限制 有例外的源代码行显示没有覆盖。为什么？

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

Writing Junit test to cover exception and catch block

java

junit

spring

unit-testing

junit4