ruby-dbus 0.17.0 → 0.18.0.beta3

data/spec/data_spec.rb

@@ -0,0 +1,353 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+# The from_raw methods are tested in packet_unmarshaller_spec.rb
+
+RSpec.shared_examples "constructor accepts numeric range" do |min, max|
+  describe "#initialize" do
+    it "accepts the min value #{min}" do
+      expect(described_class.new(min).value).to eq(min)
+    end
+
+    it "accepts the max value #{max}" do
+      expect(described_class.new(max).value).to eq(max)
+    end
+
+    it "raises on too small a value #{min - 1}" do
+      expect { described_class.new(min - 1) }.to raise_error(RangeError)
+    end
+
+    it "raises on too big a value #{max + 1}" do
+      expect { described_class.new(max + 1) }.to raise_error(RangeError)
+    end
+
+    it "raises on nil" do
+      expect { described_class.new(nil) }.to raise_error(RangeError)
+    end
+  end
+end
+
+RSpec.shared_examples "constructor accepts plain or typed values" do |plain_list|
+  describe "#initialize" do
+    Array(plain_list).each do |plain|
+      it "accepts the plain value #{plain.inspect}" do
+        expect(described_class.new(plain).value).to eq(plain)
+      end
+
+      it "accepts the typed value #{plain.inspect}" do
+        typed = described_class.new(plain)
+        expect(described_class.new(typed).value).to eq(plain)
+      end
+    end
+  end
+end
+
+RSpec.shared_examples "constructor (kwargs) accepts values" do |list|
+  describe "#initialize" do
+    list.each do |value, kwargs_hash|
+      it "accepts the plain value #{value.inspect}, #{kwargs_hash.inspect}" do
+        expect(described_class.new(value, **kwargs_hash).value).to eq(value)
+      end
+
+      it "accepts the typed value #{value.inspect}, #{kwargs_hash.inspect}" do
+        typed = described_class.new(value, **kwargs_hash)
+        expect(described_class.new(typed, **kwargs_hash).value).to eq(value)
+      end
+    end
+  end
+end
+
+RSpec.shared_examples "constructor rejects values from this list" do |bad_list|
+  describe "#initialize" do
+    bad_list.each do |(value, exc_class, msg_substr)|
+      it "rejects #{value.inspect} with #{exc_class}: #{msg_substr}" do
+        msg_re = Regexp.new(Regexp.quote(msg_substr))
+        expect { described_class.new(value) }.to raise_error(exc_class, msg_re)
+      end
+    end
+  end
+end
+
+RSpec.shared_examples "constructor (kwargs) rejects values" do |bad_list|
+  describe "#initialize" do
+    bad_list.each do |(value, kwargs_hash, exc_class, msg_substr)|
+      it "rejects #{value.inspect}, #{kwargs_hash.inspect} with #{exc_class}: #{msg_substr}" do
+        msg_re = Regexp.new(Regexp.quote(msg_substr))
+        expect { described_class.new(value, **kwargs_hash) }.to raise_error(exc_class, msg_re)
+      end
+    end
+  end
+end
+
+# TODO: Look at conversions? to_str, to_int?
+
+describe DBus::Data do
+  # test initialization, from user code, or from packet (from_raw)
+  # remember to unpack if initializing from Data::Base
+  # #value should recurse inside so that the user doesnt have to
+  # Kick InvalidPacketException out of here?
+
+  describe DBus::Data::Byte do
+    include_examples "constructor accepts numeric range", 0, 2**8 - 1
+    include_examples "constructor accepts plain or typed values", 42
+  end
+
+  describe DBus::Data::Int16 do
+    include_examples "constructor accepts numeric range", -2**15, 2**15 - 1
+    include_examples "constructor accepts plain or typed values", 42
+  end
+
+  describe DBus::Data::UInt16 do
+    include_examples "constructor accepts numeric range", 0, 2**16 - 1
+    include_examples "constructor accepts plain or typed values", 42
+  end
+
+  describe DBus::Data::Int32 do
+    include_examples "constructor accepts numeric range", -2**31, 2**31 - 1
+    include_examples "constructor accepts plain or typed values", 42
+  end
+
+  describe DBus::Data::UInt32 do
+    include_examples "constructor accepts numeric range", 0, 2**32 - 1
+    include_examples "constructor accepts plain or typed values", 42
+  end
+
+  describe DBus::Data::Int64 do
+    include_examples "constructor accepts numeric range", -2**63, 2**63 - 1
+    include_examples "constructor accepts plain or typed values", 42
+  end
+
+  describe DBus::Data::UInt64 do
+    include_examples "constructor accepts numeric range", 0, 2**64 - 1
+    include_examples "constructor accepts plain or typed values", 42
+  end
+
+  describe DBus::Data::Boolean do
+    describe "#initialize" do
+      it "accepts false and true" do
+        expect(described_class.new(false).value).to eq(false)
+        expect(described_class.new(true).value).to eq(true)
+      end
+
+      it "accepts truth value of other objects" do
+        expect(described_class.new(nil).value).to eq(false)
+        expect(described_class.new(0).value).to eq(true) # !
+        expect(described_class.new(1).value).to eq(true)
+        expect(described_class.new(Time.now).value).to eq(true)
+      end
+    end
+
+    include_examples "constructor accepts plain or typed values", false
+  end
+
+  describe DBus::Data::Double do
+    include_examples "constructor accepts plain or typed values", Math::PI
+
+    describe "#initialize" do
+      it "raises on values that can't be made a Float" do
+        expect { described_class.new(nil) }.to raise_error(TypeError)
+        expect { described_class.new("one") }.to raise_error(ArgumentError)
+        expect { described_class.new(/itsaregexp/) }.to raise_error(TypeError)
+      end
+    end
+  end
+
+  describe "basic, string-like types" do
+    describe DBus::Data::String do
+      # TODO: what about strings with good codepoints but encoded in
+      # let's say Encoding::ISO8859_2?
+      good = [
+        "",
+        "Ř",
+        # a Noncharacter, but well-formed Unicode
+        # https://www.unicode.org/versions/corrigendum9.html
+        "\uffff",
+        # maximal UTF-8 codepoint U+10FFFF
+        "\u{10ffff}"
+      ]
+
+      bad = [
+        # NUL in the middle
+        # FIXME: InvalidPacketException is wrong here, it should be ArgumentError
+        ["a\x00b", DBus::InvalidPacketException, "contains NUL"],
+        # invalid UTF-8
+        ["\xFF\xFF\xFF\xFF", DBus::InvalidPacketException, "not in UTF-8"],
+        # overlong sequence encoding an "A"
+        ["\xC1\x81", DBus::InvalidPacketException, "not in UTF-8"],
+        # first codepoint outside UTF-8, U+110000
+        ["\xF4\x90\xC0\xC0", DBus::InvalidPacketException, "not in UTF-8"]
+      ]
+
+      include_examples "constructor accepts plain or typed values", good
+      include_examples "constructor rejects values from this list", bad
+
+      describe ".alignment" do
+        # this overly specific test avoids a redundant alignment call
+        # in the production code
+        it "returns the correct value" do
+          expect(described_class.alignment).to eq 4
+        end
+      end
+    end
+
+    describe DBus::Data::ObjectPath do
+      good = [
+        "/"
+        # TODO: others
+      ]
+
+      bad = [
+        ["", DBus::InvalidPacketException, "Invalid object path"]
+        # TODO: others
+      ]
+
+      include_examples "constructor accepts plain or typed values", good
+      include_examples "constructor rejects values from this list", bad
+
+      describe ".alignment" do
+        # this overly specific test avoids a redundant alignment call
+        # in the production code
+        it "returns the correct value" do
+          expect(described_class.alignment).to eq 4
+        end
+      end
+    end
+
+    describe DBus::Data::Signature do
+      good = [
+        "",
+        "i",
+        "ii"
+        # TODO: others
+      ]
+
+      bad = [
+        ["!", DBus::InvalidPacketException, "Unknown type code"]
+        # TODO: others
+      ]
+
+      include_examples "constructor accepts plain or typed values", good
+      include_examples "constructor rejects values from this list", bad
+
+      describe ".alignment" do
+        # this overly specific test avoids a redundant alignment call
+        # in the production code
+        it "returns the correct value" do
+          expect(described_class.alignment).to eq 1
+        end
+      end
+    end
+  end
+
+  describe "containers" do
+    describe DBus::Data::Array do
+      good = [
+        # [[1, 2, 3], member_type: nil],
+        [[1, 2, 3], { member_type: "q" }],
+        [[1, 2, 3], { member_type: DBus::Type::UINT16 }],
+        [[1, 2, 3], { member_type: DBus.type("q") }],
+        [[DBus::Data::UInt16.new(1), DBus::Data::UInt16.new(2), DBus::Data::UInt16.new(3)], { member_type: "q" }]
+        # TODO: others
+      ]
+
+      bad = [
+        # undesirable type guessing
+        ## [[1, 2, 3], { member_type: nil }, DBus::InvalidPacketException, "Unknown type code"],
+        ## [[1, 2, 3], { member_type: "!" }, DBus::InvalidPacketException, "Unknown type code"]
+        # TODO: others
+      ]
+
+      include_examples "constructor (kwargs) accepts values", good
+      include_examples "constructor (kwargs) rejects values", bad
+
+      describe ".from_typed" do
+        it "creates new instance from given object and type" do
+          type = DBus::Type.new("s")
+          expect(described_class.from_typed(["test", "lest"], member_types: [type])).to be_a(described_class)
+        end
+      end
+    end
+
+    describe DBus::Data::Struct do
+      three_words = ::Struct.new(:a, :b, :c)
+
+      qqq = ["q", "q", "q"]
+      integers = [1, 2, 3]
+      uints = [DBus::Data::UInt16.new(1), DBus::Data::UInt16.new(2), DBus::Data::UInt16.new(3)]
+
+      # TODO: all the reasonable initialization params
+      # need to be normalized into one/few internal representation.
+      # So check what is the result
+      #
+      # Internally, it must be Data::Base
+      # Perhaps distinguish #value => Data::Base
+      # and #plain_value => plain Ruby
+      #
+      # but then, can they mutate?
+      #
+      # TODO: also check data ownership: reasonable to own the data?
+      # can make it explicit?
+      good = [
+        # from plain array; various m_t styles
+        [integers, { member_types: ["q", "q", "q"] }],
+        [integers, { member_types: [DBus::Type::UINT16, DBus::Type::UINT16, DBus::Type::UINT16] }],
+        [integers, { member_types: DBus.types("qqq") }],
+        # plain array of data
+        [uints, { member_types: DBus.types("qqq") }],
+        # ::Struct
+        [three_words.new(*integers), { member_types: qqq }],
+        [three_words.new(*uints), { member_types: qqq }]
+        # TODO: others
+      ]
+
+      _bad_but_valid = [
+        # Wrong member_types arg:
+        # hmm this is another reason to pass the type
+        # as the entire struct type, not the members:
+        # empty struct will be caught naturally
+        [integers, { member_types: [] }, ArgumentError, "???"],
+        [integers, { member_types: ["!"] }, DBus::InvalidPacketException, "Unknown type code"],
+        # STRUCT specific: member count mismatch
+        [[1, 2], { member_types: DBus.types("qqq") }, ArgumentError, "???"],
+        [[1, 2, 3, 4], { member_types: DBus.types("qqq") }, ArgumentError, "???"]
+        # TODO: others
+      ]
+
+      include_examples "constructor (kwargs) accepts values", good
+      # include_examples "constructor (kwargs) rejects values", bad
+
+      describe ".from_typed" do
+        it "creates new instance from given object and type" do
+          type = DBus::Type.new("s")
+          expect(described_class.from_typed(["test", "lest"].freeze, member_types: [type, type]))
+            .to be_a(described_class)
+        end
+      end
+    end
+
+    describe DBus::Data::Variant do
+      describe ".from_typed" do
+        it "creates new instance from given object and type" do
+          type = DBus::Type.new("s")
+          expect(described_class.from_typed("test", member_types: [type])).to be_a(described_class)
+        end
+
+        it "ignores the member_types argument" do
+          type = DBus::Type.new("s")
+          # Base.from_typed is a generic interface with a fixed signature;
+          # So it must offer the member_types parameter, which is misleading
+          # for a Variant
+          value = described_class.from_typed("test", member_types: [type])
+          expect(value.type.to_s).to eq "v"
+          expect(value.member_type.to_s).to eq "s"
+        end
+      end
+    end
+
+    describe DBus::Data::DictEntry do
+    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,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test the main loop
 require_relative "spec_helper"
 require "dbus"

data/spec/node_spec.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::Node do
+  describe "#inspect" do
+    # the behavior needs improvement
+    it "shows the node, poorly" do
+      parent = described_class.new("parent")
+      parent.object = DBus::Object.new("/parent")
+
+      3.times do |i|
+        child_name = "child#{i}"
+        child = described_class.new(child_name)
+        parent[child_name] = child
+      end
+
+      expect(parent.inspect).to match(/<DBus::Node [0-9a-f]+ {child0 => {},child1 => {},child2 => {}}>/)
+    end
+  end
+end

data/spec/object_path_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 require_relative "spec_helper"
 require "dbus"
 
@@ -18,6 +20,7 @@ describe DBus::ObjectPath do
       expect(described_class.valid?("/EmptyLastComponent/")).to be_falsey
       expect(described_class.valid?("/Invalid Character")).to be_falsey
       expect(described_class.valid?("/Invalid-Character")).to be_falsey
+      expect(described_class.valid?("/InválídCháráctér")).to be_falsey
     end
   end
 end

data/spec/packet_marshaller_spec.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+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 DBus::PacketMarshaller do
+  context "marshall.yaml" do
+    marshall_yaml.each do |test|
+      t = OpenStruct.new(test)
+      next if t.marshall == false
+      # skip test cases for invalid unmarshalling
+      next if t.val.nil?
+
+      # while the marshaller can use only native endianness, skip the other
+      endianness = t.end.to_sym
+
+      signature = t.sig
+      expected = buffer_from_yaml(t.buf)
+
+      it "writes a '#{signature}' with value #{t.val.inspect} (#{endianness})" do
+        subject = described_class.new(endianness: endianness)
+        subject.append(signature, t.val)
+        expect(subject.packet).to eq(expected)
+      end
+    end
+  end
+end