使用 JUnit 5 进行 IOException Catch 代码覆盖率测试_技术教程

本文旨在提供一种使用 JUnit 5 框架，对包含 `IOException` 异常捕获的 Java 代码进行有效覆盖率测试的实用方法。通过重构待测代码，将可能抛出 `IOException` 的部分提取成可覆盖的 protected 方法，并利用子类重写该方法，模拟 `IOException` 的抛出，从而实现对异常处理逻辑的测试覆盖。

在进行单元测试时，确保代码覆盖率至关重要，特别是对于异常处理逻辑。然而，当 IOException 等受检异常被捕获时，直接模拟异常的抛出可能会比较困难。本文将介绍一种通过代码重构和继承的方式，利用 JUnit 5 框架实现对 IOException 捕获块进行覆盖率测试的方法。

代码重构

首先，需要对原始代码进行重构，将可能抛出 IOException 的部分提取到一个单独的 protected 方法中。例如，对于以下代码：

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;

public class ServiceToTest {
    public void unzip(byte[] zipFile) {
        try (ZipInputStream zipInputStream = new ZipInputStream(new ByteArrayInputStream(zipFile))) {
            ZipEntry entry;
            while ((entry = zipInputStream.getNextEntry()) != null) {
                byte[] buffer = new byte[1024];
                int len;
                try (var file = new ByteArrayOutputStream(buffer.length)) {
                    while ((len = zipInputStream.read(buffer)) > 0) {
                        file.write(buffer, 0, len);
                    }
                    System.out.println(entry.getName());
                }
            }
        } catch (IOException e) {
            System.out.println(e.getMessage());
            // some logic or rethrow the exception
        }
    }
}

可以将其重构为：

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;

public class ServiceToTest {
    public void unzip(byte[] zipFile) {
        try (ZipInputStream zipInputStream = new ZipInputStream(new ByteArrayInputStream(zipFile))) {
            writeToFile(zipInputStream);
        } catch (IOException e) {
            System.out.println(e.getMessage());

        }
    }

    protected void writeToFile(ZipInputStream zipInputStream) throws IOException {
        ZipEntry entry;
        while ((entry = zipInputStream.getNextEntry()) != null) {
            byte[] buffer = new byte[1024];
            int len;
            try (ByteArrayOutputStream file = new ByteArrayOutputStream(buffer.length)) {
                while ((len = zipInputStream.read(buffer)) > 0) {
                    file.write(buffer, 0, len);
                }
                System.out.println(entry.getName());
            }
        }
    }

}

现在，writeToFile 方法成为了 protected 方法，并且声明了抛出 IOException。

创建测试类和子类

接下来，创建一个测试类 ServiceTest 和一个继承自 ServiceToTest 的子类 ServiceToTestChild。在 ServiceToTestChild 中，重写 writeToFile 方法，使其直接抛出 IOException。

import org.junit.jupiter.api.Test;

import java.io.File;
import java.io.IOException;
import java.util.zip.ZipInputStream;


class ServiceTest {

    @Test
    public void shouldUnzip() {
        ServiceToTest serviceToTest = new ServiceToTest();
        serviceToTest.unzip(new File("yourFilePath").toString().getBytes());

        //Assert happy path
    }


    @Test
    public void shouldThrowIOException() {
        ServiceToTest serviceToTest = new ServiceToTestChild();
        serviceToTest.unzip(new File("yourFilePath").toString().getBytes());

        //Assert exception path
    }

    private class ServiceToTestChild extends ServiceToTest {
        @Override
        protected void writeToFile(ZipInputStream zipInputStream) throws IOException {
            throw new IOException();
        }
    }
}

编写测试用例

在 ServiceTest 类中，编写两个测试用例：

shouldUnzip：测试正常情况，即不抛出 IOException 的情况。
shouldThrowIOException：测试异常情况，通过使用 ServiceToTestChild 实例，使 unzip 方法捕获 IOException。

在 shouldThrowIOException 测试用例中，创建 ServiceToTestChild 的实例，并调用 unzip 方法。由于 ServiceToTestChild 重写了 writeToFile 方法并使其抛出 IOException，因此 unzip 方法的 catch 块将被执行，从而实现对 IOException 捕获块的覆盖。

注意事项：

确保替换 new File("yourFilePath").toString().getBytes() 为实际存在的zip文件路径，或者使用模拟的byte数组。
在 shouldThrowIOException 测试用例中，可以添加断言来验证异常处理逻辑是否正确执行，例如，检查异常信息是否符合预期。
此方法依赖于代码重构，需要仔细考虑重构对现有代码的影响。