sprout-flashplayer-bundle 9.115.9 → 9.115.11

data/lib/sprout/flashplayer/version.rb

@@ -3,7 +3,7 @@ module Sprout
     module VERSION #:nodoc:
       MAJOR = 9
       MINOR = 115
-      TINY  = 9
+      TINY  = 11
 
       STRING = [MAJOR, MINOR, TINY].join('.')
       MAJOR_MINOR = [MAJOR, MINOR].join('.')

data/lib/sprout/tasks/flashplayer_task.rb

@@ -25,7 +25,13 @@ module Sprout
   
   class FlashPlayerError < StandardError #:nodoc:
   end
-
+  
+  # This exception will be raised when the FlashPlayerTask has encountered
+  # a test_result_pre_delimiter and subsequently a well-formatted JUnit
+  # XML result test failure
+  class AssertionFailure < StandardError
+  end
+  
   # The FlashPlayerTask will download, unpack, configure and launch the debug 
   # Flash Player for OS X, Windows and Linux.
   # 
@@ -40,58 +46,36 @@ module Sprout
   #     t.swf = 'bin/SomeProject.swf'
   #   end
   #
-  # You can also send the FlashPlayerTask a variety of additional parameters including which 
-  # version of the FlashPlayer to download (only 9.115.x is supported at the time of this writing).
-  #
   class FlashPlayerTask < Rake::Task
-    DEFAULT_VERSION = nil
-    EXECUTABLE_NAME = 'sprout-flashplayer-tool'
-    
+    # This is the opening prelude to a collection of test results. When the
+    # task encounters this string in the trace output log file, it will begin
+    # collecting trace statements with the expectation that the following
+    # strings will be well-formatted XML data matching what JUnit emits for 
+    # Cruise Control.
+    #
+    # See the lib/asunit3/asunit.framework.XMLResultPrinter for more information.
     @@test_result_pre_delimiter = '<XMLResultPrinter>'
+
+    # This is the closing string that will indicate the end of test result XML data
     @@test_result_post_delimiter = '</XMLResultPrinter>'
+
     @@home = nil
     @@trust = nil
 
-    attr_accessor :version,
-                  :name
-
-    attr_writer   :swf,
-                  :test_result_file
+    def initialize(task_name, app)
+      super(task_name, app)
+      @default_gem_name = 'sprout-flashplayer-tool'
+      @default_result_file = 'AsUnitResults.xml'
+      @inside_test_result = false
+    end
 
     def self.define_task(args, &block)
       t = super
       yield t if block_given?
       t.define
     end
-
-    def initialize_task
-    end
     
-    def swf
-      @swf ||= nil
-      if(@swf.nil?)
-        prerequisites.each do |req|
-          if(req.index('.swf'))
-            @swf = req.to_s
-            break
-          end
-        end
-      end
-      return @swf
-    end
-
-    def define
-      CLEAN.add(test_result_file)
-    end
-    
-    def test_result_file
-      @test_result_file ||= 'AsUnitResults.xml'
-    end
-    
-    def test_result
-      @test_result ||= ''
-    end
-
+    # Local system path to the Flash Player Trust file
     def FlashPlayerTask.trust
       if(@@trust)
         return @@trust
@@ -100,6 +84,7 @@ module Sprout
       return @@trust
     end
 
+    # Local system path to where the Flash Player stores trace output logs and trust files
     def FlashPlayerTask.home
       if(@@home)
         return @@home
@@ -117,7 +102,7 @@ module Sprout
       return @@home
     end
 
-    # Enumerate the potential locations of the Flash Player Home
+    # Collection of the potential locations of the Flash Player Home
     # For each supported Platform, the first existing location
     # will be used.
     def FlashPlayerTask.home_paths
@@ -127,10 +112,97 @@ module Sprout
               File.join(User.home, '.macromedia', 'Flash_Player')]
     end
 
-    def initialize(task_name, app)
-      super(task_name, app)
-      @version = DEFAULT_VERSION
-      @inside_test_result = false
+    # The swf parameter can be set explicitly in the block sent to this task as in:
+    #   
+    #   flashplayer :run do |t|
+    #     t.swf = 'bin/SomeProject.swf'
+    #   end
+    #
+    # Or it can be set implicitly as a rake prerequisite as follows:
+    #
+    #   flashplayer :run => 'bin/SomeProject' do |t|
+    #   end
+    #
+    def swf(swf)
+      @swf = swf
+    end
+
+    def swf
+      @swf ||= nil
+      if(@swf.nil?)
+        prerequisites.each do |req|
+          if(req.index('.swf'))
+            @swf = req.to_s
+            break
+          end
+        end
+      end
+      return @swf
+    end
+
+    # By default, the Flash Player should be given focus after being launched. Unfortunately,
+    # this doesn't work properly on OS X, so we needed to do some hackery in order to make it
+    # happen. This in turn can lead to multiple instances of the Player being instantiated.
+    # In the case of running a test harness, this is absolutely not desirable, so we had
+    # expose a parameter that allows us to prevent auto-focus of the player.
+    def do_not_focus=(focus)
+      @do_not_focus = focus
+    end
+    
+    def do_not_focus
+      @do_not_focus ||= nil
+    end
+
+    # The gem version of the sprout-flashplayer-tool RubyGem to download. 
+    #
+    # It's important to note that this version number
+    # will differ slightly from the actual player version in that the final revision 
+    # (the last of three numbers), is the gem version, while the first two describe the player
+    # version being downloaded.
+    # The exact gem version that you would like the ToolTask to execute. By default this value
+    # should be nil and will download the latest version of the gem that is available unless
+    # there is a version already installed on your system. 
+    # 
+    # This attribute could be an easy
+    # way to update your local gem to the latest version without leaving your build file,
+    # but it's primary purpose is to allow you to specify very specific versions of the tools
+    # that your project depends on. This way your team can rest assured that they are all
+    # working with the same tools.
+    def gem_version=(version)
+      @gem_version = version
+    end
+    
+    def gem_version
+      return @gem_version ||= nil
+    end
+    
+    # Full name of the sprout tool gem that this tool task will use. 
+    # This defaults to sprout-flashplayer-tool
+    def gem_name=(name)
+      @gem_name = name
+    end
+
+    def gem_name
+      return @gem_name ||= @default_gem_name
+    end
+    
+    # The File where JUnit test results should be written. This value
+    # defaults to 'AsUnitResults.xml'
+    #
+    def test_result_file=(file)
+      @test_result_file = file
+    end
+
+    def test_result_file
+      @test_result_file ||= @default_result_file
+    end
+    
+    def test_result
+      @test_result ||= ''
+    end
+
+    def define # :nodoc:
+      CLEAN.add(test_result_file)
     end
 
     def execute(*args)
@@ -157,7 +229,7 @@ module Sprout
       end
 
       @running_process = nil
-      @thread = run(EXECUTABLE_NAME, version, swf)
+      @thread = run(gem_name, gem_version, swf)
       read_log(@thread, log_file)
       @thread.join
     end
@@ -170,8 +242,8 @@ module Sprout
       end
     end
 
-    def run(tool, version, swf)
-      path_to_exe = Sprout.get_executable(tool, nil, version)
+    def run(tool, gem_version, swf)
+      path_to_exe = Sprout.get_executable(tool, nil, gem_version)
       target = User.clean_path(path_to_exe)
       @player_pid = nil
       
@@ -192,6 +264,7 @@ module Sprout
     end
     
     def focus_player_on_mac(out, exe)
+      return if do_not_focus
       begin
         if(User.new.is_a?(OSXUser))
           require 'appscript'
@@ -227,7 +300,7 @@ module Sprout
         end
       end
     end
-      
+
     # Returns true if inside of a test result
     def parse_test_result(line, thread)
       if(@inside_test_result)
@@ -235,6 +308,7 @@ module Sprout
           @inside_test_result = false
           write_test_result(test_result)
           close
+          examine_test_result test_result
           return true
         else
           test_result << line
@@ -254,6 +328,35 @@ module Sprout
         f.puts(result)
       end
     end
+
+    def examine_test_result(result)
+      require 'rexml/document'
+      doc = nil
+      begin
+        doc = REXML::Document.new(result)
+      rescue REXML::ParseException => e
+        puts "[WARNING] Invalid test results encountered"
+        return
+      end
+      
+      # Handle JUnit Failures
+      failures = []
+
+      doc.elements.each('/testsuites/testsuite/testsuite/testcase/error') do |element|
+        failures << element.text
+      end
+
+      doc.elements.each("/testsuites/testsuite/testsuite/testcase/failure") do |element|
+        failures << element.text
+      end
+
+      if(failures.size > 0)
+        raise AssertionFailure.new("Test Failures Encountered #{failures.join("\n")}")
+      end
+
+    end
+
+
   end
 
   ##########################################

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sprout-flashplayer-bundle
 version: !ruby/object:Gem::Version 
-  version: 9.115.9
+  version: 9.115.11
 platform: ruby
 authors: 
 - Pattern Park
@@ -9,7 +9,7 @@ autorequire: sprout/flashplayer
 bindir: bin
 cert_chain: []
 
-date: 2008-02-17 00:00:00 -08:00
+date: 2008-02-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency