browserstack-automate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f3653ef44d2bc13fe3355f44b67ed710da7f605
+  data.tar.gz: 99de11d249bf913ef82a05cb1c666c2f1fd6b986
+SHA512:
+  metadata.gz: 363e2eb4d83e085e9ce5b807e24c871f50d60863eb3aa43ba37a9174720e0a5d0db3279202bad7b52ea6d0a77fdef662498c9393e277caf75619376f9b59e4c7
+  data.tar.gz: e341d69f8d35b1c6d28c88d3c222017deac00d66325a1a2cc5c0ec5f1637071a3fcac8a5a56dd6e780cf42b18c8baddc33e5bdee8c109b478a5fc04211939a88

data/.gitignore

@@ -0,0 +1,6 @@
+node_modules
+selenium*.jar
+tests_output
+*.gemfile
+*.lock
+local.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in browserstack.gemspec
+gemspec

data/README.md

@@ -0,0 +1,71 @@
+# BrowserStack-Automate
+
+Run Cucumber tests on BrowserStack Automate using our Ruby integration.
+
+> Running your Selenium tests on BrowserStack requires a username and an access key. To create an account go to [BrowserStack Automate](https://www.browserstack.com/automate)
+
+![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780)
+
+## Running First Test
+
+You can use our integration to run your Cucumber tests on BrowserStack. It's a simple two-step process:
+
+#### Step 1 - Install *browserstack-automate* integration
+
+```
+gem install browserstack-automate
+```
+
+#### Step 2 - Add it to your `support/env.rb` file 
+
+You just need to add this to your configuration file
+
+```
+require 'browserstack-automate'
+BrowserStack.for "cucumber"
+```
+
+That's it! You can now execute your tests on BrowserStack by using the `RUN_ON_BSTACK`, `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` environment variables.
+
+```bash
+RUN_ON_BSTACK=true BROWSERSTACK_USERNAME=<your_username> BROWSERSTACK_ACCESS_KEY=<your_access_key> bundle exec cucumber
+```
+
+## Running Local Tests
+
+In order to run tests inside your local development environments, use ```BSTACK_LOCAL=true```.
+
+```
+RUN_ON_BSTACK=true BSTACK_LOCAL=true BROWSERSTACK_USERNAME=<username> BROWSERSTACK_ACCESS_KEY=<access_key> bundle exec cucumber
+```
+
+This creates an instance of BrowserStack Local Binary for every single build. To know more about how this works, read our documentation on [Local Testing](https://www.browserstack.com/local-testing).
+
+
+## Running Parallel Tests
+
+You can run your parallel tests on BrowserStack by adding ```RUN_ON_BSTACK=true``` to your parallel tests.
+
+```
+RUN_ON_BSTACK=true BROWSERSTACK_USERNAME=<username> BROWSERSTACK_ACCESS_KEY=<access_key>  bundle exec cucumber
+```
+
+## Integrating with CI
+
+Configure these parameters in your Continuous Integration platform to run your tests directly on BrowserStack
+
+```
+//Required
+RUN_ON_BSTACK - Boolean. To run your tests on BrowserStack
+BROWSERSTACK_USERNAME - your BrowserStack username
+BROWSERSTACK_ACCESS_KEY - your BrowserStack accesskey
+
+//Optional
+BSTACK_LOCAL - Boolean. Whether to start/stop BrowserStackLocal for your tests
+```
+
+## Further Reading
+* [BrowerStack Automate documentation for Cucumber](https://www.browserstack.com/automate/cucumber-integration)
+* [BrowserStack Automate documentation for Ruby](https://www.browserstack.com/automate/ruby)
+* [Full range of testing capabilities on BrowserStack](https://www.browserstack.com/automate/capabilities)
+* [Testing local, development servers with BrowserStack](https://www.browserstack.com/local-testing)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+task :default => :spec
+task :spec => [:cucumber]
+
+task :cucumber do
+  Bundler.with_clean_env do
+    system("bundle install") 
+    system("cd tests/cucumber && bundle install && bundle exec appraisal install && BSTACK_BUILD=BrowserStackPatchCucumberTest RUN_ON_BSTACK=true bundle exec appraisal cucumber")
+  end
+end

data/browserstack.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'browserstack-automate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "browserstack-automate"
+  spec.version       = Browserstack::VERSION
+  spec.authors       = [ "BrowserStack Support" ]
+  spec.email         = [ "support@browserstack.com" ]
+
+  spec.description   = %q{Run Cucumber tests on BrowserStack Automate using our Ruby integration.}
+  spec.summary       = %q{Run Cucumber tests on BrowserStack Automate using our Ruby integration.}
+  spec.homepage      = "https://www.browserstack.com"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "selenium-webdriver"
+  spec.add_dependency "browserstack-local", "~> 1.2"
+  spec.add_dependency "curb", '~> 0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "appraisal", '~> 0'
+end

data/examples/cucumber/Gemfile

@@ -0,0 +1,8 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+# gem "rails"
+
+gem "cucumber", '2.4.0'
+gem "selenium-webdriver", "2.53.0"
+gem "browserstack-automate", path: "../../"

data/examples/cucumber/features/google.feature

@@ -0,0 +1,9 @@
+Feature: Google can search
+
+Background:
+  Given I am on Google
+
+Scenario: Search for a term
+  When I fill in "q" found by "name" with "BrowserStack"
+  And I submit
+  Then I should see title "BrowserStack - Google Search"

data/examples/cucumber/features/step_definitions/google_steps.rb

@@ -0,0 +1,17 @@
+Given /^I am on (.+)$/ do |url|
+  @browser.navigate.to "http://www.google.com/ncr"
+end
+
+When /^I fill in "([^"]*)" found by "([^\"]*)" with "([^\"]*)"$/ do |value, type, keys|
+  @element = @browser.find_element(type, value)
+  @element.send_keys keys
+end
+
+When /^I submit$/ do
+  @element.submit
+  sleep 5
+end
+
+Then /^I should see title "([^\"]*)"$/ do |title|
+  raise "Fail" if @browser.title != title
+end

data/examples/cucumber/features/support/env.rb

@@ -0,0 +1,14 @@
+require 'selenium/webdriver'
+
+require 'browserstack-automate'
+BrowserStack.for "cucumber"
+
+browser = Selenium::WebDriver.for :firefox
+
+Before do |scenario|
+  @browser = browser
+end
+
+at_exit do
+  browser.quit
+end

data/examples/simple_sample/Gemfile

@@ -0,0 +1,7 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+# gem "rails"
+
+gem "selenium-webdriver", "~> 3.0.1"
+gem "browserstack-automate", path: "../../"

data/examples/simple_sample/sample.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'selenium-webdriver'
+require 'browserstack-automate'
+
+BrowserStack.for "ruby"
+
+@repeat = ENV['REPEAT'] || 5
+
+# Input capabilities
+driver = Selenium::WebDriver.for :firefox
+
+begin
+  driver.navigate.to "http://www.google.com"
+  element = driver.find_element(:name, 'q')
+  element.send_keys "BrowserStack"
+  element.submit
+  start = Time.now.to_i
+  @repeat.times do
+    puts driver.title
+  end
+  driver.quit
+rescue
+  driver.quit
+end

data/lib/browserstack-automate.rb

@@ -0,0 +1,74 @@
+require 'selenium/webdriver'
+require 'browserstack/local'
+
+$cucumber_after = self.method(:After) rescue nil
+
+if ENV['RUN_ON_BSTACK'].to_s.match(/true/)
+  require_relative './browserstack-automate/webdriver_patch.rb'
+  
+  # See: https://github.com/SeleniumHQ/selenium/issues/2950
+  require_relative './browserstack-automate/keep_alive_patch.rb' unless Gem.loaded_specs["selenium-webdriver"].version.to_s.start_with?("3")
+end
+
+module BrowserStack
+  @@framework = 'rubyFramework'
+  @@bs_local = nil
+  @@bstack_identifier = "bstack_patches_#{(0...16).map { ('a'..'z').to_a[rand(26)] }.join}"
+
+  def self.for(framework)
+    @@framework = framework
+  end
+
+  def self.get_framework
+    @@framework
+  end
+
+  def self.get_framework_version
+    if @@framework.match(/cucumber/i)
+      return Cucumber::VERSION
+    end
+  end
+
+  def self.get_identifier
+    @@bstack_identifier
+  end
+
+  def self.track_environment(track_hash)
+    if ENV['TRAVIS'] && ENV['TRAVIS'].match(/true/i)
+      track_hash['ci_env'] = 'travis'
+      track_hash['ci_env.travis.build_id'] = ENV['TRAVIS_BUILD_ID']
+      track_hash['ci_env.travis.build_number'] = ENV['process.env.TRAVIS_BUILD_NUMBER']
+      track_hash['ci_env.travis.repo_slug'] = ENV['process.env.TRAVIS_REPO_SLUG']
+      track_hash['ci_env.travis.test_result'] = ENV['process.env.TRAVIS_TEST_RESULT']
+    elsif ENV['BUILD_TAG'] && ENV['BUILD_TAG'].match(/jenkins/i)
+      track_hash['ci_env'] = ENV['jenkins']
+      track_hash['ci_env.jenkins.build_id'] = ENV['process.env.BUILD_ID']
+      track_hash['ci_env.jenkins.build_number'] = ENV['process.env.BUILD_NUMBER']
+      track_hash['ci_env.jenkins.job_name'] = ENV['process.env.JOB_NAME']
+      track_hash['ci_env.jenkins.build_tag'] = ENV['process.env.BUILD_TAG']
+      track_hash['ci_env.jenkins.git_url'] = ENV['process.env.GIT_URL']
+    end
+  end
+
+  private
+  def self.start_local
+    @@bs_local = BrowserStack::Local.new
+    browserstack_access_key = ENV['BROWSERSTACK_ACCESS_KEY'] || ENV['BROWSERSTACK_ACCESSKEY']
+    bs_local_args = {
+      'key' => browserstack_access_key,
+      'localIdentifier' => @@bstack_identifier
+    }
+    @@bs_local.start(bs_local_args)
+
+    if @@framework.match(/cucumber/i)
+      $cucumber_after.call do
+        @@bs_local.stop() if @@bs_local
+      end
+    else
+      Signal.trap("EXIT") do
+        @@bs_local.stop if @@bs_local
+        Kernel.exit!
+      end
+    end
+  end
+end

data/lib/browserstack-automate/keep_alive_patch.rb

@@ -0,0 +1,18 @@
+require 'selenium/webdriver/remote/http/curb'
+
+module Selenium
+  module WebDriver
+    module Remote
+      class Bridge
+        attr_accessor :http_curb
+        def http
+          unless @http_curb
+            @http_curb = Http::Curb.new
+            @http_curb.server_url = @http.send(:server_url)
+          end
+          @http_curb
+        end
+      end # Bridge
+    end # Remote
+  end # WebDriver
+end # Selenium

data/lib/browserstack-automate/version.rb

@@ -0,0 +1,3 @@
+module Browserstack
+  VERSION = "0.1.0"
+end

data/lib/browserstack-automate/webdriver_patch.rb

@@ -0,0 +1,42 @@
+module Selenium
+  module WebDriver
+    class << self
+      alias_method :original_for, :for
+
+      def for(*args)
+        browser = args.shift
+        browser = nil if browser.to_s.downcase == 'remote'
+        opts = args.shift || {}
+        opts[:url] = opts[:url] || 'http://127.0.0.1:4444/wd/hub'
+        opts[:desired_capabilities] = opts[:desired_capabilities] || {}
+
+        opts[:desired_capabilities][:browserName] = ENV['BSTACK_BROWSER'] || browser || opts[:desired_capabilities][:browserName] || opts[:desired_capabilities][:browser]
+        opts[:desired_capabilities][:browser] = opts[:desired_capabilities][:browserName]
+        opts[:desired_capabilities][:browser_version] = ENV['BSTACK_BROWSER_VERSION']
+        opts[:desired_capabilities][:os] = ENV['BSTACK_OS']
+        opts[:desired_capabilities][:os_version] = ENV['BSTACK_OS_VERSION']
+        opts[:desired_capabilities][:device] = ENV['BSTACK_DEVICE']
+
+        if ENV['RUN_ON_BSTACK'] && ENV['RUN_ON_BSTACK'].match(/true/i)
+          browserstack_username = ENV['BROWSERSTACK_USERNAME'] || ENV['BROWSERSTACK_USER']
+          browserstack_access_key = ENV['BROWSERSTACK_ACCESS_KEY'] || ENV['BROWSERSTACK_ACCESSKEY']
+          opts[:url] = "https://#{browserstack_username}:#{browserstack_access_key}@hub.browserstack.com/wd/hub"
+
+          opts[:desired_capabilities]['browserstack.framework'] = BrowserStack::get_framework
+          opts[:desired_capabilities]['browserstack.framework_version'] = BrowserStack::get_framework_version
+          opts[:desired_capabilities]['build'] = ENV['BSTACK_BUILD'] if ENV['BSTACK_BUILD']
+          opts[:desired_capabilities]['project'] = ENV['BSTACK_PROJECT'] if ENV['BSTACK_PROJECT']
+          opts[:desired_capabilities]['name'] = ENV['BSTACK_NAME'] if ENV['BSTACK_NAME']
+          if ENV['BSTACK_LOCAL'] && ENV['BSTACK_LOCAL'].match(/true/i)
+            BrowserStack.start_local
+            opts[:desired_capabilities]['browserstack.local'] = true
+            opts[:desired_capabilities]['browserstack.localIdentifier'] = BrowserStack::get_identifier
+          end
+          BrowserStack::track_environment(opts[:desired_capabilities])
+        end
+
+        original_for(:remote, opts, *args)
+      end
+    end
+  end
+end

data/tests/cucumber/Appraisals

@@ -0,0 +1,19 @@
+appraise "cucumber-latest" do
+  gem "cucumber"
+end
+
+appraise "cucumber-2.4.0" do
+  gem "cucumber", "2.4.0"
+end
+
+appraise "cucumber-2.0.1" do
+  gem "cucumber", "2.0.1"
+end
+
+appraise "cucumber-1.3.20" do
+  gem "cucumber", "1.3.20"
+end
+
+appraise "cucumber-1.2.0" do
+  gem "cucumber", "1.2.0"
+end

data/tests/cucumber/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gem "appraisal"
+gem "browserstack-automate", path: "../../"

data/tests/cucumber/features/google.feature

@@ -0,0 +1,9 @@
+Feature: Google can search
+
+Background:
+  Given I am on Google
+
+Scenario: Search for a term
+  When I fill in "q" found by "name" with "BrowserStack"
+  And I submit
+  Then I should see title "BrowserStack - Google Search"

data/tests/cucumber/features/step_definitions/google_steps.rb

@@ -0,0 +1,17 @@
+Given /^I am on (.+)$/ do |url|
+  @browser.navigate.to "http://www.google.com/ncr"
+end
+
+When /^I fill in "([^"]*)" found by "([^\"]*)" with "([^\"]*)"$/ do |value, type, keys|
+  @element = @browser.find_element(type, value)
+  @element.send_keys keys
+end
+
+When /^I submit$/ do
+  @element.submit
+  sleep 5
+end
+
+Then /^I should see title "([^\"]*)"$/ do |title|
+  raise "Fail" if @browser.title != title
+end

data/tests/cucumber/features/support/env.rb

@@ -0,0 +1,25 @@
+require 'selenium/webdriver'
+require 'net/http'
+require 'json'
+
+require 'browserstack-automate'
+BrowserStack.for "cucumber"
+
+browser = Selenium::WebDriver.for :firefox
+
+Before do |scenario|
+  @browser = browser
+end
+
+at_exit do
+  sess_id = browser.session_id
+  browser.quit
+
+  url = URI("https://www.browserstack.com/automate/sessions/#{sess_id}.json")
+  Net::HTTP.start(url.host, url.port, :use_ssl => url.scheme == 'https') do |http|
+    request = Net::HTTP::Get.new url.request_uri
+    request.basic_auth ENV['BROWSERSTACK_USERNAME'], ENV['BROWSERSTACK_ACCESS_KEY']
+    response = http.request request
+    puts "Session status was not 'done'" && Kernel.exit!(1) if not JSON.parse(response.body)["automation_session"]["status"].match(/done/)
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: browserstack-automate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BrowserStack Support
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  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: browserstack-local
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: curb
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
+description: Run Cucumber tests on BrowserStack Automate using our Ruby integration.
+email:
+- support@browserstack.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- browserstack.gemspec
+- examples/cucumber/Gemfile
+- examples/cucumber/features/google.feature
+- examples/cucumber/features/step_definitions/google_steps.rb
+- examples/cucumber/features/support/env.rb
+- examples/simple_sample/Gemfile
+- examples/simple_sample/sample.rb
+- lib/browserstack-automate.rb
+- lib/browserstack-automate/keep_alive_patch.rb
+- lib/browserstack-automate/version.rb
+- lib/browserstack-automate/webdriver_patch.rb
+- tests/cucumber/Appraisals
+- tests/cucumber/Gemfile
+- tests/cucumber/features/google.feature
+- tests/cucumber/features/step_definitions/google_steps.rb
+- tests/cucumber/features/support/env.rb
+homepage: https://www.browserstack.com
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Run Cucumber tests on BrowserStack Automate using our Ruby integration.
+test_files: []