快捷導(dǎo)航

spring boot系列之集成測試(推薦)

更新時間：2018年03月23日 15:13:15 作者：大名Dean鼎

這篇文章主要介紹了spring boot系列集成測試,需要的朋友可以參考下

如果希望很方便針對API進(jìn)行測試，并且方便的集成到CI中驗證每次的提交，那么spring boot自帶的IT絕對是不二選擇。

迅速編寫一個測試Case

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@ActiveProfiles({Profiles.ENV_IT})
public class DemoIntegrationTest{
  @Autowired
  private FooService fooService;
  @Test
  public void test(){
    System.out.println("tested");
  }
}

其中 SpringBootTest 定義了跑IT時的一些配置，上述代碼是用了隨機端口，當(dāng)然也可以預(yù)定義端口，像這樣

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT, properties = {"server.port=9990"})

ActiveProfiles 強制使用了IT的Profile，從最佳實踐上來說IT Profile所配置的數(shù)據(jù)庫或者其他資源組件的地址，應(yīng)該是與開發(fā)或者Staging環(huán)境隔離的。因為當(dāng)一個IT跑完之后很多情況下我們需要清除測試數(shù)據(jù)。

你能夠發(fā)現(xiàn)這樣的Case可以使用 Autowired 注入任何想要的Service。這是因為spring將整個上下文都加載了起來，與實際運行的環(huán)境是一樣的，包含了數(shù)據(jù)庫，緩存等等組件。如果覺得測試時不需要全部的資源，那么在profile刪除對應(yīng)的配置就可以了。這就是一個完整的運行環(huán)境，唯一的區(qū)別是當(dāng)用例跑完會自動shutdown。

測試一個Rest API

強烈推薦一個庫，加入到gradle中

testCompile 'io.rest-assured:rest-assured:3.0.3'

支持JsonPath，十分好用，具體文檔戳這里

@Sql(scripts = "/testdata/users.sql")
@Test
public void test001Login() {
  String username = "demo@demo.com";
  String password = "demo";
  JwtAuthenticationRequest request = new JwtAuthenticationRequest(username, password);
  Response response = given().contentType(ContentType.JSON).body(request)
      .when().post("/auth/login").then()
      .statusCode(HttpStatus.OK.value())
      .extract()
      .response();
  assertThat(response.path("token"), is(IsNull.notNullValue()));
  assertThat(response.path("expiration"), is(IsNull.notNullValue()));
}

@Sql 用于在測試前執(zhí)行sql插入測試數(shù)據(jù)。注意 given().body() 中傳入的是一個java對象 JwtAuthenticationRequest ，因為rest-assured會自動幫你用 jackson 將對象序列化成json字符串。當(dāng)然也可以將轉(zhuǎn)換好的json放到body，效果是一樣的。

返回結(jié)果被一個Response接住，之后就可以用JsonPath獲取其中數(shù)據(jù)進(jìn)行驗證。當(dāng)然還有一種更直觀的辦法，可以通過 response.asString() 獲取完整的response，再反序列化成java對象進(jìn)行驗證。

至此，最基本的IT就完成了。在Jenkins增加一個step gradle test 就可以實現(xiàn)每次提交代碼都進(jìn)行一次測試。

一些復(fù)雜的情況

數(shù)據(jù)混雜

這是最容易發(fā)生，一個項目有很多dev，每個dev都會寫自己的IT case，那么如果數(shù)據(jù)之間產(chǎn)生了影響怎么辦。很容易理解，比如一個測試批量寫的場景，最后驗證方式是看寫的數(shù)據(jù)量是不是10w行。那么另外一個dev寫了其他的case恰好也新增了一條數(shù)據(jù)到這張表，結(jié)果變成了10w+1行，那么批量寫的case就跑不過了。

為了杜絕這種情況，我們采用每次跑完一個測試Class就將數(shù)據(jù)清空。既然是基于類的操作，可以寫一個基類解決。

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@ActiveProfiles({Profiles.ENV_IT})
public abstract class BaseIntegrationTest {
  private static JdbcTemplate jdbcTemplate;
  @Autowired
  public void setDataSource(DataSource dataSource) {
    jdbcTemplate = new JdbcTemplate(dataSource);
  }
  @Value("${local.server.port}")
  protected int port;
  @Before
  public void setupEnv() {
    RestAssured.port = port;
    RestAssured.basePath = "/api";
    RestAssured.baseURI = "http://localhost";
    RestAssured.config = RestAssured.config().httpClient(HttpClientConfig.httpClientConfig().httpMultipartMode(HttpMultipartMode.BROWSER_COMPATIBLE));
  }
  public void tearDownEnv() {
    given().contentType(ContentType.JSON)
        .when().post("/auth/logout");
  }
  @AfterClass
  public static void cleanDB() throws SQLException {
    Resource resource = new ClassPathResource("/testdata/CleanDB.sql");
    Connection connection = jdbcTemplate.getDataSource().getConnection();
    ScriptUtils.executeSqlScript(connection, resource);
    connection.close();
  }
}

@AfterClass 中使用了jdbcTemplate執(zhí)行了一個CleanDB.sql，通過這種方式清除所有測試數(shù)據(jù)。

@Value("${local.server.port}") 也要提一下，因為端口是隨機的，那么Rest-Assured不知道請求要發(fā)到losthost的哪個端口上，這里使用 @Value 獲取當(dāng)前的端口號并設(shè)置到 RestAssured.port 就解決了這個問題。

共有數(shù)據(jù)怎么處理

跑一次完整的IT，可能需要經(jīng)歷數(shù)十個Class，數(shù)百個method，那么如果一些數(shù)據(jù)是所有case都需要的，只有在所有case都跑完才需要清除怎么辦？換句話說，這種數(shù)據(jù)清理不是基于類的，而是基于一次運行。比如初始用戶數(shù)據(jù)，城市庫等等

我們耍了個小聰明，借助了 flyway

@Configuration
@ConditionalOnClass({DataSource.class})
public class UpgradeAutoConfiguration {
  public static final String FLYWAY = "flyway";
  @Bean(name = FLYWAY)
  @Profile({ENV_IT})
  public UpgradeService cleanAndUpgradeService(DataSource dataSource) {
    UpgradeService upgradeService = new FlywayUpgradeService(dataSource);
    try {
      upgradeService.cleanAndUpgrade();
    } catch (Exception ex) {
      LOGGER.error("Flyway failed!", ex);
    }
    return upgradeService;
  }
}

可以看到當(dāng)Profile是IT的情況下， flyway 會drop掉所有表并重新依次執(zhí)行每次的upgrade腳本，由此創(chuàng)建完整的數(shù)據(jù)表，當(dāng)然都是空的。在項目的test路徑下，增加一個版本極大的sql，這樣就可以讓 flyway 在最后插入共用的測試數(shù)據(jù)，例如 src/test/resources/db/migration/V999.0.1__Insert_Users.sql ，完美的解決各種數(shù)據(jù)問題。

小結(jié)

用Spring boot內(nèi)置的測試服務(wù)可以很快速的驗證API，我現(xiàn)在都不用把服務(wù)啟動再通過人工頁面點擊來測試自己的API，直接與前端同事溝通好Request的格式，寫個Case就可以驗證。

當(dāng)然這種方式也有一個不足就是不方便對系統(tǒng)進(jìn)行壓力測試，之前在公司的API測試用例都是Jmeter寫的，做性能測試的時候會方便很多。

您可能感興趣的文章: