zeroconf 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c389ff9fea665db344da8713c4cb1e3a8af014eee5c7fef1201dba139b6e8ea6
-  data.tar.gz: 340781dbba64cef0228016f79685d4f48de201c6aacd9df16da502dadcec492c
+  metadata.gz: 39d1c369a77bb16908b77e600e166c264662ec1fc624de8aee2f62fc752e3aae
+  data.tar.gz: 6f58a84ef9926d9e900182390249b6b029312332a7376cc1f1229b182812bb59
 SHA512:
-  metadata.gz: '0928363c430656e6d72454462d2d53e265073abb83c54b405161fe48342825c10400fe6038c6265558c1471bb48e070917b1a44fc8854b5c4446b5f024c73caa'
-  data.tar.gz: a59a327c0bd4391c1511b5367d642e498f56e528c3881e17b4861a06a79398f59771ea1fce76ad17e7762e74b141e854b144cc5fd1b2e91ec33281f41dbedde6
+  metadata.gz: 5a515ce4490d93f37439bec362b84a6bb99c4d42098892f8250d9059537984c9ac6f0c90e9cbf005374f0fdb9abd0a78cb4fd2f7b54e87e05f8acce6eee892cb
+  data.tar.gz: be3a38c8bfab29934aca1d2d1100fa4fdda4aa7bfc8c31fe095a461337cffc67b44ac1d982c2faf8f6131891c9eee1a9d444932fa5899b353b0f12e9b8968210

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [ head, 3.2  ]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake test

data/lib/zeroconf/browser.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "zeroconf/client"
+
+module ZeroConf
+  class Browser < Client
+    private
+
+    def get_query
+      q = PTR.new(name)
+      query = Resolv::DNS::Message.new 0
+      query.add_question q.name, q.class
+      query
+    end
+  end
+end

data/lib/zeroconf/client.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "zeroconf/utils"
+
+module ZeroConf
+  class Client
+    include Utils
+
+    attr_reader :name, :interfaces
+
+    def initialize name, interfaces: ZeroConf.interfaces
+      @name = name
+      @interfaces = interfaces
+    end
+
+    def run timeout: 3
+      sockets = open_interfaces interfaces.map(&:addr), Resolv::MDNS::Port
+
+      query = get_query
+      sockets.each { |socket| multicast_send(socket, query.encode) }
+
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      now = start
+      msgs = block_given? ? nil : []
+
+      loop do
+        wait = timeout && timeout - (now - start)
+        return if wait && wait < 0
+
+        readers, = IO.select(sockets, [], [], wait)
+
+        return msgs unless readers
+
+        readers.each do |reader|
+          buf, _ = reader.recvfrom 2048
+          msg = Resolv::DNS::Message.decode(buf)
+          # only yield replies to this question
+          if interested? msg
+            if block_given?
+              if :done == yield(msg)
+                return msg
+              end
+            else
+              msgs << msg
+            end
+          end
+        end
+        now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    ensure
+      sockets.each(&:close) if sockets
+    end
+
+    private
+
+    def interested? _; true; end
+
+    def open_interfaces addrs, port
+      addrs.map { |addr|
+        if addr.ipv4?
+          open_ipv4 addr, port
+        else
+          open_ipv6 addr, port
+        end
+      }.compact
+    end
+  end
+end

data/lib/zeroconf/discoverer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "zeroconf/client"
+
+module ZeroConf
+  class Discoverer < Client
+    DISCOVER_QUERY = Resolv::DNS::Message.new 0
+    DISCOVER_QUERY.add_question DISCOVERY_NAME, PTR
+
+    def initialize interfaces: ZeroConf.interfaces
+      super(nil, interfaces:)
+    end
+
+    private
+
+    def interested? msg
+      msg.question.length > 0 && msg.question.first.last == PTR
+    end
+
+    def get_query
+      DISCOVER_QUERY
+    end
+  end
+end

data/lib/zeroconf/resolver.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "zeroconf/client"
+
+module ZeroConf
+  class Resolver < Client
+    private
+
+    def get_query
+      query = Resolv::DNS::Message.new 0
+      query.add_question Resolv::DNS::Name.create(name), A
+      query
+    end
+  end
+end

data/lib/zeroconf/service.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require "zeroconf/utils"
+
 module ZeroConf
   class Service
+    include Utils
+
     attr_reader :service, :service_port, :hostname, :service_interfaces,
       :service_name, :qualified_host, :text
 
@@ -13,9 +17,12 @@ module ZeroConf
       @service_name = "#{hostname}.#{service}"
       @qualified_host = "#{hostname}.local."
       @text = text
+      @started = false
       @rd, @wr = IO.pipe
     end
 
+    def started?; @started; end
+
     def announcement
       msg = Resolv::DNS::Message.new(0)
       msg.qr = 1
@@ -80,11 +87,10 @@ module ZeroConf
       msg
     end
 
-    include Utils
-
     def stop
       @wr.write "x"
       @wr.close
+      @started = false
     end
 
     def start
@@ -97,6 +103,8 @@ module ZeroConf
       # announce
       multicast_send(sock, msg.encode)
 
+      @started = true
+
       loop do
         readers, = IO.select(sockets, [], [])
         next unless readers
@@ -114,7 +122,9 @@ module ZeroConf
 
             break unless class_type == 1 || class_type == 255
 
-            unicast = type::ClassValue & PTR::MDNS_UNICAST_RESPONSE > 0
+            legacy = from[1] != Resolv::MDNS::Port
+            unicast = legacy || type::ClassValue & PTR::MDNS_UNICAST_RESPONSE > 0
+            reply_id = legacy ? msg.id : 0
 
             qn = name.to_s + "."
 
@@ -123,25 +133,25 @@ module ZeroConf
               break if has_flags
 
               if unicast
-                dnssd_unicast_answer
+                dnssd_unicast_answer(id: reply_id, legacy: legacy)
               else
                 dnssd_multicast_answer
               end
             when service
               if unicast
-                service_unicast_answer
+                service_unicast_answer(id: reply_id, legacy: legacy)
               else
                 service_multicast_answer
               end
             when service_name
               if unicast
-                service_instance_unicast_answer
+                service_instance_unicast_answer(id: reply_id, legacy: legacy)
               else
                 service_instance_multicast_answer
               end
             when qualified_host
               if unicast
-                name_answer_unicast
+                name_answer_unicast(id: reply_id, legacy: legacy)
               else
                 name_answer_multicast
               end
@@ -162,16 +172,17 @@ module ZeroConf
         end
       end
     ensure
-      multicast_send sock, disconnect_msg.encode
-      sockets.map(&:close)
+      multicast_send(sock, disconnect_msg.encode) if sock
+      sockets.map(&:close) if sockets
     end
 
     private
 
-    def service_instance_unicast_answer
+    def service_instance_unicast_answer(id:, legacy:)
       msg = Resolv::DNS::Message.new(0)
       msg.qr = 1
       msg.aa = 1
+      msg.id = id
 
       service_interfaces.each do |iface|
         if iface.addr.ipv4?
@@ -191,15 +202,16 @@ module ZeroConf
           Resolv::DNS::Resource::IN::TXT.new(*@text)
       end
       msg.add_answer service_name, 10, Resolv::DNS::Resource::IN::SRV.new(0, 0, service_port, qualified_host)
-      msg.add_question service_name, ZeroConf::MDNS::Announce::IN::SRV
+      msg.add_question service_name, legacy ? Resolv::DNS::Resource::IN::SRV : MDNS::Announce::IN::SRV
 
       msg
     end
 
-    def service_unicast_answer
+    def service_unicast_answer(id:, legacy:)
       msg = Resolv::DNS::Message.new(0)
       msg.qr = 1
       msg.aa = 1
+      msg.id = id
 
       msg.add_additional service_name, 10, Resolv::DNS::Resource::IN::SRV.new(0, 0, service_port, qualified_host)
 
@@ -225,20 +237,21 @@ module ZeroConf
         10,
         Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(service_name))
 
-      msg.add_question service, ZeroConf::PTR
+      msg.add_question service, legacy ? Resolv::DNS::Resource::IN::PTR : PTR
 
       msg
     end
 
-    def dnssd_unicast_answer
+    def dnssd_unicast_answer(id:, legacy:)
       msg = Resolv::DNS::Message.new(0)
       msg.qr = 1
       msg.aa = 1
+      msg.id = id
 
       msg.add_answer DISCOVERY_NAME, 10,
         Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(service))
 
-      msg.add_question DISCOVERY_NAME, ZeroConf::PTR
+      msg.add_question DISCOVERY_NAME, legacy ? Resolv::DNS::Resource::IN::PTR : PTR
       msg
     end
 
@@ -312,10 +325,11 @@ module ZeroConf
       msg
     end
 
-    def name_answer_unicast
+    def name_answer_unicast(id:, legacy:)
       msg = Resolv::DNS::Message.new(0)
       msg.qr = 1
       msg.aa = 1
+      msg.id = id
 
       first = true
 
@@ -344,7 +358,7 @@ module ZeroConf
         end
       end
 
-      msg.add_question qualified_host, ZeroConf::MDNS::Announce::IN::A
+      msg.add_question qualified_host, legacy ? Resolv::DNS::Resource::IN::A : MDNS::Announce::IN::A
 
       if @text
         msg.add_additional service_name,

data/lib/zeroconf/utils.rb

@@ -4,15 +4,61 @@ require "socket"
 require "ipaddr"
 require "fcntl"
 require "resolv"
+require "rbconfig"
 
 module ZeroConf
+  MDNS_CACHE_FLUSH = 0x8000
+
+  # :stopdoc:
+  class PTR < Resolv::DNS::Resource::IN::PTR
+    MDNS_UNICAST_RESPONSE = 0x8000
+
+    ClassValue = Resolv::DNS::Resource::IN::ClassValue | MDNS_UNICAST_RESPONSE
+    ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
+  end
+
+  class ANY < Resolv::DNS::Resource::IN::ANY
+    MDNS_UNICAST_RESPONSE = 0x8000
+
+    ClassValue = Resolv::DNS::Resource::IN::ClassValue | MDNS_UNICAST_RESPONSE
+    ::Resolv::DNS::Resource::ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
+  end
+
+  class A < Resolv::DNS::Resource::IN::A
+    MDNS_UNICAST_RESPONSE = 0x8000
+
+    ClassValue = Resolv::DNS::Resource::IN::ClassValue | MDNS_UNICAST_RESPONSE
+    ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
+  end
+
+  class SRV < Resolv::DNS::Resource::IN::SRV
+    MDNS_UNICAST_RESPONSE = 0x8000
+
+    ClassValue = Resolv::DNS::Resource::IN::ClassValue | MDNS_UNICAST_RESPONSE
+    ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
+  end
+
+  module MDNS
+    module Announce
+      module IN
+        [:SRV, :A, :AAAA, :TXT].each do |name|
+          const_set(name, Class.new(Resolv::DNS::Resource::IN.const_get(name)) {
+            const_set(:ClassValue, superclass::ClassValue | MDNS_CACHE_FLUSH)
+            self::ClassHash[[self::TypeValue, self::ClassValue]] = self
+          })
+        end
+      end
+    end
+  end
+  # :startdoc:
+
   module Utils
     DISCOVERY_NAME = "_services._dns-sd._udp.local."
 
     def open_ipv4 saddr, port
       sock = UDPSocket.new Socket::AF_INET
       sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true)
-      sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEPORT, true)
+      sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEPORT, true) unless RbConfig::CONFIG["host_os"].include?("linux")
       sock.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, true)
       sock.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_LOOP, true)
       sock.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP,
@@ -29,14 +75,22 @@ module ZeroConf
 
     def multicast_send sock, query
       dest = if sock.local_address.ipv4?
-        BROADCAST_V4
+        broadcast_v4
       else
-        BROADCAST_V6
+        broadcast_v6
       end
 
       sock.send(query, 0, dest)
     end
 
+    def broadcast_v4
+      BROADCAST_V4
+    end
+
+    def broadcast_v6
+      BROADCAST_V6
+    end
+
     def unicast_send sock, data, to
       sock.send(data, 0, Addrinfo.new(to))
     end
@@ -44,7 +98,7 @@ module ZeroConf
     def open_ipv6 saddr, port
       sock = UDPSocket.new Socket::AF_INET6
       sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true)
-      sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEPORT, true)
+      sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEPORT, true) unless RbConfig::CONFIG["host_os"].include?("linux")
       sock.setsockopt(Socket::IPPROTO_IPV6, Socket::IPV6_MULTICAST_HOPS, true)
       sock.setsockopt(Socket::IPPROTO_IPV6, Socket::IPV6_MULTICAST_LOOP, true)
 

data/lib/zeroconf/version.rb

@@ -1,3 +1,3 @@
 module ZeroConf
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/zeroconf.rb

@@ -1,60 +1,12 @@
 # frozen_string_literal: true
 
-require "zeroconf/utils"
 require "zeroconf/service"
+require "zeroconf/browser"
+require "zeroconf/resolver"
+require "zeroconf/discoverer"
 
 module ZeroConf
-  MDNS_CACHE_FLUSH = 0x8000
-
-  extend Utils
-  include Utils
-
-  # :stopdoc:
-  class PTR < Resolv::DNS::Resource::IN::PTR
-    MDNS_UNICAST_RESPONSE = 0x8000
-
-    ClassValue = Resolv::DNS::Resource::IN::ClassValue | MDNS_UNICAST_RESPONSE
-    ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
-  end
-
-  class ANY < Resolv::DNS::Resource::IN::ANY
-    MDNS_UNICAST_RESPONSE = 0x8000
-
-    ClassValue = Resolv::DNS::Resource::IN::ClassValue | MDNS_UNICAST_RESPONSE
-    ::Resolv::DNS::Resource::ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
-  end
-
-  class A < Resolv::DNS::Resource::IN::A
-    MDNS_UNICAST_RESPONSE = 0x8000
-
-    ClassValue = Resolv::DNS::Resource::IN::ClassValue | MDNS_UNICAST_RESPONSE
-    ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
-  end
-
-  class SRV < Resolv::DNS::Resource::IN::SRV
-    MDNS_UNICAST_RESPONSE = 0x8000
-
-    ClassValue = Resolv::DNS::Resource::IN::ClassValue | MDNS_UNICAST_RESPONSE
-    ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
-  end
-
-  module MDNS
-    module Announce
-      module IN
-        [:SRV, :A, :AAAA, :TXT].each do |name|
-          const_set(name, Class.new(Resolv::DNS::Resource::IN.const_get(name)) {
-            const_set(:ClassValue, superclass::ClassValue | MDNS_CACHE_FLUSH)
-            self::ClassHash[[self::TypeValue, self::ClassValue]] = self
-          })
-        end
-      end
-    end
-  end
-
-  DISCOVER_QUERY = Resolv::DNS::Message.new 0
-  DISCOVER_QUERY.add_question DISCOVERY_NAME, PTR
-
-  # :startdoc:
+  #include Utils
 
   ##
   # ZeroConf.browse
@@ -72,45 +24,8 @@ module ZeroConf
   # @param [Array<Socket::Ifaddr>] interfaces list of interfaces to query
   # @param [Numeric] timeout number of seconds before returning
   def self.browse name, interfaces: self.interfaces, timeout: 3, &blk
-    port = 0
-    sockets = interfaces.map { |iface|
-      if iface.addr.ipv4?
-        open_ipv4 iface.addr, port
-      else
-        open_ipv6 iface.addr, port
-      end
-    }.compact
-
-    q = PTR.new(name)
-
-    sockets.each { |socket|
-      query = Resolv::DNS::Message.new 0
-
-      query.add_question q.name, q.class
-
-      multicast_send socket, query.encode
-    }
-
-    start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    now = start
-    msgs = block_given? ? nil : []
-
-    loop do
-      readers, = IO.select(sockets, [], [], timeout - (now - start))
-      return msgs unless readers
-      readers.each do |reader|
-        buf, = reader.recvfrom 2048
-        msg = Resolv::DNS::Message.decode(buf)
-        if block_given?
-          return msg if :done == yield(msg)
-        else
-          msgs << msg
-        end
-      end
-      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    end
-  ensure
-    sockets.map(&:close) if sockets
+    browser = ZeroConf::Browser.new(name, interfaces:)
+    browser.run(timeout:, &blk)
   end
 
   ###
@@ -131,7 +46,6 @@ module ZeroConf
       port = nil
       ipv4 = []
       ipv6 = []
-      pp r
       r.additional.each { |name, ttl, data|
         case data
         when Resolv::DNS::Resource::IN::SRV
@@ -149,37 +63,8 @@ module ZeroConf
   end
 
   def self.resolve name, interfaces: self.interfaces, timeout: 3, &blk
-    port = 0
-    sockets = interfaces.map { |iface|
-      if iface.addr.ipv4?
-        open_ipv4 iface.addr, port
-      else
-        open_ipv6 iface.addr, port
-      end
-    }.compact
-
-    query = Resolv::DNS::Message.new 0
-    query.add_question Resolv::DNS::Name.create(name), A
-
-    sockets.each do |sock|
-      multicast_send sock, query.encode
-    end
-
-    start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    now = start
-
-    loop do
-      readers, = IO.select(sockets, [], [], timeout - (now - start))
-      return unless readers
-      readers.each do |reader|
-        buf, = reader.recvfrom 2048
-        msg = Resolv::DNS::Message.decode(buf)
-        return msg if :done == yield(msg)
-      end
-      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    end
-  ensure
-    sockets.map(&:close) if sockets
+    resolver = ZeroConf::Resolver.new(name, interfaces:)
+    resolver.run(timeout:, &blk)
   end
 
   def self.service service, service_port, hostname = Socket.gethostname, service_interfaces: self.service_interfaces, text: [""]
@@ -222,46 +107,9 @@ module ZeroConf
   #
   # @param [Array<Socket::Ifaddr>] interfaces list of interfaces to query
   # @param [Numeric] timeout number of seconds before returning
-  def self.discover interfaces: self.interfaces, timeout: 3
-    port = 0
-
-    sockets = interfaces.map { |iface|
-      if iface.addr.ipv4?
-        open_ipv4 iface.addr, port
-      else
-        open_ipv6 iface.addr, port
-      end
-    }.compact
-
-    discover_query = DISCOVER_QUERY
-    sockets.each { |socket| multicast_send(socket, discover_query.encode) }
-
-    start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    now = start
-    msgs = nil
-
-    loop do
-      readers, = IO.select(sockets, [], [], timeout && (timeout - (now - start)))
-      return msgs unless readers
-      readers.each do |reader|
-        buf, _ = reader.recvfrom 2048
-        msg = Resolv::DNS::Message.decode(buf)
-        # only yield replies to this question
-        if msg.question.length > 0 && msg.question.first.last == PTR
-          if block_given?
-            if :done == yield(msg)
-              return msg
-            end
-          else
-            msgs ||= []
-            msgs << msg
-          end
-        end
-      end
-      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    end
-  ensure
-    sockets.each(&:close) if sockets
+  def self.discover interfaces: self.interfaces, timeout: 3, &blk
+    discoverer = ZeroConf::Discoverer.new(interfaces:)
+    discoverer.run(timeout:, &blk)
   end
 
   def self.interfaces
@@ -282,7 +130,4 @@ module ZeroConf
     ipv4, ipv6 = interfaces.partition { |ifa| ifa.addr.ipv4? }
     [ipv4.first, ipv6&.first].compact
   end
-
-  private_class_method def self.multiquery_send sock, queries, query_id
-  end
 end

data/test/client_test.rb

@@ -12,6 +12,7 @@ module ZeroConf
     def test_resolve
       s = make_server iface, "coolhostname"
       runner = Thread.new { s.start }
+      Thread.pass until s.started?
       found = nil
 
       name = "coolhostname.local"
@@ -28,12 +29,13 @@ module ZeroConf
       runner.join
 
       assert found
-      assert_in_delta 3, took, 0.1
+      assert_in_delta 3, took, 0.2
     end
 
     def test_resolve_returns_early
       s = make_server iface, "coolhostname"
       runner = Thread.new { s.start }
+      Thread.pass until s.started?
       found = nil
 
       name = "coolhostname.local"
@@ -57,6 +59,7 @@ module ZeroConf
     def test_discover_works
       s = make_server iface
       runner = Thread.new { s.start }
+      Thread.pass until s.started?
       found = nil
 
       took = time_it do
@@ -71,12 +74,13 @@ module ZeroConf
       runner.join
 
       assert found
-      assert_in_delta 3, took, 0.1
+      assert_in_delta 3, took, 0.2
     end
 
     def test_discover_return_early
       s = make_server iface
       runner = Thread.new { s.start }
+      Thread.pass until s.started?
       found = nil
 
       took = time_it do
@@ -97,11 +101,12 @@ module ZeroConf
     def test_browse
       s = make_server iface
       runner = Thread.new { s.start }
+      Thread.pass until s.started?
       found = nil
 
       took = time_it do
         ZeroConf.browse SERVICE do |msg|
-          if msg.question.find { |name, type| name.to_s == SERVICE && type == ZeroConf::PTR }
+          if msg.question.find { |name, type| name.to_s == SERVICE && type == PTR }
             found = msg
           end
         end
@@ -112,17 +117,18 @@ module ZeroConf
 
       assert found
       assert_equal Resolv::DNS::Name.create(SERVICE_NAME + "."), found.answer.first.last.name
-      assert_in_delta 3, took, 0.1
+      assert_in_delta 3, took, 0.2
     end
 
     def test_browse_returns_early
       s = make_server iface
       runner = Thread.new { s.start }
+      Thread.pass until s.started?
       found = nil
 
       took = time_it do
         found = ZeroConf.browse SERVICE do |msg|
-          if msg.question.find { |name, type| name.to_s == SERVICE && type == ZeroConf::PTR }
+          if msg.question.find { |name, type| name.to_s == SERVICE && type == PTR }
             :done
           end
         end

data/test/helper.rb

@@ -3,6 +3,30 @@ ENV["MT_NO_PLUGINS"] = "1"
 require "minitest/autorun"
 require "zeroconf"
 
+Thread.abort_on_exception = true
+
+class NotParallel
+  def self.start; end
+  def self.shutdown; end
+end
+
+Minitest.parallel_executor = NotParallel
+
+Thread.new do
+  # this test suite shouldn't take any more than 60 seconds
+  sleep 60
+
+  Thread.list.each do |t|
+    next if t == Thread.current
+    puts "#" * 90
+    p t
+    puts t.backtrace
+    puts "#" * 90
+  end
+
+  exit!
+end
+
 module ZeroConf
   class Test < Minitest::Test
     SERVICE = "_test-mdns._tcp.local"
@@ -25,6 +49,7 @@ module ZeroConf
     def make_listener rd, q
       Thread.new do
         sock = open_ipv4 Addrinfo.new(Socket.sockaddr_in(Resolv::MDNS::Port, Socket::INADDR_ANY)), Resolv::MDNS::Port
+        Thread.current[:started] = true
         loop do
           readers, = IO.select([sock, rd])
           read = readers.first

data/test/service_test.rb

@@ -29,13 +29,14 @@ module ZeroConf
     def test_unicast_service_instance_answer
       s = make_server iface
       runner = Thread.new { s.start }
+      Thread.pass until s.started?
 
-      query = Resolv::DNS::Message.new 0
-      query.add_question "tc-lan-adapter._test-mdns._tcp.local.", ZeroConf::SRV
+      query = Resolv::DNS::Message.new 10
+      query.add_question "tc-lan-adapter._test-mdns._tcp.local.", SRV
 
-      sock = open_ipv4 iface.addr, 0
+      sock = open_ipv4 iface.addr, Resolv::MDNS::Port
       multicast_send sock, query.encode
-      res = Resolv::DNS::Message.decode sock.recvfrom(2048).first
+      res = Resolv::DNS::Message.decode read_with_timeout(sock).first
       s.stop
       runner.join
 
@@ -51,7 +52,38 @@ module ZeroConf
         10,
         Resolv::DNS::Resource::IN::TXT.new(*s.text)
       expected.add_answer s.service_name, 10, Resolv::DNS::Resource::IN::SRV.new(0, 0, s.service_port, s.qualified_host)
-      expected.add_question s.service_name, ZeroConf::MDNS::Announce::IN::SRV
+      expected.add_question s.service_name, MDNS::Announce::IN::SRV
+
+      assert_equal expected, res
+    end
+
+    def test_legacy_unicast_service_instance_answer
+      s = make_server iface
+      runner = Thread.new { s.start }
+      Thread.pass until s.started?
+
+      query = Resolv::DNS::Message.new 10
+      query.add_question "tc-lan-adapter._test-mdns._tcp.local.", Resolv::DNS::Resource::IN::SRV
+
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+      res = Resolv::DNS::Message.decode read_with_timeout(sock).first
+      s.stop
+      runner.join
+
+      expected = Resolv::DNS::Message.new(10)
+      expected.qr = 1
+      expected.aa = 1
+
+      expected.add_additional s.qualified_host,
+        10,
+        Resolv::DNS::Resource::IN::A.new(iface.addr.ip_address)
+
+      expected.add_additional s.service_name,
+        10,
+        Resolv::DNS::Resource::IN::TXT.new(*s.text)
+      expected.add_answer s.service_name, 10, Resolv::DNS::Resource::IN::SRV.new(0, 0, s.service_port, s.qualified_host)
+      expected.add_question s.service_name, Resolv::DNS::Resource::IN::SRV
 
       assert_equal expected, res
     end
@@ -63,10 +95,11 @@ module ZeroConf
       listen = make_listener rd, q
       s = make_server iface
       server = Thread.new { s.start }
+      Thread.pass until s.started?
 
-      query = Resolv::DNS::Message.new 0
+      query = Resolv::DNS::Message.new 10
       query.add_question "_services._dns-sd._udp.local.", Resolv::DNS::Resource::IN::PTR
-      sock = open_ipv4 iface.addr, 0
+      sock = open_ipv4 iface.addr, Resolv::MDNS::Port
       multicast_send sock, query.encode
 
       while res = q.pop
@@ -91,32 +124,91 @@ module ZeroConf
     end
 
     def test_announcement
-      ann = "\x00\x00\x84\x00\x00\x00\x00\x01\x00\x00\x00\x04\n_test-mdns\x04_tcp\x05local\x00\x00\f\x00\x01\x00\x00\x00<\x00\x15\x0Etc-lan-adapter\x03lan\xC0\f\xC0-\x00!\x80\x01\x00\x00\x00<\x00 \x00\x00\x00\x00\xA5\xB8\x0Etc-lan-adapter\x03lan\x05local\x00\xC0T\x00\x01\x80\x01\x00\x00\x00<\x00\x04\n\x00\x01\x95\xC0T\x00\x1C\x80\x01\x00\x00\x00<\x00\x10\xFD\xDA\x85k\tL\x00\x00\x10\xF6\x892\xEA\xBB\\H\xC0-\x00\x10\x80\x01\x00\x00\x00<\x00\x01\x00".b
-      msg = Resolv::DNS::Message.decode ann
+      # FIXME: this test should be converted to an integration test.
+      # We need to make a client listen for the announcement and then decode that
       service = Service.new "_test-mdns._tcp.local.", 42424
+
+      msg = Resolv::DNS::Message.new(0)
+      msg.qr = 1
+      msg.aa = 1
+
+      msg.add_additional service.service_name, 60, MDNS::Announce::IN::SRV.new(0, 0, service.service_port, service.qualified_host)
+
+      service.service_interfaces.each do |iface|
+        if iface.addr.ipv4?
+          msg.add_additional service.qualified_host,
+            60,
+            MDNS::Announce::IN::A.new(iface.addr.ip_address)
+        else
+          msg.add_additional service.qualified_host,
+            60,
+            MDNS::Announce::IN::AAAA.new(iface.addr.ip_address)
+        end
+      end
+
+      if service.text
+        msg.add_additional service.service_name,
+          60,
+          MDNS::Announce::IN::TXT.new(*service.text)
+      end
+
+      msg.add_answer service.service,
+        60,
+        Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(service.service_name))
+
       assert_equal msg, service.announcement
     end
 
     def test_disconnect
-      data = "\x00\x00\x84\x00\x00\x00\x00\x01\x00\x00\x00\x03\n_test-mdns\x04_tcp\x05local\x00\x00\f\x00\x01\x00\x00\x00\x00\x00\x11\x0Etc-lan-adapter\xC0\f\xC0-\x00!\x00\x01\x00\x00\x00\x00\x00\x1C\x00\x00\x00\x00\xA5\xB8\x0Etc-lan-adapter\x05local\x00\xC0P\x00\x01\x00\x01\x00\x00\x00\x00\x00\x04\n\x00\x01\x95\xC0-\x00\x10\x00\x01\x00\x00\x00\x00\x00\x13\x06test=1\vother=value".b
-      m = Resolv::DNS::Message.decode data
+      # FIXME: this test should be converted to an integration test.
+      # We need to make a client listen for the disconnect and then decode that
       s = make_server iface
-      assert_equal m, s.disconnect_msg
+
+      msg = Resolv::DNS::Message.new(0)
+      msg.qr = 1
+      msg.aa = 1
+
+      msg.add_additional s.service_name, 0, Resolv::DNS::Resource::IN::SRV.new(0, 0, s.service_port, s.qualified_host)
+
+      s.service_interfaces.each do |iface|
+        if iface.addr.ipv4?
+          msg.add_additional s.qualified_host,
+            0,
+            Resolv::DNS::Resource::IN::A.new(iface.addr.ip_address)
+        else
+          msg.add_additional s.qualified_host,
+            0,
+            Resolv::DNS::Resource::IN::AAAA.new(iface.addr.ip_address)
+        end
+      end
+
+      if s.text
+        msg.add_additional s.service_name,
+          0,
+          Resolv::DNS::Resource::IN::TXT.new(*s.text)
+      end
+
+      msg.add_answer s.service,
+        0,
+        Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(s.service_name))
+
+      assert_equal msg, s.disconnect_msg
     end
 
     def test_dnssd_unicast_answer
       s = make_server iface
       runner = Thread.new { s.start }
+      Thread.pass until s.started?
 
-      query = Resolv::DNS::Message.new 0
-      query.add_question "_services._dns-sd._udp.local.", ZeroConf::PTR
+      query = Resolv::DNS::Message.new 10
+      query.add_question "_services._dns-sd._udp.local.", PTR
 
-      sock = open_ipv4 iface.addr, 0
+      sock = open_ipv4 iface.addr, Resolv::MDNS::Port
       multicast_send sock, query.encode
 
       res = nil
       loop do
-        buf, from = sock.recvfrom(2048)
+        buf, from = read_with_timeout sock
         res = Resolv::DNS::Message.decode buf
         if from.last == iface.addr.ip_address
           break if res.answer.find { |name, ttl, data| data.name.to_s == SERVICE }
@@ -133,29 +225,66 @@ module ZeroConf
       expected.add_answer DISCOVERY_NAME, 10,
         Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(s.service))
 
-      expected.add_question DISCOVERY_NAME, ZeroConf::PTR
+      expected.add_question DISCOVERY_NAME, PTR
+
+      assert_equal expected, res
+    end
+
+    def test_dnssd_legacy_unicast_answer
+      s = make_server iface
+      runner = Thread.new { s.start }
+      Thread.pass until s.started?
+
+      query = Resolv::DNS::Message.new 10
+      query.add_question "_services._dns-sd._udp.local.", Resolv::DNS::Resource::IN::PTR
+
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+
+      res = nil
+      loop do
+        buf, from = read_with_timeout sock
+        res = Resolv::DNS::Message.decode buf
+        if from.last == iface.addr.ip_address
+          break if res.answer.find { |name, ttl, data| data.name.to_s == SERVICE }
+        end
+      end
+
+      s.stop
+      runner.join
+
+      expected = Resolv::DNS::Message.new(10)
+      expected.qr = 1
+      expected.aa = 1
+
+      expected.add_answer DISCOVERY_NAME, 10,
+        Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(s.service))
+
+      expected.add_question DISCOVERY_NAME, Resolv::DNS::Resource::IN::PTR
 
       assert_equal expected, res
     end
 
     def test_service_multicast_answer
-      q = Queue.new
+      q = Thread::Queue.new
       rd, wr = IO.pipe
 
       listen = make_listener rd, q
       s = make_server iface
       server = Thread.new { s.start }
+      Thread.pass until s.started? && listen[:started]
 
-      query = Resolv::DNS::Message.new 0
+      query = Resolv::DNS::Message.new 10
       query.add_question "_test-mdns._tcp.local.", Resolv::DNS::Resource::IN::PTR
-      sock = open_ipv4 iface.addr, 0
+      sock = open_ipv4 iface.addr, Resolv::MDNS::Port
       multicast_send sock, query.encode
 
       service = Resolv::DNS::Name.create s.service
       service_name = Resolv::DNS::Name.create s.service_name
 
       while res = q.pop
-        if res.answer.find { |name, ttl, data| name == service && data.name == service_name }
+        if res.answer.find { |name, ttl, data| name == service && data.name == service_name } &&
+            res.additional.find { |_, _, data| ZeroConf::MDNS::Announce::IN::SRV == data.class }
           wr.write "x"
           break
         end
@@ -183,19 +312,20 @@ module ZeroConf
         60,
         Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(s.service_name))
 
-      assert_equal msg.encode, res.encode
+      assert_equal msg, res
     end
 
     def test_service_unicast_answer
       s = make_server iface
       runner = Thread.new { s.start }
+      Thread.pass until s.started?
 
-      query = Resolv::DNS::Message.new 0
-      query.add_question "_test-mdns._tcp.local.", ZeroConf::PTR
+      query = Resolv::DNS::Message.new 10
+      query.add_question "_test-mdns._tcp.local.", PTR
 
-      sock = open_ipv4 iface.addr, 0
+      sock = open_ipv4 iface.addr, Resolv::MDNS::Port
       multicast_send sock, query.encode
-      res = Resolv::DNS::Message.decode sock.recvfrom(2048).first
+      res = Resolv::DNS::Message.decode read_with_timeout(sock).first
       s.stop
       runner.join
 
@@ -214,11 +344,46 @@ module ZeroConf
       expected.add_answer s.service,
         10,
         Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(s.service_name))
-      expected.add_question s.service, ZeroConf::PTR
+      expected.add_question s.service, PTR
+
+      assert_equal expected, res
+    end
+
+    def test_service_legacy_unicast_answer
+      s = make_server iface
+      runner = Thread.new { s.start }
+      Thread.pass until s.started?
+
+      query = Resolv::DNS::Message.new 10
+      query.add_question "_test-mdns._tcp.local.", PTR
+
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+      res = Resolv::DNS::Message.decode read_with_timeout(sock).first
+      s.stop
+      runner.join
+
+      expected = Resolv::DNS::Message.new(10)
+      expected.qr = 1
+      expected.aa = 1
+
+      expected.add_additional s.service_name, 10, Resolv::DNS::Resource::IN::SRV.new(0, 0, s.service_port, s.qualified_host)
+      expected.add_additional s.qualified_host,
+            10,
+            Resolv::DNS::Resource::IN::A.new(iface.addr.ip_address)
+
+      expected.add_additional s.service_name,
+        10,
+        Resolv::DNS::Resource::IN::TXT.new(*s.text)
+      expected.add_answer s.service,
+        10,
+        Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(s.service_name))
+      expected.add_question s.service, Resolv::DNS::Resource::IN::PTR
 
       assert_equal expected, res
     end
 
+
     def test_multicast_service_instance_answer
       q = Queue.new
       rd, wr = IO.pipe
@@ -226,10 +391,11 @@ module ZeroConf
       listen = make_listener rd, q
       s = make_server iface
       server = Thread.new { s.start }
+      Thread.pass until s.started?
 
-      query = Resolv::DNS::Message.new 0
+      query = Resolv::DNS::Message.new 10
       query.add_question "tc-lan-adapter._test-mdns._tcp.local.", Resolv::DNS::Resource::IN::PTR
-      sock = open_ipv4 iface.addr, 0
+      sock = open_ipv4 iface.addr, Resolv::MDNS::Port
       multicast_send sock, query.encode
 
       service_name = Resolv::DNS::Name.create s.service_name
@@ -266,13 +432,14 @@ module ZeroConf
     def test_unicast_name_lookup
       s = make_server iface
       runner = Thread.new { s.start }
+      Thread.pass until s.started?
 
-      query = Resolv::DNS::Message.new 0
-      query.add_question "tc-lan-adapter.local.", ZeroConf::A
+      query = Resolv::DNS::Message.new 10
+      query.add_question "tc-lan-adapter.local.", A
 
-      sock = open_ipv4 iface.addr, 0
+      sock = open_ipv4 iface.addr, Resolv::MDNS::Port
       multicast_send sock, query.encode
-      res = Resolv::DNS::Message.decode sock.recvfrom(2048).first
+      res = Resolv::DNS::Message.decode read_with_timeout(sock).first
       s.stop
       runner.join
 
@@ -287,7 +454,37 @@ module ZeroConf
         Resolv::DNS::Resource::IN::TXT.new(*s.text)
 
       expected.add_question s.qualified_host,
-        ZeroConf::MDNS::Announce::IN::A
+        MDNS::Announce::IN::A
+
+      assert_equal expected, res
+    end
+
+    def test_legacy_unicast_name_lookup
+      s = make_server iface
+      runner = Thread.new { s.start }
+      Thread.pass until s.started?
+
+      query = Resolv::DNS::Message.new 10
+      query.add_question "tc-lan-adapter.local.", Resolv::DNS::Resource::IN::A
+
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+      res = Resolv::DNS::Message.decode read_with_timeout(sock).first
+      s.stop
+      runner.join
+
+      expected = Resolv::DNS::Message.new(10)
+      expected.qr = 1
+      expected.aa = 1
+
+      expected.add_answer s.qualified_host, 10, Resolv::DNS::Resource::IN::A.new(iface.addr.ip_address)
+
+      expected.add_additional s.service_name,
+        10,
+        Resolv::DNS::Resource::IN::TXT.new(*s.text)
+
+      expected.add_question s.qualified_host,
+        Resolv::DNS::Resource::IN::A
 
       assert_equal expected, res
     end
@@ -299,10 +496,11 @@ module ZeroConf
       listen = make_listener rd, q
       s = make_server iface
       server = Thread.new { s.start }
+      Thread.pass until s.started?
 
-      query = Resolv::DNS::Message.new 0
+      query = Resolv::DNS::Message.new 10
       query.add_question "tc-lan-adapter.local.", Resolv::DNS::Resource::IN::A
-      sock = open_ipv4 iface.addr, 0
+      sock = open_ipv4 iface.addr, Resolv::MDNS::Port
       multicast_send sock, query.encode
 
       host = Resolv::DNS::Name.create s.qualified_host
@@ -330,5 +528,10 @@ module ZeroConf
 
       assert_equal expected, res
     end
+
+    def read_with_timeout sock
+      return unless sock.wait_readable(3)
+      sock.recvfrom(2048)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeroconf
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Aaron Patterson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-16 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resolv
@@ -58,12 +58,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/zeroconf.rb
+- lib/zeroconf/browser.rb
+- lib/zeroconf/client.rb
+- lib/zeroconf/discoverer.rb
+- lib/zeroconf/resolver.rb
 - lib/zeroconf/service.rb
 - lib/zeroconf/utils.rb
 - lib/zeroconf/version.rb
@@ -90,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Multicast DNS client and server