Enable tests for Socket::AF_UNIX on Windows

Author: trinistr

library/socket/basicsocket/getpeereid_spec.rb

@@ -2,7 +2,7 @@
 require_relative '../fixtures/classes'
 
 describe 'BasicSocket#getpeereid' do
-  with_feature :unix_socket do
+  platform_is_not :windows do
     describe 'using a UNIXSocket' do
       before do
         @path = SocketSpecs.socket_path

library/socket/shared/address.rb

@@ -164,11 +164,24 @@
         end
       end
 
-      it 'equals address of peer socket' do
-        if @method == :local_address
-          @addr.to_s.should == @b.remote_address.to_s
-        else
-          @addr.to_s.should == @b.local_address.to_s
+      platform_is_not :windows do
+        it 'equals address of peer socket' do
+          if @method == :local_address
+            @addr.to_s.should == @b.remote_address.to_s
+          else
+            @addr.to_s.should == @b.local_address.to_s
+          end
+        end
+      end
+
+      platform_is :windows do
+        it 'equals address of peer socket' do
+          if @method == :local_address
+            @addr.to_s.should == @b.remote_address.to_s
+          else
+            # see https://bugs.ruby-lang.org/issues/21702
+            @addr.unix_path.should == @b.local_address.unix_path
+          end
         end
       end
 

library/socket/spec_helper.rb

@@ -2,7 +2,7 @@
 require 'socket'
 
 MSpec.enable_feature :sock_packet if Socket.const_defined?(:SOCK_PACKET)
-MSpec.enable_feature :unix_socket unless PlatformGuard.windows?
+MSpec.enable_feature :unix_socket if Socket.const_defined?(:AF_UNIX)
 MSpec.enable_feature :udp_cork if Socket.const_defined?(:UDP_CORK)
 MSpec.enable_feature :tcp_cork if Socket.const_defined?(:TCP_CORK)
 MSpec.enable_feature :pktinfo if Socket.const_defined?(:IP_PKTINFO)

library/socket/unixserver/accept_spec.rb

@@ -111,10 +111,12 @@
             @socket.recv(5).should == 'hello'
           end
 
-          it "is set to nonblocking" do
-            require 'io/nonblock'
-            @socket = @server.accept
-            @socket.should.nonblock?
+          platform_is_not :windows do
+            it "is set to nonblocking" do
+              require 'io/nonblock'
+              @socket = @server.accept
+              @socket.should.nonblock?
+            end
           end
 
           it "is set to close on exec" do

library/socket/unixsocket/initialize_spec.rb

@@ -4,8 +4,17 @@
 with_feature :unix_socket do
   describe 'UNIXSocket#initialize' do
     describe 'using a non existing path' do
-      it 'raises Errno::ENOENT' do
-        -> { UNIXSocket.new(SocketSpecs.socket_path) }.should raise_error(Errno::ENOENT)
+      platform_is_not :windows do
+        it 'raises Errno::ENOENT' do
+          -> { UNIXSocket.new(SocketSpecs.socket_path) }.should raise_error(Errno::ENOENT)
+        end
+      end
+
+      platform_is :windows do
+        # Why, Windows, why?
+        it 'raises Errno::ECONNREFUSED' do
+          -> { UNIXSocket.new(SocketSpecs.socket_path) }.should raise_error(Errno::ECONNREFUSED)
+        end
       end
     end
 
@@ -34,15 +43,16 @@
         @socket.binmode?.should be_true
       end
 
-      it 'sets the socket to nonblock' do
-        require 'io/nonblock'
-        @socket.should.nonblock?
+      platform_is_not :windows do
+        it 'sets the socket to nonblock' do
+          require 'io/nonblock'
+          @socket.should.nonblock?
+        end
       end
 
       it 'sets the socket to close on exec' do
         @socket.should.close_on_exec?
       end
-
     end
   end
 end

library/socket/unixsocket/recv_io_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../spec_helper'
 require_relative '../fixtures/classes'
 
-with_feature :unix_socket do
+platform_is_not :windows do
   describe "UNIXSocket#recv_io" do
     before :each do
       @path = SocketSpecs.socket_path

library/socket/unixsocket/recvfrom_spec.rb

@@ -22,13 +22,43 @@
       sock.close
     end
 
-    it "returns an array with data and information on the sender" do
-      @client.send("foobar", 0)
-      sock = @server.accept
-      data = sock.recvfrom(6)
-      data.first.should == "foobar"
-      data.last.should == ["AF_UNIX", ""]
-      sock.close
+    platform_is_not :windows, :linux do
+      it "returns an array with data and information on the sender" do
+        @client.send("foobar", 0)
+        sock = @server.accept
+        data = sock.recvfrom(6)
+        data.should == ["foobar", ["AF_UNIX", ""]]
+        sock.close
+      end
+    end
+
+    platform_is :linux do
+      # It isn't clear which platforms support remote addresses here, so only Linux tests this.
+      it "returns an array with data and information on the sender" do
+        @client.send("foobar", 0)
+        sock = @server.accept
+        data = sock.recvfrom(6)
+        data.should == ["foobar", ["AF_UNIX", ""]]
+        sock.send("barfoo", 0)
+        data = @client.recvfrom(6)
+        data.should == ["barfoo", ["AF_UNIX", @server.local_address.unix_path]]
+        sock.close
+      end
+    end
+
+    platform_is :windows do
+      it "returns an Array containing the data and address information" do
+        # The second part of the address is a memory dump on Windows!
+        # See https://bugs.ruby-lang.org/issues/21702
+        @client.send("foobar", 0)
+        sock = @server.accept
+        data = sock.recvfrom(6)
+        (data in ["foobar", ["AF_UNIX", String]]).should be_true
+        sock.send("barfoo", 0)
+        data = @client.recvfrom(6)
+        (data in ["barfoo", ["AF_UNIX", String]]).should be_true
+        sock.close
+      end
     end
 
     it "allows an output buffer as third argument" do
@@ -54,15 +84,17 @@
       buffer.encoding.should == Encoding::ISO_8859_1
     end
 
-    it "uses different message options" do
-      @client.send("foobar", Socket::MSG_PEEK)
-      sock = @server.accept
-      peek_data = sock.recvfrom(6, Socket::MSG_PEEK) # Does not retrieve the message
-      real_data = sock.recvfrom(6)
+    platform_is_not :windows do
+      it "uses different message options" do
+        @client.send("foobar", Socket::MSG_PEEK)
+        sock = @server.accept
+        peek_data = sock.recvfrom(6, Socket::MSG_PEEK) # Does not retrieve the message
+        real_data = sock.recvfrom(6)
 
-      real_data.should == peek_data
-      peek_data.should == ["foobar", ["AF_UNIX", ""]]
-      sock.close
+        real_data.should == peek_data
+        peek_data.should == ["foobar", ["AF_UNIX", ""]]
+        sock.close
+      end
     end
   end
 
@@ -78,40 +110,52 @@
         @server.close
       end
 
-      it 'returns an Array containing the data and address information' do
-        @server.recvfrom(5).should == ['hello', ['AF_UNIX', '']]
+      platform_is_not :windows do
+        it 'returns an Array containing the data and address information' do
+          @server.recvfrom(5).should == ['hello', ['AF_UNIX', '']]
+        end
+      end
+
+      platform_is :windows do
+        it 'returns an Array containing the data and address information' do
+          # The second part of the address is a memory dump on Windows!
+          # See https://bugs.ruby-lang.org/issues/21702
+          (@server.recvfrom(5) in ['hello', ['AF_UNIX', String]]).should be_true
+        end
       end
     end
 
-    # These specs are taken from the rdoc examples on UNIXSocket#recvfrom.
-    describe 'using a UNIX socket constructed using UNIXSocket.for_fd' do
-      before do
-        @path1 = SocketSpecs.socket_path
-        @path2 = SocketSpecs.socket_path.chop + '2'
-        rm_r(@path2)
+    platform_is_not :windows do
+      # These specs are taken from the rdoc examples on UNIXSocket#recvfrom.
+      describe 'using a UNIX socket constructed using UNIXSocket.for_fd' do
+        before do
+          @path1 = SocketSpecs.socket_path
+          @path2 = SocketSpecs.socket_path.chop + '2'
+          rm_r(@path2)
 
-        @client_raw = Socket.new(:UNIX, :DGRAM)
-        @client_raw.bind(Socket.sockaddr_un(@path1))
+          @client_raw = Socket.new(:UNIX, :DGRAM)
+          @client_raw.bind(Socket.sockaddr_un(@path1))
 
-        @server_raw = Socket.new(:UNIX, :DGRAM)
-        @server_raw.bind(Socket.sockaddr_un(@path2))
+          @server_raw = Socket.new(:UNIX, :DGRAM)
+          @server_raw.bind(Socket.sockaddr_un(@path2))
 
-        @socket = UNIXSocket.for_fd(@server_raw.fileno)
-        @socket.autoclose = false
-      end
+          @socket = UNIXSocket.for_fd(@server_raw.fileno)
+          @socket.autoclose = false
+        end
 
-      after do
-        @client_raw.close
-        @server_raw.close # also closes @socket
+        after do
+          @client_raw.close
+          @server_raw.close # also closes @socket
 
-        rm_r @path1
-        rm_r @path2
-      end
+          rm_r @path1
+          rm_r @path2
+        end
 
-      it 'returns an Array containing the data and address information' do
-        @client_raw.send('hello', 0, Socket.sockaddr_un(@path2))
+        it 'returns an Array containing the data and address information' do
+          @client_raw.send('hello', 0, Socket.sockaddr_un(@path2))
 
-        @socket.recvfrom(5).should == ['hello', ['AF_UNIX', @path1]]
+          @socket.recvfrom(5).should == ['hello', ['AF_UNIX', @path1]]
+        end
       end
     end
   end

library/socket/unixsocket/send_io_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../spec_helper'
 require_relative '../fixtures/classes'
 
-with_feature :unix_socket do
+platform_is_not :windows do
   describe "UNIXSocket#send_io" do
     before :each do
       @path = SocketSpecs.socket_path

library/socket/unixsocket/shared/pair.rb

@@ -12,18 +12,37 @@
     @s2.gets.should == "foo\n"
   end
 
-  it "sets the socket paths to empty Strings" do
-    @s1.path.should == ""
-    @s2.path.should == ""
-  end
+  platform_is_not :windows do
+    it "sets the socket paths to empty Strings" do
+      @s1.path.should == ""
+      @s2.path.should == ""
+    end
+
+    it "sets the socket addresses to empty Strings" do
+      @s1.addr.should == ["AF_UNIX", ""]
+      @s2.addr.should == ["AF_UNIX", ""]
+    end
 
-  it "sets the socket addresses to empty Strings" do
-    @s1.addr.should == ["AF_UNIX", ""]
-    @s2.addr.should == ["AF_UNIX", ""]
+    it "sets the socket peer addresses to empty Strings" do
+      @s1.peeraddr.should == ["AF_UNIX", ""]
+      @s2.peeraddr.should == ["AF_UNIX", ""]
+    end
   end
 
-  it "sets the socket peer addresses to empty Strings" do
-    @s1.peeraddr.should == ["AF_UNIX", ""]
-    @s2.peeraddr.should == ["AF_UNIX", ""]
+  platform_is :windows do
+    it "emulates unnamed sockets with a temporary file with a path" do
+      @s1.path.match?(/\\AppData\\Local\\Temp\\\d+-\d+\.\(\$\)\z/).should be_true
+      @s1.addr.should == ["AF_UNIX", @s1.path]
+      @s2.peeraddr.should == ["AF_UNIX", @s1.path]
+    end
+
+    it "sets the peer address of first socket to an empty string" do
+      @s1.peeraddr.should == ["AF_UNIX", ""]
+    end
+
+    it "sets the address and path of second socket to an empty string" do
+      @s2.addr.should == ["AF_UNIX", ""]
+      @s2.path.should == ""
+    end
   end
 end