使用Maven的测试 - 组织单元和集成测试

• Testing with Maven - Organizing unit and integration tests
  • Introduction
  • How does a Maven project look like?
  • What does Maven Surefire plugin do?
  • Why isn't Surefire plugin good for running integration tests?
  • Maven Failsafe Plugin
  • How does Maven Failsafe plugin work?
  • How to organize tests properly in your Maven project?
    • Mix unit and integration tests
    • Advantages
    • Disadvantages
    • Separate unit and integration tests on package level
    • Advantages
    • Disadvantages
    • Separate unit and integration tests or root folder level
    • How to set it up?
      • Maven Compiler Plugin Way
      • build-helper-maven-plugin way
    • Advantages
    • Disadvantages
    • Surprise option: New maven module
    • Advantages
    • Disadvantages
  • Summary
  • Follow Rodnan Sol for more
  • Follow the author too

介绍

您是否正在项目中进行单元和集成测试？但愿如此！

测试是一个良好的工作和高质量软件的基本面，即使他们的客户说ð¥。

如果您是Java开发人员，您可能知道那里的不同构建工具及其对写作和运行单元和集成测试的支持：

• ant
• Maven
• gradle
• 你命名

在这篇文章中，我们将重点关注由ASF（Apache Software Foundation）构建和维护的 Maven 。

Maven是一个美丽的项目，它帮助数百万个项目进行了生效，这是一个行业标准，但即使数百万个项目都取决于它，也没有什么是完美的。在这篇文章中，我们不会找到Maven构建工具背后的所有负面影响，而只是为了专注于测试主题，并为您提供建议如何设置项目结构以实施更好的测试和生产代码质量。<<<<<<<<<<<<<<<<<<<<< /p>

如果您熟悉Maven项目的设置，并且您知道如何像Surefire和FailSafe这样的不同插件处理编译的测试类，那么您可以跳到以下section，最初的几个只是引入了。 Maven如何处理测试。如果您想刷新您的知识，也可以阅读第一章！ ：）

Maven项目的样子如何？

默认情况下，如果一个新项目刚刚初始化，则应该像这样：

UserService类只是为了示例，它们背后没有框架，没有真正的逻辑，仅是为了演示。

我们如何执行项目中的测试？这很容易，只需在您的终端中运行mvn test命令即可。

$ mvn test
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< org.rodnansol:simple-test-setup >-------------------
[INFO] Building simple-test-setup 1.0-SNAPSHOT
[INFO]   from pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- resources:3.3.0:resources (default-resources) @ simple-test-setup ---
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 0 resource
[INFO]
[INFO] --- compiler:3.10.1:compile (default-compile) @ simple-test-setup ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- resources:3.3.0:testResources (default-testResources) @ simple-test-setup ---
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO]
[INFO] --- compiler:3.10.1:testCompile (default-testCompile) @ simple-test-setup ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- surefire:3.0.0-M8:test (default-test) @ simple-test-setup ---
[INFO] Using auto detected provider org.apache.maven.surefire.junitplatform.JUnitPlatformProvider
[INFO]
[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running org.rodnansol.user.UserServiceTest
OpenJDK 64-Bit Server VM warning: Sharing is only supported for boot loader classes because bootstrap classpath has been appended
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.645 s - in org.rodnansol.user.UserServiceTest
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.629 s
[INFO] Finished at: 2023-06-04T17:45:29+02:00
[INFO] ------------------------------------------------------------------------

在这种情况下发生了什么？

maven具有多个阶段可以执行的，因为Maven具有pom.xml文件，它还具有一个所谓的有效POM ，其中包含所有阶段配置，但是它们是没有在pom.xml文件中呈现，因为那太冗长了，很难阅读。这些配置是从所谓的 super pom 。

有效的POM 包含在执行特定阶段时将运行的所有插件，这些阶段由插件支持，例如 maven-clean-plugin ， Maven-Compiler-Plugin 和 maven-surefire-plugin 正在执行任何测试。

不在这里， Maven-Surefire-Plugin 在test阶段执行其test目标。即使他们的措辞相同，也不相同。另一件事也至关重要，我们在这里看不到maven-failsafe-plugin，这将是稍后的关键。

好吧，好吧，我想用眼睛看到它，那么如何创建有效的pom？很容易：mvn help:effective-pom。

当它超过250行时，让我复制它的一小部分。

我们可以看到 maven-clean-plugin的配置和 maven-surefire-plugin ：

Maven SureFire插件可以做什么？

tl; dr：它执行测试。

认真地，它正在执行测试，但是如何识别测试？

插件具有配置值，其中一个首先定义了编译测试类的文件夹，而其他配置选项设置了随附的文件，它主要是通过模式完成的。

• 测试类目录：https://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html#testclassesdirectory
  • 默认情况下：target/test-classes-由 maven-compiler-plugin 's testompile 目标 expile 阶段。肯定有很多事情要去那里。 ð¥
• 包括课程：https://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html#includes
  • 默认情况下任何以：test *.java *test.java， *tests.java， *testcase.java。

现在可能是 aha！时刻，“所以这就是为什么我闪亮的Junit测试未执行的原因，因为我将其命名为Userservicet或Userservicete”。

是！但是您可以将其配置为包括新模式或可以将特定文件放入包含部分。

为什么SureFire插件不适合运行集成测试？

如果我们检查默认生命周期，我们将看到可用阶段的列表：

让我们再次检查test阶段。在此阶段之前，我们只能看到编译测试类所必需的test-compile，我们肯定会看到其他一些阶段，但现在对我们来说并不是那么“有趣”。

之后，我们看不到“测试”相关阶段，但是integration-test阶段，默认情况下与Surefire插件无关。

如果我们要运行集成测试，那将需要不同的环境设置，例如在运行任何集成测试之前运行 docker-compose.yml 文件，并在集成测试时停止启动依赖项完成？

Maven SureFire不是为运行集成测试而创建的，这就是为什么它不拾取具有IT的测试类，其名称中的ITCase Postfix，因为应该使用Maven Failsafe插件！ < /p>

ð在这里一个小注：您绝对可以配置Surefire插件来处理以ITCase结尾的测试类，但是它并不是要与它们一起使用。另一方面，集成测试也可以称为简单测试，测试，测试柜，但它们不同，请不要混合您的单元和集成测试。

Maven FailSafe插件

让我引用以下内容中的以下文档：

“在SureFire插件旨在运行单元测试的同时，FailSafe插件旨在运行集成测试。选择了名称（FailSafe），因为它是SureFire的同义词，并且因为它意味着当失败时，它确实可以所以以安全的方式。

Maven生命周期有四个用于运行集成测试的阶段：

• 用于设置集成测试环境的预融合测试
• 集成测试用于运行集成测试。
• 综合测试后用于拆除集成测试环境。
• 验证用于检查集成测试的结果。

如果您使用SureFire插件进行运行测试，则当您患有测试故障时，构建将在集成测试阶段停止，并且您的集成测试环境将无法正确拆除。

在集成测试期间使用了故障保护插件，并验证构建生命周期的阶段以执行应用程序的集成测试。在集成测试阶段，FAILSAFE插件不会使构建失败，从而使后整合测试阶段可以执行。” - 来源：https://maven.apache.org/surefire/maven-failsafe-plugin/

无法更好地描述：

• 用于单位测试：使用 surefire ！
• 进行集成测试：使用 FailSafe ！

Maven FailSafe插件如何工作？

它与 surefire 插件相同，它从特定目录执行测试，并具有特定的文件名模式。

• 测试类目录：https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html#testclassesdirectory
  • 与 surefire 相同，因此target/test-classes，编译的源文件也由 maven编译器插件编译
• 包括课程：https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html#includes
  • 这是可以轻松看到差异的地方，而 surefire 插件包含Java类，以测试，测试，testcase后缀结尾，在这种情况下，以下模式为默认模式：IT*.java ， *it.java， *itcase.java。 - 因此例如UserServiceIT.java或CreateUserITCase.java。

<plugin>
    <artifactId>maven-failsafe-plugin</artifactId>
    <version>3.0.0-M8</version>
    <executions>
        <execution>
            <id>default-integration-test</id>
            <phase>integration-test</phase>
            <goals>
                <goal>integration-test</goal>
            </goals>
        </execution>
    </executions>
</plugin>

<build>
    <testResources>
        <testResource>
            <directory>src/it/resources</directory>
        </testResource>
        <testResource>
            <directory>src/test/resources</directory>
        </testResource>
    </testResources>
    <plugins>
        <plugin>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.11.0</version>
            <executions>
                <execution>
                    <id>default-testCompile</id>
                    <phase>test-compile</phase>
                    <goals>
                        <goal>testCompile</goal>
                    </goals>
                    <configuration>
                        <compileSourceRoots>
                            <compileSourceRoot>src/test/java</compileSourceRoot>
                            <compileSourceRoot>src/it/java</compileSourceRoot>
                        </compileSourceRoots>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <artifactId>maven-failsafe-plugin</artifactId>
            <version>3.0.0-M8</version>
            <executions>
                <execution>
                    <id>default-integration-test</id>
                    <phase>integration-test</phase>
                    <goals>
                        <goal>integration-test</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>build-helper-maven-plugin</artifactId>
            <version>3.4.0</version>
            <executions>
                <execution>
                    <id>add-integration-test-sources</id>
                    <phase>generate-test-sources</phase>
                    <goals>
                        <goal>add-test-source</goal>
                    </goals>
                    <configuration>
                        <sources>
                            <source>src/it/java</source>
                        </sources>
                    </configuration>
                </execution>
                <execution>
                    <id>add-integration-test-resources</id>
                    <phase>generate-test-resources</phase>
                    <goals>
                        <goal>add-test-resource</goal>
                    </goals>
                    <configuration>
                        <resources>
                            <resource>
                                <filtering>true</filtering>
                                <directory>src/it/resources</directory>
                            </resource>
                        </resources>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <artifactId>maven-failsafe-plugin</artifactId>
            <version>3.0.0-M8</version>
            <executions>
                <execution>
                    <id>default-integration-test</id>
                    <phase>integration-test</phase>
                    <goals>
                        <goal>integration-test</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>