[Ruby 3.2] Enable most tests for Socket::AF_UNIX and test for File.socket? on Windows #1300

trinistr · 2025-11-12T20:34:45Z

Add support for UNIXSocket on Windows. Emulate anonymous sockets. Add
support for File.socket? and File::Stat#socket? where possible.
[Feature #19135]

Enable test for File.socket?
- Move tests to the shared spec as it was supposed to be, so FileTest.socket? is actually tested.
- Include a real test with #to_path.
Enable most tests in 'socket' library.

Following things are not supported so the tests are disabled:

#send_io, #recv_io,
DGRAM sockets (tests probably can be rewritten using STREAM sockets?),
SEQPACKET sockets (non-block stuff),
#getpeerid (UNIX IDs),
message flags (maybe some are supported, I don't know, documentation seems to be the blog post).

Socket pairs are emulated using a temporary file (ruby/ruby#6513 (comment)), so the behavior is different. Trying to create a Socket using a non-existent path raises a different error for whatever reason.

There are a couple bugs, reported as https://bugs.ruby-lang.org/issues/21702:

#remote_address.to_s returns 110 bytes always;
#recvfrom returns 2047 bytes of garbage as the remote address.

trinistr · 2025-11-21T18:39:16Z

library/socket/unixsocket/recvfrom_spec.rb

+          @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))


It probably should be possible to rewrite this using :STREAM sockets but just changing the type doesn't work.

library/socket/spec_helper.rb

andrykonchin · 2025-11-21T19:27:44Z

library/socket/shared/address.rb

+          else
+            # see https://bugs.ruby-lang.org/issues/21702
+            @addr.unix_path.should == @b.local_address.unix_path
+          end


There is a special guard ruby_bug for such cases. It will not run a guarded test case on MRI but will on other Ruby implementations

From the contributing guide (#13669 is an id of the corresponding reported issue):

ruby_bug '#13669', ''...'3.2' do it "works like this" do # Specify the expected behavior here, not the bug end end

Ah, forgot about it. Though, the guide says "If [bugfix] is not backported or not likely, use ruby_version_is instead." (I don't understand the point about backporting? It will still be some minimum version.), and in any case version to expect the fix in is unknown currently. Does this PR need to be parked until someone can get on the bug?

ruby_bug guard indicates that there is no any value for alternative Ruby implementations to follow the current CRuby's incorrect behaviour. If an issue isn't being fixed in CRuby and backported to the supported versions - this behaviour becomes a feature so alternative implementations need to implement it as well.

In this case it's definitely a bug and I suppose it will be fixed very soon.

Does this PR need to be parked until someone can get on the bug?

No.

As I wrote above the ruby_bug guard prevents running this case on CRuby so CI will be green. After fixing and backporting the guard is supposed to be removed. And the next release version (4.0) can be used temporary as a fixed Ruby version.

Thank you for the clarification!

andrykonchin · 2025-11-21T19:41:12Z

library/socket/unixsocket/recvfrom_spec.rb

+        data = @client.recvfrom(6)
+        (data in ["barfoo", ["AF_UNIX", String]]).should be_true
+        sock.close
+      end


ditto ruby_bug

andrykonchin · 2025-11-21T20:45:09Z

library/socket/unixsocket/recvfrom_spec.rb

+        data.should == ["barfoo", ["AF_UNIX", @server.local_address.unix_path]]
+        sock.close
+      end
+    end


suggestion: may be it makes sense to have separate cases for recvfrom called on a client and on a server socket.

I've separated them, but can't say that it is definitely better. It's interesting that tests for recvfrom on other socket types usually just ignore the address part, so who knows what lurks there.

andrykonchin · 2025-11-21T20:46:21Z

library/socket/unixsocket/recvfrom_spec.rb

+    end
+
+    platform_is :linux do
+      # It isn't clear which platforms support remote addresses here, so only Linux tests this.


I think it's OK to remove the guard. If it passes on CRuby CI then it's completely fine.

It won't pass, as at least OSX does not implement this.

I see. It may be better to specify it explicitly with platform_is_not :windows, :darwin (as far as CRuby's CI uses only Linux, macOS and Windows). If specs are run on other platforms I suppose mainterners of Ruby package will let us know that there are failing tests.

andrykonchin · 2025-11-21T20:47:02Z

library/socket/unixsocket/recvfrom_spec.rb

+          # 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


core/filetest/socket_spec.rb

library/socket/spec_helper.rb

Previously, it was just a fancy :windows platform guard. Unix sockets are now mostly implemented on Windows, making the feature useless.

trinistr force-pushed the 3.2-unixsocket-windows branch 7 times, most recently from f3ec3c8 to f87cf33 Compare November 21, 2025 17:06

Enable File.socket? test on Windows, improve FileTest.socket?

84bd439

trinistr force-pushed the 3.2-unixsocket-windows branch 4 times, most recently from 51d1c32 to 8092a25 Compare November 21, 2025 18:36

trinistr commented Nov 21, 2025

View reviewed changes

library/socket/spec_helper.rb Outdated Show resolved Hide resolved

trinistr marked this pull request as ready for review November 21, 2025 18:41

andrykonchin reviewed Nov 21, 2025

View reviewed changes

Enable tests for Socket::AF_UNIX on Windows

dceeddb

trinistr force-pushed the 3.2-unixsocket-windows branch from 8092a25 to ba50fc1 Compare November 22, 2025 11:46

Remove :unix_socket feature as it's no longer needed

1d0c365

Previously, it was just a fancy :windows platform guard. Unix sockets are now mostly implemented on Windows, making the feature useless.

trinistr force-pushed the 3.2-unixsocket-windows branch from ba50fc1 to 1d0c365 Compare November 22, 2025 11:50

Uh oh!

[Ruby 3.2] Enable most tests for Socket::AF_UNIX and test for File.socket? on Windows #1300

Are you sure you want to change the base?

[Ruby 3.2] Enable most tests for Socket::AF_UNIX and test for File.socket? on Windows #1300

Conversation

trinistr commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

trinistr Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trinistr Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

trinistr commented Nov 12, 2025 •

edited

Loading

trinistr Nov 21, 2025 •

edited

Loading

trinistr Nov 21, 2025 •

edited

Loading