rubysl-socket 0.0.1 → 1.0.0

data/spec/tcpserver/gets_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+describe "TCPServer#gets" do
+  before :each do
+    @server = TCPServer.new(SocketSpecs.hostname, SocketSpecs.port)
+  end
+
+  after :each do
+    @server.close
+  end
+
+  ruby_bug "#", "1.8" do
+    it "raises Errno::ENOTCONN on gets" do
+      lambda { @server.gets }.should raise_error(Errno::ENOTCONN)
+    end
+  end
+end

data/spec/tcpserver/listen_spec.rb

@@ -0,0 +1 @@
+require File.expand_path('../../fixtures/classes', __FILE__)

data/spec/tcpserver/new_spec.rb

@@ -0,0 +1,88 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+describe "TCPServer.new" do
+  after(:each) do
+    @server.close if @server && !@server.closed?
+  end
+
+  it "binds to a host and a port" do
+    @server = TCPServer.new('127.0.0.1', SocketSpecs.port)
+    addr = @server.addr
+    addr[0].should == 'AF_INET'
+    addr[1].should be_kind_of(Fixnum)
+    # on some platforms (Mac), MRI
+    # returns comma at the end.
+    addr[2].should =~ /^#{SocketSpecs.hostname}\b/
+    addr[3].should == '127.0.0.1'
+  end
+
+  it "binds to localhost and a port with either IPv4 or IPv6" do
+    @server = TCPServer.new(SocketSpecs.hostname, SocketSpecs.port)
+    addr = @server.addr
+    if addr[0] == 'AF_INET'
+      addr[1].should == SocketSpecs.port
+      addr[2].should =~ /^#{SocketSpecs.hostname}\b/
+      addr[3].should == '127.0.0.1'
+    else
+      addr[1].should == SocketSpecs.port
+      addr[2].should =~ /^#{SocketSpecs.hostnamev6}\b/
+      addr[3].should == '::1'
+    end
+  end
+
+  it "binds to INADDR_ANY if the hostname is empty" do
+    @server = TCPServer.new('', SocketSpecs.port)
+    addr = @server.addr
+    addr[0].should == 'AF_INET'
+    addr[1].should == SocketSpecs.port
+    expected = ['', '0.0.0.0']
+    expected.should include(addr[2])
+    addr[3].should == '0.0.0.0'
+  end
+
+  it "binds to INADDR_ANY if the hostname is empty and the port is a string" do
+    @server = TCPServer.new('', SocketSpecs.port.to_s)
+    addr = @server.addr
+    addr[0].should == 'AF_INET'
+    addr[1].should == SocketSpecs.port
+    expected = ['', '0.0.0.0']
+    expected.should include(addr[2])
+    addr[3].should == '0.0.0.0'
+  end
+
+  it "coerces port to string, then determines port from that number or service name" do
+    t = Object.new
+    lambda { TCPServer.new(SocketSpecs.hostname, t) }.should raise_error(TypeError)
+
+    def t.to_str; SocketSpecs.port.to_s; end
+
+    @server = TCPServer.new(SocketSpecs.hostname, t)
+    addr = @server.addr
+    addr[1].should == SocketSpecs.port
+
+    # TODO: This should also accept strings like 'https', but I don't know how to
+    # pick such a service port that will be able to reliably bind...
+  end
+
+  it "raises Errno::EADDRNOTAVAIL when the adress is unknown" do
+    lambda { TCPServer.new("1.2.3.4", 4000) }.should raise_error(Errno::EADDRNOTAVAIL)
+  end
+
+  # There is no way to make this fail-proof on all machines, because
+  # DNS servers like opendns return A records for ANY host, including
+  # traditionally invalidly named ones.
+  quarantine! do
+    it "raises a SocketError when the host is unknown" do
+      lambda {
+        TCPServer.new("--notavalidname", 4000)
+      }.should raise_error(SocketError)
+    end
+  end
+
+  it "raises Errno::EADDRINUSE when address is already in use" do
+    lambda {
+      @server = TCPServer.new('127.0.0.1', SocketSpecs.port)
+      @server = TCPServer.new('127.0.0.1', SocketSpecs.port)
+    }.should raise_error(Errno::EADDRINUSE)
+  end
+end

data/spec/tcpserver/output_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+describe "TCPServer#<<" do
+  after(:each) do
+    @server.close if @server
+    @socket.close if @socket
+  end
+end

data/spec/tcpserver/readpartial_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+describe "TCPServer#readpartial" do
+  after(:each) do
+    @server.close if @server
+    @socket.close if @socket
+  end
+end

data/spec/tcpserver/sysaccept_spec.rb

@@ -0,0 +1 @@
+require File.expand_path('../../fixtures/classes', __FILE__)

data/spec/tcpsocket/gethostbyname_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+# TODO: verify these for windows
+describe "TCPSocket#gethostbyname" do
+  before :each do
+    @host_info = TCPSocket.gethostbyname(SocketSpecs.hostname)
+  end
+
+  it "returns an array elements of information on the hostname" do
+    @host_info.should be_kind_of(Array)
+  end
+
+  platform_is_not :windows do
+    it "returns the canonical name as first value" do
+    @host_info[0].should == SocketSpecs.hostname
+    end
+
+    not_compliant_on :jruby do
+      it "returns the address type as the third value" do
+        address_type = @host_info[2]
+        [Socket::AF_INET, Socket::AF_INET6].include?(address_type).should be_true
+      end
+
+      it "returns the IP address as the fourth value" do
+        ip = @host_info[3]
+        ["127.0.0.1", "::1"].include?(ip).should be_true
+      end
+    end
+
+    deviates_on :jruby do
+      it "returns the address type as the third value" do
+        address_type = @host_info[2]
+        [Socket::AF_INET, Socket::AF_INET6].include?(address_type).should be_true
+      end
+
+      it "returns the IP address as the fourth value" do
+        ip = @host_info[3]
+        ["127.0.0.1", "::1"].include?(ip).should be_true
+      end
+    end
+  end
+
+  platform_is :windows do
+    it "returns the canonical name as first value" do
+      host = "#{ENV['COMPUTERNAME'].downcase}"
+      host << ".#{ENV['USERDNSDOMAIN'].downcase}" if ENV['USERDNSDOMAIN']
+      @host_info[0].should == host
+    end
+
+    it "returns the address type as the third value" do
+      @host_info[2].should == Socket::AF_INET
+    end
+
+    it "returns the IP address as the fourth value" do
+      @host_info[3].should == "127.0.0.1"
+    end
+  end
+
+  it "returns any aliases to the address as second value" do
+    @host_info[1].should be_kind_of(Array)
+  end
+end

data/spec/tcpsocket/new_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path('../shared/new', __FILE__)
+
+describe "TCPSocket.new" do
+  it_behaves_like :tcpsocket_new, :new
+end

data/spec/tcpsocket/open_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path('../shared/new', __FILE__)
+
+describe "TCPSocket.open" do
+  it_behaves_like :tcpsocket_new, :open
+end

data/spec/tcpsocket/partially_closable_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+require File.expand_path('../../shared/partially_closable_sockets', __FILE__)
+
+describe "TCPSocket partial closability" do
+
+  before :each do
+    @server = TCPServer.new("127.0.0.1", SocketSpecs.port+1)
+    @s1 = TCPSocket.new("127.0.0.1", SocketSpecs.port+1)
+    @s2 = @server.accept
+  end
+
+  after :each do
+    @server.close
+    @s1.close
+    @s2.close
+  end
+
+  it_should_behave_like "partially closable sockets"
+
+end

data/spec/tcpsocket/recv_nonblock_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+describe "TCPSocket#recv_nonblock" do
+  before :all do
+    SocketSpecs::SpecTCPServer.start
+  end
+
+  before :each do
+    @hostname = SocketSpecs::SpecTCPServer.get.hostname
+    @socket = nil
+  end
+
+  after :each do
+    if @socket
+      @socket.write "QUIT"
+      @socket.close
+    end
+  end
+
+  it "returns a String read from the socket" do
+    @socket = TCPSocket.new @hostname, SocketSpecs.port
+    @socket.write "TCPSocket#recv_nonblock"
+
+    # Wait for the server to echo. This spec is testing the return
+    # value, not the non-blocking behavior.
+    #
+    # TODO: Figure out a good way to test non-blocking.
+    IO.select([@socket])
+    @socket.recv_nonblock(50).should == "TCPSocket#recv_nonblock"
+  end
+end

data/spec/tcpsocket/setsockopt_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+describe "TCPSocket#setsockopt" do
+  before :all do
+    SocketSpecs::SpecTCPServer.start
+  end
+
+  before(:each) do
+    hostname = SocketSpecs::SpecTCPServer.get.hostname
+    port = SocketSpecs::SpecTCPServer.get.port
+    @sock = TCPSocket.new(hostname, port)
+  end
+
+  after :each do
+    @sock.close unless @sock.closed?
+  end
+
+  describe "using constants" do
+    it "sets the TCP nodelay to 1" do
+      @sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1).should == 0
+    end
+  end
+
+  ruby_version_is "1.9" do
+    describe "using symbols" do
+      it "sets the TCP nodelay to 1" do
+        @sock.setsockopt(:IPPROTO_TCP, :TCP_NODELAY, 1).should == 0
+      end
+
+      context "without prefix" do
+        it "sets the TCP nodelay to 1" do
+          @sock.setsockopt(:TCP, :NODELAY, 1).should == 0
+        end
+      end
+    end
+
+    describe "using strings" do
+      it "sets the TCP nodelay to 1" do
+        @sock.setsockopt('IPPROTO_TCP', 'TCP_NODELAY', 1).should == 0
+      end
+
+      context "without prefix" do
+        it "sets the TCP nodelay to 1" do
+          @sock.setsockopt('TCP', 'NODELAY', 1).should == 0
+        end
+      end
+    end
+  end
+end

data/spec/tcpsocket/shared/new.rb

@@ -0,0 +1,85 @@
+require File.expand_path('../../../fixtures/classes', __FILE__)
+
+describe :tcpsocket_new, :shared => true do
+  before :all do
+    SocketSpecs::SpecTCPServer.start
+  end
+
+  after :all do
+    SocketSpecs::SpecTCPServer.cleanup
+  end
+
+  before :each do
+    @hostname = SocketSpecs::SpecTCPServer.get.hostname
+  end
+
+  it "requires a hostname and a port as arguments" do
+    lambda { TCPSocket.send(@method) }.should raise_error(ArgumentError)
+  end
+
+  it "throws a type error if the port is not a fixnum or string" do
+    lambda { TCPSocket.send(@method, @hostname, {}) }.should raise_error(TypeError)
+  end
+
+  it "refuses the connection when there is no server to connect to" do
+    lambda do
+      TCPSocket.send(@method, @hostname, SocketSpecs.local_port)
+    end.should raise_error(Errno::ECONNREFUSED)
+  end
+
+  describe "with a running server" do
+    before :each do
+      @socket = nil
+    end
+
+    after :each do
+      if @socket
+        @socket.write "QUIT"
+        @socket.shutdown
+        @socket.close
+      end
+    end
+
+    it "silently ignores 'nil' as the third parameter" do
+      @socket = TCPSocket.send(@method, @hostname, SocketSpecs.port, nil)
+      @socket.should be_an_instance_of(TCPSocket)
+    end
+
+    it "connects to a listening server with host and port" do
+      @socket = TCPSocket.send(@method, @hostname, SocketSpecs.port)
+      @socket.should be_an_instance_of(TCPSocket)
+    end
+
+    it "connects to a server when passed local_host argument" do
+      @socket = TCPSocket.send(@method, @hostname, SocketSpecs.port, @hostname)
+      @socket.should be_an_instance_of(TCPSocket)
+    end
+
+    it "connects to a server when passed local_host and local_port arguments" do
+      @socket = TCPSocket.send(@method, @hostname, SocketSpecs.port,
+                               @hostname, SocketSpecs.local_port)
+      @socket.should be_an_instance_of(TCPSocket)
+    end
+
+    it "has an address once it has connected to a listening server" do
+      @socket = TCPSocket.send(@method, @hostname, SocketSpecs.port)
+      @socket.should be_an_instance_of(TCPSocket)
+
+      # TODO: Figure out how to abstract this. You can get AF_INET
+      # from 'Socket.getaddrinfo(hostname, nil)[0][3]' but socket.addr
+      # will return AF_INET6. At least this check will weed out clearly
+      # erroneous values.
+      @socket.addr[0].should =~ /^AF_INET6?/
+
+      case @socket.addr[0]
+      when 'AF_INET'
+        @socket.addr[3].should == SocketSpecs.addr(:ipv4)
+      when 'AF_INET6'
+        @socket.addr[3].should == SocketSpecs.addr(:ipv6)
+      end
+
+      @socket.addr[1].should be_kind_of(Fixnum)
+      @socket.addr[2].should =~ /^#{@hostname}/
+    end
+  end
+end

data/spec/udpsocket/bind_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+describe "UDPSocket.bind" do
+
+  before :each do
+    @socket = UDPSocket.new
+  end
+
+  after :each do
+    @socket.close unless @socket.closed?
+  end
+
+  it "binds the socket to a port" do
+    @socket.bind(SocketSpecs.hostname, SocketSpecs.port)
+
+    lambda { @socket.bind(SocketSpecs.hostname, SocketSpecs.port) }.should raise_error
+  end
+
+  it "receives a hostname and a port" do
+    @socket.bind(SocketSpecs.hostname, SocketSpecs.port)
+
+    port, host = Socket.unpack_sockaddr_in(@socket.getsockname)
+
+    host.should == "127.0.0.1"
+    port.should == SocketSpecs.port
+  end
+
+  it "binds to INADDR_ANY if the hostname is empty" do
+    @socket.bind("", SocketSpecs.port)
+    port, host = Socket.unpack_sockaddr_in(@socket.getsockname)
+    host.should == "0.0.0.0"
+  end
+end

data/spec/udpsocket/connect_spec.rb

@@ -0,0 +1 @@
+require File.expand_path('../../fixtures/classes', __FILE__)

data/spec/udpsocket/new_spec.rb

@@ -0,0 +1 @@
+require File.expand_path('../../fixtures/classes', __FILE__)

data/spec/udpsocket/open_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+describe "UDPSocket.open" do
+  after(:each) do
+    @socket.close if @socket && !@socket.closed?
+  end
+
+  it "allows calls to open without arguments" do
+    @socket = UDPSocket.open
+    @socket.should be_kind_of(UDPSocket)
+  end
+end