bewildr 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,107 +1,118 @@
 =bewildr
-Test WPF apps in (iron) ruby!
+Test WPF UI apps with (iron) ruby!
 
 Written by Nat Ritmeyer (http://www.natontesting.com)
 
 ==Intro
-<b>This is pre-alpha software - it has a way to go before being complete...</b>
-
 Documentation is on the way; until then, take a look at the tests or read the API overview below.
 
 ==Getting started
-===Installation
+===Dependencies
+1. Install .net 3 and 4 (http://www.microsoft.com/downloads/details.aspx?FamilyID=10cc340b-f857-4a14-83f5-25634c3bf043&displaylang=en & http://msdn.microsoft.com/en-us/netframework/aa569263.aspx)
+2. Install the latest ironruby (http://www.ironruby.net/), and for your own sanity install it in c:\\\\ironruby instead of the default location.
+3. You'll need at least rubygems version 1.3.6:
+  gem update --system
 
-Install the latest ironruby (http://www.ironruby.net/), and for your own sanity install it in c:\\\\ironruby instead of the default location.
-
-<tt>
-gem install bewildr
-</tt>
+===Installation
 
-You'll need at least rubygems version 1.3.6 (gem update --system)
+  gem install bewildr --no-rdoc --no-ri
 
-===API Overview
+To use bewildr:
 
-<b>Start an app</b>
+  require 'bewildr'
 
-<tt>@app = Bewildr::Application.start('notepad')</tt>
+==API Overview
+===Application Management
+Start an app
 
-<tt>@app = Bewildr::Application.start('c:/windows/notepad.exe')</tt>
+  @app = Bewildr::Application.start('notepad')
+  @app = Bewildr::Application.start('c:/windows/notepad.exe')
 
-<b>Start an app and wait for a particular window:</b>
+Start an app and wait for a particular window:
 
-<tt>@app, @window = Bewildr::Application.start_app_and_wait_for_window('notepad', 'Untitled - Notepad')</tt>
+  @app, @window = Bewildr::Application.start_app_and_wait_for_window('notepad', 'Untitled - Notepad')
 
 or (taking a regex for the window title instead of a string - tests become more robust):
 
-<tt>@app, @window = Bewildr::Application.start_app_and_wait_for_window('c:/windows/notepad.exe', /.* - Notepad/)</tt>
-
-<b>kill an app</b>
-
-
-<tt>@app.kill</tt>
+  @app, @window = Bewildr::Application.start_app_and_wait_for_window('c:/windows/notepad.exe', /.* - Notepad/)
 
-<tt>@app.running? == false</tt>
+Kill an app
 
-<tt>@app.should_not be_running</tt>
+  @app.kill
+  @app.running? == false
+  @app.should_not be_running
 
-<b>Get application windows:</b>
+===Window Management
+Get application windows:
 
 All windows belonging to an app:
 
-<tt>@all_windows_for_my_app = @app.get_windows</tt>
+  @all_windows_for_my_app = @app.windows
 
 Window with a particular name:
 
-<tt>@main_window = @app.get_window('My App 1.0')</tt>
+  @main_window = @app.window('My App 1.0')
 
 Window with a particular name (find window using regex instead of string):
 
-<tt>@main_window = @app.get_window(/My App .*/)</tt>
+  @main_window = @app.window(/My App .*/)
 
-<b>Find an element by its automation id:</b>
+===Basic Element Interaction
 
-<tt>my_button = @window.get(:id => 'my_button')</tt>
+Find an element by its automation id:
 
-<b>Find an element by its type:</b>
+  my_button = @window.get(:id => 'my_button')
 
-<tt>@all_buttons = @window.get(:type => :button)</tt>
+Find an element by its type:
 
-<b>Find an element by its name:</b>
+  @all_buttons = @window.get(:type => :button)
 
-<tt>my_button = @window.get(:name => 'Click Here')</tt>
+Find an element by its name:
 
-<b>Find an element by a combination of criteria:</b>
+  my_button = @window.get(:name => 'Click Here')
 
-<tt>@main_window.get(:type => :hyperlink, :name => "Link Text")</tt>
+Find an element by a combination of criteria:
 
-<b>Click a button:</b>
+  @main_window.get(:type => :hyperlink, :name => "Link Text")
 
-<tt>@window.get(:id => 'my_button').click</tt>
+Click a button:
 
-<b>Check for existence/enabled state of an element:</b>
+  @window.get(:id => 'my_button').click
 
-<tt>@window.get(:id => 'some_element').exists?</tt>
+===Element State
 
-<tt>@window.get(:id => 'some_element').enabled?</tt>
+Check for existence/enabled state of an element:
+
+  @window.get(:id => 'some_element').exists?
+  @window.get(:id => 'some_element').enabled?
 
 ...which allows for some nice idiomatic test code if you're using rspec:
 
-<tt>@window.get(:id => 'some_element').should_not exist</tt>
+  @window.get(:id => 'some_element').should_not exist
+  @window.get(:id => 'some_element').should be_enabled
+
+Wait for an element to exist:
+
+  @window.wait_for_existence_of(:id => "an_object")
+
+Wait for an element to disappear:
+
+  @window.wait_for_non_existence_of(:id => "an_object")
+
+The wait_for_existence_of method can be called recursively:
+
+  @window.wait_for_existence_of(:id => "an_object").wait_for_existence_of(:id => "child_object")
 
-<tt>@window.get(:id => 'some_element').should be_enabled</tt>
+The line above will result in waiting for 'an_object', and once it has appeared it'll wait for an
+object below it in the object hierarchy called 'child_object'.
 
 ==Background story
-I've recently been testing a WPF app using ironruby and the White automation library
-(see http://www.natontesting.com/2010/02/17/how-to-test-a-wpf-app-using-ironruby-and-white/
-for an example of my adventures). White proved to be buggy, painful and worst of all, slow.
-The whole time I was writing the framework and the tests, I wanted a replacement for white -
-something written in ruby, something that talked directly to MS Automation, something that
-had a simple architecture (trying to figure out what's going in in white is not trivial) and
-something that could be used to write idiomatic tests (using rspec matchers).
-
-Thus, Bewildr. "Scratch your own itch", and all that.
-
-Why 'bewildr'? Quite simply, I have been bewildrd for the whole journey. Bewildrd by white,
-bewildrd by Microsoft's automation architecture (which turns out, in fact, to be very well
-thought out - it just required a mind-shift, that's all) and bewildrd as a result of the
-recent late nights writing bewildr.
+I've recently being testing a WPF app. I wrote some classes to wrap the White automation library
+(http://white.codeplex.com/) using IronRuby to allow the WPF app tests to be written in ruby - the
+same language as the tests for the other systems. Due to some performance issues and a number of
+bugs, I ended up rewriting large chunks of the functionality of white by directly talking to the MS
+Automation API (http://msdn.microsoft.com/en-us/library/ms747327(v=VS.100).aspx). After a while it
+occured to me... "why not write a library from scratch that tests WPF apps, that's fast and allows
+for idiomatic tests due to a clean API?"
+
+Enter 'Bewildr'.

data/Rakefile

@@ -10,10 +10,10 @@ require 'cucumber/rake/task'
 
 spec = Gem::Specification.new do |s|
   s.name = 'bewildr'
-  s.version = '0.1.1'
+  s.version = '0.1.2'
   s.has_rdoc = true
   s.extra_rdoc_files = ['README.rdoc', 'LICENSE']
-  s.summary = 'Test your WPF apps with (iron) ruby!'
+  s.summary = 'Test WPF UI apps with (iron) ruby!'
   s.description = s.summary
   s.author = 'Nat Ritmeyer'
   s.email = 'nat@natontesting.com'
@@ -48,5 +48,5 @@ Spec::Rake::SpecTask.new do |t|
 end
 
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format pretty --no-color"
+  t.cucumber_opts = "features --format pretty --no-color -q"
 end

data/lib/bewildr.rb

@@ -10,6 +10,7 @@ raise LoadError, "Bewildr only works under IronRuby" unless RUBY_ENGINE == "iron
 load_assembly 'UIAutomationClient, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35'
 load_assembly 'UIAutomationTypes, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35'
 load_assembly 'System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089'
+load_assembly 'System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089'
 
 #require BewildrClickr - stopgap until the ffi gem works under ironruby
 require File.join(File.expand_path(File.dirname(__FILE__)), "bewildr", "ext", "BewildrClickr.dll")
@@ -37,6 +38,7 @@ require 'bewildr/control_patterns/selection_item_pattern'
 require 'bewildr/control_patterns/range_value_pattern'
 require 'bewildr/control_patterns/grid_pattern'
 require 'bewildr/control_patterns/table_pattern'
+require 'bewildr/control_patterns/text_pattern'
 
 require 'bewildr/control_type_additions/text_additions'
 require 'bewildr/control_type_additions/combo_box_additions'
@@ -47,4 +49,5 @@ require 'bewildr/control_type_additions/tab_additions'
 require 'bewildr/control_type_additions/list_additions'
 require 'bewildr/control_type_additions/tree_additions'
 require 'bewildr/control_type_additions/tree_item_additions'
-require 'bewildr/control_type_additions/data_grid_additions'
+require 'bewildr/control_type_additions/data_grid_additions'
+require 'bewildr/control_type_additions/document_additions'

data/lib/bewildr/application.rb

@@ -10,9 +10,9 @@ module Bewildr
     private :initialize
 
     def kill
-      @proc.kill
+      `taskkill /f /t /pid #{@proc_id}`
       Timeout::timeout(5) do
-        sleep 0.1 until @proc.has_exited
+        sleep 0.1 while running?
       end
     end
 
@@ -26,41 +26,37 @@ module Bewildr
       end
     end
 
-    def get_windows
+    def windows
       Bewildr::Windows.windows_by_process_id(@proc_id)
     end
 
-    def get_window_by_name(input)
+    def window_by_name(input)
       case input
-      when String then return get_windows.select{|window| window.name.strip == input.strip}.first
-      when Regexp then return get_windows.select{|window| input.match(window.name.strip).nil? == false}.first
+      when String then return windows.select{|window| window.name.strip == input.strip}.first
+      when Regexp then return windows.select{|window| input.match(window.name.strip).nil? == false}.first
       else
         raise ArgumentError, "input not a string or regexp but a #{input.class}"
       end
     end
-    alias :get_window :get_window_by_name
+    alias :window :window_by_name
 
     def wait_for_window(input, wait_time = 30)
       begin
-      Timeout::timeout(wait_time) do
-        begin
-          my_window = get_window(input)
-          raise if my_window.nil?
-          return my_window
-        rescue
-          sleep 0.2
-          retry
+        Timeout::timeout(wait_time) do
+          begin
+            my_window = window(input)
+            raise if my_window.nil?
+            return my_window
+          rescue
+            sleep 0.2
+            retry
+          end
         end
-      end
       rescue Timeout::Error
         raise ElementDoesntExist
       end
     end
 
-    def window_count
-      get_windows.size
-    end
-
     #takes name or full path of exe to start
     def self.start(process_name)
       Bewildr::Application.new(System::Diagnostics::Process.start(process_name))
@@ -78,6 +74,18 @@ module Bewildr
       Bewildr::Application.new(process)
     end
 
+    def self.attach_or_launch(path_to_exe)
+      #if app is already open attach to it
+      potential_process_name = File.basename(path_to_exe, ".exe")
+      if Bewildr::Application.processes_with_name(potential_process_name).size > 0
+        #app is running, attach to it
+        Bewildr::Application.attach_to_process_name(potential_process_name)
+      else
+        #app is not running, start a new instance
+        Bewildr::Application.start(path_to_exe)
+      end
+    end
+
     def self.start_app_and_wait_for_window(path, window_name)
       app = Bewildr::Application.start(path)
       window = app.wait_for_window(window_name)
@@ -85,11 +93,19 @@ module Bewildr
     end
 
     def self.kill_all_processes_with_name(input)
-      System::Diagnostics::Process.get_processes_by_name(input).each {|p| p.kill}
+      System::Diagnostics::Process.get_processes_by_name(input).each do |p|
+        p.kill
+        p.wait_for_exit
+      end
     end
 
     def self.processes_with_name(input)
       System::Diagnostics::Process.get_processes_by_name(input).collect {|p| Bewildr::Application.attach_to_process(p) }
     end
+
+    def self.wait_for_process_with_name(input)
+      Timeout.timeout(30) {sleep 0.1 until System::Diagnostics::Process.get_processes_by_name(input).size > 0}
+      self.attach_to_process_name(input)
+    end
   end
 end

data/lib/bewildr/control_patterns/range_value_pattern.rb

@@ -7,6 +7,10 @@ module Bewildr
         @automation_element.get_current_pattern(System::Windows::Automation::RangeValuePattern.pattern).current.value
       end
 
+      def value=(input)
+        @automation_element.get_current_pattern(System::Windows::Automation::RangeValuePattern.pattern).set_value(input.to_f)
+      end
+
       def maximum
         @automation_element.get_current_pattern(System::Windows::Automation::RangeValuePattern.pattern).current.maximum
       end

data/lib/bewildr/control_patterns/selection_pattern.rb

@@ -18,10 +18,7 @@ module Bewildr
       end
 
       def selected
-        case can_select_multiple?
-        when true then get_selection
-        when false then get_selection.first
-        end
+        can_select_multiple? ? get_selection : get_selection.first
       end
     end
   end

data/lib/bewildr/control_patterns/text_pattern.rb

@@ -0,0 +1,15 @@
+#Copyright (c) 2010, Nathaniel Ritmeyer. All rights reserved.s
+
+module Bewildr
+  module ControlPatterns
+    module TextPattern
+      def select_all
+        @automation_element.get_current_pattern(System::Windows::Automation::TextPattern.pattern).document_range.select
+      end
+
+      def get_text
+        @automation_element.get_current_pattern(System::Windows::Automation::TextPattern.pattern).document_range.get_text(-1)
+      end
+    end
+  end
+end

data/lib/bewildr/control_patterns/toggle_pattern.rb

@@ -24,6 +24,10 @@ module Bewildr
               state == :off
             end
 
+            def indeterminate?
+              state == :indeterminate
+            end
+
             def checked_state
               state
             end

data/lib/bewildr/control_type_additions/document_additions.rb

@@ -0,0 +1,24 @@
+#Copyright (c) 2010, Nathaniel Ritmeyer. All rights reserved.
+
+module Bewildr
+  module ControlTypeAdditions
+    module DocumentAdditions
+      def self.extended(base)
+        base.extend Bewildr::ControlPatterns::TextPattern
+
+        base.instance_eval do
+          def text
+            get_text
+          end
+
+          def text=(input)
+            focus
+            select_all
+            System::Windows::Forms::SendKeys.send_wait("{DEL}")
+            System::Windows::Forms::SendKeys.send_wait(input)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bewildr/control_type_additions/list_additions.rb

@@ -11,6 +11,45 @@ module Bewildr
             selectable_elements = get(:type => :list_item, :scope => :children)
             selectable_elements.find {|selectable_element| selectable_element.name == input}.select
           end
+
+          def items
+            my_list_items = list_items
+            return nil if my_list_items.nil?
+            my_list_items.collect {|item| item.name}
+          end
+
+          def list_items
+            bewildr_list_items = get(:type => :list_item, :scope => :children)
+            bewildr_list_items.nil? ? nil : bewildr_list_items
+          end
+
+          def count
+            my_items = items
+            my_items.nil? ? 0 : my_items.size
+          end
+
+          def select(input)
+            case input
+            when String then select_by_name(input)
+            when Integer then select_by_index(input)
+            else raise ArgumentError, "Select by name or by index"
+            end
+          end
+
+          def select_by_name(input)
+            my_item = list_items.find {|item| item.name == input}
+            raise NoSuchItemInListBox if my_item.nil?
+            my_item.select
+          end
+
+          def select_by_index(input)
+            raise "Index must be 0 or greater" if input < 0
+            my_item = list_items[input].select
+          end
+
+          def selected
+            get_selection.first.name
+          end
         end
       end
     end

data/lib/bewildr/control_type_additions/menu_additions.rb

@@ -12,6 +12,10 @@ module Bewildr
           def root_menu_items
             get(:type =>:menu_item, :scope => :children)
           end
+
+          def root_menu_item_names
+            root_menu_items.collect {|menu_item| menu_item.name}
+          end
           
           def select_menu(path)
              menu_item(path).click

data/lib/bewildr/control_type_additions/tab_additions.rb

@@ -8,9 +8,22 @@ module Bewildr
 
         base.instance_eval do
           def select(input)
-            selectable_elements = get(:type => :tab_item, :scope => :children)
+            raise NoSuchTab unless tab_names.include?(input)
+            selectable_elements = tabs
             selectable_elements.find {|selectable_element| selectable_element.name == input}.select
           end
+
+          def tabs
+            get(:type => :tab_item, :scope => :children)
+          end
+
+          def tab_names
+            tabs.collect {|tab| tab.name}
+          end
+
+          def selected
+            tabs.find {|tab| tab.selected?}
+          end
         end
       end
     end

data/lib/bewildr/control_type_additions/tree_item_additions.rb

@@ -11,6 +11,18 @@ module Bewildr
           def child_nodes
             get(:type => :tree_item, :scope => :children)
           end
+
+          #horrible, but necessary - clickable point for tree items doesn't work like you think it would...
+          #I've added 7 to y and 22 to x... that's working for now... this is hardly the ideal solution...
+          #To see what's going on with the following code, take a look at a tree node under uispy - you'll
+          #understand - a picture paints a thousand words and all that.
+          def clickable_point
+            existence_check
+            ae_top_left_point = @automation_element.current.bounding_rectangle.top_left
+            ae_top_left_point.x += 22
+            ae_top_left_point.y += 7
+            ae_top_left_point
+          end
         end
       end
     end

data/lib/bewildr/element.rb

@@ -65,6 +65,10 @@ module Bewildr
       end
     end
 
+    def focus
+      @automation_element.set_focus
+    end
+
     #:id => "id"
     #:name => "bob"
     #:type => :button
@@ -133,6 +137,7 @@ module Bewildr
         extend Bewildr::ControlTypeAdditions::DataGridAdditions
       when :data_item
       when :document
+        extend Bewildr::ControlTypeAdditions::DocumentAdditions
       when :edit
         extend Bewildr::ControlPatterns::ValuePattern
       when :group
@@ -158,6 +163,7 @@ module Bewildr
       when :scroll_bar
       when :seperator
       when :slider
+        extend Bewildr::ControlPatterns::RangeValuePattern
       when :spinner
       when :split_button
       when :status_bar

data/lib/bewildr/exceptions.rb

@@ -4,5 +4,7 @@ class ElementNotEnabled < StandardError; end
 class ElementDoesntExist < StandardError; end
 class PasswordFieldReadAttempt < StandardError; end
 class NoSuchItemInComboBox < StandardError; end
+class NoSuchItemInListBox < StandardError; end
+class NoSuchTab < StandardError; end
 
 class BewildrInternalError < StandardError; end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bewildr
 version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Nat Ritmeyer
@@ -14,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 +01:00
+date: 2010-06-07 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: Test your WPF apps with (iron) ruby!
+description: Test WPF UI apps with (iron) ruby!
 email: nat@natontesting.com
 executables: []
 
@@ -40,12 +41,14 @@ files:
 - lib/bewildr/control_patterns/selection_item_pattern.rb
 - lib/bewildr/control_patterns/selection_pattern.rb
 - lib/bewildr/control_patterns/table_pattern.rb
+- lib/bewildr/control_patterns/text_pattern.rb
 - lib/bewildr/control_patterns/toggle_pattern.rb
 - lib/bewildr/control_patterns/value_pattern.rb
 - lib/bewildr/control_patterns/window_pattern.rb
 - lib/bewildr/control_type.rb
 - lib/bewildr/control_type_additions/combo_box_additions.rb
 - lib/bewildr/control_type_additions/data_grid_additions.rb
+- lib/bewildr/control_type_additions/document_additions.rb
 - lib/bewildr/control_type_additions/list_additions.rb
 - lib/bewildr/control_type_additions/menu_additions.rb
 - lib/bewildr/control_type_additions/menu_item_additions.rb
@@ -70,25 +73,29 @@ rdoc_options: []
 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.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Test your WPF apps with (iron) ruby!
+summary: Test WPF UI apps with (iron) ruby!
 test_files: []