How to init a default trace context with span in controller when using SpringBootTest

Question

I'm making a move from Spring Boot 1.5.21 to 2.2.5, and in the process also moving from spring-boot-cloud version Edgware.SR6 to Hoxton.SR3. This move forced me to ditch the sleuth's own implementation of tracer/span model and embrace the new model from brave. However, I have an issue with my controller integration tests.

I have a microservice called Edge with a main class called EdgeApplication and I'm using Spock as a testing framework. My code includes the following test class:

@ContextConfiguration(classes = EdgeApplication.class)
@SpringBootTest(classes = EdgeApplication.class)
@ActiveProfiles(profiles = ["test"])
@AutoConfigureMockMvc
class VerificationCodeControllerSpecIT extends Specification {

  @Autowired
  MockMvc mockMvc

  def setup() {
     mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build()
  }

  def "Generate change password verification code"() {
    // Some code calling a PrincipalController via mockMvc.perform()
  }
}

Previously, in Spring Boot 1.5.21, when The call got to the PrincipalController, a default trace context with span was initialized. Now, in Spring Boot 2, this is not the case. I must emphasise that this lack of context in the PrincipalController only happens in test code, and not in a real run of the microservice.

Why this behavior changed and how can I restore the old behavior, i.e. have a default trace context with span when the controller is called?

I added a demo project: Demo You will be able to run the integration test and in debug see that in the controller tracer.currentSpan() is null (while containing a value on normal project run)

score 3 · Accepted Answer · answered Jun 04 '20 at 14:38

3

At Spring Boot 1.5.21 the latest supported version for spring-cloud-sleuth was 1.3.6.RELEASE.

In the old version, Sleuth used to have interceptor: 'TraceHandlerInterceptor' to create a span when the Servlet dispatcher triggers this interceptor.

While running your Spring Boot test at version 1.5.21 the MockMvc init TestDispatcherServlet that triggers the above interceptor.

As part of aligned HTTP instrumentation with Brave, this interceptor was removed.

when using MockMvc it's necessary to explicitly configure your filter Chain. your MockMvc is missing the TracingFilter

answered Jun 04 '20 at 14:38

Tzachi Strugo

88
5

I tried adding the TracingFilter but apparently I had another issue that masked (threw the same exception) the filter issue. Once I fixed the masking issue, I was able to get the tracing context when TracingFilter was added to MockMvc. – Eyal Ringort Jun 05 '20 at 17:28
Explicitly adding the `TracingFilter` to my MockMvc was the missing piece of the puzzle for me. Thanks @Tzachi... You rock! – SourceVisor Apr 20 '21 at 01:25

score 0 · Answer 2 · answered Jun 03 '20 at 12:15

0

If it's related to Spring Security maybe you should use the https://github.com/spring-projects/spring-security/blob/5.3.2.RELEASE/test/src/main/java/org/springframework/security/test/web/servlet/setup/SecurityMockMvcConfigurers.java . Example:

MockMvcBuilders.webAppContextSetup(this.wac)
   .apply(SecurityMockMvcConfigurers.springSecurity())
   .build();

answered Jun 03 '20 at 12:15

Marcin Grzejszczak

10,624
1
16
32

Unfortunately this didn't help, ```tracer.currentSpan()``` still returns null – Eyal Ringort Jun 03 '20 at 13:57
I guess we'll need a sample then to check it out – Marcin Grzejszczak Jun 03 '20 at 15:00
Added demo project to the original question. 10x. – Eyal Ringort Jun 04 '20 at 13:22

How to init a default trace context with span in controller when using SpringBootTest

2 Answers2