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

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

考虑到被测试方法的当前特征，实现完全覆盖并不容易：只有在try块中抛出异常时，才会执行catch块。

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

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解析器是一个复杂的东西，值得拥有完整的类。所以没有静态助手方法——一个普通的类，您可以实例化它，然后调用它的方法（这也适用于使用依赖注入，这将有助于解决您正在询问的问题......在try块中抛出异常）
3. 您正在代码示例中捕获异常。不要这样做-尝试准确捕获您的代码实际可以产生的异常（在您的情况下可能是IOException）。

Answer 2

在这种情况下，您可能会经常考虑在类中引入其他依赖项。下面是一个粗略的例子。为读者创建一个工厂：

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提供的相应覆盖率报告。

还要注意这里提到的JaCoCo的一个局限性，在第节中，除了例外，源代码行没有覆盖范围。为什么？