tem_multi_updater 0.1 → 0.2

data/CHANGELOG

@@ -1 +1,3 @@
+v0.2. Complete test coverage.
+
 v0.1. Initial release.

data/Manifest

@@ -6,3 +6,5 @@ Rakefile
 bin/tem_multi_update_fw
 lib/tem_multi_updater.rb
 lib/tem_multi_updater/updater.rb
+test/integration_test.rb
+test/updater_test.rb

data/Rakefile

@@ -19,6 +19,8 @@ Echoe.new('tem_multi_updater') do |p|
   p.dependencies = ['smartcard >=0.4.7',
                     'tem_multi_proxy >=0.2.5',
                     'tem_ruby >=0.12.0']
+  p.development_dependencies = ['echoe >=3.2',
+                                'flexmock >=0.8.6']
   
   p.need_tar_gz = !Gem.win_platform?
   p.need_zip = !Gem.win_platform?

data/lib/tem_multi_updater/updater.rb

@@ -29,11 +29,16 @@ class Updater
   def run
     return unless @pending.nil?
     
-    @logger.info "Querying #{@server_addr}"
+    @logger.info "Querying tem_multi_proxy at #{@server_addr}"
     @transport_configs = Tem::MultiProxy::Client.query_tems @server_addr
+    if @transport_configs.nil? || @transport_configs.empty?
+      @logger.error "No response from tem_multi_proxy at #{@server_addr}"
+      return false
+    end
     
     spawn_threads
     wait_for_threads
+    return true
   end
 
   # Spawns one updating thread for each smart-card transport configuration.
@@ -61,40 +66,57 @@ class Updater
   # Args:
   #   transport_config:: configuration for the TEM's smart-card transport 
   def update_thread(transport_config)
-    transport = Smartcard::Iso::AutoConfigurator.try_transport transport_config
-    if transport
-      @logger.info "Connected to #{transport.inspect}"
-      update_transport transport
-    else
-      @logger.warn "Failed connecting to #{transport_config.inspect}"
-    end
-    
-    @pending_mx.synchronize do
-      @pending -= 1
-      @pending_cv.signal
+    begin
+      transport = transport_for_config transport_config
+      if transport
+        @logger.info "Connected to #{transport.inspect}"
+        update_transport transport
+        transport.disconnect
+      else
+        @logger.warn "Failed connecting to #{transport_config.inspect}"
+      end
+    ensure    
+      @pending_mx.synchronize do
+        @pending -= 1
+        @pending_cv.signal
+      end
     end
   end
   
+  # Creates a ISO smart-card transport out of a configuration.
+  #
+  # Args:
+  #   transport_config:: configuration for the TEM's smart-card transport
+  #
+  # Returns a transport.
+  def transport_for_config(transport_config)
+    Smartcard::Iso::AutoConfigurator.try_transport transport_config    
+  end
+  
   # Installs or updates TEM firmware on a smart-card.
   # 
+  # No firmware will be uploaded if the smart-card already has the latest
+  # version of the TEM software.
+  #
   # Args:
   #   transport_config:: smart-card transport connecting to the TEM card
   #
-  # No firmware will be uploaded if the smart-card already has the latest
-  # version of the TEM software.
+  # Returns 
   def update_transport(transport)
     if !needs_update? transport
       @logger.info "No update needed at #{transport.inspect}"
-      return
+      return false
     end
     
     @logger.info "Uploading TEM firmware to #{transport.inspect}"
     begin
       Tem::Firmware::Uploader.upload_cap transport
+      return true
     rescue Exception => e
       @logger.error "Error while uploading TEM firmware to " +
                     "#{transport.inspect} - #{e.class.name}: #{e.message}"
       @logger.info e.backtrace.join("\n")
+      return false
     end
   end
 

data/tem_multi_updater.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tem_multi_updater}
-  s.version = "0.1"
+  s.version = "0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
@@ -12,13 +12,14 @@ Gem::Specification.new do |s|
   s.email = %q{victor@costan.us}
   s.executables = ["tem_multi_update_fw"]
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "bin/tem_multi_update_fw", "lib/tem_multi_updater.rb", "lib/tem_multi_updater/updater.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "bin/tem_multi_update_fw", "lib/tem_multi_updater.rb", "lib/tem_multi_updater/updater.rb", "tem_multi_updater.gemspec"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "bin/tem_multi_update_fw", "lib/tem_multi_updater.rb", "lib/tem_multi_updater/updater.rb", "test/integration_test.rb", "test/updater_test.rb", "tem_multi_updater.gemspec"]
   s.homepage = %q{http://tem.rubyforge.org}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Tem_multi_updater", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{tem}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Updates the firmware on all TEMs connected to a tem_multi_proxy.}
+  s.test_files = ["test/integration_test.rb", "test/updater_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -28,14 +29,20 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<smartcard>, [">= 0.4.7"])
       s.add_runtime_dependency(%q<tem_multi_proxy>, [">= 0.2.5"])
       s.add_runtime_dependency(%q<tem_ruby>, [">= 0.12.0"])
+      s.add_development_dependency(%q<echoe>, [">= 3.2"])
+      s.add_development_dependency(%q<flexmock>, [">= 0.8.6"])
     else
       s.add_dependency(%q<smartcard>, [">= 0.4.7"])
       s.add_dependency(%q<tem_multi_proxy>, [">= 0.2.5"])
       s.add_dependency(%q<tem_ruby>, [">= 0.12.0"])
+      s.add_dependency(%q<echoe>, [">= 3.2"])
+      s.add_dependency(%q<flexmock>, [">= 0.8.6"])
     end
   else
     s.add_dependency(%q<smartcard>, [">= 0.4.7"])
     s.add_dependency(%q<tem_multi_proxy>, [">= 0.2.5"])
     s.add_dependency(%q<tem_ruby>, [">= 0.12.0"])
+    s.add_dependency(%q<echoe>, [">= 3.2"])
+    s.add_dependency(%q<flexmock>, [">= 0.8.6"])
   end
 end

data/test/integration_test.rb

@@ -0,0 +1,52 @@
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Massachusetts Institute of Technology
+# License:: MIT
+
+require 'tem_multi_updater'
+
+require 'logger'
+require 'stringio'
+require 'test/unit'
+
+class IntegrationTest < Test::Unit::TestCase
+  def setup
+    super
+    @server_addr = 'localhost'
+    logger = Logger.new StringIO.new
+    @updater = Tem::MultiUpdater::Updater.new logger, @server_addr
+
+    @old_abort = Thread.abort_on_exception
+    Thread.abort_on_exception = true
+  end
+  
+  def teardown
+    Thread.abort_on_exception = @old_abort
+    super    
+  end
+  
+  def test_live
+    # Remove the TEM firmware from the first card to force an update.
+    transport_configs = Tem::MultiProxy::Client.query_tems @server_addr
+    assert transport_configs, "#{@server_addr} test proxy is not live"
+    assert !transport_configs.empty?, "#{@server_addr} test proxy has no cards"    
+    card = @updater.transport_for_config transport_configs[0]
+    assert card,
+           "Cannot connect to the first card on the #{@server_addr} test proxy"
+    class <<card; include Smartcard::Gp::GpCardMixin; end
+    card.delete_application Tem::Firmware::Uploader.applet_aid
+    card.disconnect
+    
+    # Run the whole update code against a live proxy.
+    assert_equal true, @updater.run,
+                 'Integration test needs a live tem_multi_proxy at localhost'
+    
+    # Check that the first card has the TEM firmware now.
+    card = @updater.transport_for_config transport_configs[0]
+    assert card, 'Transport error on the card whose TEM firmware was removed'
+    tem = Tem::Session.new card
+    assert_equal Tem::Firmware::Uploader.fw_version, tem.fw_version,
+                 'Incorrect TEM firmware version'
+    tem.disconnect
+    card.disconnect
+  end
+end

data/test/updater_test.rb

@@ -0,0 +1,106 @@
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Massachusetts Institute of Technology
+# License:: MIT
+
+require 'tem_multi_updater'
+
+require 'logger'
+require 'stringio'
+require 'test/unit'
+
+require 'rubygems'
+require 'flexmock/test_unit'
+
+class UpdaterTest < Test::Unit::TestCase
+  def setup
+    super
+    @server_addr = :server_addr
+    @updater = Tem::MultiUpdater::Updater.new Logger.new(StringIO.new),
+                                              @server_addr
+    @old_abort = Thread.abort_on_exception
+    Thread.abort_on_exception = true
+  end
+  
+  def teardown
+    Thread.abort_on_exception = @old_abort
+    super
+  end
+  
+  def test_dead_proxy
+    flexmock(Tem::MultiProxy::Client).should_receive(:query_tems).
+        with(@server_addr).and_return(nil)
+    assert_equal false, @updater.run
+  end
+  
+  def test_threading
+    flexmock(Tem::MultiProxy::Client).should_receive(:query_tems).
+        with(@server_addr).and_return([:transport1, :transport2, :transport3])
+    ['1', '2', '3'].each do |suffix|
+      tem = Object.new
+      flexmock(Smartcard::Iso::AutoConfigurator).should_receive(:try_transport).
+          with(:"transport#{suffix}").and_return(tem).once
+      flexmock(@updater).should_receive(:update_transport).once.
+          with(tem).and_return { Kernel.sleep 0.4 + 0.1 * suffix.to_i; true }          
+      flexmock(tem).should_receive(:disconnect).once
+    end        
+    
+    time0 = Time.now
+    assert_equal true, @updater.run, 'run return value'
+    assert_operator 0.9, :>, Time.now - time0, 'Updates happened in parallel'
+  end
+    
+  def test_update_transport
+    flexmock(@updater).should_receive(:needs_update?).with(:new_transport).
+                       and_return(false).once
+    flexmock(Tem::Firmware::Uploader).should_receive(:upload_cap).
+                                      with(:new_transport).never
+    assert_equal false, @updater.update_transport(:new_transport),
+                 'Up-to-date smartcard'
+
+    flexmock(@updater).should_receive(:needs_update?).with(:old_transport).
+                       and_return(true).once                                      
+    flexmock(Tem::Firmware::Uploader).should_receive(:upload_cap).
+                                      with(:old_transport).once
+    assert_equal true, @updater.update_transport(:old_transport),
+                 'Outdated smartcard'
+
+    flexmock(@updater).should_receive(:needs_update?).with(:err_transport).
+                       and_return(true).once                                      
+    flexmock(Tem::Firmware::Uploader).should_receive(:upload_cap).
+        with(:err_transport).once.
+        and_raise(Smartcard::Iso::ApduError, {:data => [], :status => 0x6A88})
+    assert_equal false, @updater.update_transport(:err_transport),
+                 'Flaly smartcard'
+  end
+  
+  def _test_needs_update(version, answer)
+    session = Object.new
+    if version.has_key? :status
+      flexmock(Tem::Session).should_receive(:new).
+          and_raise(Smartcard::Iso::ApduError, version).once
+    else
+      flexmock(Tem::Session).should_receive(:new).with(:transport).
+          and_return(session).once
+      flexmock(session).should_receive(:fw_version).and_return(version).once
+    end
+    
+    assert_equal answer, @updater.needs_update?(:transport), version.inspect 
+  end
+  
+  def test_needs_update
+    fw_version = Tem::Firmware::Uploader.fw_version
+    
+    [
+     [{:major => fw_version[:major] + 1, :minor => 0}, false],
+     [{:major => fw_version[:major] - 1, :minor => 256}, true],
+     [{:major => fw_version[:major], :minor => 0}, true],
+     [{:major => fw_version[:major], :minor => 256}, false],
+     [{:major => fw_version[:major], :minor => fw_version[:minor] - 1}, true],
+     [{:major => fw_version[:major], :minor => fw_version[:minor]}, false],
+     [{:major => fw_version[:major], :minor => fw_version[:minor] + 1}, false],
+     [{:data => [], :status => 0x6A88}, true],
+    ].each do |test_case|
+      _test_needs_update *test_case
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tem_multi_updater
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Victor Costan
@@ -42,6 +42,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.12.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.2"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.6
+    version: 
 description: Updates the firmware on all TEMs connected to a tem_multi_proxy.
 email: victor@costan.us
 executables: 
@@ -64,6 +84,8 @@ files:
 - bin/tem_multi_update_fw
 - lib/tem_multi_updater.rb
 - lib/tem_multi_updater/updater.rb
+- test/integration_test.rb
+- test/updater_test.rb
 - tem_multi_updater.gemspec
 has_rdoc: true
 homepage: http://tem.rubyforge.org
@@ -98,5 +120,6 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Updates the firmware on all TEMs connected to a tem_multi_proxy.
-test_files: []
-
+test_files: 
+- test/integration_test.rb
+- test/updater_test.rb