effective_test_bot 0.0.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4884b3837c09c059ee9cd8bd3b9a803937007fbf
-  data.tar.gz: d69257b14ead0e0872d5526136bea212e6c09e6d
+  metadata.gz: 6c091f3638ed0ef358cce23cb248daeb0f7040d3
+  data.tar.gz: d38922c2629ea9a12004fc150601331a47db6af7
 SHA512:
-  metadata.gz: b24f81eaf523bf55420e49764135ddeed87e67eeb4aba786c527070ea81d46bb8bb72cc6090663990717bfce82fcf90fa12cc19ca0b4cc0f6612cf4f5b7d03ad
-  data.tar.gz: 817b26e0068da69b9df9dc73364a1e1ff23cec1a2f781c457d3a64c3c7043a9cffca1784094e0d69a294874fdbe7d4ea4e23aa94a4090a90f30bbd27ddd35a46
+  metadata.gz: 3ae23c5221d6a46a3f2a369cd42a31d2e98d09c8e6b032286b14dd3920349a9503ca4360e8726eef3cb403541655512a16bcaa8f10a75e2547e90250fb7d0b7f
+  data.tar.gz: 5d690bb001ab760f86f1aa621a0c5e8876b1e53c16f248e221decb5493cd2e82fc919c71836bfb553fcc07d4ffe89b85367c15f261ea2e39217811e94421284a

data/README.md

@@ -2,7 +2,7 @@
 
 A shared library of rails model & capybara-based feature tests that should pass in every Rails application.
 
-Also provides a one-liner installation & configuration of rspec-rails, guard, and capybara test environment.
+Also provides a one-liner installation & configuration of minitest and capybara test environment.
 
 Rails 3.2.x and 4.x
 
@@ -27,33 +27,29 @@ Then run the generator:
 rails generate effective_test_bot:install
 ```
 
-The above command will first invoke the default `rspec-rails` and `guard` installation tasks, if they haven't already been run.
+The above command will first invoke the default `minitest` installation tasks, if they haven't already been run.
 
-It will then copy the packaged `spec_helper.rb`, `rails_helper.rb` and other rspec/testing configuration files that match this gem author's opinionated testing environment.
+It will then copy the packaged `test_helper.rb` that matches this gem author's opinionated testing environment.
 
-Run the test suite with either rspec, or guard, or as you normally would:
+Run the test suite with:
 
 ```ruby
-bundle exec guard # (then press ENTER)
-```
-
-or
-
-```ruby
-bundle exec rspec
+bundle exec rake test:bot
 ```
 
 You should now see multiple -- hopefully passing -- tests that you didn't write!
 
 
-### Existing rspec installation
+## Fixtures
 
-If you already have an existing rspec installation that works with `capybara` and `capybara-webkit`, you will only need to add this one line to your `spec/spec_helper.rb`:
+TODO
 
-```
-RSpec.configure do |config|
-  config.files_or_directories_to_run = ['spec', '../effective_test_bot/spec']
-end
+users.yml:
+
+```yaml
+normal:
+  email: 'normal@agilestyle.com'
+  encrypted_password: <%= Devise::Encryptor.digest(User, 'password') %>
 ```
 
 
@@ -64,17 +60,6 @@ MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
 Code and Effect is the product arm of [AgileStyle](http://www.agilestyle.com/), an Edmonton-based shop that specializes in building custom web applications with Ruby on Rails.
 
 
-## Testing
-
-The test suite for this gem is unfortunately not yet complete.
-
-Run tests by:
-
-```ruby
-rake spec
-```
-
-
 ## Contributing
 
 1. Fork it
@@ -83,5 +68,3 @@ rake spec
 4. Push to the branch (`git push origin my-new-feature`)
 5. Bonus points for test coverage
 6. Create new Pull Request
-
-#page.save_screenshot('sign-in-test-1.png')

data/lib/effective_test_bot/engine.rb

@@ -2,6 +2,10 @@ module EffectiveTestBot
   class Engine < ::Rails::Engine
     engine_name 'effective_test_bot'
 
+    config.autoload_paths += Dir["#{config.root}/test/concerns/**/"]
+    config.autoload_paths += Dir["#{config.root}/test/support/**/"]
+    config.autoload_paths += Dir["#{config.root}/test/test_botable/**/"]
+
     # Set up our default configuration options.
     initializer "effective_test_bot.defaults", :before => :load_config_initializers do |app|
       # Set up our defaults, as per our initializer template
@@ -10,7 +14,12 @@ module EffectiveTestBot
 
     initializer 'effective_test_bot.test_suite' do |app|
       Rails.application.config.to_prepare do
-        ActionDispatch::IntegrationTest.send(:include, EffectiveTestBotHelper)
+        ActionDispatch::IntegrationTest.send(:include, ActsAsTestBotable)
+
+        ActionDispatch::IntegrationTest.send(:include, EffectiveTestBotAssertions)
+        ActionDispatch::IntegrationTest.send(:include, EffectiveTestBotFormHelper)
+        ActionDispatch::IntegrationTest.send(:include, EffectiveTestBotLoginHelper)
+        ActionDispatch::IntegrationTest.send(:include, EffectiveTestBotTestHelper)
       end
     end
 

data/lib/effective_test_bot/version.rb

@@ -1,3 +1,4 @@
 module EffectiveTestBot
-  VERSION = '0.0.10'.freeze
+  VERSION = '0.2.0'.freeze
+
 end

data/lib/generators/effective_test_bot/install_generator.rb

@@ -13,19 +13,6 @@ module EffectiveTestBot
         run 'bundle exec rails generate minitest:install'
       end
 
-      # def install_rspec
-      #   return if File.exists?('spec/spec_helper.rb')
-      #   puts '[effective_test_bot] installing rspec'
-      #   run 'bundle exec rails generate rspec:install'
-      # end
-
-      # def install_guard
-      #   return if File.exists?('Guardfile')
-      #   puts '[effective_test_bot] installing guard'
-      #   run 'bundle exec guard init'
-      #   puts ""
-      # end
-
       def explain_overwrite
         puts '[effective_test_bot] Successfully installed/detected: minitest'
         puts ""
@@ -49,15 +36,9 @@ module EffectiveTestBot
       end
 
       def overwrite_minitest
-        template 'minitest/test_helper.rb', 'test/test_helper.rb'
+        template 'test_helper.rb', 'test/test_helper.rb'
       end
 
-      # def overwrite_rspec
-      #   template 'rspec/.rspec', '.rspec'
-      #   template 'rspec/rails_helper.rb', 'spec/rails_helper.rb'
-      #   template 'rspec/spec_helper.rb', 'spec/spec_helper.rb'
-      # end
-
       def thank_you
         puts "Thanks for using EffectiveTestBot"
         puts "Run tests by typing 'rake test:bot'"

data/lib/generators/templates/effective_test_bot.rb

@@ -1,4 +1,6 @@
 # EffectiveTestBot Rails Engine
 
-EffectiveTestBot.setup do |config|
+if Rails.env.test?
+  EffectiveTestBot.setup do |config|
+  end
 end

data/lib/generators/templates/{minitest/test_helper.rb → test_helper.rb}

@@ -11,6 +11,7 @@ require 'shoulda'
 
 require 'capybara/webkit'
 require 'capybara-screenshot/minitest'
+require 'capybara/slow_finder_errors'
 
 class ActiveSupport::TestCase
   # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
@@ -26,14 +27,16 @@ class ActionDispatch::IntegrationTest
   include Capybara::Screenshot::MiniTestPlugin
   include Warden::Test::Helpers if defined?(Devise)
 
-  # called before every single test
-  # def setup
+  # def setup # Called before every test
   # end
 
-  # called after every single test
-  def teardown
-    Capybara.reset_sessions!
+  # def teardown # Called after every single test
+  # end
+
+  def after_teardown # I reset sessions here so capybara-screenshot can still make screenshots when tests fail
+    super() and Capybara.reset_sessions!
   end
+
 end
 
 
@@ -50,6 +53,7 @@ Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
 
 # So the very first thing I do is set up a consistent database
 Rake::Task['db:schema:load'].invoke
+ActiveRecord::Migration.maintain_test_schema!
 
 # or the following 3:
 

data/lib/tasks/effective_test_bot_tasks.rake

@@ -1,36 +1,18 @@
 require 'rake/testtask'
 require 'rails/test_unit/sub_test_task'
 
-# namespace :test do
-#   task :bot => :environment do
-#     #Rails::TestTask.test_creator(Rake.application.top_level_tasks).invoke_rake_task
-
-#     #eval File.read("#{config.root}/lib/generators/templates/effective_test_bot.rb")
-#     Rails::TestTask.new('effective_test_bot' => 'test:prepare') do |t|
-#       t.libs << 'test'
-#       t.pattern = 'test/integration/**/*_test.rb'
-#       #t.test_files = FileList["../effective_test_bot/test/**/*_test.rb"].exclude('test/controllers/**/*_test.rb')
-#     end
-#   end
-# end
-
 namespace :test do
   desc 'Runs Effective Test Bot'
   task :bot do
     Rake::Task["test:effective_test_bot"].invoke
   end
 
-  #Rake::Task["db:seed"].invoke
-  # Or in rails 3 add to test/test_helper.rb
-  # Rails.application.load_seed
-
   Rails::TestTask.new('effective_test_bot' => 'test:prepare') do |t|
     t.libs << 'test'
-    t.test_files = FileList["#{File.dirname(__FILE__)}/../../test/**/*_test.rb"]
+    t.test_files = FileList["#{File.dirname(__FILE__)}/../../test/test_bot/**/*_test.rb"]
   end
-end
 
-# Rake::Task['db:fixtures:load'].enhance do
-#   Rake::Task['db:seed'].invoke
-# end
+
+
+end
 

data/test/concerns/acts_as_test_botable.rb

@@ -0,0 +1,57 @@
+module ActsAsTestBotable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    CRUD_ACTIONS = [:index, :new, :create, :edit, :update, :show, :destroy]
+
+    def crud_test(obj, user, options = {})
+      # Check for expected usage
+      unless (obj.kind_of?(Class) || obj.kind_of?(ActiveRecord::Base)) && user.kind_of?(User) && options.kind_of?(Hash)
+        puts 'invalid parameters passed to crud_test(), expecting crud_test(Post || Post.new(), User.first, options_hash)' and return
+      end
+
+      # Make sure Obj.new() works
+      if obj.kind_of?(Class) && (obj.new() rescue false) == false
+        puts "effective_test_bot: failed to initialize object with #{obj}.new(), unable to proceed" and return
+      end
+
+      # Set up the crud_actions_to_test
+      crud_actions_to_test = if options[:only]
+        Array(options[:only]).flatten.compact.map(&:to_sym)
+      elsif options[:except]
+        (CRUD_ACTIONS - Array(options[:except]).flatten.compact.map(&:to_sym))
+      else
+        CRUD_ACTIONS
+      end
+
+      # Parse the resource and resourece class
+      resource = obj.kind_of?(Class) ? obj.new() : obj
+      resource_class = obj.kind_of?(Class) ? obj : obj.class
+
+      # If obj is an ActiveRecord object with attributes, Post.new(:title => 'My Title')
+      # then compute any explicit attributes, so forms will be filled with those values
+      resource_attributes = if obj.kind_of?(ActiveRecord::Base)
+        empty = resource_class.new()
+        {}.tap { |atts| resource.attributes.each { |k, v| atts[k] = v if empty.attributes[k] != v } }
+      end || {}
+
+      # Assign variables to be used in test/test_botable/crud_test.rb
+      let(:resource) { resource }
+      let(:resource_class) { resource_class }
+      let(:resource_name) { resource_class.name.underscore }
+      let(:resource_attributes) { resource_attributes }
+      let(:user) { user }
+      let(:controller_namespace) { options[:namespace] }
+      let(:crud_actions_to_test) { crud_actions_to_test }
+
+      include ::CrudTest
+
+      # This will run any CrudTest methods, in order, as it's defined in the file
+      # Then the rest of the methods in whatever order they occur originally (:random, :alpha, :sorted)
+      def self.runnable_methods
+        ::CrudTest.public_instance_methods.map { |name| name.to_s if name.to_s.starts_with?('test_bot') }.compact + super.select { |name| !name.starts_with?('test_bot') }
+      end
+    end
+
+  end
+end

data/test/support/effective_test_bot_assertions.rb

@@ -0,0 +1,26 @@
+module EffectiveTestBotAssertions
+  def assert_signed_in
+    visit new_user_session_path
+    assert_content I18n.t('devise.failure.already_authenticated')
+    assert page.has_no_selector?('form#new_user')
+  end
+
+  def assert_signed_out
+    visit new_user_session_path
+    refute_content I18n.t('devise.failure.already_authenticated')
+    assert page.has_selector?('form#new_user')
+  end
+
+  def assert_page_title(title = :any, message = 'page title is blank')
+    if title.present? && title != :any
+      assert_title(title) # Capybara TitleQuery, match this text
+    else
+      title = (page.find(:xpath, '//title', visible: false) rescue nil)
+      assert title.present?, message
+    end
+  end
+
+  def assert_page_status(status = 200)
+    assert_equal status, page.status_code, "page failed to load with #{status} HTTP status code"
+  end
+end

data/{app/helpers/effective_test_bot_helper.rb → test/support/effective_test_bot_form_helper.rb}

@@ -1,36 +1,6 @@
-module EffectiveTestBotHelper
-  def as_user(user)
-    sign_in(user); yield; logout
-  end
-
-  def sign_in(user) # Warden::Test::Helpers
-    user.kind_of?(String) == true ? login_as(User.find_by_email(user)) : login_as(user)
-  end
-
-  def sign_in_manually(email, password)
-    visit new_user_session_path
-
-    within('form#new_user') do
-      fill_form(:email => email, :password => password)
-      submit_form
-    end
-  end
-
-  def sign_up(email = Faker::Internet.email, password = Faker::Internet.password)
-    visit new_user_registration_path
-
-    within('form#new_user') do
-      fill_form(:email => email, :password => password, :password_confirmation => password)
-      submit_form
-    end
-
-    # These lines seem to need to be here, or minitest.rb 23 blows up.
-    # Some kind of threading issue is fucking with me.
-    assert_equal page.status_code, 200
-    assert_content I18n.t('devise.registrations.signed_up')
-
-    User.find_by_email(email)
-  end
+module EffectiveTestBotFormHelper
+  DIGITS = ('1'..'9').to_a
+  LETTERS = ('A'..'Z').to_a
 
   # fill_form(:email => 'somethign@soneone.com', :password => 'blahblah', 'user.last_name' => 'hlwerewr')
   def fill_form(fills = {})
@@ -46,7 +16,7 @@ module EffectiveTestBotHelper
         field.select(fill_value(field, fills), match: :first)
       when 'input_file'
         puts "Warning, input_file not yet supported"
-      when 'input_submit'
+      when 'input_submit', 'input_search'
         # Do nothing
       else
         raise "unsupported field type #{[field.tag_name, field['type']].compact.join('_')}"
@@ -54,6 +24,10 @@ module EffectiveTestBotHelper
     end
   end
 
+  def clear_form
+    all('input,select,textarea').each { |field| field.set('') }
+  end
+
   # Operates on just string keys
   def fill_value(field, fills = nil)
     attributes = field['name'].to_s.gsub(']', '').split('[') # user[something_attributes][last_name] => ['user', 'something_attributes', 'last_name']
@@ -67,12 +41,7 @@ module EffectiveTestBotHelper
 
         if fills.key?(key)
           fill_value = fills[key]
-
-          if field_name == 'select'
-            break
-          else
-            return fill_value
-          end
+          ['select'].include?(field_name) ? break : (return fill_value)
         end
       end
     end
@@ -85,8 +54,7 @@ module EffectiveTestBotHelper
     when 'input_password'
       Faker::Internet.password
     when 'input_tel'
-      digits = ('1'..'9').to_a
-      d = 10.times.map { digits.sample }
+      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(' ')
@@ -101,6 +69,8 @@ module EffectiveTestBotHelper
         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
@@ -117,7 +87,7 @@ module EffectiveTestBotHelper
     when 'input_checkbox'
       [true, false].sample
     when 'input_radio'
-      binding.pry
+      [true, false].sample
     else
       raise "fill_value unsupported field type: #{field['type']}"
     end
@@ -126,10 +96,9 @@ module EffectiveTestBotHelper
   def submit_form(label = nil)
     if label.present?
       click_on(label)
-      #find_field(label).click
     else
       first(:css, "input[type='submit']").click
     end
+    synchronize!
   end
-
 end

data/test/support/effective_test_bot_login_helper.rb

@@ -0,0 +1,31 @@
+# This is all assuming you're running Devise
+
+module EffectiveTestBotLoginHelper
+  def as_user(user)
+    sign_in(user); yield; logout
+  end
+
+  def sign_in(user) # Warden::Test::Helpers
+    user.kind_of?(String) == true ? login_as(User.find_by_email!(user)) : login_as(user)
+  end
+
+  def sign_in_manually(email, password)
+    visit new_user_session_path
+
+    within('form#new_user') do
+      fill_form(:email => email, :password => password)
+      submit_form
+    end
+  end
+
+  def sign_up(email = Faker::Internet.email, password = Faker::Internet.password)
+    visit new_user_registration_path
+
+    within('form#new_user') do
+      fill_form(:email => email, :password => password, :password_confirmation => password)
+      submit_form
+    end
+
+    User.find_by_email(email)
+  end
+end