ruby-dbus 0.16.0 → 0.25.0

data/spec/emits_changed_signal_spec.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::EmitsChangedSignal do
+  describe "#initialize" do
+    it "accepts a simple value" do
+      expect(described_class.new(:const).value).to eq :const
+    end
+
+    it "avoids nil by asking the interface" do
+      ifc = DBus::Interface.new("org.example.Foo")
+      ifc.emits_changed_signal = described_class.new(:invalidates)
+
+      expect(described_class.new(nil, interface: ifc).value).to eq :invalidates
+    end
+
+    it "fails for unknown value" do
+      expect { described_class.new(:huh) }.to raise_error(ArgumentError, /Seen :huh/)
+    end
+
+    it "fails for 2 nils" do
+      expect { described_class.new(nil, interface: nil) }.to raise_error(ArgumentError, /Both/)
+    end
+  end
+
+  describe "#==" do
+    it "is true for two different objects with the same value" do
+      const_a = described_class.new(:const)
+      const_b = described_class.new(:const)
+      expect(const_a == const_b).to be true
+    end
+  end
+
+  describe "#to_xml" do
+    it "uses a string value" do
+      expect(described_class.new(:const).to_xml)
+        .to eq "    <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"const\"/>\n"
+    end
+  end
+
+  describe "#to_s" do
+    it "uses a string value" do
+      expect(described_class.new(:const).to_s).to eq "const"
+    end
+  end
+end
+
+describe DBus::Interface do
+  describe ".emits_changed_signal=" do
+    it "only allows an EmitsChangedSignal as argument" do
+      ifc = described_class.new("org.ruby.Interface")
+      expect { ifc.emits_changed_signal = :const }.to raise_error(TypeError)
+    end
+  end
+end

data/spec/err_msg_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # should report it missing on org.ruby.SampleInterface
 # (on object...) instead of on DBus::Proxy::ObjectInterface
 require_relative "spec_helper"

data/spec/introspect_xml_parser_spec.rb

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

data/spec/introspection_spec.rb

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

data/spec/main_loop_spec.rb

@@ -1,8 +1,24 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test the main loop
 require_relative "spec_helper"
 require "dbus"
 
+describe "DBus.logger" do
+  it "will log debug messages if $DEBUG is true" do
+    logger_old = DBus.logger
+    DBus.logger = nil
+    debug_old = $DEBUG
+    $DEBUG = true
+
+    DBus.logger.debug "this debug message will always be shown"
+
+    $DEBUG = debug_old
+    DBus.logger = logger_old
+  end
+end
+
 describe "MainLoopTest" do
   before(:each) do
     @session_bus = DBus::ASessionBus.new
@@ -70,7 +86,7 @@ describe "MainLoopTest" do
     @obj.on_signal "LongTaskEnd"
   end
 
-  it "tests loop quit" do
+  it "tests loop quit", slow: true do
     test_loop_quit 1
   end
 

data/spec/message_spec.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+# Pedantic full coverage test.
+# The happy paths are covered via calling classes
+describe DBus::Message do
+  describe "#marshall" do
+    it "raises when the object path is /org/freedesktop/DBus/Local" do
+      m = DBus::Message.new(DBus::Message::SIGNAL)
+      # the path is valid, it just must not be sent
+      m.path = DBus::ObjectPath.new("/org/freedesktop/DBus/Local")
+      m.interface = "org.example.spam"
+      m.member = "Spam"
+
+      expect { m.marshall }.to raise_error(RuntimeError, /Cannot send a message with the reserved path/)
+    end
+  end
+end

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,25 +1,63 @@
 #!/usr/bin/env ruby
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+# 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"
 
-require_relative "spec_helper"
-SimpleCov.command_name "Service Tests" if Object.const_defined? "SimpleCov"
 # find the library without external help
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 
 require "dbus"
 
-PROPERTY_INTERFACE = "org.freedesktop.DBus.Properties".freeze
+SERVICE_NAME = "org.ruby.service"
+
+class TestChild < DBus::Object
+  def initialize(opath)
+    @name = opath.split("/").last.capitalize
+    super
+  end
+
+  dbus_interface "org.ruby.TestChild" do
+    dbus_reader_attr_accessor :name, "s"
+  end
+end
 
 class Test < DBus::Object
-  INTERFACE = "org.ruby.SampleInterface".freeze
+  Point2D = Struct.new(:x, :y)
+
+  attr_writer :main_loop
+
+  include DBus::ObjectManager
+
+  INTERFACE = "org.ruby.SampleInterface"
   def initialize(path)
     super path
     @read_me = "READ ME"
     @read_or_write_me = "READ OR WRITE ME"
+    @my_struct = ["three", "strings", "in a struct"].freeze
+    @my_array = [42, 43]
+    @my_dict = {
+      "one" => 1,
+      "two" => "dva",
+      "three" => [3, 3, 3]
+    }
+    @my_variant = @my_array.dup
+    # 201 is a RET instruction for ZX Spectrum which has turned 40 recently
+    @my_byte = 201
+    @main_loop = nil
   end
 
   # Create an interface aggregating all upcoming dbus_method defines.
   dbus_interface INTERFACE do
+    dbus_method :quit, "" do
+      @main_loop&.quit
+    end
+
     dbus_method :hello, "in name:s, in name2:s" do |name, name2|
       puts "hello(#{name}, #{name2})"
     end
@@ -59,6 +97,60 @@ class Test < DBus::Object
     dbus_method :mirror_byte_array, "in bytes:ay, out mirrored:ay" do |bytes|
       [bytes]
     end
+
+    dbus_method :Coordinates, "out coords:(dd)" do
+      coords = [3.0, 4.0].freeze
+      [coords]
+    end
+
+    dbus_method :Coordinates2, "out coords:(dd)" do
+      coords = Point2D.new(5.0, 12.0)
+      [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
+    # ReadOrWriteMe:string, returns "READ OR WRITE ME" at first
+    dbus_attr_accessor :read_or_write_me, "s"
+    dbus_attr_reader :read_me, "s"
+
+    def write_me=(value)
+      raise "We don't talk about Bruno" if value =~ /Bruno/
+
+      @read_me = value
+    end
+    dbus_writer :write_me, "s"
+
+    dbus_attr_writer :password, "s"
+
+    # a property that raises when client tries to read it
+    def explosive
+      raise "Something failed"
+    end
+    dbus_reader :explosive, "s"
+
+    dbus_attr_accessor :my_struct, "(sss)"
+    dbus_attr_accessor :my_array, "aq"
+    dbus_attr_accessor :my_dict, "a{sv}"
+    dbus_attr_accessor :my_variant, "v"
+
+    dbus_attr_accessor :my_byte, "y"
+
+    # to test dbus_properties_changed
+    dbus_method :SetTwoProperties, "in read_me:s, in byte:y" do |read_me, byte|
+      @read_me = read_me
+      @my_byte = byte
+      dbus_properties_changed(INTERFACE,
+                              { "ReadMe" => read_me, "MyByte" => byte },
+                              [])
+    end
   end
 
   # closing and reopening the same interface
@@ -90,11 +182,29 @@ 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}")
+      object_server.export(child)
+      [child.path]
+    end
+
+    dbus_method :Delete, "in opath:o" do |opath|
+      raise ArgumentError unless opath.start_with?(path)
+
+      object_server.unexport(opath)
+    end
+  end
+
   dbus_interface "org.ruby.Duplicates" do
     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
@@ -118,72 +228,6 @@ class Test < DBus::Object
     dbus_signal :LongTaskStart
     dbus_signal :LongTaskEnd
   end
-
-  # Properties:
-  # ReadMe:string, returns "READ ME" at first, then what WriteMe received
-  # WriteMe:string
-  # ReadOrWriteMe:string, returns "READ OR WRITE ME" at first
-  dbus_interface PROPERTY_INTERFACE do
-    dbus_method :Get, "in interface:s, in propname:s, out value:v" do |interface, propname|
-      unless interface == INTERFACE
-        raise DBus.error("org.freedesktop.DBus.Error.UnknownInterface"),
-              "Interface '#{interface}' not found on object '#{@path}'"
-      end
-
-      case propname
-      when "ReadMe"
-        [@read_me]
-      when "ReadOrWriteMe"
-        [@read_or_write_me]
-      when "WriteMe"
-        raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"),
-              "Property '#{interface}.#{propname}' (on object '#{@path}') is not readable"
-      else
-        # what should happen for unknown properties
-        # plasma: InvalidArgs (propname), UnknownInterface (interface)
-        raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"),
-              "Property '#{interface}.#{propname}' not found on object '#{@path}'"
-      end
-    end
-
-    dbus_method :Set, "in interface:s, in propname:s, in  value:v" do |interface, propname, value|
-      unless interface == INTERFACE
-        raise DBus.error("org.freedesktop.DBus.Error.UnknownInterface"),
-              "Interface '#{interface}' not found on object '#{@path}'"
-      end
-
-      case propname
-      when "ReadMe"
-        raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"),
-              "Property '#{interface}.#{propname}' (on object '#{@path}') is not writable"
-      when "ReadOrWriteMe"
-        @read_or_write_me = value
-        self.PropertiesChanged(interface, { propname => value }, [])
-      when "WriteMe"
-        @read_me = value
-        self.PropertiesChanged(interface, { "ReadMe" => value }, [])
-      else
-        raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"),
-              "Property '#{interface}.#{propname}' not found on object '#{@path}'"
-      end
-    end
-
-    dbus_method :GetAll, "in interface:s, out value:a{sv}" do |interface|
-      unless interface == INTERFACE
-        raise DBus.error("org.freedesktop.DBus.Error.UnknownInterface"),
-              "Interface '#{interface}' not found on object '#{@path}'"
-      end
-
-      [
-        {
-          "ReadMe" => @read_me,
-          "ReadOrWriteMe" => @read_or_write_me
-        }
-      ]
-    end
-
-    dbus_signal :PropertiesChanged, "interface:s, changed_properties:a{sv}, invalidated_properties:as"
-  end
 end
 
 class Derived < Test
@@ -198,13 +242,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
@@ -221,11 +266,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