rainforest_ruby_runtime 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d12bd4da6f90002d9083b6b02f4a35fce42df209
-  data.tar.gz: caabdbef344fb27cf6e0cede1b9209ce66db6579
+  metadata.gz: 1504bf22a8dea19e857d7b408594412e1151a9ab
+  data.tar.gz: cfabcb8af8b10d8588fa570e61c1f725ae8b64aa
 SHA512:
-  metadata.gz: 90c4ddf50e7eba5665186c1eed38dcc1b950792e9e701a339deb78fa5824910c6567d5e3466372e2c1e5ce56f49d18e2a63f6228d6c5c567d23495e563ee4422
-  data.tar.gz: 2d2fe0da4b72fe4ecde81800131b3cabb4270c3a9f126c067c1178625987655a7d3c84f1e97a9d343d96c5472d1995c6a206207890957c41b66952a692386ec0
+  metadata.gz: 645ff7563f78bbd339f732588e2507af95c2b14389d0ab88a143491aaf652e6200770ea92163526d4b7cac92ecb7f4169fa170e0f308ec77c9bb03dad4c588b2
+  data.tar.gz: f5ef4ce3ad10defe54167650b16b95616ee355a929d45b3dc5317215923da9b58943647b9e34a17609134886a25b0bb47cc12127408415e79a4c7fe5b7d13563

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2
+jobs:
+  test:
+    docker:
+      - image: circleci/ruby:2.4.4
+        environment:
+          RUNTIME_ENV: test
+    steps:
+      - checkout
+      - run:
+          name: Install Ruby gems
+          command: |
+            bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+      - run:
+          name: Set up test output directory
+          command: sudo install -o circleci -d ~/rspec
+      - run:
+          name: RSpec
+          command: |
+            bundle exec rspec \
+              --color \
+              --require spec_helper \
+              --format documentation \
+              --format RspecJunitFormatter \
+              --out ~/rspec/rspec.xml \
+              $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings --timings-type=filename)
+      - store_artifacts:
+          path: ~/rspec
+      - store_test_results:
+          path: ~/rspec
+workflows:
+  version: 2
+  test_build:
+    jobs:
+      - test

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 tags
+vendor/sauce/sc

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+2.4.4

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 0.1.0 - 2018-04-13
+
+- Support multiple browsers with `--browsers` param
+- Change default browser to `chrome` (used to be `firefox`)
+- Support running multiple scripts at once
+- Use RSpec for running scripts and displaying results
+- Remove support for BrowserStack and TestingBot
+- Remove support for IE 8, 9, and 10 on SauceLabs
+- Update browser versions on SauceLabs, add Microsoft Edge
+- Add changelog

data/Gemfile

@@ -1,10 +1,5 @@
 source 'https://rubygems.org'
-ruby '2.3.3'
+ruby '2.4.4'
 
 # Specify your gem's dependencies in rainforest_ruby_runtime.gemspec
 gemspec
-
-gem 'pry'
-gem 'awesome_print'
-gem 'm', '~> 1.5.0'
-gem 'minitest', '~> 5.10.0'

data/README.md

@@ -1,6 +1,6 @@
 # Rainforest Ruby Runtime
 
-[![Build Status](https://travis-ci.org/rainforestapp/rainforest_ruby_runtime.svg)](https://travis-ci.org/rainforestapp/rainforest_ruby_runtime)
+[![CircleCI](https://circleci.com/gh/rainforestapp/rainforest_ruby_runtime/tree/master.svg?style=svg)](https://circleci.com/gh/rainforestapp/rainforest_ruby_runtime/tree/master)
 
 Gem to run Rainforest Automated Tests locally or on Sauce Labs.
 
@@ -18,15 +18,155 @@ Or install it yourself as:
 
     $ gem install rainforest_ruby_runtime
 
+### Installing from source
+
+    $ git clone git@github.com:rainforestapp/rainforest_ruby_runtime.git
+    $ gem build
+    $ gem install
+
 ## Usage
 
+To run the tests on Sauce Labs, first run `rainforest_test --prepare-sauce`, and then set the following environment variables:
+
+- `CAPYBARA_DRIVER=sauce`
+- `SAUCE_USERNAME=<your username>`
+- `SAUCE_ACCESS_KEY=<your access key>`
+
 You can then run the tests using the following command:
 ```
 bundle exec rainforest_test <test-file.rb>
 ```
 
-To run the tests on Sauce Labs you should set the `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables.
+Rainforest Ruby Runtime supports test runs on Sauce Labs against Chrome, Firefox, IE, Edge, and Safari.
+
+By default, your tests will run against Chrome. You can run one or more test scripts against multiple browsers with the following configuration:
+
+```
+bundle exec rainforest_test --browsers firefox,chrome,edge <test-file.rb>,<test-file1.rb>
+```
+## Validate failed test results on Rainforest
+
+To run the associated Rainforest tests for any failed Selenium tests, follow these steps:
+
+*Step 1:* Download your test scripts from Rainforest, then run your automated tests on Sauce labs per the instructions above
+
+*Step 2:* Determine the number of results you need to return with the following calculation:
+
+```
+limit = number of scripts run * number of browsers selected
+```
+
+*Step 3:* Request the results from your last test run
+
+You can find detailed instructions for making requests to Sauce Labs [here](https://wiki.saucelabs.com/display/DOCS/Job+Methods)
+
+> NOTE: It's very important that no other users are executing tests concurrently. Your limit calculation may not include the proper results if other users are running tests at the same time.
+
+Sample Response:
+
+```ruby
+[
+   {
+    "browser_short_version"=>"35",
+    "video_url"=>"https://saucelabs.com/jobs/1234567890/video.flv",
+    "creation_time"=>12345678890,
+    "custom-data"=>nil,
+    "browser_version"=>"35.0.1916.114.",
+    "owner"=>"YOURUSERNAME",
+    "id"=>"12a34e56i78o90u",
+    "record_screenshots"=>true,
+    "record_video"=>true,
+    "build"=>nil,
+    "passed"=>false,
+    "public"=>"team",
+    "end_time"=>12345678900,
+    "status"=>"complete",
+    "log_url"=>"https://saucelabs.com/jobs/1234567890/selenium-server.log",
+    "start_time"=>1234567890,
+    "proxied"=>true,
+    "modification_time"=>12345678900,
+    "tags"=>[],
+    "name"=>"Rainforest [1]",
+    "commands_not_successful"=>1,
+    "consolidated_status"=>"failed",
+    "assigned_tunnel_id"=>"tunn1234567890ellll",
+    "error"=>nil,
+    "os"=>"Windows 2008",
+    "breakpointed"=>nil,
+    "browser"=>"googlechrome"
+    }
+]
+```
+
+Filter your response array to include only failed results; `"passed" => false`.
+
+*Step 4:* Extract required properties to re-run tests on Rainforest
+
+The response for each result will include the browser, and the test ID, as the number within brackets in the `name` value.
+Extract test information from the filtered results object:
+
+Example results hash:
+```
+{"123"=>["ie11_1440_900", "windows10_edge"]}
+```
+
+*Step 5:* Run tests in Rainforest to verify the failed tests
+
+Use Rainforest's CLI to Rainforest tests by ID against the failed broswers.
+
+Example script to help you write yours:
 
+```ruby
+# Run your Rainforest scripts against Sauce Labs
+bundle exec rainforest_test <test-file.rb>,<test-file1.rb>,<test-file2.rb> --browsers firefox,chrome,edge
+
+# Calculate results limit, set environment info
+limit = <automation script count> * <browser count> # replace placeholders with values for each run
+username = ENV['SAUCE_USERNAME']
+access_key = ENV['SAUCE_ACCESS_KEY']
+
+# Make request to sauce labs
+uri = URI("https://saucelabs.com/rest/v1/#{username}/jobs?limit=#{limit}&full=true")
+resp = Net::HTTP.start(uri.host, uri.port, :use_ssl => 'https') do |http|
+  req = Net::HTTP::Get.new uri
+  req.basic_auth username, access_key
+  http.request req
+end
+
+# Parse response
+tests = JSON.parse(resp.body)
+tests = example
+
+# Filter for only failed tests
+failed_tests = tests.select do |test|
+  test['passed'] == false
+end
+
+# Mapping from Sauce browser name to Rainforest browser name
+rf_browsers = {
+  'googlechrome' => 'chrome_1440_900',
+  'firefox' => 'firefox_1440_900',
+  'iexplore' => 'ie11_1440_900',
+  'microsoftedge' => 'windows10_edge',
+  'safari' => 'safari_1440_900',
+}
+
+# Find Rainforest test id from name in format "Some Name [1234]"
+results = {}
+failed_tests.each do |test|
+  name = test['name']
+  id = name[/^Rainforest \[(\d+)\]/]
+  next unless id
+
+  results[id] ||= []
+  results[id].push(rf_browsers[test['browser']])
+end
+
+# Execute rainforest cli once per test id
+results.each do |test_id, browsers|
+  system("rainforest run #{test_id} --browsers #{browsers.join(',')}")
+end
+```
 ## Contributing
 
 1. Fork it ( https://github.com/rainforestapp/rainforest_ruby_runtime/fork )

data/Rakefile

@@ -1,9 +1,30 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'fileutils'
+require 'open-uri'
 
-require 'rake/testtask'
+GITHUB_REPO = 'https://raw.githubusercontent.com/rainforestapp/rainforest_ruby_runtime'
 
-Rake::TestTask.new do |t|
-  t.pattern = "test/**/*_test.rb"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  ENV['CAPYBARA_DRIVER'] = 'selenium'
+  t.rspec_opts = '--color --format documentation'
 end
 
-task :default => [:test]
+task :prepare_sauce do
+  sc =
+    case RUBY_PLATFORM
+    when /cygwin|mswin|mingw|bccwin|wince|emx/ then 'sc-windows.exe'
+    when /darwin/ then 'sc-osx'
+    else 'sc-linux'
+    end
+
+  FileUtils.mkdir_p('vendor/sauce')
+  url = "#{GITHUB_REPO}/v#{RainforestRubyRuntime::VERSION}/vendor/sauce/#{sc}"
+
+  File.open('vendor/sauce/sc', 'wb') do |file|
+    IO.copy_stream(open(url), file)
+    file.chmod(0755)
+  end
+end
+
+task :default => [:spec]

data/bin/rainforest_test

@@ -3,6 +3,51 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "../lib")
 require 'rainforest_ruby_runtime'
 
-RainforestRubyRuntime::Runner.new(browsers: %w(firefox)).run ARGF.read
+def prepare_sauce
+  require 'rake'
 
-puts "Your test completed successfuly!"
+  gem_dir = __dir__
+  pwd = Dir.pwd
+
+  Dir.chdir(gem_dir)
+
+  Rake.application.init('rake', '-s')
+  Rake.application.load_rakefile
+  Rake.application[:prepare_sauce].invoke
+
+  Dir.chdir(pwd)
+end
+
+options = {browsers: %i(chrome)}
+OptionParser.new do |opts|
+  opts.banner = "Usage: ruby rainforest_test [options] [file_paths]"
+
+  opts.on('--prepare-sauce', 'Sets up the Sauce Connect executable') do
+    prepare_sauce
+    puts 'Sauce Connect executable properly set up'
+    exit
+  end
+
+  opts.on('--browsers X,Y,Z', Array, 'Browsers') do |browsers|
+    invalid_browsers = browsers - RainforestRubyRuntime::Runner::BROWSERS
+    raise OptionParser::InvalidOption, "#{invalid_browsers.join(',')}" unless invalid_browsers.empty?
+    options[:browsers] = browsers.uniq.map(&:to_sym)
+  end
+  opts.on('-h', '--help', 'Displays Help') do
+		puts opts
+		exit
+	end
+end.parse!
+
+puts "Running against #{options[:browsers].join(',')}"
+
+tests = []
+while f = ARGF.file do
+  break if f.closed?
+  tests << ARGF.read(f.size)
+  ARGF.skip
+end
+
+RainforestRubyRuntime::Runner.new(browsers: options[:browsers]).run(tests)
+
+puts "Your test completed successfully!"

data/lib/rainforest_ruby_runtime.rb

@@ -1,7 +1,5 @@
 require "sauce"
 require "sauce/capybara"
-require "testingbot"
-require "testingbot/capybara"
 require "rspec/expectations"
 require "logger"
 
@@ -13,12 +11,13 @@ require "rainforest_ruby_runtime/nil_delegator"
 require "rainforest_ruby_runtime/dsl"
 require "rainforest_ruby_runtime/runner"
 require "rainforest_ruby_runtime/drivers/sauce"
-require "rainforest_ruby_runtime/drivers/browser_stack"
-require "rainforest_ruby_runtime/drivers/testing_bot"
 require "rainforest_ruby_runtime/drivers/selenium"
 require "rainforest_ruby_runtime/variables/value"
-require "rainforest_ruby_runtime/variables/registery"
+require "rainforest_ruby_runtime/variables/registry"
 require "rainforest_ruby_runtime/variables/scope"
 
 module RainforestRubyRuntime
+  def self.root
+    File.dirname(__dir__)
+  end
 end

data/lib/rainforest_ruby_runtime/drivers/sauce.rb

@@ -7,28 +7,39 @@ module RainforestRubyRuntime
         @options = options
       end
 
-      def call
-        ::Sauce.config do |c|
-          c[:browsers] = browsers
+      def to_rspec(tests)
+        apply_config
+
+        RSpec.describe 'Rainforest', sauce: true, tests: tests do
+          metadata[:tests].each do |test|
+            it "[#{test.id}] #{test.title}" do
+              test.run
+            end
+          end
         end
       end
 
       private
 
+      def apply_config
+        ::Sauce.config do |c|
+          c[:browsers] = browsers
+          c[:sauce_connect_4_executable] = File.join(RainforestRubyRuntime.root, '/vendor/sauce/sc')
+          c[:start_local_application] = false
+        end
+      end
+
       def browsers
         Array(options[:browsers]).map do |browser|
           {
-            'ie8' => ["Windows 7", "Internet Explorer", "8"],
-            'ie9' => ["Windows 7", "Internet Explorer", "9"],
-            'ie10' => ["Windows 7", "Internet Explorer", "10"],
-            'ie11' => ["Windows 7", "Internet Explorer", "11"],
-            'chrome' => ["Windows 7", "Chrome", "35"],
-            'firefox' => ["Windows 7", "Firefox", "30"],
-            'safari' => ["Mavericks", "Safari", "7"],
+            chrome: ['Windows 7', 'Chrome', 'latest'],
+            firefox: ['Windows 7', 'Firefox', 'latest'],
+            ie: ['Windows 7', 'Internet Explorer', 'latest'],
+            edge: ['Windows 10', 'microsoftedge', 'latest'],
+            safari: ['Mac 10.11', 'Safari', 'latest'],
           }.fetch(browser)
         end
       end
     end
   end
 end
-

data/lib/rainforest_ruby_runtime/drivers/selenium.rb

@@ -1,14 +1,44 @@
 module RainforestRubyRuntime
   module Drivers
     class Selenium
+      attr_reader :browsers
+
       def initialize(options)
-        @options = options
+        @browsers = options[:browsers]
+      end
+
+      def to_rspec(tests)
+        RSpec.describe 'Rainforest', tests: tests, browsers: browsers do
+          metadata[:tests].each do |test|
+            describe "[#{test.id}] #{test.title}" do
+              metadata[:browsers].each do |browser|
+                let(:current_driver) { Capybara.current_session.driver }
+
+                after do
+                  if current_driver.respond_to?(:finish!)
+                    current_driver.finish!
+                  elsif current_driver.respond_to?(:quit)
+                    current_driver.quit
+                  end
+                end
+
+                specify browser do
+                  # for whatever reason, this line no longer works if put in a `before` block
+                  current_driver.options[:browser] = browser
+
+                  test.run
+                end
+              end
+            end
+          end
+        end
       end
 
-      def call
-        # No configuration
+      private
+
+      def current_driver
+        Capybara.current_session.driver
       end
     end
   end
 end
-