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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
# frozen_string_literal: true
RSpec::Matchers.define_negated_matcher :be_nullable, :be_non_null
RSpec::Matchers.define :require_graphql_authorizations do |*expected|
def permissions_for(klass)
if klass.respond_to?(:required_permissions)
klass.required_permissions
else
Array.wrap(klass.authorize)
end
end
match do |klass|
actual = permissions_for(klass)
expect(actual).to match_array(expected.compact)
end
failure_message do |klass|
actual = permissions_for(klass)
missing = actual - expected
extra = expected - actual
message = []
message << "is missing permissions: #{missing.inspect}" if missing.any?
message << "contained unexpected permissions: #{extra.inspect}" if extra.any?
message.join("\n")
end
end
RSpec::Matchers.define :have_graphql_fields do |*expected|
def expected_field_names
Array.wrap(expected).map { |name| GraphqlHelpers.fieldnamerize(name) }
end
@allow_extra = false
chain :only do
@allow_extra = false
end
chain :at_least do
@allow_extra = true
end
match do |kls|
keys = kls.fields.keys.to_set
fields = expected_field_names.to_set
next true if fields == keys
next true if @allow_extra && fields.proper_subset?(keys)
false
end
failure_message do |kls|
missing = expected_field_names - kls.fields.keys
extra = kls.fields.keys - expected_field_names
message = []
message << "is missing fields: <#{missing.inspect}>" if missing.any?
message << "contained unexpected fields: <#{extra.inspect}>" if extra.any? && !@allow_extra
message.join("\n")
end
end
RSpec::Matchers.define :include_graphql_fields do |*expected|
expected_field_names = expected.map { |name| GraphqlHelpers.fieldnamerize(name) }
match do |kls|
expect(kls.fields.keys).to include(*expected_field_names)
end
failure_message do |kls|
missing = expected_field_names - kls.fields.keys
"is missing fields: <#{missing.inspect}>" if missing.any?
end
end
RSpec::Matchers.define :have_graphql_field do |field_name, args = {}|
match do |kls|
field = kls.fields[GraphqlHelpers.fieldnamerize(field_name)]
expect(field).to be_present
args.each do |argument, value|
expect(field.send(argument)).to eq(value)
end
end
end
RSpec::Matchers.define :have_graphql_mutation do |mutation_class|
match do |mutation_type|
field = mutation_type.fields[GraphqlHelpers.fieldnamerize(mutation_class.graphql_name)]
expect(field).to be_present
expect(field.resolver).to eq(mutation_class)
end
end
# note: connection arguments do not have to be named, they will be inferred.
RSpec::Matchers.define :have_graphql_arguments do |*expected|
include GraphqlHelpers
def expected_names(field)
@names ||= Array.wrap(expected).map { |name| GraphqlHelpers.fieldnamerize(name) }
if field.type.try(:ancestors)&.include?(GraphQL::Types::Relay::BaseConnection)
@names | %w[after before first last]
else
@names
end
end
match do |field|
names = expected_names(field)
expect(field.arguments.keys).to contain_exactly(*names)
end
failure_message do |field|
names = expected_names(field).inspect
args = field.arguments.keys.inspect
"expected #{field.name} to have the following arguments: #{names}, but it has #{args}."
end
end
module GraphQLTypeHelpers
def message(object, expected, **opts)
non_null = expected.non_null? || (opts.key?(:null) && !opts[:null])
actual = object.type
actual_type = actual.unwrap.graphql_name
actual_type += '!' if actual.non_null?
expected_type = expected.unwrap.graphql_name
expected_type += '!' if non_null
"expected #{describe_object(object)} to have GraphQL type #{expected_type}, but got #{actual_type}"
end
def describe_object(object)
case object
when Types::BaseField
"#{describe_object(object.owner_type)}.#{object.graphql_name}"
when Types::BaseArgument
"#{describe_object(object.owner)}.#{object.graphql_name}"
when Class
object.try(:graphql_name) || object.name
else
object.to_s
end
end
def nullified(type, can_be_nil)
return type if can_be_nil.nil? # unknown!
return type if can_be_nil
type.to_non_null_type
end
end
RSpec::Matchers.define :have_graphql_type do |expected, opts = {}|
include GraphQLTypeHelpers
match do |object|
if object.type.list?
expect(object.type.unwrap).to eq(nullified(expected, opts[:null]))
else
expect(object.type).to eq(nullified(expected, opts[:null]))
end
end
failure_message do |object|
message(object, expected, **opts)
end
end
RSpec::Matchers.define :have_nullable_graphql_type do |expected|
include GraphQLTypeHelpers
match do |object|
expect(object).to have_graphql_type(expected.unwrap, { null: true })
end
description do
"have nullable GraphQL type #{expected.graphql_name}"
end
failure_message do |object|
message(object, expected, null: true)
end
end
RSpec::Matchers.define :have_non_null_graphql_type do |expected|
include GraphQLTypeHelpers
match do |object|
expect(object).to have_graphql_type(expected, { null: false })
end
description do
"have non-null GraphQL type #{expected.graphql_name}"
end
failure_message do |object|
message(object, expected, null: false)
end
end
RSpec::Matchers.define :have_graphql_resolver do |expected|
match do |field|
expect(field.resolver).to eq(expected)
end
end
RSpec::Matchers.define :have_graphql_extension do |expected|
match do |field|
expect(field.extensions).to include(expected)
end
end
RSpec::Matchers.define :expose_permissions_using do |expected|
match do |type|
permission_field = type.fields['userPermissions']
expect(permission_field).not_to be_nil
expect(permission_field.type).to be_non_null
expect(permission_field.type.of_type.graphql_name).to eq(expected.graphql_name)
end
end
RSpec::Matchers.define :have_graphql_name do |expected|
def graphql_name(object)
object.graphql_name if object.respond_to?(:graphql_name)
end
match do |object|
name = graphql_name(object)
begin
if expected.present?
expect(name).to eq(expected)
else
expect(expected).to be_present
end
rescue RSpec::Expectations::ExpectationNotMetError => error
@error = error
raise
end
end
failure_message do |object|
if expected.present?
@error
else
'Expected graphql_name value cannot be blank'
end
end
end
RSpec::Matchers.define :have_graphql_description do |expected|
def graphql_description(object)
object.description if object.respond_to?(:description)
end
match do |object|
description = graphql_description(object)
begin
if expected.present?
expect(description).to eq(expected)
else
expect(description).to be_present
end
rescue RSpec::Expectations::ExpectationNotMetError => error
@error = error
raise
end
end
failure_message do |object|
if expected.present?
@error
else
"have_graphql_description expected value cannot be blank"
end
end
end
|