docbrown/spec/rails_helper.rb

ENV["RAILS_ENV"] = "test"
require "knapsack_pro"
KnapsackPro::Adapters::RSpecAdapter.bind

require "spec_helper"

require File.expand_path("../config/environment", __dir__)
require "rspec/rails"
abort("The Rails environment is running in production mode!") if Rails.env.production?

# Add additional requires below this line. Rails is not loaded until this point!

require "pundit/matchers"
require "pundit/rspec"
require "webmock/rspec"
require "sidekiq/testing"
require "validate_url/rspec_matcher"

# Requires supporting ruby files with custom matchers and macros, etc, in
# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
# run as spec files by default. This means that files in spec/support that end
# in _spec.rb will both be required and run as specs, causing the specs to be
# run twice. It is recommended that you do not name files matching this glob to
# end with _spec.rb. You can configure this pattern with the --pattern
# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
#
# The following line is provided for convenience purposes. It has the downside
# of increasing the boot-up time by auto-requiring all files in the support
# directory. Alternatively, in the individual `*_spec.rb` files, manually
# require only the support files necessary.

Dir[Rails.root.join("spec/support/**/*.rb")].sort.each { |f| require f }
Dir[Rails.root.join("spec/system/shared_examples/**/*.rb")].sort.each { |f| require f }
Dir[Rails.root.join("spec/models/shared_examples/**/*.rb")].sort.each { |f| require f }
Dir[Rails.root.join("spec/workers/shared_examples/**/*.rb")].sort.each { |f| require f }
Dir[Rails.root.join("spec/initializers/shared_examples/**/*.rb")].sort.each { |f| require f }

# Checks for pending migrations before tests are run.
# If you are not using ActiveRecord, you can remove this line.
ActiveRecord::Migration.maintain_test_schema!

# Disable internet connection with Webmock
# allow browser websites, so that "webdrivers" can access their binaries
# see <https://github.com/titusfortner/webdrivers/wiki/Using-with-VCR-or-WebMock>
allowed_sites = [
  "chromedriver.storage.googleapis.com",
  "github.com/mozilla/geckodriver/releases",
  "selenium-release.storage.googleapis.com",
  "developer.microsoft.com/en-us/microsoft-edge/tools/webdriver",
  "api.knapsackpro.com",
  "elasticsearch",
]
WebMock.disable_net_connect!(allow_localhost: true, allow: allowed_sites)

RSpec::Matchers.define_negated_matcher :not_change, :change

Rack::Attack.enabled = false

# `browser`, a dependency of `field_test`, starting from version 3.0
# considers the empty user agent a bot, which will fail tests as we
# explicitly configure field tests to exclude bots
# see https://github.com/fnando/browser/blob/master/CHANGELOG.md#300
Browser::Bot.matchers.delete(Browser::Bot::EmptyUserAgentMatcher)

RSpec.configure do |config|
  config.use_transactional_fixtures = true
  config.fixture_path = "#{::Rails.root}/spec/fixtures"

  config.include ApplicationHelper
  config.include ActionMailer::TestHelper
  config.include Devise::Test::ControllerHelpers, type: :view
  config.include Devise::Test::IntegrationHelpers, type: :system
  config.include Devise::Test::IntegrationHelpers, type: :request
  config.include FactoryBot::Syntax::Methods
  config.include OmniauthHelpers
  config.include SidekiqTestHelpers
  config.include ElasticsearchHelpers

  config.after(:each, type: :system) do
    Warden::Manager._on_request.clear
  end

  config.after(:each, type: :request) do
    Warden::Manager._on_request.clear
  end

  config.before(:suite) do
    # Set the TZ ENV variable with the current random timezone from zonebie
    # which we can then use to properly set the browser time for Capybara specs
    ENV["TZ"] = Time.zone.tzinfo.name

    Search::Cluster.recreate_indexes

    # NOTE: @citizen428 needed while we delegate from User to Profile to keep
    # spec changes limited for the time being.
    csv = Rails.root.join("lib/data/dev_profile_fields.csv")
    ProfileFields::ImportFromCsv.call(csv)
    Profile.refresh_attributes!
  end

  config.before do
    # Worker jobs shouldn't linger around between tests
    Sidekiq::Worker.clear_all
  end

  config.before(:each, stub_elasticsearch: true) do |_example|
    stubbed_search_response = { "hits" => { "hits" => [] } }
    allow(Search::Client).to receive(:search).and_return(stubbed_search_response)
    allow(Search::Client).to receive(:index).and_return({ "_source" => {} })
  end

  config.around(:each, elasticsearch_reset: true) do |example|
    Search::Cluster.recreate_indexes
    example.run
    Search::Cluster.recreate_indexes
  end

  config.around(:each, :elasticsearch) do |ex|
    klasses = Array.wrap(ex.metadata[:elasticsearch]).map do |search_class|
      Search.const_get(search_class)
    end
    klasses.each { |klass| clear_elasticsearch_data(klass) }
    ex.run
  end

  config.around(:each, throttle: true) do |example|
    Rack::Attack.enabled = true
    example.run
    Rack::Attack.enabled = false
  end

  config.after do
    SiteConfig.clear_cache
  end

  # Only turn on VCR if :vcr is included metadata keys
  config.around do |ex|
    if ex.metadata.key?(:vcr)
      ex.run
    else
      VCR.turned_off { ex.run }
    end
  end

  config.before do
    stub_request(:any, /res.cloudinary.com/).to_rack("dsdsdsds")

    stub_request(:any, /emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/).to_rack("stubbed-emoji")

    stub_request(:post, /api.fastly.com/)
      .to_return(status: 200, body: "".to_json, headers: {})

    stub_request(:any, /localhost:9090/)
      .to_return(status: 200, body: "OK".to_json, headers: {})

    stub_request(:post, /api.bufferapp.com/)
      .to_return(status: 200, body: { fake_text: "so fake" }.to_json, headers: {})

    # for twitter image cdn
    stub_request(:get, /twimg.com/)
      .to_return(status: 200, body: "", headers: {})

    stub_request(:any, /api.mailchimp.com/)
      .to_return(status: 200, body: "", headers: {})

    stub_request(:any, /dummyimage.com/)
      .to_return(status: 200, body: "", headers: {})

    stub_request(:post, "http://www.google-analytics.com/collect")
      .to_return(status: 200, body: "", headers: {})

    stub_request(:any, /robohash.org/)
      .with(headers:
            {
              "Accept" => "*/*",
              "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
              "User-Agent" => "Ruby"
            }).to_return(status: 200, body: "", headers: {})

    allow(SiteConfig).to receive(:community_description).and_return("Some description")
    allow(SiteConfig).to receive(:public).and_return(true)
    allow(SiteConfig).to receive(:waiting_on_first_user).and_return(false)
  end

  config.after do
    Timecop.return
  end

  config.after(:suite) do
    WebMock.disable_net_connect!(
      allow_localhost: true,
      allow: allowed_sites,
    )
  end

  OmniAuth.config.test_mode = true
  OmniAuth.config.logger = Rails.logger

  config.infer_spec_type_from_file_location!

  # Filter lines from Rails gems in backtraces.
  config.filter_rails_from_backtrace!
  # arbitrary gems may also be filtered via:
  # config.filter_gems_from_backtrace("gem name")
end