rainforest-cli 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40e961e73be70a98532715ed684c099be7123ee2
-  data.tar.gz: e9d7c1e437f736f86018c942c427d460214ba1e6
+  metadata.gz: 93bba481d733b42bc5f7f7fb501e931264c6e781
+  data.tar.gz: d4892987ecabb73e6fd9063e409052b54ac849e6
 SHA512:
-  metadata.gz: 2af94476bfdda2979af022be631c24185bc3fa55aef4e555574ca5e96ccbe3515eaa26739d4dc4685517faf45873897c91a328433a85bada8300eebe009661c6
-  data.tar.gz: f802da9550fd0821e5a265da33abe411047a28cea5c2e588fe7a2864cea4a07eafaaf82220c9c14226e048182c7b803de354ec5eece128c6b5f3911e3a7a0724
+  metadata.gz: 1e2b9375fef282917fd66997b4a11715740ea66de6420b8c6e8d1af452fe96cc09a59258bf363a3fda725024a70cc43952c29c51aaf4450d624a10581f91acbd
+  data.tar.gz: f829dfa712a368139bd81590fd47022f05b515bc7f3bb2aa4224854f3f1828b42f0f57027af21081dbe34a387a2691fd1d549426d2289e71871c2c6028c6d975

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 tags
 
 *.csv
+spec/rainforest

data/.rvmrc

@@ -1 +1 @@
-rvm use 2.2.0@rainforest-cli --create
+rvm use 2.3.0@rainforest-cli --create

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+  - 2.3.0
+  - 2.2.3
   - 2.1.2
   - 2.0.0
   - 1.9.3

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Rainforest CLI Changelog
 
+## 1.1.0 - 6th January 2016
+- Added support for tests stored in plain text format, so you can store them locally
+
 ## 1.0.5 - 25th August 2015
 - Added environment support (278f4fe9a1ca9f507fe1e4b11935d9c37056786b)
 

data/README.md

@@ -56,7 +56,8 @@ The most popular options are:
 - `--browsers ie8` or `--browsers ie8,chrome` - specficy the browsers you wish to run against. This overrides the test own settings. Valid browsers are ie8, ie9, chrome, firefox and safari.
 - `--tag run-me` - only run tests which have this tag (recommended if you have lots of [test-steps](http://docs.rainforestqa.com/pages/example-test-suite.html#test_steps))!)
 - `--site-id` - only run tests for a specific site. Get in touch with us for help on getting that you site id if you are unable to.
-- `--conflict abort` - if you trigger rainforest more than once, anything running will be aborted and a fresh run started
+- `--environment-id` - run your tests using this environment. Otherwise it will use your default environment
+- `--conflict OPTION` - use the `abort` option to abort any runs in progress in the same environment as your new run. use the `abort-all` option to abort all runs in progress.
 - `--fg` - results in the foreground - rainforest-cli will not return until the run is complete. This is what you want to make the build pass / fail dependent on rainforest results
 - `--fail-fast` - fail the build as soon as the first failed result comes in. If you don't pass this it will wait until 100% of the run is done. Use with `--fg`.
 - `--custom-url` - use a custom url for this run. Example use case: an ad-hoc QA environment with [Fourchette](https://github.com/rainforestapp/fourchette). You will need to specify a `site_id` too for this to work. Note that we will be creating a new environment for this particular run.

data/bin/rainforest

@@ -4,4 +4,4 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "../lib")
 
 require "rainforest/cli"
 
-Rainforest::Cli.start(ARGV)
+RainforestCli.start(ARGV)

data/lib/rainforest/cli.rb

@@ -4,36 +4,58 @@ require "rainforest/cli/runner"
 require "rainforest/cli/http_client"
 require "rainforest/cli/git_trigger"
 require "rainforest/cli/csv_importer"
+require "rainforest/cli/test_importer"
+require "rainforest/cli/test_parser"
 require "erb"
 require "httparty"
 require "json"
 require "logger"
 
-module Rainforest
-  module Cli
-    def self.start(args)
-      options = OptionParser.new(args)
-      OptionParser.new(['--help']) if args.size == 0
+module RainforestCli
+  def self.start(args)
+    options = OptionParser.new(args)
+    OptionParser.new(['--help']) if args.size == 0
 
-      begin
-        options.validate!
-      rescue OptionParser::ValidationError => e
-        logger.fatal e.message
-        exit 2
-      end
+    begin
+      options.validate!
+    rescue OptionParser::ValidationError => e
+      logger.fatal e.message
+      exit 2
+    end
 
+    case options.command
+    when 'run'
       runner = Runner.new(options)
       runner.run
+    when 'new'
+      t = TestImporter.new(options)
+      t.create_new
+    when 'validate'
+      t = TestImporter.new(options)
+      t.validate
+    when 'upload'
+      t = TestImporter.new(options)
+      t.upload
 
-      true
+      # options.tags = ['ro']
+      # runner = Runner.new(options)
+      # runner.run
+    when 'export'
+      t = TestImporter.new(options)
+      t.export
+    else
+      logger.fatal "Unknown command"
+      exit 2
     end
 
-    def self.logger
-      @logger ||= Logger.new(STDOUT)
-    end
+    true
+  end
 
-    def self.logger=(logger)
-      @logger = logger
-    end
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
   end
 end

data/lib/rainforest/cli/csv_importer.rb

@@ -4,49 +4,47 @@ require 'httparty'
 require 'parallel'
 require 'ruby-progressbar'
 
-module Rainforest
-  module Cli
-    class CSVImporter
-      attr_reader :client
-
-      def initialize name, file, token
-        @generator_name = name
-        @file = file
-        @client = HttpClient.new token: token
+module RainforestCli
+  class CSVImporter
+    attr_reader :client
+
+    def initialize name, file, token
+      @generator_name = name
+      @file = file
+      @client = HttpClient.new token: token
+    end
+
+    def row_data columns, values
+      Hash[(columns.map {|c| c['id']}).zip(values)]
+    end
+
+    def import
+      rows = []
+      CSV.foreach(@file, encoding: 'windows-1251:utf-8') do |row|
+        rows << row
       end
 
-      def row_data columns, values
-        Hash[(columns.map {|c| c['id']}).zip(values)]
+      # Create the generator
+      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
+
+      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..."
+      p = ProgressBar.create(title: 'Rows', total: rows.count, format: '%a %B %p%% %t')
 
-      def import
-        rows = []
-        CSV.foreach(@file, encoding: 'windows-1251:utf-8') do |row|
-          rows << row
-        end
-
-        # Create the generator
-        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
-
-        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..."
-        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|
-          response = client.post("/generators/#{@generator_id}/rows", {data: row_data(@columns, row)})
-          raise response['error'] if response['error']
-        end
+      # Insert the data
+      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
     end
   end

data/lib/rainforest/cli/git_trigger.rb

@@ -1,19 +1,17 @@
 require 'optparse'
 
-module Rainforest
-  module Cli
-    class GitTrigger
-      def self.git_trigger_should_run?(commit_message)
-        commit_message.include?('@rainforest')
-      end
+module RainforestCli
+  class GitTrigger
+    def self.git_trigger_should_run?(commit_message)
+      commit_message.include?('@rainforest')
+    end
 
-      def self.extract_hashtags(commit_message)
-        commit_message.scan(/#([\w_-]+)/).flatten.map {|s| s.gsub('#','') }
-      end
+    def self.extract_hashtags(commit_message)
+      commit_message.scan(/#([\w_-]+)/).flatten.map {|s| s.gsub('#','') }
+    end
 
-      def self.last_commit_message
-        `git log -1 --pretty=%B`.strip
-      end
+    def self.last_commit_message
+      `git log -1 --pretty=%B`.strip
     end
   end
 end

data/lib/rainforest/cli/http_client.rb

@@ -1,56 +1,57 @@
-module Rainforest
-  module Cli
-    class HttpClient
-      API_URL = ENV.fetch("RAINFOREST_API_URL") do
-        'https://app.rainforestqa.com/api/1'
-      end.freeze
-
-      def initialize(options)
-        @token = options.fetch(:token)
-      end
+module RainforestCli
+  class HttpClient
+    API_URL = ENV.fetch("RAINFOREST_API_URL") do
+      'https://app.rainforestqa.com/api/1'
+    end.freeze
+
+    def initialize(options)
+      @token = options.fetch(:token)
+    end
 
-      def delete(url, body = {})
-        response = HTTParty.delete make_url(url), {
-          body: body,
-          headers: headers,
-        }
+    def delete(url, body = {})
+      response = HTTParty.delete make_url(url), {
+        body: body,
+        headers: headers,
+        verify: false
+      }
 
-        JSON.parse(response.body)
-      end
+      JSON.parse(response.body)
+    end
 
-      def post(url, body = {})
-        response = HTTParty.post make_url(url), {
-          body: body,
-          headers: headers,
-        }
+    def post(url, body = {})
+      response = HTTParty.post make_url(url), {
+        body: body,
+        headers: headers,
+        verify: false
+      }
 
-        JSON.parse(response.body)
-      end
+      JSON.parse(response.body)
+    end
 
-      def get(url, body = {})
-        response = HTTParty.get make_url(url), {
-          body: body,
-          headers: headers,
-        }
-
-        if response.code == 200
-          JSON.parse(response.body)
-        else
-          nil
-        end
-      end
+    def get(url, body = {})
+      response = HTTParty.get make_url(url), {
+        body: body,
+        headers: headers,
+        verify: false
+      }
 
-      private
-      def make_url(url)
-        File.join(API_URL, url)
+      if response.code == 200
+        JSON.parse(response.body)
+      else
+        nil
       end
+    end
 
-      def headers
-        {
-          "CLIENT_TOKEN" => @token,
-          "User-Agent" => "Rainforest-cli-#{Rainforest::Cli::VERSION}"
-        }
-      end
+    private
+    def make_url(url)
+      File.join(API_URL, url)
+    end
+
+    def headers
+      {
+        "CLIENT_TOKEN" => @token,
+        "User-Agent" => "Rainforest-cli-#{RainforestCli::VERSION}"
+      }
     end
   end
 end

data/lib/rainforest/cli/options.rb

@@ -1,133 +1,154 @@
 require 'optparse'
 
-module Rainforest
-  module Cli
-    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
+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_reader :command, :token, :tags, :conflict, :browsers, :site_id, :environment_id,
-                  :import_file_name, :import_name, :custom_url, :description, :folder
+  class OptionParser
+    attr_writer :file_name, :tags
+    attr_reader :command, :token, :tags, :conflict, :browsers, :site_id, :environment_id,
+                :import_file_name, :import_name, :custom_url, :description, :folder,
+                :debug, :file_name
 
-      VALID_BROWSERS = %w{chrome firefox safari ie8 ie9}.freeze
+    VALID_BROWSERS = %w{chrome firefox safari ie8 ie9}.freeze
 
-      def initialize(args)
-        @args = args.dup
-        @tags = []
-        @browsers = nil
+    def initialize(args)
+      @args = args.dup
+      @tags = []
+      @browsers = nil
+      @require_token = true
+      @debug = false
 
-        @parsed = ::OptionParser.new do |opts|
-          opts.on("--import-variable-csv-file FILE", "Import step variables; CSV data") do |value|
-            @import_file_name = value
-          end
+      @parsed = ::OptionParser.new do |opts|
+        opts.on("--debug") do
+          @debug = true
+        end
 
-          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("--file") do |value|
+          @file_name = value
+        end
 
-          opts.on("--git-trigger", "Only run if the last commit contains @rainforestapp") do |value|
-            @git_trigger = true
-          end
+        opts.on("--import-variable-csv-file FILE", "Import step variables; CSV data") do |value|
+          @import_file_name = value
+        end
 
-          opts.on("--fg", "Run the tests in foreground.") do |value|
-            @foreground = value
-          end
+        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("--fail-fast", String, "Fail as soon as there is a failure (don't wait for completion)") do |value|
-            @failfast = true
-          end
+        opts.on("--git-trigger", "Only run if the last commit contains @rainforestapp") do |value|
+          @git_trigger = true
+        end
 
-          opts.on("--token TOKEN", String, "Your rainforest API token.") do |value|
-            @token = value
-          end
+        opts.on("--fg", "Run the tests in foreground.") do |value|
+          @foreground = value
+        end
 
-          opts.on("--tag TAG", String, "A tag to run the tests with") do |value|
-            @tags << value
-          end
+        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("--folder ID", "Run tests in the specified folders") do |value|
-            @folder = value
-          end
+        opts.on("--token TOKEN", String, "Your rainforest API token.") do |value|
+          @token = value
+        end
 
-          opts.on("--browsers LIST", "Run against the specified browsers") do |value|
-            @browsers = value.split(',').map{|x| x.strip.downcase }.uniq
+        opts.on("--tag TAG", String, "A tag to run the tests with") do |value|
+          @tags << value
+        end
 
-            raise BrowserException, @browsers unless (@browsers - VALID_BROWSERS).empty?
-          end
+        opts.on("--folder ID", "Run tests in the specified folders") do |value|
+          @folder = value
+        end
 
-          opts.on("--conflict MODE", String, "How should Rainforest handle existing in progress runs?") do |value|
-            @conflict = value
-          end
+        opts.on("--browsers LIST", "Run against the specified browsers") do |value|
+          @browsers = value.split(',').map{|x| x.strip.downcase }.uniq
 
-          opts.on("--environment-id ID", Integer, "Run using this environment. If excluded, will use your default") do |value|
-            @environment_id = value
-          end
+          raise BrowserException, @browsers unless (@browsers - VALID_BROWSERS).empty?
+        end
 
-          opts.on("--site-id ID", Integer, "Only run tests for a specific site") do |value|
-            @site_id = value
-          end
+        opts.on("--conflict MODE", String, "How should Rainforest handle existing in progress runs?") do |value|
+          @conflict = 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|
-            @custom_url = value
-          end
+        opts.on("--environment-id ID", Integer, "Run using this environment. If excluded, will use your default") do |value|
+          @environment_id = value
+        end
 
-          opts.on("--description DESCRIPTION", "Add a description for the run.") do |value|
-            @description = value
-          end
+        opts.on("--site-id ID", Integer, "Only run tests for a specific site") do |value|
+          @site_id = value
+        end
 
-          opts.on_tail("--help", "Display help message and exit") do |value|
-            puts opts
-            exit 0
-          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|
+          @custom_url = value
+        end
 
-        end.parse!(@args)
+        opts.on("--description DESCRIPTION", "Add a description for the run.") do |value|
+          @description = value
+        end
 
-        @command = @args.shift
-        @tests = @args.dup
-      end
+        opts.on_tail("--help", "Display help message and exit") do |value|
+          puts opts
+          exit 0
+        end
 
-      def tests
-        @tests
-      end
+      end.parse!(@args)
 
-      def git_trigger?
-        @git_trigger
-      end
+      @command = @args.shift
 
-      def failfast?
-        @failfast
+      if @command == 'new'
+        @file_name = @args.shift
       end
 
-      def foreground?
-        @foreground
-      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
+      @tests
+    end
+
+    def git_trigger?
+      @git_trigger
+    end
+
+    def failfast?
+      @failfast
+    end
+
+    def foreground?
+      @foreground
+    end
 
-      def validate!
+    def validate!
+      if @require_token 
         unless token
           raise ValidationError, "You must pass your API token using: --token TOKEN"
         end
+      end
 
-        if custom_url && site_id.nil?
-          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)
-            raise ValidationError, "Input file: #{import_file_name} not found"
-          end
+      if custom_url && site_id.nil?
+        raise ValidationError, "The site-id and custom-url options are both required."
+      end
 
-        elsif import_file_name || import_name
-          raise ValidationError, "You must pass both --import-variable-csv-file and --import-variable-name"
+      if import_file_name && import_name
+        unless File.exists?(import_file_name)
+          raise ValidationError, "Input file: #{import_file_name} not found"
         end
-        true
-      end
 
-      class ValidationError < RuntimeError
+      elsif import_file_name || import_name
+        raise ValidationError, "You must pass both --import-variable-csv-file and --import-variable-name"
       end
+      true
+    end
+
+    class ValidationError < RuntimeError
     end
   end
 end