selenium-extjs 0.0.1

data/README.rdoc

@@ -0,0 +1,80 @@
+
+= Selenium-extjs
+
+Please, it's work in progress - wait for complete features or help us :)
+
+More information about extjs and selenium tests:
+* http://www.xeolabs.com/portal/articles/selenium-and-extjs
+* http://stackoverflow.com/questions/107314/any-suggestions-for-testing-extjs-code-in-a-browser-preferably-with-selenium
+
+== How it works?
+
+It's used the 'get_eval' to get Ext's components information (like id) using the window.Ext object and common selenium methods (like: type, click_at) to change the application status.
+
+==Instalation
+
+# TODO: deploy gem
+
+* git clone git://github.com/cathoderay/selenium-extjs.git
+* cd selenium-extjs
+* rake package
+* cd pkg
+* gem install selenium-extjs-0.0.1.gem
+
+==Contributing
+
+Send us a message!
+
+==Some Examples
+
+Please, take a look at "/test" files.
+
+===Simple
+
+	@selenium = [..your selenium object..]
+
+	appfeedgrid = @selenium.find_ext(:xtype => "appfeedgrid")
+
+	button = @selenium.find_ext(:xtype => "button", :text => 'Open All', :xparent => appfeedgrid)
+	
+	# click method wait for any request complete
+	button.click
+
+=== Working with Form
+
+	# search for form.
+	form = @selenium.find_ext(:xtype => "form", :title_has => 'Simple')
+
+	form.field[:email].value = "NotAEmail"
+
+	# convert to "isValid" and run at client.
+	assert_false form.field[:email].valid?
+
+	form.fields[:email].value = 'myemail@domain.br'
+	
+	assert_true form.field[:email].valid?
+	
+
+=== Working with Grid and Ajax Content.
+
+	# :wait blocks test, waiting for window
+	window = @selenium.find_ext(:xtype => 'window', :wait => true, :title => 'Store Load Callback')
+	# close the window
+	window.close
+
+	# search for editorgrid component.
+	editorgrid = @selenium.find(:xtype => "editorgrid")
+
+	# number of lines
+	print editorgrid.num_rows()
+
+	# set row 1 with data
+	editorgrid.edit_row(1, ["Jorge", "Shade", "10.10", "24/03/06", true]);
+ 
+	# get row (hash)
+	print editorgrid.get_row(3)
+ 
+	# clica at cell x,y
+	editorgrid.click_at_cell(2, 5)
+
+

data/lib/selenium-extjs.rb

@@ -0,0 +1,6 @@
+
+module SeleniumExtJs
+  VERSION = "0.0.1"
+end
+
+require 'selenium-extjs/Ext'

data/lib/selenium-extjs/Ext.rb

@@ -0,0 +1,120 @@
+
+require 'rubygems'
+require 'selenium/client'
+require 'selenium-extjs/Selenium'
+require 'selenium-extjs/component/Component'
+require 'selenium-extjs/component/Panel'
+require 'selenium-extjs/component/Button'
+require 'selenium-extjs/component/Field'
+require 'selenium-extjs/component/Form'
+require 'selenium-extjs/component/Grid'
+require 'selenium-extjs/component/Window'
+require 'selenium-extjs/component/Combo'
+require 'selenium-extjs/component/FieldSet'
+
+
+require 'json'
+
+
+module Ext
+  def self.reg(xtype, cls)
+    Ext::ComponentMgr.register_type(xtype, cls)
+  end   
+
+  def self.create(xtype, id, parent, selenium)
+    Ext::ComponentMgr.create(xtype, cls)
+  end   
+  
+  def self.condition_parent(cmp)
+    "(TODO)"
+  end
+
+  def self.condition_xtype(xtype)
+    "(el.getXType() == '#{xtype}')"  
+  end
+
+  def self.condition_default(key, value)
+    key = key.to_s if key.is_a? Symbol
+    ret = "("
+    if key.end_with? '_has'
+      key = key.gsub(/_has$/, '')
+      ret += "(typeof el.initialConfig.#{key} == 'string' && el.initialConfig.#{key}.indexOf('#{value}') != -1)||"
+    end
+    ret += "(el.initialConfig.#{key} && el.initialConfig.#{key} == '#{value}')"
+    ret += ")"
+    ret
+  end
+
+  # build arguments list.
+  def self.arguments(args)
+    if args.is_a? Array
+      return args.to_json[1..-2] || ""
+    else
+      return args.to_json
+    end
+  end
+  
+  def self.build_remote_call(id, method_name, arguments)
+    code = []
+    code << "(function(_) {"
+    code << "  var r;"
+    code << "  if (typeof _.#{method_name} == 'function') {"
+    code << "    r = _.#{method_name}(#{arguments});"
+    code << "  } else {"
+    code << "    r = _.#{method_name};"
+    code << "  }"
+    code << "  if (typeof r.getId == 'function') {" # return hash map
+    code << "    return 'JSON:' + window.Ext.util.JSON.encode({\"cmpid\":r.getId()});"
+    code << "  } else {"
+    code << "    return r;"
+    code << "  }"
+    code << "})(window.Ext.getCmp('#{id}'));"
+    (code.collect {|t| t.strip }).join
+  end
+  
+  # convert some ruby-style methods to ext-style
+  def self.extfy(method_name)
+    if method_name.end_with? '?'
+      method_name = "is_" + method_name
+      method_name.chop!
+    end
+    tokens = method_name.split("_")
+    tmp = tokens.shift
+    tokens.collect! {|t| t.capitalize }
+    tokens.unshift tmp
+    return tokens.join
+  end
+
+  class ComponentMgr
+    @@all = {}
+
+    def self.register_type(xtype, cls)
+        @@all[xtype] = cls
+    end
+
+    def self.registered?(xtype)
+      @@all.has_key? xtype
+    end
+  
+    def self.create(xtype, id, parent, selenium)
+      @@all[xtype].new(id, parent, selenium)
+    end
+  end  
+
+  {
+    :button => Button,
+    :component => Component,
+    :grid => Grid,
+    :editorgrid => EditorGrid,
+    :window => Window,
+    :form => Form,
+    :field => Field,
+    :panel => Panel,
+    :tabpanel => TabPanel,
+    :combo => Combo,
+    :fieldset => FieldSet
+  }.each do | xtype, cls |
+    Ext::reg(xtype, cls)
+  end
+
+end

data/lib/selenium-extjs/Selenium.rb

@@ -0,0 +1,71 @@
+module Ext
+  class Selenium < Selenium::Client::Driver
+    def initialize(args)
+      super(args)
+    end  
+
+    def find_ext(args)
+      if args.kind_of? Hash        
+        exp = ""
+        parent = nil
+        
+        xtype = nil
+        filters = []        
+        args.each do |k,v|
+          filters << case k
+            # use para botões.
+            when :icon_cls
+              " (el.iconCls?(el.iconCls.indexOfind_extf('#{v}') != -1):false) "
+            when :title
+              " (el.title?(el.title == '#{v}'):false) "
+            when :title_has
+              " (el.title?(el.title.indexOf('#{v}') != -1):false) "
+            when :wait
+              nil
+            when :text
+              " (el.getText?(el.getText() == '#{v}'):false) "
+            when :xtype
+              xtype = v
+              Ext::condition_xtype(v)
+            when :xparent
+              if v.is_a? Ext::Component
+                parent = v
+                " el.findParentBy(function(o) { return o.getId() == '#{v.getId()}' }) "
+              else
+                " el.findParentBy(function(o) { return o.getXType() == '#{v}' })  "
+              end
+            else
+              Ext::condition_default(k, v)
+          end
+        end
+        exp = filters.compact().join(" && ")
+        p "window.Ext.ComponentMgr.all.find(function(el){ return #{exp}  }).getId()"
+
+        # wait for element.
+        if args.has_key?(:wait) && args[:wait]
+          wait_for_condition("null != window.Ext.ComponentMgr.all.find(function(el){ return (#{exp}); })")
+        end
+        
+        id = get_eval("window.Ext.ComponentMgr.all.find(function(el){ return (#{exp}); }).getId()")
+
+        return get_cmp(id, parent)
+      end
+    end
+
+    def wait_for_component_visible(id)
+      wait_for_condition("window.Ext.getCmp('#{id}').isVisible()")
+    end
+
+    def get_cmp(id, parent=nil)
+      xtypes = get_eval("window.Ext.getCmp('#{id}').getXTypes()")
+      selected_xtype = nil
+      for xtype in xtypes.split("/").reverse() do
+        if Ext::ComponentMgr::registered? xtype.to_sym
+          selected_xtype = xtype.to_sym
+          break
+        end
+      end
+      return Ext::ComponentMgr::create selected_xtype, id, parent, self
+    end
+  end
+end

data/lib/selenium-extjs/component/Button.rb

@@ -0,0 +1,14 @@
+
+module Ext
+	class Button < Component
+
+	  def click
+	    wait_for_ajax()
+      @selenium.click_at(selector(), "0,0")
+    end
+
+    def node
+      return "//table[@id='#{@id}']//button"
+    end
+  end
+end

data/lib/selenium-extjs/component/Combo.rb

@@ -0,0 +1,21 @@
+
+module Ext
+	class Combo < Field
+
+    def value= (v)
+      @selenium.type(@id, v)
+      blur
+    end
+    
+    def blur
+      @selenium.fire_event(@id, "blur")
+    end
+
+    def value
+      # xpath or Ext?
+      # TODO: get more information from field (textarea or input[type=text])
+      @selenium.get_value(@id) #{}"//div[@id='#{@id}']//input")
+      # return @selenium.get_eval("window.Ext.getCmp('#{@id}').getValue()");
+    end
+  end
+end

data/lib/selenium-extjs/component/Component.rb

@@ -0,0 +1,98 @@
+
+require 'json'
+
+module Ext
+	class Component
+    attr_accessor :parent
+
+
+	  def initialize(id, parent = nil, selenium = nil)
+	    @id = id
+	    @parent = parent
+	    @selenium = selenium
+      init_component()
+	  end
+	  
+    def init_component()
+    end
+
+    # algumas ideias...
+    # obj.items_component_array -> serializar o retorno em uma lista
+    # tratar obj.store
+
+    def method_missing(method_name, *args, &block)
+
+      #
+      cmp = "window.Ext.getCmp('#{@id}')"
+     
+      # TODO: unit for validate this :p
+      # registered?
+      # is_registered
+      # isRegistered()
+
+      if method_name.to_s.end_with? "="
+        return nil
+      end
+      
+      # convert method name to ext model.
+      method_name = Ext::extfy(method_name.to_s)
+
+      # build js arguments list
+      arguments = Ext::arguments(args)
+
+      # move to selenium.
+      cmd = Ext::build_remote_call(@id, method_name, arguments)
+      p cmd
+      
+      ret = @selenium.get_eval(cmd)
+      if ret.start_with? "JSON:"
+        ret = JSON ret.split(":", 2)[1]
+      end
+
+      if ret == "true" || ret == "false"
+        ret = (ret =="true")
+      end
+
+
+      if ret.is_a? Hash
+        if ret.has_key? "cmpid"
+          p "---->"
+          p ret
+          return @selenium.get_cmp(ret["cmpid"], nil)
+        else
+          return ret
+        end
+      else
+        return ret
+      end
+    end  
+
+	  def wait_for_ajax
+	    @selenium.wait_for_condition("window.Ext.Ajax.isLoading() == false")
+    end
+	  
+	  # common tag element for this element
+	  def node
+	    return "//div[@id='#{@id}']"
+    end
+	  
+	  # xpath for this element.
+	  def selector
+	    p @parent
+	    sel = ""
+	    if @parent && @parent.getId()
+  	    sel += @parent.selector()
+	    end
+	    sel += node()
+	    return sel
+    end
+	  
+	  def getId()
+	    return @id
+	  end
+	  
+	  def highlight
+	    @selenium.highlight(selector())
+    end	  
+	end
+end

data/lib/selenium-extjs/component/Field.rb

@@ -0,0 +1,32 @@
+
+module Ext
+	class Field < Component
+
+#	  attr_reader :name
+#	  def init_component()
+#  	  @name = @selenium.get_eval("window.Ext.getCmp('#{@id}').getName()");
+#    end
+    
+    def value= (v)
+      @selenium.type(@id, v)
+      blur
+    end
+    
+    def blur
+      @selenium.fire_event(@id, "blur")
+    end
+
+    # user valid?
+    #def has_error?
+    #  # using Ext.JS
+    #  @selenium.get_eval("window.Ext.getCmp('#{@id}').isValid()") != "true"
+    #end
+    
+    def value
+      # xpath or Ext?
+      # TODO: get more information from field (textarea or input[type=text])
+      @selenium.get_value(@id) #{}"//div[@id='#{@id}']//input")
+      # return @selenium.get_eval("window.Ext.getCmp('#{@id}').getValue()");
+    end
+  end
+end

data/lib/selenium-extjs/component/FieldSet.rb

@@ -0,0 +1,15 @@
+
+module Ext
+  class FieldSet < Panel
+    def init_component()
+      super()
+    end
+    
+    def collapsed=(flag)
+      if collapsed != flag
+        @selenium.click_at("//fieldset[@id='#{@id}']//*[contains(@class, 'x-tool-toggle') or @type='checkbox']", "0,0")
+      end
+    end
+    
+  end
+end

data/lib/selenium-extjs/component/Form.rb

@@ -0,0 +1,25 @@
+
+module Ext
+  class Form < Ext::Panel
+
+    attr_reader :fields 
+    
+	  def init_component()
+      super()
+   
+#       # load all fields.
+#       fields = @selenium.get_eval("window.Ext.getCmp('#{@id}').findBy(function(el) { return el.getXTypes().indexOf('/field/') != -1 }).map(function(el) { return el.getId() })");
+#       @fields = {}
+#       fields.split(",").each do |field_id|
+#         field = @selenium.get_cmp(field_id, self);
+#         @fields[field.getName().to_sym] = field
+#         p field_id
+#       end
+# #      print @fields
+      
+    end
+
+    # component/box/field/textfield
+    # window.Ext.ComponentMgr.all.find(function(el){ return el.getXType() == 'form' }).findBy(function(el) { console.debug(el.getXType()); })
+  end
+end

data/lib/selenium-extjs/component/Grid.rb

@@ -0,0 +1,63 @@
+
+module Ext
+	class Grid < Component
+  end
+
+	class EditorGrid < Grid	  
+
+    
+    def click_at_cell(x,y)
+      @selenium.click_at(node() + "//div[contains(@class,'x-grid3-body')]//div[#{x}]//table//td[#{y}]", "0,0")
+    end
+    
+    # number of lines of Grid (store!)
+    def num_rows()
+      @selenium.get_eval("window.Ext.getCmp('#{@id}').getStore().getCount()").to_i
+    end
+    
+    def get_row(row)
+      len = @selenium.get_eval("window.Ext.getCmp('#{@id}').colModel.columns.length").to_i
+      ret = {}
+      len.times().each do |idx|
+        begin
+          data_index = @selenium.get_eval("window.Ext.getCmp('#{@id}').colModel.columns[#{idx}].dataIndex");
+          text = @selenium.get_text(node() + "//div[contains(@class,'x-grid3-body')]//div[#{row}]//table//td[#{idx+1}]")
+          ret[data_index.to_sym] = text
+        rescue Selenium::CommandError => ex
+          p ex
+        end
+      end
+      ret
+    end
+    
+    def edit_row(row, data)
+      len = @selenium.get_eval("window.Ext.getCmp('#{@id}').colModel.columns.length").to_i
+      len.times().each do |idx|
+        print "window.Ext.getCmp('#{@id}').colModel.columns[#{idx}].getEditor().getId()"
+        begin
+          editable = @selenium.get_eval("window.Ext.getCmp('#{@id}').colModel.columns[#{idx}].getEditor().getId()");
+          click_at_cell(row, idx + 1)
+#          @selenium.highlight(node() + "//div[contains(@class,'x-grid3-body')]//div[#{row}]//table//td[#{idx+1}]")
+          @selenium.wait_for_component_visible(editable)
+          @selenium.type(node() + "//*[@id='#{editable}']", data[idx])
+          @selenium.fire_event(node() + "//*[@id='#{editable}']", "blur")
+          sleep 1
+        rescue RuntimeError => ex
+          p ex
+        end
+      end
+    end
+
+    # //div[contains(@class,"x-grid3-body")]//div[2]//table//td[3]
+	  # // x-grid3-viewport
+	  ## x-grid3-body
+	  ## x-grid3-row x-grid3-row-first
+	  ## //div[contains(@class,"x-grid3-body")]//div[2]
+	  ## //div[contains(@class,"x-grid3-body")]//div[2]//table//td[2]
+	  
+    # Ext.getCmp("ext-comp-1005").store.getAt(2).data
+    # Ext.getCmp("ext-comp-1005").colModel.columns
+    # Ext.getCmp("ext-comp-1005").colModel.columns[0].getEditor().getXType()
+    # x-grid3-col
+  end
+end

data/lib/selenium-extjs/component/Panel.rb

@@ -0,0 +1,53 @@
+
+module Ext
+	class Panel < Component
+    attr_reader :items
+    
+    def init_component()
+	    @items = []
+	    total = @selenium.get_eval("(window.Ext.getCmp('#{@id}').items)?(window.Ext.getCmp('#{@id}').items.length):0").to_i
+	    total.times().each do |n|
+        cmp = get(n)
+        cmp.parent = self
+	      @items << cmp
+        # p cmp
+        #Ext::build_cmp(@selenium.get_eval("window.Ext.getCmp('#{@id}').get(#{n}).getId()"), self)
+      end
+    end
+
+    def title
+      @selenium.get_eval("window.Ext.getCmp('#{@id}').title")
+    end
+  end
+
+	class TabPanel < Panel
+
+=begin
+	  def active_tab
+      tab = active_tab().getId()
+#	    id = @selenium.get_eval("window.Ext.getCmp('#{@id}').getActiveTab().getId()")
+	    p "--- active tab ---"
+	    p id
+      p "?"
+      list = @items.select do |el|
+        p el.getId() 
+        el.getId() == id
+      end
+      p list
+      return list.first()
+    end
+=end
+    
+    def active_tab=(param)
+      if param.is_a? String
+        if param =~ /^ext-/
+          # wait!
+        else
+         title = param 
+        end
+      elsif param.is_a? Integer
+        @selenium.click_at( selector() + "//ul[contains(@class, 'x-tab-strip')]//li[#{param}]//span[contains(@class, 'x-tab-strip-text')]", "0,0")
+      end
+    end
+  end
+end

data/lib/selenium-extjs/component/Window.rb

@@ -0,0 +1,8 @@
+
+module Ext
+	class Window < Component
+	  def close
+	    @selenium.click_at( node() + "//div[contains(@class, 'x-tool-close')]", "0,0")
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: selenium-extjs
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ronald Andreu Kaiser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-18 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: raios.catodicos@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/selenium-extjs/component/Button.rb
+- lib/selenium-extjs/component/Combo.rb
+- lib/selenium-extjs/component/Component.rb
+- lib/selenium-extjs/component/Field.rb
+- lib/selenium-extjs/component/FieldSet.rb
+- lib/selenium-extjs/component/Form.rb
+- lib/selenium-extjs/component/Grid.rb
+- lib/selenium-extjs/component/Panel.rb
+- lib/selenium-extjs/component/Window.rb
+- lib/selenium-extjs/Ext.rb
+- lib/selenium-extjs/Selenium.rb
+- lib/selenium-extjs.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/cathoderay/selenium-extjs
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A framework in ruby to test your extjs applications with selenium
+test_files: []
+