ruby-dbus 0.16.0 → 0.25.0

data/spec/server_robustness_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test that a server survives various error cases
 require_relative "spec_helper"
 require "dbus"
@@ -14,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
 
@@ -23,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
 
@@ -31,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
 
@@ -39,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
 
@@ -49,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
 
@@ -58,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/session_bus_spec.rb

@@ -1,7 +1,26 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 require_relative "spec_helper"
 require "dbus"
 
+describe DBus::ASystemBus do
+  describe "#initialize" do
+    it "will use DBUS_SYSTEM_BUS_ADDRESS or the well known address" do
+      expect(ENV)
+        .to receive(:[])
+        .with("DBUS_SYSTEM_BUS_ADDRESS")
+        .and_return(nil)
+      expect(DBus::MessageQueue)
+        .to receive(:new)
+        .with("unix:path=/var/run/dbus/system_bus_socket")
+      expect_any_instance_of(described_class).to receive(:send_hello)
+
+      described_class.new
+    end
+  end
+end
+
 describe DBus::ASessionBus do
   subject(:dbus_session_bus_address) { "unix:abstract=/tmp/dbus-foo,guid=123" }
 
@@ -16,6 +35,22 @@ describe DBus::ASessionBus do
       ENV["DBUS_SESSION_BUS_ADDRESS"] = dbus_session_bus_address
       expect(DBus::ASessionBus.session_bus_address).to eq(dbus_session_bus_address)
     end
+
+    it "uses launchd on macOS when ENV and file fail" do
+      ENV["DBUS_SESSION_BUS_ADDRESS"] = nil
+      expect(described_class).to receive(:address_from_file).and_return(nil)
+      expect(DBus::Platform).to receive(:macos?).and_return(true)
+
+      expect(described_class.session_bus_address).to start_with "launchd:"
+    end
+
+    it "raises a readable exception when all addresses fail" do
+      ENV["DBUS_SESSION_BUS_ADDRESS"] = nil
+      expect(described_class).to receive(:address_from_file).and_return(nil)
+      expect(DBus::Platform).to receive(:macos?).and_return(false)
+
+      expect { described_class.session_bus_address }.to raise_error(NotImplementedError, /Cannot find session bus/)
+    end
   end
 
   describe "#address_from_file" do
@@ -23,7 +58,7 @@ describe DBus::ASessionBus do
 
     before do
       # mocks of files for address_from_file method
-      machine_id_path = File.expand_path("/etc/machine-id", __FILE__)
+      machine_id_path = File.expand_path("/etc/machine-id", __dir__)
       expect(Dir).to receive(:[]).with(any_args) { [machine_id_path] }
       expect(File).to receive(:read).with(machine_id_path) { "baz" }
       expect(File).to receive(:exist?).with(session_bus_file_path) { true }

data/spec/session_bus_spec_manual.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 require_relative "spec_helper"
 require "dbus"
 

data/spec/signal_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test the signal handlers
 require_relative "spec_helper"
 require "dbus"
@@ -29,7 +31,7 @@ describe "SignalHandlerTest" do
   end
 
   # testing for commit 017c83 (kkaempf)
-  it "tests overriding a handler" do
+  it "tests overriding a handler", slow: true do
     DBus.logger.debug "Inside test_overriding_a_handler"
     counter = 0
 
@@ -52,7 +54,7 @@ describe "SignalHandlerTest" do
     expect(counter).to eq(1)
   end
 
-  it "tests on signal overload" do
+  it "tests on signal overload", slow: true do
     DBus.logger.debug "Inside test_on_signal_overload"
     counter = 0
     started = false
@@ -74,7 +76,7 @@ describe "SignalHandlerTest" do
     expect { @intf.on_signal "to", "many", "yarrrrr!" }.to raise_error(ArgumentError)
   end
 
-  it "is possible to add signal handlers from within handlers" do
+  it "is possible to add signal handlers from within handlers", slow: true do
     ended = false
     @intf.on_signal "LongTaskStart" do
       @intf.on_signal "LongTaskEnd" do
@@ -101,4 +103,15 @@ describe "SignalHandlerTest" do
   it "tests removing a nonexistent rule" do
     @obj.on_signal "DoesNotExist"
   end
+
+  describe DBus::ProxyObject do
+    describe "#on_signal" do
+      it "raises a descriptive error when the default_iface is wrong" do
+        open_quote = RUBY_VERSION >= "3.4" ? "'" : "`"
+        @obj.default_iface = "org.ruby.NoSuchInterface"
+        expect { @obj.on_signal("Foo") {} }
+          .to raise_error(NoMethodError, /undefined signal.*interface #{open_quote}org.ruby.NoSuchInterface'/)
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,42 +1,20 @@
-coverage = if ENV["COVERAGE"]
-             ENV["COVERAGE"] == "true"
-           else
-             # heuristics: enable for interactive builds (but not in OBS)
-             # or in Travis
-             ENV["DISPLAY"] || ENV["TRAVIS"]
-           end
-
-if coverage
-  require "simplecov"
-  SimpleCov.root File.expand_path("../..", __FILE__)
-
-  # do not cover specs
-  SimpleCov.add_filter "_spec.rb"
-  # do not cover the activesupport helpers
-  SimpleCov.add_filter "/core_ext/"
-
-  # use coveralls for on-line code coverage reporting at Travis CI
-  if ENV["TRAVIS"]
-    require "coveralls"
-  end
-  SimpleCov.start
-end
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require_relative "coverage_helper"
 
-if Object.const_defined? "RSpec"
-  # http://betterspecs.org/#expect
-  RSpec.configure do |config|
-    config.expect_with :rspec do |c|
-      c.syntax = :expect
-    end
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+# http://betterspecs.org/#expect
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
   end
 end
 
 require "tempfile"
 require "timeout"
 
-TOPDIR = File.expand_path("../..", __FILE__)
+TOPDIR = File.expand_path("..", __dir__)
 
 # path of config file for a private bus
 def config_file_path
@@ -86,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
@@ -102,5 +80,19 @@ 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
+def buffer_from_yaml(parts)
+  strings = parts.flatten.map do |part|
+    if part.is_a? Integer
+      part.chr
+    else
+      part
+    end
+  end
+  strings.join.force_encoding(Encoding::BINARY)
 end

data/spec/thread_safety_spec.rb

@@ -1,30 +1,73 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test thread safety
 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 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
+      end
+
+      svc.unexport(obj)
+      puts
     end
-    jobs.each(&:join)
   end
 end

data/spec/tools/dbus-launch-simple

@@ -12,13 +12,16 @@ 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
-	sleep 0.1
-	TRIES=`expr $TRIES + 1`
-	if [ $TRIES -gt 100 ]; then echo "dbus-daemon failed?"; exit 1; fi
+        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)
@@ -26,10 +29,10 @@ my_dbus_launch () {
 #    dbus-monitor &
 }
 
-my_dbus_launch
-
 # Clean up at exit.
 trap "kill \$KILLS; rm -rf \$RM_FILES" EXIT TERM INT
 
+my_dbus_launch
+
 # run the payload; the return value is passed on
 "$@"

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

@@ -7,7 +7,31 @@
   <!-- 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/>
+  -->
+
+  <!-- Give clients a variety of addresses to connect to -->
   <listen>unix:tmpdir=/tmp</listen>
+  <listen>unix:dir=/tmp</listen>
+  <!-- runtime will happily steal the actual session bus! -->
+  <!--
+  <listen>unix:runtime=yes</listen>
+  -->
+  <!-- openSUSE Build Service does not set up IPv6 at build time -->
+  <!--
+  <listen>tcp:host=%3a%3a1,family=ipv6</listen>
+  -->
   <listen>tcp:host=127.0.0.1</listen>
 
   <standard_session_servicedirs />
@@ -19,10 +43,18 @@
     <allow eavesdrop="true"/>
     <!-- Allow anyone to own anything -->
     <allow own="*"/>
+
+    <!-- To test how request_name handles bus errors -->
+    <deny own="org.rubygems.ruby_dbus.NobodyCanOwnThisName"/>
   </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 -->
+  <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
+  -->
+  <apparmor mode="disabled"/>
 </busconfig>

data/spec/tools/test_env

@@ -2,13 +2,33 @@
 # test_env: set up the environment needed to run tests:
 # - set up a private bus
 # - run a test server on it
+set -o errexit
 
 #export DBUS_VERBOSE=1
 #export RUBYOPT="-d"
 export RUBYOPT="$RUBYOPT -w"
-DIR=$(dirname $0)
-$DIR/test_server \
-	$DIR/../service_newapi.rb \
-	-- \
-	$DIR/dbus-launch-simple \
-	"$@"
+MYDIR=$(dirname $0)
+TOPDIR=$(realpath $MYDIR/../..)
+
+
+# Clean up at exit.
+trap "rm -rf \$RM_FILES" EXIT TERM INT
+
+export XDG_DATA_DIRS=`mktemp -d dbus.activation.XXXXXX`
+RM_FILES="$RM_FILES $XDG_DATA_DIRS"
+
+SVCDIR=$XDG_DATA_DIRS/dbus-1/services
+mkdir -p $SVCDIR
+for SVC in $TOPDIR/spec/mock-service/*.service; do
+  SVCBASE=${SVC##*/}
+  sed -e "s@\(Exec\)=/usr/bin/@\1=$TOPDIR/spec/mock-service/@" $SVC > $SVCDIR/$SVCBASE
+done
+
+
+# no command given -> run an interactive shell
+if [ $# = 0 ]; then
+  set -- env PS1="TEST_ENV \w> " bash
+fi
+
+$MYDIR/dbus-launch-simple \
+	"$@"