rautomation 0.6.3 → 0.7.0

data/lib/rautomation/element_collections.rb

@@ -1,6 +1,9 @@
 module RAutomation
   # @private
   module ElementCollections
+    class UnsupportedLocatorException < RuntimeError
+    end
+
     # Creates collection classes and methods for elements.
     # @param [Array<Symbol>] elements for which to create collection classes
     #   and methods.
@@ -15,6 +18,11 @@ module RAutomation
               include Enumerable
 
               def initialize(window, locators)
+               if locators[:hwnd] || locators[:pid]
+                raise UnsupportedLocatorException, 
+                  ":hwnd or :pid in " + locators.inspect + " are not supported for #{adapter_class}::#{class_name_plural}"
+                end
+
                 @window = window
                 @locators = locators
               end
@@ -38,7 +46,7 @@ module RAutomation
 
         class_eval %Q{
             def #{element}(locators = {})
-              #{class_name_plural}.new(@window, locators)
+              #{adapter_class}::#{class_name_plural}.new(@window || self, locators)
             end
         }
       end

data/lib/rautomation/window.rb

@@ -15,12 +15,13 @@ module RAutomation
     has_many :windows, :buttons, :text_fields
 
     class << self
+      # @param locators (see #initialize)
       # @return [Windows] all windows. 
-      def windows
-        Windows.new(nil, {})
+      def windows(locators = {})
+        Windows.new(nil, locators)
       end
     end
-    
+
     # Retrieves all windows with similar locators to the current window.
     # @param locators (see #initialize) 
     # @return [Windows] all windows matching current window's _locators_ if no
@@ -63,7 +64,7 @@ module RAutomation
     # @param [Hash] locators locators for the window.
     def initialize(locators)
       @adapter = locators.delete(:adapter) || ENV["RAUTOMATION_ADAPTER"] && ENV["RAUTOMATION_ADAPTER"].to_sym || default_adapter
-      @window = Adapter.const_get(normalize(@adapter)).const_get(:Window).new(locators)
+      @window = Adapter.const_get(normalize(@adapter)).const_get(:Window).new(self, locators)
     end
 
     class << self
@@ -105,6 +106,13 @@ module RAutomation
       @window.title
     end
 
+    # @return [Array<String>] all {Window} class names in a sorted array.
+    # @raise [UnknownWindowException] if the window doesn't exist.
+    def class_names
+      wait_until_present
+      @window.class_names
+    end
+
     # Activates the Window, e.g. brings it to the top of other windows.
     def activate
       @window.activate
@@ -179,7 +187,7 @@ module RAutomation
 
     # Sends keyboard keys to the window. Refer to specific {Adapter} documentation for all possible values.
     # @raise [UnknownWindowException] if the window doesn't exist.
-    def send_keys(keys)
+    def send_keys(*keys)
       wait_until_present
       @window.send_keys(keys)
     end
@@ -194,7 +202,7 @@ module RAutomation
     # @note Refer to specific {Adapter} documentation for possible _locator_ parameters.
     # @param [Hash] locators for the {Button}.
     # @raise [UnknownWindowException] if the window doesn't exist.
-    def button(locators)
+    def button(locators={})
       wait_until_present
       Button.new(@window, locators)
     end
@@ -202,7 +210,7 @@ module RAutomation
     # Retrieves {TextField} on the window.
     # @note Refer to specific {Adapter} documentation for possible _locators_ parameters.
     # @raise [UnknownWindowException] if the window doesn't exist.
-    def text_field(locators)
+    def text_field(locators={})
       wait_until_present
       TextField.new(@window, locators)
     end
@@ -212,8 +220,6 @@ module RAutomation
       @window.send(name, *args)
     end
 
-    private
-
     def wait_until_present
       WaitHelper.wait_until {present?}
     rescue WaitHelper::TimeoutError
@@ -226,6 +232,8 @@ module RAutomation
       raise UnknownWindowException, "Window with locator #{@window.locators.inspect} doesn't exist!"
     end
 
+    private
+
     def normalize adapter
       adapter.to_s.split("_").map {|word| word.capitalize}.join
     end

data/rautomation.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{rautomation}
+  s.version = File.read("VERSION").strip
+  s.authors = [%q{Jarmo Pertman}]
+  s.email = %q{jarmo.p@gmail.com}
+  s.description = %q{RAutomation is a small and easy to use library for helping out to automate windows and their controls
+for automated testing.
+
+RAutomation provides:
+* Easy to use and user-friendly API (inspired by Watir http://www.watir.com)
+* Cross-platform compatibility
+* Easy extensibility - with small scripting effort it's possible to add support for not yet
+  supported platforms or technologies}
+  s.homepage = %q{http://github.com/jarmo/RAutomation}
+  s.summary = %q{Automate windows and their controls through user-friendly API with Ruby}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]  
+
+  s.add_development_dependency("rspec", "~>2.3")
+end
+

data/spec/adapter/autoit/window_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+describe "AutoIt::Window", :if => SpecHelper.adapter == :autoit do
+
+  it "mouse clicking" do
+    window = RAutomation::Window.new(:title => "MainFormWindow")
+
+    popup = RAutomation::Window.new(:title => "About")
+    popup.exist?.should == false
+
+    window.maximize
+    window.move_mouse(60, 45)
+    window.click_mouse
+
+    sleep 0.1
+
+    popup = RAutomation::Window.new(:title => "About")
+    popup.exist?.should == true
+  end
+
+  it "mouse position" do
+    window = RAutomation::Window.new(:title => "MainFormWindow")
+
+    window.move_mouse(1, 1)
+    window.mouse_position.should_not == [100, 100]
+
+    window.move_mouse(100, 100)
+    window.mouse_position.should == [100, 100]
+  end
+
+  it "mouse press/release" do
+    window = RAutomation::Window.new(:title => "MainFormWindow")
+    window.maximize
+
+    text_field = window.text_field(:name => "textField")
+    text_field.set("start string")
+    text_field.value.should == "start string"
+
+    window.move_mouse(146, 103)
+    window.press_mouse
+    window.move_mouse(194, 103)
+    window.release_mouse
+
+    window.send_keys("^c")
+
+    text_field.set("new string")
+    text_field.value.should == "new string"
+
+    window.move_mouse(146, 103)
+    window.press_mouse
+    window.move_mouse(194, 103)
+    window.release_mouse
+    window.send_keys("^v")
+
+    text_field.value.should == "start string"
+  end
+
+  it "#method_missing" do
+    window = RAutomation::Window.new(:title => "MainFormWindow")
+
+    window.MouseMove(1, 1)
+    position = [window.MouseGetPosX, window.MouseGetPosY]
+    position.should_not == [100, 100]
+
+    window.MouseMove(100, 100)
+    position = [window.MouseGetPosX, window.MouseGetPosY]
+
+    position.should == [100, 100]
+  end
+end
+

data/spec/adapter/{win_ffi → ms_uia}/button_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "WinFfi::Button", :if => SpecHelper.adapter == :win_ffi do
+describe "MsUia::Button", :if => SpecHelper.adapter == :ms_uia do
   it "find by id" do
     window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
     window.button(:id => "aboutButton").should exist

data/spec/adapter/{win_ffi → ms_uia}/checkbox_spec.rb

@@ -1,16 +1,17 @@
 require 'spec_helper'
 
-describe "WinFfi::Checkbox", :if => SpecHelper.adapter == :win_ffi do
+describe "MsUia::Checkbox", :if => SpecHelper.adapter == :ms_uia do
   it "#checkbox" do
     RAutomation::Window.new(:title => "MainFormWindow").checkbox(:value => "checkBox").should exist
 
     RAutomation::Window.wait_timeout = 0.1
-    expect {RAutomation::Window.new(:title => "non-existing-window").checkbox(:value => "Something")}.
-      to raise_exception(RAutomation::UnknownWindowException)
+    expect { RAutomation::Window.new(:title => "non-existing-window").checkbox(:value => "Something") }.
+        to raise_exception(RAutomation::UnknownWindowException)
   end
 
   it "check for checkbox class" do
     RAutomation::Window.new(:title => "MainFormWindow").checkbox(:id => "textField").should_not exist
+    RAutomation::Window.new(:title => "MainFormWindow").checkbox(:id => "checkBox").should exist
   end
 
 
@@ -22,6 +23,11 @@ describe "WinFfi::Checkbox", :if => SpecHelper.adapter == :win_ffi do
     checkbox.should be_set
   end
 
+  it "#value" do
+    checkbox = RAutomation::Window.new(:title => "MainFormWindow").checkbox(:id => "checkBox")
+    checkbox.value.should == "checkBox"
+  end
+
   it "#clear" do
     checkbox = RAutomation::Window.new(:title => "MainFormWindow").checkbox(:value => "checkBox")
     checkbox.set

data/spec/adapter/ms_uia/control_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+
+describe "MsUia::Control", :if => SpecHelper.adapter == :ms_uia do
+
+  it "control coordinates", :special => false do
+    window = RAutomation::Window.new(:title => /MainFormWindow/i)
+
+    window.maximize
+    control = window.control(:id => "radioButtonReset")
+    control.bounding_rectangle.should be_all {|coord| coord.between?(200, 400)}
+  end
+
+   it "control process id", :special => true do
+    window = RAutomation::Window.new(:title => /MainFormWindow/i)
+
+    control = window.control(:id => "radioButtonReset")
+    control.new_pid.should == @pid1
+   end
+
+  it "has a class" do
+    window = RAutomation::Window.new(:title => /MainFormWindow/i)
+
+    control = window.control(:id => "radioButtonReset")
+    control.control_class.should =~ /WindowsForms10.BUTTON.app.0.2bf8098_r1[0-9]_ad1/
+  end
+
+end

data/spec/adapter/ms_uia/keystroke_converter_spec.rb

@@ -0,0 +1,50 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rautomation'
+require 'rspec'
+
+describe "KeystrokeConverter", :if => SpecHelper.adapter == :ms_uia do
+
+  it "converts plain ASCII" do
+    codes = RAutomation::Adapter::MsUia::KeystrokeConverter.convert("abc")
+    converted_keys = convert_keys "abc"
+    codes.should == converted_keys
+  end
+
+  it "uses caps lock for entering downcase keys" do
+    codes = RAutomation::Adapter::MsUia::KeystrokeConverter.convert("aBc")
+    converted_keys = convert_keys "abc"
+    converted_keys = converted_keys.insert(1, RAutomation::Adapter::MsUia::Constants::VK_LSHIFT)
+    codes.should == converted_keys
+  end
+
+  it "converts special keys" do
+    codes = RAutomation::Adapter::MsUia::KeystrokeConverter.convert("{tab}a{backspace}b{enter}c {left}d{right}ee{down}f{up}g{unsupported}{home}{end}{delete}")
+    expected_codes = [
+        RAutomation::Adapter::MsUia::Constants::VK_TAB,
+        convert_keys("a"),
+        RAutomation::Adapter::MsUia::Constants::VK_BACK,
+        convert_keys("b"),
+        RAutomation::Adapter::MsUia::Constants::VK_RETURN,
+        convert_keys("c"),
+        RAutomation::Adapter::MsUia::Constants::VK_SPACE,
+        RAutomation::Adapter::MsUia::Constants::VK_LEFT,
+        convert_keys("d"),
+        RAutomation::Adapter::MsUia::Constants::VK_RIGHT,
+        convert_keys("ee"),
+        RAutomation::Adapter::MsUia::Constants::VK_DOWN,
+        convert_keys("f"),
+        RAutomation::Adapter::MsUia::Constants::VK_UP,
+        convert_keys("g"),
+        convert_keys("unsupported"),
+        RAutomation::Adapter::MsUia::Constants::VK_HOME,
+        RAutomation::Adapter::MsUia::Constants::VK_END,
+        RAutomation::Adapter::MsUia::Constants::VK_DELETE
+    ].flatten
+    codes.should == expected_codes
+  end
+
+  def convert_keys keys
+    keys.split("").map { |k| k.upcase.unpack("c")[0] }
+  end
+
+end

data/spec/adapter/{win_ffi → ms_uia}/label_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "WinFfi::Label", :if => SpecHelper.adapter == :win_ffi do
+describe "MsUia::Label", :if => SpecHelper.adapter == :ms_uia do
   it "#exist?" do
     window = RAutomation::Window.new(:title => "MainFormWindow")
 
@@ -10,9 +10,9 @@ describe "WinFfi::Label", :if => SpecHelper.adapter == :win_ffi do
 
   it "check for label class" do
     RAutomation::Window.new(:title => "MainFormWindow").label(:id => "textField").should_not exist
+    RAutomation::Window.new(:title => "MainFormWindow").label(:id => "label1").should exist
   end
 
-
   it "#label" do
     window = RAutomation::Window.new(:title => "MainFormWindow")
 

data/spec/adapter/ms_uia/list_item_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe "MsUia::ListItem", :if => SpecHelper.adapter == :ms_uia do
+
+  it "#exists" do
+    RAutomation::Window.new(:title => "MainFormWindow").list_item(:value => "Apple").should exist
+    RAutomation::Window.new(:title => "MainFormWindow").list_item(:value => "This is a sample text").should_not exist
+  end
+
+  it "#value" do
+    RAutomation::Window.new(:title => "MainFormWindow").list_item(:value => "Apple").value.should == "Apple"
+  end
+
+end

data/spec/adapter/{win_ffi → ms_uia}/listbox_spec.rb

@@ -1,13 +1,14 @@
 require 'spec_helper'
 
-describe "WinFfi::ListBox", :if => SpecHelper.adapter == :win_ffi do
+describe "MsUia::ListBox", :if => SpecHelper.adapter == :ms_uia do
 
   it "#exists" do
     RAutomation::Window.new(:title => "MainFormWindow").list_box(:id => "FruitListBox").should exist
   end
 
-  it "check for listbox class" do
+  it "checks for ListBox class" do
     RAutomation::Window.new(:title => "MainFormWindow").list_box(:id => "textField").should_not exist
+    RAutomation::Window.new(:title => "MainFormWindow").list_box(:id => "FruitListBox").should exist
   end
 
   it "counts items" do
@@ -17,11 +18,23 @@ describe "WinFfi::ListBox", :if => SpecHelper.adapter == :win_ffi do
 
   it "lists items" do
     list_box = RAutomation::Window.new(:title => "MainFormWindow").list_box(:id => "FruitListBox")
-    list_box.items[0].should == "Apple"
-    list_box.items[1].should == "Orange"
-    list_box.items[2].should == "Mango"
+
+    list_box.items[0].value.should == "Apple"
+    list_box.items[1].value.should == "Orange"
+    list_box.items[2].value.should == "Mango"
   end
 
+  it "returns a value" do
+    list_box = RAutomation::Window.new(:title => "MainFormWindow").list_box(:id => "FruitListBox")
+
+    list_box.value.should == ""
+    list_box.select(0)
+    list_box.value.should == "Apple"
+    list_box.select(1)
+    list_box.value.should == "Orange"
+    list_box.select(2)
+    list_box.value.should == "Mango"
+  end
 
   it "#selected?" do
     list_box = RAutomation::Window.new(:title => "MainFormWindow").list_box(:id => "FruitListBox")

data/spec/adapter/{win_ffi → ms_uia}/radio_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
-describe "WinFfi::RadioButton", :if => SpecHelper.adapter == :win_ffi do
+describe "MsUia::RadioButton", :if => SpecHelper.adapter == :ms_uia do
+
   it "#exist?" do
     RAutomation::Window.new(:title => "MainFormWindow").radio(:value => "Option 1").should exist
 
@@ -12,6 +13,7 @@ describe "WinFfi::RadioButton", :if => SpecHelper.adapter == :win_ffi do
 
   it "check for radio class" do
     RAutomation::Window.new(:title => "MainFormWindow").radio(:id => "textField").should_not exist
+    RAutomation::Window.new(:title => "MainFormWindow").radio(:id => "radioButton2").should exist
   end
 
 

data/spec/adapter/ms_uia/select_list_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe "MsUia::SelectList", :if => SpecHelper.adapter == :ms_uia do
+  it "#select_list" do
+    RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox").should exist
+
+    RAutomation::Window.wait_timeout = 0.1
+    expect {RAutomation::Window.new(:title => "non-existent-window").
+            select_list(:class => /COMBOBOX/i)}.
+            to raise_exception(RAutomation::UnknownWindowException)
+  end
+
+  it "check for select list class" do
+    RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "textField").should_not exist
+    RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox").should exist
+  end
+
+  it "#options" do
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox")
+    select_list.options.size.should == 5
+
+    expected_options = ["Apple", "Caimito", "Coconut", "Orange", "Passion Fruit"]
+    select_list.options.map {|option| option.text}.should == expected_options
+  end
+
+  it "#selected? & #select" do
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox")
+    select_list.options(:text => "Apple")[0].should_not be_selected
+    select_list.options(:text => "Apple")[0].select.should be_true
+    select_list.options(:text => "Apple")[0].should be_selected
+  end
+
+  it "#set" do
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox")
+    select_list.options(:text => "Apple")[0].should_not be_selected
+    select_list.set("Apple")
+    select_list.options(:text => "Apple")[0].should be_selected
+  end
+
+  it "#value" do
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox")
+
+    #default empty state
+    select_list.value.should == ""
+
+    select_list.options(:text => "Apple")[0].select
+    select_list.value.should == "Apple"
+
+    select_list.options(:text => "Caimito")[0].select
+    select_list.value.should == "Caimito"
+  end
+
+  it "enabled/disabled" do
+    RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox").should be_enabled
+    RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox").should_not be_disabled
+
+    RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "comboBoxDisabled").should_not be_enabled
+    RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "comboBoxDisabled").should be_disabled
+  end
+
+  it "#option" do
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox")
+
+    select_list.option(:text => "Apple").should_not be_selected
+    select_list.option(:text => "Apple").set
+    select_list.option(:text => "Apple").should be_selected
+  end
+
+  it "cannot select anything on a disabled select list" do
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "comboBoxDisabled")
+
+    lambda { select_list.option(:text => "Apple").set }.should raise_error
+  end
+
+
+#  it "control by focus" do
+#    window      = RAutomation::Window.new(:title => /MainFormWindow/i)
+#
+#    button = window.button(:value => "Reset")
+#    button.set_focus
+#
+#    element = window.get_focused_element
+#    type =button.get_current_control_type(element)
+#    puts "type :#{type}"
+
+#    box1 = another_button.bounding_rectangle
+#        box2 =   button.bounding_rectangle
+#
+#
+#    puts "#{box1}"
+#    puts "#{box2}"
+#
+#    sleep 10
+#    box1.should == box2
+#  end
+
+#  it "fires change event when selected" do
+#
+#    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox")
+#
+#    select_list.option(:text => "Apple").should_not be_selected
+#    select_list.set("Apple")
+#    select_list.option(:text => "Apple").should be_selected
+#
+#    label = RAutomation::Window.new(:title => "MainFormWindow").label(:id => "fruitsLabel")
+#    sleep 1
+#    label.value.should == "Apple"
+#  end
+end