effective_test_bot 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64b44fba9d50f01fd32b612de3d11d810c6ba12a
-  data.tar.gz: a07e93aee37f18a0af63098c6ac6ac540d61d8a8
+  metadata.gz: 24fabf2bbe4a09876a2920587a60881ef48559e1
+  data.tar.gz: fd5df539a7a87cdd4b0ca95854c3917d34793c31
 SHA512:
-  metadata.gz: 5ba5cc490a7296da4d6a82f33faa5cc7bce2f8b2cbe29b01b913812bd59963b0381d73c58d886792144a8a318f27c56389ebdbc5412451abcf624863f0e6bbc7
-  data.tar.gz: fc19738de32fde123f04dd8b606eb17627236601323dc8a9267d58a5d88ca195a467943a97a5ba9efb9fe6a0004b8711bb1fc3c37ffe1863f69309e391a1c75f
+  metadata.gz: 8cd5f562b9690e6a9f593f3cc9702198d8a5bdcd1a6493b07831f765d601c77a59407083f77e1a8cb967a5802c0b4d85034cf531d9744a05714c173d17f71ced
+  data.tar.gz: 34737fdab12778d809e632761248cd23cbbcca8c3a388d64806d7437fe7814cce4ea27679f12ac59ae54a664f2718dd45fccde95dcfafad2268a519b2b900518

data/app/helpers/effective_test_bot_controller_helper.rb

@@ -3,22 +3,18 @@ module EffectiveTestBotControllerHelper
 
   # This is included as an after_action in the controller
   def assign_test_bot_payload(payload = {})
-    return unless response.content_type == 'text/html'.freeze
-    return unless !!(response.body[BODY_TAG])
-
     payload.merge!({ response_code: response.code, assigns: test_bot_view_assigns, flash: flash.to_hash })
 
-    payload = view_context.content_tag(:script, id: 'test_bot_payload') do
-      [
-        '',
-        'window.effective_test_bot = {};',
-        payload.map { |k, v| "window.effective_test_bot.#{k} = #{v.respond_to?(:to_json) ? v.to_json : ("'" + v + "'")};" },
-        '',
-      ].join("\n").html_safe
-    end
+    if response.content_type == 'text/html' && response.body[BODY_TAG].present?
+      payload = view_context.content_tag(:script, build_payload_javascript(payload), id: 'test_bot_payload')
+
+      split = response.body.split(BODY_TAG)
+      response.body = "#{split.first}#{payload}#{BODY_TAG}#{split.last if split.size > 1}"
+    elsif response.content_type == 'text/javascript' && response.body.present?
+      payload = build_payload_javascript(payload)
 
-    split = response.body.split(BODY_TAG)
-    response.body = "#{split.first}#{payload}#{BODY_TAG}#{split.last if split.size > 1}"
+      response.body = "#{response.body};#{payload}"
+    end
   end
 
   # This is called in an ActionController rescue_from.
@@ -28,6 +24,15 @@ module EffectiveTestBotControllerHelper
 
   private
 
+  def build_payload_javascript(payload)
+    [
+      '',
+      'window.effective_test_bot = {};',
+      payload.map { |k, v| "window.effective_test_bot.#{k} = #{v.respond_to?(:to_json) ? v.to_json : ("'" + v + "'")};" },
+      '',
+    ].join("\n").html_safe
+  end
+
   def test_bot_access_denied(exception)
     {
       access_denied: exception,

data/lib/effective_test_bot.rb

@@ -1,6 +1,7 @@
 require 'effective_resources'
 require 'effective_test_bot/engine'
 require 'effective_test_bot/dsl'
+require 'effective_test_bot/middleware'
 require 'effective_test_bot/version'
 
 module EffectiveTestBot

data/lib/effective_test_bot/engine.rb

@@ -12,6 +12,12 @@ module EffectiveTestBot
       eval File.read("#{config.root}/config/effective_test_bot.rb")
     end
 
+    initializer 'effective_test_bot.middleware' do |app|
+      if Rails.env.test?
+        Rails.application.config.middleware.use EffectiveTestBot::Middleware
+      end
+    end
+
     initializer 'effective_test_bot.email_logger' do |app|
       if Rails.env.test?
         ActiveSupport.on_load :action_mailer do

data/lib/effective_test_bot/middleware.rb

@@ -0,0 +1,40 @@
+# Watch for any rails server exceptions and write the stacktrace to ./tmp/test_bot/exception.txt
+# This file is checked for by assert_no_exceptions
+
+module EffectiveTestBot
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        @app.call(env)
+      rescue Exception => exception
+        begin
+          save(exception)
+        rescue => e
+          puts "TestBotError: An error occurred while attempting to save a rails server exception: #{e.message}"
+        end
+
+        raise exception
+      end
+    end
+
+    def save(exception)
+      lines = [exception.message] + exception.backtrace.first(EffectiveTestBot&.backtrace_lines || 10)
+
+      dir = File.join(Dir.pwd, 'tmp', 'test_bot')
+      file = File.join(dir, 'exception.txt')
+
+      Dir.mkdir(dir) unless File.exist?(dir)
+      File.delete(file) if File.exist?(file)
+
+      File.open(file, 'w') do |file|
+        file.write "================== Start server exception ==================\n"
+        lines.each { |line| file.write(line); file.write("\n") }
+        file.write "=================== End server exception ===================\n"
+      end
+    end
+  end
+end

data/lib/effective_test_bot/version.rb

@@ -1,3 +1,3 @@
 module EffectiveTestBot
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/test/support/effective_test_bot_assertions.rb

@@ -17,6 +17,17 @@ module EffectiveTestBotAssertions
     assert assigns['current_user'].blank?, message || 'Expected @current_user to be blank when signed out'
   end
 
+  def assert_no_exceptions(message = "(no_exceptions) Unexpected rails server exception:\n:exception:")
+    # this file is created by EffectiveTestBot::Middleware when an exception is encountered in the rails app
+    file = File.join(Dir.pwd, 'tmp', 'test_bot', 'exception.txt')
+    return unless File.exist?(file)
+
+    exception = File.read(file)
+    File.delete(file)
+
+    assert false, message.sub(':exception:', exception)
+  end
+
   def assert_can_execute_javascript(message = "Expected page.evaluate_script() to be successful")
     error = nil; result = nil;
 
@@ -60,7 +71,7 @@ module EffectiveTestBotAssertions
 
       info = [
         "Encountered a 403 Access Denied",
-        ("(cannot :#{exception['action']}, #{exception['subject']})" if exception.present?),
+        ("(cannot :#{exception[:action]}, #{exception[:subject]})" if exception.present?),
         "on #{page.current_path} as user #{user || 'no user'}.",
         ("\nAdd assign_test_bot_access_denied_exception(exception) if defined?(EffectiveTestBot) to the very bottom of your ApplicationController's rescue_from block to gather more information." unless exception.present?),
       ].compact.join(' ')

data/test/support/effective_test_bot_form_helper.rb

@@ -28,6 +28,7 @@ module EffectiveTestBotFormHelper
     end
 
     assert_no_assigns_errors unless test_bot_skip?(:no_assigns_errors)
+    assert_no_exceptions unless test_bot_skip?(:exceptions)
     assert_authorization unless test_bot_skip?(:authorization)
     assert_page_status unless test_bot_skip?(:page_status)
 
@@ -37,6 +38,7 @@ module EffectiveTestBotFormHelper
   # 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','');"
+    page.execute_script "$('form').find('[required]').removeAttr('required');"
     click_submit(label)
     true
   end

data/test/support/effective_test_bot_test_helper.rb

@@ -53,7 +53,11 @@ module EffectiveTestBotTestHelper
 
   # Calls capybara within do .. end if selector is present and bool is true
   def within_if(selector, bool = true, &block)
-    (selector.present? && bool) ? within(selector) { yield } : yield
+    (selector.present? && bool) ? within(first(selector)) { yield } : yield
+  end
+
+  def within_each(selector, &block)
+    all(selector).each { |field| within(field) { yield } }
   end
 
   def click_first(label)
@@ -63,7 +67,7 @@ module EffectiveTestBotTestHelper
   # EffectiveTestBot includes an after_filter on ApplicationController to set an http header
   # These values are 'from the last page submit or refresh'
   def response_code
-    page.evaluate_script('window.effective_test_bot.response_code')&.to_i
+    (page.evaluate_script('window.effective_test_bot.response_code')&.to_i rescue nil)
   end
 
   def flash
@@ -78,9 +82,9 @@ module EffectiveTestBotTestHelper
     return nil unless page.evaluate_script('window.effective_test_bot.access_denied').present?
 
     {
-      'exception': page.evaluate_script('window.effective_test_bot.access_denied'),
-      'action': page.evaluate_script('window.effective_test_bot.action'),
-      'subject': page.evaluate_script('window.effective_test_bot.subject')
+      exception: page.evaluate_script('window.effective_test_bot.access_denied'),
+      action: page.evaluate_script('window.effective_test_bot.action'),
+      subject: page.evaluate_script('window.effective_test_bot.subject')
     }
   end
 

data/test/test_botable/base_test.rb

@@ -8,6 +8,7 @@ module BaseTest
     return if test_bot_skip?(:normal)
 
     assert_authorization unless test_bot_skip?(:authorization)
+    assert_no_exceptions unless test_bot_skip?(:exceptions)
     assert_page_status unless test_bot_skip?(:page_status)
     assert_no_js_errors unless test_bot_skip?(:no_js_errors)
     assert_page_title unless (test_bot_skip?(:page_title) || all('head').blank?)
@@ -53,6 +54,7 @@ module BaseTest
       visit(new_path)
 
       assert_authorization(hint)
+      assert_no_exceptions
       assert_page_status
 
       assert_form("form#new_#{resource_name}", "TestBotError: Failed to find form#new_#{resource_name}. #{hint}") unless test_bot_skip?(:form)
@@ -64,6 +66,7 @@ module BaseTest
         submit_novalidate_form
 
         assert_authorization(hint)
+        assert_no_exceptions
         assert_page_status
       end
 
@@ -93,23 +96,23 @@ module BaseTest
     (page.document.first(:css, selector) rescue nil)
   end
 
+  def effective_resource
+    @effective_resource ||= Effective::Resource.new([controller_namespace, resource_class].join('/'))
+  end
+
   def resources_path # index, create
-    path = polymorphic_path([*controller_namespace, resource_class]) rescue nil
-    path || polymorphic_path([*controller_namespace.try(:singularize), resource_class])
+    effective_resource.action_path(:index)
   end
 
   def resource_path(resource) # show, update, destroy
-    path = polymorphic_path([*controller_namespace, resource]) rescue nil
-    path || polymorphic_path([*controller_namespace.try(:singularize), resource])
+    effective_resource.action_path(:show, resource)
   end
 
   def new_resource_path # new
-    path = new_polymorphic_path([*controller_namespace, resource_class]) rescue nil
-    path || new_polymorphic_path([*controller_namespace.try(:singularize), resource_class])
+    effective_resource.action_path(:new)
   end
 
   def edit_resource_path(resource) # edit
-    path = edit_polymorphic_path([*controller_namespace, resource]) rescue nil
-    path || edit_polymorphic_path([*controller_namespace.try(:singularize), resource])
+    effective_resource.action_path(:edit, resource)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: effective_test_bot
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Code and Effect
@@ -160,6 +160,7 @@ files:
 - lib/effective_test_bot.rb
 - lib/effective_test_bot/dsl.rb
 - lib/effective_test_bot/engine.rb
+- lib/effective_test_bot/middleware.rb
 - lib/effective_test_bot/version.rb
 - lib/generators/effective_test_bot/install_generator.rb
 - lib/tasks/effective_test_bot_tasks.rake