rainforest-cli 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a4d51888c0d3ce1b8845532734aa59145159b2f
-  data.tar.gz: 49d5541c943fc62aca7dbd5c173823cf6c64743c
+  metadata.gz: 04fa2b25294be20d03d2c6f41b74d19d806b0fe5
+  data.tar.gz: 5fe743cb8e0fae9c345c191d1e01f73705e3c24a
 SHA512:
-  metadata.gz: 8f8479a400d1d88eaf84e0eeb584a1e6a8e56590e89b628cfbd9cb8c0126cc4b6b0e64c4ff9c8427f31d6f79795ad2a43abd5b27c03a10232fdc3481dd77c1a4
-  data.tar.gz: 1e1337f1e45e4b5131e612d0bea3fef8d01686ea043af10d7deb2d5d76baf79a13d6a558773619ace488f8f7acbb01ae5b3090d5aeac968f5c9e54494e610888
+  metadata.gz: 3bc25ec6f023a5d1078538d7368552a970a0079652bb04bfd20c9f5e9237b2d707a3ae88eb51ed82df87ed3188b8d921464adb0dcaf6a23f663b510156a75d2d
+  data.tar.gz: 510f8eff35dddb1f889e3afa2db044fc393db312d89bcbf22ea1db330bf1a03286fb9bdc3c8baf2280aba0bb7d4d4a9f4a44d6a99161ce92aae91161887045ae

data/.gitignore

@@ -16,6 +16,8 @@ test/tmp
 test/version_tmp
 tmp
 tags
+.byebug_history
 
 *.csv
 spec/rainforest
+spec/rainforest-testing

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  rf-stylez: ruby/rubocop.yml
+
+Style/FileName:
+  Exclude: [rainforest-cli.gemspec]

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Rainforest CLI Changelog
 
+## 1.2.1 - 18th March 2016
+- Fixed a bug where uploading was stuck in an infinite loop if an embedded id did not exist (7b02b2f66dbd47098a7c1d5f79bc60a0cbe8984f, @epaulet)
+- Fixed a bug that occurred when specifying a nested test folder without creating parent folders first (6c1b0e02c858f9d9c264e771f964b3e1a4ea8c7e, @epaulet)
+- Removed 'ro' tag and use 'rainforest-cli' as the test's source instead.
+(10864a7e054d4c869f6a345608b2d1c1c0925fe8, @epaulet)
+- Add retries on API calls so that minor interruptions do not cancel Rainforest builds.
+(98021337a3fbbf16c7cd858bbec5d925fb86c939, @epaulet)
+
 ## 1.2.0 - 8th February 2016
 - Add support for embedded tests.
 - Add support for customizable RFML ids.

data/Gemfile

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rainforest-cli.gemspec
 gemspec
 
+gem 'rf-stylez'
+gem 'circlemator', require: false
+
 group :test do
-  gem "rspec", "2.14"
+  gem 'rspec', '~> 3.4.0'
+  gem 'rspec-its', '~> 1.2.0'
+  gem 'byebug'
 end

data/README.md

@@ -1,5 +1,7 @@
 [![Build Status](https://travis-ci.org/rainforestapp/rainforest-cli.png?branch=master)](https://travis-ci.org/rainforestapp/rainforest-cli)
 
+[![Gem Version](https://badge.fury.io/rb/rainforest-cli.svg)](https://badge.fury.io/rb/rainforest-cli)
+
 # Rainforest-cli
 
 A command line interface to interact with RainforestQA.

data/Rakefile

@@ -1,11 +1,13 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
 
 begin
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new(:spec)
 
-  task :default => :spec
-rescue LoadError
+  task default: :spec
+rescue LoadError => e
+  puts e.message
+  exit
 end
-

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  pre:
+    - bundle exec circlemator style-check --base-branch=master

data/lib/rainforest/cli.rb

@@ -1,16 +1,20 @@
-require "rainforest/cli/version"
-require "rainforest/cli/options"
-require "rainforest/cli/runner"
-require "rainforest/cli/http_client"
-require "rainforest/cli/git_trigger"
-require "rainforest/cli/csv_importer"
-require "rainforest/cli/test_parser"
-require "rainforest/cli/test_files"
-require "rainforest/cli/test_importer"
-require "erb"
-require "httparty"
-require "json"
-require "logger"
+# frozen_string_literal: true
+require 'erb'
+require 'json'
+require 'logger'
+require 'rainforest/cli/version'
+require 'rainforest/cli/constants'
+require 'rainforest/cli/options'
+require 'rainforest/cli/runner'
+require 'rainforest/cli/http_client'
+require 'rainforest/cli/git_trigger'
+require 'rainforest/cli/csv_importer'
+require 'rainforest/cli/test_parser'
+require 'rainforest/cli/test_files'
+require 'rainforest/cli/remote_tests'
+require 'rainforest/cli/validator'
+require 'rainforest/cli/test_importer'
+require 'rainforest/cli/uploader'
 
 module RainforestCli
   def self.start(args)
@@ -32,16 +36,16 @@ module RainforestCli
       t = TestImporter.new(options)
       t.create_new
     when 'validate'
-      t = TestImporter.new(options)
+      t = Validator.new(options)
       t.validate
     when 'upload'
-      t = TestImporter.new(options)
+      t = Uploader.new(options)
       t.upload
     when 'export'
       t = TestImporter.new(options)
       t.export
     else
-      logger.fatal "Unknown command"
+      logger.fatal 'Unknown command'
       exit 2
     end
 

data/lib/rainforest/cli/constants.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module RainforestCli
+  THREADS = 32
+end

data/lib/rainforest/cli/csv_importer.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 require 'csv'
-require 'httparty'
 require 'parallel'
 require 'ruby-progressbar'
 
@@ -28,21 +28,21 @@ module RainforestCli
       columns = rows.shift.map do |column|
         {name: column.downcase.strip.gsub(/\s/, '_')}
       end
-      raise 'Invalid schema in CSV. You must include headers in first row.' if not columns
+      raise 'Invalid schema in CSV. You must include headers in first row.' if !columns
 
-      print "Creating custom step variable"
-      response = client.post "/generators", { name: @generator_name, description: @generator_name, columns: columns }
+      print 'Creating custom step variable'
+      response = client.post '/generators', { name: @generator_name, description: @generator_name, columns: columns }
       raise "Error creating custom step variable: #{response['error']}" if response['error']
       puts "\t[OK]"
 
       @columns = response['columns']
       @generator_id = response['id']
 
-      puts "Uploading data..."
+      puts 'Uploading data...'
       p = ProgressBar.create(title: 'Rows', total: rows.count, format: '%a %B %p%% %t')
 
       # Insert the data
-      Parallel.each(rows, in_threads: 16, finish: lambda { |item, i, result| p.increment }) do |row|
+      Parallel.each(rows, in_threads: 16, finish: lambda { |_item, _i, _result| p.increment }) do |row|
         response = client.post("/generators/#{@generator_id}/rows", {data: row_data(@columns, row)})
         raise response['error'] if response['error']
       end

data/lib/rainforest/cli/git_trigger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
 
 module RainforestCli
@@ -7,7 +8,7 @@ module RainforestCli
     end
 
     def self.extract_hashtags(commit_message)
-      commit_message.partition('@rainforest').last.scan(/#([\w_-]+)/).flatten.map {|s| s.gsub('#','') }
+      commit_message.partition('@rainforest').last.scan(/#([\w_-]+)/).flatten.map {|s| s.gsub('#', '') }
     end
 
     def self.last_commit_message

data/lib/rainforest/cli/http_client.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+require 'httparty'
+require 'http/exceptions'
+
 module RainforestCli
   class HttpClient
-    API_URL = ENV.fetch("RAINFOREST_API_URL") do
+    API_URL = ENV.fetch('RAINFOREST_API_URL') do
       'https://app.rainforestqa.com/api/1'
     end.freeze
+    RETRY_INTERVAL = 10
 
     def initialize(options)
       @token = options.fetch(:token)
@@ -28,29 +33,61 @@ module RainforestCli
       JSON.parse(response.body)
     end
 
-    def get(url, body = {})
-      response = HTTParty.get make_url(url), {
-        body: body,
-        headers: headers,
-        verify: false
-      }
+    def get(url, body = {}, retries_on_failures: false)
+      wrap_exceptions(retries_on_failures) do
+        response = HTTParty.get make_url(url), {
+          body: body,
+          headers: headers,
+          verify: false
+        }
 
-      if response.code == 200
-        JSON.parse(response.body)
-      else
-        nil
+        if response.code == 200
+          return JSON.parse(response.body)
+        else
+          return nil
+        end
       end
     end
 
     private
+    def wrap_exceptions(retries_on_failures)
+      @retry_delay = 0
+      @waiting_on_retries = false
+      loop do
+        begin
+          # Suspend tries until wait period is over
+          if @waiting_on_retries
+            Kernel.sleep 5
+          else
+            Http::Exceptions.wrap_exception { yield }
+            break
+          end
+        rescue Http::Exceptions::HttpException, Timeout::Error => e
+          raise e unless retries_on_failures
+
+          unless @waiting_on_retries
+            @waiting_on_retries = true
+            @retry_delay += RETRY_INTERVAL
+
+            RainforestCli.logger.warn 'Exception Encountered while trying to contact Rainforest API:'
+            RainforestCli.logger.warn "\t\t#{e.message}"
+            RainforestCli.logger.warn "Retrying again in #{@retry_delay} seconds..."
+
+            Kernel.sleep @retry_delay
+            @waiting_on_retries = false
+          end
+        end
+      end
+    end
+
     def make_url(url)
       File.join(API_URL, url)
     end
 
     def headers
       {
-        "CLIENT_TOKEN" => @token,
-        "User-Agent" => "Rainforest-cli-#{RainforestCli::VERSION}"
+        'CLIENT_TOKEN' => @token,
+        'User-Agent' => "Rainforest-cli-#{RainforestCli::VERSION}"
       }
     end
   end

data/lib/rainforest/cli/options.rb

@@ -1,13 +1,7 @@
+# frozen_string_literal: true
 require 'optparse'
 
 module RainforestCli
-  class BrowserException < Exception
-    def initialize browsers
-      invalid_browsers = browsers - OptionParser::VALID_BROWSERS
-      super "#{invalid_browsers.join(', ')} is not valid. Valid browsers: #{OptionParser::VALID_BROWSERS.join(', ')}"
-    end
-  end
-
   class OptionParser
     attr_writer :file_name, :tags
     attr_reader :command, :token, :tags, :conflict, :browsers, :site_id, :environment_id,
@@ -16,92 +10,123 @@ module RainforestCli
 
     # Note, not all of these may be available to your account
     # also, we may remove this in the future.
-    VALID_BROWSERS = %w{android_phone_landscape android_phone_portrait android_tablet_landscape android_tablet_portrait chrome chrome_1440_900 chrome_adblock chrome_ghostery chrome_guru chrome_ublock firefox firefox_1440_900 ie10 ie10_1440_900 ie11 ie11_1440_900 ie8 ie8_1440_900 ie9 ie9_1440_900 ios_iphone4s office2010 office2013 osx_chrome osx_firefox safari ubuntu_chrome ubuntu_firefox}.freeze
+    VALID_BROWSERS = %w{
+      android_phone_landscape
+      android_phone_portrait
+      android_tablet_landscape
+      android_tablet_portrait
+      chrome
+      chrome_1440_900
+      chrome_adblock
+      chrome_ghostery
+      chrome_guru
+      chrome_ublock
+      firefox
+      firefox_1440_900
+      ie10
+      ie10_1440_900
+      ie11
+      ie11_1440_900
+      ie8
+      ie8_1440_900
+      ie9
+      ie9_1440_900
+      ios_iphone4s
+      office2010
+      office2013
+      osx_chrome
+      osx_firefox
+      safari
+      ubuntu_chrome
+      ubuntu_firefox
+    }.freeze
+    TOKEN_NOT_REQUIRED = %w{new validate}.freeze
 
     def initialize(args)
       @args = args.dup
       @tags = []
       @browsers = nil
-      @require_token = true
       @debug = false
 
+      # NOTE: Disabling line length cop to allow for consistency of syntax
+      # rubocop:disable Metrics/LineLength
       @parsed = ::OptionParser.new do |opts|
-        opts.on("--debug") do
+        opts.on('--debug') do
           @debug = true
         end
 
-        opts.on("--file") do |value|
+        opts.on('--file') do |value|
           @file_name = value
         end
 
-        opts.on("--test-folder spec/rainforest", "Specify the test folder. Defaults to spec/rainforest if not set.") do |value|
+        opts.on('--test-folder FILE_PATH', 'Specify the test folder. Defaults to spec/rainforest if not set.') do |value|
           @test_folder = value
         end
 
-        opts.on("--import-variable-csv-file FILE", "Import step variables; CSV data") do |value|
+        opts.on('--import-variable-csv-file FILE', 'Import step variables; CSV data') do |value|
           @import_file_name = value
         end
 
-        opts.on("--import-variable-name NAME", "Import step variables; Name of variable (note, will be replaced if exists)") do |value|
+        opts.on('--import-variable-name NAME', 'Import step variables; Name of variable (note, will be replaced if exists)') do |value|
           @import_name = value
         end
 
-        opts.on("--git-trigger", "Only run if the last commit contains @rainforestapp") do |value|
+        opts.on('--git-trigger', 'Only run if the last commit contains @rainforestapp') do |_value|
           @git_trigger = true
         end
 
-        opts.on("--fg", "Run the tests in foreground.") do |value|
+        opts.on('--fg', 'Run the tests in foreground.') do |value|
           @foreground = value
         end
 
-        opts.on("--fail-fast", String, "Fail as soon as there is a failure (don't wait for completion)") do |value|
+        opts.on('--fail-fast', String, "Fail as soon as there is a failure (don't wait for completion)") do |_value|
           @failfast = true
         end
 
-        opts.on("--token TOKEN", String, "Your rainforest API token.") do |value|
+        opts.on('--token API_TOKEN', String, 'Your rainforest API token.') do |value|
           @token = value
         end
 
-        opts.on("--tag TAG", String, "A tag to run the tests with") do |value|
+        opts.on('--tag TAG', String, 'A tag to run the tests with') do |value|
           @tags << value
         end
 
-        opts.on("--folder ID", "Run tests in the specified folders") do |value|
+        opts.on('--folder ID', 'Run tests in the specified folders') do |value|
           @folder = value
         end
 
-        opts.on("--browsers LIST", "Run against the specified browsers") do |value|
-          @browsers = value.split(',').map{|x| x.strip.downcase }.uniq
-
-          raise BrowserException, @browsers unless (@browsers - VALID_BROWSERS).empty?
+        opts.on('--browsers LIST', 'Run against the specified browsers') do |value|
+          @browsers = value.split(',').map {|x| x.strip.downcase }.uniq
         end
 
-        opts.on("--conflict MODE", String, "How should Rainforest handle existing in progress runs?") do |value|
+        opts.on('--conflict MODE', String, 'How should Rainforest handle existing in progress runs?') do |value|
           @conflict = value
         end
 
-        opts.on("--environment-id ID", Integer, "Run using this environment. If excluded, will use your default") do |value|
+        opts.on('--environment-id ID', Integer, 'Run using this environment. If excluded, will use your default') do |value|
           @environment_id = value
         end
 
-        opts.on("--site-id ID", Integer, "Only run tests for a specific site") do |value|
+        opts.on('--site-id ID', Integer, 'Only run tests for a specific site') do |value|
           @site_id = value
         end
 
-        opts.on("--custom-url URL", String, "Use a custom url for this run. You will need to specify a site_id too for this to work.") do |value|
+        opts.on('--custom-url URL', String, 'Use a custom url for this run. You will need to specify a site_id too for this to work.') do |value|
           @custom_url = value
         end
 
-        opts.on("--description DESCRIPTION", "Add a description for the run.") do |value|
+        opts.on('--description DESCRIPTION', 'Add a description for the run.') do |value|
           @description = value
         end
 
-        opts.on_tail("--help", "Display help message and exit") do |value|
+        opts.on_tail('--help', 'Display help message and exit') do |_value|
           puts opts
           exit 0
         end
 
       end.parse!(@args)
+      # rubocop:enable Metrics/LineLength
+      # NOTE: end Rubocop exception
 
       @command = @args.shift
 
@@ -110,10 +135,6 @@ module RainforestCli
       end
 
       @tests = @args.dup
-
-      # A couple of commands don't need the token
-      token_not_required = %w{new validate}
-      @require_token = false if token_not_required.include?(@command)
     end
 
     def tests
@@ -133,28 +154,39 @@ module RainforestCli
     end
 
     def validate!
-      if @require_token
+      if !TOKEN_NOT_REQUIRED.include?(command)
         unless token
-          raise ValidationError, "You must pass your API token using: --token TOKEN"
+          raise ValidationError, 'You must pass your API token using: --token TOKEN'
         end
       end
 
+      if browsers
+        raise BrowserException, browsers unless (browsers - VALID_BROWSERS).empty?
+      end
+
       if custom_url && site_id.nil?
-        raise ValidationError, "The site-id and custom-url options are both required."
+        raise ValidationError, 'The site-id and custom-url options are both required.'
       end
 
       if import_file_name && import_name
-        unless File.exists?(import_file_name)
+        unless File.exist?(import_file_name)
           raise ValidationError, "Input file: #{import_file_name} not found"
         end
 
       elsif import_file_name || import_name
-        raise ValidationError, "You must pass both --import-variable-csv-file and --import-variable-name"
+        raise ValidationError, 'You must pass both --import-variable-csv-file and --import-variable-name'
       end
       true
     end
 
     class ValidationError < RuntimeError
     end
+
+    class BrowserException < ValidationError
+      def initialize browsers
+        invalid_browsers = browsers - OptionParser::VALID_BROWSERS
+        super "#{invalid_browsers.join(', ')} is not valid. Valid browsers: #{OptionParser::VALID_BROWSERS.join(', ')}"
+      end
+    end
   end
 end