ruby-dbus 0.18.0.beta1 → 0.18.0.beta4

data/spec/property_spec.rb

@@ -4,6 +4,14 @@
 require_relative "spec_helper"
 require "dbus"
 
+# FIXME: factor out DBus::TestFixtures::Value in spec_helper
+require "ostruct"
+require "yaml"
+
+data_dir = File.expand_path("data", __dir__)
+marshall_yaml_s = File.read("#{data_dir}/marshall.yaml")
+marshall_yaml = YAML.safe_load(marshall_yaml_s)
+
 describe "PropertyTest" do
   before(:each) do
     @session_bus = DBus::ASessionBus.new
@@ -52,7 +60,7 @@ describe "PropertyTest" do
 
   it "tests get all" do
     all = @iface.all_properties
-    expect(all.keys.sort).to eq(["MyStruct", "ReadMe", "ReadOrWriteMe"])
+    expect(all.keys.sort).to eq(["MyArray", "MyDict", "MyStruct", "MyVariant", "ReadMe", "ReadOrWriteMe"])
   end
 
   it "tests get all on a V1 object" do
@@ -60,7 +68,7 @@ describe "PropertyTest" do
     iface = obj["org.ruby.SampleInterface"]
 
     all = iface.all_properties
-    expect(all.keys.sort).to eq(["MyStruct", "ReadMe", "ReadOrWriteMe"])
+    expect(all.keys.sort).to eq(["MyArray", "MyDict", "MyStruct", "MyVariant", "ReadMe", "ReadOrWriteMe"])
   end
 
   it "tests unknown property reading" do
@@ -122,5 +130,75 @@ describe "PropertyTest" do
       struct = @iface["MyStruct"]
       expect(struct).to be_frozen
     end
+
+    it "Get returns the correctly typed value (check with dbus-send)" do
+      # As big as the DBus::Data branch is,
+      # it still does not handle the :exact mode on the client/proxy side.
+      # So we resort to parsing dbus-send output.
+      cmd = "dbus-send --print-reply " \
+            "--dest=org.ruby.service " \
+            "/org/ruby/MyInstance " \
+            "org.freedesktop.DBus.Properties.Get " \
+            "string:org.ruby.SampleInterface " \
+            "string:MyStruct"
+      reply = `#{cmd}`
+      expect(reply).to match(/variant\s+struct {\s+string "three"\s+string "strings"\s+string "in a struct"\s+}/)
+    end
+
+    it "GetAll returns the correctly typed value (check with dbus-send)" do
+      cmd = "dbus-send --print-reply " \
+            "--dest=org.ruby.service " \
+            "/org/ruby/MyInstance " \
+            "org.freedesktop.DBus.Properties.GetAll " \
+            "string:org.ruby.SampleInterface "
+      reply = `#{cmd}`
+      expect(reply).to match(/variant\s+struct {\s+string "three"\s+string "strings"\s+string "in a struct"\s+}/)
+    end
+  end
+
+  context "an array-typed property" do
+    it "gets read as an array" do
+      val = @iface["MyArray"]
+      expect(val).to eq([42, 43])
+    end
+  end
+
+  context "an dict-typed property" do
+    it "gets read as a hash" do
+      val = @iface["MyDict"]
+      expect(val).to eq({
+                          "one" => 1,
+                          "two" => "dva",
+                          "three" => [3, 3, 3]
+                        })
+    end
+  end
+
+  context "a variant-typed property" do
+    it "gets read at all" do
+      obj = @svc.object("/org/ruby/MyDerivedInstance")
+      iface = obj["org.ruby.SampleInterface"]
+      val = iface["MyVariant"]
+      expect(val).to eq([42, 43])
+    end
+  end
+
+  context "marshall.yaml round-trip via a VARIANT property" do
+    marshall_yaml.each do |test|
+      t = OpenStruct.new(test)
+      next if t.val.nil?
+
+      # Round trips do not work yet because the properties
+      # must present a plain Ruby value so the exact D-Bus type is lost.
+      # Round trips will work once users can declare accepting DBus::Data
+      # in properties and method arguments.
+      it "Sets #{t.sig.inspect}:#{t.val.inspect} and Gets something back" do
+        before = DBus::Data.make_typed(t.sig, t.val)
+        expect { @iface["MyVariant"] = before }.to_not raise_error
+        expect { _after = @iface["MyVariant"] }.to_not raise_error
+        # round-trip:
+        # expect(after).to eq(before.value)
+      end
+    end
   end
 end

data/spec/service_newapi.rb

@@ -13,16 +13,30 @@ PROPERTY_INTERFACE = "org.freedesktop.DBus.Properties"
 class Test < DBus::Object
   Point2D = Struct.new(:x, :y)
 
+  attr_writer :main_loop
+
   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
+    @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
@@ -93,7 +107,10 @@ class Test < DBus::Object
     end
     dbus_reader :explosive, "s"
 
-    dbus_attr_reader :my_struct, "(sss)"
+    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"
   end
 
   # closing and reopening the same interface
@@ -193,6 +210,7 @@ end
 puts "listening, with ruby-#{RUBY_VERSION}"
 main = DBus::Main.new
 main << bus
+myobj.main_loop = main
 begin
   main.run
 rescue SystemCallError

data/spec/spec_helper.rb

@@ -15,6 +15,8 @@ if coverage
   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
 
@@ -118,3 +120,15 @@ def with_service_by_activation(&block)
 
   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/type_spec.rb

@@ -6,15 +6,76 @@ require "dbus"
 
 describe DBus do
   describe ".type" do
-    ["i", "ai", "a(ii)", "aai"].each do |s|
-      it "parses some type #{s}" do
-        expect(DBus.type(s).to_s).to be_eql s
+    good = [
+      "i",
+      "ai",
+      "a(ii)",
+      "aai"
+    ]
+
+    context "valid single types" do
+      good.each do |s|
+        it "#{s.inspect} is parsed" do
+          expect(DBus.type(s).to_s).to eq(s)
+        end
+      end
+    end
+
+    bad = [
+      ["\x00", "Unknown type code"],
+      ["!", "Unknown type code"],
+
+      # ARRAY related
+      ["a", "Empty ARRAY"],
+      ["aa", "Empty ARRAY"],
+
+      # STRUCT related
+      ["r", "Abstract STRUCT"],
+      ["()", "Empty STRUCT"],
+      ["(ii", "STRUCT not closed"],
+      ["a{i)", "STRUCT unexpectedly closed"],
+
+      # TODO: deep nesting arrays, structs, combined
+
+      # DICT_ENTRY related
+      ["e", "Abstract DICT_ENTRY"],
+      ["a{}", "DICT_ENTRY must have 2 subtypes, found 0"],
+      ["a{s}", "DICT_ENTRY must have 2 subtypes, found 1"],
+      ["a{sss}", "DICT_ENTRY must have 2 subtypes, found 3"],
+      ["a{vs}", "DICT_ENTRY key must be basic (non-container)"],
+      ["{sv}", "DICT_ENTRY not an immediate child of an ARRAY"],
+      ["a({sv})", "DICT_ENTRY not an immediate child of an ARRAY"],
+      ["a{sv", "DICT_ENTRY not closed"],
+      ["}", "DICT_ENTRY unexpectedly closed"],
+
+      # Too long
+      ["(#{"y" * 254})", "longer than 255"],
+
+      # not Single Complete Types
+      ["", "expecting a Single Complete Type"],
+      ["ii", "more than a Single Complete Type"]
+    ]
+    context "invalid single types" do
+      bad.each.each do |s, msg|
+        it "#{s.inspect} raises an exception mentioning: #{msg}" do
+          rx = Regexp.new(Regexp.quote(msg))
+          expect { DBus.type(s) }.to raise_error(DBus::Type::SignatureException, rx)
+        end
       end
     end
+  end
+
+  describe ".types" do
+    good = [
+      "",
+      "ii"
+    ]
 
-    ["aa", "(ii", "ii)", "hrmp"].each do |s|
-      it "raises exception for invalid type #{s}" do
-        expect { DBus.type(s).to_s }.to raise_error DBus::Type::SignatureException
+    context "valid signatures" do
+      good.each do |s|
+        it "#{s.inspect} is parsed" do
+          expect(DBus.types(s).map(&:to_s).join).to eq(s)
+        end
       end
     end
   end

data/spec/zzz_quit_spec.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe "Quit the service" do
+  it "Tells the service to quit and waits, to collate coverage data" do
+    session_bus = DBus::ASessionBus.new
+    @svc = session_bus.service("org.ruby.service")
+    @obj = @svc.object("/org/ruby/MyInstance")
+    @obj.default_iface = "org.ruby.SampleInterface"
+    @obj.quit
+    sleep 3
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dbus
 version: !ruby/object:Gem::Version
-  version: 0.18.0.beta1
+  version: 0.18.0.beta4
 platform: ruby
 authors:
 - Ruby DBus Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -131,6 +131,7 @@ files:
 - examples/no-introspect/tracker-test.rb
 - examples/rhythmbox/playpause.rb
 - examples/service/call_service.rb
+- examples/service/complex-property.rb
 - examples/service/service_newapi.rb
 - examples/simple/call_introspect.rb
 - examples/simple/get_id.rb
@@ -144,6 +145,7 @@ files:
 - lib/dbus/bus_name.rb
 - lib/dbus/core_ext/class/attribute.rb
 - lib/dbus/core_ext/module/redefine_method.rb
+- lib/dbus/data.rb
 - lib/dbus/error.rb
 - lib/dbus/introspect.rb
 - lib/dbus/logger.rb
@@ -156,6 +158,7 @@ files:
 - lib/dbus/proxy_object.rb
 - lib/dbus/proxy_object_factory.rb
 - lib/dbus/proxy_object_interface.rb
+- lib/dbus/raw_message.rb
 - lib/dbus/type.rb
 - lib/dbus/xml.rb
 - ruby-dbus.gemspec
@@ -167,12 +170,16 @@ files:
 - spec/bus_spec.rb
 - spec/byte_array_spec.rb
 - spec/client_robustness_spec.rb
+- spec/data/marshall.yaml
+- spec/data_spec.rb
 - spec/err_msg_spec.rb
 - spec/introspect_xml_parser_spec.rb
 - spec/introspection_spec.rb
 - spec/main_loop_spec.rb
 - spec/node_spec.rb
 - spec/object_path_spec.rb
+- spec/packet_marshaller_spec.rb
+- spec/packet_unmarshaller_spec.rb
 - spec/property_spec.rb
 - spec/proxy_object_spec.rb
 - spec/server_robustness_spec.rb
@@ -190,6 +197,7 @@ files:
 - spec/type_spec.rb
 - spec/value_spec.rb
 - spec/variant_spec.rb
+- spec/zzz_quit_spec.rb
 homepage: https://github.com/mvidner/ruby-dbus
 licenses:
 - LGPL-2.1