Spring-启动单元测试:ConstraintValidator 中的@Value
Spring-Boot UnitTest: @Value in ConstraintValidator
我目前正在提供覆盖范围 - 通过 MockMVC 请求调用测试我的 DTO 的验证。
我最近在我的注册约束验证器中引入了一个新字段,supportedSpecializations,我从 application.properties 中注入值,以便于维护和扩展。请参阅下面的代码片段:
@Component
public class RegistrationValidator implements ConstraintValidator<Registration, String> {
//campus.students.supportedspecializations="J2E,.NET,OracleDB,MySQL,Angular"
@Value("${campus.students.supportedspecializations}")
private String supportedSpecializations;
private String specializationExceptionMessage;
//All ExceptionMessages are maintained in a separate class
@Override
public void initialize(Registration constraintAnnotation) {
exceptionMessage = constraintAnnotation.regionException().getMessage();
}
@Override
public boolean isValid(RegistrationData regData, ConstraintValidatorContext context) {
String[] specializations = supportedSpecializations.split(",");
boolean isValidSpecialization = Arrays.stream(specializations)
.anyMatch(spec -> spec.equalsIgnoreCase(regData.getSpec()));
if (!isValidSpecialization){
context.disableDefaultConstraintViolation();
context.buildConstraintViolationWithTemplate(specializationExceptionMessage)
.addConstraintViolation();
return false;
}
//additional validation logic...
return true;
}
}
单元测试现在失败,因为该字段未被 @Value 注释的定义 属性 注入。
我不确定 ReflectionTestUtils 是否对我的情况有帮助,因此非常感谢任何关于如何在 UnitTests 中注入所需值的建议。
Spring版本为2.1.0
我目前正在使用以下代码片段进行测试:
@InjectMocks
private StudentController mockRestController;
@Mock
private StudentService mockStudentService;
@Mock
private ValidationExceptionTranslator mockExceptionTranslator;
@Value("${campus.students.supportedspecializations}")
private String supportedSpecializations;
private MockMvc mockMvc;
private static final String VALIDATION_SUCCESSFUL = "success";
private static final String VALIDATION_FAILED = "failed";
@Before
public void setup() {
MockitoAnnotations.initMocks(this);
this.mockMvc = MockMvcBuilders.standaloneSetup(mockRestController).build();
doReturn(
ResponseEntity.status(HttpStatus.OK)
.header("Content-Type", "text/html; charset=utf-8")
.body(VALIDATION_SUCCESSFUL))
.when(mockStudentService).insertStudent(Mockito.any());
doReturn(
ResponseEntity.status(HttpStatus.BAD_REQUEST)
.header("Content-Type", "application/json")
.body(VALIDATION_FAILED))
.when(mockExceptionTranslator).translate(Mockito.any());
}
@Test
public void testValidation_UnsupportedSpecialization() throws Exception {
MvcResult mvcResult = mockMvc.perform(
post("/Students").contentType(MediaType.APPLICATION_JSON_UTF8).content(
"{\"registrationData\":{\"spec\":\"unsupported\"}}"))
.andExpect(status().isBadRequest())
.andReturn();
assertEquals(VALIDATION_FAILED, mvcResult.getResponse().getContentAsString());
verify(mockExceptionTranslator, times(1)).translate(Mockito.any());
verify(mockStudentService, times(0)).insertStudent(Mockito.any());
}
我尝试使用 @RunWith(SpringRunner.class) 和 @SpringBootTest(classes = Application.class),但由于@Value 未被解析,验证测试仍然失败。我可能是错的,但我认为 ConstraintValidator 的实例是在我们到达 restController 之前创建的,因此 MockMVC perform(...) 调用不能简单地确保适当的@Value验证器被注入 supportedSpecializations.
是的,
使用 ReflectionTestUtil
.
使用ReflectionTestUtil.setField
设置supportedSpecializations
的值
setup()
方法(junit < 1.4)
或单元测试中的 @Before
注释方法 (junit > 1.4)。
更多详情
我建议不要使用 MockMVC
进行单元测试;
适合集成测试,
只是不是单元测试。
不需要开始 Spring 进行单元测试;
您永远不需要 Spring 来为您的单元测试执行注入。
反而,
实例化您正在测试的 class 并直接调用方法。
这是一个简单的例子:
public class TestRegistrationValidator
{
private static final String VALUE_EXCEPTION_MESSAGE = "VALUE_EXCEPTION_MESSAGE";
private static final String VALUE_SUPPORTED_SPECIALIZATIONS = "BLAMMY,KAPOW";
private RegistrationValidator classToTest;
@Mock
private Registration mockRegistration;
@Mock
private RegionExceptionType mockRegionExceptionType; // use the actual type of regionExcpeption.
@Before
public void preTestSetup()
{
MockitoAnnotations.initMocks(this);
ReflectionTestUtils.setField(classToTest, "supportedSpecializations", VALUE_SUPPORTED_SPECIALIZATIONS);
doReturn(VALUE_EXCEPTION_MESSAGE).when(mockRegionExceptionType).getMessage();
doReturn(mockRegionExceptionType).when(mockRegion).regionException();
}
@Test
public void initialize_allGood_success()
{
classToTest.initialize(mockRegistration);
...assert some stuff.
...perhaps verify some stuff.
}
}
我认为对你来说最好的选择是在你的 RegistrationValidator.class
中使用构造函数注入,这样你就可以在需要时直接为测试分配模拟或测试值。示例:
@Component
class ExampleClass {
final String text
// Use @Autowired to get @Value to work.
@Autowired
ExampleClass(
// Refer to configuration property
// app.message.text to set value for
// constructor argument message.
@Value('${app.message.text}') final String text) {
this.text = text
}
}
通过这种方式,您可以将模拟值设置为用于单元测试的变量。
是的,你是对的,自定义构造函数在这里不是一个选项,那么你可以引入一个配置 class,你可以从 yml 或 属性 中读取这些值,并在验证器中自动装配它们。这应该适用于你.
或
您可以在单独的 test.yml
或 test.properties
中提供 @Value
属性,并指定在 运行 集成测试时使用。在那种情况下,您应该能够解析这些值。
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = ExampleApplication.class)
@TestPropertySource(locations="classpath:test.properties")
public class ExampleApplicationTests {
}
@TestPropertySource
注释具有更高的优先顺序,它应该解析您的值。
通过以下方式解决了问题:
在测试中添加了以下注释 Class
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
@AutoConfigureMockMvc
然后自动装配控制器和mockMVC,最后用Spring的注释服务和翻译器@MockBean
所以目前它看起来像这样:
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
@AutoConfigureMockMvc
public class StudentValidatorTest {
@Autowired
private StudentController mockRestController;
@MockBean
private StudentService mockStudentService;
@MockBean
private ValidationExceptionTranslator mockExceptionTranslator;
@Autowired
private MockMvc mockMvc;
private static final String VALIDATION_SUCCESSFUL = "success";
private static final String VALIDATION_FAILED = "failed";
@Before
public void setup() {
MockitoAnnotations.initMocks(this);
this.mockMvc = MockMvcBuilders.standaloneSetup(mockRestController).build();
doReturn(
ResponseEntity.status(HttpStatus.OK)
.header("Content-Type", "text/html; charset=utf-8")
.body(VALIDATION_SUCCESSFUL))
.when(mockStudentService).insertStudent(Mockito.any());
doReturn(
ResponseEntity.status(HttpStatus.BAD_REQUEST)
.header("Content-Type", "application/json")
.body(VALIDATION_FAILED))
.when(mockExceptionTranslator).translate(Mockito.any());
}
//...and tests...
我目前正在提供覆盖范围 - 通过 MockMVC 请求调用测试我的 DTO 的验证。 我最近在我的注册约束验证器中引入了一个新字段,supportedSpecializations,我从 application.properties 中注入值,以便于维护和扩展。请参阅下面的代码片段:
@Component
public class RegistrationValidator implements ConstraintValidator<Registration, String> {
//campus.students.supportedspecializations="J2E,.NET,OracleDB,MySQL,Angular"
@Value("${campus.students.supportedspecializations}")
private String supportedSpecializations;
private String specializationExceptionMessage;
//All ExceptionMessages are maintained in a separate class
@Override
public void initialize(Registration constraintAnnotation) {
exceptionMessage = constraintAnnotation.regionException().getMessage();
}
@Override
public boolean isValid(RegistrationData regData, ConstraintValidatorContext context) {
String[] specializations = supportedSpecializations.split(",");
boolean isValidSpecialization = Arrays.stream(specializations)
.anyMatch(spec -> spec.equalsIgnoreCase(regData.getSpec()));
if (!isValidSpecialization){
context.disableDefaultConstraintViolation();
context.buildConstraintViolationWithTemplate(specializationExceptionMessage)
.addConstraintViolation();
return false;
}
//additional validation logic...
return true;
}
}
单元测试现在失败,因为该字段未被 @Value 注释的定义 属性 注入。 我不确定 ReflectionTestUtils 是否对我的情况有帮助,因此非常感谢任何关于如何在 UnitTests 中注入所需值的建议。
Spring版本为2.1.0 我目前正在使用以下代码片段进行测试:
@InjectMocks
private StudentController mockRestController;
@Mock
private StudentService mockStudentService;
@Mock
private ValidationExceptionTranslator mockExceptionTranslator;
@Value("${campus.students.supportedspecializations}")
private String supportedSpecializations;
private MockMvc mockMvc;
private static final String VALIDATION_SUCCESSFUL = "success";
private static final String VALIDATION_FAILED = "failed";
@Before
public void setup() {
MockitoAnnotations.initMocks(this);
this.mockMvc = MockMvcBuilders.standaloneSetup(mockRestController).build();
doReturn(
ResponseEntity.status(HttpStatus.OK)
.header("Content-Type", "text/html; charset=utf-8")
.body(VALIDATION_SUCCESSFUL))
.when(mockStudentService).insertStudent(Mockito.any());
doReturn(
ResponseEntity.status(HttpStatus.BAD_REQUEST)
.header("Content-Type", "application/json")
.body(VALIDATION_FAILED))
.when(mockExceptionTranslator).translate(Mockito.any());
}
@Test
public void testValidation_UnsupportedSpecialization() throws Exception {
MvcResult mvcResult = mockMvc.perform(
post("/Students").contentType(MediaType.APPLICATION_JSON_UTF8).content(
"{\"registrationData\":{\"spec\":\"unsupported\"}}"))
.andExpect(status().isBadRequest())
.andReturn();
assertEquals(VALIDATION_FAILED, mvcResult.getResponse().getContentAsString());
verify(mockExceptionTranslator, times(1)).translate(Mockito.any());
verify(mockStudentService, times(0)).insertStudent(Mockito.any());
}
我尝试使用 @RunWith(SpringRunner.class) 和 @SpringBootTest(classes = Application.class),但由于@Value 未被解析,验证测试仍然失败。我可能是错的,但我认为 ConstraintValidator 的实例是在我们到达 restController 之前创建的,因此 MockMVC perform(...) 调用不能简单地确保适当的@Value验证器被注入 supportedSpecializations.
是的,
使用 ReflectionTestUtil
.
使用ReflectionTestUtil.setField
设置supportedSpecializations
的值
setup()
方法(junit < 1.4)
或单元测试中的 @Before
注释方法 (junit > 1.4)。
更多详情
我建议不要使用 MockMVC
进行单元测试;
适合集成测试,
只是不是单元测试。
不需要开始 Spring 进行单元测试; 您永远不需要 Spring 来为您的单元测试执行注入。 反而, 实例化您正在测试的 class 并直接调用方法。
这是一个简单的例子:
public class TestRegistrationValidator
{
private static final String VALUE_EXCEPTION_MESSAGE = "VALUE_EXCEPTION_MESSAGE";
private static final String VALUE_SUPPORTED_SPECIALIZATIONS = "BLAMMY,KAPOW";
private RegistrationValidator classToTest;
@Mock
private Registration mockRegistration;
@Mock
private RegionExceptionType mockRegionExceptionType; // use the actual type of regionExcpeption.
@Before
public void preTestSetup()
{
MockitoAnnotations.initMocks(this);
ReflectionTestUtils.setField(classToTest, "supportedSpecializations", VALUE_SUPPORTED_SPECIALIZATIONS);
doReturn(VALUE_EXCEPTION_MESSAGE).when(mockRegionExceptionType).getMessage();
doReturn(mockRegionExceptionType).when(mockRegion).regionException();
}
@Test
public void initialize_allGood_success()
{
classToTest.initialize(mockRegistration);
...assert some stuff.
...perhaps verify some stuff.
}
}
我认为对你来说最好的选择是在你的 RegistrationValidator.class
中使用构造函数注入,这样你就可以在需要时直接为测试分配模拟或测试值。示例:
@Component
class ExampleClass {
final String text
// Use @Autowired to get @Value to work.
@Autowired
ExampleClass(
// Refer to configuration property
// app.message.text to set value for
// constructor argument message.
@Value('${app.message.text}') final String text) {
this.text = text
}
}
通过这种方式,您可以将模拟值设置为用于单元测试的变量。 是的,你是对的,自定义构造函数在这里不是一个选项,那么你可以引入一个配置 class,你可以从 yml 或 属性 中读取这些值,并在验证器中自动装配它们。这应该适用于你.
或
您可以在单独的 test.yml
或 test.properties
中提供 @Value
属性,并指定在 运行 集成测试时使用。在那种情况下,您应该能够解析这些值。
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = ExampleApplication.class)
@TestPropertySource(locations="classpath:test.properties")
public class ExampleApplicationTests {
}
@TestPropertySource
注释具有更高的优先顺序,它应该解析您的值。
通过以下方式解决了问题: 在测试中添加了以下注释 Class
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
@AutoConfigureMockMvc
然后自动装配控制器和mockMVC,最后用Spring的注释服务和翻译器@MockBean
所以目前它看起来像这样:
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
@AutoConfigureMockMvc
public class StudentValidatorTest {
@Autowired
private StudentController mockRestController;
@MockBean
private StudentService mockStudentService;
@MockBean
private ValidationExceptionTranslator mockExceptionTranslator;
@Autowired
private MockMvc mockMvc;
private static final String VALIDATION_SUCCESSFUL = "success";
private static final String VALIDATION_FAILED = "failed";
@Before
public void setup() {
MockitoAnnotations.initMocks(this);
this.mockMvc = MockMvcBuilders.standaloneSetup(mockRestController).build();
doReturn(
ResponseEntity.status(HttpStatus.OK)
.header("Content-Type", "text/html; charset=utf-8")
.body(VALIDATION_SUCCESSFUL))
.when(mockStudentService).insertStudent(Mockito.any());
doReturn(
ResponseEntity.status(HttpStatus.BAD_REQUEST)
.header("Content-Type", "application/json")
.body(VALIDATION_FAILED))
.when(mockExceptionTranslator).translate(Mockito.any());
}
//...and tests...