/
DgsRestControllerTest.kt
228 lines (198 loc) · 7.93 KB
/
DgsRestControllerTest.kt
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
/*
* Copyright 2021 Netflix, Inc.
*
* 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
*
* http://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 com.netflix.graphql.dgs.mvc
import com.fasterxml.jackson.annotation.JsonIgnoreProperties
import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
import com.netflix.graphql.dgs.DgsQueryExecutor
import graphql.ExecutionResultImpl
import graphql.execution.reactive.SubscriptionPublisher
import io.mockk.every
import io.mockk.impl.annotations.MockK
import io.mockk.junit5.MockKExtension
import io.mockk.slot
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import org.springframework.http.HttpHeaders
import org.springframework.http.HttpStatus
import org.springframework.http.MediaType
import org.springframework.http.ResponseEntity
import org.springframework.web.context.request.WebRequest
@ExtendWith(MockKExtension::class)
class DgsRestControllerTest {
private val httpHeaders = HttpHeaders().apply {
contentType = MediaType.APPLICATION_JSON
}
@MockK
lateinit var dgsQueryExecutor: DgsQueryExecutor
@MockK
lateinit var webRequest: WebRequest
@Test
fun `Is able to execute a a well formed query`() {
val queryString = "query { hello }"
val requestBody = """
{
"query": "$queryString"
}
""".trimIndent()
every {
dgsQueryExecutor.execute(
queryString,
emptyMap(),
any(),
any(),
any(),
any()
)
} returns ExecutionResultImpl.newExecutionResult().data(mapOf(Pair("hello", "hello"))).build()
val result = DgsRestController(dgsQueryExecutor).graphql(requestBody.toByteArray(), null, null, null, httpHeaders, webRequest)
assertThat(result.body).isInstanceOfSatisfying(ByteArray::class.java) { body ->
val mapper = jacksonObjectMapper()
val (data, errors) = mapper.readValue(body, GraphQLResponse::class.java)
assertThat(errors.size).isEqualTo(0)
assertThat(data["hello"]).isEqualTo("hello")
}
}
@Test
fun `Passing a query with an operationName should execute the matching named query`() {
val queryString = "query operationA{ hello } query operationB{ hi }"
val requestBody = """
{
"query": "$queryString",
"operationName": "operationB"
}
""".trimIndent()
val capturedOperationName = slot<String>()
every {
dgsQueryExecutor.execute(
queryString,
emptyMap(),
any(),
any(),
capture(capturedOperationName),
any()
)
} returns ExecutionResultImpl.newExecutionResult().data(mapOf(Pair("hi", "there"))).build()
val result = DgsRestController(dgsQueryExecutor).graphql(requestBody.toByteArray(), null, null, null, httpHeaders, webRequest)
assertThat(result.body).isInstanceOfSatisfying(ByteArray::class.java) { body ->
val mapper = jacksonObjectMapper()
val (data, errors) = mapper.readValue(body, GraphQLResponse::class.java)
assertThat(errors.size).isEqualTo(0)
assertThat(data["hi"]).isEqualTo("there")
assertThat(capturedOperationName.captured).isEqualTo("operationB")
}
}
@Test
fun `Content-type application graphql should be handled correctly`() {
val requestBody = """
{
hello
}
""".trimIndent()
every {
dgsQueryExecutor.execute(
requestBody,
emptyMap(),
any(),
any(),
any(),
any()
)
} returns ExecutionResultImpl.newExecutionResult().data(mapOf(Pair("hello", "hello"))).build()
val headers = HttpHeaders()
headers.contentType = MediaType("application", "graphql")
val result = DgsRestController(dgsQueryExecutor).graphql(requestBody.toByteArray(), null, null, null, headers, webRequest)
assertThat(result.body).isInstanceOfSatisfying(ByteArray::class.java) { body ->
val mapper = jacksonObjectMapper()
val (data, errors) = mapper.readValue(body, GraphQLResponse::class.java)
assertThat(errors.size).isEqualTo(0)
assertThat(data["hello"]).isEqualTo("hello")
}
}
@Test
fun `Return an error when a Subscription is attempted on the Graphql Endpoint`() {
val queryString = "subscription { stocks { name } }"
val requestBody = """
{
"query": "$queryString"
}
""".trimIndent()
every {
dgsQueryExecutor.execute(
queryString,
emptyMap(),
any(),
any(),
any(),
any()
)
} returns ExecutionResultImpl.newExecutionResult()
.data(SubscriptionPublisher(null, null)).build()
val result =
DgsRestController(dgsQueryExecutor).graphql(requestBody.toByteArray(), null, null, null, httpHeaders, webRequest)
assertThat(result.statusCode).isEqualTo(HttpStatus.BAD_REQUEST)
assertThat(result.body).isEqualTo("Trying to execute subscription on /graphql. Use /subscriptions instead!")
}
@Test
fun `Returns a request error if the no body is present`() {
val requestBody = ""
val result =
DgsRestController(dgsQueryExecutor)
.graphql(requestBody.toByteArray(), null, null, null, httpHeaders, webRequest)
assertThat(result)
.isInstanceOf(ResponseEntity::class.java)
.extracting { it.statusCode }
.isEqualTo(HttpStatus.BAD_REQUEST)
}
@Test
fun `Writes response headers when dgs-response-headers are set in extensions object`() {
val queryString = "query { hello }"
val requestBody = """
{
"query": "$queryString"
}
""".trimIndent()
every {
dgsQueryExecutor.execute(
queryString,
emptyMap(),
any(),
any(),
any(),
any()
)
} returns ExecutionResultImpl.newExecutionResult()
.data(mapOf("hello" to "hello"))
.extensions(mutableMapOf(DgsRestController.DGS_RESPONSE_HEADERS_KEY to mapOf("myHeader" to "hello")) as Map<Any, Any>?)
.build()
val result = DgsRestController(dgsQueryExecutor).graphql(requestBody.toByteArray(), null, null, null, httpHeaders, webRequest)
assertThat(result.headers["myHeader"]).contains("hello")
assertThat(result.body).isInstanceOfSatisfying(ByteArray::class.java) { body ->
val mapper = jacksonObjectMapper()
val (_, _, extensions) = mapper.readValue(body, GraphQLResponse::class.java)
assertThat(extensions).isNull()
}
}
data class GraphQLResponse(
val data: Map<String, Any> = emptyMap(),
val errors: List<GraphQLError> = emptyList(),
// should not be on the response; only here so we can
// test that it does not exist.
val extensions: Map<String, Any>?
)
@JsonIgnoreProperties(ignoreUnknown = true)
data class GraphQLError(val message: String)
}