我怎样才能模拟 java.time.LocalDate.now()
How can I mock java.time.LocalDate.now()
在我的测试用例中,我需要测试时间敏感的方法,在那个方法中我们使用 java 8 class LocalDate,它是 不是 Joda.
当我运行测试
时,我能做些什么来改变时间
在您的代码中,将 LocalDate.now()
替换为 LocalDate.now(clock);
。
然后您可以通过 Clock.systemDefaultZone()
生产和 a fixed clock 测试。
这是一个例子:
首先,注入Clock
。如果您使用 spring 引导,只需执行 :
@Bean
public Clock clock() {
return Clock.systemDefaultZone();
}
其次,在您的代码中调用 LocalDate.now(clock)
:
@Component
public class SomeClass{
@Autowired
private Clock clock;
public LocalDate someMethod(){
return LocalDate.now(clock);
}
}
现在,在你的单元测试中 class :
// Some fixed date to make your tests
private final static LocalDate LOCAL_DATE = LocalDate.of(1989, 01, 13);
// mock your tested class
@InjectMocks
private SomeClass someClass;
//Mock your clock bean
@Mock
private Clock clock;
//field that will contain the fixed clock
private Clock fixedClock;
@Before
public void initMocks() {
MockitoAnnotations.initMocks(this);
//tell your tests to return the specified LOCAL_DATE when calling LocalDate.now(clock)
fixedClock = Clock.fixed(LOCAL_DATE.atStartOfDay(ZoneId.systemDefault()).toInstant(), ZoneId.systemDefault());
doReturn(fixedClock.instant()).when(clock).instant();
doReturn(fixedClock.getZone()).when(clock).getZone();
}
@Test
public void testSomeMethod(){
// call the method to test
LocalDate returnedLocalDate = someClass.someMethod();
//assert
assertEquals(LOCAL_DATE, returnedLocalDate);
}
您可能还想在生产中传递固定时钟(其值在事务开始时固定)以避免在不同的实体和请求中使用不一致的 "now"。
有关详细信息,请参阅 。
您可以重构您的代码以使其易于测试,例如,将 LocalDate.now()
的所有调用替换为调用自定义可模拟非静态 class.[=12= 的某些方法]
或者,您可以使用 PowerMock's mockStatic。
如果我们需要像 now() 这样的模拟静态方法,我们可以使用多个替代方法,例如 PowerMock:
@RunWith(PowerMockRunner.class)
@PrepareForTest({ LocalDateTime.class })
public class LocalDateTimeUnitTest {
@Test
public void givenLocalDateTimeMock_whenNow_thenGetFixedLocalDateTime() {
Clock clock = Clock.fixed(Instant.parse("2014-12-22T10:15:30.00Z"), ZoneId.of("UTC"));
LocalDateTime dateTime = LocalDateTime.now(clock);
mockStatic(LocalDateTime.class);
when(LocalDateTime.now()).thenReturn(dateTime);
String dateTimeExpected = "2014-12-22T10:15:30";
LocalDateTime now = LocalDateTime.now();
assertThat(now).isEqualTo(dateTimeExpected);
}
}
或JMockit,确实有了JMockit我们可以使用MockUp class:
@Test
public void givenLocalDateTimeWithJMock_whenNow_thenGetFixedLocalDateTime() {
Clock clock = Clock.fixed(Instant.parse("2014-12-21T10:15:30.00Z"), ZoneId.of("UTC"));
new MockUp<LocalDateTime>() {
@Mock
public LocalDateTime now() {
return LocalDateTime.now(clock);
}
};
String dateTimeExpected = "2014-12-21T10:15:30";
LocalDateTime now = LocalDateTime.now();
assertThat(now).isEqualTo(dateTimeExpected);
}
或期望 class:
@Test
public void givenLocalDateTimeWithExpectations_whenNow_thenGetFixedLocalDateTime() {
Clock clock = Clock.fixed(Instant.parse("2014-12-23T10:15:30.00Z"), ZoneId.of("UTC"));
LocalDateTime dateTimeExpected = LocalDateTime.now(clock);
new Expectations(LocalDateTime.class) {
{
LocalDateTime.now();
result = dateTimeExpected;
}
};
LocalDateTime now = LocalDateTime.now();
assertThat(now).isEqualTo(dateTimeExpected);
}
我们可以找到更多例子here。
另一个简单的替代方法是使用具有固定时钟实例的 now() 方法。 当然,java.time 包中的大多数 classes 都有一个带有 Clock 参数的 now() 方法:
@Test
public void givenFixedClock_whenNow_thenGetFixedLocalDateTime() {
Clock clock = Clock.fixed(Instant.parse("2014-12-22T10:15:30.00Z"), ZoneId.of("UTC"));
String dateTimeExpected = "2014-12-22T10:15:30";
LocalDateTime dateTime = LocalDateTime.now(clock);
assertThat(dateTime).isEqualTo(dateTimeExpected);
}
使用Spring:
时钟配置class:
@Configuration
public class ClockConfiguration {
private final static LocalDate LOCAL_DATE = LocalDate.of(2019, 12, 17);
@Bean
@ConditionalOnMissingBean
Clock getSystemDefaultZoneClock() {
return Clock.systemDefaultZone();
}
@Bean
@Profile("test")
@Primary
Clock getFixedClock() {
return Clock.fixed(LOCAL_DATE.atStartOfDay(ZoneId.systemDefault()).toInstant(), ZoneId.systemDefault());
}
}
SomeService class:
@Service
@RequiredArgsConstructor
public class SomeService {
private final Clock clock;
public void someMethod(){
...
LocalDateTime.now(clock)
LocalDate.now(clock)
...
}
}
您必须在测试中有一个有效的 "test" 配置文件:
SomeServiceTest class:
@ActiveProfiles("test")
@EnableConfigurationProperties
@SpringBootTest(classes = [YourAppMainClass])
class SomeServiceTest {
...
}
您可以在您正在测试的 class 中使用 supplier,以便在使用日期时间的任何地方传递当前时间。
public Supplier<LocalDateTime> localDateTime = () -> LocalDateTime.now();
并且在测试方法中只需覆盖它的值,如:
myClassObj.localDateTime = () -> LocalDateTime.parse("2020-11-24T23:59:59.999");
我们必须在这里模拟一个静态方法。我使用以下依赖项。请记住,我们所有的测试代码都必须在 try 块中。只要我们调用 LocalDate.now() 或 LocalDate
<!-- https://mvnrepository.com/artifact/org.mockito/mockito-inline -->
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-inline</artifactId>
<version>3.11.0</version>
<scope>test</scope>
</dependency>
代码:
@Test
void verifykNonLeapYear() {
LocalDate currentLocalDate = LocalDate.of(2010, 2, 13);
try (MockedStatic<LocalDate> topDateTimeUtilMock = Mockito.mockStatic(LocalDate.class)) {
topDateTimeUtilMock.when(() -> LocalDate.now()).thenReturn(currentLocalDate);
assertThat(TopDateTimeUtil.numberOfDaysInCurrentYear(), is(365));
}
}
在我的测试用例中,我需要测试时间敏感的方法,在那个方法中我们使用 java 8 class LocalDate,它是 不是 Joda.
当我运行测试
时,我能做些什么来改变时间在您的代码中,将 LocalDate.now()
替换为 LocalDate.now(clock);
。
然后您可以通过 Clock.systemDefaultZone()
生产和 a fixed clock 测试。
这是一个例子:
首先,注入Clock
。如果您使用 spring 引导,只需执行 :
@Bean
public Clock clock() {
return Clock.systemDefaultZone();
}
其次,在您的代码中调用 LocalDate.now(clock)
:
@Component
public class SomeClass{
@Autowired
private Clock clock;
public LocalDate someMethod(){
return LocalDate.now(clock);
}
}
现在,在你的单元测试中 class :
// Some fixed date to make your tests
private final static LocalDate LOCAL_DATE = LocalDate.of(1989, 01, 13);
// mock your tested class
@InjectMocks
private SomeClass someClass;
//Mock your clock bean
@Mock
private Clock clock;
//field that will contain the fixed clock
private Clock fixedClock;
@Before
public void initMocks() {
MockitoAnnotations.initMocks(this);
//tell your tests to return the specified LOCAL_DATE when calling LocalDate.now(clock)
fixedClock = Clock.fixed(LOCAL_DATE.atStartOfDay(ZoneId.systemDefault()).toInstant(), ZoneId.systemDefault());
doReturn(fixedClock.instant()).when(clock).instant();
doReturn(fixedClock.getZone()).when(clock).getZone();
}
@Test
public void testSomeMethod(){
// call the method to test
LocalDate returnedLocalDate = someClass.someMethod();
//assert
assertEquals(LOCAL_DATE, returnedLocalDate);
}
您可能还想在生产中传递固定时钟(其值在事务开始时固定)以避免在不同的实体和请求中使用不一致的 "now"。
有关详细信息,请参阅
您可以重构您的代码以使其易于测试,例如,将 LocalDate.now()
的所有调用替换为调用自定义可模拟非静态 class.[=12= 的某些方法]
或者,您可以使用 PowerMock's mockStatic。
如果我们需要像 now() 这样的模拟静态方法,我们可以使用多个替代方法,例如 PowerMock:
@RunWith(PowerMockRunner.class)
@PrepareForTest({ LocalDateTime.class })
public class LocalDateTimeUnitTest {
@Test
public void givenLocalDateTimeMock_whenNow_thenGetFixedLocalDateTime() {
Clock clock = Clock.fixed(Instant.parse("2014-12-22T10:15:30.00Z"), ZoneId.of("UTC"));
LocalDateTime dateTime = LocalDateTime.now(clock);
mockStatic(LocalDateTime.class);
when(LocalDateTime.now()).thenReturn(dateTime);
String dateTimeExpected = "2014-12-22T10:15:30";
LocalDateTime now = LocalDateTime.now();
assertThat(now).isEqualTo(dateTimeExpected);
}
}
或JMockit,确实有了JMockit我们可以使用MockUp class:
@Test
public void givenLocalDateTimeWithJMock_whenNow_thenGetFixedLocalDateTime() {
Clock clock = Clock.fixed(Instant.parse("2014-12-21T10:15:30.00Z"), ZoneId.of("UTC"));
new MockUp<LocalDateTime>() {
@Mock
public LocalDateTime now() {
return LocalDateTime.now(clock);
}
};
String dateTimeExpected = "2014-12-21T10:15:30";
LocalDateTime now = LocalDateTime.now();
assertThat(now).isEqualTo(dateTimeExpected);
}
或期望 class:
@Test
public void givenLocalDateTimeWithExpectations_whenNow_thenGetFixedLocalDateTime() {
Clock clock = Clock.fixed(Instant.parse("2014-12-23T10:15:30.00Z"), ZoneId.of("UTC"));
LocalDateTime dateTimeExpected = LocalDateTime.now(clock);
new Expectations(LocalDateTime.class) {
{
LocalDateTime.now();
result = dateTimeExpected;
}
};
LocalDateTime now = LocalDateTime.now();
assertThat(now).isEqualTo(dateTimeExpected);
}
我们可以找到更多例子here。
另一个简单的替代方法是使用具有固定时钟实例的 now() 方法。 当然,java.time 包中的大多数 classes 都有一个带有 Clock 参数的 now() 方法:
@Test
public void givenFixedClock_whenNow_thenGetFixedLocalDateTime() {
Clock clock = Clock.fixed(Instant.parse("2014-12-22T10:15:30.00Z"), ZoneId.of("UTC"));
String dateTimeExpected = "2014-12-22T10:15:30";
LocalDateTime dateTime = LocalDateTime.now(clock);
assertThat(dateTime).isEqualTo(dateTimeExpected);
}
使用Spring:
时钟配置class:
@Configuration
public class ClockConfiguration {
private final static LocalDate LOCAL_DATE = LocalDate.of(2019, 12, 17);
@Bean
@ConditionalOnMissingBean
Clock getSystemDefaultZoneClock() {
return Clock.systemDefaultZone();
}
@Bean
@Profile("test")
@Primary
Clock getFixedClock() {
return Clock.fixed(LOCAL_DATE.atStartOfDay(ZoneId.systemDefault()).toInstant(), ZoneId.systemDefault());
}
}
SomeService class:
@Service
@RequiredArgsConstructor
public class SomeService {
private final Clock clock;
public void someMethod(){
...
LocalDateTime.now(clock)
LocalDate.now(clock)
...
}
}
您必须在测试中有一个有效的 "test" 配置文件:
SomeServiceTest class:
@ActiveProfiles("test")
@EnableConfigurationProperties
@SpringBootTest(classes = [YourAppMainClass])
class SomeServiceTest {
...
}
您可以在您正在测试的 class 中使用 supplier,以便在使用日期时间的任何地方传递当前时间。
public Supplier<LocalDateTime> localDateTime = () -> LocalDateTime.now();
并且在测试方法中只需覆盖它的值,如:
myClassObj.localDateTime = () -> LocalDateTime.parse("2020-11-24T23:59:59.999");
我们必须在这里模拟一个静态方法。我使用以下依赖项。请记住,我们所有的测试代码都必须在 try 块中。只要我们调用 LocalDate.now() 或 LocalDate
<!-- https://mvnrepository.com/artifact/org.mockito/mockito-inline -->
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-inline</artifactId>
<version>3.11.0</version>
<scope>test</scope>
</dependency>
代码:
@Test
void verifykNonLeapYear() {
LocalDate currentLocalDate = LocalDate.of(2010, 2, 13);
try (MockedStatic<LocalDate> topDateTimeUtilMock = Mockito.mockStatic(LocalDate.class)) {
topDateTimeUtilMock.when(() -> LocalDate.now()).thenReturn(currentLocalDate);
assertThat(TopDateTimeUtil.numberOfDaysInCurrentYear(), is(365));
}
}