Skip to content

GH-3182: Properly reset bean in the MockIntCtx #3190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 21, 2020
Merged

GH-3182: Properly reset bean in the MockIntCtx #3190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e69e038
GH-3182: Properly reset bean in the MockIntCtx
artembilan Feb 20, 2020
9141874
* Ensure that only provided beans are reset
artembilan Feb 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions ...st/src/main/java/org/springframework/integration/test/context/MockIntegrationContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2017-2019 the original author or authors.
* Copyright 2017-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -27,6 +27,7 @@
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.context.Lifecycle;
import org.springframework.context.SmartLifecycle;
import org.springframework.integration.core.MessageProducer;
import org.springframework.integration.core.MessageSource;
import org.springframework.integration.endpoint.IntegrationConsumer;
Expand Down Expand Up @@ -97,6 +98,11 @@ public void resetBeans(String... beanNames) {
.forEach(e -> {
Object endpoint = this.beanFactory.getBean(e.getKey());
DirectFieldAccessor directFieldAccessor = new DirectFieldAccessor(endpoint);
SmartLifecycle lifecycle = null;
if (endpoint instanceof SmartLifecycle && ((SmartLifecycle) endpoint).isRunning()) {
lifecycle = (SmartLifecycle) endpoint;
lifecycle.stop();
}
if (endpoint instanceof SourcePollingChannelAdapter) {
directFieldAccessor.setPropertyValue("source", e.getValue());
}
Expand All @@ -108,9 +114,19 @@ else if (endpoint instanceof ReactiveStreamsConsumer) {
else if (endpoint instanceof IntegrationConsumer) {
directFieldAccessor.setPropertyValue(HANDLER, e.getValue());
}
if (lifecycle != null && lifecycle.isAutoStartup()) {
Copy link

@hgarus hgarus Feb 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this have potential to break existing tests?

Maybe this just matters for constructed examples. But I could imagine something like this:

@BeforeClass
void init() {
  nonAutostartupHandler.start();
}

@After 
void cleanup() {
  mockIntegrationContext.reset()
}

@Test
void t1() {
  // do something with handler
}

@Test 
void t2() {
  // expect handler to be still running
}

Admittedly the @BeforeClass is somewhat artificial. But I could see a handler being manually started as part of context initialization.

I'm sorry for not contributing a fix myself, I had a pretty busy week at work.

Copy link
Member Author

@artembilan artembilan Feb 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nonAutostartupHandler.start(); - you definitely start it manually. The framework can't assume when and how you have started it or going to.
Only the way for the framework to start it when you have that autoStartup = true.

I admit that it may break some peculiar test, but at the same time the test is wrong because it has been relied on bug which we are fixing here.

On the other hand I don't worry too much about breaking changes for tests. That's not that part of project which may make your customer unhappy.

lifecycle.start();
}
});

this.beans.clear();
if (!ObjectUtils.isEmpty(beanNames)) {
for (String name : beanNames) {
this.beans.remove(name);
}
}
else {
this.beans.clear();
}
}

/**
Expand Down
80 changes: 59 additions & 21 deletions ...test/src/test/java/org/springframework/integration/test/mock/MockMessageHandlerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2017-2019 the original author or authors.
* Copyright 2017-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -17,23 +17,26 @@
package org.springframework.integration.test.mock;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
import static org.assertj.core.api.Assertions.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.springframework.integration.test.mock.MockIntegration.mockMessageHandler;

import java.util.List;
import java.util.Map;

import org.junit.After;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;
import org.reactivestreams.Subscriber;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.integration.annotation.EndpointId;
import org.springframework.integration.annotation.Poller;
import org.springframework.integration.annotation.ServiceActivator;
import org.springframework.integration.channel.DirectChannel;
Expand All @@ -42,6 +45,7 @@
import org.springframework.integration.endpoint.ReactiveStreamsConsumer;
import org.springframework.integration.expression.ValueExpression;
import org.springframework.integration.handler.ExpressionEvaluatingMessageHandler;
import org.springframework.integration.handler.LoggingHandler;
import org.springframework.integration.support.MessageBuilder;
import org.springframework.integration.test.context.MockIntegrationContext;
import org.springframework.integration.test.context.SpringIntegrationTest;
Expand All @@ -56,15 +60,15 @@
import org.springframework.messaging.support.GenericMessage;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;

/**
* @author Artem Bilan
* @author Yicheng Feng
*
* @since 5.0
*/
@RunWith(SpringRunner.class)
@SpringJUnitConfig
@ContextConfiguration(classes = MockMessageHandlerTests.Config.class)
@SpringIntegrationTest
@DirtiesContext
Expand Down Expand Up @@ -97,10 +101,10 @@ public class MockMessageHandlerTests {
@Autowired
private ArgumentCaptor<Message<?>> messageArgumentCaptor;

@After
@AfterEach
public void tearDown() {
this.mockIntegrationContext.resetBeans();
results.purge(null);
this.results.purge(null);
}

@Test
Expand Down Expand Up @@ -181,8 +185,7 @@ public void testMockRawHandler() {
ArgumentCaptor<Message<?>> messageArgumentCaptor = MockIntegration.messageArgumentCaptor();
MessageHandler mockMessageHandler =
spy(mockMessageHandler(messageArgumentCaptor))
.handleNext(m -> {
});
.handleNext(m -> { });

String endpointId = "rawHandlerConsumer";
this.mockIntegrationContext.substituteMessageHandlerFor(endpointId, mockMessageHandler);
Expand All @@ -201,25 +204,22 @@ public void testMockRawHandler() {

this.mockIntegrationContext.resetBeans(endpointId);

mockMessageHandler =
MessageHandler mockMessageHandler2 =
mockMessageHandler()
.handleNextAndReply(m -> m);

try {
this.mockIntegrationContext.substituteMessageHandlerFor(endpointId, mockMessageHandler);
fail("IllegalStateException expected");
}
catch (Exception e) {
assertThat(e).isInstanceOf(IllegalStateException.class);
assertThat(e.getMessage()).contains("with replies can't replace simple MessageHandler");
}

assertThatIllegalStateException()
.isThrownBy(() ->
this.mockIntegrationContext.substituteMessageHandlerFor(endpointId, mockMessageHandler2))
.withMessageContaining("with replies can't replace simple MessageHandler");

this.mockIntegrationContext.resetBeans();

assertThat(TestUtils.getPropertyValue(endpoint, "handler", MessageHandler.class))
.isNotSameAs(mockMessageHandler);
.isNotSameAs(mockMessageHandler2);
assertThat(TestUtils.getPropertyValue(endpoint, "subscriber", Subscriber.class))
.isNotSameAs(mockMessageHandler);
.isNotSameAs(mockMessageHandler2);
}

/**
Expand All @@ -238,6 +238,37 @@ public void testHandlerSubstitutionWithOutputChannel() {
assertThat(list.size()).isEqualTo(2);
}

@Autowired
private MessageChannel logChannel;

@Test
@SuppressWarnings("unchecked")
public void testMockIntegrationContextReset() {
MockMessageHandler mockMessageHandler = mockMessageHandler();
mockMessageHandler.handleNext(message -> { });

this.mockIntegrationContext.substituteMessageHandlerFor("logEndpoint", mockMessageHandler);

String endpointId = "mockMessageHandlerTests.Config.myService.serviceActivator";
this.mockIntegrationContext.substituteMessageHandlerFor(endpointId, mockMessageHandler);

this.logChannel.send(new GenericMessage<>(1));

this.mockIntegrationContext.resetBeans("logEndpoint");

this.logChannel.send(new GenericMessage<>(2));

verify(mockMessageHandler).handleMessage(any(Message.class));

assertThat(TestUtils.getPropertyValue(this.mockIntegrationContext, "beans", Map.class)).hasSize(1);

assertThat(
TestUtils.getPropertyValue(
this.context.getBean("mockMessageHandlerTests.Config.myService.serviceActivator"), "handler"))
.isSameAs(mockMessageHandler);
}


@Configuration
@EnableIntegration
public static class Config {
Expand Down Expand Up @@ -301,6 +332,13 @@ public MessageHandler handleNextInput() {
});
}

@Bean
@EndpointId("logEndpoint")
@ServiceActivator(inputChannel = "logChannel")
public MessageHandler logHandler() {
return new LoggingHandler(LoggingHandler.Level.FATAL);
}

}

}