借助模拟和单元测试助手,更喜欢Spring测试

原创|使用教程|编辑:郑恭琳|2021-01-22 09:59:11.580|阅读 10 次

概述:Spring框架(以及Spring Boot)提供了一个有用的测试框架,可为您的Spring Controllers编写JUnit测试。

# 周年庆正版采购有优惠,点击咨询 # # 31款JAVA开发必备控件和工具 #

相关链接:

Spring框架(以及Spring Boot)提供了一个有用的测试框架,可为您的Spring Controllers编写JUnit测试。

在我以前的文章中,我们讨论了如何使用Parasoft JtestUnit Test Assistant有效地构建和改进这些测试。在本文中,我将继续解决测试任何复杂应用程序的最大挑战之一:依赖关系管理


为什么我需要模拟?

说实话。复杂的应用程序不是从头开始构建的,而是使用库,API以及由其他人构建和维护的核心项目或服务。作为Spring开发人员,我们尽可能地利用现有功能,因此我们可以将时间和精力花在我们关心的方面:应用程序的业务逻辑。我们将详细信息留给库,因此我们的应用程序具有很多依赖性,如下面的橙色所示:


1.具有多个依赖项的Spring服务

如果单元测试的大多数功能取决于这些依赖项的行为,那么如何将单元测试集中在应用程序(控制器和服务)上?最后,我不是总是执行集成测试而不是单元测试吗?如果我需要更好地控制这些依赖项的行为,或者在单元测试期间这些依赖项不可用,该怎么办?


我需要的是一种将应用程序与这些依赖项隔离的方法,因此我可以将单元测试的重点放在应用程序代码上。在某些情况下,我们可以为这些依赖项创建专门的“测试”版本。但是,由于多种原因,使用Mockito之类的标准化库相对于此方法有很多好处:

  • 您不必自己编写和维护特殊的“测试”代码
  • 模拟库可以跟踪对模拟的调用,从而提供额外的验证层
  • 诸如PowerMock之类的标准库提供了附加功能,例如模拟静态方法,私有方法或构造函数
  • Mockito这样的模拟库的知识可以在项目中重复使用,而自定义测试代码的知识则不能重复使用


2.模拟服务替换了多个依赖关系

Spring的依赖

通常,Spring应用程序将功能拆分为Bean。控制器可能取决于Service Bean,而Service Bean可能取决于EntityManagerJDBC连接或另一个Bean。在大多数情况下,需要隔离测试代码的依赖是bean。在集成测试中,所有层都应该是真实的,但是对于单元测试,我们需要确定哪些依赖项应该是真实的,哪些应该是模拟的。

Spring允许开发人员使用XMLJava或两者的结合来定义和配置bean,以在您的配置中混合使用模拟bean和实际bean。由于需要在Java中定义模拟对象,因此应使用Configuration类来定义和配置模拟的bean


模拟依赖

UTA生成Spring测试时,控制器的所有依赖项都将设置为模拟,以便每个测试都可以控制该依赖项。运行测试时,UTA会检测尚未配置方法模拟的方法在模拟对象上进行的方法调用,并建议应模拟那些方法。然后,我们可以使用快速修复程序自动模拟每种方法。

这是依赖于PersonService的示例控制器:

@Controller

@RequestMapping("/people")

public class PeopleController {

 

    @Autowired

    protected PersonService personService;

    @GetMapping

    public ModelAndView people(Model model){

   

        for (Person person : personService.getAllPeople()) {

            model.addAttribute(person.getName(), person.getAge());

        }

        return new ModelAndView("people.jsp", model.asMap());

    }

}

还有由Parasoft Jtest的单元测试助手生成的示例测试:

@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration

public class PeopleControllerTest {

 

    @Autowired

    PersonService personService;

 

    // Other fields and setup

 

    @Configuration

    static class Config {

 

        // Other beans

 

        @Bean

        public PersonService getPersonService() {

            return mock(PersonService.class);

        }

    }

 

    @Test

    public void testPeople() throws Exception {

        // When

        ResultActions actions = mockMvc.perform(get("/people"));

    }

}

在这里,测试使用带有@Configuration注释的内部类,该类使用Java配置为受测控制器提供Bean依赖关系。这使我们可以在bean方法中模拟PersonService。还没有模拟方法,因此在运行测试时,我看到以下建议:

这意味着在我模拟的PersonService上调用了getAllPeople()方法,但是测试尚未为此方法配置模拟。当我选择“模拟”快速修复选项时,测试将更新:

    @Test

    public void testPeople() throws Exception {

        Collection<Person> getAllPeopleResult = new ArrayList<Person>();

        doReturn(getAllPeopleResult).when(personService).getAllPeople();

        // When

        ResultActions actions = mockMvc.perform(get("/people"));

当我再次运行测试时,它通过了。我仍然应该填充由getAllPeople()返回的Collection,但是解决了设置我的模拟依赖项的挑战。

请注意,我可以将生成的方法模拟从测试方法移到Configuration类的bean方法中。如果这样做,则意味着该类中的每个测试都将以相同的方式模拟相同的方法。将方法模拟保留在测试方法中意味着可以在不同的测试之间对方法进行不同的模拟。

Spring Boot

Spring Boot使Bean模拟变得更加容易。无需为测试中的bean和定义它的Configuration类使用@Autowired字段,您只需使用bean的字段并使用@MockBean对其进行注释即可。 Spring Boot将使用它在类路径上找到的模拟框架为该bean创建一个模拟,并以可以注入容器中任何其他bean的方式注入它。当使用单元测试助手生成Spring Boot测试时,使用@MockBean功能而不是Configuration类。

@SpringBootTest

@AutoConfigureMockMvc

public class PeopleControllerTest {

    // Other fields and setup – no Configuration class needed!

 

    @MockBean

    PersonService personService;

 

    @Test

    public void testPeople() throws Exception {

        ...

    }

}

XMLJava配置

在上面的第一个示例中,Configuration类将所有bean提供给Spring容器。另外,您可以将XML配置用于测试,而不是Configuration类。或者您可以将两者结合起来。例如:

@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration({ "classpath:/**/testContext.xml" })

public class PeopleControllerTest {

 

    @Autowired

    PersonService personService;

 

    // Other fields and setup

 

    @Configuration

    static class Config {

        @Bean

        @Primary

        public PersonService getPersonService() {

            return mock(PersonService.class);

        }

    }

 

    // Tests

}

在这里,该类在@ContextConfiguration批注(此处未显示)中引用XML配置文件以提供大多数bean,这些bean可以是真实bean或特定于测试的bean。 我们还提供了@Configuration类,其中模拟了PersonService@Primary批注指示即使在XML配置中找到了PersonService bean,该测试也将使用@Configuration类中的模拟bean。这种类型的配置可以使测试代码更小、更易于管理。

您可以使用所需的任何特定@ContextConfiguration属性将UTA配置为生成测试。

模拟静态方法

有时,依赖项是静态访问的。例如,应用程序可能通过静态方法调用访问第三方服务:

public class ExternalPersonService {

    public static Person getPerson(int id) {

       RestTemplate restTemplate = new RestTemplate();

       try {

           return restTemplate.getForObject("http://domain.com/people/" + id, Person.class);

        } catch (RestClientException e) {

            return null;

        }

    }

}

在我们的控制器中:

    @GetMapping

    public ResponseEntity<Person> getPerson(@PathVariable("id") int id, Model model)

    {

        Person person = ExternalPersonService.getPerson(id);

        if (person != null) {

            return new ResponseEntity<Person>(person, HttpStatus.OK);

        }

        return new ResponseEntity<>(HttpStatus.NOT_FOUND);

    }

在此示例中,我们的处理程序方法使用静态方法调用从第三方服务获取Person对象。当我们为此处理程序方法构建JUnit测试时,每次运行测试时都会对服务进行真正的HTTP调用。

相反,让我们模拟静态的ExternalPersonService.getPerson()方法。这可以防止HTTP调用,并允许我们提供适合我们测试需求的Person对象响应。单元测试助手可以使使用PowerMockito模拟静态方法更加容易。

UTA为上面的处理程序方法生成一个测试,如下所示:

    @Test

    public void testGetPerson() throws Throwable {

        // When

        long id = 1L;

        ResultActions actions = mockMvc.perform(get("/people/" + id));

 

        // Then

        actions.andExpect(status().isOk());

    }

运行测试时,我们将看到在UTA流树中进行的HTTP调用。让我们找到对ExternalPersonService.getPerson()的调用,并对其进行模拟:


测试已更新为使用PowerMock模拟此测试的静态方法:

    @Test

    public void testGetPerson() throws Throwable {

        spy(ExternalPersonService.class);

 

        Person getPersonResult = null; // UTA: default value

        doReturn(getPersonResult).when(ExternalPersonService.class, "getPerson", anyInt());

 

        // When

        int id = 0;

        ResultActions actions = mockMvc.perform(get("/people/" + id));

 

        // Then

        actions.andExpect(status().isOk());

    }

现在,使用UTA,我们可以选择getPersonResult变量并将其实例化,以便模拟方法调用不会返回null

    String name = ""; // UTA: default value

    int age = 0; // UTA: default value

    Person getPersonResult = new Person(name, age);


当我们再次运行测试时,getPersonResult模拟ExternalPersonService.getPerson()方法返回,并且测试通过。

注意:从流树中,您还可以为静态方法调用选择“添加可模拟方法模式”。这会将单元测试助手配置为在生成新测试时始终模拟那些静态方法调用。


结论

复杂的应用程序通常具有功能依赖性,这会使开发人员对代码进行单元测试的能力复杂化并受到限制。使用Mockito这样的模拟框架可以帮助开发人员将测试中的代码与这些依赖项隔离开来,从而使他们能够更快地编写更好的单元测试。Parasoft Jtest单元测试助手通过配置新的测试以使用模拟,并在运行时查找丢失的方法模拟并帮助开发人员为它们生成模拟,使依赖关系管理变得容易。







标签:

本站文章除注明转载外,均为本站原创或翻译。欢迎任何形式的转载,但请务必注明出处、不得修改原文相关链接,尊重他人劳动成果

登录 慧都网发表评论


暂无评论...

为你推荐

  • 推荐视频
  • 推荐活动
  • 推荐产品
  • 推荐文章
  • 慧都慧问
相关厂商
相关产品
Parasoft Jtest

专业针对Java语言的开发测试方案,可无缝集成Parasoft SOAtest

在线
客服
咨询
电话
400-700-1020
在线
QQ
购物车 反馈 返回
顶部
在线客服系统
live chat