2020-10-26 Spring Boot 的TDD使用方法

Spring Boot 的TDD使用方法

来源

  • Spring boot 网站分享的链接 https://content.pivotal.io/springone-platform-2017/test-driven-development-with-spring-boot-sannidhi-jalukar-madhura-bhave
  • 代码链接github.com/mbhave/tdd-with-spring-boot
  • 代码链接2github.com/sannidhi/tdd-boot-demo

基本内容

  • TDD 测试驱动开发，是先写测试，之后再补充代码。
  • 主要的困难在于写测试的时候很多类都没有。
  • 解决方案是：通过Mock的形式完成测试条件的准备，之后再补全对应的业务代码。
  • 测试分为3种
    • integrationTest，集成测试，测试真实的业务逻辑。
    • UnitTest + Spring，使用Spring的AutoWire等相关资源的单元测试。
    • UnitTest，单独的一个类的测试。

IntegrationTest


////////// IntegrationTests.java //////////

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class IntegrationTests {

    @Autowired
    private TestRestTemplate testRestTemplate;

    @Test
    public void getCar_WithName_ReturnsCar() {
        ResponseEntity<Car> responseEntity = this.testRestTemplate.getForEntity("/cars/{name}", Car.class, "prius");
        Car car = responseEntity.getBody();
        assertThat(responseEntity.getStatusCode()).isEqualTo(HttpStatus.OK);
        assertThat(car.getName()).isEqualTo("prius");
        assertThat(car.getType()).isEqualTo("hybrid");
    }
}

////////// Car.java //////////

@Entity
public class Car {

    @Id
    @GeneratedValue
    private Long id;

    private String name;

    private String type;

    public Car(String name, String type) {
        this.name = name;
        this.type = type;
    }

    public String getName() {
        return this.name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getType() {
        return this.type;
    }

    public void setType(String type) {
        this.type = type;
    }
}
  • 主要使用了@SpringBootTest注解，并指定了RandomPort
  • 请求通过TestRestTemplate构建，指定对应的数据类型，自动转换。
  • 每个结果通过assertThat进行验证
  • 集成测试用于验证整个的业务流程是否正确。并没有Mock的部分。是实际的程序运行测试。
  • 需要的主要是Entity对象，或者是JSON对象
  • 需要启动整个Spring程序以及tomcat服务器进行测试

ControllerTest


////////// CarsControllerTests.java //////////

@RunWith(SpringRunner.class)
@WebMvcTest
public class CarsControllerTests {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private CarService carService;

    @Test
    public void getCar_WithName_ReturnsCar() throws Exception {
        when(this.carService.getCarDetails("prius")).thenReturn(new Car("prius", "hybrid"));
        this.mockMvc.perform(get("/cars/{name}", "prius"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("name").value("prius"))
                .andExpect(jsonPath("type").value("hybrid"));
    }

    @Test
    public void getCar_NotFound_Returns404() throws Exception {
        when(this.carService.getCarDetails(any())).thenReturn(null);
        this.mockMvc.perform(get("/cars/{name}", "prius"))
                .andExpect(status().isNotFound());
    }

}

////////// CarsController.java //////////

@RestController
public class CarsController {

    private final CarService carService;

    public CarsController(CarService carService) {
        this.carService = carService;
    }

    @GetMapping("/cars/{name}")
    public Car getCar(@PathVariable String name) {
        Car car = this.carService.getCarDetails(name);
        if (car == null) {
            throw new CarNotFoundException();
        }
        return car;
    }
    
//  @ExceptionHandler
//  @ResponseStatus(HttpStatus.NOT_FOUND)
//  private void carNotFoundHandler(CarNotFoundException ex){}

}

////////// CarService.java //////////

@Service
public class CarService {

    public Car getCarDetails(String name) {
        return null;
    }
}

////////// CarNotFoundException.java //////////
@ResponseStatus(HttpStatus.NOT_FOUND)
public class CarNotFoundException extends RuntimeException {
}
  • 接口api测试，属于UnitTest+Spring
  • 使用@WebMvcTest注解
  • 使用了MockMvc模拟请求
  • 使用了MockBean作为模拟Service的返回值，发送给Controller
  • Controller调用Service的方式可以是直接的构造函数的参数包含。
  • 此时Service的逻辑不需要实现。因为都通过Mock实现了。
  • 因此只需要验证Controller的逻辑即可。
  • 对于Exception，优先使用RuntimeException()
  • 当Exception需要转换为不同的Response的时候
    • 可以使用@ResponseStatus，放在对应的Exception类上
    • 或者使用ExceptionHandler处理，也需要增加@ResponseStatus注解到对应方法上。

ServiceTest


////////// CarServiceTest.java //////////
@RunWith(MockitoJUnitRunner.class)
public class CarServiceTest {

    @Mock
    private CarRepository carRepository;

    private CarService carService;

    @Before
    public void setUp() throws Exception {
        carService = new CarService(carRepository);
    }

    @Test
    public void getCarDetails_returnsCarInfo() {
        given(carRepository.findByName("prius")).willReturn(new Car("prius", "hybrid"));

        Car car = carService.getCarDetails("prius");

        assertThat(car.getName()).isEqualTo("prius");
        assertThat(car.getType()).isEqualTo("hybrid");
    }

    @Test(expected = CarNotFoundException.class)
    public void getCarDetails_whenCarNotFound() throws Exception {
        given(carRepository.findByName("prius")).willReturn(null);

        carService.getCarDetails("prius");
    }
}

////////// CarService.java //////////
@Service
public class CarService {

    private CarRepository carRepository;

    public CarService(CarRepository carRepository) {
        this.carRepository = carRepository;
    }

    public Car getCarDetails(String name) {
        Car car = carRepository.findByName(name);
        if(car == null) {
            throw new CarNotFoundException();
        }
        return car;
    }
}

////////// CarRepository.java //////////
public class CarRepository{
    Car findByName(String name){
        return null;
    }
}
  • 服务测试，属于UnitTest
  • 仅仅验证Service的业务逻辑，使用MockitoJUnitRunner运行，而不是SpringRunner
  • 也就是不会使用AutoWire的功能，所以Repository需要通过构造函数传入。
  • 使用@Mock注解模拟Repository的功能。
  • 使用Mokito的given方法仿真Repository的对应方法的返回值。
  • 此时CarRepository不需要对方法进行实现也可以有返回值。
  • 直接使用service对象调用对应方法进行测试。

RepositoryTest

////////// CarRepositoryTest.java //////////
@RunWith(SpringRunner.class)
@DataJpaTest
public class CarRepositoryTests {

    @Autowired
    private CarRepository repository;

    @Autowired
    private TestEntityManager testEntityManager;

    @Test
    public void findByName_ReturnsCar() throws Exception {
        Car savedCar = testEntityManager.persistFlushFind(new Car("prius", "hybrid"));
        Car car = this.repository.findByName("prius");
        assertThat(car.getName()).isEqualTo(savedCar.getName());
        assertThat(car.getType()).isEqualTo(savedCar.getType());
    }
}

////////// CarRepository.java //////////
public interface CarRepository extends CrudRepository<Car,String> {
    Car findByName(String name);
}
  • 资源测试，属于UnitTest+Spring
  • 由于需要使用到实际的数据库，所以需要调用Spring。
  • 使用DataJpaTest注解，引用进行Repository测试的相关资源。其数据库默认是内部的内存数据库。
  • TestEntityManager可以直接使用。其中的persistFlushFind方法可以避免Repository.save的使用，为数据库添加一些临时资源，并自动回滚删除。
  • 如果不使用TestEntityManager，则需要在测试前首先配置数据库数据，然后手动delete。
  • Repository测试主要就是用来测试SQL语句是否符合逻辑。
  • 同时DataJpaTest可以使用@AutoConfigureTestDatabase指定自己需要的数据库。

CachingTest

////////// CachingTest.java //////////
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE)
@AutoConfigureTestDatabase
public class CachingTest {

    @Autowired
    private CarService service;

    @MockBean
    private CarRepository repository;

    @Test
    public void getCar_ReturnsCachedValue() throws Exception {
        given(repository.findByName(anyString())).willReturn(new Car("prius", "hybrid"));
        service.getCarDetails("prius");
        service.getCarDetails("prius");
        verify(repository, times(1)).findByName("prius");
    }
}

////////// CarsApplication.java //////////
@SpringBootApplication
@EnableCaching
public class CarsApplication {

    public static void main(String[] args) {
        SpringApplication.run(CarsApplication.class, args);
    }
}

////////// CarService.java //////////
@Service
public class CarService {

    private CarRepository carRepository;

    public CarService(CarRepository carRepository) {
        this.carRepository = carRepository;
    }

    @Cacheable("cars")
    public Car getCarDetails(String name) {
        Car car = carRepository.findByName(name);
        if(car == null) {
            throw new CarNotFoundException();
        }
        return car;
    }
}

////////// CarRepository.java //////////
public class CarRepository{
    Car findByName(String name){
        return null;
    }
}
  • 缓存测试，主要用来测试缓存的请求情况
  • 不需要使用网络环境webEnvironment = SpringBootTest.WebEnvironment.NONE
  • 使用内存数据库@AutoConfigureTestDatabase
  • 需要在Application上使用@EnableCaching启动缓存
  • 同时对应的Service方法需要进行@Cacheable("cars")注释，标记这返回值需要缓存。
  • 最后在测试的时候，多次请求service的对应方法，并检查Mock的Repository对应的方法调用次数，来判定是否使用了缓存的数据。
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,937评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,503评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,712评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,668评论 1赞 276
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,677评论 5赞 366
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,601评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,975评论 3赞 396
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,637评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,881评论 1赞 298
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,387评论 4赞 319
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,971评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2赞 342