ruby-dbus 0.18.1 → 0.20.0

data/spec/proxy_object_interface_spec.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::ProxyObjectInterface do
+  # TODO: tag tests that need a service, eg "needs-service"
+  # TODO: maybe remove this and rely on a packaged tool
+  around(:each) do |example|
+    with_private_bus do
+      with_service_by_activation(&example)
+    end
+  end
+
+  let(:bus) { DBus::ASessionBus.new }
+
+  context "when calling org.ruby.service" do
+    let(:svc) { bus["org.ruby.service"] }
+
+    # This is white box testing, knowing the implementation
+    # A better way would be structuring it according to the D-Bus Spec
+    # Or testing the service side doing the right thing? (What if our bugs cancel out)
+    describe "#define_method_from_descriptor" do
+      it "can call a method with multiple OUT arguments" do
+        obj = svc["/org/ruby/MyInstance"]
+        ifc = obj["org.ruby.SampleInterface"]
+
+        even, odd = ifc.EvenOdd([3, 1, 4, 1, 5, 9, 2, 6])
+        expect(even).to eq [4, 2, 6]
+        expect(odd).to eq [3, 1, 1, 5, 9]
+      end
+    end
+  end
+end

data/spec/server_robustness_spec.rb

@@ -16,7 +16,7 @@ describe "ServerRobustnessTest" do
   it "tests no such path with introspection" do
     obj = @svc.object "/org/ruby/NotMyInstance"
     expect { obj.introspect }.to raise_error(DBus::Error) do |e|
-      expect(e).to_not match(/timeout/)
+      expect(e.message).to_not match(/timeout/)
     end
   end
 
@@ -25,7 +25,19 @@ describe "ServerRobustnessTest" do
     ifc = DBus::ProxyObjectInterface.new(obj, "org.ruby.SampleInterface")
     ifc.define_method("the_answer", "out n:i")
     expect { ifc.the_answer }.to raise_error(DBus::Error) do |e|
-      expect(e).to_not match(/timeout/)
+      expect(e.message).to_not match(/timeout/)
+    end
+  end
+
+  context "an existing path without an object" do
+    let(:obj) { @svc.object "/org" }
+
+    it "errors without a timeout" do
+      ifc = DBus::ProxyObjectInterface.new(obj, "org.ruby.SampleInterface")
+      ifc.define_method("the_answer", "out n:i")
+      expect { ifc.the_answer }.to raise_error(DBus::Error) do |e|
+        expect(e.message).to_not match(/timeout/)
+      end
     end
   end
 
@@ -33,7 +45,7 @@ describe "ServerRobustnessTest" do
     obj = @svc.object "/org/ruby/MyInstance"
     obj.default_iface = "org.ruby.SampleInterface"
     expect { obj.will_raise }.to raise_error(DBus::Error) do |e|
-      expect(e).to_not match(/timeout/)
+      expect(e.message).to_not match(/timeout/)
     end
   end
 
@@ -41,7 +53,7 @@ describe "ServerRobustnessTest" do
     obj = @svc.object "/org/ruby/MyInstance"
     obj.default_iface = "org.ruby.SampleInterface"
     expect { obj.will_raise_name_error }.to raise_error(DBus::Error) do |e|
-      expect(e).to_not match(/timeout/)
+      expect(e.message).to_not match(/timeout/)
     end
   end
 
@@ -51,7 +63,7 @@ describe "ServerRobustnessTest" do
     ifc = DBus::ProxyObjectInterface.new(obj, "org.ruby.SampleInterface")
     ifc.define_method("not_the_answer", "out n:i")
     expect { ifc.not_the_answer }.to raise_error(DBus::Error) do |e|
-      expect(e).to_not match(/timeout/)
+      expect(e.message).to_not match(/timeout/)
     end
   end
 
@@ -60,7 +72,7 @@ describe "ServerRobustnessTest" do
     ifc = DBus::ProxyObjectInterface.new(obj, "org.ruby.NoSuchInterface")
     ifc.define_method("the_answer", "out n:i")
     expect { ifc.the_answer }.to raise_error(DBus::Error) do |e|
-      expect(e).to_not match(/timeout/)
+      expect(e.message).to_not match(/timeout/)
     end
   end
 end

data/spec/service_newapi.rb

@@ -10,11 +10,24 @@ require "dbus"
 
 PROPERTY_INTERFACE = "org.freedesktop.DBus.Properties"
 
+class TestChild < DBus::Object
+  def initialize(opath)
+    @name = opath.split("/").last.capitalize
+    super
+  end
+
+  dbus_interface "org.ruby.TestChild" do
+    dbus_attr_reader :name, "s"
+  end
+end
+
 class Test < DBus::Object
   Point2D = Struct.new(:x, :y)
 
   attr_writer :main_loop
 
+  include DBus::ObjectManager
+
   INTERFACE = "org.ruby.SampleInterface"
   def initialize(path)
     super path
@@ -89,6 +102,12 @@ class Test < DBus::Object
       [coords]
     end
 
+    # Two OUT arguments
+    dbus_method :EvenOdd, "in numbers:ai, out even:ai, out odd:ai" do |numbers|
+      even, odd = numbers.partition(&:even?)
+      [even, odd]
+    end
+
     # Properties:
     # ReadMe:string, returns "READ ME" at first, then what WriteMe received
     # WriteMe:string
@@ -155,6 +174,21 @@ class Test < DBus::Object
     end
   end
 
+  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)
+      [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)
+    end
+  end
+
   dbus_interface "org.ruby.Duplicates" do
     dbus_method :the_answer, "out answer:i" do
       [0]

data/spec/service_spec.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe "DBus::Service (server role)" do
+  let(:bus) { DBus::ASessionBus.new }
+  # This is the client role, but the server role API is bad
+  # and for the one test there is no difference
+  let(:service) { bus["org.ruby.service"] }
+
+  describe "#descendants_for" do
+    it "raises for not existing path" do
+      expect { service.descendants_for("/notthere") }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -31,7 +31,7 @@ if coverage
       c.single_report_path = "coverage/lcov.info"
     end
 
-    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [
       SimpleCov::Formatter::HTMLFormatter,
       SimpleCov::Formatter::LcovFormatter
     ]

data/spec/thread_safety_spec.rb

@@ -5,28 +5,71 @@
 require_relative "spec_helper"
 require "dbus"
 
-describe "ThreadSafetyTest" do
-  it "tests thread competition" do
-    print "Thread competition: "
-    jobs = []
-    5.times do
-      jobs << Thread.new do
-        Thread.current.abort_on_exception = true
+class TestSignalRace < DBus::Object
+  dbus_interface "org.ruby.ServerTest" do
+    dbus_signal :signal_without_arguments
+  end
+end
+
+# Run *count* threads all doing *body*, wait for their finish
+def race_threads(count, &body)
+  jobs = count.times.map do |j|
+    Thread.new do
+      Thread.current.abort_on_exception = true
+
+      body.call(j)
+    end
+  end
+  jobs.each(&:join)
+end
+
+# Repeat *count* times: { random sleep, *body* }, printing progress
+def repeat_with_jitter(count, &body)
+  count.times do |i|
+    sleep 0.1 * rand
+    print "#{i} "
+    $stdout.flush
 
+    body.call
+  end
+end
+
+describe "thread safety" do
+  context "R/W: when the threads call methods with return values" do
+    it "it works with separate bus connections" do
+      race_threads(5) do |_j|
         # use separate connections to avoid races
         bus = DBus::ASessionBus.new
         svc = bus.service("org.ruby.service")
         obj = svc.object("/org/ruby/MyInstance")
         obj.default_iface = "org.ruby.SampleInterface"
 
-        10.times do |i|
-          print "#{i} "
-          $stdout.flush
+        repeat_with_jitter(10) do
           expect(obj.the_answer[0]).to eq(42)
-          sleep 0.1 * rand
         end
       end
+      puts
+    end
+  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
+
+        repeat_with_jitter(10) do
+          obj.signal_without_arguments
+        end
+
+        svc.unexport(obj)
+      end
+      puts
     end
-    jobs.each(&:join)
   end
 end

data/spec/tools/dbus-limited-session.conf

@@ -7,6 +7,20 @@
   <!-- Our well-known bus type, don't change this -->
   <type>session</type>
 
+  <!-- Authentication:
+       This was useful during refactoring, but meanwhile RSpec mocking has
+       replaced it. -->
+  <!-- Explicitly list all known authentication mechanisms,
+       their order is not important.
+       By default the daemon allows all but this lets me disable some. -->
+  <auth>EXTERNAL</auth>
+  <auth>DBUS_COOKIE_SHA1</auth>
+  <auth>ANONYMOUS</auth>
+  <!-- Insecure, other users could call us and exploit debug APIs/bugs -->
+  <!--
+  <allow_anonymous/>
+  -->
+
   <listen>unix:tmpdir=/tmp</listen>
   <listen>tcp:host=127.0.0.1</listen>
 
@@ -24,6 +38,7 @@
   <!-- 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 -->
+  <limit name="reply_timeout">5000</limit><!-- 5 seconds -->
 
   <!--
 dbus-daemon[1700]: [session uid=1001 pid=1700] Unable to set up new connection: Failed to get AppArmor confinement information of socket peer: Protocol not available

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dbus
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Ruby DBus Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -155,6 +155,7 @@ files:
 - lib/dbus/message.rb
 - lib/dbus/message_queue.rb
 - lib/dbus/object.rb
+- lib/dbus/object_manager.rb
 - lib/dbus/object_path.rb
 - lib/dbus/proxy_object.rb
 - lib/dbus/proxy_object_factory.rb
@@ -164,6 +165,7 @@ files:
 - lib/dbus/xml.rb
 - ruby-dbus.gemspec
 - spec/async_spec.rb
+- spec/auth_spec.rb
 - spec/binding_spec.rb
 - spec/bus_and_xml_backend_spec.rb
 - spec/bus_driver_spec.rb
@@ -179,15 +181,18 @@ files:
 - spec/introspection_spec.rb
 - spec/main_loop_spec.rb
 - spec/node_spec.rb
+- spec/object_manager_spec.rb
 - spec/object_path_spec.rb
 - spec/object_spec.rb
 - spec/packet_marshaller_spec.rb
 - spec/packet_unmarshaller_spec.rb
 - spec/property_spec.rb
+- spec/proxy_object_interface_spec.rb
 - spec/proxy_object_spec.rb
 - spec/server_robustness_spec.rb
 - spec/server_spec.rb
 - spec/service_newapi.rb
+- spec/service_spec.rb
 - spec/session_bus_spec.rb
 - spec/session_bus_spec_manual.rb
 - spec/signal_spec.rb
@@ -220,8 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.3
+rubygems_version: 3.3.0.dev
 signing_key: 
 specification_version: 4
 summary: Ruby module for interaction with D-Bus