rspec-openhab-scripting 0.0.16-java → 0.0.17-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5dd7ea9915aa3edecf86f75d7331bfe77ad3fbbbee4c278fd130895e4bc1e6c
-  data.tar.gz: 489db2879bf94009c027fcbb87572ae5b3834d31fab17f473cddc2fdecfebdfd
+  metadata.gz: a5541ba712d1a3fef9112f736b456309acb491aa0cdf075098abe04712a59940
+  data.tar.gz: d75f2b90687529a2bbc63f6d456f639a23360e7636d8ea7c36ed4d2113c7b6d7
 SHA512:
-  metadata.gz: 967d33cd26a809179324637df7ebb9243ec901ae6c75aaa97a1615a6f699082bb83050727502c326bcf85732f86521f93ce253877306d8e6cf86b4ed84030708
-  data.tar.gz: 375c3ebb1c64176b3da00a8489b8b9574e5636d767a2cb981100dc3b6b3128cbf23fc8b7ab9998ed3b7154a9d0754be6f349d3711ef326e7714ec360cac89732
+  metadata.gz: f576f81ea3fea76dbb173e8aa7ad3d1439f24e518bcd8574597266fe4bc457e325b6ec2f214e9c15a9c6b4c681d7350f7845fe055962f3b1b68214c0433b6b4d
+  data.tar.gz: 394f5a733ed2ddd02bf109f08fb80bbc35f8db5cebb340231a4b9bb17064ba17598ea1dbd90de18e16ff7d6ef52c387db001da6f6a3ae140c44928e71cef48c5

data/lib/rspec/openhab/api.rb

@@ -4,11 +4,12 @@ require "faraday"
 
 module OpenHAB
   class API
-    def initialize(url)
+    def initialize(url, token = nil)
       @faraday = Faraday.new(url) do |f|
         f.response :raise_error
         f.response :json
         f.path_prefix = "/rest/"
+        f.headers = { "X-OPENHAB-TOKEN" => token } if token
       end
     end
 
@@ -36,6 +37,22 @@ module OpenHAB
       nil
     end
 
+    def channel_types
+      @faraday.get("channel-types").body
+    end
+
+    def thing_types
+      @faraday.get("thing-types").body
+    end
+
+    def things
+      @faraday.get("things").body
+    end
+
+    def authenticated?
+      @faraday.headers.key?("X-OPENHAB-TOKEN")
+    end
+
     private
 
     def root_data

data/lib/rspec/openhab/core/mocks/channel_type_provider.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RSpec
+  module OpenHAB
+    module Core
+      module Mocks
+        class ChannelTypeProvider
+          include org.openhab.core.thing.type.ChannelTypeProvider
+          include Singleton
+
+          def initialize
+            @types = {}
+          end
+
+          def add(type)
+            @types[type.uid] = type
+          end
+
+          def get_channel_types(_locale)
+            @types.values
+          end
+
+          def get_channel_type(uid, _locale)
+            @types[uid]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/openhab/core/mocks/item_channel_link_provider.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RSpec
+  module OpenHAB
+    module Core
+      module Mocks
+        class ItemChannelLinkProvider
+          include org.openhab.core.thing.link.ItemChannelLinkProvider
+          include Singleton
+
+          def initialize
+            @listeners = []
+            @links = []
+          end
+
+          def add_provider_change_listener(listener)
+            @listeners << listener
+          end
+
+          def remove_provider_change_listener(listener)
+            @listeners.delete(listener)
+          end
+
+          def all
+            @links
+          end
+
+          def add(link)
+            @links << link
+            @listeners.each { |l| l.added(self, link) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/openhab/core/mocks/thing_type_provider.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RSpec
+  module OpenHAB
+    module Core
+      module Mocks
+        class ThingTypeProvider
+          include org.openhab.core.thing.binding.ThingTypeProvider
+          include Singleton
+
+          def initialize
+            @types = {}
+          end
+
+          def add(type)
+            @types[type.uid] = type
+          end
+
+          def get_thing_types(_locale)
+            @types.values
+          end
+
+          def get_thing_type(uid, _locale)
+            @types[uid]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/openhab/core/osgi.rb

@@ -4,7 +4,11 @@ module OpenHAB
   module Core
     class OSGI
       class << self
-        def register_service(name, service)
+        def register_service(name, service = nil)
+          if service.nil?
+            service = name
+            name = service.java_class.interfaces.first&.name || service.java_class.name
+          end
           (@services ||= {})[name] = service
         end
 

data/lib/rspec/openhab/dsl/imports.rb

@@ -68,6 +68,12 @@ module OpenHAB
         def add_bundle_listener(listener); end
       end
 
+      class BundleResolver
+        include org.openhab.core.util.BundleResolver
+
+        def resolve_bundle(klass); end
+      end
+
       # don't depend on org.openhab.core.test
       class VolatileStorageService
         include org.openhab.core.storage.StorageService
@@ -190,7 +196,7 @@ module OpenHAB
           event_factory.create_event(type, topic, payload, source)
         rescue Exception => e
           logger.warn("Creation of event failed, because one of the " \
-                      "registered event factories has thrown an exception: #{e}")
+                      "registered event factories has thrown an exception: #{e.inspect}")
           nil
         end
 
@@ -201,7 +207,9 @@ module OpenHAB
               begin
                 event_subscriber.receive(event)
               rescue Exception => e
-                logger.warn("Dispatching/filtering event for subscriber '#{event_subscriber.class}' failed: #{e}")
+                logger.warn(
+                  "Dispatching/filtering event for subscriber '#{event_subscriber.class}' failed: #{e.inspect}"
+                )
               end
             else
               logger.trace("Skip event subscriber (#{event_subscriber.class}) because of its filter.")
@@ -217,7 +225,7 @@ module OpenHAB
         include Singleton
 
         def submit(runnable)
-          runnable.run
+          runnable.respond_to?(:run) ? runnable.run : runnable.call
 
           java.util.concurrent.CompletableFuture.completed_future(nil)
         end
@@ -233,6 +241,40 @@ module OpenHAB
         end
       end
 
+      class SafeCaller
+        include org.openhab.core.common.SafeCaller
+        include org.openhab.core.common.SafeCallerBuilder
+
+        def create(target, _interface_type)
+          @target = target
+          self
+        end
+
+        def build
+          @target
+        end
+
+        def with_timeout(_timeout)
+          self
+        end
+
+        def with_identifier(_identifier)
+          self
+        end
+
+        def on_exception(_handler)
+          self
+        end
+
+        def on_timeout(_handler)
+          self
+        end
+
+        def with_async
+          self
+        end
+      end
+
       class CallbacksMap < java.util.HashMap
         def put(_rule_uid, trigger_handler)
           trigger_handler.executor.shutdown_now
@@ -275,7 +317,7 @@ module OpenHAB
           # the registries!
           ss = VolatileStorageService.new
           mr = org.openhab.core.internal.items.MetadataRegistryImpl.new
-          OpenHAB::Core::OSGI.register_service("org.openhab.core.items.MetadataRegistry", mr)
+          OpenHAB::Core::OSGI.register_service(mr)
           mr.managed_provider = mmp = org.openhab.core.internal.items.ManagedMetadataProviderImpl.new(ss)
           mr.add_provider(mmp)
           gmp = org.openhab.core.model.item.internal.GenericMetadataProvider.new
@@ -286,16 +328,24 @@ module OpenHAB
           ir.event_publisher = ep
           up = org.openhab.core.internal.i18n.I18nProviderImpl.new(cc)
           ir.unit_provider = up
-          ir.item_state_converter = org.openhab.core.internal.items.ItemStateConverterImpl.new(up)
+          ir.item_state_converter = isc = org.openhab.core.internal.items.ItemStateConverterImpl.new(up)
           tr = org.openhab.core.thing.internal.ThingRegistryImpl.new
+          tr.managed_provider = mtp = org.openhab.core.thing.ManagedThingProvider.new(ss)
+          tr.add_provider(mtp)
           mtr = org.openhab.core.automation.internal.type.ModuleTypeRegistryImpl.new
           rr = org.openhab.core.automation.internal.RuleRegistryImpl.new
           rr.module_type_registry = mtr
           rr.managed_provider = mrp = org.openhab.core.automation.ManagedRuleProvider.new(ss)
           rr.add_provider(mrp)
           iclr = org.openhab.core.thing.link.ItemChannelLinkRegistry.new(tr, ir)
+          iclr.add_provider(RSpec::OpenHAB::Core::Mocks::ItemChannelLinkProvider.instance)
+          OpenHAB::Core::OSGI.register_service(iclr)
           ctr = org.openhab.core.thing.type.ChannelTypeRegistry.new
+          OpenHAB::Core::OSGI.register_service(ctr)
+          ctr.add_channel_type_provider(RSpec::OpenHAB::Core::Mocks::ChannelTypeProvider.instance)
           ttr = org.openhab.core.thing.type.ThingTypeRegistry.new(ctr)
+          OpenHAB::Core::OSGI.register_service(ttr)
+          ttr.add_thing_type_provider(RSpec::OpenHAB::Core::Mocks::ThingTypeProvider.instance)
 
           safe_emf = org.openhab.core.model.core.internal.SafeEMFImpl.new
           model_repository = org.openhab.core.model.core.internal.ModelRepositoryImpl.new(safe_emf)
@@ -362,9 +412,12 @@ module OpenHAB
           iu = org.openhab.core.internal.items.ItemUpdater.new(ir)
           ief = org.openhab.core.items.events.ItemEventFactory.new
 
-          sc = org.openhab.core.internal.common.SafeCallerImpl.new({})
-          aum = org.openhab.core.thing.internal.AutoUpdateManager.new({ "enabled" => "true" }, nil, ep, iclr, mr, tr)
-          cm = org.openhab.core.thing.internal.CommunicationManager.new(aum, nil, nil, iclr, ir, nil, ep, sc, tr)
+          sc = SafeCaller.new
+          aum = org.openhab.core.thing.internal.AutoUpdateManager.new(
+            { "enabled" => true, "sendOptimisticUpdates" => true }, ctr, ep, iclr, mr, tr
+          )
+          spf = org.openhab.core.thing.internal.profiles.SystemProfileFactory.new(ctr, nil, BundleResolver.new)
+          cm = org.openhab.core.thing.internal.CommunicationManager.new(aum, ctr, spf, iclr, ir, isc, ep, sc, tr)
 
           em.add_event_subscriber(iu)
           em.add_event_subscriber(cm)

data/lib/rspec/openhab/items.rb

@@ -3,6 +3,18 @@
 module RSpec
   module OpenHAB
     module Items
+      class ThingHandler
+        include org.openhab.core.thing.binding.ThingHandler
+
+        attr_reader :thing
+
+        def initialize(thing)
+          @thing = thing
+        end
+
+        def handle_command(channel, command); end
+      end
+
       class << self
         def populate_items_from_api(api)
           all_items = api.items
@@ -39,6 +51,15 @@ module RSpec
             item.category = item_json["category"] if item_json["category"]
 
             $ir.add(item)
+
+            next unless item.meta["channel"]&.value
+
+            channel_uid = org.openhab.core.thing.ChannelUID.new(item.meta["channel"].value)
+            channel = $things.get_channel(channel_uid)
+            next unless channel
+
+            link = org.openhab.core.thing.link.ItemChannelLink.new(item.name, channel_uid)
+            Core::Mocks::ItemChannelLinkProvider.instance.add(link)
           end
           all_items.each do |item_json| # rubocop:disable Style/CombinableLoops
             item_json["groupNames"].each do |group_name|
@@ -48,6 +69,170 @@ module RSpec
             end
           end
         end
+
+        def populate_things_from_api(api)
+          populate_channel_types_from_api(api)
+          populate_thing_types_from_api(api)
+
+          thing_type_registry = ::OpenHAB::Core::OSGI.service("org.openhab.core.thing.type.ThingTypeRegistry")
+
+          api.things.each do |thing_json|
+            uid = org.openhab.core.thing.ThingUID.new(thing_json["UID"])
+            type_uid = org.openhab.core.thing.ThingTypeUID.new(thing_json["thingTypeUID"])
+            bridge_uid = org.openhab.core.thing.ThingUID.new(thing_json["bridgeUID"]) if thing_json["bridgeUID"]
+
+            type = thing_type_registry.get_thing_type(type_uid)
+            klass = if type.is_a?(org.openhab.core.thing.type.BridgeType)
+                      org.openhab.core.thing.binding.builder.BridgeBuilder
+                    else
+                      org.openhab.core.thing.binding.builder.ThingBuilder
+                    end
+            builder = klass.create(type_uid, uid)
+            builder.with_bridge(bridge_uid) if bridge_uid
+
+            thing_json.each do |(k, v)|
+              case k
+              when "UID", "thingTypeUID", "bridgeUID", "statusInfo", "editable"
+                nil
+              when "channels"
+                builder.with_channels(v.map { |c| build_channel(c) })
+              when "configuration"
+                builder.with_configuration(org.openhab.core.config.core.Configuration.new(v))
+              else
+                builder.send(:"with_#{k}", v)
+              end
+            end
+
+            thing = builder.build
+            # pretend everything is online so that AutoUpdateManager won't reject updates
+            # to items linked to offline channels
+            thing.status_info = org.openhab.core.thing.binding.builder.ThingStatusInfoBuilder
+                                   .create(org.openhab.core.thing.ThingStatus::ONLINE).build
+            handler = ThingHandler.new(thing)
+            thing.handler = handler
+            $things.add(thing)
+          end
+        end
+
+        private
+
+        def populate_channel_types_from_api(api)
+          api.channel_types.each do |ct_json|
+            uid = org.openhab.core.thing.type.ChannelTypeUID.new(ct_json["UID"])
+            builder = case ct_json["kind"]
+                      when "STATE"
+                        org.openhab.core.thing.type.ChannelTypeBuilder.state(uid, ct_json["label"], ct_json["itemType"])
+                      when "TRIGGER"
+                        org.openhab.core.thing.type.ChannelTypeBuilder.trigger(uid, ct_json["label"])
+                      else
+                        raise ArgumentError, "Unrecognized channel type kind #{ct_json["kind"]} for #{uid}"
+                      end
+
+            ct_json.each do |(k, v)|
+              case k
+              when "parameters", "parameterGroups", "label", "kind", "UID", "itemType"
+                nil
+              when "commandDescription"
+                builder.with_command_description(build_command_description(v))
+              when "stateDescription"
+                builder.with_state_description_fragment(build_state_description_fragment(v))
+              when "advanced"
+                builder.is_advanced(v)
+              else
+                builder.send(:"with_#{k}", v)
+              end
+            end
+
+            ct = builder.build
+            Core::Mocks::ChannelTypeProvider.instance.add(ct)
+          end
+        end
+
+        def build_command_description(json)
+          org.openhab.core.types.CommandDescriptionBuilder.create
+             .with_command_options(json["commandOptions"].map do |o|
+                                     org.openhab.core.types.CommandOption.new(o["command"], o["label"])
+                                   end)
+             .build
+        end
+
+        def build_state_description_fragment(json)
+          org.openhab.core.types.StateDescriptionFragmentBuilder.create
+             .with_minimum(json["minimum"]&.to_d)
+             .with_maximum(json["maximum"]&.to_d)
+             .with_step(json["step"&.to_d])
+             .with_pattern(json["pattern"])
+             .with_read_only(json["readOnly"])
+             .with_options(json["options"].map { |o| org.openhab.core.types.StateOption.new(o["value"], o["label"]) })
+             .build
+        end
+
+        def populate_thing_types_from_api(api)
+          api.thing_types.each do |tt_json|
+            uid = org.openhab.core.thing.ThingTypeUID.new(tt_json["UID"])
+            builder = org.openhab.core.thing.type.ThingTypeBuilder.instance(uid, tt_json["label"])
+            tt_json.each do |(k, v)|
+              case k
+              when "UID", "label", "bridge"
+                nil
+              when "listed"
+                builder.is_listed(v)
+              when "channels"
+                builder.with_channels(v.map { |c| build_channel_definition(c) })
+              when "channelGroups"
+                builder.with_channel_groups(v.map { |cg| build_channel_group_definition(cg) })
+              else
+                builder.send(:"with#{k[0].upcase}#{k[1..]}", v)
+              end
+            end
+
+            tt = tt_json["bridge"] ? builder.build_bridge : builder.build
+            Core::Mocks::ThingTypeProvider.instance.add(tt)
+          end
+        end
+
+        def build_channel_definition(json)
+          org.openhab.core.thing.type.ChannelDefinition.new(
+            json["uid"],
+            org.openhab.core.thing.type.ChannelTypeUID.new(json["typeUID"]),
+            json["description"],
+            json["properties"],
+            nil
+          )
+        end
+
+        def build_channel_group_definition(json)
+          org.openhab.core.thing.type.ChannelGroupDefinition.new(
+            json["uid"],
+            org.openhab.core.thing.type.ChannelGroupTypeUID.new(json["typeUID"]),
+            json["label"],
+            json["description"]
+          )
+        end
+
+        def build_channel(json)
+          uid = org.openhab.core.thing.ChannelUID.new(json["uid"])
+          builder = org.openhab.core.thing.binding.builder.ChannelBuilder.create(uid)
+
+          json.each do |(k, v)|
+            case k
+            when "uid", "id", "linkedItems", "itemType"
+              nil
+            when "channelTypeUID"
+              builder.with_type(org.openhab.core.thing.type.ChannelTypeUID.new((v)))
+            when "configuration"
+              builder.with_configuration(org.openhab.core.config.core.Configuration.new(v))
+            when "kind"
+              builder.with_kind(org.openhab.core.thing.type.ChannelKind.const_get(v, false))
+            when "defaultTags"
+              builder.with_default_tags(v.to_set)
+            else
+              builder.send("with_#{k}", v)
+            end
+          end
+
+          builder.build
+        end
       end
     end
   end

data/lib/rspec/openhab/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenHAB
-    VERSION = "0.0.16"
+    VERSION = "0.0.17"
   end
 end

data/lib/rspec-openhab-scripting.rb

@@ -5,7 +5,8 @@
 $LOAD_PATH.unshift(File.expand_path("../vendor/gems/jar-dependencies-1.0.0/lib", __dir__))
 
 require "rspec/openhab/api"
-api = OpenHAB::API.new("http://#{ENV.fetch("OPENHAB_HOST", "localhost")}:#{ENV.fetch("OPENHAB_HTTP_PORT", "8080")}/")
+api = OpenHAB::API.new("http://#{ENV.fetch("OPENHAB_HOST", "localhost")}:#{ENV.fetch("OPENHAB_HTTP_PORT", "8080")}/",
+                       ENV.fetch("OPENHAB_TOKEN", nil))
 
 module OpenHAB
   module Core
@@ -66,7 +67,10 @@ require "rspec/openhab/core/logger"
 # during testing, we don't want "regular" output from rules
 OpenHAB::Log.logger("org.openhab.automation.jruby.runtime").level = :warn
 OpenHAB::Log.logger("org.openhab.automation.jruby.logger").level = :warn
+require "rspec/openhab/core/mocks/channel_type_provider"
+require "rspec/openhab/core/mocks/item_channel_link_provider"
 require "rspec/openhab/core/mocks/persistence_service"
+require "rspec/openhab/core/mocks/thing_type_provider"
 require "openhab/dsl/imports"
 OpenHAB::DSL::Imports.api = api
 OpenHAB::DSL::Imports.import_presets
@@ -93,6 +97,7 @@ RSpec.configure do |config|
 end
 
 RSpec::OpenHAB::SuspendRules.suspend_rules do
+  RSpec::OpenHAB::Items.populate_things_from_api(api) if api.authenticated?
   RSpec::OpenHAB::Items.populate_items_from_api(api)
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: java
 authors:
 - Cody Cutrer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +192,10 @@ files:
 - lib/rspec/openhab/core/item_proxy.rb
 - lib/rspec/openhab/core/load_path.rb
 - lib/rspec/openhab/core/logger.rb
+- lib/rspec/openhab/core/mocks/channel_type_provider.rb
+- lib/rspec/openhab/core/mocks/item_channel_link_provider.rb
 - lib/rspec/openhab/core/mocks/persistence_service.rb
+- lib/rspec/openhab/core/mocks/thing_type_provider.rb
 - lib/rspec/openhab/core/openhab_setup.rb
 - lib/rspec/openhab/core/osgi.rb
 - lib/rspec/openhab/core/script_handling.rb
@@ -237,7 +240,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="