selenium_fury 0.5.5 → 0.5.6

data/Changelog.md

@@ -0,0 +1,29 @@
+###v0.5.2
+####Enhancements
+
+*  Adding the custom generator and cucumber features to the project.
+*  Tests now execute against HomeAway.
+
+[full changelog](https://github.com/scottcsims/SeleniumFury/compare/v0.5.1...v0.5.2)
+
+###v0.5.1
+####Enhancements
+
+*  Adding ability to name attributes in order of id, name, title.
+
+[full changelog](https://github.com/scottcsims/SeleniumFury/compare/v0.5...v0.5.1)
+
+###v0.5.
+####Enhancements
+
+*  Adding project files and connecting to a public facing site.
+
+v0.2.
+####Enhancements
+
+*  Adding Validator Code
+
+v0.1.
+####Enhancements
+
+*  Adding Generator Code

data/Gemfile

@@ -1,6 +1,6 @@
 source :rubygems
 
-gem "selenium-client", :require => "selenium/client"
+gem "selenium-webdriver"
 gem "nokogiri"
 
 group :development do
@@ -12,6 +12,7 @@ group :development do
   gem "bundler"
   gem "builder"
   gem "rake"
+  gem "faker"
 end
 
 

data/Gemfile.lock

@@ -2,35 +2,47 @@ GEM
   remote: http://rubygems.org/
   specs:
     builder (3.0.0)
-    cucumber (1.0.2)
+    childprocess (0.2.2)
+      ffi (~> 1.0.6)
+    cucumber (1.1.0)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
-      gherkin (~> 2.4.5)
+      gherkin (~> 2.5.0)
       json (>= 1.4.6)
-      term-ansicolor (>= 1.0.5)
-    diff-lcs (1.1.2)
-    gherkin (2.4.5)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
+    faker (1.0.1)
+      i18n (~> 0.4)
+    ffi (1.0.9)
+    gherkin (2.5.4)
       json (>= 1.4.6)
     git (1.2.5)
+    i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.5.3)
+    json (1.6.1)
+    json_pure (1.6.1)
     nokogiri (1.5.0)
-    rake (0.9.2)
+    rake (0.9.2.2)
     rdiscount (1.6.8)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    selenium-client (1.2.18)
-    term-ansicolor (1.0.6)
-    yard (0.7.2)
+    rspec-mocks (2.7.0)
+    rubyzip (0.9.4)
+    selenium-webdriver (2.9.1)
+      childprocess (>= 0.2.1)
+      ffi (= 1.0.9)
+      json_pure
+      rubyzip
+    term-ansicolor (1.0.7)
+    yard (0.7.3)
 
 PLATFORMS
   ruby
@@ -39,10 +51,11 @@ DEPENDENCIES
   builder
   bundler
   cucumber
+  faker
   jeweler
   nokogiri
   rake
   rdiscount
   rspec
-  selenium-client
+  selenium-webdriver
   yard

data/Rakefile

@@ -23,9 +23,9 @@ Jeweler::Tasks.new do |gem|
  all of the selenium locators you are using in your page file and return a list of the locators that it could not find.
  If there are missing locators you can then rerun the generator to generate new selenium locators for your page. http://www.scottcsims.com}
   gem.email = "ssims98@gmail.com"
-  gem.authors = ["Scott Sims"]
+  gem.authors = ["Scott Sims","Tim Tischler"]
   gem.homepage = "https://github.com/scottcsims/SeleniumFury"
-  gem.version = '0.5.5'
+  gem.version = '0.5.6'
   gem.add_dependency 'nokogiri'
 end
 

data/features/custom_generator.feature

@@ -1,4 +1,5 @@
-Feature: As an automated tester I want to create a page object with variable names that reflect business terms so the our test will reflect ubiquitous language.
+Feature: Custom Generator
+  As an automated tester I want to create a page object with variable names that reflect business terms so the our test will reflect ubiquitous language.
 
   Scenario: Use a custom generator configuration object to specify how to name our variables from another source than the id
     Given I am on the advanced search page for HomeAway

data/features/generate_page_object.feature

@@ -1,4 +1,5 @@
-Feature: As an automated tester I want to use a tool to find html elements on a web page so that I can reuse locators in in the page object pattern.
+Feature: Generator
+  As an automated tester I want to use a tool to find html elements on a web page so that I can reuse locators in in the page object pattern.
 
 
   Scenario: The generator produces a ruby class on standard out that reflects the ids of page elements that can be used as a page object.

data/features/step_definitions/validate_page_object_steps.rb

@@ -1,9 +1,8 @@
 When /^I run the validator$/ do
-  check_page_file_class(AdvancedSearch, "/searchForm")
+  validate(AdvancedSearch, "/searchForm")
 end
 Then /^the advanced search page object locators will be checked$/ do
-  found_missing_locators.should have(0).elements
-  found_missing_locators.should_not be_nil
+  @found_missing_locators.should have(0).elements
 end
 When /^I run the validator with missing locators$/ do
   class AdvancedSearchBroken < AdvancedSearch
@@ -20,5 +19,6 @@ When /^I run the validator with missing locators$/ do
   end
 end
 Then /^there will be missing locators found$/ do
-  found_missing_locators["missing_locator_attribute"].should == "missing_locator"
+  @found_missing_locators.should have(1).elements
+  @found_missing_locators["missing_locator_attribute"].should == "missing_locator"
 end

data/features/validate_page_object.feature

@@ -1,4 +1,5 @@
-Feature: As an automated tester I want a tool to check if my page object locators are correct so that I can update invalid locators.
+Feature: Validator
+  As an automated tester I want a tool to check if my page object locators are correct so that I can update invalid locators.
 
   Scenario: Use reflection to open a page object and validate that the locators are valid
     Given I am on the advanced search page for HomeAway

data/lib/selenium_fury/common/page_parser.rb

@@ -0,0 +1,49 @@
+#/* Copyright (c) 2010 HomeAway, Inc.
+# * All rights reserved.  http://www.homeaway.com
+# *
+# * Licensed under the Apache License, Version 2.0 (the "License");
+# * you may not use this file except in compliance with the License.
+# * You may obtain a copy of the License at
+# *
+# *      http://www.apache.org/licenses/LICENSE-2.0
+# *
+# * Unless required by applicable law or agreed to in writing, software
+# * distributed under the License is distributed on an "AS IS" BASIS,
+# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# * See the License for the specific language governing permissions and
+# * limitations under the License.
+# */
+module SeleniumFury
+    class PageParser
+      def initialize (html_source)
+        @html_source = html_source
+        @nokogiri_selectors= ["select",
+                              "textarea",
+                              "form",
+                              "input",
+                              "input[type='button']",
+                              "input[type='file']",
+                              "input[type='checkbox']",
+                              "input[type='password']",
+                              "input[type='radio']",
+                              "input[type='reset']",
+                              "input[type='image']",
+                              "input[type='submit']",
+                              "input[type='text']"]
+
+      end
+
+      attr_reader :browser, :nokogiri_selectors,:html_source
+
+      def nokogiri_elements
+        nokogiri_elements=[]
+        doc = Nokogiri::HTML(html_source)
+        nokogiri_selectors.each do |selector|
+          doc.css(selector).each do |nokogiri_element|
+            nokogiri_elements.push(nokogiri_element)
+          end
+        end
+        return nokogiri_elements
+      end
+    end
+end

data/lib/selenium_fury/common/selenium_api_chooser.rb

@@ -0,0 +1,22 @@
+module SeleniumFury
+  module SeleniumApiChooser
+    def generate(selenium_api_object)
+      if selenium_api_object.class == Selenium::Client::Driver
+        return SeleniumFury::SeleniumClient::PageGenerator.get_source_and_print_elements(selenium_api_object)
+      end
+      if selenium_api_object.class == Selenium::WebDriver::Driver
+        return SeleniumFury::SeleniumWebDriver::PageGenerator.web_driver_generate(selenium_api_object)
+      end
+    end
+
+    def validate(page_object, *live_url)
+      unless browser.nil?
+        return check_page_file_class(page_object,*live_url)
+      end
+      unless driver.nil?
+        return SeleniumFury::SeleniumWebDriver::PageValidator.web_driver_validate(page_object)
+      end
+    end
+
+  end
+end

data/lib/selenium_fury/selenium_client/create_selenium_client_driver.rb

@@ -0,0 +1,38 @@
+#/* Copyright (c) 2010 HomeAway, Inc.
+# * All rights reserved.  http://www.homeaway.com
+# *
+# * Licensed under the Apache License, Version 2.0 (the "License");
+# * you may not use this file except in compliance with the License.
+# * You may obtain a copy of the License at
+# *
+# *      http://www.apache.org/licenses/LICENSE-2.0
+# *
+# * Unless required by applicable law or agreed to in writing, software
+# * distributed under the License is distributed on an "AS IS" BASIS,
+# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# * See the License for the specific language governing permissions and
+# * limitations under the License.
+# */
+module SeleniumFury
+  module SeleniumClient
+    module CreateSeleniumClientDriver
+      # @return [Selenium::Client::Driver]
+      def browser
+        return @browser
+      end
+
+      # @param url [string]
+      # @return [Selenium::Client::Driver]
+      def create_selenium_driver(url)
+
+        @browser = Selenium::Client::Driver.new(
+            :host => ENV['HOST'] || "localhost",
+            :port => 4444,
+            :browser => ENV['SELENIUM_RC_BROWSER'] || "*firefox",
+            :url => url,
+            :timeout_in_second => 60)
+      end
+      alias_method :create_selenium_client_driver, :create_selenium_driver
+    end
+  end
+end

data/lib/selenium_fury/selenium_client/custom_generator.rb

@@ -0,0 +1,65 @@
+#/* Copyright (c) 2010 HomeAway, Inc.
+# * All rights reserved.  http://www.homeaway.com
+# *
+# * Licensed under the Apache License, Version 2.0 (the "License");
+# * you may not use this file except in compliance with the License.
+# * You may obtain a copy of the License at
+# *
+# *      http://www.apache.org/licenses/LICENSE-2.0
+# *
+# * Unless required by applicable law or agreed to in writing, software
+# * distributed under the License is distributed on an "AS IS" BASIS,
+# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# * See the License for the specific language governing permissions and
+# * limitations under the License.
+# */
+module SeleniumFury
+  module SeleniumClient
+    module CustomGenerator
+# Use a custom configuration object to define a location strategy for a locators name and value
+# @param [Hash] options the options to use with a custom generator.
+# @option opts [CustomConfiguration] :custom_configuration a class that explains how to parse the page
+# @option opts [String] :browser the selenium driver
+# @option opts [String] :html html from the page under test
+      def custom_generator(options)
+        custom_configuration = options[:custom_configuration]
+        browser = options[:browser]
+        if !browser.nil?
+          html = browser.get_html_source
+        else
+          html = options[:html]
+        end
+        doc = Nokogiri::HTML(html)
+        html_menu_elements ={}
+        doc.css(custom_configuration.selector).each do |nokogiri_element|
+          custom_configuration.nokogiri_element = nokogiri_element
+          puts "Html element is #{nokogiri_element}" if $DEBUG
+          generated_name = clean_attribute_name(custom_configuration.name)
+          puts "generated name is #{generated_name}" if $DEBUG
+          generated_value = custom_configuration.value
+          puts "generated value is #{generated_value}" if $DEBUG
+          puts "@#{generated_name} = \"#{generated_value}\"" if $DEBUG
+          html_menu_elements[generated_name]= generated_value
+        end
+        return print_selenium_client_page_object(html_menu_elements)
+      end
+
+      # Parse the html attribute to a ruby variable
+      # @return [String]
+      # @param attribute_name [String] the html id,name, or title of an element
+      def clean_attribute_name(attribute_name)
+        attribute_name.gsub!('input-', '')
+        attribute_name.gsub!('select-', '')
+        attribute_name.gsub!(/([A-Z]+)/, '_\1')
+        attribute_name.gsub!('\\', '')
+        attribute_name.gsub!(' ', '_')
+        attribute_name.gsub!('.', '_')
+        attribute_name.gsub!('-', '_')
+        attribute_name.gsub!('__', '_')
+        attribute_name.gsub!(/^_/, '')
+        attribute_name = attribute_name.to_s.downcase
+        return attribute_name
+      end
+    end
+  end
+end

data/lib/selenium_fury/selenium_client/locator_finder.rb

@@ -0,0 +1,54 @@
+module SeleniumFury
+  module SeleniumClient
+    class LocatorFinder
+      def initialize (nokogiri_elements)
+        @nokogiri_elements=nokogiri_elements
+        @valid_locators=["id", "name", "title"]
+      end
+
+      attr_reader :nokogiri_elements, :valid_locators
+
+      def find_locators
+        locators=[]
+        nokogiri_elements.each do |nokogiri_element|
+          valid_locators.each do |valid_locator|
+            if nokogiri_element.get_attribute(valid_locator) != nil
+              locators.push(nokogiri_element.get_attribute(valid_locator))
+              break
+            end
+          end
+        end
+        return locators
+      end
+
+      def page_object_attributes
+        locators=find_locators
+        object_attributes ={}
+        locators.each do |locator|
+          name=attribute_name(locator)
+          object_attributes[name] = locator
+        end
+        return object_attributes
+      end
+
+      def attribute_name name
+        if !name.nil?
+          find_and_replace_patterns = [[/([A-Z]+)/, '_\1'],
+                                       ['input-', ''],
+                                       ['select-', ''],
+                                       ['\\', ''],
+                                       [' ', '_'],
+                                       ['.', '_'],
+                                       ['-', '_'],
+                                       ['__', '_']
+          ]
+          find_and_replace_patterns.each do |pattern|
+            name=name.gsub(pattern[0], pattern[1])
+          end
+          name=name.to_s.downcase
+        end
+        return name
+      end
+    end
+  end
+end

data/lib/selenium_fury/selenium_client/page_generator.rb

@@ -0,0 +1,63 @@
+#/* Copyright (c) 2010 HomeAway, Inc.
+# * All rights reserved.  http://www.homeaway.com
+# *
+# * Licensed under the Apache License, Version 2.0 (the "License");
+# * you may not use this file except in compliance with the License.
+# * You may obtain a copy of the License at
+# *
+# *      http://www.apache.org/licenses/LICENSE-2.0
+# *
+# * Unless required by applicable law or agreed to in writing, software
+# * distributed under the License is distributed on an "AS IS" BASIS,
+# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# * See the License for the specific language governing permissions and
+# * limitations under the License.
+# */
+module SeleniumFury
+  module SeleniumClient
+    module PageGenerator
+
+      # @return [String]
+      # @param html_elements [Hash]
+      def print_selenium_client_page_object(html_elements)
+        result = ""
+        result += "found (#{html_elements.length} elements)\n"
+        result += "class YourPageFile\n"
+        result += "\tdef initialize *browser\n\t\t@browser = *browser\n"
+        html_elements.keys.sort.each do |key|
+          result += "\t\t@#{key} = \"#{html_elements[key]}\"\n"
+        end
+        result += "\tend\n"
+        count=1
+        html_elements.keys.sort.each do |key|
+          if count == 1
+            result += "\tattr_accessor :browser, "
+          end
+          if count % 5 == 0
+            result += "\n\t"
+          end
+          if count != html_elements.length
+            result += ":#{key}, "
+          else
+            result += ":#{key}"
+          end
+          count = count + 1
+        end
+        result += "\n\nend"
+        $stdout.puts result
+        return result
+      end
+
+
+      # @param browser [Selenium::Client::Driver]
+      def get_source_and_print_elements(browser)
+        html =browser.get_html_source
+        nokogiri_elements = SeleniumFury::PageParser.new(html).nokogiri_elements
+        raise "The generator did not find nokogiri elements" unless nokogiri_elements
+        page_object_attributes = SeleniumFury::SeleniumClient::LocatorFinder.new(nokogiri_elements).page_object_attributes
+        raise "The generator did not find page object attributes" if page_object_attributes.empty?
+        print_selenium_client_page_object page_object_attributes
+      end
+    end
+  end
+end

data/lib/selenium_fury/selenium_client/page_validator.rb

@@ -0,0 +1,117 @@
+#/* Copyright (c) 2010 HomeAway, Inc.
+# * All rights reserved.  http://www.homeaway.com
+# *
+# * Licensed under the Apache License, Version 2.0 (the "License");
+# * you may not use this file except in compliance with the License.
+# * You may obtain a copy of the License at
+# *
+# *      http://www.apache.org/licenses/LICENSE-2.0
+# *
+# * Unless required by applicable law or agreed to in writing, software
+# * distributed under the License is distributed on an "AS IS" BASIS,
+# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# * See the License for the specific language governing permissions and
+# * limitations under the License.
+# */
+module SeleniumFury
+  module SeleniumClient
+    module PageValidator
+      @found_missing_locators
+      attr_accessor :found_missing_locators
+      # @param page_file_class [Class] The page object class you want to test
+      # @param live_url [String] the url of the page your testing
+      def check_page_file_class(page_file_class, *live_url)
+        raise "cannot access the selenium client driver" if browser.nil?
+        missing_locators={}
+        puts "Validating the #{page_file_class} class"
+        #all initialize methods of page files should have *browser specified as the argument. This is an optional argument
+        test_page = page_file_class.new(browser)
+        raise "The test class is nil" if test_page.nil?
+        #skip the open if we don't need to open the url again
+        unless live_url.empty?
+          puts "Opening  #{browser.browser_url}/#{live_url}" #if $DEBUG
+          browser.open live_url
+        end
+
+        #check for class methods and execute.
+        verify_class_variables(test_page, missing_locators) if test_page.public_methods(all=false).length > 0
+
+        #check for instance methods and execute.
+        verify_instance_variables(test_page, missing_locators) if test_page.instance_variables.length > 0
+        @found_missing_locators=missing_locators
+        return print_missing_locators(missing_locators)
+      end
+
+
+      # @param missing_locators [Hash] locator name and values
+      def print_missing_locators missing_locators
+        puts "Missing locators are " if missing_locators != {}
+        missing_locators.each_pair do |locator_name, locator_value|
+          puts "     #{locator_name} =>  #{locator_value}"
+        end
+        raise "found missing locators" unless missing_locators.empty?
+      end
+
+      def attribute_name_filter locator_name
+        #Add names of attributes to filter
+        skip_words=["browser"]
+
+        skip_words=skip_words+@known_missing_locators if !@known_missing_locators.nil?
+
+        return skip_words.include?(locator_name)
+      end
+
+      # @param test_page [Object] an instantiated page object
+      # @param missing_locators [Hash]
+      def verify_instance_variables(test_page, missing_locators)
+        #test_page.print_properties browser
+        test_page.instance_variables.each do |locator_name|
+          #prepare the locator values
+          locator_name.slice!(0)
+          if attribute_name_filter(locator_name)
+            puts "Skipping validation for #{locator_name}"
+            next
+          end
+          next if (test_page.method(locator_name).call.class.to_s != "String")
+          puts "     Validating the #{locator_name} page element locator" #chomp the @ sign off of the method name.
+          locator_value = test_page.method(locator_name) # Create the reference to the get method of the instance variable
+          begin
+            browser.wait_for_element(locator_value.call, {:timeout_in_seconds => "5"})
+          rescue
+            puts "    -----------------------------------    Could not find '#{locator_name}'"
+          end
+          missing_locators[locator_name]= locator_value.call if !browser.element?(locator_value.call) # Use the value of the instance variable
+        end
+      end
+
+      # @param test_page [Object] an instantiated page object
+      # @param missing_locators [Hash]
+      def verify_class_variables(test_page, missing_locators)
+        test_page.public_methods(all=false).each do |locator_name|
+          #Only operate with the set methods not the get methods
+          next if (!locator_name.include?("="))
+
+          locator_name.slice!(locator_name.length-1)
+
+          if attribute_name_filter(locator_name)
+            puts "Skipping validation for #{locator_name}"
+            next
+          end
+          next if (test_page.method(locator_name).call.class.to_s != "String")
+          puts "     Validating the #{locator_name} page element locator" #chomp the @ sign off of the method name.
+          locator_value = test_page.method(locator_name) # Create the reference to the get method of the instance variable
+                                                                          #Now validate the page
+          begin
+            browser.wait_for_element(locator_value.call, {:timeout_in_seconds => "5"})
+          rescue
+            puts "    -----------------------------------          Could not find #{locator_name}"
+          end
+          missing_locators[locator_name]= locator_value.call if !browser.element?(locator_value.call) # Use the value of the instance variable
+
+        end
+      end
+
+
+    end
+  end
+end

data/lib/selenium_fury/selenium_web_driver/create_selenium_web_driver.rb

@@ -0,0 +1,35 @@
+#/* Copyright (c) 2010 HomeAway, Inc.
+# * All rights reserved.  http://www.homeaway.com
+# *
+# * Licensed under the Apache License, Version 2.0 (the "License");
+# * you may not use this file except in compliance with the License.
+# * You may obtain a copy of the License at
+# *
+# *      http://www.apache.org/licenses/LICENSE-2.0
+# *
+# * Unless required by applicable law or agreed to in writing, software
+# * distributed under the License is distributed on an "AS IS" BASIS,
+# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# * See the License for the specific language governing permissions and
+# * limitations under the License.
+# */
+
+module SeleniumFury
+  module SeleniumWebDriver
+    module CreateSeleniumWebDriver
+
+      #@return [Selenium::WebDriver::Driver]
+      def driver
+        return @driver
+      end
+
+      # @param url [string]
+      # @return [Selenium::WebDriver::Driver]
+      def launch_web_driver url
+        @driver = Selenium::WebDriver.for :firefox
+        @driver.navigate.to url
+      end
+
+    end
+  end
+end