ruby-dbus 0.5.0

data/ruby-dbus.gemspec

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+require "rubygems"
+require "rake"
+
+GEMSPEC = Gem::Specification.new do |s|
+  s.name = "ruby-dbus"
+  # s.rubyforge_project = nil
+  s.summary = "Ruby module for interaction with D-Bus"
+  # s.description = FIXME
+  s.version = File.read("VERSION").strip
+  s.author = "Ruby DBus Team"
+  s.email = "ruby-dbus-devel@lists.luon.net"
+  s.homepage = "http://trac.luon.net/data/ruby-dbus/"
+  s.files = FileList["{doc/tutorial,examples,lib,test}/**/*", "Rakefile", "ruby-dbus.gemspec", "VERSION"].to_a.sort
+  s.require_path = "lib"
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["COPYING", "README", "NEWS"]
+end

data/test/binding_test.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+# Test the binding of dbus concepts to ruby concepts
+require "test/unit"
+require "dbus"
+
+class BindingTest < Test::Unit::TestCase
+  def setup
+    @bus = DBus::SessionBus.instance
+    @svc = @bus.service("org.ruby.service")
+    @base = @svc.object "/org/ruby/MyInstance"
+    @base.introspect
+    @base.default_iface = "org.ruby.SampleInterface"
+  end
+
+  # https://trac.luon.net/ruby-dbus/ticket/36#comment:3
+  def test_class_inheritance
+    derived = @svc.object "/org/ruby/MyDerivedInstance"
+    derived.introspect
+
+    # it should inherit from the parent
+    assert_not_nil derived["org.ruby.SampleInterface"]
+  end
+
+  # https://trac.luon.net/ruby-dbus/ticket/36
+  # Interfaces and methods/signals appeared on all classes
+  def test_separation_of_classes
+    test2 = @svc.object "/org/ruby/MyInstance2"
+    test2.introspect
+
+    # it should have its own interface
+    assert_not_nil test2["org.ruby.Test2"]
+    # but not an interface of the Test class
+    assert_nil test2["org.ruby.SampleInterface"]
+
+    # and the parent should not get polluted by the child
+    assert_nil @base["org.ruby.Test2"]
+  end
+
+  def test_translating_errors_into_exceptions
+    # this is a generic call that will reply with the specified error
+    @base.Error "org.example.Fail", "as you wish"
+    assert false, "should have raised"
+  rescue DBus::Error => e
+    assert_equal "org.example.Fail", e.name
+    assert_equal "as you wish", e.message
+  end
+
+  def test_generic_dbus_error
+    # this is a generic call that will reply with the specified error
+    @base.will_raise_error_failed
+    assert false, "should have raised"
+  rescue DBus::Error => e
+    assert_equal "org.freedesktop.DBus.Error.Failed", e.name
+    assert_equal "failed as designed", e.message
+  end
+end

data/test/bus_driver_test.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# Test the methods of the bus driver
+require "test/unit"
+require "dbus"
+
+def d(msg)
+  puts msg if $DEBUG
+end
+
+class BusDriverTest < Test::Unit::TestCase
+  def setup
+    @bus = DBus::SessionBus.instance
+    @svc = @bus.service("org.ruby.service")
+    @svc.object("/").introspect
+  end
+
+  def test_exists
+    assert @svc.exists?, "could not find the service"
+    nonsvc = @bus.service "org.ruby.nosuchservice"
+    assert ! nonsvc.exists?, "found a service that should not exist"
+  end
+end

data/test/dbus-launch-simple

@@ -0,0 +1,35 @@
+#! /bin/sh
+# A wrapper for DBus tests
+# Reimplementing dbus-launch because it is in dbus-1-x11.rpm
+# Sets up a private session bus and call the specified program
+set -o errexit
+
+# This launches the bus daemon,
+# exports DBUS_SESSION_BUS_ADDRESS and sets DBUS_SESSION_BUS_PID
+my_dbus_launch () {
+    # reimplementing dbus-launch because it is in dbus-1-x11.rpm
+    PF=`mktemp dbus.pid.XXXXXX` || exit
+    AF=`mktemp dbus.addr.XXXXXX` || exit
+    RM_FILES="$RM_FILES $PF $AF"
+
+    dbus-daemon --config-file=dbus-limited-session.conf --print-address=3 3>$AF --print-pid=4 4>$PF &
+    # wait for the daemon to print the info
+    TRIES=0
+    while [ ! -s $AF -o ! -s $PF ]; do
+	sleep 0.1
+	TRIES=`expr $TRIES + 1`
+	if [ $TRIES -gt 100 ]; then echo "dbus-daemon failed?"; exit 1; fi
+    done
+    DBUS_SESSION_BUS_PID=$(cat $PF)
+    export DBUS_SESSION_BUS_ADDRESS=$(cat $AF)
+    KILLS="$KILLS $DBUS_SESSION_BUS_PID"
+#    dbus-monitor &
+}
+
+my_dbus_launch
+
+# Clean up at exit.
+trap "kill \$KILLS; rm -rf \$RM_FILES" EXIT TERM INT
+
+# run the payload; the return value is passed on
+"$@"

data/test/dbus-limited-session.conf

@@ -0,0 +1,28 @@
+<!-- This configuration file controls the testing message bus.
+     It is based on a session bus config. -->
+
+<!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-Bus Bus Configuration 1.0//EN"
+ "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd">
+<busconfig>
+  <!-- Our well-known bus type, don't change this -->
+  <type>session</type>
+
+  <listen>unix:tmpdir=/tmp</listen>
+  <listen>tcp:host=localhost,port=0,family=ipv4</listen>
+
+  <standard_session_servicedirs />
+
+  <policy context="default">
+    <!-- Allow everything to be sent -->
+    <allow send_destination="*" eavesdrop="true"/>
+    <!-- Allow everything to be received -->
+    <allow eavesdrop="true"/>
+    <!-- Allow anyone to own anything -->
+    <allow own="*"/>
+  </policy>
+
+  <!-- Do not increase the limits.
+       Instead, lower some so that we can test resource leaks. -->
+  <limit name="max_match_rules_per_connection">50</limit><!-- was 512 -->
+
+</busconfig>

data/test/server_robustness_test.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# Test that a server survives various error cases
+require "test/unit"
+require "dbus"
+
+class ServerRobustnessTest < Test::Unit::TestCase
+  def setup
+    @bus = DBus::SessionBus.instance
+    @svc = @bus.service("org.ruby.service")
+  end
+
+  # https://trac.luon.net/ruby-dbus/ticket/31
+  # the server should not crash
+  def test_no_such_path_with_introspection
+    obj = @svc.object "/org/ruby/NotMyInstance"
+    obj.introspect
+    assert false, "should have raised"
+  rescue DBus::Error => e
+    assert_no_match(/timeout/, e.to_s)
+  end
+
+  def test_no_such_path_without_introspection
+    obj = @svc.object "/org/ruby/NotMyInstance"
+    ifc = DBus::ProxyObjectInterface.new(obj, "org.ruby.SampleInterface")
+    ifc.define_method("the_answer", "out n:i")
+    ifc.the_answer
+    assert false, "should have raised"
+  rescue DBus::Error => e
+    assert_no_match(/timeout/, e.to_s)
+  end
+
+  def test_a_method_that_raises
+    obj = @svc.object "/org/ruby/MyInstance"
+    obj.introspect
+    obj.default_iface = "org.ruby.SampleInterface"
+    obj.will_raise
+    assert false, "should have raised"
+  rescue DBus::Error => e
+    assert_no_match(/timeout/, e.to_s)
+  end
+end

data/test/server_test.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# Test that a server survives various error cases
+require "test/unit"
+require "dbus"
+
+class Foo < DBus::Object
+  dbus_interface "org.ruby.ServerTest" do
+    dbus_signal :signal_without_arguments
+    dbus_signal :signal_with_argument, "epsilon:d"
+  end
+
+  dbus_signal :signal_without_interface
+rescue DBus::Object::UndefinedInterface => e
+  # raised by the preceding signal declaration
+end
+
+class Bar < DBus::Object
+  dbus_interface "org.ruby.ServerTest" do
+    # a valid Ruby symbol but an invalid DBus name; Ticket#38
+    dbus_signal :signal_with_a_bang!
+  end
+rescue DBus::InvalidMethodName
+  # raised by the preceding signal declaration
+end
+
+class ServerTest < Test::Unit::TestCase
+  def setup
+    @bus = DBus::SessionBus.instance
+    @svc = @bus.request_service "org.ruby.server-test"
+  end
+
+  def teardown
+    @bus.proxy.ReleaseName "org.ruby.server-test"
+  end
+
+  def test_unexporting_an_object
+    obj = Foo.new "/org/ruby/Foo"
+    @svc.export obj
+    assert @svc.unexport(obj)
+  end
+
+  def test_unexporting_an_object_not_exported
+    obj = Foo.new "/org/ruby/Foo"
+    assert !@svc.unexport(obj)
+  end
+
+  def test_emiting_signals
+    obj = Foo.new "/org/ruby/Foo"
+    @svc.export obj
+    obj.signal_without_arguments    
+    obj.signal_with_argument(-0.1)
+  end
+end

data/test/service_newapi.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+
+# find the library without external help
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'dbus'
+
+def d(msg)
+  puts "#{$$} #{msg}" if $DEBUG
+end
+
+class Test < DBus::Object
+  # Create an interface aggregating all upcoming dbus_method defines.
+  dbus_interface "org.ruby.SampleInterface" do
+    dbus_method :hello, "in name:s, in name2:s" do |name, name2|
+      puts "hello(#{name}, #{name2})"
+    end
+
+    dbus_method :test_variant, "in stuff:v" do |variant|
+      p variant
+    end
+
+    dbus_method :bounce_variant, "in stuff:v, out chaff:v" do |variant|
+      [variant]
+    end
+
+    dbus_method :variant_size, "in stuff:v, out size:u" do |variant|
+      [variant.size]
+    end
+
+    dbus_method :the_answer, "out answer:i" do
+      42
+    end
+
+    dbus_method :will_raise, "" do
+      raise "Handle this"
+    end
+
+    dbus_method :will_raise_error_failed, "" do
+      raise DBus.error, "failed as designed"
+    end
+
+    dbus_method :Error, "in name:s, in description:s" do |name, description|
+      raise DBus.error(name), description
+    end
+
+    dbus_signal :SomethingJustHappened, "toto:s, tutu:u"
+  end
+
+  dbus_interface "org.ruby.AnotherInterface" do
+    dbus_method :ThatsALongMethodNameIThink do
+      puts "ThatsALongMethodNameIThink"
+    end
+    dbus_method :Reverse, "in instr:s, out outstr:s" do |instr|
+      outstr = instr.split(//).reverse.join
+      puts "got: #{instr}, replying: #{outstr}"
+      [outstr]
+    end
+  end
+
+  dbus_interface "org.ruby.Ticket30" do
+    dbus_method :Sybilla, 'in choices:av, out advice:s' do |choices|
+      ["Do #{choices[0]}"]
+    end
+  end
+
+  dbus_interface "org.ruby.Loop" do
+    # starts doing something long, but returns immediately
+    # and sends a signal when done
+    dbus_method :LongTaskBegin, 'in delay:i' do |delay|
+# FIXME did not complain about mismatch between signature and block args
+      d "Long task began"
+      task = Thread.new do
+        d "Long task thread started (#{delay}s)"
+        sleep delay
+        d "Long task will signal end"
+        self.LongTaskEnd
+      end
+      task.abort_on_exception = true # protect from test case bugs
+    end
+
+    dbus_signal :LongTaskEnd
+  end
+end
+
+class Derived < Test
+end
+
+class Test2 < DBus::Object
+  dbus_interface "org.ruby.Test2" do
+    dbus_method :hi, "in name:s, out greeting:s" do |name|
+      "Hi, #{name}!"
+    end
+  end
+end
+
+bus = DBus::SessionBus.instance
+service = bus.request_service("org.ruby.service")
+myobj = Test.new("/org/ruby/MyInstance")
+service.export(myobj)
+derived = Derived.new "/org/ruby/MyDerivedInstance"
+service.export derived
+test2 = Test2.new "/org/ruby/MyInstance2"
+service.export test2 
+
+# introspect every other connection, Ticket #34
+#  (except the one that activates us - it has already emitted
+#  NOC by the time we run this. Therefore the test for #34 will not work
+#  by running t2.rb alone, one has to run t1 before it; 'rake' does it)
+mr = DBus::MatchRule.new.from_s "type='signal',interface='org.freedesktop.DBus',member='NameOwnerChanged'"
+bus.add_match(mr) do |msg|
+  new_unique_name = msg.params[2]
+  unless new_unique_name.empty?
+    d "RRRING #{new_unique_name}"
+    bus.introspect_data(new_unique_name, "/") do
+      # ignore the result
+    end
+  end
+end
+
+puts "listening"
+main = DBus::Main.new
+main << bus
+begin
+  main.run
+rescue SystemCallError
+  # the test driver will kill the bus, that's OK
+end
+

data/test/session_bus_test_manual.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require "test/unit"
+require "dbus"
+
+def d(msg)
+  puts msg if $DEBUG
+end
+
+class SessionBusAddressTest < Test::Unit::TestCase
+  def setup
+    # test getting the session bus address even if unset in ENV (Issue#4)
+    ENV.delete "DBUS_SESSION_BUS_ADDRESS"
+    @bus = DBus::SessionBus.instance
+    @svc = @bus.service("org.freedesktop.DBus")
+  end
+
+  def test_connection
+    assert @svc.exists?
+  end
+end

data/test/signal_test.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+# Test the signal handlers
+require "test/unit"
+require "dbus"
+
+def d(msg)
+  puts "#{$$} #{msg}" if $DEBUG
+end
+
+class SignalHandlerTest < Test::Unit::TestCase
+  def setup
+    @session_bus = DBus::SessionBus.instance
+    svc = @session_bus.service("org.ruby.service")
+    @obj = svc.object("/org/ruby/MyInstance")
+    @obj.introspect                  # necessary
+    @obj.default_iface = "org.ruby.Loop"
+
+    @loop = DBus::Main.new
+    @loop << @session_bus
+  end
+
+  # testing for commit 017c83 (kkaempf)
+  def test_overriding_a_handler
+    counter = 0
+
+    @obj.on_signal "LongTaskEnd" do
+      d "+10"
+      counter += 10
+    end
+    @obj.on_signal "LongTaskEnd" do
+      d "+1"
+      counter += 1
+    end
+
+    d "will begin"
+    @obj.LongTaskBegin 3
+
+    quitter = Thread.new do
+      d "sleep before quit"
+      # FIXME if we sleep for too long
+      # the socket will be drained and we deadlock in a select.
+      # It could be worked around by sending ourselves a Unix signal
+      # (with a dummy handler) to interrupt the select
+      sleep 1
+      d "will quit"
+      @loop.quit
+    end
+    @loop.run
+
+    assert_equal 1, counter
+  end
+
+  def test_too_many_rules
+    100.times do
+      @obj.on_signal "Whichever" do
+        puts "not called"
+      end
+    end
+  end
+
+  def test_removing_a_nonexistent_rule
+    @obj.on_signal "DoesNotExist"
+  end
+end