Parallel by default

Author: agarneha1331

Gemfile

@@ -7,3 +7,4 @@ gem 'rspec'
 gem 'browserstack-local'
 gem 'parallel_tests'
 gem 'browserstack-automate'
+gem 'rake'

Gemfile.lock

@@ -60,6 +60,7 @@ GEM
     rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
+    rake (13.0.6)
     regexp_parser (1.7.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -92,6 +93,7 @@ DEPENDENCIES
   capybara
   cucumber
   parallel_tests
+  rake
   rspec
   selenium-webdriver
 

README.md

@@ -3,43 +3,28 @@ cucumber-browserstack
 
 This repository provides information and helpful tweaks to run your Cucumber tests on the BrowserStack selenium cloud infrastructure.
 
-###Configuration
-Add the CapyBara, Cucumber gems into your Gemfile.
-Run `bundle install`.
-
-###Run tests
-To run the tests, execute:
-
-```bash
-cucumber BS_USERNAME=<username> BS_AUTHKEY=<access-key> SELENIUM_PLATFORM=<platform> SELENIUM_BROWSER=<browser-name>
-```
-or
-```bash
-cucumber BS_USERNAME=<username> BS_AUTHKEY=<access-key> BS_AUTOMATE_OS=<os> BS_AUTOMATE_OS_VERSION=<os-version> SELENIUM_BROWSER=<browser-name>
-```
-
-Examples:
-```bash
-cucumber BS_USERNAME=<username> BS_AUTHKEY=<access-key> SELENIUM_PLATFORM=WINDOWS SELENIUM_BROWSER=chrome
-```
-or
-```bash
-cucumber BS_USERNAME=<username> BS_AUTHKEY=<access-key> BS_AUTOMATE_OS="OS X" BS_AUTOMATE_OS_VERSION="Mojave" SELENIUM_BROWSER="chrome"
-```
+## Setup
+* Clone the repo
+* Install dependencies `bundle install`
+* To test various sample repositories with ease, it is recommended to setup `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` environment variables. Alternatively you can directly update `*.config.yml` files inside the `config/` directory with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings)
+
+### Running your tests
+* To run tests, run `bundle exec rake parallel`
+* To run local tests, run `bundle exec rake local`
+
+ Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
 
 Alternatively the variables can be set in the environment using env or your CI framework (like Travis or Jenkins)
 
 Notice that selenium driver.quit is not required for Capybara tests because Capybara implicitly does so.
 
 To run parallel tests use `parallel_cucumber`instead of cucumber. Add the option -n to specify the number of parallel processes. Add the parallel_tests gem in your Gemfile.
 
-To run local testing, set the capability `browserstack.local` in features/support/env.rb to true. 
+To run local testing, set the capability `browserstack.local` in config/local.config.yml to true. 
 
 ###Further Reading
 - [Cucumber](https://cucumber.io/)
 - [CapyBara](http://jnicklas.github.io/capybara/)
 - [BrowserStack documentation for Automate](https://www.browserstack.com/automate/ruby)
 
 Happy Testing!
-
-

Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'parallel'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:single) do |task|
+  ENV['CONFIG_NAME'] ||= 'single'
+  task.cucumber_opts = ['--format=pretty', 'features/sample.feature']
+end
+
+task default: :single
+
+Cucumber::Rake::Task.new(:local) do |task|
+  task.cucumber_opts = ['--format=pretty', 'features/sample.feature', 'CONFIG_NAME=local']
+end
+
+task :parallel do |_t, _args|
+  @num_parallel = 4
+
+  Parallel.map([*1..@num_parallel], in_processes: @num_parallel) do |task_id|
+    ENV['TASK_ID'] = (task_id - 1).to_s
+    ENV['name'] = 'parallel_test'
+    ENV['CONFIG_NAME'] = 'parallel'
+
+    Rake::Task['single'].invoke
+    Rake::Task['single'].reenable
+  end
+end
+
+task :test do |_t, _args|
+  Rake::Task['single'].invoke
+  Rake::Task['single'].reenable
+  Rake::Task['local'].invoke
+  Rake::Task['parallel'].invoke
+end

config/local.config.yml

@@ -0,0 +1,14 @@
+server: hub.browserstack.com
+user: BROWSERSTACK_USERNAME
+key: BROWSERSTACK_ACCESS_KEY
+
+common_caps:
+  build: browserstack-build-1
+  browserstack.debug: true
+  name: BStack local cucumber-ruby
+  browserstack.source: cucumber-ruby:sample-master:v1.1
+  
+
+browser_caps:
+- browser: chrome
+  browserstack.local: true

config/parallel.config.yml

@@ -0,0 +1,15 @@
+server: hub.browserstack.com
+user: BROWSERSTACK_USERNAME
+key: BROWSERSTACK_ACCESS_KEY
+
+common_caps:
+  build: browserstack-build-1
+  browserstack.debug: true
+  name: BStack parallel cucumber-ruby
+  browserstack.source: cucumber-ruby:sample-master:v1.1
+
+browser_caps:
+- browser: chrome
+- browser: firefox
+- browser: edge
+- browser: safari

config/single.config.yml

@@ -0,0 +1,12 @@
+server: hub.browserstack.com
+user: BROWSERSTACK_USERNAME
+key: BROWSERSTACK_ACCESS_KEY
+
+common_caps:
+  build: browserstack-build-1
+  browserstack.debug: true
+  name: BStack single cucumber-ruby
+  browserstack.source: cucumber-ruby:sample-master:v1.1
+
+browser_caps:
+- browser: chrome

features/sample_steps.rb features/step_definitions/sample_steps.rbfeatures/sample_steps.rb renamed to features/step_definitions/sample_steps.rb

@@ -1,43 +1,41 @@
+require 'yaml'
 require 'selenium/webdriver'
 require 'capybara/cucumber'
 require 'browserstack/local'
-require 'browserstack-automate'
-BrowserStack.for "cucumber"
 
-url = "https://#{ENV['BS_USERNAME']}:#{ENV['BS_AUTHKEY']}@hub.browserstack.com/wd/hub"
-
-Capybara.register_driver :browserstack do |app|
+# monkey patch to avoid reset sessions
+class Capybara::Selenium::Driver < Capybara::Driver::Base
+  def reset!
+    @browser.navigate.to('about:blank') if @browser
+  end
+end
 
-  capabilities = Selenium::WebDriver::Remote::Capabilities.new
-	if ENV['BS_AUTOMATE_OS']
-		capabilities['os'] = ENV['BS_AUTOMATE_OS']
-		capabilities['os_version'] = ENV['BS_AUTOMATE_OS_VERSION']
-	else
-		capabilities['platform'] = ENV['SELENIUM_PLATFORM'] || 'ANY'
-	end
+TASK_ID = (ENV['TASK_ID'] || 0).to_i
+CONFIG_NAME = ENV['CONFIG_NAME'] || 'single'
 
-	capabilities['browser'] = ENV['SELENIUM_BROWSER'] || 'chrome'
-	capabilities['browser_version'] = ENV['SELENIUM_VERSION'] if ENV['SELENIUM_VERSION']
-	capabilities['browserstack.debug'] = 'true'
-	capabilities['project'] = ENV['BS_AUTOMATE_PROJECT'] if ENV['BS_AUTOMATE_PROJECT']
-	capabilities['build'] = ENV['BS_AUTOMATE_BUILD']? ENV['BS_AUTOMATE_BUILD'] : 'browserstack-build-1'
-  capabilities['browserstack.local'] = 'false'
-  capabilities['browserstack.source'] = 'cucumber-ruby:sample-master:v1.0'     
+CONFIG = YAML.safe_load(File.read(File.join(File.dirname(__FILE__), "../../config/#{CONFIG_NAME}.config.yml")))
+CONFIG['user'] = ENV['BROWSERSTACK_USERNAME'] || CONFIG['user']
+CONFIG['key'] = ENV['BROWSERSTACK_ACCESS_KEY'] || CONFIG['key']
 
-  if capabilities['browserstack.local'] && capabilities['browserstack.local'] == 'true';
+Capybara.register_driver :browserstack do |app|
+  @caps = CONFIG['common_caps'].merge(CONFIG['browser_caps'][TASK_ID])
+  # Code to start browserstack local before start of test
+  if @caps['browserstack.local'] && @caps['browserstack.local'].to_s == 'true'
     @bs_local = BrowserStack::Local.new
-    bs_local_args = { "key" => "#{ENV['BS_AUTHKEY']}", "forcelocal" => true }
+    bs_local_args = { 'key' => (CONFIG['key']).to_s }
     @bs_local.start(bs_local_args)
   end
-  Capybara::Selenium::Driver.new(app, :browser => :remote, :url => url, :desired_capabilities => capabilities)
-
 
+  Capybara::Selenium::Driver.new(app,
+                                 browser: :remote,
+                                 url: "https://#{CONFIG['user']}:#{CONFIG['key']}@#{CONFIG['server']}/wd/hub",
+                                 desired_capabilities: @caps)
 end
 
 Capybara.default_driver = :browserstack
-Capybara.app_host = "http://www.google.com"
 Capybara.run_server = false
 
+# Code to stop browserstack local after end of test
 at_exit do
-  @bs_local.stop unless @bs_local.nil? 
+  @bs_local.stop unless @bs_local.nil?
 end