rainforest-cli 1.0.6 → 1.1.0

data/lib/rainforest/cli/runner.rb

@@ -1,156 +1,153 @@
-module Rainforest
-  module Cli
-    class Runner
-      attr_reader :options, :client
-
-      def initialize(options)
-        @options = options
-        @client = HttpClient.new token: options.token
-      end
+module RainforestCli
+  class Runner
+    attr_reader :options, :client
 
-      def run
-        if options.import_file_name && options.import_name
-          delete_generator(options.import_name)
-          CSVImporter.new(options.import_name, options.import_file_name, options.token).import
-        end
+    def initialize(options)
+      @options = options
+      @client = HttpClient.new token: options.token
+    end
 
-        post_opts = make_create_run_options
+    def run
+      if options.import_file_name && options.import_name
+        delete_generator(options.import_name)
+        CSVImporter.new(options.import_name, options.import_file_name, options.token).import
+      end
 
-        logger.debug "POST options: #{post_opts.inspect}"
-        logger.info "Issuing run"
+      post_opts = make_create_run_options
 
-        response = client.post('/runs', post_opts)
+      logger.debug "POST options: #{post_opts.inspect}"
+      logger.info "Issuing run"
 
-        if response['error']
-          logger.fatal "Error starting your run: #{response['error']}"
-          exit 1
-        end
+      response = client.post('/runs', post_opts)
 
+      if response['error']
+        logger.fatal "Error starting your run: #{response['error']}"
+        exit 1
+      end
 
-        if options.foreground?
-          run_id = response.fetch("id")
-          wait_for_run_completion(run_id)
-        else
-          true
-        end
+      if options.foreground?
+        run_id = response.fetch("id")
+        wait_for_run_completion(run_id)
+      else
+        true
       end
+    end
 
-      def wait_for_run_completion(run_id)
-        running = true
-        while running
-          Kernel.sleep 5
-          response = client.get("/runs/#{run_id}")
-          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?
-            else
-              logger.info "Run #{run_id} is now #{response["state"]} and has #{response["result"]}"
-              running = false
-            end
+    def wait_for_run_completion(run_id)
+      running = true
+      while running
+        Kernel.sleep 5
+        response = client.get("/runs/#{run_id}")
+        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?
+          else
+            logger.info "Run #{run_id} is now #{response["state"]} and has #{response["result"]}"
+            running = false
           end
         end
+      end
 
-        if url = response["frontend_url"]
-          logger.info "The detailed results are available at #{url}"
-        end
+      if url = response["frontend_url"]
+        logger.info "The detailed results are available at #{url}"
+      end
 
-        if response["result"] != "passed"
-          exit 1
-        end
+      if response["result"] != "passed"
+        exit 1
       end
+    end
 
-      def make_create_run_options
-        post_opts = {}
-        if options.git_trigger?
-          logger.debug "Checking last git commit message:"
-          commit_message = GitTrigger.last_commit_message
-          logger.debug commit_message
+    def make_create_run_options
+      post_opts = {}
+      if options.git_trigger?
+        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"
-          else
-            logger.warn "Specified tests are ignored when using --git-trigger"
-          end
+        # Show some messages to users about tests/tags being overriden
+        unless options.tags.empty?
+          logger.warn "Specified tags are ignored when using --git-trigger"
+        else
+          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 "\t'some message. @rainforest #tag1 #tag2"
-              exit 2
-            else
-              post_opts[:tags] = [tags.join(',')]
-            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 "\t'some message. @rainforest #tag1 #tag2"
+            exit 2
           else
-            logger.info "Not triggering as @rainforest was not mentioned in last commit message."
-            exit 0
+            post_opts[:tags] = [tags.join(',')]
           end
         else
-          # Not using git_trigger, so look for the
-          if !options.tags.empty?
-            post_opts[:tags] = options.tags
-          elsif !options.folder.nil?
-            post_opts[:smart_folder_id] = @options.folder.to_i
-          else
-            post_opts[:tests] = options.tests
-          end
+          logger.info "Not triggering as @rainforest was not mentioned in last commit message."
+          exit 0
         end
-
-        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
-        post_opts[:description] = options.description if options.description
-
-        if options.custom_url
-          post_opts[:environment_id] = get_environment_id(options.custom_url)
-        elsif options.environment_id
-          post_opts[:environment_id] = options.environment_id
+      else
+        # Not using git_trigger, so look for the
+        if !options.tags.empty?
+          post_opts[:tags] = options.tags
+        elsif !options.folder.nil?
+          post_opts[:smart_folder_id] = @options.folder.to_i
+        else
+          post_opts[:tests] = options.tests
         end
-
-        post_opts
       end
 
-      def logger
-        Rainforest::Cli.logger
-      end
+      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
+      post_opts[:description] = options.description if options.description
 
-      def list_generators
-        client.get("/generators")
+      if options.custom_url
+        post_opts[:environment_id] = get_environment_id(options.custom_url)
+      elsif options.environment_id
+        post_opts[:environment_id] = options.environment_id
       end
 
-      def delete_generator(name)
-        generator = list_generators.find {|g| g['generator_type'] == 'tabular' && g['name'] == name }
-        client.delete("generators/#{generator['id']}") if generator
-      end
+      post_opts
+    end
 
-      def url_valid?(url)
-        return false unless URI::regexp === url
+    def logger
+      RainforestCli.logger
+    end
 
-        uri = URI.parse(url)
-        %w(http https).include?(uri.scheme)
-      end
+    def list_generators
+      client.get("/generators")
+    end
 
-      def get_environment_id url
-        unless url_valid?(url)
-          logger.fatal "The custom URL is invalid"
-          exit 2
-        end
+    def delete_generator(name)
+      generator = list_generators.find {|g| g['generator_type'] == 'tabular' && g['name'] == name }
+      client.delete("generators/#{generator['id']}") if generator
+    end
 
-        env_post_body = { name: 'temporary-env-for-custom-url-via-CLI', url: url }
-        environment = client.post("/environments", env_post_body)
+    def url_valid?(url)
+      return false unless URI::regexp === url
 
-        if environment['error']
-          # I am talking about a URL here because the environments are pretty
-          # much hidden from clients so far.
-          logger.fatal "Error creating the ad-hoc URL: #{environment['error']}"
-          exit 1
-        end
+      uri = URI.parse(url)
+      %w(http https).include?(uri.scheme)
+    end
 
-        return environment['id']
+    def get_environment_id url
+      unless url_valid?(url)
+        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)
+
+      if environment['error']
+        # I am talking about a URL here because the environments are pretty
+        # much hidden from clients so far.
+        logger.fatal "Error creating the ad-hoc URL: #{environment['error']}"
+        exit 1
+      end
+
+      return environment['id']
     end
   end
 end

data/lib/rainforest/cli/test_importer.rb

@@ -0,0 +1,238 @@
+require 'securerandom'
+require 'rainforest'
+require 'parallel'
+require 'ruby-progressbar'
+
+class RainforestCli::TestImporter
+  attr_reader :options, :client
+  SPEC_FOLDER = 'spec/rainforest'.freeze
+  EXT = ".rfml".freeze
+  THREADS = 32.freeze
+
+  SAMPLE_FILE = <<EOF
+#! %s (this is the ID, don't edit it)
+# title: New test
+#
+# 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
+#
+
+EOF
+
+  def initialize(options)
+    @options = options
+    unless File.exists?(SPEC_FOLDER)
+      logger.fatal "Rainforest folder not found (#{SPEC_FOLDER})"
+      exit 2
+    end
+  end
+
+  def logger
+    RainforestCli.logger
+  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|
+
+      # File name
+      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)
+
+      # Get the full test from the API
+      test = Rainforest::Test.retrieve(test.id)
+
+      File.open(file_name, 'a') do |file|
+        file.puts _get_header(test)
+
+        index = 0
+        test.elements.each do |element|
+          index = _process_element(file, element, index)
+        end
+      end
+    end
+  end
+
+  def _process_element file, element, index
+    case element[:type]
+    when 'test'
+      element[:element][:elements].each do |sub_element|
+        index = _process_element(file, sub_element, index)
+      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
+
+    index += 1
+    index
+  end
+
+  # add comments if not already present
+  def _get_header test
+    out = []
+
+    has_id = false
+    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] == "!"
+
+      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
+    end
+
+    out.compact.join("\n")
+  end
+
+  def _get_id test
+    id = nil
+    test.description.to_s.strip.lines.map(&:chomp).each_with_index do |line, line_no|
+      line = line.gsub(/\#+$/, '').strip
+      if line[0] == "!"
+        id = line[1..-1].split(' ').first
+        break
+      end
+    end
+    id
+  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
+          }}
+        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)
+
+          logger.info "\tUpdated #{test.id} -- ##{t.id}" if @options.debug
+        else
+          t = Rainforest::Test.create(test_obj)
+
+          logger.info "\tCreated #{test.id} -- ##{t.id}" if @options.debug
+        end
+      rescue => e
+        logger.fatal "Error: #{test.id}: #{e}"
+        exit 2
+      end
+    end
+  end
+
+  def validate
+    tests = {}
+    has_errors = []
+
+    Dir.glob("#{SPEC_FOLDER}/**/*#{EXT}").each do |file_name|
+      out = RainforestCli::TestParser::Parser.new(File.read(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 ""
+      has_errors.each do |file_name|
+        logger.error " " + file_name
+        tests[file_name].errors.each do |line, error|
+          logger.error "\t#{error.to_s}"
+        end
+      end
+
+      exit 2
+    end
+
+    if @options.debug
+      tests.each do |file_name,test|
+        logger.debug test.inspect
+        logger.debug "#{file_name}"
+        logger.debug test.description
+        test.steps.each do |step|
+          logger.debug "\t#{step}"
+        end
+      end
+    else
+      logger.info "[VALID]"
+    end
+
+    return tests
+  end
+
+  def create_new file_name = nil
+    name = @options.file_name if @options.file_name
+    name = file_name if !file_name.nil?
+
+    uuid = SecureRandom.uuid
+    name = "#{uuid}#{EXT}" unless name
+    name += EXT unless name[-EXT.length..-1] == EXT
+    name = File.join([SPEC_FOLDER, name])
+
+    File.open(name, "w") { |file| file.write(sprintf(SAMPLE_FILE, uuid)) }
+
+    logger.info "Created #{name}" if file_name.nil?
+    name
+  end
+end