effective_test_bot 0.4.3 → 0.4.4

data/test/support/effective_test_bot_form_helper.rb

@@ -1,141 +1,69 @@
 require 'timeout'
 
 module EffectiveTestBotFormHelper
-  DIGITS = ('1'..'9').to_a
-  LETTERS = ('A'..'Z').to_a
-
-  # fill_form(:email => 'somethign@soneone.com', :password => 'blahblah', 'user.last_name' => 'hlwerewr')
+  # Intelligently fills a form with Faker based randomish input
+  # Delegates the form fill logic to effective_test_bot_form_filler
   def fill_form(fills = {})
-    fills = HashWithIndifferentAccess.new(fills)
+    fills = HashWithIndifferentAccess.new(fills) unless fills.kind_of?(HashWithIndifferentAccess)
+
+    bootstrap_tabs = all("a[data-toggle='tab']")
 
-    # Support for the cocoon gem
-    all('a.add_fields[data-association-insertion-template]').each do |cocoon_add_field|
-      next unless cocoon_add_field.visible?
-      [1,2].sample.times { cocoon_add_field.click() }
+    if bootstrap_tabs.length > 1
+      fill_bootstrap_tabs_form(fills, bootstrap_tabs)
+    else
+      fill_form_fields(fills)
     end
+    true
+  end
 
-    all('input,select,textarea').each do |field|
-      next unless field.visible?
-
-      case [field.tag_name, field['type']].compact.join('_')
-      when 'input_text', 'input_email', 'input_password', 'input_tel', 'input_number', 'textarea'
-        field.set(fill_value(field, fills))
-      when 'input_checkbox', 'input_radio'
-        field.set(fill_value(field, fills)) # TODO
-      when 'select'
-        field.select(fill_value(field, fills), match: :first)
-      when 'input_file'
-        file_path = fill_value(field, fills)
-        field['class'].to_s.include?('asset-box-uploader-fileinput') ? upload_effective_asset(field, file_path) : field.set(file_path)
-      when 'input_submit', 'input_search'
-        # Do nothing
-      else
-        raise "unsupported field type #{[field.tag_name, field['type']].compact.join('_')}"
-      end
+  # This submits the form, while checking for html5 form validation errors and unpermitted params
+  def submit_form(label = nil)
+    assert_no_html5_form_validation_errors unless test_bot_skip?(:no_html5_form_validation_errors)
+
+    if test_bot_skip?(:no_unpermitted_params)
+      click_submit(label)
+    else
+      with_raised_unpermitted_params_exceptions { click_submit(label) }
     end
 
+    assert_no_unpermitted_params unless test_bot_skip?(:no_unpermitted_params)
     true
   end
 
-  def clear_form
-    all('input,select,textarea').each { |field| (field.set('') rescue false) }
+  # Submit form after disabling any HTML5 validations
+  def submit_novalidate_form(label = nil)
+    page.execute_script "for(var f=document.forms,i=f.length;i--;)f[i].setAttribute('novalidate','');"
+    click_submit(label)
     true
   end
 
-  # Operates on just string keys
-  # This function receives the same fill values that you call fill_form with
-  def fill_value(field, fills = nil)
-    attributes = field['name'].to_s.gsub(']', '').split('[') # user[something_attributes][last_name] => ['user', 'something_attributes', 'last_name']
-    field_name = [field.tag_name, field['type']].compact.join('_')
-    fill_value = nil
-
-    if fills.present?
-      key = nil
-      attributes.reverse_each do |name|  # match last_name, then something_attributes.last_name, then user.something_attributes.last_name
-        key = (key.present? ? "#{name}.#{key}" : name) # builds up the string as we go along
-
-        if fills.key?(key)
-          fill_value = fills[key]
-          # select is treated differently, because we want the passed prefill to match both the html text or value (which is implemented below)
-          ['select'].include?(field_name) ? break : (return fill_value)
-        end
-      end
-    end
-
-    case field_name
-    when 'input_email'
-      Faker::Internet.email
-    when 'input_number'
-      min = (Float(field['min']) rescue 1)
-      max = (Float(field['max']) rescue 1000)
-      number = Random.new.rand(min..max)
-      number.kind_of?(Float) ? number.round(2) : number
-    when 'input_password'
-      @test_bot_password ||= Faker::Internet.password  # Use the same password throughout a single test. Allows passwords and password_confirmations to match.
-    when 'input_tel'
-      d = 10.times.map { DIGITS.sample }
-      d[0] + d[1] + d[2] + '-' + d[3] + d[4] + d[5] + '-' + d[6] + d[7] + d[8] + d[9]
-    when 'input_text'
-      classes = field['class'].to_s.split(' ')
-
-      if classes.include?('date') # Let's assume this is a date input.
-        Faker::Date.backward(365).strftime('%Y-%m-%d')
-      elsif classes.include?('datetime')
-        Faker::Date.backward(365).strftime('%Y-%m-%d %H:%m')
-      elsif classes.include?('price')
-        4.times.map { DIGITS.sample }.join('') + '.00'
-      elsif classes.include?('numeric')
-        min = (Float(field['min']) rescue 1)
-        max = (Float(field['max']) rescue 1000)
-        number = Random.new.rand(min..max)
-        number.kind_of?(Float) ? number.round(2) : number
-      elsif attributes.last.to_s.include?('first_name')
-        Faker::Name.first_name
-      elsif attributes.last.to_s.include?('last_name')
-        Faker::Name.last_name
-      elsif attributes.last.to_s.include?('name')
-        Faker::Name.name
-      elsif attributes.last.to_s.include?('postal') # Make a Canadian Postal Code
-        LETTERS.sample + DIGITS.sample + LETTERS.sample + ' ' + DIGITS.sample + LETTERS.sample + DIGITS.sample
-      else
-        Faker::Lorem.word
-      end
-    when 'select'
-      if fill_value.present? # accept a value or text
-        field.all('option').each do |option|
-          return option.text if option.text == fill_value || option.value.to_s == fill_value.to_s
-        end
+  def clear_form
+    all('input,select,textarea').each do |field|
+      if field.tag_name == 'select' && field['class'].to_s.include?('select2') # effective_select
+        within(field.parent) { first(:css, '.select2-selection__clear').try(:click) }
       end
 
-      field.all('option').select { |option| option.value.present? }.sample.try(:text) || '' # Don't select an empty option
-    when 'textarea'
-      Faker::Lorem.sentence
-    when 'input_checkbox'
-      [true, false].sample
-    when 'input_radio'
-      [true, false].sample
-    when 'input_file'
-      "#{File.dirname(__FILE__)}/effective_assets_upload_file._test"
-    else
-      raise "fill_value unsupported field type: #{field['type']}"
+      begin
+        field.set(''); save_test_bot_screenshot
+      rescue => e; end
     end
-  end
 
-  # page.execute_script "$('form#new_#{resource_name}').submit();"
-  def submit_form(label = nil)
-    if label.present?
-      click_on(label)
-    else
-      first(:css, "input[type='submit']").click
-    end
-    synchronize!
     true
   end
 
-  # Submit form after disabling any HTML5 validations
-  def submit_novalidate_form(label = nil)
-    page.execute_script "for(var f=document.forms,i=f.length;i--;)f[i].setAttribute('novalidate','');"
-    submit_form(label)
+  # So it turns out capybara-webkit has no way to just move the mouse to an element
+  # This kind of sucks, as we want to simulate mouse movements with the tour
+  # Instead we manually trigger submit buttons and use the data-disable-with to
+  # make the 'submit form' step look nice
+  def click_submit(label)
+    if EffectiveTestBot.screenshots?
+      page.execute_script "$('input[data-disable-with]').each(function(i) { $.rails.disableFormElement($(this)); });"
+      save_test_bot_screenshot
+      page.execute_script "$('input[data-disable-with]').each(function(i) { $.rails.enableFormElement($(this)); });"
+    end
+
+    label.present? ? click_on(label) : first(:css, "input[type='submit']").click
+    synchronize!
   end
 
   def with_raised_unpermitted_params_exceptions(&block)
@@ -145,7 +73,7 @@ module EffectiveTestBotFormHelper
       action = ActionController::Parameters.action_on_unpermitted_parameters
       ActionController::Parameters.action_on_unpermitted_parameters = :raise
     rescue => e
-      puts 'unable to assign config.action_on_unpermitted_parameters = :raise, unpermitted params assertions disabled.'
+      puts 'unable to assign config.action_on_unpermitted_parameters = :raise, (no_unpermitted_params) assertions may not work.'
     end
 
     yield
@@ -153,40 +81,4 @@ module EffectiveTestBotFormHelper
     ActionController::Parameters.action_on_unpermitted_parameters = action if action.present?
   end
 
-  # The field here is going to be the %input{:type => file}. Files can be one or more pathnames
-  # http://stackoverflow.com/questions/5188240/using-selenium-to-imitate-dragging-a-file-onto-an-upload-element/11203629#11203629
-  def upload_effective_asset(field, files)
-    files = Array(files)
-    uid = field['id']
-
-    js = "fileList = Array();"
-
-    files.each_with_index do |file, i|
-      # Generate a fake input selector
-      page.execute_script("if($('#effectiveAssetsPlaceholder#{i}').length == 0) {effectiveAssetsPlaceholder#{i} = window.$('<input/>').attr({id: 'effectiveAssetsPlaceholder#{i}', type: 'file'}).appendTo('body'); }")
-
-      # Attach file to the fake input selector through Capybara
-      page.document.attach_file("effectiveAssetsPlaceholder#{i}", files[i])
-
-      # Build up the fake js event
-      js = "#{js} fileList.push(effectiveAssetsPlaceholder#{i}.get(0).files[0]);"
-    end
-
-    # Trigger the fake drop event
-    page.execute_script("#{js} e = $.Event('drop'); e.originalEvent = {dataTransfer : { files : fileList } }; $('#s3_#{uid}').trigger(e);")
-
-    # Wait till the Uploader bar goes away
-    begin
-      Timeout.timeout(files.length * 5) do
-        within("#asset-box-input-#{uid}") do
-          within('.uploads') do
-            sleep(0.25) while (first('.upload').present? rescue false)
-          end
-        end
-      end
-    rescue Timeout::Error
-      puts "file upload timed out after #{files.length * 5}s"
-    end
-
-  end
 end

data/test/support/effective_test_bot_screenshots_helper.rb

@@ -0,0 +1,145 @@
+require 'RMagick'
+
+module EffectiveTestBotScreenshotsHelper
+  include Magick
+
+  # Creates a screenshot based on the current test and the order in this test.
+  def save_test_bot_screenshot
+    return unless EffectiveTestBot.screenshots? && defined?(current_test)
+
+    full_path = current_test_temp_path + '/' + "#{current_test_screenshot_id}.png"
+    page.save_screenshot(full_path)
+
+    #i = Magick::Image.read(file).first
+    #i.resize_to_fill(100,100).write("#{file}-square-thumb.jpg")
+  end
+
+  # This is run before every test
+  # def before_setup
+  #   super
+  #   return unless (EffectiveTestBot.screenshots? && defined?(current_test))
+  # end
+
+  # This gets called after every test.  Minitest hook for plugin developers
+  def after_teardown
+    super
+    return unless EffectiveTestBot.screenshots? && defined?(current_test) && (@test_bot_screenshot_id || 0) > 0
+
+    if !passed? && EffectiveTestBot.autosave_animated_gif_on_failure?
+      save_test_bot_failure_gif
+    end
+
+    if passed? && EffectiveTestBot.tour_mode?
+      save_test_bot_tour_gif
+    end
+  end
+
+  def save_test_bot_failure_gif
+    Dir.mkdir(current_test_failure_path) unless File.exists?(current_test_failure_path)
+    full_path = (current_test_failure_path + '/' + current_test_failure_filename)
+
+    save_test_bot_gif(full_path)
+    puts_yellow("    Animated .gif: #{full_path}")
+  end
+
+  def save_test_bot_tour_gif
+    Dir.mkdir(current_test_tour_path) unless File.exists?(current_test_tour_path)
+    full_path = (current_test_tour_path + '/' + current_test_tour_filename)
+
+    save_test_bot_gif(full_path)
+    puts_green("    Tour .gif: #{full_path}") if EffectiveTestBot.tour_mode_verbose?
+  end
+
+  def without_screenshots(&block)
+    original = EffectiveTestBot.screenshots
+
+    EffectiveTestBot.screenshots = false
+    yield
+    EffectiveTestBot.screenshots = original
+  end
+
+  protected
+
+  def save_test_bot_gif(full_path)
+
+    png_images = @test_bot_screenshot_id.times.map do |x|
+      current_test_temp_path + '/' + format_screenshot_id(x+1) + '.png'
+    end
+
+    images = Magick::ImageList.new(*png_images)
+
+    # Get max dimensions.
+    dimensions = {width: 0, height: 0}
+    images.each do |image|
+      dimensions[:width] = [image.columns, dimensions[:width]].max
+      dimensions[:height] = [image.rows, dimensions[:height]].max
+    end
+
+    # Create a final ImageList
+    animation = Magick::ImageList.new()
+
+    # Remove the PNG's alpha channel, 'cause .gifs dont support it
+    # Extend the bottom/right of each image to extend upto dimension
+    images.each do |image|
+      image.alpha Magick::DeactivateAlphaChannel
+      #image.background_color = 'white'
+      animation << image.extent(dimensions[:width], dimensions[:height])
+    end
+
+    # Run it through optimize layers.
+    # https://rmagick.github.io/ilist.html#optimize_layers
+    animation = animation.optimize_layers(Magick::OptimizePlusLayer)
+
+    # Write the final animated gif
+    animation.delay = 100 # 100 is the right setting
+    animation.write(full_path)
+  end
+
+  # There are 3 different paths we're working with
+  # current_test_temp_path: contains individually numbered .png screenshots produced by capybara
+  # current_test_tour_path: destination for .gifs of passing tests
+  # current_test_failure_path: destination for .gifs of failing tests
+
+  def current_test_temp_path
+    @_current_test_temp_path ||= File.join(Rails.root, 'tmp', 'test_bot', current_test)
+  end
+
+  def current_test_failure_path
+    File.join(Rails.root, 'tmp', 'test_bot')
+  end
+
+  def current_test_failure_filename
+    # Match Capybara-screenshots format-ish
+    "#{current_test}_failure_#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}.gif"
+  end
+
+  # Where the tour animated gif ends up
+  def current_test_tour_path
+    File.join(Rails.root, 'test', 'tour')
+  end
+
+  def current_test_tour_filename
+    current_test + '.gif'
+  end
+
+  private
+
+  # Auto incrementing counter
+  # The very first screenshot will be 01.png (tmp/test_bot/posts#new/01.png)
+  def current_test_screenshot_id
+    @test_bot_screenshot_id = (@test_bot_screenshot_id || 0) + 1
+    format_screenshot_id(@test_bot_screenshot_id)
+  end
+
+  def format_screenshot_id(number)
+    number < 10 ? "0#{number}" : number.to_s
+  end
+
+  def puts_yellow(text)
+    puts "\e[33m#{text}\e[0m" # 33 is yellow
+  end
+
+  def puts_green(text)
+    puts "\e[32m#{text}\e[0m" # 32 is green
+  end
+end

data/test/support/effective_test_bot_test_helper.rb

@@ -17,6 +17,7 @@ module EffectiveTestBotTestHelper
     @flash = (JSON.parse(Base64.decode64(session.driver.response_headers['Test-Bot-Flash'])) rescue {})
     @assigns = (JSON.parse(Base64.decode64(session.driver.response_headers['Test-Bot-Assigns'])) rescue {})
     @unpermitted_params = (JSON.parse(Base64.decode64(session.driver.response_headers['Test-Bot-Unpermitted-Params'])) rescue [])
+    @exceptions = (JSON.parse(Base64.decode64(session.driver.response_headers['Test-Bot-Exceptions'])) rescue [])
 
     @visit_delete_page = session
   end
@@ -35,7 +36,7 @@ module EffectiveTestBotTestHelper
   end
 
   # EffectiveTestBot includes an after_filter on ApplicationController to set an http header
-  # that encodes the flash message, and some of the assigns
+  # These values are 'from the last page submit or refresh'
   def flash
     @flash ||= (JSON.parse(Base64.decode64(page.response_headers['Test-Bot-Flash'])) rescue {})
   end

data/test/test_bot/integration/application_test.rb

@@ -65,9 +65,10 @@ module TestBot
 
       def is_crud_controller?(route)
         return false unless CRUD_ACTIONS.include?(route.defaults[:action])
+        return false unless route.defaults[:controller].present? && route.app.respond_to?(:controller)
 
-        controller_klass = (route.app.controller(route.defaults) rescue nil) if route.defaults[:controller].present? && route.app.respond_to?(:controller)
-        controller_instance = controller_klass.new() if controller_klass
+        controller_klass = (route.app.controller(route.defaults) rescue nil)
+        controller_instance = controller_klass.new()
 
         # Is this a CRUD capable controller?
         controller_instance && controller_instance.respond_to?(:new) && controller_instance.respond_to?(:create)

data/test/test_bot/integration/environment_test.rb

@@ -5,7 +5,7 @@ module TestBot
     @@original_users_count = User.count
     let(:original_users_count) { @@original_users_count }
 
-    let(:email) { 'unique@testbot.com'}
+    let(:email) { 'unique@testbot.com' }
     let(:password) { '!Password123' }
     let(:create_user!) { User.new(email: email, password: password, password_confirmation: password).save(validate: false) }
 
@@ -14,7 +14,7 @@ module TestBot
     end
 
     test '01: seeds and fixtures loaded' do
-      assert_normal
+      assert_environment_normal
     end
 
     test '02: all fixtures and seeds valid' do
@@ -40,7 +40,7 @@ module TestBot
     end
 
     test '05: test database has reset' do
-      assert_normal
+      assert_environment_normal
     end
 
     test '06: capybara can sign up a user' do
@@ -53,7 +53,7 @@ module TestBot
 
     test '07: database and session have reset' do
       assert_signed_out
-      assert_normal
+      assert_environment_normal
     end
 
     test '08: capybara can login_as via warden test helper' do
@@ -64,7 +64,7 @@ module TestBot
 
     test '09: database and session have reset' do
       assert_signed_out
-      assert_normal
+      assert_environment_normal
     end
 
     test '10: capybara can sign in manually' do
@@ -75,21 +75,17 @@ module TestBot
 
     test '11: database and session have reset' do
       assert_signed_out
-      assert_normal
+      assert_environment_normal
     end
 
     private
 
-    def assert_normal
+    # This is all about seeing if the cookies, session, and database are rolling back properly in between tests
+    def assert_environment_normal
       visit root_path
       assert_page_status
-      assert_equal original_users_count, User.count, 'Epected User.count to be back to original'
+      assert_equal original_users_count, User.count, 'Expected User.count to be back to original'
       assert assigns[:current_user].blank?, 'Expected current_user to be blank'
-
-      # Someitmes it's nice to assert your environment...
-      #assert users(:normal).present?
-      #assert 2, User.count
-      #assert 3, Physician.count
     end
 
   end