summaryrefslogtreecommitdiff
path: root/spec/ruby/library/socket/basicsocket/recv_nonblock_spec.rb
blob: f2a6682f12b8eae834b808281a1b7250828a990e (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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
require_relative '../spec_helper'
require_relative '../fixtures/classes'

describe "Socket::BasicSocket#recv_nonblock" do
  SocketSpecs.each_ip_protocol do |family, ip_address|
    before :each do
      @s1 = Socket.new(family, :DGRAM)
      @s2 = Socket.new(family, :DGRAM)
    end

    after :each do
      @s1.close unless @s1.closed?
      @s2.close unless @s2.closed?
    end

    platform_is_not :windows do
      describe 'using an unbound socket' do
        it 'raises an exception extending IO::WaitReadable' do
          -> { @s1.recv_nonblock(1) }.should raise_error(IO::WaitReadable)
        end
      end
    end

    it "raises an exception extending IO::WaitReadable if there's no data available" do
      @s1.bind(Socket.pack_sockaddr_in(0, ip_address))
      -> {
        @s1.recv_nonblock(5)
      }.should raise_error(IO::WaitReadable) { |e|
        platform_is_not :windows do
          e.should be_kind_of(Errno::EAGAIN)
        end
        platform_is :windows do
          e.should be_kind_of(Errno::EWOULDBLOCK)
        end
      }
    end

    it "returns :wait_readable with exception: false" do
      @s1.bind(Socket.pack_sockaddr_in(0, ip_address))
      @s1.recv_nonblock(5, exception: false).should == :wait_readable
    end

    it "receives data after it's ready" do
      @s1.bind(Socket.pack_sockaddr_in(0, ip_address))
      @s2.send("aaa", 0, @s1.getsockname)
      IO.select([@s1], nil, nil, 2)
      @s1.recv_nonblock(5).should == "aaa"
    end

    it "allows an output buffer as third argument" do
      @s1.bind(Socket.pack_sockaddr_in(0, ip_address))
      @s2.send("data", 0, @s1.getsockname)
      IO.select([@s1], nil, nil, 2)

      buffer = +"foo"
      @s1.recv_nonblock(5, 0, buffer).should.equal?(buffer)
      buffer.should == "data"
    end

    it "preserves the encoding of the given buffer" do
      @s1.bind(Socket.pack_sockaddr_in(0, ip_address))
      @s2.send("data", 0, @s1.getsockname)
      IO.select([@s1], nil, nil, 2)

      buffer = ''.encode(Encoding::ISO_8859_1)
      @s1.recv_nonblock(5, 0, buffer)
      buffer.encoding.should == Encoding::ISO_8859_1
    end

    it "does not block if there's no data available" do
      @s1.bind(Socket.pack_sockaddr_in(0, ip_address))
      @s2.send("a", 0, @s1.getsockname)
      IO.select([@s1], nil, nil, 2)
      @s1.recv_nonblock(1).should == "a"
      -> {
        @s1.recv_nonblock(5)
      }.should raise_error(IO::WaitReadable)
    end
  end

  SocketSpecs.each_ip_protocol do |family, ip_address|
    describe 'using a connected but not bound socket' do
      before do
        @server = Socket.new(family, :STREAM)
      end

      after do
        @server.close
      end

      it "raises Errno::ENOTCONN" do
        -> { @server.recv_nonblock(1) }.should raise_error { |e|
          [Errno::ENOTCONN, Errno::EINVAL].should.include?(e.class)
        }
        -> { @server.recv_nonblock(1, exception: false) }.should raise_error { |e|
          [Errno::ENOTCONN, Errno::EINVAL].should.include?(e.class)
        }
      end
    end
  end
end

describe "Socket::BasicSocket#recv_nonblock" do
  context "when recvfrom(2) returns 0 (if no messages are available to be received and the peer has performed an orderly shutdown)" do
    describe "stream socket" do
      before :each do
        @server = TCPServer.new('127.0.0.1', 0)
        @port = @server.addr[1]
      end

      after :each do
        @server.close unless @server.closed?
      end

      ruby_version_is ""..."3.3" do
        it "returns an empty String on a closed stream socket" do
          ready = false

          t = Thread.new do
            client = @server.accept

            Thread.pass while !ready
            begin
              client.recv_nonblock(10)
            rescue IO::EAGAINWaitReadable
              retry
            end
          ensure
            client.close if client
          end

          Thread.pass while t.status and t.status != "sleep"
          t.status.should_not be_nil

          socket = TCPSocket.new('127.0.0.1', @port)
          socket.close
          ready = true

          t.value.should == ""
        end
      end

      ruby_version_is "3.3" do
        it "returns nil on a closed stream socket" do
          ready = false

          t = Thread.new do
            client = @server.accept

            Thread.pass while !ready
            begin
              client.recv_nonblock(10)
            rescue IO::EAGAINWaitReadable
              retry
            end
          ensure
            client.close if client
          end

          Thread.pass while t.status and t.status != "sleep"
          t.status.should_not be_nil

          socket = TCPSocket.new('127.0.0.1', @port)
          socket.close
          ready = true

          t.value.should be_nil
        end
      end
    end
  end
end