/
GraphQlObservationAutoConfigurationTests.java
148 lines (119 loc) · 5.24 KB
/
GraphQlObservationAutoConfigurationTests.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
* Copyright 2012-2022 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.actuate.autoconfigure.observation.graphql;
import io.micrometer.observation.ObservationRegistry;
import io.micrometer.observation.tck.TestObservationRegistry;
import io.micrometer.tracing.propagation.Propagator;
import org.junit.jupiter.api.Test;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.graphql.observation.DefaultDataFetcherObservationConvention;
import org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention;
import org.springframework.graphql.observation.GraphQlObservationInstrumentation;
import org.springframework.graphql.observation.PropagationWebGraphQlInterceptor;
import org.springframework.graphql.server.WebGraphQlHandler;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link GraphQlObservationAutoConfiguration}.
*
* @author Brian Clozel
*/
class GraphQlObservationAutoConfigurationTests {
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withBean(TestObservationRegistry.class, TestObservationRegistry::create)
.withConfiguration(AutoConfigurations.of(GraphQlObservationAutoConfiguration.class));
@Test
void backsOffWhenObservationRegistryIsMissing() {
new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(GraphQlObservationAutoConfiguration.class))
.run((context) -> assertThat(context).doesNotHaveBean(GraphQlObservationInstrumentation.class));
}
@Test
void definesInstrumentationWhenObservationRegistryIsPresent() {
this.contextRunner.run((context) -> assertThat(context).hasSingleBean(GraphQlObservationInstrumentation.class));
}
@Test
void instrumentationBacksOffIfAlreadyPresent() {
this.contextRunner.withUserConfiguration(InstrumentationConfiguration.class)
.run((context) -> assertThat(context).hasSingleBean(GraphQlObservationInstrumentation.class)
.hasBean("customInstrumentation"));
}
@Test
void instrumentationUsesCustomConventionsIfAvailable() {
this.contextRunner.withUserConfiguration(CustomConventionsConfiguration.class).run((context) -> {
GraphQlObservationInstrumentation instrumentation = context
.getBean(GraphQlObservationInstrumentation.class);
assertThat(instrumentation).extracting("requestObservationConvention")
.isInstanceOf(CustomExecutionRequestObservationConvention.class);
assertThat(instrumentation).extracting("dataFetcherObservationConvention")
.isInstanceOf(CustomDataFetcherObservationConvention.class);
});
}
@Test
void propagationInterceptorNotContributedWhenPropagatorIsMissing() {
this.contextRunner.withUserConfiguration(WebGraphQlConfiguration.class)
.run((context) -> assertThat(context).doesNotHaveBean(PropagationWebGraphQlInterceptor.class));
}
@Test
void propagationInterceptorNotContributedWhenNotWebApplication() {
this.contextRunner.withUserConfiguration(TracingConfiguration.class)
.run((context) -> assertThat(context).doesNotHaveBean(PropagationWebGraphQlInterceptor.class));
}
@Test
void propagationInterceptorContributed() {
this.contextRunner.withUserConfiguration(WebGraphQlConfiguration.class, TracingConfiguration.class)
.run((context) -> assertThat(context).hasSingleBean(PropagationWebGraphQlInterceptor.class));
}
@Configuration(proxyBeanMethods = false)
static class InstrumentationConfiguration {
@Bean
GraphQlObservationInstrumentation customInstrumentation(ObservationRegistry registry) {
return new GraphQlObservationInstrumentation(registry);
}
}
@Configuration(proxyBeanMethods = false)
static class CustomConventionsConfiguration {
@Bean
CustomExecutionRequestObservationConvention customExecutionConvention() {
return new CustomExecutionRequestObservationConvention();
}
@Bean
CustomDataFetcherObservationConvention customDataFetcherConvention() {
return new CustomDataFetcherObservationConvention();
}
}
static class CustomExecutionRequestObservationConvention extends DefaultExecutionRequestObservationConvention {
}
static class CustomDataFetcherObservationConvention extends DefaultDataFetcherObservationConvention {
}
@Configuration(proxyBeanMethods = false)
static class WebGraphQlConfiguration {
@Bean
WebGraphQlHandler webGraphQlHandler() {
return mock(WebGraphQlHandler.class);
}
}
@Configuration(proxyBeanMethods = false)
static class TracingConfiguration {
@Bean
Propagator propagator() {
return mock(Propagator.class);
}
}
}