Skip to content

Commit fdd47e5

Browse files
mcohen75geoand
mcohen75
authored and
geoand
committed
Create a TracingMongoClient bean only when one already exists or is created by MongoAutoConfiguration (#242)
1 parent 31b6b0e commit fdd47e5

File tree

4 files changed

+184
-46
lines changed

4 files changed

+184
-46
lines changed

‎instrument-starters/opentracing-spring-cloud-mongo-starter/src/main/java/io/opentracing/contrib/spring/cloud/mongo/MongoTracingAutoConfiguration.java‎

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,49 +14,32 @@
1414
package io.opentracing.contrib.spring.cloud.mongo;
1515

1616
import com.mongodb.MongoClient;
17-
import com.mongodb.MongoClientOptions;
1817
import io.opentracing.Tracer;
19-
import io.opentracing.contrib.mongo.TracingMongoClient;
20-
import io.opentracing.contrib.mongo.common.TracingCommandListener;
21-
import io.opentracing.contrib.mongo.common.TracingCommandListener.Builder;
22-
import io.opentracing.contrib.mongo.common.providers.PrefixSpanNameProvider;
2318
import io.opentracing.contrib.spring.tracer.configuration.TracerAutoConfiguration;
24-
import org.springframework.beans.factory.ObjectProvider;
25-
import org.springframework.beans.factory.annotation.Autowired;
2619
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
27-
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
2820
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
29-
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
3021
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
3122
import org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration;
32-
import org.springframework.boot.autoconfigure.mongo.MongoProperties;
23+
import org.springframework.context.annotation.Bean;
3324
import org.springframework.context.annotation.Configuration;
34-
import org.springframework.core.env.Environment;
3525

3626
/**
3727
* @author Vivien Maleze
3828
*/
3929
@Configuration
40-
@AutoConfigureBefore(MongoAutoConfiguration.class)
41-
@ConditionalOnClass(MongoClient.class)
42-
@ConditionalOnBean(Tracer.class)
43-
@AutoConfigureAfter(TracerAutoConfiguration.class)
30+
@AutoConfigureAfter({ TracerAutoConfiguration.class, MongoAutoConfiguration.class })
31+
@ConditionalOnBean({ Tracer.class, MongoClient.class })
4432
@ConditionalOnProperty(name = "opentracing.spring.cloud.mongo.enabled", havingValue = "true", matchIfMissing = true)
45-
public class MongoTracingAutoConfiguration extends MongoAutoConfiguration {
33+
public class MongoTracingAutoConfiguration {
4634

47-
private Tracer tracer;
35+
private final Tracer tracer;
4836

49-
public MongoTracingAutoConfiguration(@Autowired(required = false) MongoProperties properties,
50-
ObjectProvider<MongoClientOptions> options, Environment environment, Tracer tracer) {
51-
super(properties, options, environment);
37+
public MongoTracingAutoConfiguration(final Tracer tracer) {
5238
this.tracer = tracer;
5339
}
5440

55-
@Override
56-
public MongoClient mongo() {
57-
MongoClient mongo = super.mongo();
58-
TracingCommandListener commandListener = new Builder(tracer)
59-
.build();
60-
return new TracingMongoClient(commandListener, mongo.getAllAddress(), mongo.getCredentialsList(), mongo.getMongoClientOptions());
41+
@Bean
42+
TracingMongoClientPostProcessor tracingMongoClientPostProcessor() {
43+
return new TracingMongoClientPostProcessor(tracer);
6144
}
6245
}

‎instrument-starters/opentracing-spring-cloud-mongo-starter/src/main/java/io/opentracing/contrib/spring/cloud/mongo/TracingMongoClientPostProcessor.java‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
/**
2+
* Copyright 2017-2019 The OpenTracing Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5+
* in compliance with the License. You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software distributed under the License
10+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11+
* or implied. See the License for the specific language governing permissions and limitations under
12+
* the License.
13+
*/
14+
package io.opentracing.contrib.spring.cloud.mongo;
15+
16+
import com.mongodb.MongoClient;
17+
import io.opentracing.Tracer;
18+
import io.opentracing.contrib.mongo.TracingMongoClient;
19+
import io.opentracing.contrib.mongo.common.TracingCommandListener;
20+
import org.springframework.beans.BeansException;
21+
import org.springframework.beans.factory.config.BeanPostProcessor;
22+
23+
class TracingMongoClientPostProcessor implements BeanPostProcessor {
24+
25+
private final Tracer tracer;
26+
27+
TracingMongoClientPostProcessor(Tracer tracer) {
28+
this.tracer = tracer;
29+
}
30+
31+
@Override
32+
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
33+
34+
if (bean instanceof MongoClient && !(bean instanceof TracingMongoClient)) {
35+
final MongoClient client = (MongoClient) bean;
36+
37+
final TracingCommandListener commandListener = new TracingCommandListener.Builder(tracer)
38+
.build();
39+
40+
return new TracingMongoClient(commandListener, client.getAllAddress(), client.getCredentialsList(), client.getMongoClientOptions());
41+
}
42+
43+
return bean;
44+
}
45+
}

‎instrument-starters/opentracing-spring-cloud-mongo-starter/src/test/java/io/opentracing/contrib/spring/cloud/mongo/MongoTracingAutoConfigurationTest.java‎

Lines changed: 61 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2017-2018 The OpenTracing Authors
2+
* Copyright 2017-2019 The OpenTracing Authors
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
55
* in compliance with the License. You may obtain a copy of the License at
@@ -13,16 +13,18 @@
1313
*/
1414
package io.opentracing.contrib.spring.cloud.mongo;
1515

16-
import static org.hamcrest.Matchers.is;
17-
import static org.junit.Assert.assertNotNull;
18-
import static org.junit.Assert.assertThat;
1916
import static org.mockito.Mockito.mock;
2017

2118
import com.mongodb.MongoClient;
19+
import com.mongodb.MongoClientURI;
2220
import io.opentracing.Tracer;
21+
import io.opentracing.contrib.spring.tracer.configuration.TracerAutoConfiguration;
22+
import org.assertj.core.api.Assertions;
2323
import org.junit.Test;
24-
import org.springframework.boot.test.util.TestPropertyValues;
25-
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
24+
import org.springframework.boot.autoconfigure.AutoConfigurations;
25+
import org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration;
26+
import org.springframework.boot.context.annotation.UserConfigurations;
27+
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
2628
import org.springframework.context.annotation.Bean;
2729
import org.springframework.context.annotation.Configuration;
2830

@@ -32,22 +34,52 @@
3234
public class MongoTracingAutoConfigurationTest {
3335

3436
@Test
35-
public void loadMongoTracingByDefault() {
36-
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
37-
context.register(TracerConfig.class, MongoTracingAutoConfiguration.class);
38-
context.refresh();
39-
MongoClient mongoClient = context.getBean(MongoClient.class);
40-
assertNotNull(mongoClient);
37+
public void createsTracingPostProcessor() {
38+
final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
39+
.withConfiguration(UserConfigurations.of(TracerConfig.class, MongoConfig.class))
40+
.withConfiguration(AutoConfigurations.of(MongoTracingAutoConfiguration.class));
41+
42+
contextRunner.run(context -> Assertions.assertThat(context).hasSingleBean(TracingMongoClientPostProcessor.class));
43+
}
44+
45+
@Test
46+
public void doesNotCreateTracingPostProcessorWhenNoTracer() {
47+
final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
48+
.withConfiguration(UserConfigurations.of(MongoConfig.class))
49+
.withConfiguration(AutoConfigurations.of(MongoTracingAutoConfiguration.class));
50+
51+
contextRunner.run(context -> Assertions.assertThat(context).doesNotHaveBean(TracingMongoClientPostProcessor.class));
52+
}
53+
54+
@Test
55+
public void doesNotCreateTracingPostProcessorWhenNoMongoClient() {
56+
final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
57+
.withConfiguration(UserConfigurations.of(TracerConfig.class))
58+
.withConfiguration(AutoConfigurations.of(MongoTracingAutoConfiguration.class));
59+
60+
contextRunner.run(context -> Assertions.assertThat(context).doesNotHaveBean(TracingMongoClientPostProcessor.class));
61+
}
62+
63+
@Test
64+
public void doesNotCreateTracingPostProcessorWhenDisabled() {
65+
final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
66+
.withPropertyValues("opentracing.spring.cloud.mongo.enabled=false")
67+
.withConfiguration(UserConfigurations.of(TracerConfig.class, MongoConfig.class))
68+
.withConfiguration(AutoConfigurations.of(MongoTracingAutoConfiguration.class));
69+
70+
contextRunner.run(context -> Assertions.assertThat(context).doesNotHaveBean(TracingMongoClientPostProcessor.class));
4171
}
4272

4373
@Test
44-
public void disableMongoTracing() {
45-
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
46-
context.register(TracerConfig.class, MongoTracingAutoConfiguration.class);
47-
TestPropertyValues.of("opentracing.spring.cloud.mongo.enabled:false").applyTo(context);
48-
context.refresh();
49-
String[] tracingMongoClientBeans = context.getBeanNamesForType(MongoClient.class);
50-
assertThat(tracingMongoClientBeans.length, is(0));
74+
public void createsTracingPostProcessorWhenAutoConfigured() {
75+
final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
76+
.withConfiguration(AutoConfigurations.of(
77+
MongoTracingAutoConfiguration.class,
78+
TracerAutoConfiguration.class,
79+
MongoAutoConfiguration.class
80+
));
81+
82+
contextRunner.run(context -> Assertions.assertThat(context).hasSingleBean(TracingMongoClientPostProcessor.class));
5183
}
5284

5385
@Configuration
@@ -58,4 +90,13 @@ public Tracer tracer() {
5890
return mock(Tracer.class);
5991
}
6092
}
61-
}
93+
94+
@Configuration
95+
static class MongoConfig {
96+
97+
@Bean
98+
public MongoClient client() {
99+
return new MongoClient(new MongoClientURI("mongodb://localhost/test"));
100+
}
101+
}
102+
}

‎instrument-starters/opentracing-spring-cloud-mongo-starter/src/test/java/io/opentracing/contrib/spring/cloud/mongo/TracingMongoClientPostProcessorTest.java‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/**
2+
* Copyright 2017-2019 The OpenTracing Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5+
* in compliance with the License. You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software distributed under the License
10+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11+
* or implied. See the License for the specific language governing permissions and limitations under
12+
* the License.
13+
*/
14+
package io.opentracing.contrib.spring.cloud.mongo;
15+
16+
import static org.assertj.core.api.Assertions.assertThat;
17+
18+
import com.mongodb.MongoClient;
19+
import com.mongodb.MongoClientOptions;
20+
import com.mongodb.MongoClientURI;
21+
import io.opentracing.Tracer;
22+
import io.opentracing.contrib.mongo.TracingMongoClient;
23+
import org.junit.Before;
24+
import org.junit.Test;
25+
import org.mockito.Mock;
26+
27+
public class TracingMongoClientPostProcessorTest {
28+
29+
@Mock
30+
private Tracer tracer;
31+
32+
@Mock
33+
private TracingMongoClient tracingClient;
34+
35+
private TracingMongoClientPostProcessor processor;
36+
37+
@Before
38+
public void setup() {
39+
processor = new TracingMongoClientPostProcessor(tracer);
40+
}
41+
42+
@Test
43+
public void testNonMongoClientBeansAreReturnedUnaltered() {
44+
45+
final Object expected = new Object();
46+
47+
final Object actual = processor.postProcessAfterInitialization(expected, "any-bean-name");
48+
49+
assertThat(actual).isSameAs(expected);
50+
}
51+
52+
@Test
53+
public void testMongoClientBeansReplacedWithTracingClient() {
54+
55+
final MongoClient client = new MongoClient(new MongoClientURI("mongodb://localhost/test", MongoClientOptions.builder()));
56+
57+
final Object actual = processor.postProcessAfterInitialization(client, "any-bean-name");
58+
59+
assertThat(actual).isInstanceOf(TracingMongoClient.class);
60+
}
61+
62+
@Test
63+
public void testTracingMongoClientBeanNotWrapped() {
64+
65+
final Object actual = processor.postProcessAfterInitialization(tracingClient, "any-bean-name");
66+
67+
assertThat(actual).isSameAs(tracingClient);
68+
}
69+
}

0 commit comments

Comments
 (0)