rainforest-cli 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64c92d088ca6ebcc0b9b64ec565c28755a5c3179
-  data.tar.gz: ce73f06786865a973aa5db835458d88b4bd4edc5
+  metadata.gz: 5a4d51888c0d3ce1b8845532734aa59145159b2f
+  data.tar.gz: 49d5541c943fc62aca7dbd5c173823cf6c64743c
 SHA512:
-  metadata.gz: 86ee464ee5745117353fb673682355aed50361b31b76a01b97dce5f4e34817e2439f5bd0a7467f511f80956b93e2ef32c87e349d4dbd24970a804c0b82e09da1
-  data.tar.gz: f91efb44badfae00246e3a9d2d991242af873eed47c800330fd9c8a1f94d131a9d22f76ac6fe0c3119e6308bfed73ecd297a611ac17027d37501c18bc3651bcb
+  metadata.gz: 8f8479a400d1d88eaf84e0eeb584a1e6a8e56590e89b628cfbd9cb8c0126cc4b6b0e64c4ff9c8427f31d6f79795ad2a43abd5b27c03a10232fdc3481dd77c1a4
+  data.tar.gz: 1e1337f1e45e4b5131e612d0bea3fef8d01686ea043af10d7deb2d5d76baf79a13d6a558773619ace488f8f7acbb01ae5b3090d5aeac968f5c9e54494e610888

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Rainforest CLI Changelog
 
+## 1.2.0 - 8th February 2016
+- Add support for embedded tests.
+- Add support for customizable RFML ids.
+
 ## 1.1.4 - 15th January 2016
 - Customizable folder location for rainforest tests (fa4418738311cee8ca25cbb22a8ca52aa9cbd873, @ukd1)
 - Update valid browser list, though this doesn't include custom browsers today (e6195c42f95cce72a17f49643bfe8c297baf8dd9, @ukd1)

data/README.md

@@ -41,6 +41,17 @@ Run all tests with tag 'run-me' and abort previous in-progress runs.
 rainforest run --tag run-me --fg --conflict abort --token YOUR_TOKEN_HERE
 ```
 
+Create new Rainforest test in RFML format (Rainforest Markup Language).
+
+```bash
+rainforest new
+```
+
+Upload rainforest
+
+```bash
+rainforest upload --token YOUR_TOKEN_HERE
+```
 
 ## Options
 

data/lib/rainforest/cli.rb

@@ -4,8 +4,9 @@ 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 "rainforest/cli/test_files"
+require "rainforest/cli/test_importer"
 require "erb"
 require "httparty"
 require "json"

data/lib/rainforest/cli/options.rb

@@ -12,7 +12,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_spec_folder
+                :debug, :file_name, :test_folder
 
     # Note, not all of these may be available to your account
     # also, we may remove this in the future.
@@ -24,7 +24,6 @@ module RainforestCli
       @browsers = nil
       @require_token = true
       @debug = false
-      @test_spec_folder = RainforestCli::TestImporter::SPEC_FOLDER
 
       @parsed = ::OptionParser.new do |opts|
         opts.on("--debug") do
@@ -36,7 +35,7 @@ module RainforestCli
         end
 
         opts.on("--test-folder spec/rainforest", "Specify the test folder. Defaults to spec/rainforest if not set.") do |value|
-          @test_spec_folder = value
+          @test_folder = value
         end
 
         opts.on("--import-variable-csv-file FILE", "Import step variables; CSV data") do |value|
@@ -134,7 +133,7 @@ module RainforestCli
     end
 
     def validate!
-      if @require_token 
+      if @require_token
         unless token
           raise ValidationError, "You must pass your API token using: --token TOKEN"
         end

data/lib/rainforest/cli/test_files.rb

@@ -0,0 +1,32 @@
+class RainforestCli::TestFiles
+  DEFAULT_TEST_FOLDER = './spec/rainforest'.freeze
+  EXT = ".rfml".freeze
+
+  attr_reader :test_folder, :test_paths, :test_data
+
+  def initialize(test_folder = nil)
+    @test_folder = test_folder || DEFAULT_TEST_FOLDER
+
+    unless Dir.exists?(@test_folder)
+      Dir.mkdir(@test_folder)
+    end
+    @test_paths = "#{@test_folder}/**/*#{EXT}"
+    @test_data = [].tap do |all_tests|
+      Dir.glob(@test_paths) do |file_name|
+        all_tests << RainforestCli::TestParser::Parser.new(File.read(file_name)).process
+      end
+    end
+  end
+
+  def file_extension
+    EXT
+  end
+
+  def rfml_ids
+    @test_data.map(&:rfml_id)
+  end
+
+  def count
+    @test_data.count
+  end
+end

data/lib/rainforest/cli/test_importer.rb

@@ -4,31 +4,29 @@ require 'parallel'
 require 'ruby-progressbar'
 
 class RainforestCli::TestImporter
-  attr_reader :options, :client
-  SPEC_FOLDER = 'spec/rainforest'.freeze
-  EXT = ".rfml".freeze
+  attr_reader :options, :client, :test_files
   THREADS = 32.freeze
 
   SAMPLE_FILE = <<EOF
-#! %s (this is the ID, don't edit it)
+#! %s (Test ID - only edit if this test has not yet been uploaded)
 # title: New test
+# start_uri: /
 #
-# 1. steps:
-#   a) pairs of lines are steps (first line = action, second = response)
-#   b) second line must have a ?
-#   c) second line must not be blank
-# 2. comments:
-#   a) lines starting # are comments
+# Lines starting with # are test attributes or comments
+# Possible attributes: #{RainforestCli::TestParser::Parser::TEXT_FIELDS.join(', ')}
+#
+# Steps are composed of two lines: an action and a question. Example:
+#
+# This is the step action.
+# This is the step question?
 #
 
 EOF
 
   def initialize(options)
     @options = options
-    unless File.exists?(@options.test_spec_folder)
-      logger.fatal "Rainforest test folder not found (#{@options.test_spec_folder})"
-      exit 2
-    end
+    ::Rainforest.api_key = @options.token
+    @test_files = RainforestCli::TestFiles.new(@options.test_folder)
   end
 
   def logger
@@ -36,8 +34,6 @@ EOF
   end
 
   def export
-    ::Rainforest.api_key = @options.token
-
     tests = Rainforest::Test.all(page_size: 1000)
     p = ProgressBar.create(title: 'Rows', total: tests.count, format: '%a %B %p%% %t')
     Parallel.each(tests, in_threads: THREADS, finish: lambda { |item, i, result| p.increment }) do |test|
@@ -115,69 +111,35 @@ EOF
   end
 
   def upload
-    ::Rainforest.api_key = @options.token
-
-    ids = {}
-    logger.info "Syncing tests"
-    Rainforest::Test.all(page_size: 1000).each do |test|
-      id = _get_id(test)
-
-      next if id.nil?
-
-      # note, this test id is numeric
-      ids[id] = test.id
-    end
-
-    logger.debug ids.inspect if @options.debug
-
-    tests = validate.values
-
-    logger.info "Uploading tests..."
-    p = ProgressBar.create(title: 'Rows', total: tests.count, format: '%a %B %p%% %t')
-
-    # Insert the data
-    Parallel.each(tests, in_threads: THREADS, finish: lambda { |item, i, result| p.increment }) do |test|
-      next unless test.steps.count > 0
-
-      if @options.debug
-        logger.debug "Starting: #{test.id}"
-        logger.debug "\t#{test.start_uri || "/"}"
-      end
-
-      test_obj = {
-        start_uri: test.start_uri || "/",
-        title: test.title,
-        description: test.description,
-        tags: (["ro"] + test.tags).uniq,
-        elements: test.steps.map do |step|
-          {type: 'step', redirection: true, element: {
-            action: step.action,
-            response: step.response
-          }}
+    # Prioritize embedded tests before other tests
+    upload_groups = []
+    unordered_tests = []
+    queued_tests = test_files.test_data.dup
+
+    until queued_tests.empty?
+      new_ordered_group = []
+      ordered_ids = upload_groups.flatten.map(&:rfml_id)
+
+      queued_tests.each do |rfml_test|
+        if (rfml_test.embedded_ids - ordered_ids).empty?
+          new_ordered_group << rfml_test
+        else
+          unordered_tests << rfml_test
         end
-      }
-
-      unless test.browsers.empty?
-        test_obj[:browsers] = test.browsers.map {|b|
-          {'state' => 'enabled', 'name' => b}
-        }
       end
 
-      # Create the test
-      begin
-        if ids[test.id]
-          t = Rainforest::Test.update(ids[test.id], test_obj)
+      upload_groups << new_ordered_group
+      queued_tests = unordered_tests
+      unordered_tests = []
+    end
 
-          logger.info "\tUpdated #{test.id} -- ##{t.id}" if @options.debug
-        else
-          t = Rainforest::Test.create(test_obj)
+    logger.info "Uploading tests..."
 
-          logger.info "\tCreated #{test.id} -- ##{t.id}" if @options.debug
-        end
-      rescue => e
-        logger.fatal "Error: #{test.id}: #{e}"
-        exit 2
-      end
+    # Upload in parallel if order doesn't matter
+    if upload_groups.count > 1
+      upload_groups_sequentially(upload_groups)
+    else
+      upload_group_in_parallel(upload_groups.first)
     end
   end
 
@@ -185,7 +147,7 @@ EOF
     tests = {}
     has_errors = []
 
-    Dir.glob("#{@options.test_spec_folder}/**/*#{EXT}").each do |file_name|
+    Dir.glob(test_files.test_paths).each do |file_name|
       out = RainforestCli::TestParser::Parser.new(File.read(file_name)).process
 
       tests[file_name] = out
@@ -224,15 +186,117 @@ EOF
   def create_new file_name = nil
     name = @options.file_name if @options.file_name
     name = file_name if !file_name.nil?
+    ext = test_files.file_extension
 
     uuid = SecureRandom.uuid
-    name = "#{uuid}#{EXT}" unless name
-    name += EXT unless name[-EXT.length..-1] == EXT
-    name = File.join([@options.test_spec_folder, name])
+    name = "#{uuid}#{ext}" unless name
+    name += ext unless name[-ext.length..-1] == ext
+    name = File.join([@test_files.test_folder, name])
 
     File.open(name, "w") { |file| file.write(sprintf(SAMPLE_FILE, uuid)) }
 
     logger.info "Created #{name}" if file_name.nil?
     name
   end
+
+  private
+
+  def upload_groups_sequentially(upload_groups)
+    progress_bar = ProgressBar.create(title: 'Rows', total: test_files.count, format: '%a %B %p%% %t')
+    upload_groups.each_with_index do |rfml_tests, idx|
+      if idx == (rfml_tests.length - 1)
+        upload_group_in_parallel(rfml_tests, progress_bar)
+      else
+        rfml_tests.each { |rfml_test| upload_test(rfml_test) }
+        progress_bar.increment
+      end
+    end
+  end
+
+  def upload_group_in_parallel(rfml_tests, progress_bar = nil)
+    progress_bar ||= ProgressBar.create(title: 'Rows', total: rfml_tests.count, format: '%a %B %p%% %t')
+    Parallel.each(rfml_tests, in_threads: THREADS, finish: lambda { |item, i, result| progress_bar.increment }) do |rfml_test|
+      upload_test(rfml_test)
+    end
+  end
+
+  def upload_test(rfml_test)
+    return unless rfml_test.steps.count > 0
+
+    if @options.debug
+      logger.debug "Starting: #{rfml_test.rfml_id}"
+      logger.debug "\t#{rfml_test.start_uri || "/"}"
+    end
+
+    test_obj = create_test_obj(rfml_test)
+    # Upload the test
+    begin
+      if rfml_id_mappings[rfml_test.rfml_id]
+        t = Rainforest::Test.update(rfml_id_mappings[rfml_test.rfml_id], test_obj)
+
+        logger.info "\tUpdated #{rfml_test.rfml_id} -- ##{t.id}" if @options.debug
+      else
+        t = Rainforest::Test.create(test_obj)
+
+        logger.info "\tCreated #{rfml_test.rfml_id} -- ##{t.id}" if @options.debug
+        rfml_id_mappings[rfml_test.rfml_id] = t.id
+      end
+    rescue => e
+      logger.fatal "Error: #{rfml_test.rfml_id}: #{e}"
+      exit 2
+    end
+  end
+
+  def rfml_id_mappings
+    if @_id_mappings.nil?
+      @_id_mappings = {}.tap do |id_mappings|
+        Rainforest::Test.all(page_size: 1000, rfml_ids: test_files.rfml_ids).each do |rf_test|
+          rfml_id = rf_test.rfml_id
+          next if rfml_id.nil?
+
+          id_mappings[rfml_id] = rf_test.id
+        end
+      end
+    end
+    @_id_mappings
+  end
+
+  def create_test_obj(rfml_test)
+    test_obj = {
+      start_uri: rfml_test.start_uri || "/",
+      title: rfml_test.title,
+      description: rfml_test.description,
+      tags: (["ro"] + rfml_test.tags).uniq,
+      rfml_id: rfml_test.rfml_id,
+      elements: rfml_test.steps.map do |step|
+        case step.type
+        when :step
+          {
+            type: 'step',
+            redirection: true,
+            element: {
+              action: step.action,
+              response: step.response
+            }
+          }
+        when :test
+          {
+            type: 'test',
+            redirection: true,
+            element: {
+              id: rfml_id_mappings[step.rfml_id]
+            }
+          }
+        end
+      end
+    }
+
+    unless rfml_test.browsers.empty?
+      test_obj[:browsers] = rfml_test.browsers.map {|b|
+        {'state' => 'enabled', 'name' => b}
+      }
+    end
+
+    test_obj
+  end
 end

data/lib/rainforest/cli/test_parser.rb

@@ -1,11 +1,19 @@
 module RainforestCli::TestParser
-  class EmbeddedTest < Struct.new(:test_name)
+  class EmbeddedTest < Struct.new(:rfml_id)
+    def type
+      :test
+    end
+
     def to_s
-      "--> embed: #{test_name}"
+      "--> embed: #{rfml_id}"
     end
   end
 
   class Step < Struct.new(:action, :response)
+    def type
+      :step
+    end
+
     def to_s
       "#{action} --> #{response}"
     end
@@ -17,7 +25,10 @@ module RainforestCli::TestParser
     end
   end
 
-  class Test < Struct.new(:id, :description, :title, :start_uri, :steps, :errors, :tags, :browsers)
+  class Test < Struct.new(:rfml_id, :description, :title, :start_uri, :steps, :errors, :tags, :browsers)
+    def embedded_ids
+      steps.inject([]) { |embeds, step| step.type == :test ? embeds + [step.rfml_id] : embeds }
+    end
   end
 
   class Parser
@@ -43,7 +54,7 @@ module RainforestCli::TestParser
       text.lines.map(&:chomp).each_with_index do |line, line_no|
         if line[0..1] == '#!'
           # special comment, don't ignore!
-          @test.id = line[2..-1].strip.split(" ")[0]
+          @test.rfml_id = line[2..-1].strip.split(" ")[0]
           @test.description += line[1..-1] + "\n"
 
         elsif line[0] == '#'
@@ -90,8 +101,8 @@ module RainforestCli::TestParser
         end
       end
 
-      if @test.id == nil
-        @test.errors[0] = Error.new(0, "Missing test ID. Please start a line #! followed by a unique id.")
+      if @test.rfml_id == nil
+        @test.errors[0] = Error.new(0, "Missing RFML ID. Please start a line #! followed by a unique id.")
       end
 
       return @test

data/lib/rainforest/cli/version.rb

@@ -1,3 +1,3 @@
 module RainforestCli
-  VERSION = "1.1.4"
+  VERSION = "1.2.0"
 end

data/spec/options_spec.rb

@@ -9,12 +9,7 @@ describe RainforestCli::OptionParser do
 
     context "test folder (when passed)" do
       let(:args) { ["--test-folder", "/path/to/folder"] }
-      its(:test_spec_folder) { should == "/path/to/folder" }
-    end
-
-    context "test folder (when not passed)" do
-      let(:args) { [] }
-      its(:test_spec_folder) { should == RainforestCli::TestImporter::SPEC_FOLDER }
+      its(:test_folder) { should == "/path/to/folder" }
     end
 
     context "importing name" do

data/spec/rainforest-example/example_test.rfml

@@ -0,0 +1,6 @@
+#! example_test (Test ID - only edit if this test has not yet been uploaded)
+# title: Example Test
+# start_uri: /
+
+This is a step action.
+This is a question?

data/spec/test_files_spec.rb

@@ -0,0 +1,36 @@
+describe RainforestCli::TestFiles do
+  let(:test_folder) { File.dirname(__FILE__) + '/rainforest-example' }
+  subject { described_class.new(test_folder) }
+
+  let(:rfml_test) { subject.test_data.first }
+  let(:text_file) { File.read(test_folder + '/example_test.rfml') }
+
+  describe '#initialize' do
+    before do
+      allow(Dir).to receive(:mkdir)
+    end
+
+    context 'when test folder name is not supplied' do
+      it 'uses the default file folder' do
+        expect(described_class.new.test_folder).to eq(described_class::DEFAULT_TEST_FOLDER)
+      end
+    end
+
+    context 'when test folder name is supplied' do
+      let(:folder_name) { './foo' }
+
+      it 'creates the supplied folder if file does not exist' do
+        expect(Dir).to receive(:mkdir).with(folder_name).once
+        described_class.new(folder_name)
+      end
+    end
+
+  end
+
+  describe '#test_data' do
+    it 'parses all available tests on initialization' do
+      expect(rfml_test.title).to eq(text_file.match(/^# title: (.+)$/)[1])
+      expect(rfml_test.rfml_id).to eq(text_file.match(/^#! (.+?)($| .+?$)/)[1])
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rainforest-cli
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Simon Mathieu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -121,6 +121,7 @@ files:
 - lib/rainforest/cli/http_client.rb
 - lib/rainforest/cli/options.rb
 - lib/rainforest/cli/runner.rb
+- lib/rainforest/cli/test_files.rb
 - lib/rainforest/cli/test_importer.rb
 - lib/rainforest/cli/test_parser.rb
 - lib/rainforest/cli/version.rb
@@ -130,8 +131,10 @@ files:
 - spec/fixtures/variables.txt
 - spec/git_trigger_spec.rb
 - spec/options_spec.rb
+- spec/rainforest-example/example_test.rfml
 - spec/runner_spec.rb
 - spec/spec_helper.rb
+- spec/test_files_spec.rb
 homepage: https://www.rainforestqa.com/
 licenses:
 - MIT
@@ -162,5 +165,7 @@ test_files:
 - spec/fixtures/variables.txt
 - spec/git_trigger_spec.rb
 - spec/options_spec.rb
+- spec/rainforest-example/example_test.rfml
 - spec/runner_spec.rb
 - spec/spec_helper.rb
+- spec/test_files_spec.rb