watir_robot 0.1.0

data/lib/watir_robot/keywords/table.rb

@@ -0,0 +1,100 @@
+module WatirRobot
+  
+  #
+  # Functionality related to HTMl tables, including headers, bodies, footers, and cells
+  # 
+  module Table
+    
+    ### Actions ###
+    
+    #
+    # Get contents of a single table cell
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    # @param [String] row with the top-most row as 1, the number of the row in question
+    # @param [String] col with the left-most row as 1, the number of the column in question
+    # @return [String] the text contained within the targeted table cell
+    # 
+    def get_table_cell(loc, row, col)
+      row = row.to_i - 1
+      col = col.to_i - 1
+      @browser.table(parse_location(loc))[row][col].text
+    end
+    
+    
+    ### Conditions ###
+    
+    #
+    # Verify that table cell contains certain contents
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    # @param [String] row with the top-most row as 1, the number of the row in question
+    # @param [String] col with the left-most row as 1, the number of the column in question
+    # @param [String] text the text to compare against
+    # 
+    def table_cell_should_contain(loc, row, col, text)
+      row = row.to_i - 1
+      col = col.to_i - 1
+      raise(ElementMatchError, "The table cell at row #{row} and column #{col}, located in the table at #{loc}, does not contain the text #{text}") unless
+        @browser.table(parse_location(loc))[row][col].text.include? text
+    end
+    
+    #
+    # Verify that a table column contains certain contents
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    # @param [String] col with the left-most row as 1, the number of the column in question
+    # @param [String] text the text to compare against
+    # 
+    def table_column_should_contain(loc, col, text)
+      # There's no "nice" way to do this, so we run through each row and snag
+      #   the cell at offset y
+      col = col.to_i - 1
+      content = ''
+      @browser.table(parse_location(loc)).rows.each do |row|
+        content << ' '
+        content << row[col].text
+      end
+      
+      raise(Exception::ElementMatchError, "The table column number #{c} in the table located at #{loc} does not contain the text #{text}") unless
+        content.include? text
+    end
+    
+    #
+    # Verify that a table's header contains certain contents
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    # @param [String] text the text to compare against
+    # 
+    def table_header_should_contain(loc, text)
+      raise(Exception::ElementMatchError, "The table header of the table located at #{loc} does not contain the text #{text}") unless
+        @browser.table(parse_location(loc)).thead.text.include? text
+    end
+    
+    #
+    # Verify that a table row conatins certain contents
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    # @param [String] row with the top-most row as 1, the number of the row in question
+    # @param [String] text the text to compare against
+    # 
+    def table_row_should_contain(loc, row, text)
+      row = row.to_i - 1
+      raise(Exception::ElementMatchError, "The table row number #{row} in the table located at #{loc} does not contain the text #{text}") unless
+        @browser.table(parse_location(loc))[row].text.include? text
+    end
+    
+    #
+    # Verify that certain content is contained somewhere within an entire HTML table
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    # @param [String] text the text to compare against
+    # 
+    def table_should_contain(loc, text)
+      raise(Exception::ElementMatchError, "The table located at #{loc} does not contain the text #{text}") unless
+        @browser.table(parse_location(loc)).text.include? text
+    end
+    
+  end
+  
+end

data/lib/watir_robot/keywords/text_field.rb

@@ -0,0 +1,69 @@
+module WatirRobot
+  
+  #
+  # Functionality related to text fields (+<input>+ of type text and password)
+  # 
+  module TextField
+    
+    ### Actions ###
+    
+    #
+    # Focus cursor inside a textfield
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    #
+    def focus_textfield(loc)
+      @browser.text_field(parse_location(loc)).focus
+    end
+    
+    #
+    # Input text into a text field
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    # @param [String] text the text to type into the field
+    # 
+    def input_text(loc, text)
+      @browser.text_field(parse_location(loc)).set text
+    end
+    
+    #
+    # Input a password into a password field.
+    #
+    # @note This value will not be logged.
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    # @param [String] password the password to type into the field
+    # 
+    def input_password(loc, password)
+      # This will differ from input_text when logging is implemented
+      @browser.text_field(parse_location(loc)).set password
+    end
+    
+    
+    ### Conditions ###
+    
+    #
+    # Verify that textfield's text contains the value
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    # @param [String] text the text to type into the field
+    # 
+    def textfield_should_contain(loc, text)
+      raise(Exception::ElementMatchError, "The textfield located at #{loc} does not contain the text #{text}") unless
+        @browser.text_field(parse_location(loc)).value.include? text
+    end
+    
+    #
+    # Verify that textfield's text is the value
+    #
+    # @param [String] loc attribute/value pairs that match an HTML element
+    # @param [String] text the text to compare against
+    # 
+    def textfield_should_be(loc, text)
+      raise(Exception::ElementMatchError, "The textfield located at #{loc} does not have text equal to #{text}") unless
+        @browser.text_field(parse_location(loc)).value == text
+    end
+    
+  end
+  
+end

data/lib/watir_robot/parser.rb

@@ -0,0 +1,170 @@
+module WatirRobot
+  
+  #
+  # This module contains the functions necessary to convert arguments obtained
+  # from Robot Framework tests and make them meaningful to the underlying
+  # Watir-WebDriver code.
+  # 
+  module Parser
+    
+    #
+    # Mapping of Unicode values to java.awt.event.KeyEvent constants
+    #
+    KEY_CONSTANTS = {
+      32 => ['VK_SPACE'],
+      33 => ['VK_EXCLAMATION_MARK'],
+      34 => ['VK_SHIFT', 'VK_QUOTE'],
+      35 => ['VK_SHIFT', 'VK_3'],
+      36 => ['VK_SHIFT', 'VK_4'],
+      38 => ['VK_AMPERSAND'],
+      39 => ['VK_QUOTE'],
+      40 => ['VK_SHIFT', 'VK_9'],
+      41 => ['VK_SHIFT', 'VK_0'],
+      42 => ['VK_ASTERISK'],
+      43 => ['VK_ADD'],
+      45 => ['VK_SUBTRACT'],
+      46 => ['VK_DECIMAL'],
+      47 => ['VK_SLASH'],
+      48 => ['VK_0'],
+      49 => ['VK_1'],
+      50 => ['VK_2'],
+      51 => ['VK_3'],
+      52 => ['VK_4'],
+      53 => ['VK_5'],
+      54 => ['VK_6'],
+      55 => ['VK_7'],
+      56 => ['VK_8'],
+      57 => ['VK_9'],
+      58 => ['VK_SHIFT', 'VK_SEMICOLON'],
+      59 => ['VK_SEMICOLON'],
+      60 => ['VK_SHIFT', 'VK_COMMA'],
+      61 => ['VK_EQUALS'],
+      62 => ['VK_SHIFT', 'VK_DECIMAL'],
+      64 => ['VK_AT'],
+      65 => ['VK_SHIFT', 'VK_A'],
+      66 => ['VK_SHIFT', 'VK_B'],
+      67 => ['VK_SHIFT', 'VK_C'],
+      68 => ['VK_SHIFT', 'VK_D'],
+      69 => ['VK_SHIFT', 'VK_E'],
+      70 => ['VK_SHIFT', 'VK_F'],
+      71 => ['VK_SHIFT', 'VK_G'],
+      72 => ['VK_SHIFT', 'VK_H'],
+      73 => ['VK_SHIFT', 'VK_I'],
+      74 => ['VK_SHIFT', 'VK_J'],
+      75 => ['VK_SHIFT', 'VK_K'],
+      76 => ['VK_SHIFT', 'VK_L'],
+      77 => ['VK_SHIFT', 'VK_M'],
+      78 => ['VK_SHIFT', 'VK_N'],
+      79 => ['VK_SHIFT', 'VK_O'],
+      80 => ['VK_SHIFT', 'VK_P'],
+      81 => ['VK_SHIFT', 'VK_Q'],
+      82 => ['VK_SHIFT', 'VK_R'],
+      83 => ['VK_SHIFT', 'VK_S'],
+      84 => ['VK_SHIFT', 'VK_T'],
+      85 => ['VK_SHIFT', 'VK_U'],
+      86 => ['VK_SHIFT', 'VK_V'],
+      87 => ['VK_SHIFT', 'VK_W'],
+      88 => ['VK_SHIFT', 'VK_X'],
+      89 => ['VK_SHIFT', 'VK_Y'],
+      90 => ['VK_SHIFT', 'VK_Z'],
+      91 => ['VK_OPEN_BRACKET'],
+      92 => ['VK_BACK_SLASH'],
+      93 => ['VK_CLOSE_BRACKET'],
+      94 => ['VK_SHIFT', 'VK_6'],
+      95 => ['VK_SHIFT', 'VK_SUBTRACT'],
+      96 => ['VK_BACK_QUOTE'],
+      97 => ['VK_A'],
+      98 => ['VK_B'],
+      99 => ['VK_C'],
+      100 => ['VK_D'],
+      101 => ['VK_E'],
+      102 => ['VK_F'],
+      103 => ['VK_G'],
+      104 => ['VK_H'],
+      105 => ['VK_I'],
+      106 => ['VK_J'],
+      107 => ['VK_K'],
+      108 => ['VK_L'],
+      109 => ['VK_M'],
+      110 => ['VK_N'],
+      111 => ['VK_O'],
+      112 => ['VK_P'],
+      113 => ['VK_Q'],
+      114 => ['VK_R'],
+      115 => ['VK_S'],
+      116 => ['VK_T'],
+      117 => ['VK_U'],
+      118 => ['VK_V'],
+      119 => ['VK_W'],
+      120 => ['VK_X'],
+      121 => ['VK_Y'],
+      122 => ['VK_Z'],
+      123 => ['VK_SHIFT', 'VK_OPEN_BRACKET'],
+      125 => ['VK_SHIFT', 'VK_CLOSE_BRACKET'],
+    }
+  
+    #
+    # Parses the "location" string provided as argument for locating HTML elements.
+    #
+    # Watir-WebDriver expects a hash of parameters by which to search for HTML
+    # elements. This function take arguments from Robot Framework tests in the
+    # form of <tt>attribute=value</tt> and constructs a hash which
+    # Watir-WebDriver can use to uniquely identify HTML elements on the page.
+    #
+    # @param [String] loc argument from Robot Framework to locate an HTML element
+    # @return [Hash] a hash which Watir-WebDriver can use to locate an HTML element
+    #
+    def parse_location(loc)
+      loc = self.trim_sides(loc)
+      
+      if loc[0..3].downcase == 'css='
+        return {:css => loc[4..loc.length]}
+      elsif loc[0..5].downcase == 'xpath='
+        return {:xpath => loc[6..loc.length]}
+      else
+        # Comma-separated attributes
+        attr_list = loc.split(',')
+        attrs = {}
+        attr_list.each do |a|
+          attr_kv = a.split('=')
+          attrs[self.trim_sides(attr_kv[0])] = self.trim_sides(attr_kv[1])
+        end
+        # Watir expects symbols for keys
+        attrs = Hash[attrs.map { |k, v| [k.to_sym, v] }]
+        if attrs.key? :id
+          attrs.delete_if {|k, v| k != :id}
+        end
+        return attrs
+      end
+    end
+    
+    #
+    # Parses a key-code argument, provided as an actual character or in ASCII code
+    #
+    # @param [String] key the key for which to find the java.awt.KeyEvent key-code constant
+    # @return [String] the constant for the key event
+    #
+    def parse_key_code(key)
+      if key[0..5].downcase = 'ascii='
+        # return the ASCII code directly
+        return key[6..key.length]
+      else
+        # we assume it's a character and try to map it to a constant
+      end
+    end
+    
+    #
+    # Small utility for trimming whitespace from both sides of a string
+    #
+    # @param [String] s string to trim both sides of
+    # @return [Strgin] the same string without whitespace on the left or right sides
+    #
+    def trim_sides(s)
+      s = s.lstrip
+      s = s.rstrip
+      return s
+    end
+    
+  end
+
+end

data/scripts/example_tests/resource.txt

@@ -0,0 +1,14 @@
+*** Settings ***
+Library         Remote  http://localhost:8270
+
+*** Variables ***
+${BROWSER}  firefox
+${URL}  http://bit.ly/watir-example
+
+*** Keywords ***
+Open and Maximize
+    [Arguments]  ${url}  ${browser}=firefox
+    [Documentation]  Open a browser to a specific URL and then maximize it to full-screen.
+    Start Browser  ${URL}  ${BROWSER}
+    Maximize Browser Window
+

data/scripts/example_tests/test.txt

@@ -0,0 +1,171 @@
+*** Settings ***
+Suite Setup     Open and Maximize  ${URL}  ${BROWSER}
+Suite Teardown  Close Browser
+Library         Remote  http://localhost:8270
+Resource        resource.txt
+
+*** Test Cases ***
+Test Browser
+    [Setup]  Go To  ${URL}
+    Url Should Contain  google.com
+    ${current_url}=  Get Url
+    Go To  http://psd.tutsplus.com
+    Url Should Be  http://psd.tutsplus.com/
+    Go Back
+    Go Forward
+    Refresh
+    Click Image  alt=Photoshop to HTML
+    Switch To Next Window
+    Title Should Be  Photoshop to HTML | Rockable Press
+    Switch To Previous Window
+    Title Should Contain  Psdtuts+
+    Switch to Window  url=http://rockablepress.com/books/photoshop-to-html/
+    Url Should Contain  rockablepress.com
+    Switch to Window  url=http://psd.tutsplus.com/
+    Close Window  2
+    ${windows}=  Get Window Count
+    ${current_url}=  Get Url
+    Click Link  href=http://rockablepress.com/books/photoshop-to-html/
+    ${windows}=  Get Window Count
+    Switch to Next Window
+    Title Should Be  Photoshop to HTML | Rockable Press
+    ${windows}=  Get Window Count
+    Close Window  url=http://rockablepress.com/books/photoshop-to-html/
+    Title Should Contain  Psdtuts+
+
+Test Button
+    [Setup]  Go To  ${URL}
+    Click Button  value=Submit
+
+Test CheckBox
+    [Setup]  Go To  ${URL}
+    Select Checkbox  value=Ruby
+    Checkbox Should Be Selected  value=Ruby
+    Unselect Checkbox  value=Ruby
+    Checkbox Should Not Be Selected  value=Ruby
+
+Test Element
+    [Setup]  Go To  ${URL}
+    Click Element  name=submit
+    Element Should Be Visible  class=errorheader
+    Element Should Not Be Visible  name=backupCache
+    Element Text Should Be  class=errorheader  Looks like you have a question or two that still needs to be filled out.
+    Element Text Should Contain  class=errorheader  question or two
+    Focus  name=entry.0.single
+    Sleep  2 seconds
+    ${attr}=  Get Element Attribute  id=ss-form  method
+    ${text}=  Get Element Text  class=errorheader
+
+Test FileField
+    Go To  http://scribd.com/upload/supload
+    Choose File  name=upload_doc  C:/foobar.txt
+    ${file}=  Get Filefield Path  name=upload_doc
+
+Test Form
+    [Setup]  Go To  ${URL}
+    Form Should Contain Button  id=ss-form  value=Submit
+    Form Should Not Contain Button  id=ss-form  value=foobar
+    Form Should Contain Checkbox  id=ss-form  value=Ruby
+    Form Should Not Contain Checkbox  id=ss-form  value=foobar
+    Go To  http://scribd.com/upload/supload
+    Form Should Contain Filefield  name=upload_doc  id=file
+    Form Should Not Contain Filefield  name=upload_doc  id=foobar
+    Go Back
+    Form Should Contain Radio Button  id=ss-form  value=Watir
+    Form Should Not Contain Radio Button  id=ss-form  value=foobar
+    Form Should Contain Select List  id=ss-form  id=entry_6
+    Form Should Not Contain Select List  id=ss-form  id=foobar
+    Form Should Contain Textfield  id=ss-form  id=entry_0
+    Form Should Not Contain Textfield  id=ss-form  id=foobar
+
+Test Image
+    [Setup]  Go To  ${URL}
+    Go To  http://psd.tutsplus.com/
+    Click Image  alt=Photoshop to HTML
+    Switch To Window  title=Photoshop to HTML | Rockable Press
+    Url Should Be  http://rockablepress.com/books/photoshop-to-html/
+    ${count}=  Get Window Count
+    Switch To Other Window
+    Close Other Window
+
+Test Link
+    [Setup]  Go To  ${URL}
+    Click Link  text=Terms of Service
+    Url Should Be  http://www.google.com/accounts/TOS
+    Go Back
+
+Test List
+    [Setup]  Go To  ${URL}
+    ${items}=  Get List Items  class=ss-choices
+
+Test Native
+    [Setup]  Go To  ${URL}
+    Capture Screenshot
+
+Test Page
+    [Setup]  Go To  ${URL}
+    Title Should Be  Watir Example
+    ${source}=  Get Page Source
+    Log Page Source
+    ${text}=  Get Page Text
+    ${status}=  Get Page Status
+    ${title}=  Get Title
+    ${all_links}=  Get All Elements By Xpath  //a
+    Log  Executing JavaScript has been tested. It is simple wrapper around WebDriver's execute_script function, so if there's a problem, it's at the WebDriver level.
+    Page Should Contain  What testing tool do you like?
+    Page Should Not Contain  Supercalafragilisticexbialadocious
+    Page Should Contain Button  value=Submit
+    Page Should Not Contain Button  value=Foobar
+    Page Should Contain Checkbox  value=Ruby
+    Page Should Not Contain Checkbox  value=Clojure
+    Page Should Contain Element  id=ss-form
+    Page Should Not Contain Element  id=foobar
+    Go To  http://www.google.com/
+    Page Should Contain Image  src=/images/nav_logo29.png
+    Page Should Not Contain Image  src=foobar
+    Go Back
+    Page Should Contain Link  href=http://docs.google.com
+    Page Should Not Contain Link  href=foobar
+    Page Should Contain List  class=ss-choices  false
+    Page Should Not Contain List  class=foobar
+    Page Should Contain Radio Button  value=Watir
+    Page Should Not Contain Radio Button  value=foobar
+    Page Should Contain Textfield  name=entry.0.single
+    Page Should Not Contain Textfield  name=foobar
+    Title Should Be  Watir Example
+    Title Should Contain  Watir
+
+Test Radio
+    [Setup]  Go To  ${URL}
+    Select Radio Button  value=Watir
+    Radio Button Should Be Selected  value=Watir
+    Radio Button Should Not Be Selected  value=Selenium
+
+Test Select
+    [Setup]  Go To  ${URL}
+    Go to  http://drupal.org/project/issues/search/drupal
+    Select Item From List  id=edit-status  text=active
+    Item Should Be Selected  id=edit-status  text=active
+    Item Should Not Be Selected  id=edit-status  text=needs work
+    Select Item From List  id=edit-status  text=needs review
+    Item Should Be Selected  id=edit-status  text=needs review
+    Clear Items From List  id=edit-status
+    Item should not be selected  id=edit-status  text=active
+    Item should not be selected  id=edit-status  text=needs review
+
+Test Table
+    [Setup]  Go To  ${URL}
+    Go To  http://www.facebook.com
+    ${cell_1}=  Get Table Cell  ${EMPTY}  1  1
+    Table Cell Should Contain  ${EMPTY}  1  1  Email
+    Table Column Should Contain  ${EMPTY}  1  logged in
+    Table Row Should Contain  ${EMPTY}  3  your password?
+    Table Should Contain  ${EMPTY}  Password
+
+Test TextField
+    [Setup]  Go To  ${URL}
+    Focus TextField  name=entry.0.single
+    Input Text  name=entry.0.single  Foobar
+    Textfield Should Contain  name=entry.0.single  Foo
+    Textfield Should Be  name=entry.0.single  Foobar
+