browserstack-cucumber 0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjQwMzNjMzg0ZWYwYTkyZTQ0MGJlODVhMGU1MTE3NjY4MjBiOTljMA==
+  data.tar.gz: !binary |-
+    ZDRmMTllMDE2YTRmNjU2MzczYzczZWJhNzA0MDkxMzA2OTkzMGQ0OA==
+SHA512:
+  metadata.gz: !binary |-
+    MDZlM2Y2Zjg0MGVlNmI5NmFkYjI3Njg2ZDllZjdmNmNjMGViYjgwOTlkMjAz
+    ZmQ2NDIzYmVkMGNjOGM3Njg4NTA4YWY0NTViYzM3YzY5YmU4MTNjNWM1MWEz
+    ZTg2OTc5Y2FiOGIxMWVjNzI4YjFkMzE0N2EwNmU2Yjc1Y2I2N2U=
+  data.tar.gz: !binary |-
+    M2VlZTZkZjk3ZWViYmNkZThmZjJlY2U5YTc1MzJiYmUzZjJjYzg4Y2U4NTQ0
+    ZTkyNmEwNjg3NTcxYzI3NDMwYzFlYzE1MTVkNTRjMDBjYTZmMGYzMTUxNmEy
+    ZjI2YTRlM2E1NzM1Yjk2NDE0YTY3N2IyMDg0MjJhMTI2NzE5YTA=

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rspec'
+gem 'cucumber'
+gem 'page-object'
+gem 'rest-client'
+gem 'json'
+
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Long Tail Ad Solutions
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# BrowserStackCucumber
+
+A Ruby helper for running tests in BrowserStack Automate browser testing cloud service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'browserstack-cucumber'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install browserstack-cucumber
+
+## Usage
+
+browserstack-cucumber designed to get configuration from environment variables set by Jenkins.
+
+###Code changes:
+See features/support/env.rb on how to add BrowserStack support to your cucumber tests:
+
+```ruby
+require'rspec/expectations'
+require'page-object'
+require 'BrowserStack/browserstack.rb'
+require'selenium/webdriver'
+
+World(PageObject::PageFactory)
+
+#Installing Cucumber hooks
+Before('@selenium') do
+  @browser = ::BrowserStackCucumber.before_hook_impl
+end
+
+Around('@selenium') do |scenario, block|
+  ::BrowserStackCucumber.around_hook_impl(scenario, block)
+end
+
+at_exit do
+  ::BrowserStackCucumber.at_exit_impl()
+end
+```
+
+
+###Running tests:
+
+You'll need to set the following environment variables (the following values are used http://saucelabs.com/rest/v1/info/browsers/webdriver)
+ * SELENIUM_PLATFORM (os)
+ * SELENIUM_BROWSER (api_name)
+ * SELENIUM_VERSION (short_version)
+ * BROWSER_STACK_USER_NAME
+ * BROWSER_STACK_API_KEY
+
+To run cucumber tests suite:
+
+    $ cucumber SELENIUM_PLATFORM="Windows 2008" SELENIUM_BROWSER="firefox" SELENIUM_VERSION="24" BROWSER_STACK_API_KEY="<your browserstack api key>" BROWSER_STACK_USER_NAME="<browserstack username>"
+
+## Testing the Gem:
+
+set the following env variables
+run tests with
+
+    $ bundle exec cucumber SELENIUM_PLATFORM="Windows 2008" SELENIUM_BROWSER="firefox" SELENIUM_VERSION="24" BROWSER_STACK_API_KEY="<your browserstack api key>" BROWSER_STACK_USER_NAME="<browserstack username>"
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/browserstack-cucumber.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'browserstack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'browserstack-cucumber'
+  spec.version       = BrowserStackCucumber::VERSION
+  spec.authors       = ['Vladimir Vladimirov']
+  #noinspection RubyLiteralArrayInspection
+  spec.email         = ['vladimir@jwplayer.com']
+  spec.description   = %q{A Ruby helper for running tests in BrowserStack}
+  spec.summary       = %q{A Ruby helper for running tests in BrowserStack Automate browser testing cloud service}
+  spec.homepage      = 'https://github.com/JWPlayer/browserstack-cucumber'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  #noinspection RubyLiteralArrayInspection
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'page-object'
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'json'
+end

data/features/step_definitions/yahoo_test_steps.rb

@@ -0,0 +1,12 @@
+Given(/^I am on the yahoo page$/) do
+  visit(YahooMainPage)
+end
+
+When(/^I do search for phrase "([^"]*)"$/) do |search_phrase|
+  on(YahooMainPage).search_query = search_phrase
+  on(YahooMainPage).do_search
+end
+
+Then(/^I should see more then "([^"]*)" result$/) do |arg|
+  on(YahooResultsPage).search_results.count.should > arg.to_i
+end

data/features/support/env.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'..','..','lib'))
+
+require'rspec/expectations'
+require'page-object'
+require 'BrowserStack/browserstack.rb'
+require'selenium/webdriver'
+
+World(PageObject::PageFactory)
+
+#Installing Cucumber hooks
+begin
+  if ENV['SELENIUM_PLATFORM'] and !$0.include? 'app_checker.rb'
+    Before('@selenium') do
+      @browser = ::BrowserStackCucumber.before_hook_impl
+    end
+
+    Around('@selenium') do |scenario, block|
+      ::BrowserStackCucumber.around_hook_impl(scenario, block)
+    end
+
+    at_exit do
+      ::BrowserStackCucumber.at_exit_impl()
+    end
+  end
+
+rescue NoMethodError=>e
+  puts e
+end
+

data/features/support/pages/yahoo_main_page.rb

@@ -0,0 +1,11 @@
+class YahooMainPage
+  include PageObject
+
+  page_url 'http://yahoo.com'
+
+
+  text_field(:search_query, name: 'p')
+
+  button(:do_search, id: 'search-submit')
+
+end

data/features/support/pages/yahoo_results_page.rb

@@ -0,0 +1,23 @@
+class YahooResultsPage
+  include PageObject
+
+  expected_title 'why yahoo changed the logo - Yahoo Search Results'
+
+  def search_results
+    @browser.find_elements(css: 'li > div > div > h3 > a')
+  end
+
+  def initialize_page
+    #has_expected_title_wait? if self.respond_to?("has_expected_title_wait?")
+
+    has_expected_title? if self.respond_to?('has_expected_title?')
+
+    #has_expected_element? if self.respond_to?("has_expected_element?")
+
+    #has_expected_element_visible? if self.respond_to?("has_expected_element_visible?")
+
+
+  end
+
+
+end

data/features/testing_yahoo.feature

@@ -0,0 +1,9 @@
+@selenium
+Feature: trying to figure out why Yahoo changed logo
+
+
+  Scenario: let's ask yahoo do they know
+    Given I am on the yahoo page
+    When I do search for phrase "why yahoo changed the logo"
+    Then I should see more then "1" result
+

data/lib/browserstack/browserstack.rb

@@ -0,0 +1,226 @@
+require 'rubygems'
+require 'rest-client'
+require 'json'
+require 'BrowserStack/wait_until'
+
+module BrowserStackCucumber
+
+  class Config
+    attr_reader :browser
+
+    @test_url = 'https://account.jwplayer.com/sign-in'
+    @test_substring = 'sign in'
+    @browser = nil
+
+    def test_url=(url)
+      @test_url = url
+    end
+
+    def self.name_from_scenario(scenario)
+      # Special behavior to handle Scenario Outlines
+      if scenario.instance_of? ::Cucumber::Ast::OutlineTable::ExampleRow
+        table = scenario.instance_variable_get(:@table)
+        outline = table.instance_variable_get(:@scenario_outline)
+        return "#{outline.feature.file} - #{outline.title} - #{table.headers} -> #{scenario.name}"
+      end
+      scenario, feature = _scenario_and_feature_name(scenario)
+      return "#{feature} - #{scenario}"
+    end
+
+    def self._scenario_and_feature_name(scenario)
+      scenario_name = scenario.name.split("\n").first
+      feature_name = scenario.feature.short_name
+      return scenario_name, feature_name
+    end
+
+    def self.selenium_username
+      ENV['BROWSER_STACK_USER_NAME']
+    end
+
+    def self.selenium_apikey
+      ENV['BROWSER_STACK_API_KEY']
+    end
+
+    def self.selenium_os
+      #TODO: Windows 8 doesn't match BS
+      #'Windows XP' => Windows
+      ENV['SELENIUM_PLATFORM'].split(' ')[0]
+    end
+
+    def self.selenium_os_version
+      #'Windows XP' => XP
+      r = ENV['SELENIUM_PLATFORM'].split(' ')[1]
+      return 'XP' if (r=='2003')
+      return '7' if (r=='2008')
+      return '8' if (r=='2012')
+      r
+    end
+
+    def self.selenium_browser
+      #firefox
+      ENV['SELENIUM_BROWSER']
+    end
+
+    def self.selenium_browser_version
+      #21
+      ENV['SELENIUM_VERSION']
+    end
+
+
+    def self.capabilities
+
+      capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
+      capabilities[:name] = 'Testing Selenium 2 with Ruby on BrowserStack'
+      capabilities['os'] = selenium_os
+      capabilities['os_version'] = selenium_os_version
+      capabilities['browser'] = selenium_browser
+      capabilities['browser_version'] = selenium_browser_version
+      capabilities['browserstack.user'] = selenium_username
+      capabilities['browserstack.key'] = selenium_apikey
+      capabilities['browserstack.debug'] = 'true'
+      capabilities['acceptSslCerts'] = 'true'
+      capabilities['Idle timeout'] = 30
+      capabilities['build'] = ENV['BUILD_NUMBER']
+      capabilities['project'] = ENV['JOB_NAME']
+      capabilities
+    end
+    def self.url
+      'http://hub.browserstack.com/wd/hub'
+    end
+
+    def self.init_browser(scenario)
+      my_capabilities = capabilities()
+      my_url = url()
+      my_capabilities[:name] = name_from_scenario(scenario)
+      @browser = nil
+      count=0
+      try_count=0
+
+      #check for session limit before starting the test
+      wait_till_session_is_available()
+
+      WaitUntil::wait_until(500) do
+        count+=1
+        puts "try #{count} to init browser" if count>1
+
+        begin
+          try_count+=1
+          @browser = Selenium::WebDriver.for(:remote, :url => my_url, :desired_capabilities => my_capabilities)
+          @browser.get @test_url
+          raise "Network connection issue. Failed to open #{@test_url} and find '#{@test_substring}' substring" if !@browser.page_source.downcase.include? @test_substring
+          @browser
+        rescue =>e
+          if e.message.include? 'sessions are currently being used. Please upgrade to add more parallel sessions'
+            puts "Run out of sessions: '#{e.message}'"
+          else
+            puts "Exception while initializing Selenium session: #{e.class }#{e}"
+            puts e.backtrace
+            @browser.quit if !@browser.nil?
+            raise if try_count>30
+          end
+        end
+      end
+
+      if @browser.nil?
+        puts 'failed to init browser'
+        raise 'failed to initiate remote browser session after 300 seconds'
+      end
+
+      unless @browser.is_a? ::Selenium::WebDriver::Driver
+        puts 'invalid browser'
+        raise 'invalid browser'
+      end
+
+      @browser.instance_variable_get(:'@bridge').maximizeWindow
+      #puts my_capabilities['name']
+      #puts @browser.session_id
+      ENV['browser_session_id'] = @browser.session_id
+      @browser
+    end
+
+    def self.wait_till_session_is_available
+      ::BrowserStackCucumber::WaitUntil::wait_until(500) do
+        url = "https://#{selenium_username}:#{selenium_apikey}@api.browserstack.com/3/status"
+        r = RestClient.get(url)
+        parsed_r = JSON.parse(r.body)
+        puts "no free BrowserStack session available now#{parsed_r}" if (parsed_r['sessions_limit']==parsed_r['running_sessions'])
+        parsed_r['sessions_limit']-parsed_r['running_sessions']>0
+      end
+    rescue RestClient::Unauthorized=>e
+      puts "Error: Failed to access BrowserStack account, please check username and api key: #{e}"
+      raise
+    end
+
+    def self.browser
+      @browser
+    end
+
+    def self.close_browser
+      @browser.quit if !@browser.nil?
+      @browser = nil
+    end
+
+    def self.close_browser_force
+      unless @browser.nil?
+        puts @browser.title
+        STDERR.puts 'Something went wrong and selenium session was not closed. Closing it now.'
+        ::BrowserStackCucumber::Config.close_browser
+      end
+
+    end
+
+  end
+
+
+  module_function
+  def before_hook_impl
+    #::Capybara.default_driver = :browser_stack
+    #::Capybara.current_driver = :browser_stack
+    @browser = BrowserStackCucumber::Config.browser
+  end
+
+  module_function
+  def around_hook_impl(scenario, block)
+    #::Capybara.current_driver = :browser_stack
+
+    #set additional job details here (project, build, name etc)
+    #init selenium session
+
+    #driver = ::Capybara.current_session.driver
+    #noinspection RubyUnusedLocalVariable
+    my_browser = BrowserStackCucumber::Config.init_browser(scenario)
+
+    #set sessions details for BrowserStack here
+    #Job = ...
+
+    # This allow us to execute steps (n) times
+    unless scenario.instance_of? ::Cucumber::Ast::OutlineTable::ExampleRow
+      scenario.steps.each do |step|
+        step.instance_variable_set(:@skip_invoke, false)
+      end
+    end
+
+    block.call
+
+    # Quit the driver to allow for the generation of a new session_id
+    BrowserStackCucumber::Config.close_browser
+
+    #report job status to BrowserStack
+    #unless job.nil?
+    #  job.passed = !scenario.failed?
+    #  job.save
+    #end
+
+
+
+  end
+
+  module_function
+  def at_exit_impl
+    ::BrowserStackCucumber::Config.close_browser_force
+    #do global shutdown (i.e. tunnel)
+    #check for global errors
+  end
+
+
+end

data/lib/browserstack/version.rb

@@ -0,0 +1,3 @@
+module BrowserStackCucumber
+  VERSION = '0.1'
+end

data/lib/browserstack/wait_until.rb

@@ -0,0 +1,9 @@
+module BrowserStackCucumber
+  module WaitUntil
+
+    def self.wait_until(timeout = 10, message=nil, &block)
+      wait = Selenium::WebDriver::Wait.new(:timeout => timeout, :message => message)
+      wait.until &block
+    end
+  end
+end

data/lib/browserstack/with_rescue.rb

@@ -0,0 +1,34 @@
+module BrowserStackCucumber
+  module RetryHelper
+    def self.with_rescue(exception, limit=1, &block)
+
+      try=0
+      begin
+        block.call(try)
+      rescue exception
+        try+=1
+        retry if try<=limit
+      end
+    end
+
+    def self.with_rescue_many(exceptions, limit=1, &block)
+
+      try=0
+      begin
+        block.call(try)
+      rescue *exceptions
+        try+=1
+        retry if try<=limit
+      end
+    end
+
+  end
+end
+
+=begin
+usage example
+    RetryHelper::with_rescue(Selenium::WebDriver::Error::StaleElementReferenceError, 5) do
+      page_headline.include?('Your Billing Information')
+    end
+
+=end

data/lib/browserstack.rb

@@ -0,0 +1,4 @@
+require 'browsrstack/version'
+require 'browsrstack/browserstack'
+
+

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: browserstack-cucumber
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Vladimir Vladimirov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: page-object
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby helper for running tests in BrowserStack
+email:
+- vladimir@jwplayer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- browserstack-cucumber.gemspec
+- features/step_definitions/yahoo_test_steps.rb
+- features/support/env.rb
+- features/support/pages/yahoo_main_page.rb
+- features/support/pages/yahoo_results_page.rb
+- features/testing_yahoo.feature
+- lib/browserstack.rb
+- lib/browserstack/browserstack.rb
+- lib/browserstack/version.rb
+- lib/browserstack/wait_until.rb
+- lib/browserstack/with_rescue.rb
+homepage: https://github.com/JWPlayer/browserstack-cucumber
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: A Ruby helper for running tests in BrowserStack Automate browser testing
+  cloud service
+test_files:
+- features/step_definitions/yahoo_test_steps.rb
+- features/support/env.rb
+- features/support/pages/yahoo_main_page.rb
+- features/support/pages/yahoo_results_page.rb
+- features/testing_yahoo.feature