rainforest-cli 1.2.0 → 1.2.1

data/lib/rainforest/cli/remote_tests.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+class RainforestCli::RemoteTests
+  def initialize(api_token = nil)
+    Rainforest.api_key = api_token
+  end
+
+  def api_token_set?
+    !Rainforest.api_key.nil?
+  end
+
+  def rfml_ids
+    @rfml_ids ||= tests.map(&:rfml_id)
+  end
+
+  def tests
+    @tests ||= fetch_tests
+  end
+
+  def fetch_tests
+    if api_token_set?
+      begin
+        logger.info 'Syncing tests...'
+        tests = Rainforest::Test.all(page_size: 1000)
+        logger.info 'Syncing completed.'
+        tests
+      rescue Rainforest::ApiError => e
+        logger.error "Encountered API Error: #{e.message}"
+        exit 4
+      end
+    else
+      logger.info ''
+      logger.info 'No API Token set. Using local tests only...'
+      logger.info ''
+      []
+    end
+  end
+
+  def primary_key_dictionary
+    @primary_key_dictionary ||= {}.tap do |primary_key_dictionary|
+      tests.each do |rf_test|
+        primary_key_dictionary[rf_test.rfml_id] = rf_test.id
+      end
+    end
+  end
+
+  def logger
+    RainforestCli.logger
+  end
+end

data/lib/rainforest/cli/runner.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RainforestCli
   class Runner
     attr_reader :options, :client
@@ -16,7 +17,7 @@ module RainforestCli
       post_opts = make_create_run_options
 
       logger.debug "POST options: #{post_opts.inspect}"
-      logger.info "Issuing run"
+      logger.info 'Issuing run'
 
       response = client.post('/runs', post_opts)
 
@@ -26,7 +27,7 @@ module RainforestCli
       end
 
       if options.foreground?
-        run_id = response.fetch("id")
+        run_id = response.fetch('id')
         wait_for_run_completion(run_id)
       else
         true
@@ -37,12 +38,13 @@ module RainforestCli
       running = true
       while running
         Kernel.sleep 5
-        response = client.get("/runs/#{run_id}")
+        response = client.get("/runs/#{run_id}", {}, retries_on_failures: true)
         if response
           state_details = response.fetch('state_details')
-          unless state_details.fetch("is_final_state")
-            logger.info "Run #{run_id} is #{response['state']} and is #{response['current_progress']['percent']}% complete"
-            running = false if response["result"] == 'failed' && options.failfast?
+          unless state_details.fetch('is_final_state')
+            state, current_progress = response.values_at('state', 'current_progress')
+            logger.info "Run #{run_id} is #{state} and is #{current_progress['percent']}% complete"
+            running = false if response['result'] == 'failed' && options.failfast?
           else
             logger.info "Run #{run_id} is now #{response["state"]} and has #{response["result"]}"
             running = false
@@ -50,11 +52,11 @@ module RainforestCli
         end
       end
 
-      if url = response["frontend_url"]
-        logger.info "The detailed results are available at #{url}"
+      if response['frontend_url']
+        logger.info "The detailed results are available at #{response['frontend_url']}"
       end
 
-      if response["result"] != "passed"
+      if response['result'] != 'passed'
         exit 1
       end
     end
@@ -62,28 +64,28 @@ module RainforestCli
     def make_create_run_options
       post_opts = {}
       if options.git_trigger?
-        logger.debug "Checking last git commit message:"
+        logger.debug 'Checking last git commit message:'
         commit_message = GitTrigger.last_commit_message
         logger.debug commit_message
 
         # Show some messages to users about tests/tags being overriden
         unless options.tags.empty?
-          logger.warn "Specified tags are ignored when using --git-trigger"
+          logger.warn 'Specified tags are ignored when using --git-trigger'
         else
-          logger.warn "Specified tests are ignored when using --git-trigger"
+          logger.warn 'Specified tests are ignored when using --git-trigger'
         end
 
         if GitTrigger.git_trigger_should_run?(commit_message)
           tags = GitTrigger.extract_hashtags(commit_message)
           if tags.empty?
-            logger.error "Triggered via git, but no hashtags detected. Please use commit message format:"
+            logger.error 'Triggered via git, but no hashtags detected. Please use commit message format:'
             logger.error "\t'some message. @rainforest #tag1 #tag2"
             exit 2
           else
             post_opts[:tags] = [tags.join(',')]
           end
         else
-          logger.info "Not triggering as @rainforest was not mentioned in last commit message."
+          logger.info 'Not triggering as @rainforest was not mentioned in last commit message.'
           exit 0
         end
       else
@@ -116,7 +118,7 @@ module RainforestCli
     end
 
     def list_generators
-      client.get("/generators")
+      client.get('/generators')
     end
 
     def delete_generator(name)
@@ -133,12 +135,12 @@ module RainforestCli
 
     def get_environment_id url
       unless url_valid?(url)
-        logger.fatal "The custom URL is invalid"
+        logger.fatal 'The custom URL is invalid'
         exit 2
       end
 
       env_post_body = { name: 'temporary-env-for-custom-url-via-CLI', url: url }
-      environment = client.post("/environments", env_post_body)
+      environment = client.post('/environments', env_post_body)
 
       if environment['error']
         # I am talking about a URL here because the environments are pretty

data/lib/rainforest/cli/test_files.rb

@@ -1,32 +1,50 @@
+# frozen_string_literal: true
 class RainforestCli::TestFiles
-  DEFAULT_TEST_FOLDER = './spec/rainforest'.freeze
-  EXT = ".rfml".freeze
+  DEFAULT_TEST_FOLDER = './spec/rainforest'
+  FILE_EXTENSION = '.rfml'
 
-  attr_reader :test_folder, :test_paths, :test_data
+  attr_reader :test_folder, :test_data
 
   def initialize(test_folder = nil)
-    @test_folder = test_folder || DEFAULT_TEST_FOLDER
-
-    unless Dir.exists?(@test_folder)
-      Dir.mkdir(@test_folder)
+    if test_folder.nil?
+      RainforestCli.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)
     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
+
+  def test_paths
+    "#{@test_folder}/**/*#{FILE_EXTENSION}"
+  end
+
+  def test_data
+    if @test_data.nil?
+      @test_data = []
+      if Dir.exist?(@test_folder)
+        Dir.glob(test_paths) do |file_name|
+          @test_data << RainforestCli::TestParser::Parser.new(file_name).process
+        end
       end
     end
+    @test_data
   end
 
   def file_extension
-    EXT
+    FILE_EXTENSION
   end
 
   def rfml_ids
-    @test_data.map(&:rfml_id)
+    test_data.map(&:rfml_id)
   end
 
   def count
-    @test_data.count
+    test_data.count
+  end
+
+  def test_dictionary
+    {}.tap do |dictionary|
+      test_data.each { |rfml_test| dictionary[rfml_test.rfml_id] = rfml_test }
+    end
   end
 end

data/lib/rainforest/cli/test_importer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'securerandom'
 require 'rainforest'
 require 'parallel'
@@ -5,7 +6,6 @@ require 'ruby-progressbar'
 
 class RainforestCli::TestImporter
   attr_reader :options, :client, :test_files
-  THREADS = 32.freeze
 
   SAMPLE_FILE = <<EOF
 #! %s (Test ID - only edit if this test has not yet been uploaded)
@@ -33,13 +33,17 @@ EOF
     RainforestCli.logger
   end
 
+  def threads
+    RainforestCli::THREADS
+  end
+
   def export
     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|
+    Parallel.each(tests, in_threads: threads, finish: lambda { |_item, _i, _result| p.increment }) do |test|
 
       # File name
-      file_name = sprintf('%010d', test.id) + "_" + test.title.strip.gsub(/[^a-z0-9 ]+/i, '').gsub(/ +/, '_').downcase
+      file_name = sprintf('%010d', test.id) + '_' + test.title.strip.gsub(/[^a-z0-9 ]+/i, '').gsub(/ +/, '_').downcase
       file_name = create_new(file_name)
       File.truncate(file_name, 0)
 
@@ -64,7 +68,7 @@ EOF
         index = _process_element(file, sub_element, index)
       end
     when 'step'
-      file.puts "" unless index == 0
+      file.puts '' unless index == 0
       file.puts "# step #{index + 1}" if @options.debug
       file.puts element[:element][:action]
       file.puts element[:element][:response]
@@ -81,18 +85,26 @@ EOF
     out = []
 
     has_id = false
-    test.description.to_s.strip.lines.map(&:chomp).each_with_index do |line, line_no|
+    test.description.to_s.strip.lines.map(&:chomp).each_with_index do |line, _line_no|
       line = line.gsub(/\#+$/, '').strip
 
       # make sure the test has an ID
-      has_id = true if line[0] == "!"
+      has_id = true if line[0] == '!'
 
-      out << "#" + line
+      out << '#' + line
     end
 
     unless has_id
-      browsers = test.browsers.map {|b| b[:name] if b[:state] == "enabled" }.compact
-      out = ["#! #{SecureRandom.uuid}", "# title: #{test.title}", "# start_uri: #{test.start_uri}", "# tags: #{test.tags.join(", ")}", "# browsers: #{browsers.join(", ")}", "#", " "] + out
+      browsers = test.browsers.map {|b| b[:name] if b[:state] == 'enabled' }.compact
+      out = [
+        "#! #{SecureRandom.uuid}",
+        "# title: #{test.title}",
+        "# start_uri: #{test.start_uri}",
+        "# tags: #{test.tags.join(", ")}",
+        "# browsers: #{browsers.join(", ")}",
+        '#',
+        ' ',
+      ] + out
     end
 
     out.compact.join("\n")
@@ -100,9 +112,9 @@ EOF
 
   def _get_id test
     id = nil
-    test.description.to_s.strip.lines.map(&:chomp).each_with_index do |line, line_no|
+    test.description.to_s.strip.lines.map(&:chomp).each_with_index do |line, _line_no|
       line = line.gsub(/\#+$/, '').strip
-      if line[0] == "!"
+      if line[0] == '!'
         id = line[1..-1].split(' ').first
         break
       end
@@ -110,57 +122,24 @@ EOF
     id
   end
 
-  def upload
-    # 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
-      end
-
-      upload_groups << new_ordered_group
-      queued_tests = unordered_tests
-      unordered_tests = []
-    end
-
-    logger.info "Uploading tests..."
-
-    # 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
-
   def validate
     tests = {}
     has_errors = []
 
     Dir.glob(test_files.test_paths).each do |file_name|
-      out = RainforestCli::TestParser::Parser.new(File.read(file_name)).process
+      out = RainforestCli::TestParser::Parser.new(file_name).process
 
       tests[file_name] = out
       has_errors << file_name if out.errors != {}
     end
 
     if !has_errors.empty?
-      logger.error "Parsing errors:"
-      logger.error ""
+      logger.error 'Parsing errors:'
+      logger.error ''
       has_errors.each do |file_name|
-        logger.error " " + file_name
-        tests[file_name].errors.each do |line, error|
-          logger.error "\t#{error.to_s}"
+        logger.error ' ' + file_name
+        tests[file_name].errors.each do |_line, error|
+          logger.error "\t#{error}"
         end
       end
 
@@ -168,7 +147,7 @@ EOF
     end
 
     if @options.debug
-      tests.each do |file_name,test|
+      tests.each do |file_name, test|
         logger.debug test.inspect
         logger.debug "#{file_name}"
         logger.debug test.description
@@ -177,7 +156,7 @@ EOF
         end
       end
     else
-      logger.info "[VALID]"
+      logger.info '[VALID]'
     end
 
     return tests
@@ -191,112 +170,13 @@ EOF
     uuid = SecureRandom.uuid
     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)) }
+    FileUtils.mkdir_p(test_files.test_folder) unless Dir.exist?(test_files.test_folder)
+    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