saal 0.2.2

data/test/dinrelay_test.rb

@@ -0,0 +1,112 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+require 'webrick'
+#require 'webrick/accesslog'
+
+class TestDINRelay < Test::Unit::TestCase
+  SERVICE_OPTS = {:host => 'localhost', :port => 33333, 
+                  :user => "someuser", :pass =>"somepass"}
+
+  class BasicServing < WEBrick::HTTPServlet::AbstractServlet
+    def self.get_instance(config, opts)
+      new(opts)
+    end
+    def initialize(opts)
+      @html = opts[:html]
+      @user = opts[:user]
+      @pass = opts[:pass]
+      @feedback = opts[:feedback] || {}
+    end
+    def do_GET(req, res)
+      @feedback[:uri] = req.request_uri.to_s
+      WEBrick::HTTPAuth.basic_auth(req, res, "My Realm") {|user, pass|
+        user == @user && pass == @pass
+      }
+      res.body = @html
+      res['Content-Type'] = "text/xml"
+    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_index_html(hash)
+    outlets = hash
+    erb = ERB.new(File.open(File.dirname(__FILE__)+'/dinrelay.html.erb').read)
+    erb.result(binding)
+  end
+
+  def setup
+    @og=SAAL::DINRelay::OutletGroup.new(SERVICE_OPTS)
+    @vals={1=>"OFF",2=>"OFF",3=>"ON",4=>"OFF",5=>"ON",6=>"ON",7=>"ON",8=>"OFF"}
+    @rvals={1=>"ON",2=>"ON",3=>"OFF",4=>"ON",5=>"OFF",6=>"OFF",7=>"OFF",8=>"ON"}
+  end
+
+  def assert_path(path, uri)
+    assert_equal "http://localhost:#{SERVICE_OPTS[:port]}"+path, uri
+  end
+
+  def test_read_state
+    with_webrick(:html=>create_index_html(@vals)) do |feedback|
+      @vals.each do |num, state|
+        assert_equal state, @og.state(num)
+        assert_path '/index.htm', feedback[:uri]
+      end
+    end
+  end
+
+  def test_set_state
+    with_webrick(:html=>create_index_html(@rvals)) do |feedback|
+      @vals.each do |num, state|
+        newstate = state == "ON" ? "OFF" : "ON"
+        assert @og.set_state(num,newstate), "State change not working"
+        assert_path "/outlet?#{num}=#{newstate}", feedback[:uri]
+      end
+    end
+  end
+
+  def test_enumerate_sensors
+    sensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    assert_equal((1..8).map{|i| "name#{i}"}, sensors.map{|s| s.name}.sort)
+  end
+
+  def test_read_sensors
+    sensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    with_webrick(:html=>create_index_html(@vals)) do |feedback|
+      @vals.each do |num, state|
+        value = state == "ON" ? 1.0 : 0.0
+        assert_equal value, sensors.send('name'+num.to_s).read
+        assert_path '/index.htm', feedback[:uri]
+      end
+    end
+  end
+
+  def test_set_sensors
+    sensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    with_webrick(:html=>create_index_html(@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).write(newval), 
+                     "State change not working"
+        assert_path "/outlet?#{num}=#{newstate}", feedback[:uri]
+      end
+    end
+  end
+end

data/test/nonexistant_sensor.yml

@@ -0,0 +1,5 @@
+non_existant:
+  name: "A non-existant sensor"
+  onewire: 
+    serial: /10.A00000000000/temperature
+

data/test/outliercache_test.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+
+class TestOutlierCache < Test::Unit::TestCase
+  def test_clean_setup
+    cache = SAAL::OutlierCache.new
+    assert !cache.live, "Live empty cache"
+    20.times {cache.validate(10)}
+    assert cache.live, "Not Live full cache"
+  end
+
+  def test_failed_dirty_setup
+    cache = SAAL::OutlierCache.new
+    assert !cache.live, "Live empty cache"
+    (1..20).each {|i| cache.validate(i)}
+    assert !cache.live, "Live cache with dirty results"
+  end
+
+  def test_working_dirty_setup
+    cache = SAAL::OutlierCache.new
+    assert !cache.live, "Live empty cache"
+    [1,1,1,2,1,1,1,1,1,1,1,1,1].each {|i| cache.validate(i)}
+    assert cache.live, "Not Live full cache"
+  end
+
+  def test_validate
+    cache = SAAL::OutlierCache.new
+    20.times {cache.validate(10)}
+    assert cache.live, "Not Live full cache"
+    assert cache.validate(10), "Non validated good value"
+    assert !cache.validate(15), "Validated bad value"
+  end
+
+  def test_setup_recover_from_discontinuity
+    cache = SAAL::OutlierCache.new
+    20.times {cache.validate(10)}
+    assert cache.live, "Not Live full cache"
+    20.times {cache.validate(15)}
+    assert cache.live, "Not Live full cache"
+    assert cache.validate(15), "Non validated good value"
+    assert !cache.validate(10), "Validated bad value"
+  end
+end

data/test/sensor_test.rb

@@ -0,0 +1,109 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+
+class MockConnection
+  attr_accessor :value, :values
+  def initialize
+    @value = @values = nil
+  end
+  def read(serial)
+    @value ? @value : @values.shift 
+  end
+end
+
+class MockDBStore
+  attr_accessor :value
+  def average(sensor, from, to)
+    @value
+  end
+end
+
+class TestSensor < Test::Unit::TestCase
+  def fake_sensor(name, opts={})
+    SAAL::Sensors.sensors_from_defs(@dbstore, name, @defs[name], 
+                                    opts.merge(:owconn => @conn))[0]
+  end
+
+  def setup
+    @defs = YAML::load File.new(TEST_SENSOR_CLEANUPS_FILE)
+    @conn = MockConnection.new
+    @dbstore = MockDBStore.new
+    @fake = fake_sensor('fake', :no_outliercache => true)
+    @fake2 = fake_sensor('fake2', :no_outliercache => true)
+    @fake3 = fake_sensor('fake3')
+    @max_value = @defs['fake2']['max_value']
+    @max_correctable = @defs['fake2']['max_correctable']
+    @min_value = @defs['fake2']['min_value']
+    @min_correctable = @defs['fake2']['min_correctable']
+  end
+
+  def test_read_too_high_values
+    @conn.value = @max_value+1
+    assert_nil @fake.read
+    assert_nil @fake.read_uncached
+    @conn.value = @max_value
+    assert_equal @max_value, @fake.read
+    assert_equal @max_value, @fake.read_uncached
+  end
+
+  def test_read_too_high_but_correctable_values
+    @conn.value = @max_correctable
+    assert_equal @max_value, @fake2.read
+    assert_equal @max_value, @fake2.read_uncached
+    @conn.value = @max_correctable+1
+    assert_nil @fake2.read
+    assert_nil @fake2.read_uncached
+  end
+
+  def test_read_too_low_values
+    @conn.value = @min_value-1
+    assert_nil @fake.read
+    assert_nil @fake.read_uncached
+    @conn.value = @min_value
+    assert_equal @min_value, @fake.read
+    assert_equal @min_value, @fake.read_uncached
+  end
+
+  def test_read_too_low_but_correctable_values
+    @conn.value = @min_correctable
+    assert_equal @min_value, @fake2.read
+    assert_equal @min_value, @fake2.read_uncached
+    @conn.value = @min_correctable-1
+    assert_nil @fake2.read
+    assert_nil @fake2.read_uncached
+  end
+
+  def test_read_without_limits
+    @conn.value = 200
+    assert_equal 200, @fake3.read
+    assert_equal 200, @fake3.read_uncached
+  end
+
+  def test_eliminate_outliers
+    @conn.values = [200]*20 + [1000,200]
+    assert_equal [200]*21, (1..21).map{@fake3.read}
+    @conn.values = [200]*20 + [1000,200,1000,200]
+    assert_equal [200]*21, (1..21).map{@fake3.read_uncached}
+  end
+
+  def test_eliminate_outliers_zeroes
+    @conn.values = [0]*20 + [1000,0]
+    assert_equal [0]*20+[1000], (1..21).map{@fake3.read}
+    @conn.values = [0]*20 + [1000,0]
+    assert_equal [0]*20+[1000], (1..21).map{@fake3.read_uncached}
+  end
+
+  def test_mocked
+    @mockable = fake_sensor('fake3')
+    @conn.value = 1.0
+    assert_equal 1.0, @mockable.read
+    @mockable.mock_set(:value => 2.0)
+    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)
+    assert_equal 1.0, @mockable.minimum(0,100)
+    assert_equal 2.0, @mockable.average(0,100)
+    assert_equal 3.0, @mockable.maximum(0,100)
+    assert_equal 3.0, @mockable.read
+  end
+end

data/test/sensors_test.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+
+class TestSensors < Test::Unit::TestCase
+  def setup
+    @defs = YAML::load File.new(TEST_SENSORS_FILE)
+    @sensors = SAAL::Sensors.new(TEST_SENSORS_FILE, TEST_DBCONF)
+  end
+    
+  def test_get_sensor
+    @defs.each do |name, value|
+      s = @sensors.send name
+      assert_equal s.description, value['name']
+    end
+  end
+  
+  def test_read
+    with_fake_owserver do
+      assert_instance_of Float, @sensors.fake_temp.read
+      assert_nil @sensors.non_existant.read
+      assert_raise(NoMethodError) { @sensors.no_such_name.read }
+    end
+  end
+
+  def test_read_uncached
+    with_fake_owserver do
+      assert_instance_of Float, @sensors.fake_temp.read_uncached
+      assert_nil @sensors.non_existant.read_uncached
+      assert_raise(NoMethodError) { @sensors.no_such_name.read_uncached }
+    end
+  end
+    
+  def test_each
+    expected = @defs.map{ |name, value| value['name']}
+    assert_equal expected, @sensors.map {|sensor| sensor.description}
+  end
+
+  def test_writeable
+    dinsensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    dinsensors.each {|s| assert s.writeable?}
+    owsensors = SAAL::Sensors.new(TEST_SENSORS_FILE, TEST_DBCONF)
+    owsensors.each {|s| assert !s.writeable?}
+  end
+
+  def test_average
+    db_setup
+
+    test_values = [[10, 7.323],[12, 5.432],[23, -2.125], [44, 0.123]]
+    test_average = (5.432 - 2.125)/2.0
+    test_values.each do |values|
+      @dbstore.write(:fake_temp, *values)
+    end
+    
+    assert_instance_of Float, @sensors.fake_temp.average(11, 25)
+    assert_in_delta test_average, @sensors.fake_temp.average(11, 25), 0.001
+    assert_in_delta test_average, @sensors.fake_temp.average(12, 25), 0.001
+    assert_in_delta test_average, @sensors.fake_temp.average(11, 23), 0.001
+    
+    # when there are no points it's nil
+    assert_nil @sensors.fake_temp.average(50, 60)
+  end
+
+  def test_store_value
+    db_setup
+    
+    with_fake_owserver do
+      @sensors.fake_temp.store_value
+    end
+
+    db_test_query("SELECT * FROM sensor_reads") do |res|
+      assert_equal 1, res.num_rows
+      row = res.fetch_row
+      assert_equal "fake_temp", row[0]
+      assert_in_delta Time.now.utc.to_i, row[1], 100
+      assert_instance_of Float, row[2].to_f
+    end
+  end  
+end

data/test/test_db.yml

@@ -0,0 +1,4 @@
+host: localhost
+user: sensor_reads
+pass: abcd
+db: sensor_reads_test

data/test/test_dinrelay_sensors.yml

@@ -0,0 +1,16 @@
+group1:
+  dinrelay:
+    host: localhost
+    port: 33333
+    user: someuser
+    pass: somepass
+    outlets:
+      1: name1
+      2: name2
+      3: name3
+      4: name4
+      5: name5
+      6: name6
+      7: name7
+      8: name8
+

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+require 'test/unit'
+require 'yaml'
+require 'fileutils'
+require File.dirname(__FILE__)+'/../lib/saal.rb'
+
+class Test::Unit::TestCase
+  TEST_SENSORS_FILE = File.dirname(__FILE__)+'/test_sensors.yml'
+  TEST_SENSORS_DINRELAY_FILE = File.dirname(__FILE__)+'/test_dinrelay_sensors.yml'
+  TEST_SENSOR_CLEANUPS_FILE = File.dirname(__FILE__)+'/test_sensor_cleanups.yml'
+  TEST_NONEXIST_SENSOR_FILE = File.dirname(__FILE__)+'/nonexistant_sensor.yml'
+  TEST_DBCONF = File.dirname(__FILE__)+'/test_db.yml'
+  TEST_DBOPTS = YAML::load(File.new(TEST_DBCONF))
+
+  def with_fake_owserver
+    pid = fork do 
+      exec("owserver", "--fake", "1F,10", "--foreground")
+    end
+    sleep 1 # Potential timing bug when the system is under load
+    yield
+    Process.kill("KILL", pid)
+    Process.waitpid(pid)
+  end
+
+  def db_setup
+    @dbstore = SAAL::DBStore.new(TEST_DBCONF)
+    @dbstore.db_wipe
+    @dbstore.db_initialize
+  end
+
+  def db_test_query(query)  
+    db = Mysql.new(TEST_DBOPTS['host'],TEST_DBOPTS['user'],
+                   TEST_DBOPTS['pass'],TEST_DBOPTS['db'])
+    res = db.query(query)
+    yield res
+    db.close
+  end
+end

data/test/test_sensor_cleanups.yml

@@ -0,0 +1,21 @@
+fake:
+  name: "A fake temperature sensor"
+  max_value: 500
+  min_value: 100
+  onewire: 
+    serial: /10.4AEC29CDBAAB/temperature
+
+fake2:
+  name: "A fake temperature sensor"
+  max_value: 500
+  max_correctable: 550
+  min_value: 100
+  min_correctable: 50
+  onewire: 
+    serial: /10.4AEC29CDBAAB/temperature
+
+fake3:
+  name: "A fake temperature sensor"
+  onewire: 
+    serial: /10.4AEC29CDBAAB/temperature
+

data/test/test_sensors.yml

@@ -0,0 +1,10 @@
+fake_temp:
+  name: "A fake temperature sensor"
+  onewire: 
+    serial: /10.4AEC29CDBAAB/temperature
+
+non_existant:
+  name: "A non-existant sensor"
+  onewire: 
+    serial: /10.A00000000000/temperature
+

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification 
+name: saal
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
+platform: ruby
+authors: 
+- "Pedro C\xC3\xB4rte-Real"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-29 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ownet
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: |
+  A daemon and libraries to create an abstraction layer that interfaces with 
+  sensors and actuators, recording their state, responding to requests 
+  for current and historical values, and allowing changes of state.
+
+email: pedro@pedrocr.net
+executables: 
+- saal_readall
+- saal_dump_database
+- dinrelayset
+- dinrelaystatus
+- saal_import_mysql
+- saal_daemon
+- saal_chart
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- bin/.gitignore
+- bin/dinrelayset
+- bin/dinrelaystatus
+- bin/saal_chart
+- bin/saal_daemon
+- bin/saal_dump_database
+- bin/saal_import_mysql
+- bin/saal_readall
+- lib/chart_data.rb
+- lib/daemon.rb
+- lib/dbstore.rb
+- lib/dinrelay.rb
+- lib/outliercache.rb
+- lib/owsensor.rb
+- lib/saal.rb
+- lib/sensor.rb
+- lib/sensors.rb
+- saal.gemspec
+- test/chart_data_test.rb
+- test/daemon_test.rb
+- test/dbstore_test.rb
+- test/dinrelay.html.erb
+- test/dinrelay_test.rb
+- test/nonexistant_sensor.yml
+- test/outliercache_test.rb
+- test/sensor_test.rb
+- test/sensors_test.rb
+- test/test_db.yml
+- test/test_dinrelay_sensors.yml
+- test/test_helper.rb
+- test/test_sensor_cleanups.yml
+- test/test_sensors.yml
+has_rdoc: true
+homepage: https://github.com/pedrocr/saal
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- -S
+- -w 2
+- -N
+- -c utf8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: Thin abstraction layer for interfacing and recording sensors (currently onewire) and actuators (currently dinrelay)
+test_files: 
+- test/chart_data_test.rb
+- test/daemon_test.rb
+- test/dbstore_test.rb
+- test/dinrelay_test.rb
+- test/outliercache_test.rb
+- test/sensor_test.rb
+- test/sensors_test.rb
+- test/test_helper.rb