Continuous Testing

了解如何在 Quarkus 应用程序中使用持续测试。

Learn how to use continuous testing in your Quarkus Application.

Prerequisites

include::{includes}/prerequisites.adoc[]* Getting Started Guide的完成问候应用程序

Unresolved directive in continuous-testing.adoc - include::{includes}/prerequisites.adoc[] * The completed greeter application from the Getting Started Guide

Introduction

Quarkus 支持持续测试,其中测试会在代码更改保存后立即运行。这使您可以对代码更改获得即时反馈。Quarkus 检测哪些测试覆盖哪些代码,并使用此信息仅在代码更改时运行相关测试。

Quarkus supports continuous testing, where tests run immediately after code changes have been saved. This allows you to get instant feedback on your code changes. Quarkus detects which tests cover which code, and uses this information to only run the relevant tests when code is changed.

Solution

使用以下命令启动 Getting Started应用程序(或任何其他应用程序):

Start the Getting Started application (or any other application) using:

Unresolved directive in continuous-testing.adoc - include::{includes}/devtools/dev.adoc[]

Quarkus 会像往常一样以开发模式启动,但在屏幕底部,您应该看到以下内容:

Quarkus will start in development mode as normal, but down the bottom of the screen you should see the following:

--
Tests paused, press [r] to resume, [h] for more options>

按 `r`测试将开始运行。您应该看到状态在运行时在屏幕底部发生更改,并且它应该以以下内容结束:

Press r and the tests will start running. You should see the status change down the bottom of the screen as they are running, and it should finish with:

--
Tests all passed, 2 tests were run, 0 were skipped. Tests took 1470ms.
Press [r] to re-run, [v] to view full results, [p] to pause, [h] for more options>

如果您希望持续测试自动启动,则可以在 application.properties`中设置 `quarkus.test.continuous-testing=enabled。如果您根本不需要它,则可以将其更改为 disabled

If you want continuous testing to start automatically you can set quarkus.test.continuous-testing=enabled in application.properties. If you don’t want it at all you can change this to disabled.

现在,您可以开始对应用程序进行更改。进入 GreetingResource`并将 hello 端点更改为 `"hello world",然后保存文件。Quarkus 应立即重新运行测试,您应该获得类似于以下内容的输出:

Now you can start making changes to your application. Go into the GreetingResource and change the hello endpoint to return "hello world", and save the file. Quarkus should immediately re-run the test, and you should get output similar to the following:

2021-05-11 14:21:34,338 ERROR [io.qua.test] (Test runner thread) Test GreetingResourceTest#testHelloEndpoint() failed
: java.lang.AssertionError: 1 expectation failed.
Response body doesn't match expectation.
Expected: is "hello"
  Actual: hello world

	at io.restassured.internal.ValidatableResponseImpl.body(ValidatableResponseImpl.groovy)
	at org.acme.getting.started.GreetingResourceTest.testHelloEndpoint(GreetingResourceTest.java:21)


--
Test run failed, 2 tests were run, 1 failed, 0 were skipped. Tests took 295ms
Press [r] to re-run, [v] to view full results, [p] to pause, [h] for more options>

将其改回来,测试将再次运行。

Change it back and the tests will run again.

Controlling Continuous Testing

可以使用各种热键来控制持续测试。按 `h`将显示以下命令列表:

There are various hotkeys you can use to control continuous testing. Pressing h will display the following list of commands:

The following commands are available:
[r] - Re-run all tests
[f] - Re-run failed tests
[b] - Toggle 'broken only' mode, where only failing tests are run (disabled)
[v] - Print failures from the last test run
[p] - Pause tests
[o] - Toggle test output (disabled)
[i] - Toggle instrumentation based reload (disabled)
[l] - Toggle live reload (enabled)
[s] - Force restart
[h] - Display this help
[q] - Quit

解释如下:

These are explained below:

[r] - Re-run all tests

This will re-run every test

[f] - Re-run failed tests

This will re-run every failing test

[b] - Toggle 'broken only' mode, where only failing tests are run

Broken only mode will only run tests that have previously failed, even if other tests would normally be affected by a code change. This can be useful if you are modifying code that is used by lots of tests, but you only want to focus on debugging the failing one.

[v] - Print failures from the last test run

Prints the failures to the console again, this can be useful if there has been lots of console output since the last run.

[p] - Pause tests

Temporarily stops running tests. This can be useful if you are making lots of changes, and don’t want feedback until they are all done.

[o] - Toggle test output

By default test output is filtered and not displayed on the console, so that test output and dev mode output is not interleaved. Enabling test output will print output to the console when tests are run. Even when output is disabled the filtered output is saved and can be viewed in the Dev UI.

[i] - Toggle instrumentation based reload

This is not directly related to testing, but allows you to toggle instrumentation based reload. This will allow live reload to avoid a restart if a change does not affect the structure of a class, which gives a faster reload and allows you to keep state.

[l] - Toggle live reload

This is not directly related to testing, but allows you to turn live reload on and off.

[s] - Force restart

This will force a scan for changed files, and will perform a live reload with and changes. Note that even if there are no changes the application will still restart. This will still work even if live reload is disabled.

Continuous Testing Without Dev Mode

无需开始开发模式即可运行持续测试。如果开发模式会干扰您的测试(例如,在同一端口上运行 wiremock),或者如果您只想使用测试进行开发,这会很有用。若要启动持续测试模式,请运行 mvn quarkus:test

It is possible to run continuous testing without starting dev mode. This can be useful if dev mode will interfere with your tests (e.g. running wiremock on the same port), or if you only want to develop using tests. To start continuous testing mode run mvn quarkus:test.

在持续测试模式下运行时不可用开发用户界面,因为这是由开发模式提供的。

The Dev UI is not available when running in continuous testing mode, as this is provided by dev mode.

Multi-module Projects

注意持续测试支持模块化项目,因此在更改文件时,仍可以在应用程序之外的模块中运行测试。可按以下所列使用配置来控制所运行的模块。

Note that continuous testing supports multi-module projects, so tests in modules other than the application can still be run when files are changed. The modules that are run can be controlled using config as listed below.

默认情况下启用此选项,但可以通过 `quarkus.test.only-test-application-module=true`将其禁用。

This is enabled by default, and can be disabled via quarkus.test.only-test-application-module=true.

Configuring Continuous Testing

持续测试支持多个配置选项,这些选项可用于限制运行的测试并控制输出。配置属性如下所示:

Continuous testing supports multiple configuration options that can be used to limit the tests that are run, and to control the output. The configuration properties are shown below:

Unresolved directive in continuous-testing.adoc - include::{generated-dir}/config/quarkus-core_quarkus.test.adoc[]