summaryrefslogtreecommitdiff
path: root/spec/ruby/library/io-wait/wait_spec.rb
blob: d968c38774ccda681af02bf0febc500afb8e115e (plain)
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
require_relative '../../spec_helper'
require_relative 'fixtures/classes'

ruby_version_is ''...'3.2' do
  require 'io/wait'
end

describe "IO#wait" do
  before :each do
    @io = File.new(__FILE__ )

    if /mswin|mingw/ =~ RUBY_PLATFORM
      require 'socket'
      @r, @w = Socket.pair(Socket::AF_INET, Socket::SOCK_STREAM, 0)
    else
      @r, @w = IO.pipe
    end
  end

  after :each do
    @io.close unless @io.closed?

    @r.close unless @r.closed?
    @w.close unless @w.closed?
  end

  ruby_version_is "3.0" do
    context "[events, timeout] passed" do
      ruby_version_is "3.0"..."3.2" do
        it "returns self when the READABLE event is ready during the timeout" do
          @w.write('data to read')
          @r.wait(IO::READABLE, 2).should.equal?(@r)
        end

        it "returns self when the WRITABLE event is ready during the timeout" do
          @w.wait(IO::WRITABLE, 0).should.equal?(@w)
        end
      end

      ruby_version_is "3.2" do
        it "returns events mask when the READABLE event is ready during the timeout" do
          @w.write('data to read')
          @r.wait(IO::READABLE, 2).should == IO::READABLE
        end

        it "returns events mask when the WRITABLE event is ready during the timeout" do
          @w.wait(IO::WRITABLE, 0).should == IO::WRITABLE
        end
      end

      ruby_version_is "3.0" do
        it "waits for the READABLE event to be ready" do
          queue = Queue.new
          thread = Thread.new { queue.pop; sleep 1; @w.write('data to read') };

          queue.push('signal');
          @r.wait(IO::READABLE, 2).should_not == nil

          thread.join
        end

        it "waits for the WRITABLE event to be ready" do
          written_bytes = IOWaitSpec.exhaust_write_buffer(@w)

          queue = Queue.new
          thread = Thread.new { queue.pop; sleep 1; @r.read(written_bytes) };

          queue.push('signal');
          @w.wait(IO::WRITABLE, 2).should_not == nil

          thread.join
        end

        it "returns nil when the READABLE event is not ready during the timeout" do
          @w.wait(IO::READABLE, 0).should == nil
        end

        it "returns nil when the WRITABLE event is not ready during the timeout" do
          IOWaitSpec.exhaust_write_buffer(@w)
          @w.wait(IO::WRITABLE, 0).should == nil
        end

        it "raises IOError when io is closed (closed stream (IOError))" do
          @io.close
          -> { @io.wait(IO::READABLE, 0) }.should raise_error(IOError, "closed stream")
        end

        ruby_version_is "3.2" do
          it "raises ArgumentError when events is not positive" do
            -> { @w.wait(0, 0) }.should raise_error(ArgumentError, "Events must be positive integer!")
            -> { @w.wait(-1, 0) }.should raise_error(ArgumentError, "Events must be positive integer!")
          end
        end
      end
    end
  end

  context "[timeout, mode] passed" do
    it "accepts :r, :read, :readable mode to check READABLE event" do
      @io.wait(0, :r).should == @io
      @io.wait(0, :read).should == @io
      @io.wait(0, :readable).should == @io
    end

    it "accepts :w, :write, :writable mode to check WRITABLE event" do
      @io.wait(0, :w).should == @io
      @io.wait(0, :write).should == @io
      @io.wait(0, :writable).should == @io
    end

    it "accepts :rw, :read_write, :readable_writable mode to check READABLE and WRITABLE events" do
      @io.wait(0, :rw).should == @io
      @io.wait(0, :read_write).should == @io
      @io.wait(0, :readable_writable).should == @io
    end

    it "accepts a list of modes" do
       @io.wait(0, :r, :w, :rw).should == @io
    end

    # It works at least since 2.7 but by some reason may fail on 3.1
    ruby_version_is "3.2" do
      it "accepts timeout and mode in any order" do
        @io.wait(0, :r).should == @io
        @io.wait(:r, 0).should == @io
        @io.wait(:r, 0, :w).should == @io
      end
    end

    it "raises ArgumentError when passed wrong Symbol value as mode argument" do
      -> { @io.wait(0, :wrong) }.should raise_error(ArgumentError, "unsupported mode: wrong")
    end

    # It works since 3.0 but by some reason may fail on 3.1
    ruby_version_is "3.2" do
      it "raises ArgumentError when several Integer arguments passed" do
        -> { @w.wait(0, 10, :r) }.should raise_error(ArgumentError, "timeout given more than once")
      end
    end

    ruby_version_is "3.2" do
      it "raises IOError when io is closed (closed stream (IOError))" do
        @io.close
        -> { @io.wait(0, :r) }.should raise_error(IOError, "closed stream")
      end
    end
  end
end