File: command_monitoring.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 (346 lines) | stat: -rw-r--r-- 9,155 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
# frozen_string_literal: true
# rubocop:todo all

# Copyright (C) 2014-2020 MongoDB 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.
#

RSpec::Matchers.define :match_command_name do |expectation|

  match do |event|
    expect(event.command_name.to_s).to eq(expectation.command_name.to_s)
  end
end

RSpec::Matchers.define :match_database_name do |expectation|

  match do |event|
    expect(event.database_name.to_s).to eq(expectation.database_name.to_s)
  end
end

RSpec::Matchers.define :generate_request_id do |expectation|

  match do |event|
    expect(event.request_id).to be > 0
  end
end

RSpec::Matchers.define :generate_operation_id do |expectation|

  match do |event|
    expect(event.request_id).to be > 0
  end
end

RSpec::Matchers.define :match_command do |expectation|
  include Mongo::CommandMonitoring::Matchable

  match do |event|
    data_matches?(event.command, expectation.event_data['command'])
  end
end

RSpec::Matchers.define :match_reply do |expectation|
  include Mongo::CommandMonitoring::Matchable

  match do |event|
    data_matches?(event.reply, expectation.event_data['reply'])
  end
end

RSpec::Matchers.define :match_command_started_event do |expectation|

  match do |event|
    expect(event).to match_command_name(expectation)
    expect(event).to match_database_name(expectation)
    expect(event).to generate_operation_id
    expect(event).to generate_request_id
    expect(event).to match_command(expectation)
  end
end

RSpec::Matchers.define :match_command_succeeded_event do |expectation|

  match do |event|
    expect(event).to match_command_name(expectation)
    expect(event).to generate_operation_id
    expect(event).to generate_request_id
    expect(event).to match_reply(expectation)
  end
end

RSpec::Matchers.define :match_command_failed_event do |expectation|

  match do |event|
    expect(event).to match_command_name(expectation)
    expect(event).to generate_operation_id
    expect(event).to generate_request_id
  end
end

module Mongo
  module CommandMonitoring

    # Matchers common behavior.
    #
    # @since 2.1.0
    module Matchable

      # Determine if the data matches.
      #
      # @example Does the data match?
      #   matchable.data_matches?(actual, expected)
      #
      # @param [ Object ] actual The actual data.
      # @param [ Object ] expected The expected data.
      #
      # @return [ true, false ] If the data matches.
      #
      # @since 2.1.0
      def data_matches?(actual, expected)
        case expected
        when ::Hash, BSON::Document then
          hash_matches?(actual, expected)
        when ::Array
          array_matches?(actual, expected)
        else
          value_matches?(actual, expected)
        end
      end

      # Determine if the hash matches.
      #
      # @example Does the hash match?
      #   matchable.hash_matches?(actual, expected)
      #
      # @param [ Hash ] actual The actual hash.
      # @param [ Hash ] expected The expected hash.
      #
      # @return [ true, false ] If the hash matches.
      #
      # @since 2.1.0
      def hash_matches?(actual, expected)
        if expected['writeConcern']
          expected['writeConcern'] = Options::Mapper.transform_keys_to_symbols(expected['writeConcern'])
        end
        if expected.keys.first == '$numberLong'
          converted = expected.values.first.to_i
          if actual.is_a?(BSON::Int64)
            actual = ::Utils.int64_value(actual)
          elsif actual.is_a?(BSON::Int32)
            return false
          end
          (actual == converted) || actual >= 0
        else
          expected.each do |key, value|
            return false unless data_matches?(actual[key], value)
          end
        end
      end

      # Determine if an array matches.
      #
      # @example Does the array match?
      #   matchable.array_matches?(actual, expected)
      #
      # @param [ Array ] actual The actual array.
      # @param [ Array ] expected The expected array.
      #
      # @return [ true, false ] If the array matches.
      #
      # @since 2.1.0
      def array_matches?(actual, expected)
        expected.each_with_index do |value, i|
          # @todo: Durran: fix for kill cursors replies
          if actual
            return false unless data_matches?(actual[i], value)
          end
        end
      end

      # Check if a value matches.
      #
      # @example Does a value match.
      #   matchable.value_matches?(actual, expected)
      #
      # @param [ Object ] actual The actual value.
      # @param [ Object ] expected The expected object.
      #
      # @return [ true, false ] If the value matches.
      #
      # @since 2.1.0
      def value_matches?(actual, expected)
        case expected
        when '42', 42 then
          actual > 0
        when '' then
          !actual.nil?
        else
          actual == expected
        end
      end
    end

    # Represents a command monitoring spec in its entirety.
    #
    # @since 2.1.0
    class Spec

      # Create the spec.
      #
      # @param [ String ] test_path The yaml test path.
      #
      # @since 2.1.0
      def initialize(test_path)
        @spec = ::Utils.load_spec_yaml_file(test_path)
        @data = @spec['data']
        @tests = @spec['tests']
      end

      # Get all the tests in the spec.
      #
      # @example Get all the tests.
      #   spec.tests
      #
      # @return [ Array<Test> ] The tests.
      def tests
        @tests.map do |test|
          Test.new(@data, test)
        end
      end
    end

    # Represents an individual command monitoring test.
    #
    # @since 2.1.0
    class Test

      # @return [ String ] description The test description.
      attr_reader :description

      # @return [ Array<Expectation> ] The expectations.
      attr_reader :expectations

      attr_reader :min_server_fcv

      attr_reader :max_server_version

      # Create the new test.
      #
      # @example Create the test.
      #   Test.new(data, test)
      #
      # @param [ Array<Hash> ] data The test data.
      # @param [ Hash ] The test itself.
      #
      # @since 2.1.0
      def initialize(data, test)
        @data = data
        @description = test['description']
        @max_server_version = test['ignore_if_server_version_greater_than']
        @min_server_fcv = test['ignore_if_server_version_less_than']
        @operation = Mongo::CRUD::Operation.new(self, test['operation'])
        @expectations = test['expectations'].map{ |e| Expectation.new(e) }
      end

      # Run the test against the provided collection.
      #
      # @example Run the test.
      #   test.run(collection)
      #
      # @param [ Mongo::Collection ] collection The collection.
      #
      # @since 2.1.0
      def run(collection, subscriber)
        collection.insert_many(@data)
        subscriber.clear_events!
        @operation.execute(collection)
      end
    end

    # Encapsulates expectation behavior.
    #
    # @since 2.1.0
    class Expectation

      # @return [ String ] event_type The type of expected event.
      attr_reader :event_type

      # @return [ Hash ] event_data The event data.
      attr_reader :event_data

      # Get the expected command name.
      #
      # @example Get the expected command name.
      #   expectation.command_name
      #
      # @return [ String ] The command name.
      #
      # @since 2.1.0
      def command_name
        @event_data['command_name']
      end

      # Get the expected database name.
      #
      # @example Get the expected database name.
      #   expectation.database_name
      #
      # @return [ String ] The database name.
      #
      # @since 2.1.0
      def database_name
        @event_data['database_name']
      end

      # Get a readable event name.
      #
      # @example Get the event name.
      #   expectation.event_name
      #
      # @return [ String ] The event name.
      #
      # @since 2.1.0
      def event_name
        event_type.gsub('_', ' ')
      end

      # Create the new expectation.
      #
      # @example Create the new expectation.
      #   Expectation.new(expectation)
      #
      # @param [ Hash ] expectation The expectation.
      #
      # @since 2.1.0
      def initialize(expectation)
        @event_type = expectation.keys.first
        @event_data = expectation[@event_type]
      end

      # Get the name of the matcher.
      #
      # @example Get the matcher name.
      #   expectation.matcher
      #
      # @return [ String ] The matcher name.
      #
      # @since 2.1.0
      def matcher
        "match_#{event_type}"
      end
    end
  end
end