File: query_spec.rb

package info (click to toggle)
ruby-mongo 2.21.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 14,764 kB
  • sloc: ruby: 108,806; makefile: 5; sh: 2
file content (347 lines) | stat: -rw-r--r-- 8,412 bytes parent folder | download
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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# frozen_string_literal: true
# rubocop:todo all

require 'lite_spec_helper'
require 'support/shared/protocol'

describe Mongo::Protocol::Query do

  let(:opcode)   { 2004 }
  let(:db)       { SpecConfig.instance.test_db }
  let(:collection_name) { 'protocol-test' }
  let(:ns)       { "#{db}.#{collection_name}" }
  let(:selector) { { :name => 'Tyler' } }
  let(:options)     { Hash.new }

  let(:message) do
    described_class.new(db, collection_name, selector, options)
  end

  describe '#initialize' do

    it 'sets the namespace' do
      expect(message.namespace).to eq(ns)
    end

    it 'sets the selector' do
      expect(message.selector).to eq(selector)
    end

    context 'when options are provided' do

      context 'when flags are provided' do
        let(:options) { { :flags => [:secondary_ok] } }

        it 'sets the flags' do
          expect(message.flags).to eq(options[:flags])
        end
      end

      context 'when a limit is provided' do
        let(:options) { { :limit => 5 } }

        it 'sets the limit' do
          expect(message.limit).to eq(options[:limit])
        end
      end

      context 'when a skip is provided' do
        let(:options) { { :skip => 13 } }

        it 'sets the flags' do
          expect(message.skip).to eq(options[:skip])
        end
      end

      context 'when a projection is provided' do
        let(:options) { { :project => { :_id => 0 } } }

        it 'sets the projection' do
          expect(message.project).to eq(options[:project])
        end
      end
    end
  end

  describe '#==' do

    context 'when the other is a query' do

      context 'when the fields are equal' do
        let(:other) do
          described_class.new(db, collection_name, selector, options)
        end

        it 'returns true' do
          expect(message).to eq(other)
        end
      end

      context 'when the database is not equal' do
        let(:other) do
          described_class.new('tyler', collection_name, selector, options)
        end

        it 'returns false' do
          expect(message).not_to eq(other)
        end
      end

      context 'when the collection is not equal' do
        let(:other) do
          described_class.new(db, 'tyler', selector, options)
        end

        it 'returns false' do
          expect(message).not_to eq(other)
        end
      end

      context 'when the selector is not equal' do
        let(:other) do
          described_class.new(db, collection_name, { :a => 1 }, options)
        end

        it 'returns false' do
          expect(message).not_to eq(other)
        end
      end

      context 'when the options are not equal' do
        let(:other) do
          described_class.new(db, collection_name, selector, :skip => 2)
        end

        it 'returns false' do
          expect(message).not_to eq(other)
        end
      end
    end

    context 'when the other is not a query' do
      let(:other) do
        expect(message).not_to eq('test')
      end
    end
  end

  describe '#hash' do
    let(:values) do
      message.send(:fields).map do |field|
        message.instance_variable_get(field[:name])
      end
    end

    it 'returns a hash of the field values' do
      expect(message.hash).to eq(values.hash)
    end
  end

  describe '#replyable?' do

    it 'returns true' do
      expect(message).to be_replyable
    end
  end

  describe '#serialize' do
    let(:bytes) { message.serialize }

    include_examples 'message with a header'

    describe 'flags' do
      let(:field) { bytes.to_s[16..19] }

      context 'when no flags are provided' do
        it 'does not set any bits' do
          expect(field).to be_int32(0)
        end
      end

      context 'when flags are provided' do
        let(:options) { { :flags => flags } }

        context 'tailable cursor flag' do
          let(:flags) { [:tailable_cursor] }
          it 'sets the second bit' do
            expect(field).to be_int32(2)
          end
        end

        context 'slave ok flag' do
          let(:flags) { [:secondary_ok] }
          it 'sets the third bit' do
            expect(field).to be_int32(4)
          end
        end

        context 'oplog replay flag' do
          let(:flags) { [:oplog_replay] }
          it 'sets the fourth bit' do
            expect(field).to be_int32(8)
          end
        end

        context 'no cursor timeout flag' do
          let(:flags) { [:no_cursor_timeout] }
          it 'sets the fifth bit' do
            expect(field).to be_int32(16)
          end
        end

        context 'await data flag' do
          let(:flags) { [:await_data] }
          it 'sets the sixth bit' do
            expect(field).to be_int32(32)
          end
        end

        context 'exhaust flag' do
          let(:flags) { [:exhaust] }
          it 'sets the seventh bit' do
            expect(field).to be_int32(64)
          end
        end

        context 'partial flag' do
          let(:flags) { [:partial] }
          it 'sets the eigth bit' do
            expect(field).to be_int32(128)
          end
        end

        context 'multiple flags' do
          let(:flags) { [:await_data, :secondary_ok] }
          it 'sets the correct bits' do
            expect(field).to be_int32(36)
          end
        end
      end
    end

    describe 'namespace' do
      let(:field) { bytes.to_s[20..36] }
      it 'serializes the namespace' do
        expect(field).to be_cstring(ns)
      end

      context 'when the namespace contains unicode characters' do
        let(:field) { bytes.to_s[20..40] }

        let(:collection_name) do
          'områder'
        end

        it 'serializes the namespace' do
          expect(field).to be_cstring(ns)
        end

      end
    end

    describe 'skip' do
      let(:field) { bytes.to_s[37..40] }

      context 'when no skip is provided' do
        it 'serializes a zero' do
          expect(field).to be_int32(0)
        end
      end

      context 'when skip is provided' do
        let(:options) { { :skip => 5 } }

        it 'serializes the skip' do
          expect(field).to be_int32(options[:skip])
        end
      end
    end

    describe 'limit' do
      let(:field) { bytes.to_s[41..44] }

      context 'when no limit is provided' do
        it 'serializes a zero' do
          expect(field).to be_int32(0)
        end
      end

      context 'when limit is provided' do
        let(:options) { { :limit => 123 } }
        it 'serializes the limit' do
          expect(field).to be_int32(options[:limit])
        end
      end
    end

    describe 'selector' do
      let(:field) { bytes.to_s[45..65] }
      it 'serializes the selector' do
        expect(field).to be_bson(selector)
      end
    end

    describe 'project' do
      let(:field) { bytes.to_s[66..-1] }
      context 'when no projection is provided' do
        it 'does not serialize a projection' do
          expect(field).to be_empty
        end
      end

      context 'when projection is provided' do
        let(:options) { { :project => projection } }
        let(:projection) { { :_id => 0 } }

        it 'serializes the projection' do
          expect(field).to be_bson(projection)
        end
      end
    end
  end

  describe '#registry' do

    context 'when the class is loaded' do

      it 'registers the op code in the Protocol Registry' do
        expect(Mongo::Protocol::Registry.get(described_class::OP_CODE)).to be(described_class)
      end

      it 'creates an #op_code instance method' do
        expect(message.op_code).to eq(described_class::OP_CODE)
      end
    end
  end

  describe '#compress' do

    context 'when the selector represents a command that can be compressed' do

      let(:selector) do
        { ping: 1 }
      end

      it 'returns a compressed message' do
        expect(message.maybe_compress('zlib')).to be_a(Mongo::Protocol::Compressed)
      end
    end

    context 'when the selector represents a command for which compression is not allowed' do

      Mongo::Monitoring::Event::Secure::REDACTED_COMMANDS.each do |command|

        let(:selector) do
          { command => 1 }
        end

        context "when the command is #{command}" do

          it 'does not allow compression for the command' do
            expect(message.maybe_compress('zlib')).to be(message)
          end
        end
      end
    end
  end
end