rainforest-cli 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92aa2786f98a5e439e178408b1521a27b9f788e5
-  data.tar.gz: 4fb8adeafb3467880fe9e3be7adcd74a23abd28e
+  metadata.gz: 5eb860284f17f1642d76697d195b5352cd641f52
+  data.tar.gz: 18786715493b49e4dc981fa020f80c1083f7d3f1
 SHA512:
-  metadata.gz: 6564dc0380b6daaed3b00248d2a02c2cd4e8fc1c272fe68dc55925e7918919c490ff5c939d42534bebf1dbd0c21e593d540f7e61cbfcebc4e733c2989700cc20
-  data.tar.gz: ddd1a2abeba97ec6f4ef67c4e35f6cf274ab79af279b58da0fe683a07b6cc1e545c7d4c8c59f996f294201f6b34b506719b8065d75193d59ecf1e8446fa93589
+  metadata.gz: 39ecb9e62e9cf82131dcdf141681da172cac675b74506de7376f223a68682fd5cc54b06811a8c2f0238741e8dcdb183efc16d26c20adcad1373931e40f8e0f8e
+  data.tar.gz: 8d40cb3cefe445792c033790806a921dadd2db1665ee48712c6a6ad0039c0c4b1c9ec7586d060dfa1b547f1d1d83c51fbc4e0a9c031004f2ddc44bd3685211ed

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Rainforest CLI Changelog
 
+# 1.3.0 - 7th April 2016
+- Export tests with embedded tests unflattened. (0ed4c62cac8a0d5fbd98f03190d3c18c48ac7119,
+@epaulet)
+- Add option to save API token in environment rather than specifying in commands.
+(eaa32e87dff2881074c920f6ffc278d1fcd25ae7, @valeriangalliat)
+- Fixed a bug where tests would upload without the correct source attribute if
+an upload command failed in the middle of executing. (92df14606304957c5c58719a8999471df5f4f8c0,
+@epaulet)
+- Specify app source url as a command line option. (d02f750e885824c1b6f141344af9a34fc99e7527,
+@ukd1)
+- Add support for redirect flag on steps and embedded test. (e54a3f78333d4b8398b8aece40ebfbaaf4113eb4,
+@epaulet)
+- Add support for site_id attribute in RFML test and add `sites` command for
+site ID reference. (7b628b12879f5c2230181d5e4badf785c26c8035, @epaulet)
+- Add support for exporting specified tests using test IDs found on dashboard.
+(69d104d7452dcb2ba7925d1de86532f250b72f41, @ziahamza)
+
 # 1.2.2 - 21st March 2016
 - Add support for Ruby 1.9.3 for easier usage on CircleCI. (16d74306a160c0fca8d34bc32493119051179c90, @epaulet)
 

data/Gemfile

@@ -5,7 +5,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rf-stylez'
-gem 'circlemator', require: false
 
 group :test do
   gem 'rspec', '~> 3.4.0'

data/README.md

@@ -25,22 +25,24 @@ gem "rainforest-cli", require: false
 ## Basic Usage
 To use the cli client, you'll need your API token from a test settings page from inside [Rainforest](https://app.rainforestqa.com/).
 
+You can either pass the token with `--token YOUR_TOKEN_HERE` CLI option, or put it in the `RAINFOREST_API_TOKEN` environment variable.
+
 Run all of your tests
 
 ```bash
-rainforest run all --token YOUR_TOKEN_HERE
+rainforest run all
 ```
 
 Run all in the foreground and report
 
 ```bash
-rainforest run all --fg --token YOUR_TOKEN_HERE
+rainforest run all --fg
 ```
 
 Run all tests with tag 'run-me' and abort previous in-progress runs.
 
 ```bash
-rainforest run --tag run-me --fg --conflict abort --token YOUR_TOKEN_HERE
+rainforest run --tag run-me --fg --conflict abort
 ```
 
 Create new Rainforest test in RFML format (Rainforest Markup Language).
@@ -49,24 +51,77 @@ Create new Rainforest test in RFML format (Rainforest Markup Language).
 rainforest new
 ```
 
-Upload rainforest
+Upload tests to Rainforest
+
+```bash
+rainforest upload
+```
 
+Export all tests from Rainforest
 ```bash
-rainforest upload --token YOUR_TOKEN_HERE
+rainforest export
 ```
 
 ## Options
 
 ### General
 
-Required:
-- `--token <your-rainforest-token>` - you must supply your token (get it from any tests API tab)
+- `--token <your-rainforest-token>` - supply your token (get it from any tests API tab), if not set in `RAINFOREST_API_TOKEN` environment variable
+
+### Writing Tests
+Rainforest Tests written using RFML have the following format
+
+```
+#! [RFML ID]
+# title: [TITLE]
+# start_uri: [START_URI]
+# tags: [TAGS]
+# site_id: [SITE ID]
+# [OTHER COMMENTS]
+
+[ACTION 1]
+[QUESTION 1]
 
+# redirect: [REDIRECT FLAG]
+- [EMBEDDED TEST RFML ID]
 
-### Running Tests
-The most popular options are:
+[ACTION 2]
+[QUESTION 2]
 
-- `--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.
+... etc.
+```
+
+Required Fields:
+- `RFML ID` - Unique identifier for your test. For newly generated tests, this will
+be a UUID, but you are free to change it for easier reference (for example, your
+login test might have the id `login_test`).
+- `TITLE` - The title of your test.
+- `START_URI` - The path used to direct the tester to the correct page to begin the test.
+- `ACTION 1`, `ACTION 2`, ... - The directions for your tester to follow in this
+step. You must have at least one step in your test.
+- `QUESTION 1`, `QUESTION 2`, ... - The question you would like your tester to
+answer in this step. You must have at least one step in your test.
+
+Optional Fields:
+- `SITE ID` - Site ID for the site this test is for. You can find your available
+site IDs with the `sites` command. Sites can be configured at
+https://app.rainforestqa.com/settings/sites.
+- `TAGS` - Comma separated list of your desired tags for this test.
+- `OTHER COMMENTS` - Any comments you'd like to save to this test. All lines beginning with
+`#` will be ignored by Rainforest unless they begin with a supported data field,
+such as `tags` or `start_uri`.
+- `REDIRECT FLAG` - A `true` or `false` flag to designate whether the tester should be
+redirected. The default value is `true`. This flag is only applicable for embedded
+tests and the first step of a test.
+- `EMBEDDED TEST RFML ID` - Embed the steps of another test within the current test
+using the embedded test's RFML ID.
+
+For more information on test writing, please visit our [documentation](http://support.rainforestqa.com/hc/en-us/sections/200585603-Writing-Tests).
+
+### Command Line Options
+
+Popular command line options are:
+- `--browsers ie8` or `--browsers ie8,chrome` - specify the browsers you wish to run against. This overrides the test own settings. Valid browsers can be found in your account settings.
 - `--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.
 - `--environment-id` - run your tests using this environment. Otherwise it will use your default environment
@@ -76,6 +131,19 @@ The most popular options are:
 - `--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.
 - `--git-trigger` - only trigger a run when the last commit (for a git repo in the current working directory) has contains `@rainforest` and a list of one or more tags. E.g. "Fix checkout process. @rainforest #checkout" would trigger a run for everything tagged `checkout`. This over-rides `--tag` and any tests specified. If no `@rainforest` is detected it will exit 0.
 - `--description "CI automatic run"` - add an arbitrary description for the run.
+- `--embed-tests` - Use with `rainforest export` to export your tests without extracting the
+steps of an embedded test.
+
+
+#### Specifying Test IDs
+Any integers input as arguments in the command line arguments are treated as
+test IDs taken from the Rainforest dashboard. ie:
+
+`rainforest run --token $TOKEN 1232 3212` - will export only tests
+1232 and 3212. The `export` and `run` commands and are otherwise ignored.
+
+All other argument types should be specified as seen above.
+
 
 More detailed info on options can be [found here](https://github.com/rainforestapp/rainforest-cli/blob/master/lib/rainforest/cli/options.rb#L23-L74).
 

data/lib/rainforest/cli.rb

@@ -13,8 +13,9 @@ 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/exporter'
 require 'rainforest/cli/uploader'
+require 'rainforest/cli/sites'
 
 module RainforestCli
   def self.start(args)
@@ -33,8 +34,8 @@ module RainforestCli
       runner = Runner.new(options)
       runner.run
     when 'new'
-      t = TestImporter.new(options)
-      t.create_new
+      t = TestFiles.new(options)
+      t.create_file
     when 'validate'
       t = Validator.new(options)
       t.validate
@@ -42,8 +43,11 @@ module RainforestCli
       t = Uploader.new(options)
       t.upload
     when 'export'
-      t = TestImporter.new(options)
+      t = Exporter.new(options)
       t.export
+    when 'sites'
+      t = Sites.new(options)
+      t.list_sites
     else
       logger.fatal 'Unknown command'
       exit 2

data/lib/rainforest/cli/exporter.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require 'securerandom'
+require 'rainforest'
+require 'parallel'
+require 'ruby-progressbar'
+
+class RainforestCli::Exporter
+  attr_reader :options, :client, :test_files
+
+  def initialize(options)
+    @options = options
+    ::Rainforest.api_key = @options.token
+    @test_files = RainforestCli::TestFiles.new(@options)
+  end
+
+  def logger
+    RainforestCli.logger
+  end
+
+  def threads
+    RainforestCli::THREADS
+  end
+
+  def export
+    test_ids =
+      if @options.tests.length > 0
+        @options.tests
+      else
+        Rainforest::Test.all(page_size: 1000).map { |t| t.id }
+      end
+    p = ProgressBar.create(title: 'Rows', total: test_ids.count, format: '%a %B %p%% %t')
+    Parallel.each(test_ids, in_threads: threads, finish: lambda { |_item, _i, _result| p.increment }) do |test_id|
+      # Get the full test from the API
+      test = Rainforest::Test.retrieve(test_id)
+
+      # File name
+      file_name = sprintf('%010d', test.id) + '_' + test.title.strip.gsub(/[^a-z0-9 ]+/i, '').gsub(/ +/, '_').downcase
+      file_name = test_files.create_file(file_name)
+      File.truncate(file_name, 0)
+
+      File.open(file_name, 'a') do |file|
+        file.puts(get_header(test))
+
+        test.elements.each_with_index do |element, index|
+          process_element(file, element, index)
+        end
+      end
+    end
+  end
+
+  private
+
+  def process_element file, element, index
+    case element[:type]
+    when 'test'
+      if @options.embed_tests
+        file.puts '' unless index == 0
+        file.puts "- #{element[:element][:rfml_id]}"
+      else
+        element[:element][:elements].each do |sub_element|
+          index = process_element(file, sub_element, index)
+        end
+      end
+    when 'step'
+      file.puts '' unless index == 0
+      file.puts "# step #{index + 1}" if @options.debug
+      file.puts element[:element][:action]
+      file.puts element[:element][:response]
+    else
+      raise "Unknown element type: #{element[:type]}"
+    end
+  end
+
+  def get_header(test)
+    browsers = test.browsers.map { |b| b[:name] if b[:state] == 'enabled' }.compact
+    <<-EOF
+#! #{test.rfml_id}
+# title: #{test.title}
+# start_uri: #{test.start_uri}
+# tags: #{test.tags.join(", ")}
+# browsers: #{browsers.join(", ")}
+#
+
+    EOF
+  end
+end

data/lib/rainforest/cli/options.rb

@@ -6,7 +6,7 @@ module RainforestCli
     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, :test_folder
+                :debug, :file_name, :test_folder, :embed_tests, :app_source_url
 
     # Note, not all of these may be available to your account
     # also, we may remove this in the future.
@@ -39,6 +39,7 @@ module RainforestCli
       safari
       ubuntu_chrome
       ubuntu_firefox
+      iphone_6s_v9_0
     }.freeze
     TOKEN_NOT_REQUIRED = %w{new validate}.freeze
 
@@ -47,6 +48,7 @@ module RainforestCli
       @tags = []
       @browsers = nil
       @debug = false
+      @token = ENV['RAINFOREST_API_TOKEN']
 
       # NOTE: Disabling line length cop to allow for consistency of syntax
       # rubocop:disable Metrics/LineLength
@@ -59,6 +61,10 @@ module RainforestCli
           @file_name = value
         end
 
+        opts.on('--app-source-url FILE', 'Import step variables; CSV data') do |value|
+          @app_source_url = value
+        end
+
         opts.on('--test-folder FILE_PATH', 'Specify the test folder. Defaults to spec/rainforest if not set.') do |value|
           @test_folder = value
         end
@@ -119,6 +125,10 @@ module RainforestCli
           @description = value
         end
 
+        opts.on('--embed-tests', 'Export tests without expanding embedded test steps') do |_value|
+          @embed_tests = true
+        end
+
         opts.on_tail('--help', 'Display help message and exit') do |_value|
           puts opts
           exit 0

data/lib/rainforest/cli/runner.rb

@@ -99,6 +99,7 @@ module RainforestCli
         end
       end
 
+      post_opts[:app_source_url] = options.app_source_url if options.app_source_url
       post_opts[:conflict] = options.conflict if options.conflict
       post_opts[:browsers] = options.browsers if options.browsers
       post_opts[:site_id] = options.site_id if options.site_id

data/lib/rainforest/cli/sites.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+class RainforestCli::Sites
+  def initialize(options)
+    @client = RainforestCli::HttpClient.new(token: options.token)
+  end
+
+  def list_sites
+    sites = fetch_sites
+
+    if sites.empty?
+      logger.info('No configured sites found on your account.')
+      logger.info('Please visit https://app.rainforestqa.com/settings/sites to create and edit your sites.')
+    else
+      print_site_table(sites)
+    end
+  end
+
+  def print_site_table(sites)
+    puts 'Site ID | Site Name'
+    puts '-------------------'
+    sites.each do |site|
+      puts "#{site['id'].to_s.rjust(7)} | #{site['name']}"
+    end
+  end
+
+  private
+
+  def fetch_sites
+    @sites ||= @client.get('/sites')
+  end
+
+  def logger
+    RainforestCli.logger
+  end
+end

data/lib/rainforest/cli/test_files.rb

@@ -2,15 +2,30 @@
 class RainforestCli::TestFiles
   DEFAULT_TEST_FOLDER = './spec/rainforest'
   FILE_EXTENSION = '.rfml'
+  SAMPLE_FILE = <<EOF
+#! %s
+# title: New test
+# start_uri: /
+# tags: rfml-test
+#
+
+This is a step action.
+This is a step question?
+
+This is another step action.
+This is another step question?
+
+EOF
 
   attr_reader :test_folder, :test_data
 
-  def initialize(test_folder = nil)
-    if test_folder.nil?
-      RainforestCli.logger.info "No test folder supplied. Using default folder: #{DEFAULT_TEST_FOLDER}"
+  def initialize(options)
+    @options = options
+    if @options.test_folder.nil?
+      logger.info "No test folder supplied. Using default folder: #{DEFAULT_TEST_FOLDER}"
       @test_folder = File.expand_path(DEFAULT_TEST_FOLDER)
     else
-      @test_folder = File.expand_path(test_folder)
+      @test_folder = File.expand_path(@options.test_folder)
     end
   end
 
@@ -47,4 +62,29 @@ class RainforestCli::TestFiles
       test_data.each { |rfml_test| dictionary[rfml_test.rfml_id] = rfml_test }
     end
   end
+
+  def ensure_directory_exists
+    FileUtils.mkdir_p(test_folder) unless Dir.exist?(test_folder)
+  end
+
+  def create_file(file_name = @options.file_name)
+    ensure_directory_exists
+
+    uuid = SecureRandom.uuid
+
+    name = file_name || uuid.to_s
+    name += file_extension unless name[-file_extension.length..-1] == file_extension
+    name = File.join(test_folder, name)
+
+    File.open(name, 'w') { |file| file.write(sprintf(SAMPLE_FILE, uuid)) }
+
+    logger.info "Created #{name}"
+    name
+  end
+
+  private
+
+  def logger
+    RainforestCli.logger
+  end
 end