zeroconf 1.0.0

data/test/service_test.rb

@@ -0,0 +1,334 @@
+require "helper"
+
+module ZeroConf
+  class ServiceTest < Test
+    include ZeroConf::Utils
+
+    attr_reader :iface
+
+    def setup
+      super
+      @iface = ZeroConf.interfaces.find_all { |x| x.addr.ipv4? }.first
+    end
+
+    def test_service_info
+      s = Service.new "_test-mdns._tcp.local.",
+        42424,
+        "tc-lan-adapter",
+        service_interfaces: [iface]
+
+      assert_equal "_test-mdns._tcp.local.", s.service
+      assert_equal 42424, s.service_port
+      assert_equal "tc-lan-adapter", s.hostname
+      assert_equal [iface], s.service_interfaces
+      assert_equal "#{s.hostname}.#{s.service}", s.service_name
+      assert_equal "#{s.hostname}.local.", s.qualified_host
+      assert_equal [""], s.text
+    end
+
+    def test_unicast_service_instance_answer
+      s = make_server iface
+      runner = Thread.new { s.start }
+
+      query = Resolv::DNS::Message.new 0
+      query.add_question "tc-lan-adapter._test-mdns._tcp.local.", ZeroConf::SRV
+
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+      res = Resolv::DNS::Message.decode sock.recvfrom(2048).first
+      s.stop
+      runner.join
+
+      expected = Resolv::DNS::Message.new(0)
+      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, ZeroConf::MDNS::Announce::IN::SRV
+
+      assert_equal expected, res
+    end
+
+    def test_multicast_discover
+      q = Queue.new
+      rd, wr = IO.pipe
+
+      listen = make_listener rd, q
+      s = make_server iface
+      server = Thread.new { s.start }
+
+      query = Resolv::DNS::Message.new 0
+      query.add_question "_services._dns-sd._udp.local.", Resolv::DNS::Resource::IN::PTR
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+
+      while res = q.pop
+        if res.answer.find { |name, ttl, data| name.to_s == "_services._dns-sd._udp.local" && data.name.to_s == SERVICE }
+          wr.write "x"
+          break
+        end
+      end
+
+      listen.join
+      s.stop
+      server.join
+
+      msg = Resolv::DNS::Message.new(0)
+      msg.qr = 1
+      msg.aa = 1
+
+      msg.add_answer DISCOVERY_NAME, 60,
+        Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(s.service))
+
+      assert_equal msg, res
+    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
+      service = Service.new "_test-mdns._tcp.local.", 42424
+      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
+      s = make_server iface
+      assert_equal m, s.disconnect_msg
+    end
+
+    def test_dnssd_unicast_answer
+      s = make_server iface
+      runner = Thread.new { s.start }
+
+      query = Resolv::DNS::Message.new 0
+      query.add_question "_services._dns-sd._udp.local.", ZeroConf::PTR
+
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+
+      res = nil
+      loop do
+        buf, from = sock.recvfrom(2048)
+        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(0)
+      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, ZeroConf::PTR
+
+      assert_equal expected, res
+    end
+
+    def test_service_multicast_answer
+      q = Queue.new
+      rd, wr = IO.pipe
+
+      listen = make_listener rd, q
+      s = make_server iface
+      server = Thread.new { s.start }
+
+      query = Resolv::DNS::Message.new 0
+      query.add_question "_test-mdns._tcp.local.", Resolv::DNS::Resource::IN::PTR
+      sock = open_ipv4 iface.addr, 0
+      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 }
+          wr.write "x"
+          break
+        end
+      end
+
+      listen.join
+      s.stop
+      server.join
+
+      msg = Resolv::DNS::Message.new(0)
+      msg.qr = 1
+      msg.aa = 1
+
+      msg.add_additional s.service_name, 60, MDNS::Announce::IN::SRV.new(0, 0, s.service_port, s.qualified_host)
+
+      msg.add_additional s.qualified_host,
+        60,
+        MDNS::Announce::IN::A.new(iface.addr.ip_address)
+
+      msg.add_additional s.service_name,
+        60,
+        MDNS::Announce::IN::TXT.new(*s.text)
+
+      msg.add_answer s.service,
+        60,
+        Resolv::DNS::Resource::IN::PTR.new(Resolv::DNS::Name.create(s.service_name))
+
+      assert_equal msg.encode, res.encode
+    end
+
+    def test_service_unicast_answer
+      s = make_server iface
+      runner = Thread.new { s.start }
+
+      query = Resolv::DNS::Message.new 0
+      query.add_question "_test-mdns._tcp.local.", ZeroConf::PTR
+
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+      res = Resolv::DNS::Message.decode sock.recvfrom(2048).first
+      s.stop
+      runner.join
+
+      expected = Resolv::DNS::Message.new(0)
+      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, ZeroConf::PTR
+
+      assert_equal expected, res
+    end
+
+    def test_multicast_service_instance_answer
+      q = Queue.new
+      rd, wr = IO.pipe
+
+      listen = make_listener rd, q
+      s = make_server iface
+      server = Thread.new { s.start }
+
+      query = Resolv::DNS::Message.new 0
+      query.add_question "tc-lan-adapter._test-mdns._tcp.local.", Resolv::DNS::Resource::IN::PTR
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+
+      service_name = Resolv::DNS::Name.create s.service_name
+
+      while res = q.pop
+        if res.answer.find { |name, ttl, data| name == service_name }
+          wr.write "x"
+          break
+        end
+      end
+
+      listen.join
+      s.stop
+      server.join
+
+      msg = Resolv::DNS::Message.new(0)
+      msg.qr = 1
+      msg.aa = 1
+
+      msg.add_answer s.service_name, 60, Resolv::DNS::Resource::IN::SRV.new(0, 0, s.service_port, s.qualified_host)
+
+      msg.add_additional s.qualified_host,
+        60,
+        Resolv::DNS::Resource::IN::A.new(iface.addr.ip_address)
+
+      msg.add_additional service_name,
+        60,
+        Resolv::DNS::Resource::IN::TXT.new(*s.text)
+
+
+      assert_equal msg, res
+    end
+
+    def test_unicast_name_lookup
+      s = make_server iface
+      runner = Thread.new { s.start }
+
+      query = Resolv::DNS::Message.new 0
+      query.add_question "tc-lan-adapter.local.", ZeroConf::A
+
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+      res = Resolv::DNS::Message.decode sock.recvfrom(2048).first
+      s.stop
+      runner.join
+
+      expected = Resolv::DNS::Message.new(0)
+      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,
+        ZeroConf::MDNS::Announce::IN::A
+
+      assert_equal expected, res
+    end
+
+    def test_multicast_name
+      q = Queue.new
+      rd, wr = IO.pipe
+
+      listen = make_listener rd, q
+      s = make_server iface
+      server = Thread.new { s.start }
+
+      query = Resolv::DNS::Message.new 0
+      query.add_question "tc-lan-adapter.local.", Resolv::DNS::Resource::IN::A
+      sock = open_ipv4 iface.addr, 0
+      multicast_send sock, query.encode
+
+      host = Resolv::DNS::Name.create s.qualified_host
+
+      while res = q.pop
+        if res.answer.find { |name, ttl, data| name == host }
+          wr.write "x"
+          break
+        end
+      end
+
+      listen.join
+      s.stop
+      server.join
+
+      expected = Resolv::DNS::Message.new(0)
+      expected.qr = 1
+      expected.aa = 1
+
+      expected.add_answer s.qualified_host, 60, Resolv::DNS::Resource::IN::A.new(iface.addr.ip_address)
+
+      expected.add_additional s.service_name,
+        60,
+        Resolv::DNS::Resource::IN::TXT.new(*s.text)
+
+      assert_equal expected, res
+    end
+  end
+end

data/zeroconf.gemspec

@@ -0,0 +1,18 @@
+require_relative "lib/zeroconf/version"
+
+Gem::Specification.new do |s|
+  s.name        = "zeroconf"
+  s.version     = ZeroConf::VERSION
+  s.summary     = "Multicast DNS client and server"
+  s.description = "This is a multicast DNS client and server written in Ruby"
+  s.authors     = [ "Aaron Patterson" ]
+  s.email       = "tenderlove@ruby-lang.org"
+  s.files       = `git ls-files -z`.split("\x0")
+  s.test_files  = s.files.grep(%r{^test/})
+  s.homepage    = "https://github.com/tenderlove/zeroconf"
+  s.license     = "Apache-2.0"
+
+  s.add_dependency("resolv", "~> 0.3.0")
+  s.add_development_dependency("rake", "~> 13.0")
+  s.add_development_dependency("minitest", "~> 5.20")
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: zeroconf
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Patterson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resolv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+description: This is a multicast DNS client and server written in Ruby
+email: tenderlove@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/zeroconf.rb
+- lib/zeroconf/service.rb
+- lib/zeroconf/utils.rb
+- lib/zeroconf/version.rb
+- test/client_test.rb
+- test/helper.rb
+- test/service_test.rb
+- zeroconf.gemspec
+homepage: https://github.com/tenderlove/zeroconf
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.0.dev
+signing_key:
+specification_version: 4
+summary: Multicast DNS client and server
+test_files:
+- test/client_test.rb
+- test/helper.rb
+- test/service_test.rb