MockMvc 和 WebDriver

在前面的章節中，我們已經看到了如何將 MockMvc 與原生的 HtmlUnit API 結合使用。在本節中，我們使用 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 時不必更新所有測試。

我們甚至可以更進一步，將此邏輯放在代表我們當前所在的 HtmlPage 的 Object 中，如下例所示

  • 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()
		}
	}
}

以前，這種模式被稱為 Page Object Pattern。雖然我們當然可以使用 HtmlUnit 來做到這一點，但 WebDriver 提供了一些工具（我們將在下面的章節中探討），可以使實現這種模式變得容易得多。

MockMvc 和 WebDriver 設定

要將 Selenium WebDriver 與 MockMvc 結合使用，請確保您的專案包含了對 org.seleniumhq.selenium: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)

透過利用 Page Object Pattern，這改進了我們的 HtmlUnit 測試的設計。正如我們在 為何選擇 WebDriver 和 MockMvc？ 中提到的，我們可以在 HtmlUnit 中使用 Page Object Pattern，但在 WebDriver 中要容易得多。請考慮以下 CreateMessagePage 實現

  • Java

  • Kotlin

public class CreateMessagePage extends AbstractPage { (1)

	(2)
	private WebElement summary;
	private WebElement text;

	@FindBy(css = "input[type=submit]") (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("https://:9990/mail/messages/form");
		return PageFactory.initElements(driver, CreateMessagePage.class);
	}
}
1 CreateMessagePage 擴充套件了 AbstractPage。我們在此不詳細介紹 AbstractPage，但總而言之，它包含我們所有頁面的通用功能。例如，如果我們的應用有一個導航欄、全域性錯誤訊息和其他功能，我們可以將此邏輯放在一個共享位置。
2 我們為 HTML 頁面中我們感興趣的每個部分都設有一個成員變數。這些變數的型別是 WebElement。WebDriver 的 PageFactory 透過自動解析每個 WebElement，使我們可以從 CreateMessagePage 的 HtmlUnit 版本中移除大量程式碼。 PageFactory#initElements(WebDriver,Class<T>) 方法透過使用欄位名並查詢 HTML 頁面中元素的 id 或 name 來自動解析每個 WebElement。
3 我們可以使用 @FindBy 註解來覆蓋預設的查詢行為。我們的示例展示瞭如何使用 @FindBy 註解透過 css 選擇器 (input[type=submit]) 來查詢提交按鈕。 
class CreateMessagePage(private val driver: WebDriver) : AbstractPage(driver) { (1)

	(2)
	private lateinit var summary: WebElement
	private lateinit var text: WebElement

	@FindBy(css = "input[type=submit]") (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("https://:9990/mail/messages/form")
			return PageFactory.initElements(driver, CreateMessagePage::class.java)
		}
	}
}
1 CreateMessagePage 擴充套件了 AbstractPage。我們在此不詳細介紹 AbstractPage，但總而言之，它包含我們所有頁面的通用功能。例如，如果我們的應用有一個導航欄、全域性錯誤訊息和其他功能，我們可以將此邏輯放在一個共享位置。
2 我們為 HTML 頁面中我們感興趣的每個部分都設有一個成員變數。這些變數的型別是 WebElement。WebDriver 的 PageFactory 透過自動解析每個 WebElement，使我們可以從 CreateMessagePage 的 HtmlUnit 版本中移除大量程式碼。 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。