rspec-openhab-scripting 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 116f3664ed9d88e87a4030cf7006dc82c3c517b7b6f54b2611989f5aa48f7988
-  data.tar.gz: d257ff1821dad6bca67eaa1cb848d3cc55b1a05f7cb02d5f20e9e34d2b2c3c17
+  metadata.gz: 5e3e336c4b70557c83f8116331678ecc50f0ec67326049b70302893903d48f18
+  data.tar.gz: 7d10a10b19aeacbc89eba86b0c40875c7c6f43a0b1529fc9af7ec06ab569d0bc
 SHA512:
-  metadata.gz: c29fdc081461392dcad67246de4b784c012c0963d971acc1ca4f2c4f78e9229698ef36c7c1946c1b14e290b7bf11c77977f4d20a0e39b41fa950b3e2609663b6
-  data.tar.gz: 859f14916f43496a242adf17896a2d8bb5cd46027d101c5e3da70ebc215fba5bcecf9f71d0dd4eb41b9022e8879d427af3cbb4624a909af33864f5011ccdaeee
+  metadata.gz: 6f6eaf2489819f42da8e95f5a8095ead7314c62a6f338d4d605bb6e924848cafd318abe97fbd0503bf48ae43dc747f6663c917b3c597e5c6ec99515dd088a7c7
+  data.tar.gz: c3a04761c79f529c49b11597ae63bfd409ab2a117f24af666a2638d541690d908c4258efdaaec5f01921c7680f8c643f8bcfe5f99abc8c0d67b285c40df27a96

data/lib/rspec/openhab/configuration.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RSpec
+  module OpenHAB
+    module Configuration
+      class << self
+        # Copy binding configuration from the root OpenHAB instance
+        # Default `true`
+        # @return [true, false]
+        attr_accessor :include_bindings
+        # Copy the JSONDB (managed thing and item configuration) from the root
+        # OpenHAB instance
+        # Default `true`
+        # @return [true, false]
+        attr_accessor :include_jsondb
+        # Use a private (empty) confdir (scripts, rules, items, and things
+        # # files), instead of sharing with the root OpenHAB
+        # instance.
+        # Default `false`
+        # @return [true, false]
+        attr_accessor :private_confdir
+        # Use the root OpenHAB instance directly, rather than creating a
+        # private (but linked) instance.
+        # @default `false`
+        # @return [true, false]
+        attr_accessor :use_root_instance
+      end
+
+      self.include_bindings = true
+      self.include_jsondb = true
+      self.private_confdir = false
+      self.use_root_instance = false
+    end
+  end
+end

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

@@ -13,6 +13,10 @@ module OpenHAB
             @proxies[item.name] = super
           end
         end
+
+        def reset_cache
+          @proxies = {}
+        end
       end
     end
   end

data/lib/rspec/openhab/dsl/things/thing.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    module Things
+      class Thing
+        @proxies = {}
+
+        class << self
+          # ensure each item only has a single proxy, so that
+          # expect(item).to receive(:method) works
+          def new(thing)
+            @proxies.fetch(thing.uid.to_s) do
+              @proxies[thing.uid.to_s] = super
+            end
+          end
+
+          def reset_cache
+            @proxies = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/openhab/helpers.rb

@@ -75,7 +75,7 @@ module RSpec
         @rules.fetch(rule_name).execute(nil, { "event" => event })
       end
 
-      def trigger_channel(channel, event)
+      def trigger_channel(channel, event = "")
         channel = org.openhab.core.thing.ChannelUID.new(channel) if channel.is_a?(String)
         channel = channel.uid if channel.is_a?(org.openhab.core.thing.Channel)
         thing = channel.thing
@@ -112,6 +112,7 @@ module RSpec
         require_relative "actions"
         require_relative "core/item_proxy"
         require_relative "dsl/timers/timer"
+        require_relative "dsl/things/thing"
         # TODO: still needed?
         require_relative "dsl/rules/triggers/watch"
 
@@ -174,6 +175,19 @@ module RSpec
         end
       end
 
+      def install_addon(addon_id, wait: true)
+        addon_service = ::OpenHAB::Core::OSGI.service("org.openhab.core.addon.AddonService")
+        addon_service.install(addon_id)
+        return unless wait
+
+        loop do
+          addon = addon_service.get_addon(addon_id, nil)
+          return if addon.installed?
+
+          sleep 0.25
+        end
+      end
+
       private
 
       def jrubyscripting_config

data/lib/rspec/openhab/hooks.rb

@@ -4,20 +4,18 @@ module RSpec
   module OpenHAB
     Object.include RSpec::OpenHAB::Helpers if defined?(IRB)
 
+    Helpers.launch_karaf(
+      include_bindings: Configuration.include_bindings,
+      include_jsondb: Configuration.include_jsondb,
+      private_confdir: Configuration.private_confdir,
+      use_root_instance: Configuration.use_root_instance
+    )
+
     if RSpec.respond_to?(:configure)
       RSpec.configure do |config|
-        config.add_setting :include_openhab_bindings, default: true
-        config.add_setting :include_openhab_jsondb, default: true
-        config.add_setting :private_openhab_confdir, default: false
-        config.add_setting :use_root_openhab_instance, default: false
-
         config.before(:suite) do
-          Helpers.launch_karaf(include_bindings: config.include_openhab_bindings,
-                               include_jsondb: config.include_openhab_jsondb,
-                               private_confdir: config.private_openhab_confdir,
-                               use_root_instance: config.use_root_openhab_instance)
           config.include ::OpenHAB::Core::EntityLookup
-          Helpers.autorequires unless config.private_openhab_confdir
+          Helpers.autorequires unless Configuration.private_confdir
           Helpers.send(:set_up_autoupdates)
           Helpers.load_transforms
           Helpers.load_rules
@@ -35,10 +33,14 @@ module RSpec
         end
 
         config.before do
-          next unless defined?(::OpenHAB::DSL::Items::ItemProvider)
-
-          @item_provider = ::OpenHAB::DSL::Items::ItemProvider.send(:new)
-          allow(::OpenHAB::DSL::Items::ItemProvider).to receive(:instance).and_return(@item_provider)
+          if defined?(::OpenHAB::DSL::Items::ItemProvider)
+            @item_provider = ::OpenHAB::DSL::Items::ItemProvider.send(:new)
+            allow(::OpenHAB::DSL::Items::ItemProvider).to receive(:instance).and_return(@item_provider)
+          end
+          if defined?(::OpenHAB::DSL::Things::ThingProvider)
+            @thing_provider = ::OpenHAB::DSL::Things::ThingProvider.send(:new)
+            allow(::OpenHAB::DSL::Things::ThingProvider).to receive(:instance).and_return(@thing_provider)
+          end
         end
 
         config.after do
@@ -47,6 +49,9 @@ module RSpec
             ::OpenHAB::Core.rule_registry.remove(uid)
           end
           $ir.remove_provider(@item_provider) if instance_variable_defined?(:@item_provider) && @item_provider
+          ::OpenHAB::Core::ItemProxy.reset_cache
+          $things.remove_provider(@thing_provider) if instance_variable_defined?(:@thing_provider) && @thing_provider
+          ::OpenHAB::DSL::Things::Thing.reset_cache
           ::OpenHAB::DSL::Timers.timer_manager.cancel_all
           Timecop.return
           restore_autoupdate_items

data/lib/rspec/openhab/karaf.rb

@@ -304,7 +304,6 @@ module RSpec
       BLOCKED_COMPONENTS = {
         "org.openhab.core" => %w[
           org.openhab.core.addon.AddonEventFactory
-          org.openhab.core.binding.BindingInfoRegistry
           org.openhab.core.binding.i18n.BindingI18nLocalizationService
           org.openhab.core.internal.auth.ManagedUserProvider
           org.openhab.core.internal.auth.UserRegistryImpl
@@ -675,6 +674,7 @@ module RSpec
       def cleanup_instance
         cleanup_clone
         minimize_installed_features
+        filter_addons
       end
 
       def cleanup_clone
@@ -685,10 +685,23 @@ module RSpec
                          "#{oh_userdata}/tmp/*",
                          "#{oh_userdata}/jsondb/org.openhab.marketplace.json",
                          "#{oh_userdata}/jsondb/org.openhab.jsonaddonservice.json",
+                         "#{path}/config/org/apache/felix/fileinstall",
                          "#{felix_cm}/org/openhab/jsonaddonservice.config"])
         FileUtils.rm_rf("#{oh_userdata}/jsondb") unless include_jsondb
       end
 
+      def filter_addons
+        config_file = "#{path}/etc/org.apache.felix.fileinstall-deploy.cfg"
+        return unless File.exist?(config_file)
+
+        config = File.read(config_file)
+        new_config = config.sub(/^(felix\.fileinstall\.filter\s+=)[^\n]+$/, "\\1 .*/openhab-addons-[^/]+\\.kar")
+
+        return if config == new_config
+
+        File.write(config_file, new_config)
+      end
+
       def prune_startlevels
         config_file = java.lang.System.get_property("openhab.servicecfg")
         return unless File.exist?(config_file)

data/lib/rspec/openhab/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenHAB
-    VERSION = "1.0.5"
+    VERSION = "1.1.0"
   end
 end

data/lib/rspec-openhab-scripting.rb

@@ -12,6 +12,7 @@ $LOAD_PATH.unshift("#{__dir__}/rspec")
 
 require "diff/lcs"
 
+require "rspec/openhab/configuration"
 require "rspec/openhab/helpers"
 require "rspec/openhab/karaf"
 require "rspec/openhab/hooks"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -187,6 +187,7 @@ files:
 - lib/rspec-openhab-scripting.rb
 - lib/rspec/openhab/actions.rb
 - lib/rspec/openhab/api.rb
+- lib/rspec/openhab/configuration.rb
 - lib/rspec/openhab/core/item_proxy.rb
 - lib/rspec/openhab/core/logger.rb
 - lib/rspec/openhab/core/mocks/bundle_install_support.rb
@@ -197,6 +198,7 @@ files:
 - lib/rspec/openhab/core/mocks/thing_handler.rb
 - lib/rspec/openhab/core/openhab_setup.rb
 - lib/rspec/openhab/dsl/rules/triggers/watch.rb
+- lib/rspec/openhab/dsl/things/thing.rb
 - lib/rspec/openhab/dsl/timers/timer.rb
 - lib/rspec/openhab/helpers.rb
 - lib/rspec/openhab/hooks.rb