如何知道我们的E2E测试覆盖率？

在单元测试中，很容易知道已经覆盖了哪些代码区域。但是我们能及时知道API调用的动态范围吗？我们一直在思考，既然已经编写了许多 E2E 测试用例，但是我们应该继续编写多少剩余测试？

在单元测试中，很容易知道已经覆盖了哪些代码区域。但是我们能及时知道API调用的动态范围吗？我们一直在思考，既然已经编写了许多 E2E 测试用例，但是应该继续编写多少剩余测试？永远不够？或者我们可以止步于此？

我们需要一个可以告诉当下在哪里的女巫，她就是 Java Agent。

什么是 Java Agent

什么是Java代理？

Java代理是为应用程序提供检测功能的软件组件。在代理的上下文中 ，检测提供了重新定义在运行时加载的类内容的功能。

幸运的是，我们有 Jacoco 代理。Jacoco 代理是 Java 代理之一，它可以在 JVM 加载类文件时标记类代码，并在调用任何代码后及时计算覆盖范围。我们可以转储覆盖数据并上传到SonarQube以使其可视化，获取最新的Jacoco代理。

我们可以从其官方网站（https://www.eclemma.org/jacoco/）获得最新的 jacoco 代理。请随时将最新的* .zip文件下载到本地计算机并解压缩。只需要使用以下两个文件：

• lib / jacocoagent.jar –> Java代理用以标记代码
• lib / jacococli.jar –> CLI转储覆盖率数据并生成报告

宿主应用程序启动参数设置

开始了！假设有一个伪装的后端服务应用程序，我们将其命名为“ MyBackendService.jar ”。该服务提供了一些RESTful API。一旦任何外部应用程序调用了这些API，我们都希望在服务运行良好时计算覆盖率。啊..听起来像是基本的E2E测试场景，对吧？最大的不同是，我们将自动打开浏览器来模拟用户操作（键入或单击）以与后端服务进行交互。

有一种经典的方式（java-jar any.jar）来启动后端服务并设置参数“ -javaagent ”的值。

java-javaagent:/lib/jacocoagent.jar=includes=*,output=tcpserver,port=6300,address=localhost,append=true -jar MyBackendService.jar

• output = tcpserver：这代表JacocoAgent将侦听端口以处理进一步的请求，以下载覆盖数据。
• port = 6300：这意味着jacoco代理正在侦听哪个端口。
• include =* ：这意味着我们可以过滤应该包括哪些源代码。例如include = com.fizz.api。：com.buzz.controller。

如果我们通过 Docker 运行后端服务怎么办？我强烈建议您在 docker 镜像中构建jacocoagent。有一个可能的 Dockerfile 示例，如下所示:

#### Dockerfile #####ENV JACOCOAGENT_OPTION-javaagent:/jacocoagent.jar=includes=*,output=tcpserver,port=6300,address=*,append=trueCOPY ${JACOCO_AGENT} /jacocoagent.jarADD /MyBackendService.jar /App.jarENTRYPOINT java ${JACOCOAGENT_OPTION} -server -jar /App.jar
Watch out! Don't forget to expose the port jacocoagent is litening on. docker run -d -p 32399:33399 -p 6300:6300 myBackendServiceImage:latest

转储覆盖率数据

几次之后，我假设您的后端 API 服务已经被调用了很多次。现在是时候转储 coverage 数据了。

java -jar /lib/jacococli.jar dump --address localhost --port
6300 --destfile ./coverage.exec

执行上面的命令以从 jacocoagent tcp 服务器检索 coverage 数据，并将数据写入名为 coverage.exec 的本地文件。

生成可视化报告

覆盖率数据文件（coverage.exec）对任何人都没有意义。我们可以将其可视化为 html 或 xml 报告。这是人类友好的格式。

java -jar /lib/jacococli.jar report ./coverage.exec --classfiles ./build/classes --html htmlReportFolder --xmlxmlReportFileName.xml

• –classfiles：此参数是必需的，它必须是已编译的类文件的目录路径。例如，如果使用Maven作为构建工具，则应为“ yourPorjectDirectory / taget / classes”。如果是Gradle，则应为“ yourProjectDirectory / build / classes”。

您应该能够检查 htmlReportFolder 或 xml 文件以立即查看覆盖范围，或者出现了其他意外情况。

将报告上传到SonarQube（可选）

如果您有一个独立的 SonarQube 服务器，这非常好，因为我们可以将覆盖率数据报告上传到 Sonar Web 服务器，以便其他任何人都可以查看。

./mvnw sonar:sonar-Dsonar.coverage.jacoco.xmlReportPaths=./xmlReportFileName.xml-Dsonar.java.binaries=./build/classes-Dsonar.sources=./src/main/java-Dsonar.inclusions="**/*Api.java,**/*Controller.java"

• sonar.coverage.jacoco.xmlReportPaths：我们在上一步中生成的xml报告 文件的完整路径。
• sonar.java.binaries：编译的类目录。
• sonar.inclusions：这是可选的，您可能想知道仅调用了多少个api。

结论

通常，这是您其中一个可能的解决方案，并且记住仅在基于 JVM 的语言中有效。可视化您的 E2E 测试覆盖范围可以指导回答我们身在何处的问题。