workarea-testing 3.4.12

data/lib/workarea/storefront/integration_test.rb

@@ -0,0 +1,82 @@
+module Workarea
+  module Storefront
+    module IntegrationTest
+      def product
+        @product ||= create_product(
+          name: 'Integration Product',
+          variants: [
+            { sku: 'SKU1', tax_code: '001', regular: 5.to_m }
+          ]
+        )
+      end
+
+      def complete_checkout(email = nil, password = nil)
+        if Shipping::Service.blank?
+          create_shipping_service(
+            name: 'Ground',
+            tax_code: '001',
+            rates: [{ price: 7.to_m }]
+          )
+        end
+
+        post storefront.cart_items_path,
+          headers: checkout_headers,
+          params: {
+            product_id: product.id,
+            sku: product.skus.first,
+            quantity: 2
+          }
+
+        if email.present? && password.present?
+          post storefront.login_path,
+            headers: checkout_headers,
+            params: { email: email, password: password }
+        end
+
+        patch storefront.checkout_addresses_path,
+          headers: checkout_headers,
+          params: {
+            email: 'bcrouse@workarea.com',
+            billing_address: {
+              first_name:   'Ben',
+              last_name:    'Crouse',
+              street:       '12 N. 3rd St.',
+              city:         'Philadelphia',
+              region:       'PA',
+              postal_code:  '19106',
+              country:      'US',
+              phone_number: '2159251800'
+            },
+            shipping_address: {
+              first_name:   'Ben',
+              last_name:    'Crouse',
+              street:       '22 S. 3rd St.',
+              city:         'Philadelphia',
+              region:       'PA',
+              postal_code:  '19106',
+              country:      'US',
+              phone_number: '2159251800'
+            }
+          }
+
+        patch storefront.checkout_place_order_path,
+          headers: checkout_headers,
+          params: {
+            payment: 'new_card',
+            credit_card: {
+              number: '1',
+              month:  1,
+              year:   2020,
+              cvv:    '999'
+            }
+          }
+      end
+
+      private
+
+      def checkout_headers
+        { 'HTTP_USER_AGENT' => 'Mozilla' }
+      end
+    end
+  end
+end

data/lib/workarea/storefront/pagination_view_model_test.rb

@@ -0,0 +1,56 @@
+module Workarea
+  module Storefront
+    module PaginationViewModelTest
+      def pagination_view_model
+        @pagination_view_model ||= pagination_view_model_class.new(
+          stub_everything(:model)
+        )
+      end
+
+      def test_total_pages
+        pagination_view_model.expects(:total).returns(2)
+        pagination_view_model.expects(:per_page).returns(1)
+        assert_equal(2, pagination_view_model.total_pages)
+
+        pagination_view_model.expects(:total).returns(20)
+        pagination_view_model.expects(:per_page).returns(15)
+        assert_equal(2, pagination_view_model.total_pages)
+
+        pagination_view_model.expects(:total).returns(1)
+        pagination_view_model.expects(:per_page).returns(15)
+        assert_equal(1, pagination_view_model.total_pages)
+      end
+
+      def test_first_page
+        pagination_view_model.expects(:page).returns(1)
+        assert(pagination_view_model.first_page?)
+      end
+
+      def test_last_page
+        pagination_view_model.expects(:page).returns(2)
+        pagination_view_model.expects(:per_page).returns(15)
+        pagination_view_model.expects(:total).returns(30)
+        assert(pagination_view_model.last_page?)
+      end
+
+      def test_next_page
+        pagination_view_model.expects(:per_page).returns(15).at_least_once
+        pagination_view_model.expects(:total).returns(30).at_least_once
+
+        pagination_view_model.expects(:page).returns(1).at_least_once
+        assert_equal(2, pagination_view_model.next_page)
+
+        pagination_view_model.expects(:page).returns(2).at_least_once
+        assert_nil(pagination_view_model.next_page)
+      end
+
+      def test_prev_page
+        pagination_view_model.expects(:page).returns(1).at_least_once
+        assert_nil(pagination_view_model.prev_page)
+
+        pagination_view_model.expects(:page).returns(2).at_least_once
+        assert_equal(1, pagination_view_model.prev_page)
+      end
+    end
+  end
+end

data/lib/workarea/storefront/product_browsing_view_model_test.rb

@@ -0,0 +1,38 @@
+module Workarea
+  module Storefront
+    module ProductBrowsingViewModelTest
+      extend ActiveSupport::Concern
+      include PaginationViewModelTest
+
+      def pagination_view_model_class
+        product_browsing_view_model_class
+      end
+
+      def test_has_filters
+        view_model = product_browsing_view_model_class.new(stub_everything)
+        facet = mock
+        view_model.expects(:facets).returns([facet]).twice
+
+        facet.expects(:selected?).returns(true)
+        assert(view_model.has_filters?)
+
+        facet.expects(:selected?).returns(false)
+        refute(view_model.has_filters?)
+      end
+
+      def test_facets
+        view_model = product_browsing_view_model_class.new(stub_everything)
+        facets = [mock, mock]
+        search = Search::ProductSearch.new
+        search.expects(:facets).returns(facets).at_least_once
+        view_model.expects(:search_query).returns(search).twice
+
+        facets.first.stubs(:useless?).returns(true)
+        facets.second.stubs(:useless?).returns(false)
+
+        assert_equal(1, view_model.facets.size)
+        refute(view_model.facets.first.useless?)
+      end
+    end
+  end
+end

data/lib/workarea/storefront/system_test.rb

@@ -0,0 +1,142 @@
+module Workarea
+  module Storefront
+    module SystemTest
+      def setup_checkout_specs
+        create_supporting_data
+        add_product_to_cart
+      end
+
+      def create_supporting_data
+        create_tax_category(
+          name: 'Sales Tax',
+          code: '001',
+          rates: [{ percentage: 0.07, country: 'US', region: 'PA' }]
+        )
+
+        create_shipping_service(
+          name: 'Ground',
+          tax_code: '001',
+          rates: [{ price: 7.to_m }]
+        )
+
+        create_inventory(id: 'SKU', policy: 'standard', available: 5)
+
+        @product = create_product(
+          id: 'INT_PRODUCT',
+          name: 'Integration Product',
+          variants: [{ sku: 'SKU',  tax_code: '001', regular: 5.to_m }]
+        )
+
+        create_user(email: 'bcrouse@workarea.com', password: 'W3bl1nc!')
+      end
+
+      def add_user_data
+        user = User.find_by_email('bcrouse@workarea.com')
+
+        user.auto_save_shipping_address(
+          first_name: 'Ben',
+          last_name: 'Crouse',
+          street: '22 S. 3rd St.',
+          city: 'Philadelphia',
+          region: 'PA',
+          postal_code: '19106',
+          country: 'US',
+          phone_number: '2159251800'
+        )
+
+        user.auto_save_billing_address(
+          first_name: 'Ben',
+          last_name: 'Crouse',
+          street: '1019 S. 47th St.',
+          city: 'Philadelphia',
+          region: 'PA',
+          postal_code: '19143',
+          country: 'US',
+          phone_number: '2159251800'
+        )
+
+        profile = Payment::Profile.lookup(PaymentReference.new(user))
+        profile.credit_cards.create!(
+          first_name: 'Ben',
+          last_name: 'Crouse',
+          number: '1',
+          month: 1,
+          year: Time.current.year + 1,
+          cvv: '999'
+        )
+      end
+
+      def add_product_to_cart
+        product = Catalog::Product.find('INT_PRODUCT')
+        visit storefront.product_path(product)
+        click_button t('workarea.storefront.products.add_to_cart')
+      end
+
+      def start_guest_checkout
+        visit storefront.checkout_path
+      end
+
+      def start_user_checkout
+        visit storefront.checkout_path
+        click_link t('workarea.storefront.checkouts.login_title')
+
+        within '#login_form' do
+          fill_in 'email', with: 'bcrouse@workarea.com'
+          fill_in 'password', with: 'W3bl1nc!'
+          click_button t('workarea.storefront.users.login')
+        end
+      end
+
+      def fill_in_email
+        fill_in 'email', with: 'bcrouse-new-account@workarea.com'
+      end
+
+      def fill_in_shipping_address
+        fill_in 'shipping_address[first_name]',   with: 'Ben'
+        fill_in 'shipping_address[last_name]',    with: 'Crouse'
+        fill_in 'shipping_address[street]',       with: '22 S. 3rd St.'
+        fill_in 'shipping_address[city]',         with: 'Philadelphia'
+
+        if page.has_field?('shipping_address[region]')
+          fill_in 'shipping_address[region]', with: 'PA'
+        else
+          select 'Pennsylvania', from: 'shipping_address_region_select'
+        end
+
+        fill_in 'shipping_address[postal_code]',  with: '19106'
+        fill_in 'shipping_address[phone_number]', with: '2159251800'
+      end
+
+      def fill_in_new_card_cvv
+        fill_in 'cvv[new_card]', with: '999'
+      end
+
+      def fill_in_credit_card
+        fill_in 'credit_card[number]', with: '1'
+        next_year = (Time.current.year + 1).to_s
+        select next_year, from: 'credit_card[year]'
+        fill_in 'credit_card[cvv]', with: '999'
+      end
+
+      def fill_in_billing_address
+        fill_in 'billing_address[first_name]',   with: 'Ben'
+        fill_in 'billing_address[last_name]',    with: 'Crouse'
+        fill_in 'billing_address[street]',       with: '1019 S. 47th St.'
+        fill_in 'billing_address[city]',         with: 'Philadelphia'
+
+        if page.has_field?('billing_address[region]')
+          fill_in 'billing_address[region]', with: 'PA'
+        else
+          select 'Pennsylvania', from: 'billing_address_region_select'
+        end
+
+        fill_in 'billing_address[postal_code]',  with: '19143'
+        fill_in 'billing_address[phone_number]', with: '2159251800'
+      end
+
+      def select_shipping_service
+        choose 'Ground'
+      end
+    end
+  end
+end

data/lib/workarea/system_test.rb

@@ -0,0 +1,161 @@
+require 'capybara/rails'
+require 'webdrivers'
+require 'puma'
+require 'workarea/integration_test'
+require 'workarea/testing/custom_capybara_matchers'
+
+# get options on load to ensure initial configuration is captured.
+# Capybara.register_driver does not execute the passed block immediately, which
+# can cause issues with the aliasing of Workarea.config.headless_chrome_options.
+# This can be removed in the upcoming minor to rename that configuration.
+chrome_options = Workarea::Configuration::HeadlessChrome.options
+
+Capybara.server_errors = [Exception]
+Capybara.automatic_label_click = true
+Capybara.register_driver :headless_chrome do |app|
+  Capybara::Selenium::Driver.new(
+    app,
+    browser: :chrome,
+    desired_capabilities: Selenium::WebDriver::Remote::Capabilities.chrome(
+      chromeOptions: chrome_options
+    )
+  )
+end
+
+Capybara.server = :puma, { Silent: true }
+Capybara.javascript_driver = :headless_chrome
+
+# If builds want to stick to poltegeist to avoid the pain of upgrading, see if
+# we can define the driver for them. TODO remove in v4
+if defined?(Capybara::Poltergeist)
+  Capybara.register_driver :poltergeist do |app|
+    Capybara::Poltergeist::Driver.new(app, js_errors: true)
+  end
+end
+
+# Because each plugin adds more time to template resolution, more plugins mean
+# slower tests. This is accommodate that slowdown :(
+default = ENV['WORKAREA_CAPYBARA_MAX_WAIT_TIME'].presence || 10
+Capybara.default_max_wait_time = [Workarea::Plugin.installed.size, default.to_i].max
+
+# When you change a route, it doesn't see that JS routes needs to be expired.
+FileUtils.rm_rf(Rails.root.join('tmp', 'cache', 'assets', 'sprockets'))
+
+# Default screenshots to simple output of file path
+ENV["RAILS_SYSTEM_TESTING_SCREENSHOT"] ||= 'simple'
+
+module Workarea
+  class SystemTest < ActionDispatch::SystemTestCase
+    extend TestCase::Decoration
+    include TestCase::Workers
+    include TestCase::SearchIndexing
+    include TestCase::Mail
+    include TestCase::RunnerLocation
+    include TestCase::Locales
+    include TestCase::S3
+    include Factories
+    include IntegrationTest::Configuration
+
+    driven_by :headless_chrome
+
+    setup do
+      reset_window_size
+    end
+
+    teardown do
+      assert_no_js_errors if javascript?
+    end
+
+    # This is to make sure Chrome chills out and allows XHR requests to finish
+    # before going nuts on the page. Theoretically, Capybara does this for you.
+    # Of course in theory, theory works.
+    #
+    (%i(visit refresh go_back go_forward within) + Capybara::Session::NODE_METHODS).each do |method|
+      class_eval <<-ruby
+        def #{method}(*)
+          return super unless javascript?
+
+          wait_for_xhr
+          super.tap { wait_for_xhr }
+        end
+      ruby
+    end
+
+    # Waits until all XHR requests have finished, according
+    # to jQuery. Times out according to Capybara's set timeout.
+    # Used to solve race conditions between XHR requests and
+    # assertions.
+    #
+    def wait_for_xhr(time=Capybara.default_max_wait_time)
+      Timeout.timeout(time) do
+        loop until finished_all_xhr_requests?
+      end
+    rescue Timeout::Error => error
+      javascript_errors = page.driver.browser.manage.logs.get(:browser).each do |log_entry|
+        log_entry.level == 'SEVERE' && /Uncaught/.match?(log_entry.message)
+      end
+      if javascript_errors.present?
+        raise(
+          Timeout::Error,
+          <<~eos
+            Problem:
+              JavaScript errors were detected during Workarea::SystemTest#wait_for_xhr.
+              You might have an error in an XHR callback.  wait_for_xhr is a test helper
+              that checks if there are any unfinished XHR requests.  This is called
+              automatically throughout testing in Capybara interactions to ensure
+              consistency in test results.
+            Errors:
+              #{javascript_errors.map(&:message).join("\r")}
+          eos
+        )
+      else
+        raise error
+      end
+    end
+
+    # Resets the dimensions of the testing browser
+    def reset_window_size
+      return unless javascript?
+
+      page.driver.browser.manage.window.resize_to(
+        Workarea.config.capybara_browser_width,
+        Workarea.config.capybara_browser_height
+      )
+    end
+
+    def javascript?
+      Capybara.current_driver == Capybara.javascript_driver
+    end
+
+    def scroll_to_bottom
+      page.execute_script('window.scrollBy(0, 9999999)')
+    end
+
+    def scroll_to_bottom
+      page.execute_script('window.scrollBy(0, 9999999)')
+    end
+
+    # Intentionally fails, providing a custom error message, if
+    # any JavaScript errors are thrown during a test run.
+    def assert_no_js_errors
+      page.driver.browser.manage.logs.get(:browser).each do |log_entry|
+        # Bad responses (like 422 or 401) show as errors as well, which are OK
+        # for system tests because they indicate the site is functioning properly.
+        if log_entry.level == 'SEVERE' && log_entry.message =~ /Uncaught/
+          assert(false, log_entry.message)
+        elsif log_entry.level == 'WARNING'
+          STDERR.puts 'WARN: Browser warning'
+          STDERR.puts log_entry.message
+        end
+      end
+    end
+
+    private
+
+    def finished_all_xhr_requests?
+      return unless javascript?
+
+      page.evaluate_script("!window['jQuery'] || jQuery.active === 0")
+    end
+  end
+end

data/lib/workarea/test_case.rb

@@ -0,0 +1,197 @@
+module Workarea
+  class TestCase < ActiveSupport::TestCase
+    module Decoration
+      mattr_accessor :loaded_decorators
+      self.loaded_decorators = []
+
+      def self.load_decorator(path)
+        unless loaded_decorators.include?(path) || !File.file?(path)
+          load path
+          loaded_decorators << path
+        end
+      end
+
+      def inherited(subclass)
+        super
+
+        absolute_path = caller[0].split(':').first
+        # Don't try to find decorators for classes in the testing gem
+        return if absolute_path.include?('workarea-testing') ||
+                    absolute_path.include?('workarea/testing')
+
+        relative_path = absolute_path.match(/(\/test.*)/).to_s
+        decorator_relative = relative_path.gsub(
+          '.rb',
+          ".#{Rails::Decorators.extension}"
+        )
+
+        (Plugin.installed.map(&:root) + [Rails.root]).each do |root|
+          decorator_location = [root, decorator_relative].join
+
+          if File.exist?(decorator_location)
+            TestCase::Decoration.load_decorator(decorator_location)
+          end
+        end
+      end
+    end
+
+    module Workers
+      extend ActiveSupport::Concern
+
+      included do
+        setup do
+          @_worker_state =
+            Sidekiq::CallbacksWorker.workers.reduce({}) do |memo, worker|
+              memo[worker] = [worker.enabled?, worker.inlined?]
+              memo
+            end
+
+          Sidekiq::Testing.inline!
+          Sidekiq::Callbacks.inline
+        end
+
+        teardown do
+          Sidekiq::CallbacksWorker.workers.each do |worker|
+            worker.enabled = @_worker_state[worker].first
+            worker.inlined = @_worker_state[worker].second
+          end
+        end
+      end
+    end
+
+    module SearchIndexing
+      extend ActiveSupport::Concern
+
+      included do
+        setup do
+          Workarea.config.auto_refresh_search = true
+          WebMock.disable_net_connect!(allow_localhost: true)
+          Workarea::Elasticsearch::Document.all.each(&:reset_indexes!)
+          Workarea::Search::Storefront.ensure_dynamic_mappings
+        end
+      end
+    end
+
+    module Mail
+      extend ActiveSupport::Concern
+
+      included do
+        setup do
+          Workarea.config.send_email = true
+          Workarea.config.send_transactional_emails = true
+        end
+
+        teardown do
+          Workarea.config.send_email = false
+          Workarea.config.send_transactional_emails = false
+        end
+      end
+    end
+
+    module RunnerLocation
+      def running_from_source?
+        return false unless running_in_dummy_app?
+
+        calling_test = caller.detect do |path|
+          /_test\.(rb|#{Rails::Decorators.extension})/.match?(path)
+        end
+
+        Rails.root.to_s.include?('test/dummy') &&
+          Rails.root.to_s.split('/test/').first.eql?(calling_test.split('/test/').first)
+      end
+
+      def running_in_gem?
+        warn <<~eos
+          DEPRECATION WARNING: running_in_gem? is deprecated, use running_from_dummy_app? if
+          you want to know if the test suite is running from a plugin or
+          running_from_source? if you want to know if the currently executing test
+          is defined in the current Rails project.
+        eos
+        running_from_source?
+      end
+
+      def running_in_dummy_app?
+        return @running_in_dummy_app if defined?(@running_in_dummy_app)
+        @running_in_dummy_app = Rails.root.to_s.include?('test/dummy')
+      end
+    end
+
+    module Locales
+      extend ActiveSupport::Concern
+
+      included do
+        setup :save_locales
+        teardown :restore_locales
+
+        delegate :t, to: :I18n
+      end
+
+      def set_locales(available:, default:, current: nil)
+        Rails.application.config.i18n.available_locales = I18n.available_locales = available
+        Rails.application.config.i18n.default_locale = I18n.default_locale = default
+        I18n.locale = current || default
+      end
+
+      def save_locales
+        @current_rails_available_locales = Rails.application.config.i18n.available_locales
+        @current_rails_default_locale = Rails.application.config.i18n.default_locale
+
+        @current_i18n_available_locales = I18n.available_locales
+        @current_i18n_default_locale = I18n.default_locale
+        @current_i18n_locale = I18n.default_locale
+      end
+
+      def restore_locales
+        Rails.application.config.i18n.available_locales = @current_rails_available_locales
+        Rails.application.config.i18n.default_locale = @current_rails_default_locale
+
+        I18n.available_locales = @current_i18n_available_locales
+        I18n.default_locale = @current_i18n_default_locale
+        I18n.locale = @current_i18n_locale
+      end
+    end
+
+    module S3
+      extend ActiveSupport::Concern
+
+      included do
+        setup :mock_s3
+        teardown :reset_s3
+      end
+
+      def mock_s3
+        Fog.mock!
+        Workarea.s3.directories.create(key: Configuration::S3.bucket)
+      end
+
+      def reset_s3
+        Fog::Mock.reset
+      end
+    end
+
+    extend Decoration
+    extend RunnerLocation
+    include Factories
+    include Workers
+    include RunnerLocation
+    include Locales
+    include S3
+
+    setup do
+      Mongoid.truncate!
+      Workarea.redis.flushdb
+      WebMock.disable_net_connect!(allow_localhost: true)
+      Workarea.config.send_email = false
+      Workarea.config.send_transactional_emails = false
+      ActionMailer::Base.deliveries.clear
+
+      Sidekiq::Testing.inline!
+      Sidekiq::Callbacks.inline
+      Sidekiq::Callbacks.disable
+    end
+
+    teardown do
+      travel_back
+    end
+  end
+end