saal 0.2.25 → 0.3.4

data/saal.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
 
   s.name              = 'saal'
-  s.version           = '0.2.25'
-  s.date              = '2014-01-03'
+  s.version           = '0.3.4'
+  s.date              = '2021-04-04'
 
   s.summary     = "Thin abstraction layer for interfacing and recording sensors (currently onewire) and actuators (currently dinrelay)"
   s.description = <<EOF
@@ -19,6 +19,7 @@ EOF
   s.authors  = ["Pedro Côrte-Real"]
   s.email    = 'pedro@pedrocr.net'
   s.homepage = 'https://github.com/pedrocr/saal'
+  s.licenses = 'LGPL-2.1'
 
   s.require_paths = %w[lib]
 
@@ -28,9 +29,10 @@ EOF
 
   s.executables = Dir.glob("bin/*").map{|f| f.gsub('bin/','')}
 
-  s.add_dependency('ownet', [">= 0.2.1"])
-  s.add_dependency('nokogiri')
-  s.add_dependency('mysql')
+  s.add_runtime_dependency 'ownet', "~>0.2"
+  s.add_runtime_dependency 'mysql2', "~>0.5"
+  s.add_runtime_dependency 'nokogiri', '~>1.8'
+  s.add_runtime_dependency 'net-http-digest_auth', '~>1.4'
 
   # = MANIFEST =
   s.files = %w[
@@ -43,7 +45,10 @@ EOF
     bin/dinrelaystatus
     bin/saal_chart
     bin/saal_daemon
+    bin/saal_denkovi_relays
     bin/saal_dump_database
+    bin/saal_envoy_generate_config
+    bin/saal_envoy_read
     bin/saal_import_mysql
     bin/saal_readall
     lib/chart.rb
@@ -51,7 +56,10 @@ EOF
     lib/charts.rb
     lib/daemon.rb
     lib/dbstore.rb
+    lib/denkovi.rb
     lib/dinrelay.rb
+    lib/envoy.rb
+    lib/http.rb
     lib/outliercache.rb
     lib/owsensor.rb
     lib/saal.rb
@@ -63,6 +71,8 @@ EOF
     test/charts_test.rb
     test/daemon_test.rb
     test/dbstore_test.rb
+    test/denkovi.json.erb
+    test/denkovi_test.rb
     test/dinrelay.html.erb
     test/dinrelay_test.rb
     test/nonexistant_sensor.yml
@@ -71,6 +81,7 @@ EOF
     test/sensors_test.rb
     test/test_charts.yml
     test/test_db.yml
+    test/test_denkovi_sensors.yml
     test/test_dinrelay_sensors.yml
     test/test_helper.rb
     test/test_sensor_cleanups.yml

data/test/chart_data_test.rb

@@ -78,7 +78,7 @@ class TestChartData < Test::Unit::TestCase
                                         Time.utc(2012, 3, 25, 23, 59, 59),
                             ["0"]+(2..23).map{|s| s.to_s}+["0"], 
                             Time.utc(2012, 3, 25, 23, 59, 59),
-                            "_changing_timezone_test","Europe/Lisbon")
+                            "_changing_timezone_test2","Europe/Lisbon")
 
   assert_alignment_interval(24, :hours, Time.utc(2010, 12, 29, 16, 0, 0),
                                         Time.utc(2010, 12, 30, 15, 59, 59),

data/test/chart_test.rb

@@ -16,7 +16,6 @@ class TestChart < Test::Unit::TestCase
 
   def test_average
     name = 'week'
-    defs = @defs[name]
     chart = @charts.find(name)    
     assert_equal ['Fri','Sat','Sun','Mon','Tue','Wed','Thu'], chart.periodnames
     chart.sensors.each {|s| s.mock_set(:average => 1)}
@@ -31,7 +30,6 @@ class TestChart < Test::Unit::TestCase
 
   def test_min_max_avg_1arity
     name = 'week'
-    defs = @defs[name]
     chart = @charts.find(name)    
     assert_equal ['Fri','Sat','Sun','Mon','Tue','Wed','Thu'], chart.periodnames
     v = {:minimum => 1.0, :maximum => 2.0, :average => 1.5}
@@ -43,7 +41,6 @@ class TestChart < Test::Unit::TestCase
   
   def test_min_max_0arity
     name = 'week'
-    defs = @defs[name]
     chart = @charts.find(name)    
     assert_equal ['Fri','Sat','Sun','Mon','Tue','Wed','Thu'], chart.periodnames
     v = {:minimum => 1.0, :maximum => 2.0, :average => 1.5}

data/test/daemon_test.rb

@@ -18,7 +18,7 @@ class TestDaemon < Test::Unit::TestCase
     end
 
     db_test_query("SELECT * FROM sensor_reads") do |res|
-      assert res.num_rows > 0, "No sensor reads in DB"
+      assert res.count > 0, "No sensor reads in DB"
     end
   end
 
@@ -38,7 +38,7 @@ class TestDaemon < Test::Unit::TestCase
     end
 
     db_test_query("SELECT * FROM sensor_reads") do |res|
-      assert res.num_rows == 0
+      assert res.count == 0
     end
   end
 end

data/test/dbstore_test.rb

@@ -9,8 +9,11 @@ class TestFileStore < Test::Unit::TestCase
     @dbstore.write(:test_sensor, test_time, test_value)
     
     db_test_query("SELECT * FROM sensor_reads") do |res|
-      assert_equal 1, res.num_rows
-      assert_equal ["test_sensor", test_time.to_s, test_value.to_s], res.fetch_row
+      assert_equal 1, res.count
+      row = res.first
+      assert_equal "test_sensor", row["sensor"]
+      assert_equal test_time, row["date"].to_i
+      assert_equal test_value, row["value"].to_f
     end
   end
 
@@ -39,6 +42,21 @@ class TestFileStore < Test::Unit::TestCase
     assert_nil @dbstore.average(:test_sensor, 50, 60)
   end
 
+  def test_weighted_average
+    db_setup
+    test_values = [[10, 7.323],[12, 5.432],[23, -2.125], [44, 0.123]]
+    test_average = ((12-10)*7.323+(23-12)*5.432+(44-23)*(-2.125)) / (44-10)
+    test_values.each do |values|
+      @dbstore.write(:test_sensor, *values)
+    end
+
+    assert_instance_of Float, @dbstore.average(:test_sensor, 10, 44)
+    assert_in_delta test_average, @dbstore.weighted_average(:test_sensor, 10, 44), 0.001
+
+    # when there are no points it's nil
+    assert_nil @dbstore.weighted_average(:test_sensor, 50, 60)
+  end
+
   def test_min_max
     db_setup
     test_values = [[10, 7.323],[12, 5.432],[23, -2.125], [44, 0.123]]

data/test/denkovi.json.erb

@@ -0,0 +1,39 @@
+{
+
+  "CurrentState": {
+
+    "Output": [
+
+<% (1..16).each do |num| %>
+<% state = outlets[num] %>
+<% val = state == "ON" ? "1" : "0" %>
+<% if num < 16 %>
+      {"Name": "RELAY<%= num %>", "Value": "<%= val %>"},
+<% else %>
+      {"Name": "RELAY<%= num %>", "Value": "<%= val %>"}
+<% end %>
+<% end %>
+
+    ],
+
+    "Auto-reboot": {
+
+      "RebootsNumber": "0",
+
+      "LastReboot": "-"
+
+    },
+
+    "Device": {
+
+      "Name": "SMARTDEN_IP-16R",
+
+      "MAC": "E8:EA:DA:AA:AA:AA"
+
+    }
+
+  }
+
+}
+
+

data/test/denkovi_test.rb

@@ -0,0 +1,212 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+require 'webrick'
+require 'benchmark'
+
+class TestDenkoviRelay < Test::Unit::TestCase
+  def setup
+    @@serv_num ||= 0
+    @@serv_num += 1
+
+    @og=SAAL::Denkovi::OutletGroup.new(service_opts)
+    @vals={1=>"OFF",2=>"OFF",3=>"ON",4=>"OFF",5=>"ON",6=>"ON",7=>"ON",8=>"OFF",
+           9=>"OFF",10=>"OFF",11=>"ON",12=>"OFF",13=>"ON",14=>"ON",15=>"ON",16=>"OFF"}
+    @rvals={1=>"ON",2=>"ON",3=>"OFF",4=>"ON",5=>"OFF",6=>"OFF",7=>"OFF",8=>"ON",
+            9=>"ON",10=>"ON",11=>"OFF",12=>"ON",13=>"OFF",14=>"OFF",15=>"OFF",16=>"ON"}
+
+    defs = YAML::load(File.new(TEST_SENSORS_DENKOVI_FILE))
+    @pass = defs["group1"]["denkovi"]["pass"]
+    defs['group1']['denkovi']['port'] = service_opts[:port]
+    tempfile = Tempfile.new('denkovi_test_yml')
+    File.open(tempfile.path,'w') {|f| f.write(YAML::dump defs)}
+    @test_sensors_denkovi_file = tempfile.path
+  end
+
+  def service_opts
+    base_opts = {:host => 'localhost', :pass =>"somepass"}
+    base_opts.merge(:port => 3333+@@serv_num)
+  end
+
+  class BasicServing < WEBrick::HTTPServlet::AbstractServlet
+    def self.get_instance(config, opts)
+      new(opts)
+    end
+    def initialize(opts)
+      @html = opts[:html]
+      @pass = opts[:pass]
+      @status = opts[:status] || 200
+      @feedback = opts[:feedback] || {}
+      @sleep = opts[:sleep] || 0
+    end
+    def do_GET(req, res)
+      sleep @sleep
+      @feedback[:uris] ||= []
+      @feedback[:uris] << req.request_uri.to_s
+      @feedback[:uri] = req.request_uri.to_s
+      @feedback[:nrequests] = (@feedback[:nrequests]||0)+1
+      res.body = @html
+      res.status = @status
+      res['Content-Type'] = "text/html"
+    end
+  end
+
+  def with_webrick(opts)
+    opts = service_opts.merge(opts)  
+
+    Socket.do_not_reverse_lookup = true # Speed up startup
+    log = WEBrick::Log.new($stderr, WEBrick::Log::ERROR)
+    access_log = [[log, WEBrick::AccessLog::COMBINED_LOG_FORMAT]]
+    s = WEBrick::HTTPServer.new(:Port => opts[:port], 
+                                :Logger => log,
+                                :AccessLog => access_log)
+    s.mount('/', BasicServing, opts.merge(:feedback => (f = {})))
+    
+    thread = Thread.new do
+      s.start
+    end
+    while s.status != :Running; sleep 0.1; end # Make sure the server is up
+    yield f
+    s.shutdown
+    thread.exit
+  end
+
+  def create_current_state_json(hash)
+    outlets = hash
+    erb = ERB.new(File.open(File.dirname(__FILE__)+'/denkovi.json.erb').read)
+    erb.result(binding)
+  end
+
+  def assert_path(path, uri)
+    assert_equal "http://localhost:#{service_opts[:port]}"+path, uri
+  end
+
+  def test_read_state
+    with_webrick(:html=>create_current_state_json(@vals)) do |feedback|
+      @vals.each do |num, state|
+        assert_equal state, @og.state(num)
+        assert_path "/current_state.json?pw=#{@pass}", feedback[:uri]
+      end
+    end
+  end
+
+  def test_set_state
+    with_webrick(:html=>create_current_state_json(@rvals)) do |feedback|
+      @vals.each do |num, state|
+        newstate = state == "ON" ? "OFF" : "ON"
+        val = {"ON" => "1", "OFF" => "0"}[newstate]
+        assert @og.set_state(num,newstate), "State change not working"
+        assert_path "/current_state.json?pw=#{@pass}&Relay#{num}=#{val}", feedback[:uri]
+      end
+    end
+  end
+
+  def test_enumerate_sensors
+    sensors = SAAL::Sensors.new(@test_sensors_denkovi_file, TEST_DBCONF)
+    assert_equal((1..16).map{|i| "name#{i.to_s.rjust(2, "0")}"}, sensors.map{|s| s.name}.sort)
+    assert_equal((1..16).map{|i| "description#{i.to_s.rjust(2, "0")}"}, sensors.map{|s| s.description}.sort)
+  end
+
+  def test_sensor_type
+    SAAL::Sensors.new(TEST_SENSORS_DENKOVI_FILE, TEST_DBCONF).each do |s|
+      assert_equal :onoff, s.sensor_type
+    end
+  end
+
+  def test_read_sensors
+    sensors = SAAL::Sensors.new(@test_sensors_denkovi_file, TEST_DBCONF)
+    with_webrick(:html=>create_current_state_json(@vals)) do |feedback|
+      @vals.each do |num, state|
+        value = state == "ON" ? 1.0 : 0.0
+        assert_equal value, sensors.send('name'+num.to_s.rjust(2, "0")).read
+        assert_path "/current_state.json?pw=#{@pass}", feedback[:uri]
+      end
+      assert_equal 1, feedback[:nrequests], "denkovi request caching not working"
+    end
+  end
+
+  def test_set_sensors
+    sensors = SAAL::Sensors.new(@test_sensors_denkovi_file, TEST_DBCONF)
+    with_webrick(:html=>create_current_state_json(@rvals)) do |feedback|
+      @vals.each do |num, state|
+        newval = state == "ON" ? 0.0 : 1.0
+        newstate = state == "ON" ? "OFF" : "ON"
+        assert_equal newval, sensors.send('name'+num.to_s.rjust(2, "0")).write(newval), 
+                     "State change not working"
+        val = {"ON" => "1", "OFF" => "0"}[newstate]
+        assert_path "/current_state.json?pw=#{@pass}&Relay#{num}=#{val}", feedback[:uris][-2]
+        assert_path "/current_state.json?pw=#{@pass}", feedback[:uris][-1]
+      end
+    end
+  end
+
+  # Test that write invalidates any caching
+  def test_write_read_sensors
+    sensors = SAAL::Sensors.new(@test_sensors_denkovi_file, TEST_DBCONF)
+    with_webrick(:html=>create_current_state_json(@vals)) do |feedback|
+      @vals.each do |num, state|
+        sensors.send('name'+num.to_s.rjust(2, "0")).write(0.0)
+        sensors.send('name'+num.to_s.rjust(2, "0")).read
+      end
+      assert_equal 32, feedback[:nrequests], "denkovi caching too much"
+    end
+  end
+
+  # Test that the cache times out
+  def test_cache_invalidation
+    _sensors = SAAL::Sensors.new(@test_sensors_denkovi_file, TEST_DBCONF)
+    @og.cache_timeout = 0.1
+    with_webrick(:html=>create_current_state_json(@vals)) do |feedback|
+      @og.state(1)
+      sleep 0.2
+      @og.state(1)
+      assert_equal 2, feedback[:nrequests], "denkovi caching not invalidating"
+    end
+  end
+
+  def test_failed_connection
+    @vals.each do |num, state|
+      assert_equal nil, @og.state(num)
+      assert !@og.set_state(num,"ON"), "State change working without a server?!"
+    end
+  end
+
+  def test_failed_request
+    with_webrick(:html=>create_current_state_json(@vals),:status=>404) do |feedback|
+      @vals.each do |num, state|
+        assert_equal nil, @og.state(num)
+        assert !@og.set_state(num,"ON"), "State change working without a server?!"
+      end
+    end
+  end
+
+  def test_fast_open_timeout
+    #FIXME: Find a way to make this test address more generic
+    @og=SAAL::Denkovi::OutletGroup.new(service_opts.merge(:host => "10.254.254.254", 
+                                                           :timeout=>0.1))
+    with_webrick(:html=>create_current_state_json(@vals)) do |feedback|
+      time = Benchmark.measure do
+        @vals.each do |num, state|
+          assert_equal nil, @og.state(num), "Read not timing out?"
+          assert !@og.set_state(num,"ON"), "State change not timing out?"
+        end
+      end
+      total_time = @og.timeout*2*@vals.keys.size
+      assert time.total < total_time
+             "Doing the reads took too long, are we really timing out?"
+    end
+  end
+
+  def test_fast_read_timeout
+    @og=SAAL::Denkovi::OutletGroup.new(service_opts.merge(:timeout=>0.1))
+    with_webrick(:html=>create_current_state_json(@vals),:sleep=>10) do |feedback|
+      time = Benchmark.measure do
+        @vals.each do |num, state|
+          assert_equal nil, @og.state(num), "Read not timing out?"
+          assert !@og.set_state(num,"ON"), "State change not timing out?"
+        end
+      end
+      total_time = @og.timeout*2*@vals.keys.size
+      assert time.total < total_time
+             "Doing the reads took too long, are we really timing out?"
+    end
+  end
+end

data/test/dinrelay_test.rb

@@ -151,7 +151,7 @@ class TestDINRelay < Test::Unit::TestCase
 
   # Test that the cache times out
   def test_cache_invalidation
-    sensors = SAAL::Sensors.new(@test_sensors_dinrelay_file, TEST_DBCONF)
+    _sensors = SAAL::Sensors.new(@test_sensors_dinrelay_file, TEST_DBCONF)
     @og.cache_timeout = 0.1
     with_webrick(:html=>create_index_html(@vals)) do |feedback|
       @og.state(1)

data/test/sensor_test.rb

@@ -31,6 +31,9 @@ class MockDBStore
   def average(sensor, from, to)
     @value
   end
+  def weighted_average(sensor, from, to)
+    @value
+  end
   def minimum(sensor, from, to)
     @value
   end
@@ -112,6 +115,7 @@ class TestSensor < Test::Unit::TestCase
     assert_equal corrected, sensor.minimum(0,100)
     assert_equal corrected, sensor.maximum(0,100)
     assert_equal corrected, sensor.average(0,100)
+    assert_equal corrected, sensor.weighted_average(0,100)
   end
 
   def test_linear_correction
@@ -125,6 +129,7 @@ class TestSensor < Test::Unit::TestCase
     assert_equal corrected, sensor.minimum(0,100)
     assert_equal corrected, sensor.maximum(0,100)
     assert_equal corrected, sensor.average(0,100)
+    assert_equal corrected, sensor.weighted_average(0,100)
   end
 
   def test_sensor_type
@@ -145,9 +150,10 @@ class TestSensor < Test::Unit::TestCase
     assert_equal 2.0, @mockable.read
     @mockable.write(3.0)
     assert_equal 3.0, @mockable.read
-    @mockable.mock_set(:minimum => 1.0, :average => 2.0, :maximum => 3.0, :last_value => 5.0)
+    @mockable.mock_set(:minimum => 1.0, :average => 2.0, :weighted_average => 2.5, :maximum => 3.0, :last_value => 5.0)
     assert_equal 1.0, @mockable.minimum(0,100)
     assert_equal 2.0, @mockable.average(0,100)
+    assert_equal 2.5, @mockable.weighted_average(0,100)
     assert_equal 3.0, @mockable.maximum(0,100)
     assert_equal 5.0, @mockable.last_value
     assert_equal 3.0, @mockable.read