UPnP 1.0.0

data/test/test_UPnP_SSDP.rb

@@ -0,0 +1,237 @@
+require 'test/unit'
+require 'test/utilities'
+require 'UPnP/SSDP'
+
+class TestUPnPSSDP < UPnP::TestCase
+
+  def setup
+    @ssdp = UPnP::SSDP.new
+    @ssdp.timeout = 0
+  end
+
+  def teardown
+    @ssdp.listener.kill if @ssdp.listener
+  end
+
+  def test_discover
+    socket = UPnP::FakeSocket.new util_notify
+    @ssdp.socket = socket
+
+    notifications = @ssdp.discover
+
+    assert_equal [], socket.sent
+    assert_equal [Socket::INADDR_ANY, @ssdp.port], socket.bound
+
+    expected = [
+      [Socket::IPPROTO_IP, Socket::IP_TTL, [@ssdp.ttl].pack('i')],
+      [Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP,
+       "\357\377\377\372\000\000\000\000"]
+    ]
+
+    assert_equal expected, socket.socket_options
+
+    assert_equal 1, notifications.length
+    assert_equal 'upnp:rootdevice', notifications.first.type
+  end
+
+  def test_listen
+    @ssdp.socket = UPnP::FakeSocket.new util_notify
+
+    @ssdp.listen
+
+    notification = @ssdp.queue.pop
+
+    assert_equal 'upnp:rootdevice', notification.type
+  end
+
+  def test_parse_bad
+    assert_raise UPnP::SSDP::Error do
+      @ssdp.parse ''
+    end
+  end
+
+  def test_parse_notification
+    notification = @ssdp.parse util_notify
+
+    assert_equal 'upnp:rootdevice', notification.type
+  end
+
+  def test_parse_notification_byebye
+    notification = @ssdp.parse util_notify
+
+    assert_equal 'upnp:rootdevice', notification.type
+  end
+
+  def test_parse_search_response
+    response = @ssdp.parse util_search_response
+
+    assert_equal 'upnp:rootdevice', response.target
+  end
+
+  def test_search
+    socket = UPnP::FakeSocket.new util_search_response
+    @ssdp.socket = socket
+
+    responses = @ssdp.search
+
+    assert_equal nil, socket.bound
+
+    m_search = <<-M_SEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: \"ssdp:discover\"\r
+MX: 0\r
+ST: ssdp:all\r
+\r
+    M_SEARCH
+
+    assert_equal [[m_search, 0, @ssdp.broadcast, @ssdp.port]], socket.sent
+
+    expected = [
+      [Socket::IPPROTO_IP, Socket::IP_TTL, [@ssdp.ttl].pack('i')],
+    ]
+
+    assert_equal expected, socket.socket_options
+
+    assert_equal 1, responses.length
+    assert_equal 'upnp:rootdevice', responses.first.target
+  end
+
+  def test_search_device
+    socket = UPnP::FakeSocket.new util_search_response
+    @ssdp.socket = socket
+
+    responses = @ssdp.search [:device, 'MyDevice.1']
+
+    m_search = <<-M_SEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: \"ssdp:discover\"\r
+MX: 0\r
+ST: urn:schemas-upnp-org:device:MyDevice.1\r
+\r
+    M_SEARCH
+
+    assert_equal [[m_search, 0, @ssdp.broadcast, @ssdp.port]], socket.sent
+  end
+
+  def test_search_root
+    socket = UPnP::FakeSocket.new util_search_response
+    @ssdp.socket = socket
+
+    responses = @ssdp.search :root
+
+    m_search = <<-M_SEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: \"ssdp:discover\"\r
+MX: 0\r
+ST: upnp:rootdevice\r
+\r
+    M_SEARCH
+
+    assert_equal [[m_search, 0, @ssdp.broadcast, @ssdp.port]], socket.sent
+  end
+
+  def test_search_service
+    socket = UPnP::FakeSocket.new util_search_response
+    @ssdp.socket = socket
+
+    responses = @ssdp.search [:service, 'MyService.1']
+
+    m_search = <<-M_SEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: \"ssdp:discover\"\r
+MX: 0\r
+ST: urn:schemas-upnp-org:service:MyService.1\r
+\r
+    M_SEARCH
+
+    assert_equal [[m_search, 0, @ssdp.broadcast, @ssdp.port]], socket.sent
+  end
+
+  def test_search_ssdp
+    socket = UPnP::FakeSocket.new util_search_response
+    @ssdp.socket = socket
+
+    responses = @ssdp.search 'ssdp:foo'
+
+    m_search = <<-M_SEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: \"ssdp:discover\"\r
+MX: 0\r
+ST: ssdp:foo\r
+\r
+    M_SEARCH
+
+    assert_equal [[m_search, 0, @ssdp.broadcast, @ssdp.port]], socket.sent
+  end
+
+  def test_search_urn
+    socket = UPnP::FakeSocket.new util_search_response
+    @ssdp.socket = socket
+
+    responses = @ssdp.search 'urn:foo'
+
+    m_search = <<-M_SEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: \"ssdp:discover\"\r
+MX: 0\r
+ST: urn:foo\r
+\r
+    M_SEARCH
+
+    assert_equal [[m_search, 0, @ssdp.broadcast, @ssdp.port]], socket.sent
+  end
+
+  def test_search_uuid
+    socket = UPnP::FakeSocket.new util_search_response
+    @ssdp.socket = socket
+
+    responses = @ssdp.search 'uuid:foo'
+
+    m_search = <<-M_SEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: \"ssdp:discover\"\r
+MX: 0\r
+ST: uuid:foo\r
+\r
+    M_SEARCH
+
+    assert_equal [[m_search, 0, @ssdp.broadcast, @ssdp.port]], socket.sent
+  end
+
+  def test_send_search
+    socket = UPnP::FakeSocket.new
+    @ssdp.socket = socket
+
+    @ssdp.send_search 'bunnies'
+
+    search = <<-SEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: \"ssdp:discover\"\r
+MX: 0\r
+ST: bunnies\r
+\r
+    SEARCH
+
+    assert_equal [[search, 0, @ssdp.broadcast, @ssdp.port]], socket.sent
+  end
+
+  def test_stop_listening
+    thread = Thread.new do sleep end
+    @ssdp.listener = thread
+
+    @ssdp.stop_listening
+
+    assert_equal false, thread.alive?
+    assert_equal nil, @ssdp.listener
+  end
+
+end
+

data/test/test_UPnP_SSDP_notification.rb

@@ -0,0 +1,74 @@
+require 'test/unit'
+require 'test/utilities'
+require 'UPnP/SSDP'
+
+class TestUPnPSSDPNotification < UPnP::TestCase
+
+  def test_self_parse_notify
+    notification = UPnP::SSDP::Notification.parse util_notify
+
+    assert_equal Time, notification.date.class
+    assert_equal '239.255.255.250', notification.host
+    assert_equal '1900', notification.port
+    assert_equal URI.parse('http://example.com/root_device.xml'),
+                 notification.location
+    assert_equal 10, notification.max_age
+    assert_equal 'uuid:BOGUS::upnp:rootdevice', notification.name
+    assert_equal 'upnp:rootdevice', notification.type
+    assert_equal 'OS/5 UPnP/1.0 product/7', notification.server
+    assert_equal 'ssdp:alive', notification.sub_type
+  end
+
+  def test_self_parse_notify_byebye
+    notification = UPnP::SSDP::Notification.parse util_notify_byebye
+
+    assert_equal Time, notification.date.class
+    assert_equal '239.255.255.250', notification.host
+    assert_equal '1900', notification.port
+    assert_equal nil, notification.location
+    assert_equal nil, notification.max_age
+    assert_equal 'uuid:BOGUS::upnp:rootdevice', notification.name
+    assert_equal 'upnp:rootdevice', notification.type
+    assert_equal 'ssdp:byebye', notification.sub_type
+  end
+
+  def test_alive_eh
+    notification = UPnP::SSDP::Notification.parse util_notify
+
+    assert notification.alive?
+
+    notification = UPnP::SSDP::Notification.parse util_notify_byebye
+
+    assert !notification.alive?
+  end
+
+  def test_byebye_eh
+    notification = UPnP::SSDP::Notification.parse util_notify_byebye
+
+    assert notification.byebye?
+
+    notification = UPnP::SSDP::Notification.parse util_notify
+
+    assert !notification.byebye?
+  end
+
+  def test_inspect
+    notification = UPnP::SSDP::Notification.parse util_notify
+
+    id = notification.object_id.to_s 16
+    expected = "#<UPnP::SSDP::Notification:0x#{id} upnp:rootdevice ssdp:alive http://example.com/root_device.xml>"
+
+    assert_equal expected, notification.inspect
+  end
+
+  def test_inspect_byebye
+    notification = UPnP::SSDP::Notification.parse util_notify_byebye
+
+    id = notification.object_id.to_s 16
+    expected = "#<UPnP::SSDP::Notification:0x#{id} upnp:rootdevice ssdp:byebye>"
+
+    assert_equal expected, notification.inspect
+  end
+
+end
+

data/test/test_UPnP_SSDP_response.rb

@@ -0,0 +1,30 @@
+require 'test/unit'
+require 'test/utilities'
+require 'UPnP/SSDP'
+
+class TestUPnPSSDPResponse < UPnP::TestCase
+
+  def setup
+    @response = UPnP::SSDP::Response.parse util_search_response
+  end
+
+  def test_self_parse_notify
+    assert_equal Time, @response.date.class
+    assert_equal true, @response.ext
+    assert_equal URI.parse('http://example.com/root_device.xml'),
+                 @response.location
+    assert_equal 10, @response.max_age
+    assert_equal 'uuid:BOGUS::upnp:rootdevice', @response.name
+    assert_equal 'OS/5 UPnP/1.0 product/7', @response.server
+    assert_equal 'upnp:rootdevice', @response.target
+  end
+
+  def test_inspect
+    id = @response.object_id.to_s 16
+    expected = "#<UPnP::SSDP::Response:0x#{id} upnp:rootdevice http://example.com/root_device.xml>"
+
+    assert_equal expected, @response.inspect
+  end
+
+end
+

data/test/test_UPnP_control_device.rb

@@ -0,0 +1,72 @@
+require 'test/unit'
+require 'stringio'
+require 'test/utilities'
+require 'UPnP/control/device'
+
+class TestUPnPControlDevice < UPnP::TestCase
+
+  def setup
+    @device_url = URI.parse 'http://example.com/device.xml'
+
+    UPnP::OpenStub::FILES[@device_url] = StringIO.new UPnP::TestCase::IGD_XML
+    UPnP::OpenStub::FILES[@device_url + '/L3F.xml'] =
+      StringIO.new UPnP::TestCase::L3F_XML
+    UPnP::OpenStub::FILES[@device_url + '/WANCfg.xml'] =
+      StringIO.new UPnP::TestCase::CFG_XML
+    UPnP::OpenStub::FILES[@device_url + '/WANIPCn.xml'] =
+      StringIO.new UPnP::TestCase::IPCN_XML
+  end
+
+  def test_self_create
+    device = UPnP::Control::Device.create @device_url
+
+    igd = UPnP::Control::Device::InternetGatewayDevice
+
+    assert_equal igd, device.class
+    assert igd.constants.include?('URN_1'), 'URN_1 constant missing'
+    assert_equal "#{UPnP::DEVICE_SCHEMA_PREFIX}:#{igd.name}:1", igd::URN_1
+  ensure
+    UPnP::Control::Device.send :remove_const, :InternetGatewayDevice
+  end
+
+  def test_self_create_class_exists
+    UPnP::Control::Device.const_set :InternetGatewayDevice,
+                                    Class.new(UPnP::Control::Device)
+
+    device = UPnP::Control::Device.create @device_url
+
+    assert_equal UPnP::Control::Device::InternetGatewayDevice, device.class
+  ensure
+    UPnP::Control::Device.send :remove_const, :InternetGatewayDevice
+  end
+
+  def test_initialize
+    device = UPnP::Control::Device.new @device_url
+
+    assert_equal 'http://example.com/', device.url.to_s
+    assert_equal 'urn:schemas-upnp-org:device:InternetGatewayDevice:1',
+                 device.type
+
+    assert_equal 'FreeBSD router', device.friendly_name
+
+    assert_equal 'FreeBSD', device.manufacturer
+    assert_equal URI.parse('http://www.freebsd.org/'), device.manufacturer_url
+
+    assert_equal 'FreeBSD router', device.model_description
+    assert_equal 'FreeBSD router', device.model_name
+    assert_equal URI.parse('http://www.freebsd.org/'), device.model_url
+    assert_equal '1', device.model_number
+
+    assert_equal '00000000', device.serial_number
+
+    assert_equal 'uuid:ed56cff8-7d4e-11dc-b7db-000024c4931c', device.name
+
+    assert_equal 2, device.devices.length, 'devices count'
+    assert_equal 1, device.sub_devices.length, 'sub-devices count'
+
+    assert_equal 3, device.services.length, 'services count'
+    assert_equal 1, device.sub_services.length, 'sub-services count'
+  end
+
+end
+

data/test/test_UPnP_control_service.rb

@@ -0,0 +1,108 @@
+require 'test/unit'
+require 'test/utilities'
+require 'UPnP/control/service'
+
+class TestUPnPControlService < UPnP::TestCase
+
+  def setup
+    @url = URI.parse 'http://example.com'
+    service_description = <<-XML
+<service>
+  <serviceType>urn:schemas-upnp-org:service:Layer3Forwarding:1</serviceType>
+  <serviceId>urn:upnp-org:serviceId:Layer3Forwarding1</serviceId>
+  <controlURL>/ctl/L3F</controlURL>
+  <eventSubURL>/evt/L3F</eventSubURL>
+  <SCPDURL>/L3F.xml</SCPDURL>
+</service>
+    XML
+
+    service_description = REXML::Document.new service_description
+    @service_description = service_description.elements['service']
+
+    UPnP::Control::Service::FILES[@url + '/L3F.xml'] = StringIO.new L3F_XML
+
+    @methods = %w[
+      AddPortMapping
+      DeletePortMapping
+      ForceTermination
+      GetConnectionTypeInfo
+      GetExternalIPAddress
+      GetGenericPortMappingEntry
+      GetNATRSIPStatus
+      GetSpecificPortMappingEntry
+      GetStatusInfo
+      RequestConnection
+      SetConnectionType
+    ]
+  end
+
+  def test_self_create
+    device = UPnP::Control::Service.create @service_description, @url
+
+    l3f = UPnP::Control::Service::Layer3Forwarding
+    assert_equal l3f, device.class
+
+    assert l3f.constants.include?('URN_1'), 'URN_1 constant missing'
+    assert_equal "#{UPnP::SERVICE_SCHEMA_PREFIX}:#{l3f.name}:1", l3f::URN_1
+  ensure
+    UPnP::Control::Service.send :remove_const, :Layer3Forwarding
+  end
+
+  def test_self_create_class_exists
+    UPnP::Control::Service.const_set :Layer3Forwarding,
+                                    Class.new(UPnP::Control::Service)
+
+    device = UPnP::Control::Service.create @service_description, @url
+
+    assert_equal UPnP::Control::Service::Layer3Forwarding, device.class
+  ensure
+    UPnP::Control::Service.send :remove_const, :Layer3Forwarding
+  end
+
+  def test_initialize
+    service = UPnP::Control::Service.new @service_description, @url
+
+    assert_equal @url, service.url
+
+    assert_equal 'urn:schemas-upnp-org:service:Layer3Forwarding:1',
+                 service.type
+
+    assert_equal 'urn:upnp-org:serviceId:Layer3Forwarding1', service.id
+
+    control_url = @url + '/ctl/L3F'
+    assert_equal control_url, service.control_url
+
+    evt_url = @url + '/evt/L3F'
+    assert_equal evt_url, service.event_sub_url
+
+    scpd_url = @url + '/L3F.xml'
+    assert_equal scpd_url, service.scpd_url
+
+    assert_not_nil service.driver
+  end
+
+  def test_create_driver
+    service = UPnP::Control::Service.create @service_description, @url
+
+    assert_equal @methods, service.driver.methods(false).sort
+
+    registry = service.driver.mapping_registry
+
+    klass_def = registry.elename_schema_definition_from_class SOAP::SOAPString
+    assert_equal 'NewPossibleConnectionTypes', klass_def.elename.name
+
+    new_protocol = XSD::QName.new nil, 'NewProtocol'
+    mapping = registry.schema_definition_from_elename new_protocol
+    assert mapping, "Mapping for #{new_protocol} not found"
+
+    assert service.respond_to?(@methods.first)
+  end
+
+  def test_methods
+    service = UPnP::Control::Service.new @service_description, @url
+
+    assert_equal @methods, service.methods(false).sort
+  end
+
+end
+