summaryrefslogtreecommitdiff
path: root/spec/ruby/library/socket/basicsocket/setsockopt_spec.rb
blob: 1e8d84e1c9ecd02c623ad59965fb586f143c5493 (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
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
require_relative '../spec_helper'
require_relative '../fixtures/classes'

describe "BasicSocket#setsockopt" do

  before :each do
    @sock = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
  end

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

  it "sets the socket linger to 0" do
    linger = [0, 0].pack("ii")
    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_LINGER, linger).should == 0
    n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_LINGER).to_s

    if (n.size == 8) # linger struct on some platforms, not just a value
      n.should == [0, 0].pack("ii")
    else
      n.should == [0].pack("i")
    end
  end

  it "sets the socket linger to some positive value" do
    linger = [64, 64].pack("ii")
    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_LINGER, linger).should == 0
    n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_LINGER).to_s
    if (n.size == 8) # linger struct on some platforms, not just a value
      a = n.unpack('ii')
      a[0].should_not == 0
      a[1].should == 64
    else
      n.should == [64].pack("i")
    end
  end

  platform_is_not :windows do
    it "raises EINVAL if passed wrong linger value" do
      -> do
        @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_LINGER, 0)
      end.should raise_error(Errno::EINVAL)
    end
  end

  platform_is_not :aix do
    # A known bug in AIX.  getsockopt(2) does not properly set
    # the fifth argument for SO_TYPE, SO_OOBINLINE, SO_BROADCAST, etc.

    it "sets the socket option Socket::SO_OOBINLINE" do
      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, true).should == 0
      n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE).to_s
      n.should_not == [0].pack("i")

      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, false).should == 0
      n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE).to_s
      n.should == [0].pack("i")

      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, 1).should == 0
      n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE).to_s
      n.should_not == [0].pack("i")

      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, 0).should == 0
      n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE).to_s
      n.should == [0].pack("i")

      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, 2).should == 0
      n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE).to_s
      n.should_not == [0].pack("i")

      platform_is_not :windows do
        -> {
          @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, "")
        }.should raise_error(SystemCallError)
      end

      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, "blah").should == 0
      n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE).to_s
      n.should_not == [0].pack("i")

      platform_is_not :windows do
        -> {
          @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, "0")
        }.should raise_error(SystemCallError)
      end

      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, "\x00\x00\x00\x00").should == 0
      n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE).to_s
      n.should == [0].pack("i")

      platform_is_not :windows do
        -> {
          @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, "1")
        }.should raise_error(SystemCallError)
      end

      platform_is_not :windows do
        -> {
          @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, "\x00\x00\x00")
        }.should raise_error(SystemCallError)
      end

      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, [1].pack('i')).should == 0
      n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE).to_s
      n.should_not == [0].pack("i")

      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, [0].pack('i')).should == 0
      n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE).to_s
      n.should == [0].pack("i")

      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, [1000].pack('i')).should == 0
      n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE).to_s
      n.should_not == [0].pack("i")
    end
  end

  it "sets the socket option Socket::SO_SNDBUF" do
    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, 4000).should == 0
    sndbuf = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF).to_s
    # might not always be possible to set to exact size
    sndbuf.unpack('i')[0].should >= 4000

    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, true).should == 0
    n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF).to_s
    n.unpack('i')[0].should >= 1

    -> {
      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, nil).should == 0
    }.should raise_error(TypeError)

    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, 1).should == 0
    n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF).to_s
    n.unpack('i')[0].should >= 1

    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, 2).should == 0
    n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF).to_s
    n.unpack('i')[0].should >= 2

    -> {
      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, "")
    }.should raise_error(SystemCallError)

    -> {
      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, "bla")
    }.should raise_error(SystemCallError)

    -> {
      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, "0")
    }.should raise_error(SystemCallError)

    -> {
      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, "1")
    }.should raise_error(SystemCallError)

    -> {
      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, "\x00\x00\x00")
    }.should raise_error(SystemCallError)

    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, "\x00\x00\x01\x00").should == 0
    n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF).to_s
    n.unpack('i')[0].should >= "\x00\x00\x01\x00".unpack('i')[0]

    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, [4000].pack('i')).should == 0
    n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF).to_s
    n.unpack('i')[0].should >= 4000

    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF, [1000].pack('i')).should == 0
    n = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF).to_s
    n.unpack('i')[0].should >= 1000
  end

  platform_is_not :aix do
    describe 'accepts Socket::Option as argument' do
      it 'boolean' do
        option = Socket::Option.bool(:INET, :SOCKET, :KEEPALIVE, true)
        @sock.setsockopt(option).should == 0
        @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE).bool.should == true
      end

      it 'int' do
        option = Socket::Option.int(:INET, :SOCKET, :KEEPALIVE, 1)
        @sock.setsockopt(option).should == 0
        @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE).bool.should == true
      end
    end
  end

  platform_is :aix do
    describe 'accepts Socket::Option as argument' do
      it 'boolean' do
        option = Socket::Option.bool(:INET, :SOCKET, :KEEPALIVE, true)
        @sock.setsockopt(option).should == 0
      end

      it 'int' do
        option = Socket::Option.int(:INET, :SOCKET, :KEEPALIVE, 1)
        @sock.setsockopt(option).should == 0
      end
    end
  end

  describe 'accepts Socket::Option as argument' do
    it 'linger' do
      option = Socket::Option.linger(true, 10)
      @sock.setsockopt(option).should == 0
      onoff, seconds = @sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_LINGER).linger
      seconds.should == 10
      # Both results can be produced depending on the OS and value of Socket::SO_LINGER
      [true, Socket::SO_LINGER].should include(onoff)
    end
  end
end

describe 'BasicSocket#setsockopt' do
  describe 'using a STREAM socket' do
    before do
      @socket = Socket.new(:INET, :STREAM)
    end

    after do
      @socket.close
    end

    describe 'using separate arguments with Symbols' do
      it 'raises TypeError when the first argument is nil' do
        -> { @socket.setsockopt(nil, :REUSEADDR, true) }.should raise_error(TypeError)
      end

      it 'sets a boolean option' do
        @socket.setsockopt(:SOCKET, :REUSEADDR, true).should == 0
        @socket.getsockopt(:SOCKET, :REUSEADDR).bool.should == true
      end

      it 'sets an integer option' do
        @socket.setsockopt(:IP, :TTL, 255).should == 0
        @socket.getsockopt(:IP, :TTL).int.should == 255
      end

      guard -> { SocketSpecs.ipv6_available? } do
        it 'sets an IPv6 boolean option' do
          socket = Socket.new(:INET6, :STREAM)
          begin
            socket.setsockopt(:IPV6, :V6ONLY, true).should == 0
            socket.getsockopt(:IPV6, :V6ONLY).bool.should == true
          ensure
            socket.close
          end
        end
      end

      platform_is_not :windows do
        it 'raises Errno::EINVAL when setting an invalid option value' do
          -> { @socket.setsockopt(:SOCKET, :OOBINLINE, 'bla') }.should raise_error(Errno::EINVAL)
        end
      end
    end

    describe 'using separate arguments with Symbols' do
      it 'sets a boolean option' do
        @socket.setsockopt('SOCKET', 'REUSEADDR', true).should == 0
        @socket.getsockopt(:SOCKET, :REUSEADDR).bool.should == true
      end

      it 'sets an integer option' do
        @socket.setsockopt('IP', 'TTL', 255).should == 0
        @socket.getsockopt(:IP, :TTL).int.should == 255
      end
    end

    describe 'using separate arguments with constants' do
      it 'sets a boolean option' do
        @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true).should == 0
        @socket.getsockopt(:SOCKET, :REUSEADDR).bool.should == true
      end

      it 'sets an integer option' do
        @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, 255).should == 0
        @socket.getsockopt(:IP, :TTL).int.should == 255
      end
    end

    describe 'using separate arguments with custom objects' do
      it 'sets a boolean option' do
        level = mock(:level)
        name  = mock(:name)

        level.stub!(:to_str).and_return('SOCKET')
        name.stub!(:to_str).and_return('REUSEADDR')

        @socket.setsockopt(level, name, true).should == 0
      end
    end

    describe 'using a Socket::Option as the first argument' do
      it 'sets a boolean option' do
        @socket.setsockopt(Socket::Option.bool(:INET, :SOCKET, :REUSEADDR, true)).should == 0
        @socket.getsockopt(:SOCKET, :REUSEADDR).bool.should == true
      end

      it 'sets an integer option' do
        @socket.setsockopt(Socket::Option.int(:INET, :IP, :TTL, 255)).should == 0
        @socket.getsockopt(:IP, :TTL).int.should == 255
      end

      it 'raises ArgumentError when passing 2 arguments' do
        option = Socket::Option.bool(:INET, :SOCKET, :REUSEADDR, true)
        -> { @socket.setsockopt(option, :REUSEADDR) }.should raise_error(ArgumentError)
      end

      it 'raises TypeError when passing 3 arguments' do
        option = Socket::Option.bool(:INET, :SOCKET, :REUSEADDR, true)
        -> { @socket.setsockopt(option, :REUSEADDR, true) }.should raise_error(TypeError)
      end
    end
  end

  with_feature :unix_socket do
    describe 'using a UNIX socket' do
      before do
        @path = SocketSpecs.socket_path
        @server = UNIXServer.new(@path)
      end

      after do
        @server.close
        rm_r @path
      end

      it 'sets a boolean option' do
        @server.setsockopt(:SOCKET, :REUSEADDR, true)
        @server.getsockopt(:SOCKET, :REUSEADDR).bool.should == true
      end
    end
  end
end