ruby-dbus 0.22.1 → 0.23.0.beta2

data/spec/mock-service/cockpit-dbustests.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../coverage_helper"
+SimpleCov.command_name "Cockpit Tests (#{Process.pid})" if Object.const_defined? "SimpleCov"
+
+# find the library without external help
+$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
+require "dbus"
+
+SERVICE_NAME = "org.rubygems.ruby_dbus.DBusTests"
+ROOT_OPATH = "/otree/frobber"
+
+class DBusTests < DBus::Object
+  FROBBER_INTERFACE = "com.redhat.Cockpit.DBusTests.Frobber"
+
+  dbus_interface FROBBER_INTERFACE do
+    dbus_method :HelloWorld, "in greeting:s, out response:s" do |greeting|
+      # TODO: return the same thing as the original implementation
+      # and try substituting it?
+      [format("Word! You said `%s'. I'm Skeleton, btw!", greeting)]
+    end
+  end
+end
+
+bus = DBus::SessionBus.instance
+bus.object_server.export(DBusTests.new(ROOT_OPATH))
+bus.request_name(SERVICE_NAME)
+DBus::Main.new.tap { |m| m << bus }.run

data/spec/mock-service/com.redhat.Cockpit.DBusTests.xml

@@ -0,0 +1,180 @@
+<node>
+  <!--
+  This file is part of Cockpit.
+
+  Copyright (C) 2013 Red Hat, Inc.
+
+  Cockpit is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
+  (at your option) any later version.
+
+  Cockpit is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with Cockpit; If not, see <http://www.gnu.org/licenses/>.
+  -->
+
+  <interface name="com.redhat.Cockpit.DBusTests.Alpha">
+  </interface>
+
+  <interface name="com.redhat.Cockpit.DBusTests.Frobber">
+    <method name="HelloWorld">
+      <arg name="greeting" direction="in" type="s"/>
+      <arg name="response" direction="out" type="s"/>
+    </method>
+
+    <method name="NeverReturn">
+    </method>
+
+    <method name="TestPrimitiveTypes">
+      <arg direction="in"  type="y" name="val_byte" />
+      <arg direction="in"  type="b" name="val_boolean" />
+      <arg direction="in"  type="n" name="val_int16" />
+      <arg direction="in"  type="q" name="val_uint16" />
+      <arg direction="in"  type="i" name="val_int32" />
+      <arg direction="in"  type="u" name="val_uint32" />
+      <arg direction="in"  type="x" name="val_int64" />
+      <arg direction="in"  type="t" name="val_uint64" />
+      <arg direction="in"  type="d" name="val_double" />
+      <arg direction="in"  type="s" name="val_string" />
+      <arg direction="in"  type="o" name="val_objpath" />
+      <arg direction="in"  type="g" name="val_signature" />
+      <arg direction="in"  type="ay" name="val_bytestring" />
+      <arg direction="out" type="y" name="ret_byte" />
+      <arg direction="out" type="b" name="ret_boolean" />
+      <arg direction="out" type="n" name="ret_int16" />
+      <arg direction="out" type="q" name="ret_uint16" />
+      <arg direction="out" type="i" name="ret_int32" />
+      <arg direction="out" type="u" name="ret_uint32" />
+      <arg direction="out" type="x" name="ret_int64" />
+      <arg direction="out" type="t" name="ret_uint64" />
+      <arg direction="out" type="d" name="ret_double" />
+      <arg direction="out" type="s" name="ret_string" />
+      <arg direction="out" type="o" name="ret_objpath" />
+      <arg direction="out" type="g" name="ret_signature" />
+      <arg direction="out" type="ay" name="ret_bytestring" />
+    </method>
+
+    <method name="TestNonPrimitiveTypes">
+      <arg direction="in" type="a{ss}" name="dict_s_to_s" />
+      <arg direction="in" type="a{s(ii)}" name="dict_s_to_pairs" />
+      <arg direction="in" type="(iss)" name="a_struct" />
+      <arg direction="in" type="as" name="array_of_strings" />
+      <arg direction="in" type="ao" name="array_of_objpaths" />
+      <arg direction="in" type="ag" name="array_of_signatures" />
+      <arg direction="in" type="aay" name="array_of_bytestrings" />
+      <arg direction="out" type="s" name="result" />
+    </method>
+
+    <method name="TestAsv">
+      <arg direction="in" type="a{sv}" name="asv" />
+      <arg direction="out" type="s" name="result" />
+    </method>
+
+    <method name="TestVariant">
+      <arg direction="in" type="v" name="v" />
+    </method>
+
+    <method name="RequestSignalEmission">
+      <arg direction="in" type="i" name="which_one" />
+    </method>
+
+    <method name="RequestPropertyMods"/>
+
+    <method name="RequestMultiPropertyMods"/>
+
+    <method name="UnimplementedMethod"/>
+
+    <method name="PropertyCancellation"/>
+
+    <signal name="TestSignal">
+      <arg type="i" name="val_int32"/>
+      <arg type="as" name="array_of_strings" />
+      <arg type="ao" name="array_of_objpaths" />
+      <arg type="a{s(ii)}" name="dict_s_to_pairs" />
+    </signal>
+
+    <signal name="AnotherSignal">
+      <arg type="s" name="word" />
+    </signal>
+
+    <method name="DeleteAllObjects"/>
+
+    <method name="CreateObject">
+      <arg direction="in" type="o" name="at_path" />
+    </method>
+
+    <method name="DeleteObject">
+      <arg direction="in" type="o" name="path" />
+    </method>
+
+    <method name="AddAlpha"/>
+    <method name="RemoveAlpha"/>
+
+    <method name="CreateClique">
+      <arg direction="in" type="s" name="name" />
+      <arg direction="out" type="o" name="member" />
+    </method>
+
+    <method name="EmitHidden">
+      <arg direction="in" type="s" name="name" />
+    </method>
+
+    <method name="ClaimOtherName">
+      <arg name="name" direction="in" type="s"/>
+    </method>
+
+    <method name="ReleaseOtherName">
+      <arg name="name" direction="in" type="s"/>
+    </method>
+
+    <method name="TellMeYourName">
+      <arg direction="out" name="name" type="s"/>
+    </method>
+
+    <method name="MakeTestFd">
+        <arg direction="in" name="type" type="s"/>
+        <arg direction="out" name="fd" type="h"/>
+    </method>
+
+    <property name="y" type="y" access="readwrite"/>
+    <property name="b" type="b" access="readwrite"/>
+    <property name="n" type="n" access="readwrite"/>
+    <property name="q" type="q" access="readwrite"/>
+    <property name="i" type="i" access="readwrite"/>
+    <property name="u" type="u" access="readwrite"/>
+    <property name="x" type="x" access="readwrite"/>
+    <property name="t" type="t" access="readwrite"/>
+    <property name="d" type="d" access="readwrite"/>
+    <property name="s" type="s" access="readwrite"/>
+    <property name="o" type="o" access="readwrite"/>
+    <property name="g" type="g" access="readwrite"/>
+    <property name="ay" type="ay" access="readwrite"/>
+    <property name="as" type="as" access="readwrite"/>
+    <property name="aay" type="aay" access="readwrite"/>
+    <property name="ao" type="ao" access="readwrite"/>
+    <property name="ag" type="ag" access="readwrite"/>
+    <property name="FinallyNormalName" type="s" access="readwrite"/>
+    <property name="ReadonlyProperty" type="s" access="read"/>
+    <property name="WriteonlyProperty" type="s" access="write"/>
+  </interface>
+
+  <interface name="com.redhat.Cockpit.DBusTests.Clique">
+    <property name="Friend" type="o" access="read"/>
+  </interface>
+
+  <interface name="com.redhat.Cockpit.DBusTests.Hidden">
+    <property name="Name" type="s" access="read"/>
+  </interface>
+
+</node>
+
+<!-- 
+  Local Variables:
+  indent-tabs-mode: nil
+  End:
+-->

data/spec/mock-service/org.ruby.service.service

@@ -0,0 +1,4 @@
+[D-BUS Service]
+Name=org.ruby.service
+# ... will replace the directory with the current one
+Exec=/usr/bin/spaghetti-monster.rb

data/spec/mock-service/org.rubygems.ruby_dbus.DBusTests.service

@@ -0,0 +1,4 @@
+[D-BUS Service]
+Name=org.rubygems.ruby_dbus.DBusTests
+# ... will replace the directory with the current one
+Exec=/usr/bin/cockpit-dbustests.rb

data/spec/{service_newapi.rb → mock-service/spaghetti-monster.rb}

@@ -1,14 +1,20 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative "spec_helper"
-SimpleCov.command_name "Service Tests" if Object.const_defined? "SimpleCov"
+# This file was formerly named spec/service_newapi.rb, after the example
+# which it mutated from.
+# Spaghetti monster is a better name,
+# reflecting on its evolution and current nature :'-)
+
+require_relative "../coverage_helper"
+SimpleCov.command_name "Service Tests (#{Process.pid})" if Object.const_defined? "SimpleCov"
+
 # find the library without external help
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 
 require "dbus"
 
-PROPERTY_INTERFACE = "org.freedesktop.DBus.Properties"
+SERVICE_NAME = "org.ruby.service"
 
 class TestChild < DBus::Object
   def initialize(opath)
@@ -177,15 +183,14 @@ class Test < DBus::Object
   dbus_interface "org.ruby.TestParent" do
     dbus_method :New, "in name:s, out opath:o" do |name|
       child = TestChild.new("#{path}/#{name}")
-      @service.export(child)
+      object_server.export(child)
       [child.path]
     end
 
     dbus_method :Delete, "in opath:o" do |opath|
       raise ArgumentError unless opath.start_with?(path)
 
-      obj = @service.get_node(opath)&.object
-      @service.unexport(obj)
+      object_server.unexport(opath)
     end
   end
 
@@ -193,7 +198,11 @@ class Test < DBus::Object
     dbus_method :the_answer, "out answer:i" do
       [0]
     end
+
     dbus_method :interfaces, "out answer:i" do
+      # 'Shadowed' from the Ruby side, meaning ProxyObject#interfaces
+      # will return the list of interfaces rather than calling this method.
+      # Calling it with busctl will work just fine.
       raise "This DBus method is currently shadowed by ProxyObject#interfaces"
     end
   end
@@ -231,13 +240,14 @@ class Test2 < DBus::Object
 end
 
 bus = DBus::SessionBus.instance
-service = bus.request_service("org.ruby.service")
+service = bus.object_server
 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
+bus.request_name(SERVICE_NAME)
 
 # introspect every other connection, Ticket #34
 #  (except the one that activates us - it has already emitted
@@ -254,12 +264,13 @@ bus.add_match(mr) do |msg|
   end
 end
 
-puts "listening, with ruby-#{RUBY_VERSION}"
+DBus.logger.info "Service #{SERVICE_NAME} listening, with ruby-#{RUBY_VERSION}"
 main = DBus::Main.new
 main << bus
 myobj.main_loop = main
 begin
   main.run
-rescue SystemCallError
+rescue SystemCallError, SignalException => e
+  DBus.logger.info "Service #{SERVICE_NAME} got #{e.inspect}, exiting"
   # the test driver will kill the bus, that's OK
 end

data/spec/node_spec.rb

@@ -44,11 +44,7 @@ describe DBus::Node do
 
     context "on the bus" do
       let(:bus) { DBus::ASessionBus.new }
-      let(:service) do
-        # if we used org.ruby.service it would be a name collision
-        # ... which would not break the test for lucky reasons
-        bus.request_service("org.ruby.service.scratch")
-      end
+      let(:service) { bus.object_server }
 
       before do
         service.export(DBus::Object.new(manager_path))

data/spec/object_server_spec.rb

@@ -0,0 +1,138 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::ObjectServer do
+  let(:bus) { DBus::ASessionBus.new }
+  let(:server) { bus.object_server }
+
+  describe "#descendants_for" do
+    it "raises for not existing path" do
+      expect { server.descendants_for("/notthere") }.to raise_error(ArgumentError, /notthere doesn't exist/)
+    end
+  end
+
+  # tag_bus MEANS that the test needs a session bus
+  # tag_service MEANS that it needs a session bus with our testing services
+
+  describe "#export, #object, #[]", tag_bus: true do
+    it "object and [] return the object if it was exported" do
+      path = "/org/ruby/Foo"
+      obj = DBus::Object.new(path)
+      server.export(obj)
+      expect(server.object(path)).to be_equal(obj)
+      expect(server[path]).to be_equal(obj)
+    end
+
+    it "object and [] return nil if the path was not found or has no object" do
+      path = "/org/ruby/Bar"
+      obj = DBus::Object.new(path)
+      server.export(obj)
+
+      path2 = "/org/ruby/nosuch"
+      expect(server.object(path2)).to be_nil
+      expect(server[path2]).to be_nil
+
+      path3 = "/org"
+      expect(server.object(path3)).to be_nil
+      expect(server[path3]).to be_nil
+    end
+  end
+
+  describe "#export", tag_bus: true do
+    context "when exporting at a path where an object exists already" do
+      let(:path) { "/org/ruby/Same" }
+      let(:obj1) do
+        o = DBus::Object.new(path)
+        o.define_singleton_method(:which) { 1 }
+        o
+      end
+      let(:obj2) do
+        o = DBus::Object.new(path)
+        o.define_singleton_method(:which) { 2 }
+        o
+      end
+
+      it "raises an error" do
+        server.export(obj1)
+        expect { server.export(obj2) }.to raise_error(RuntimeError, /there is already an object/)
+      end
+    end
+  end
+
+  describe "#unexport", tag_bus: true do
+    before(:each) do
+      bus = DBus::ASessionBus.new
+      @svc = bus.object_server
+    end
+
+    it "returns the unexported leaf object" do
+      obj = DBus::Object.new "/org/ruby/Foo"
+      @svc.export obj
+      expect(@svc.unexport(obj)).to be_equal(obj)
+    end
+
+    it "returns the unexported leaf object, if specified by its path" do
+      obj = DBus::Object.new "/org/ruby/Foo"
+      @svc.export obj
+      expect(@svc.unexport(obj.path)).to be_equal(obj)
+
+      obj = DBus::Object.new "/org/ruby/Foo"
+      @svc.export obj
+      expect(@svc.unexport(DBus::ObjectPath.new(obj.path))).to be_equal(obj)
+    end
+
+    it "returns false if the object was never exported" do
+      obj = DBus::Object.new "/org/ruby/Foo"
+      expect(@svc.unexport(obj)).to be false
+    end
+
+    it "raises false if the path has no node" do
+      obj = DBus::Object.new "/org/ruby/Foo"
+      @svc.export obj
+      expect { @svc.unexport("/org/ruby/NotFoo") }.to raise_error(ArgumentError)
+      @svc.unexport obj
+    end
+
+    it "raises false if the path has no object" do
+      obj = DBus::Object.new "/org/ruby/Foo"
+      @svc.export obj
+      expect { @svc.unexport("/org/ruby") }.to raise_error(ArgumentError)
+      @svc.unexport obj
+    end
+
+    it "raises when argument is not usable" do
+      expect { @svc.unexport(:foo) }.to raise_error(ArgumentError)
+    end
+
+    context "/child_of_root" do
+      it "returns the unexported object" do
+        obj = DBus::Object.new "/child_of_root"
+        @svc.export obj
+        expect(@svc.unexport(obj)).to be_equal(obj)
+      end
+    end
+
+    context "/ (root)" do
+      it "returns the unexported object" do
+        obj = DBus::Object.new "/"
+        @svc.export obj
+        expect(@svc.unexport(obj)).to be_equal(obj)
+      end
+    end
+
+    context "not a leaf object" do
+      it "maintains objects on child paths" do
+        obj = DBus::Object.new "/org/ruby"
+        @svc.export obj
+        obj2 = DBus::Object.new "/org/ruby/Foo"
+        @svc.export obj2
+
+        @svc.unexport(obj)
+        expect(@svc.object("/org/ruby/Foo")).to be_a DBus::Object
+      end
+    end
+  end
+end

data/spec/object_spec.rb

@@ -118,6 +118,27 @@ describe DBus::Object do
     end
   end
 
+  describe ".dbus_signal" do
+    it "can only be used within a dbus_interface" do
+      expect do
+        ObjectTest.instance_exec do
+          dbus_signal :signal_without_interface
+        end
+      end.to raise_error(DBus::Object::UndefinedInterface)
+    end
+
+    it "cannot be named with a bang" do
+      expect do
+        ObjectTest.instance_exec do
+          dbus_interface "org.ruby.ServerTest" do
+            # a valid Ruby symbol but an invalid DBus name; Ticket#38
+            dbus_signal :signal_with_a_bang!
+          end
+        end
+      end.to raise_error(DBus::InvalidMethodName)
+    end
+  end
+
   describe ".emits_changed_signal" do
     it "raises UndefinedInterface when so" do
       expect { ObjectTest.emits_changed_signal = false }
@@ -145,4 +166,29 @@ describe DBus::Object do
       end.to raise_error(RuntimeError, /assigned more than once/)
     end
   end
+
+  # coverage obsession
+  describe "#dispatch" do
+    it "survives being called with a non-METHOD_CALL, doing nothing" do
+      obj = ObjectTest.new("/test")
+      msg = DBus::MethodReturnMessage.new
+      expect { obj.dispatch(msg) }.to_not raise_error
+    end
+  end
+
+  describe "#emit" do
+    context "before the object has been exported" do
+      it "raises an explanatory error" do
+        obj = ObjectTest.new("/test")
+
+        intf = DBus::Interface.new("org.example.Test")
+        signal = DBus::Signal.new("Ring")
+        expect { obj.emit(intf, signal) }
+          .to raise_error(
+            RuntimeError,
+            %r{Cannot emit signal org.example.Test.Ring before /test is exported}
+          )
+      end
+    end
+  end
 end

data/spec/{bus_driver_spec.rb → proxy_service_spec.rb}

@@ -4,14 +4,8 @@
 require_relative "spec_helper"
 require "dbus"
 
-describe DBus::Service do
-  context "when a private bus is set up" do
-    around(:each) do |example|
-      with_private_bus do
-        with_service_by_activation(&example)
-      end
-    end
-
+describe DBus::ProxyService do
+  context "when a private bus is set up", tag_service: true do
     let(:bus) { DBus::ASessionBus.new }
 
     describe "#exists?" do
@@ -26,5 +20,16 @@ describe DBus::Service do
         expect(svc.exists?).to be false
       end
     end
+
+    # This method is used by dbus-gui-gtk.
+    # Deprecate it? In favor of introspecting the tree gradually
+    # or move it to the application code?
+    describe "#introspect" do
+      it "creates the whole node tree" do
+        svc = bus.service("org.ruby.service")
+        expect { svc.introspect }.to_not raise_error
+        expect(svc.root.dig("org", "ruby", "MyInstance")).to be_a DBus::Node
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,51 +1,13 @@
 # frozen_string_literal: true
 
-coverage = if ENV["COVERAGE"]
-             ENV["COVERAGE"] == "true"
-           else
-             # heuristics: enable for interactive builds (but not in OBS)
-             ENV["DISPLAY"]
-           end
-
-if coverage
-  require "simplecov"
-  SimpleCov.root File.expand_path("..", __dir__)
-
-  # do not cover specs
-  SimpleCov.add_filter "_spec.rb"
-  # do not cover the activesupport helpers
-  SimpleCov.add_filter "/core_ext/"
-  # measure all if/else branches on a line
-  SimpleCov.enable_coverage :branch
-
-  SimpleCov.start
-
-  # additionally use the LCOV format for on-line code coverage reporting at CI
-  if ENV["COVERAGE_LCOV"] == "true"
-    require "simplecov-lcov"
-
-    SimpleCov::Formatter::LcovFormatter.config do |c|
-      c.report_with_single_file = true
-      # this is the default Coveralls GitHub Action location
-      # https://github.com/marketplace/actions/coveralls-github-action
-      c.single_report_path = "coverage/lcov.info"
-    end
-
-    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [
-      SimpleCov::Formatter::HTMLFormatter,
-      SimpleCov::Formatter::LcovFormatter
-    ]
-  end
-end
+require_relative "coverage_helper"
 
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 
-if Object.const_defined? "RSpec"
-  # http://betterspecs.org/#expect
-  RSpec.configure do |config|
-    config.expect_with :rspec do |c|
-      c.syntax = :expect
-    end
+# http://betterspecs.org/#expect
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
   end
 end
 
@@ -102,7 +64,7 @@ end
 
 def with_service_by_activation(&block)
   name = "org.ruby.service"
-  exec = "#{TOPDIR}/spec/service_newapi.rb"
+  exec = "#{TOPDIR}/spec/mock-service/spaghetti-monster.rb"
 
   service_dir = "#{ENV["XDG_DATA_DIRS"]}/dbus-1/services"
   FileUtils.mkdir_p service_dir
@@ -118,7 +80,9 @@ def with_service_by_activation(&block)
 
   block.call
 
-  system "pkill -f #{exec}"
+  # This would kill also other instances,
+  # namely on the bus set up by test_env.
+  ## system "pkill -f #{exec}"
 end
 
 # Make a binary string from readable YAML pieces; see data/marshall.yaml

data/spec/thread_safety_spec.rb

@@ -53,22 +53,20 @@ describe "thread safety" do
   end
 
   context "W/O: when the threads only send signals" do
-    it "it works with a shared separate bus connection" do
-      race_threads(5) do |j|
-        # shared connection
-        bus = DBus::SessionBus.instance
-        # hackish: we do not actually request the name
-        svc = DBus::Service.new("org.ruby.server-test#{j}", bus)
-
-        obj = TestSignalRace.new "/org/ruby/Foo"
-        svc.export obj
+    it "it works with a shared bus connection" do
+      # shared connection
+      bus = DBus::SessionBus.instance
+      svc = bus.object_server
+      obj = TestSignalRace.new "/org/ruby/Foo"
+      svc.export obj
 
+      race_threads(5) do |_j|
         repeat_with_jitter(10) do
           obj.signal_without_arguments
         end
-
-        svc.unexport(obj)
       end
+
+      svc.unexport(obj)
       puts
     end
   end

data/spec/tools/dbus-launch-simple

@@ -12,7 +12,10 @@ my_dbus_launch () {
     AF=`mktemp dbus.addr.XXXXXX` || exit
     RM_FILES="$RM_FILES $PF $AF"
 
-    dbus-daemon --config-file=$(dirname $0)/dbus-limited-session.conf --print-address=3 3>$AF --print-pid=4 4>$PF &
+    # For debugging:
+    # DBUS_DAEMON=~/svn/dbus/bus/dbus-daemon DBUS_VERBOSE=1 ./spec/tools/test_env env PS1="TEST $PS1" bash
+    : ${DBUS_DAEMON=dbus-daemon}
+    $DBUS_DAEMON --config-file=$(dirname $0)/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