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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
|
# frozen_string_literal: true
require "cases/helper"
require "models/post"
require "models/comment"
class UnsafeRawSqlTest < ActiveRecord::TestCase
fixtures :posts, :comments
test "order: allows string column name" do
ids_expected = Post.order(Arel.sql("title")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order("title").pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order("title").pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: allows symbol column name" do
ids_expected = Post.order(Arel.sql("title")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order(:title).pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order(:title).pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: allows downcase symbol direction" do
ids_expected = Post.order(Arel.sql("title") => Arel.sql("asc")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order(title: :asc).pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order(title: :asc).pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: allows upcase symbol direction" do
ids_expected = Post.order(Arel.sql("title") => Arel.sql("ASC")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order(title: :ASC).pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order(title: :ASC).pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: allows string direction" do
ids_expected = Post.order(Arel.sql("title") => Arel.sql("asc")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order(title: "asc").pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order(title: "asc").pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: allows multiple columns" do
ids_expected = Post.order(Arel.sql("author_id"), Arel.sql("title")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order(:author_id, :title).pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order(:author_id, :title).pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: allows mixed" do
ids_expected = Post.order(Arel.sql("author_id"), Arel.sql("title") => Arel.sql("asc")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order(:author_id, title: :asc).pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order(:author_id, title: :asc).pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: allows table and column name" do
ids_expected = Post.order(Arel.sql("title")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order("posts.title").pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order("posts.title").pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: allows column name and direction in string" do
ids_expected = Post.order(Arel.sql("title desc")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order("title desc").pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order("title desc").pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: allows table name, column name and direction in string" do
ids_expected = Post.order(Arel.sql("title desc")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order("posts.title desc").pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order("posts.title desc").pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: allows NULLS FIRST and NULLS LAST too" do
raise "precondition failed" if Post.count < 2
# Ensure there are NULL and non-NULL post types.
Post.first.update_column(:type, nil)
Post.last.update_column(:type, "Programming")
["asc", "desc", ""].each do |direction|
%w(first last).each do |position|
ids_expected = Post.order(Arel.sql("type #{direction} nulls #{position}")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order("type #{direction} nulls #{position}").pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order("type #{direction} nulls #{position}").pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
end
end if current_adapter?(:PostgreSQLAdapter)
test "order: disallows invalid column name" do
with_unsafe_raw_sql_disabled do
assert_raises(ActiveRecord::UnknownAttributeReference) do
Post.order("len(title) asc").pluck(:id)
end
end
end
test "order: disallows invalid direction" do
with_unsafe_raw_sql_disabled do
assert_raises(ArgumentError) do
Post.order(title: :foo).pluck(:id)
end
end
end
test "order: disallows invalid column with direction" do
with_unsafe_raw_sql_disabled do
assert_raises(ActiveRecord::UnknownAttributeReference) do
Post.order("len(title)" => :asc).pluck(:id)
end
end
end
test "order: always allows Arel" do
ids_depr = with_unsafe_raw_sql_deprecated { Post.order(Arel.sql("length(title)")).pluck(:title) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order(Arel.sql("length(title)")).pluck(:title) }
assert_equal ids_depr, ids_disabled
end
test "order: allows Arel.sql with binds" do
ids_expected = Post.order(Arel.sql("REPLACE(title, 'misc', 'zzzz'), id")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order([Arel.sql("REPLACE(title, ?, ?), id"), "misc", "zzzz"]).pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order([Arel.sql("REPLACE(title, ?, ?), id"), "misc", "zzzz"]).pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: disallows invalid bind statement" do
with_unsafe_raw_sql_disabled do
assert_raises(ActiveRecord::UnknownAttributeReference) do
Post.order(["REPLACE(title, ?, ?), id", "misc", "zzzz"]).pluck(:id)
end
end
end
test "order: disallows invalid Array arguments" do
with_unsafe_raw_sql_disabled do
assert_raises(ActiveRecord::UnknownAttributeReference) do
Post.order(["author_id", "length(title)"]).pluck(:id)
end
end
end
test "order: allows valid Array arguments" do
ids_expected = Post.order(Arel.sql("author_id, length(title)")).pluck(:id)
ids_depr = with_unsafe_raw_sql_deprecated { Post.order(["author_id", Arel.sql("length(title)")]).pluck(:id) }
ids_disabled = with_unsafe_raw_sql_disabled { Post.order(["author_id", Arel.sql("length(title)")]).pluck(:id) }
assert_equal ids_expected, ids_depr
assert_equal ids_expected, ids_disabled
end
test "order: logs deprecation warning for unrecognized column" do
with_unsafe_raw_sql_deprecated do
assert_deprecated(/Dangerous query method/) do
Post.order("length(title)")
end
end
end
test "pluck: allows string column name" do
titles_expected = Post.pluck(Arel.sql("title"))
titles_depr = with_unsafe_raw_sql_deprecated { Post.pluck("title") }
titles_disabled = with_unsafe_raw_sql_disabled { Post.pluck("title") }
assert_equal titles_expected, titles_depr
assert_equal titles_expected, titles_disabled
end
test "pluck: allows symbol column name" do
titles_expected = Post.pluck(Arel.sql("title"))
titles_depr = with_unsafe_raw_sql_deprecated { Post.pluck(:title) }
titles_disabled = with_unsafe_raw_sql_disabled { Post.pluck(:title) }
assert_equal titles_expected, titles_depr
assert_equal titles_expected, titles_disabled
end
test "pluck: allows multiple column names" do
values_expected = Post.pluck(Arel.sql("title"), Arel.sql("id"))
values_depr = with_unsafe_raw_sql_deprecated { Post.pluck(:title, :id) }
values_disabled = with_unsafe_raw_sql_disabled { Post.pluck(:title, :id) }
assert_equal values_expected, values_depr
assert_equal values_expected, values_disabled
end
test "pluck: allows column names with includes" do
values_expected = Post.includes(:comments).pluck(Arel.sql("title"), Arel.sql("id"))
values_depr = with_unsafe_raw_sql_deprecated { Post.includes(:comments).pluck(:title, :id) }
values_disabled = with_unsafe_raw_sql_disabled { Post.includes(:comments).pluck(:title, :id) }
assert_equal values_expected, values_depr
assert_equal values_expected, values_disabled
end
test "pluck: allows auto-generated attributes" do
values_expected = Post.pluck(Arel.sql("tags_count"))
values_depr = with_unsafe_raw_sql_deprecated { Post.pluck(:tags_count) }
values_disabled = with_unsafe_raw_sql_disabled { Post.pluck(:tags_count) }
assert_equal values_expected, values_depr
assert_equal values_expected, values_disabled
end
test "pluck: allows table and column names" do
titles_expected = Post.pluck(Arel.sql("title"))
titles_depr = with_unsafe_raw_sql_deprecated { Post.pluck("posts.title") }
titles_disabled = with_unsafe_raw_sql_disabled { Post.pluck("posts.title") }
assert_equal titles_expected, titles_depr
assert_equal titles_expected, titles_disabled
end
test "pluck: disallows invalid column name" do
with_unsafe_raw_sql_disabled do
assert_raises(ActiveRecord::UnknownAttributeReference) do
Post.pluck("length(title)")
end
end
end
test "pluck: disallows invalid column name amongst valid names" do
with_unsafe_raw_sql_disabled do
assert_raises(ActiveRecord::UnknownAttributeReference) do
Post.pluck(:title, "length(title)")
end
end
end
test "pluck: disallows invalid column names with includes" do
with_unsafe_raw_sql_disabled do
assert_raises(ActiveRecord::UnknownAttributeReference) do
Post.includes(:comments).pluck(:title, "length(title)")
end
end
end
test "pluck: always allows Arel" do
values_depr = with_unsafe_raw_sql_deprecated { Post.includes(:comments).pluck(:title, Arel.sql("length(title)")) }
values_disabled = with_unsafe_raw_sql_disabled { Post.includes(:comments).pluck(:title, Arel.sql("length(title)")) }
assert_equal values_depr, values_disabled
end
test "pluck: logs deprecation warning" do
with_unsafe_raw_sql_deprecated do
assert_deprecated(/Dangerous query method/) do
Post.includes(:comments).pluck(:title, "length(title)")
end
end
end
def with_unsafe_raw_sql_disabled(&blk)
with_config(:disabled, &blk)
end
def with_unsafe_raw_sql_deprecated(&blk)
with_config(:deprecated, &blk)
end
def with_config(new_value, &blk)
old_value = ActiveRecord::Base.allow_unsafe_raw_sql
ActiveRecord::Base.allow_unsafe_raw_sql = new_value
blk.call
ensure
ActiveRecord::Base.allow_unsafe_raw_sql = old_value
end
end
|
