File: obligation_spec.rb

package info (click to toggle)
ruby-concurrent 1.1.6%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 30,284 kB
  • sloc: ruby: 30,875; java: 6,117; javascript: 1,114; ansic: 288; makefile: 10; sh: 6
file content (329 lines) | stat: -rw-r--r-- 9,629 bytes parent folder | download | duplicates (2)
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
module Concurrent
  module Concern

    RSpec.describe Obligation do

      let (:obligation_class) do
        Class.new(Synchronization::LockableObject) do
          include Obligation
          public :state=, :compare_and_set_state, :if_state
          attr_writer :value, :reason
          def initialize
            super
            set_deref_options
            init_obligation
          end
        end
      end

      let (:obligation) { obligation_class.new }
      let (:event) { double 'event' }

      RSpec.shared_examples :incomplete do

        it 'should be not completed' do
          expect(obligation).not_to be_complete
        end

        it 'should be incomplete' do
          expect(obligation).to be_incomplete
        end

        methods = [:value, :value!, :no_error!]
        methods.each do |method|
          describe "##{method}" do

            it 'should return immediately if timeout is zero' do
              result = obligation.send(method, 0)
              if method == :no_error!
                expect(result).to eq obligation
              else
                expect(result).to be_nil
              end
            end

            it 'should block on the event if timeout is not set' do
              allow(obligation).to receive(:event).and_return(event)
              expect(event).to receive(:wait).with(nil)

              obligation.send method
            end

            it 'should block on the event if timeout is not zero' do
              allow(obligation).to receive(:event).and_return(event)
              expect(event).to receive(:wait).with(5)

              obligation.send(method, 5)
            end

          end
        end
      end

      context 'unscheduled' do
        before(:each) { obligation.state = :unscheduled }
        it_should_behave_like :incomplete
      end

      context 'pending' do
        before(:each) { obligation.state = :pending }
        it_should_behave_like :incomplete
      end

      context 'fulfilled' do

        before(:each) do
          obligation.send :set_state, true, 42, nil
          allow(obligation).to receive(:event).and_return(event)
        end

        it 'should be completed' do
          expect(obligation).to be_complete
        end

        it 'should be not incomplete' do
          expect(obligation).not_to be_incomplete
        end

        describe '#value' do

          it 'should return immediately if timeout is zero' do
            expect(obligation.value(0)).to eq 42
          end

          it 'should return immediately if timeout is not set' do
            expect(event).not_to receive(:wait)

            expect(obligation.value).to eq 42
          end

          it 'should return immediately if timeout is not zero' do
            expect(event).not_to receive(:wait)

            expect(obligation.value(5)).to eq 42
          end

        end

        describe '#value!' do

          it 'should return immediately if timeout is zero' do
            expect(obligation.value!(0)).to eq 42
          end

          it 'should return immediately if timeout is not set' do
            expect(event).not_to receive(:wait)

            expect(obligation.value!).to eq 42
          end

          it 'should return immediately if timeout is not zero' do
            expect(event).not_to receive(:wait)

            expect(obligation.value!(5)).to eq 42
          end

        end

        describe '#no_error!' do

          it 'should return immediately if timeout is zero' do
            expect(obligation.no_error!(0)).to eq obligation
          end

          it 'should return immediately if timeout is not set' do
            expect(event).not_to receive(:wait)

            expect(obligation.no_error!).to eq obligation
          end

          it 'should return immediately if timeout is not zero' do
            expect(event).not_to receive(:wait)

            expect(obligation.no_error!(5)).to eq obligation
          end

        end

      end

      context 'rejected' do

        before(:each) do
          obligation.send :set_state, false, nil, (raise rescue $!)
          allow(obligation).to receive(:event).and_return(event)
        end

        it 'should be completed' do
          expect(obligation).to be_complete
        end

        it 'should be not incomplete' do
          expect(obligation).not_to be_incomplete
        end


        describe '#value' do

          it 'should return immediately if timeout is zero' do
            expect(event).not_to receive(:wait)

            expect(obligation.value(0)).to be_nil
          end

          it 'should return immediately if timeout is not set' do
            expect(event).not_to receive(:wait)

            expect(obligation.value).to be_nil
          end

          it 'should return immediately if timeout is not zero' do
            expect(event).not_to receive(:wait)

            expect(obligation.value(5)).to be_nil
          end

        end

        describe '#value!' do

          it 'should return immediately if timeout is zero' do
            expect(event).not_to receive(:wait)

            expect { obligation.value!(0) }.to raise_error StandardError
          end

          it 'should return immediately if timeout is not set' do
            expect(event).not_to receive(:wait)

            expect { obligation.value! }.to raise_error StandardError
          end

          it 'should return immediately if timeout is not zero' do
            expect(event).not_to receive(:wait)

            expect { obligation.value!(5) }.to raise_error StandardError
          end

        end

        describe '#no_error!' do

          it 'should return immediately if timeout is zero' do
            expect(event).not_to receive(:wait)

            expect { obligation.no_error!(0) }.to raise_error StandardError
          end

          it 'should return immediately if timeout is not set' do
            expect(event).not_to receive(:wait)

            expect { obligation.no_error! }.to raise_error StandardError
          end

          it 'should return immediately if timeout is not zero' do
            expect(event).not_to receive(:wait)

            expect { obligation.no_error!(5) }.to raise_error StandardError
          end

        end

      end

      describe '#compare_and_set_state' do

        before(:each) { obligation.state = :unscheduled }

        context 'unexpected state' do
          it 'should return false if state is not the expected one' do
            expect(obligation.compare_and_set_state(:pending, :rejected)).to be_falsey
          end

          it 'should not change the state if current is not the expected one' do
            obligation.compare_and_set_state(:pending, :rejected)
            expect(obligation.state).to eq :unscheduled
          end
        end

        context 'expected state' do
          it 'should return true if state is the expected one' do
            expect(obligation.compare_and_set_state(:pending, :unscheduled)).to be_truthy
          end

          it 'should not change the state if current is not the expected one' do
            obligation.compare_and_set_state(:pending, :unscheduled)
            expect(obligation.state).to eq :pending
          end
        end

      end

      describe '#if_state' do

        before(:each) { obligation.state = :unscheduled }

        it 'should raise without block' do
          expect { obligation.if_state(:pending) }.to raise_error(ArgumentError)
        end

        it 'should return false if state is not expected' do
          expect(obligation.if_state(:pending, :rejected) { 42 }).to be_falsey
        end

        it 'should the block value if state is expected' do
          expect(obligation.if_state(:rejected, :unscheduled) { 42 }).to eq 42
        end

        it 'should execute the block within the mutex' do
          expect(obligation).to receive(:synchronize)
          obligation.if_state(:unscheduled) { nil }
        end
      end

      context '#get_arguments_from' do

        it 'returns an empty array when opts is not given' do
          args = obligation.send(:get_arguments_from)
          expect(args).to be_a ::Array
          expect(args).to be_empty
        end

        it 'returns an empty array when opts is an empty hash' do
          args = obligation.send(:get_arguments_from, {})
          expect(args).to be_a ::Array
          expect(args).to be_empty
        end

        it 'returns an empty array when there is no :args key' do
          args = obligation.send(:get_arguments_from, foo: 'bar')
          expect(args).to be_a ::Array
          expect(args).to be_empty
        end

        it 'returns an empty array when the :args key has a nil value' do
          args = obligation.send(:get_arguments_from, args: nil)
          expect(args).to be_a ::Array
          expect(args).to be_empty
        end

        it 'returns a one-element array when the :args key has a non-array value' do
          args = obligation.send(:get_arguments_from, args: 'foo')
          expect(args).to eq ['foo']
        end

        it 'returns an array when when the :args key has an array value' do
          expected = [1, 2, 3, 4]
          args = obligation.send(:get_arguments_from, args: expected)
          expect(args).to eq expected
        end

        it 'returns the given array when the :args key has a complex array value' do
          expected = [(1..10).to_a, (20..30).to_a, (100..110).to_a]
          args = obligation.send(:get_arguments_from, args: expected)
          expect(args).to eq expected
        end
      end
    end
  end
end