spring boot 測試

 

1、集成測試自動配置

代碼清單4-1 用SpringJUnit4ClassRunner對Spring應用程序進行集成測試 @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration( classes=AddressBookConfiguration.class) //加載應用程序上下文 public class AddressServiceTests { @Autowired private AddressService addressService; //注入地址服務 @Test public void testService() { //測試地址服務 Address address = addressService.findByLastName("Sheman"); assertEquals("P", address.getFirstName()); assertEquals("Sherman", address.getLastName()); assertEquals("42 Wallaby Way", address.getAddressLine1()); assertEquals("Sydney", address.getCity()); assertEquals("New South Wales", address.getState()); assertEquals("2000", address.getPostCode()); } }

解釋：

1. SpringJUnit4ClassRunner：是一個JUnit類運行器，會爲JUnit測試加載Spring應用程 序上下文，併爲測試類自動織入所需的Bean。
2. 能夠把@ContextConfiguration替換爲Spring Boot的@SpringApplicationConfiguration， 這樣不只會加載應用程序上下文，還會開啓日誌、加載外部屬性（application.properties或application.yml），以及其餘Spring Boot特性。 大多數狀況下，爲Spring Boot應用程序編寫測試時應該用@SpringApplicationConfiguration代替@ContextConfiguration。

2、測試Web應用程序

要恰當地測試一個Web應用程序，須要投入一些實際的HTTP請求，確認它能正確地處理 那些請求。Spring Boot開發者有兩個可選的方案能實現這類測試：

• Spring Mock MVC：能在一個近似真實的模擬Servlet容器裏測試控制器，而不用實際啓動 應用服務器。
• Web集成測試：在嵌入式Servlet容器（好比Tomcat或Jetty）裏啓動應用程序，在真正的應 用服務器裏執行測試。

1. 模擬Spring MVC

要在測試裏設置Mock MVC，可使用MockMvcBuilders，該類提供了兩個靜態方法:

• standaloneSetup()：構建一個Mock MVC，提供一個或多個手工建立並配置的控制器。
• webAppContextSetup()：使用Spring應用程序上下文來構建Mock MVC，該上下文裏 能夠包含一個或多個配置好的控制器。

兩個方法區別：

• standaloneSetup()：手工初始化並注入要測試的控制器，
• webAppContextSetup()：基於一個WebApplicationContext的實例，一般由Spring加載。

前者同單元測試更加接近，你可能只想讓它專一於單一控制器的測試，然後者讓Spring加載控制 器及其依賴，以便進行完整的集成測試。

/* 代碼清單4-2 爲集成測試控制器建立Mock MVC */ @RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration( classes = ReadingListApplication.class) //開啓Web上下文 @WebAppConfiguration public class MockMvcWebTests { @Autowired private WebApplicationContext webContext; //注入WebApplicationContext private MockMvc mockMvc; @Before public void setupMockMvc() { mockMvc = MockMvcBuilders .webAppContextSetup(webContext) //設置MockMvc .build(); } }

/* 向/readingList發起一個GET請求 */ @Test public void homePage() throws Exception { mockMvc.perform(get("/readingList")) .andExpect(status().isOk()) .andExpect(view().name("readingList")) .andExpect(model().attributeExists("books")) .andExpect(model().attribute("books", is(empty()))); }

/* 向/readingList發起一個POST請求 */ @Test public void postBook() throws Exception { mockMvc.perform(post("/readingList") .contentType(MediaType.APPLICATION_FORM_URLENCODED) .param("title", "BOOK TITLE") .param("author", "BOOK AUTHOR") .param("isbn", "1234567890") .param("description", "DESCRIPTION")) .andExpect(status().is3xxRedirection()) .andExpect(header().string("Location", "/readingList"));

/* 驗證剛剛的POST請求 */ //配置指望的圖書 Book expectedBook = new Book(); expectedBook.setId(1L); expectedBook.setReader("craig"); expectedBook.setTitle("BOOK TITLE"); expectedBook.setAuthor("BOOK AUTHOR"); expectedBook.setIsbn("1234567890"); expectedBook.setDescription("DESCRIPTION"); //執行GET請求 mockMvc.perform(get("/readingList")) .andExpect(status().isOk()) .andExpect(view().name("readingList")) .andExpect(model().attributeExists("books")) .andExpect(model().attribute("books", hasSize(1))) .andExpect(model().attribute("books", contains(samePropertyValuesAs(expectedBook)))); }

2. 測試Web安全

使用Spring Security

1. 添加依賴

   <dependency>
       <groupId>org.springframework.security</groupId>
       <artifactId>spring-security-test</artifactId>
       <scope>test</scope>
   </dependency>

2. 在建立MockMvc實例時運用Spring Security的配置器

   @Before public void setupMockMvc() { mockMvc = MockMvcBuilders .webAppContextSetup(webContext) .apply(springSecurity()) .build(); }

3. 使用（具體的安全配置取決於你如何配置Spring Security（或者Spring Boot如何自動配置Spring Security）。）

   場景代碼：

   1)請求未經身份驗證

   /* 請求未經身份驗證，重定向回登陸界面 */ @Test public void homePage_unauthenticatedUser() throws Exception { mockMvc.perform(get("/")) .andExpect(status().is3xxRedirection()) .andExpect(header().string("Location", "http://localhost/login")); }

   2)請求通過身份驗證 Spring Security提供了兩個註解：

   • @WithMockUser：用給定的值建立了一個UserDetails對象，指定用戶名、密碼和受權。
   • @WithUserDetails：使用事先配置好的UserDetailsService來加載UserDetails對象,根據給定的用戶名查找 並返回一個Reader對象。

   /* 通過身份驗證的請求，使用@WithMockUser */ @Test @WithMockUser(username="craig", password="password", roles="READER") public void homePage_authenticatedUser() throws Exception { ... }

   /* 通過身份驗證的請求，使用@WithUserDetails */ @Test @WithUserDetails("craig") public void homePage_authenticatedUser() throws Exception { Reader expectedReader = new Reader(); expectedReader.setUsername("craig"); expectedReader.setPassword("password"); expectedReader.setFullname("Craig Walls"); mockMvc.perform(get("/")) .andExpect(status().isOk()) .andExpect(view().name("readingList")) .andExpect(model().attribute("reader", samePropertyValuesAs(expectedReader))) .andExpect(model().attribute("books", hasSize(0))) }

   此處沒有啓動Servlet容器來運行這些測試， Spring的Mock MVC取代了實際的Servlet 容器。它比直接調用控制器方法要好，但它並無真的在Web瀏 覽器裏執行應用程序，驗證呈現出的視圖。

3、測試運行中的應用程序

Spring Boot支持用嵌入式Servlet容器來啓動應用程序。

Spring Boot 的 @WebIntegrationTest 註解就是這麼作的。 在測試類上添加@WebIntegrationTest註解，能夠聲明你不只但願Spring Boot爲測試建立應用程序上下文，還要啓 動一個嵌入式的Servlet容器。一旦應用程序運行在嵌入式容器裏，你就能夠發起真實的HTTP請 求，斷言結果了。

/* 代碼清單4-5 在服務器裏啓動應用程序，以Spring的RestTemplate對應用程序發起HTTP請求 */ @RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration( classes=ReadingListApplication.class) @WebIntegrationTest public class SimpleWebTest { @Test(expected=HttpClientErrorException.class) public void pageNotFound() { try { RestTemplate rest = new RestTemplate(); rest.getForObject( "http://localhost:8080/bogusPage", String.class); fail("Should result in HTTP 404"); } catch (HttpClientErrorException e) { assertEquals(HttpStatus.NOT_FOUND, e.getStatusCode()); throw e; } } }

1. 用隨機端口啓動服務器

@WebIntegrationTest(value={"server.port=0"}) 或者 @WebIntegrationTest("server.port=0") 或者 @WebIntegrationTest(randomPort=true)

使用端口

@Value("${local.server.port}") private int port;

rest.getForObject(
"http://localhost:{port}/bogusPage", String.class, port);

2. 使用Selenium測試HTML頁面

1. 添加org.seleniumhq.selenium依賴

2. 代碼裏使用

   1> 配置

   /* 在Spring Boot裏使用Selenium測試的模板 */ @RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration( classes=ReadingListApplication.class) @WebIntegrationTest(randomPort=true) public class ServerWebTests { private static FirefoxDriver browser; @Value("${local.server.port}") private int port; //配置Firefox驅動 @BeforeClass public static void openBrowser() { browser = new FirefoxDriver(); browser.manage().timeouts() .implicitlyWait(10, TimeUnit.SECONDS); } //關閉瀏覽器 @AfterClass public static void closeBrowser() { browser.quit(); } }

   2> 測試

   用Selenium測試閱讀列表應用程序
    @Test public void addBookToEmptyList() { String baseUrl = "http://localhost:" + port; browser.get(baseUrl); assertEquals("You have no books in your book list", browser.findElementByTagName("div").getText()); //填充併發送表單 browser.findElementByName("title").sendKeys("BOOK TITLE"); browser.findElementByName("author").sendKeys("BOOK AUTHOR"); browser.findElementByName("isbn").sendKeys("1234567890"); browser.findElementByName("description").sendKeys("DESCRIPTION"); browser.findElementByTagName("form").submit(); //判斷列表中是否包含新書 WebElement dl = browser.findElementByCssSelector("dt.bookHeadline"); assertEquals("BOOK TITLE by BOOK AUTHOR (ISBN: 1234567890)", dl.getText()); WebElement dt = browser.findElementByCssSelector("dd.bookDescription"); assertEquals("DESCRIPTION", dt.getText()); }

---

備註：書上版本比較老，下面補充下新版本的測試方法。 例子摘自segmentfault_chenatu的文章 （僅適用spring-boot 1.4版本之後的寫法）：

直接調用接口函數進行測試：

@RunWith(SpringRunner.class) @SpringBootTest public class ApiTest { @Autowired MessageApi messageApi; ...

測試controller：

@RunWith(SpringRunner.class) @SpringBootTest @AutoConfigureMockMvc public class ControllerTest { @Autowired private MockMvc mockMvc; @Test public void testControllerMethods() { MvcResult result = mockMvc.perform(get("/get-receive-message-abstracts").param("siteId", "webtrn").param("uid", "lucy") .param("limit", "100")).andExpect(status().isOk()) .andExpect(jsonPath("$", hasSize(10))).andExpect(jsonPath("$[9].title", is("hello0"))).andReturn(); }

mockito使用參考：

Mockito教程

SpringBoot與JUnit+Mockito 單元測試