MockMvc 和 WebDriver

在前面的章节中，我们已经了解了如何结合原始的 HtmlUnit API 使用 MockMvc。在本节中，我们使用 Selenium WebDriver 中的额外抽象，使操作变得更加简单。

为什么选择 WebDriver 和 MockMvc？

我们已经可以使用 HtmlUnit 和 MockMvc，那么为什么还要使用 WebDriver 呢？Selenium WebDriver 提供了一个非常优雅的 API，可以让我们轻松地组织代码。为了更好地展示其工作原理，我们将在本节中探讨一个示例。

尽管是 Selenium 的一部分，WebDriver 运行测试时并不需要 Selenium Server。

假设我们需要确保消息被正确创建。测试涉及查找 HTML 表单输入元素，填写它们，并进行各种断言。

这种方法会导致大量的单独测试，因为我们还想测试错误条件。例如，我们想确保如果只填写表单的一部分，就会收到错误。如果填写了整个表单，新创建的消息应该在之后显示。

如果其中一个字段名为“summary”，我们可能会在测试中的多个地方重复以下内容：

  • Java

  • Kotlin

HtmlTextInput summaryInput = currentPage.getHtmlElementById("summary");
summaryInput.setValueAttribute(summary);
val summaryInput = currentPage.getHtmlElementById("summary")
summaryInput.setValueAttribute(summary)

那么，如果我们将 id 更改为 smmry 会发生什么？这样做会迫使我们更新所有测试以包含此更改。这违反了 DRY 原则，因此我们应该理想地将此代码提取到自己的方法中，如下所示：

  • Java

  • Kotlin

public HtmlPage createMessage(HtmlPage currentPage, String summary, String text) {
	setSummary(currentPage, summary);
	// ...
}

public void setSummary(HtmlPage currentPage, String summary) {
	HtmlTextInput summaryInput = currentPage.getHtmlElementById("summary");
	summaryInput.setValueAttribute(summary);
}
fun createMessage(currentPage: HtmlPage, summary:String, text:String) :HtmlPage{
	setSummary(currentPage, summary);
	// ...
}

fun setSummary(currentPage:HtmlPage , summary: String) {
	val summaryInput = currentPage.getHtmlElementById("summary")
	summaryInput.setValueAttribute(summary)
}

这样做可以确保如果更改 UI，我们不必更新所有测试。

我们甚至可以更进一步，将此逻辑放置在一个 Object 中，该 Object 代表我们当前所在的 HtmlPage，如以下示例所示：

  • Java

  • Kotlin

public class CreateMessagePage {

	final HtmlPage currentPage;

	final HtmlTextInput summaryInput;

	final HtmlSubmitInput submit;

	public CreateMessagePage(HtmlPage currentPage) {
		this.currentPage = currentPage;
		this.summaryInput = currentPage.getHtmlElementById("summary");
		this.submit = currentPage.getHtmlElementById("submit");
	}

	public <T> T createMessage(String summary, String text) throws Exception {
		setSummary(summary);

		HtmlPage result = submit.click();
		boolean error = CreateMessagePage.at(result);

		return (T) (error ? new CreateMessagePage(result) : new ViewMessagePage(result));
	}

	public void setSummary(String summary) throws Exception {
		summaryInput.setValueAttribute(summary);
	}

	public static boolean at(HtmlPage page) {
		return "Create Message".equals(page.getTitleText());
	}
}
	class CreateMessagePage(private val currentPage: HtmlPage) {

		val summaryInput: HtmlTextInput = currentPage.getHtmlElementById("summary")

		val submit: HtmlSubmitInput = currentPage.getHtmlElementById("submit")

		fun <T> createMessage(summary: String, text: String): T {
			setSummary(summary)

			val result = submit.click()
			val error = at(result)

			return (if (error) CreateMessagePage(result) else ViewMessagePage(result)) as T
		}

		fun setSummary(summary: String) {
			summaryInput.setValueAttribute(summary)
		}

		fun at(page: HtmlPage): Boolean {
			return "Create Message" == page.getTitleText()
		}
	}
}

以前，这种模式被称为 页面对象模式。虽然我们当然可以使用 HtmlUnit 来实现这一点，但 WebDriver 提供了一些工具，我们将在以下章节中探讨，以使这种模式更容易实现。

MockMvc 和 WebDriver 设置

要将 Selenium WebDriver 与 MockMvc 结合使用，请确保您的项目包含对 org.seleniumhq.selenium:htmlunit3-driver 的测试依赖。

我们可以使用 MockMvcHtmlUnitDriverBuilder 轻松创建一个与 MockMvc 集成的 Selenium WebDriver，如以下示例所示：

  • Java

  • Kotlin

WebDriver driver;

@BeforeEach
void setup(WebApplicationContext context) {
	driver = MockMvcHtmlUnitDriverBuilder
			.webAppContextSetup(context)
			.build();
}
lateinit var driver: WebDriver

@BeforeEach
fun setup(context: WebApplicationContext) {
	driver = MockMvcHtmlUnitDriverBuilder
			.webAppContextSetup(context)
			.build()
}

这是一个使用 MockMvcHtmlUnitDriverBuilder 的简单示例。有关更高级的用法，请参阅 高级 MockMvcHtmlUnitDriverBuilder。

前面的示例确保任何引用 localhost 作为服务器的 URL 都被定向到我们的 MockMvc 实例，而无需真实的 HTTP 连接。任何其他 URL 都通过网络连接正常请求。这使我们能够轻松测试 CDN 的使用。

MockMvc 和 WebDriver 用法

现在我们可以像往常一样使用 WebDriver，而无需将我们的应用程序部署到 Servlet 容器。例如，我们可以通过以下方式请求视图来创建消息：

  • Java

  • Kotlin

CreateMessagePage page = CreateMessagePage.to(driver);
val page = CreateMessagePage.to(driver)

然后我们可以填写表单并提交它来创建消息，如下所示：

  • Java

  • Kotlin

ViewMessagePage viewMessagePage =
		page.createMessage(ViewMessagePage.class, expectedSummary, expectedText);
val viewMessagePage =
	page.createMessage(ViewMessagePage::class, expectedSummary, expectedText)

这通过利用页面对象模式改进了我们的 HtmlUnit 测试 的设计。正如我们在 为什么选择 WebDriver 和 MockMvc？ 中提到的，我们可以使用 HtmlUnit 实现页面对象模式，但使用 WebDriver 会容易得多。考虑以下 CreateMessagePage 实现：

  • Java

  • Kotlin

public class CreateMessagePage extends AbstractPage { [id="CO1-1"][id="CO1-1"][id="CO1-1"](1)

	[id="CO1-2"][id="CO1-2"][id="CO1-2"](2)
	private WebElement summary;
	private WebElement text;

	@FindBy(css = "input[type=submit]") [id="CO1-3"][id="CO1-3"][id="CO1-3"](3)
	private WebElement submit;

	public CreateMessagePage(WebDriver driver) {
		super(driver);
	}

	public <T> T createMessage(Class<T> resultPage, String summary, String details) {
		this.summary.sendKeys(summary);
		this.text.sendKeys(details);
		this.submit.click();
		return PageFactory.initElements(driver, resultPage);
	}

	public static CreateMessagePage to(WebDriver driver) {
		driver.get("http://localhost:9990/mail/messages/form");
		return PageFactory.initElements(driver, CreateMessagePage.class);
	}
}
1 CreateMessagePage 扩展了 AbstractPage。我们不详细介绍 AbstractPage，但总的来说，它包含了我们所有页面的共同功能。例如，如果我们的应用程序有导航栏、全局错误消息和其他功能，我们可以将此逻辑放在一个共享位置。
2 我们对 HTML 页面中感兴趣的每个部分都有一个成员变量。这些变量的类型是 WebElement。WebDriver 的 PageFactory 允许我们通过自动解析每个 WebElement 来删除 HtmlUnit 版本 CreateMessagePage 中的大量代码。PageFactory#initElements(WebDriver,Class<T>) 方法通过使用字段名并根据 HTML 页面中元素的 id 或 name 查找它来自动解析每个 WebElement。
3 我们可以使用 @FindBy 注解 来覆盖默认的查找行为。我们的示例展示了如何使用 @FindBy 注解通过 css 选择器 (input[type=submit]) 来查找我们的提交按钮。 
class CreateMessagePage(private val driver: WebDriver) : AbstractPage(driver) { [id="CO2-1"][id="CO1-4"][id="CO1-4"](1)

	[id="CO2-2"][id="CO1-5"][id="CO1-5"](2)
	private lateinit var summary: WebElement
	private lateinit var text: WebElement

	@FindBy(css = "input[type=submit]") [id="CO2-3"][id="CO1-6"][id="CO1-6"](3)
	private lateinit var submit: WebElement

	fun <T> createMessage(resultPage: Class<T>, summary: String, details: String): T {
		this.summary.sendKeys(summary)
		text.sendKeys(details)
		submit.click()
		return PageFactory.initElements(driver, resultPage)
	}
	companion object {
		fun to(driver: WebDriver): CreateMessagePage {
			driver.get("http://localhost:9990/mail/messages/form")
			return PageFactory.initElements(driver, CreateMessagePage::class.java)
		}
	}
}
1 CreateMessagePage 扩展了 AbstractPage。我们不详细介绍 AbstractPage，但总的来说，它包含了我们所有页面的共同功能。例如，如果我们的应用程序有导航栏、全局错误消息和其他功能，我们可以将此逻辑放在一个共享位置。
2 我们对 HTML 页面中感兴趣的每个部分都有一个成员变量。这些变量的类型是 WebElement。WebDriver 的 PageFactory 允许我们通过自动解析每个 WebElement 来删除 HtmlUnit 版本 CreateMessagePage 中的大量代码。PageFactory#initElements(WebDriver,Class<T>) 方法通过使用字段名并根据 HTML 页面中元素的 id 或 name 查找它来自动解析每个 WebElement。
3 我们可以使用 @FindBy 注解 来覆盖默认的查找行为。我们的示例展示了如何使用 @FindBy 注解通过 css 选择器 (input[type=submit]) 来查找我们的提交按钮。

最后，我们可以验证是否成功创建了新消息。以下断言使用 AssertJ 断言库：

  • Java

  • Kotlin

assertThat(viewMessagePage.getMessage()).isEqualTo(expectedMessage);
assertThat(viewMessagePage.getSuccess()).isEqualTo("Successfully created a new message");
assertThat(viewMessagePage.message).isEqualTo(expectedMessage)
assertThat(viewMessagePage.success).isEqualTo("Successfully created a new message")

我们可以看到 ViewMessagePage 允许我们与自定义领域模型进行交互。例如，它公开了一个返回 Message 对象的方法：

  • Java

  • Kotlin

public Message getMessage() throws ParseException {
	Message message = new Message();
	message.setId(getId());
	message.setCreated(getCreated());
	message.setSummary(getSummary());
	message.setText(getText());
	return message;
}
fun getMessage() = Message(getId(), getCreated(), getSummary(), getText())

然后我们可以在断言中使用丰富的领域对象。

最后，我们绝不能忘记在测试完成后关闭 WebDriver 实例，如下所示：

  • Java

  • Kotlin

@AfterEach
void destroy() {
	if (driver != null) {
		driver.close();
	}
}
@AfterEach
fun destroy() {
	if (driver != null) {
		driver.close()
	}
}

有关使用 WebDriver 的更多信息，请参阅 Selenium WebDriver 文档。

高级 MockMvcHtmlUnitDriverBuilder

到目前为止的示例中，我们以最简单的方式使用了 MockMvcHtmlUnitDriverBuilder，即基于 Spring TestContext Framework 为我们加载的 WebApplicationContext 构建 WebDriver。这种方法在这里重复，如下所示：

  • Java

  • Kotlin

WebDriver driver;

@BeforeEach
void setup(WebApplicationContext context) {
	driver = MockMvcHtmlUnitDriverBuilder
			.webAppContextSetup(context)
			.build();
}
lateinit var driver: WebDriver

@BeforeEach
fun setup(context: WebApplicationContext) {
	driver = MockMvcHtmlUnitDriverBuilder
			.webAppContextSetup(context)
			.build()
}

我们还可以指定其他配置选项，如下所示：

  • Java

  • Kotlin

WebDriver driver;

@BeforeEach
void setup() {
	driver = MockMvcHtmlUnitDriverBuilder
			// demonstrates applying a MockMvcConfigurer (Spring Security)
			.webAppContextSetup(context, springSecurity())
			// for illustration only - defaults to ""
			.contextPath("")
			// By default MockMvc is used for localhost only;
			// the following will use MockMvc for example.com and example.org as well
			.useMockMvcForHosts("example.com","example.org")
			.build();
}
lateinit var driver: WebDriver

@BeforeEach
fun setup() {
	driver = MockMvcHtmlUnitDriverBuilder
			// demonstrates applying a MockMvcConfigurer (Spring Security)
			.webAppContextSetup(context, springSecurity())
			// for illustration only - defaults to ""
			.contextPath("")
			// By default MockMvc is used for localhost only;
			// the following will use MockMvc for example.com and example.org as well
			.useMockMvcForHosts("example.com","example.org")
			.build()
}

作为替代方案，我们可以通过单独配置 MockMvc 实例并将其提供给 MockMvcHtmlUnitDriverBuilder 来执行完全相同的设置，如下所示：

  • Java

  • Kotlin

MockMvc mockMvc = MockMvcBuilders
		.webAppContextSetup(context)
		.apply(springSecurity())
		.build();

driver = MockMvcHtmlUnitDriverBuilder
		.mockMvcSetup(mockMvc)
		// for illustration only - defaults to ""
		.contextPath("")
		// By default MockMvc is used for localhost only;
		// the following will use MockMvc for example.com and example.org as well
		.useMockMvcForHosts("example.com","example.org")
		.build();
// Not possible in Kotlin until {kotlin-issues}/KT-22208 is fixed

这更冗长，但通过使用 MockMvc 实例构建 WebDriver，我们可以完全掌控 MockMvc。

有关创建 MockMvc 实例的更多信息，请参阅 配置 MockMvc。