rspec-openhab-scripting 0.0.5-java → 0.0.8-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66ee3ecec1c902dcf931cb3e51a7cacdb4df1e3b0798fa973aabf0147787c72f
-  data.tar.gz: da69d9608f4242545a4e01b0ae22e0133b6a1868b518ad1a95dd5d67bcd94785
+  metadata.gz: 5b4f4a385d3672410faee3ca6a90eb931f4499060de30d5dfc11869c73b78db7
+  data.tar.gz: 2d6c73ceabd6796134434250824ee255f80cc74b98b16f4172ac76d6be350c5b
 SHA512:
-  metadata.gz: 5160b3281ea2f567fd040f49cb0acf5b6c1b56ae050711ae049868ec645dc8a38799434c8c51c3c2a2fb806da98b5261b9c1e54119d3fd2c0d2888680cc2b762
-  data.tar.gz: c0ca81a870b864c45ba50d281fa9584421b36d64c48b86048765b32d6d0ab5aa64c92a49a4ddfcc6fa21d9b085b7e5a5baa63c95fcde295b090dd5967996d823
+  metadata.gz: e9153da220c8491f9a8f79bed277646df27b95ed4c17fb0181dcfd8519df0d9443c989ace2f2fe8da3fb39c14e177d7147e7148cffd5a47baa6a121a821ce883
+  data.tar.gz: 70b3fefd8b2df95db3fc553fcb785c48c8e63d3671c0922328bd0937819e7f3b3cc164edb58e3d4fc04da20101297c65868696ebf624b664892b16c86bed22cd

data/lib/rspec/openhab/actions.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    module Actions
+      # redefine these to do nothing so that rules won't fail
+      def notify(msg, email: nil) # rubocop:disable Lint/UnusedMethodArgument:
+        logger.debug("notify: #{msg}")
+      end
+
+      def say(text, voice: nil, sink: nil, volume: nil) # rubocop:disable Lint/UnusedMethodArgument:
+        logger.debug("say: #{text}")
+      end
+
+      def play_sound(filename, sink: nil, volume: nil) # rubocop:disable Lint/UnusedMethodArgument:
+        logger.debug("play_sound: #{filename}")
+      end
+    end
+  end
+end

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

@@ -213,10 +213,11 @@ module OpenHAB
           se = org.openhab.core.automation.module.script.rulesupport.internal
                   .RuleSupportScriptExtension.new(rr, srp, scmhf, scmtp, spmhf)
           sew = ScriptExtensionManagerWrapper.new(se)
-          $se = $scriptExtension = sew # rubocop:disable Style/GlobalVars
+          $se = $scriptExtension = sew
 
           # need to create some singletons referencing registries
-          org.openhab.core.model.script.ScriptServiceUtil.new(ir, tr, ep, nil, nil)
+          scheduler = org.openhab.core.internal.scheduler.SchedulerImpl.new
+          org.openhab.core.model.script.ScriptServiceUtil.new(ir, tr, ep, nil, scheduler)
           org.openhab.core.model.script.internal.engine.action.SemanticsActionService.new(ir)
 
           # link up event bus infrastructure

data/lib/rspec/openhab/items.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Style/GlobalVars
 module RSpec
   module OpenHAB
     module Items
@@ -76,4 +75,3 @@ module RSpec
     end
   end
 end
-# rubocop:enable Style/GlobalVars

data/lib/rspec/openhab/state.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.configure do |config|
-  org.openhab.core.items.GenericItem.field_reader :eventPublisher
-
-  # rubocop:disable Style/GlobalVars
   config.before(:each) do
-    ep = $ir.eventPublisher
+    ep = $ir.event_publisher
 
     # stash event publishers to avoid triggering any rules
     $ir.for_each do |_provider, item|
@@ -20,5 +17,4 @@ RSpec.configure do |config|
       item.event_publisher = ep
     end
   end
-  # rubocop:enable Style/GlobalVars
 end

data/lib/rspec/openhab/timer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.before(:each) do
+    OpenHAB::DSL::Timers.timer_manager.cancel_all
+    wait_for_background_tasks
+  end
+  config.after(:each) do
+    OpenHAB::DSL::Timers.timer_manager.cancel_all
+    wait_for_background_tasks
+  end
+end

data/lib/rspec/openhab/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenHAB
-    VERSION = "0.0.5"
+    VERSION = "0.0.8"
   end
 end

data/lib/rspec/openhab/wait.rb

@@ -4,14 +4,75 @@ module RSpec
   module OpenHAB
     module Wait
       def wait_for_rules
+        wait_for_background_tasks(timers: false)
+      end
+
+      def wait_for_timers
+        wait_for_background_tasks(rules: false)
+      end
+
+      def wait_for_background_tasks(rules: true, timers: true)
         loop do
-          sleep(0.1)
-          break if java.lang.Thread.all_stack_traces.keys.all? do |t|
-                     !t.name.match?(/^OH-rule-/) ||
-                     [java.lang.Thread::State::WAITING, java.lang.Thread::State::TIMED_WAITING].include?(t.state)
-                   end
+          sleep 0.1
+          next if java.lang.Thread.all_stack_traces.any? do |(t, stack)|
+            # this is just an estimate. I see 9 when it's parked waiting
+            # for an event, but once it hits ruby it gets real big real quick
+            min_frames = 15
+
+            case t.name
+            when /^OH-scheduler-/
+              # timer thread; born and die for each timer
+              if thread_running?(t) || stack.length > min_frames
+                logger.debug "thread #{t.name} is running (#{stack.length})"
+                stack.each do |frame|
+                  logger.trace "  #{frame}"
+                end
+                next timers
+              end
+            when /^OH-rule-/
+
+              if thread_running?(t) || stack.length > min_frames
+                logger.debug "thread #{t.name} is running (#{stack.length})"
+                stack.each do |frame|
+                  logger.trace "  #{frame}"
+                end
+
+                next rules
+              end
+            when /^OH-(?:eventwatcher|eventexecutor)-/
+              # an event is making its way through the system
+              if thread_running?(t)
+                logger.debug "thread #{t.name} is running"
+                next rules
+              end
+            end
+          end
+
+          # no need to retry if there were no timers
+          break unless timers && wait_for_next_timer
         end
       end
+
+      private
+
+      def thread_running?(thread)
+        ![java.lang.Thread::State::WAITING,
+          java.lang.Thread::State::TIMED_WAITING].include?(thread.state)
+      end
+
+      def wait_for_next_timer
+        latest = ::OpenHAB::DSL::Timers.timer_manager.instance_variable_get(:@timers).min_by(&:execution_time)
+        return false unless latest
+
+        delta = (latest.execution_time.to_instant.to_epoch_milli - java.time.Instant.now.to_epoch_milli) / 1000.0
+        # in the past? it's probably executing
+        return true if delta.negative?
+
+        logger.info("Waiting #{delta}s for next timer") if delta > 5
+
+        sleep(delta)
+        true
+      end
     end
   end
 end

data/lib/rspec-openhab-scripting.rb

@@ -34,10 +34,10 @@ maven_require do
   require "jar tech.units, indriya, 2.1.3"
 
   require "jar org.openhab.core.bundles, org.openhab.core, #{openhab_version}"
-  require "jar org.openhab.core.bundles, org.openhab.core.config.core, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.automation, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.automation.module.script, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.automation.module.script.rulesupport, #{openhab_version}"
+  require "jar org.openhab.core.bundles, org.openhab.core.config.core, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.io.monitor, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.model.core, #{openhab_version}"
   require "jar org.openhab.core.bundles, org.openhab.core.model.script, #{openhab_version}"
@@ -64,28 +64,33 @@ OpenHAB::DSL::Imports.import_presets
 
 require "openhab"
 
+require "rspec/openhab/actions"
 require "rspec/openhab/core/cron_scheduler"
 
-# openhab-scripting uses a require_relative, so our override doesn't get used
-OpenHAB::DSL.send(:remove_const, :Timer)
-require_relative "rspec/openhab/dsl/timers/timer"
-
 # RSpec additions
+require "rspec/core"
 require "rspec/openhab/dsl/rules/rspec"
+require "rspec/openhab/items"
 require "rspec/openhab/state"
+require "rspec/openhab/timer"
 require "rspec/openhab/trigger"
 require "rspec/openhab/wait"
-require "rspec/openhab/items"
 
 RSpec::OpenHAB::Items.populate_items_from_api(api)
 
+# make bundler/inline _not_ destroy the already existing load path
+module Bundler
+  module SharedHelpers
+    def clean_load_path; end
+  end
+end
+
 # load rules files
 OPENHAB_AUTOMATION_PATH = "#{org.openhab.core.OpenHAB.config_folder}/automation/jsr223/ruby/personal"
 
-# set up some environment the rules files expect
 Dir["#{OPENHAB_AUTOMATION_PATH}/*.rb"].each do |f|
   load f
 rescue Exception => e # rubocop:disable Lint/RescueException
-  warn "Failed loading #{f}: #{e}"
+  warn "Failed loading #{f}: #{e.inspect}"
   warn e.backtrace
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.8
 platform: java
 authors:
 - Cody Cutrer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -172,7 +172,7 @@ extra_rdoc_files: []
 files:
 - lib/rspec-openhab-scripting.rb
 - lib/rspec-openhab-scripting_jars.rb
-- lib/rspec/bundler/inline.rb
+- lib/rspec/openhab/actions.rb
 - lib/rspec/openhab/api.rb
 - lib/rspec/openhab/core/cron_scheduler.rb
 - lib/rspec/openhab/core/load_path.rb
@@ -182,9 +182,9 @@ files:
 - lib/rspec/openhab/core/script_handling.rb
 - lib/rspec/openhab/dsl/imports.rb
 - lib/rspec/openhab/dsl/rules/rspec.rb
-- lib/rspec/openhab/dsl/timers/timer.rb
 - lib/rspec/openhab/items.rb
 - lib/rspec/openhab/state.rb
+- lib/rspec/openhab/timer.rb
 - lib/rspec/openhab/trigger.rb
 - lib/rspec/openhab/version.rb
 - lib/rspec/openhab/wait.rb

data/lib/rspec/bundler/inline.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Bundler
-  class DummyDsl
-    def source(*); end
-  end
-end
-
-def gemfile(*, &block)
-  # needs to be a no-op, since we're already running in the context of bundler
-  Bundler::DummyDsl.new.instance_eval(&block)
-end

data/lib/rspec/openhab/dsl/timers/timer.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    class Timer
-      #
-      # Create a new Timer Object
-      #
-      # @param [Duration] duration Duration until timer should fire
-      # @param [Block] block Block to execute when timer fires
-      #
-      def initialize(duration:, thread_locals: {}, &block) # rubocop:disable Lint/UnusedMethodArgument
-        @duration = duration
-
-        Timers.timer_manager.add(self)
-      end
-
-      def reschedule(_duration = nil)
-        Timers.timer_manager.add(self)
-      end
-
-      #
-      # Cancel timer
-      #
-      # @return [Boolean] True if cancel was successful, false otherwise
-      #
-      def cancel
-        Timers.timer_manager.delete(self)
-      end
-
-      def terminated?; end
-      alias_method :has_terminated, :terminated?
-
-      def is_active # rubocop:disable Naming/PredicateName
-        false
-      end
-
-      private
-
-      def timer_block
-        proc do
-          Timers.timer_manager.delete(self)
-          yield(self)
-        end
-      end
-    end
-
-    #
-    # Convert TemporalAmount (Duration), seconds (float, integer), and Ruby Time to ZonedDateTime
-    # Note: TemporalAmount is added to now
-    #
-    # @param [Object] timestamp to convert
-    #
-    # @return [ZonedDateTime]
-    #
-    def self.to_zdt(timestamp)
-      logger.trace("Converting #{timestamp} (#{timestamp.class}) to ZonedDateTime")
-      return unless timestamp
-
-      case timestamp
-      when Java::JavaTimeTemporal::TemporalAmount then ZonedDateTime.now.plus(timestamp)
-      when ZonedDateTime then timestamp
-      when Time then timestamp.to_java(ZonedDateTime)
-      else
-        to_zdt(seconds_to_duration(timestamp)) ||
-          raise(ArgumentError, "Timestamp must be a ZonedDateTime, a Duration, a Numeric, or a Time object")
-      end
-    end
-
-    #
-    # Convert numeric seconds to a Duration object
-    #
-    # @param [Float, Integer] secs The number of seconds in integer or float
-    #
-    # @return [Duration]
-    #
-    def self.seconds_to_duration(secs)
-      return unless secs
-
-      if secs.respond_to?(:to_f)
-        secs.to_f.seconds
-      elsif secs.respond_to?(:to_i)
-        secs.to_i.seconds
-      end
-    end
-  end
-end