mastodon/spec/rails_helper.rb

162 lines
4.9 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
2016-02-24 23:17:01 +00:00
ENV['RAILS_ENV'] ||= 'test'
2023-07-28 21:09:49 +00:00
# This needs to be defined before Rails is initialized
RUN_SYSTEM_SPECS = ENV.fetch('RUN_SYSTEM_SPECS', false)
2023-09-08 14:17:55 +00:00
RUN_SEARCH_SPECS = ENV.fetch('RUN_SEARCH_SPECS', false)
2023-07-28 21:09:49 +00:00
if RUN_SYSTEM_SPECS
STREAMING_PORT = ENV.fetch('TEST_STREAMING_PORT', '4020')
ENV['STREAMING_API_BASE_URL'] = "http://localhost:#{STREAMING_PORT}"
end
2023-09-08 14:17:55 +00:00
require File.expand_path('../config/environment', __dir__)
2016-02-24 23:17:01 +00:00
abort('The Rails environment is running in production mode!') if Rails.env.production?
2016-02-24 23:17:01 +00:00
require 'spec_helper'
require 'rspec/rails'
require 'webmock/rspec'
2016-09-05 15:46:36 +00:00
require 'paperclip/matchers'
require 'capybara/rspec'
require 'chewy/rspec'
2016-02-24 23:17:01 +00:00
2023-05-04 03:50:40 +00:00
Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
2017-04-04 22:29:56 +00:00
2016-02-24 23:17:01 +00:00
ActiveRecord::Migration.maintain_test_schema!
2023-07-28 21:09:49 +00:00
WebMock.disable_net_connect!(allow: Chewy.settings[:host], allow_localhost: RUN_SYSTEM_SPECS)
Sidekiq::Testing.inline!
Sidekiq.logger = nil
2016-02-24 23:17:01 +00:00
2023-07-28 21:09:49 +00:00
# System tests config
DatabaseCleaner.strategy = [:deletion]
Devise::Test::ControllerHelpers.module_eval do
alias_method :original_sign_in, :sign_in
def sign_in(resource, _deprecated = nil, scope: nil)
original_sign_in(resource, scope: scope)
SessionActivation.deactivate warden.cookies.signed['_session_id']
warden.cookies.signed['_session_id'] = {
value: resource.activate_session(warden.request),
expires: 1.year.from_now,
httponly: true,
}
end
end
2016-02-24 23:17:01 +00:00
RSpec.configure do |config|
2023-07-28 21:09:49 +00:00
# This is set before running spec:system, see lib/tasks/tests.rake
2023-09-08 14:17:55 +00:00
config.filter_run_excluding type: lambda { |type|
case type
when :system
!RUN_SYSTEM_SPECS
when :search
!RUN_SEARCH_SPECS
end
}
2023-05-04 03:50:40 +00:00
config.fixture_path = Rails.root.join('spec', 'fixtures')
2016-02-24 23:17:01 +00:00
config.use_transactional_fixtures = true
config.order = 'random'
2016-02-24 23:17:01 +00:00
config.infer_spec_type_from_file_location!
config.filter_rails_from_backtrace!
config.define_derived_metadata(file_path: Regexp.new('spec/lib/mastodon/cli')) do |metadata|
metadata[:type] = :cli
end
2016-08-17 15:56:23 +00:00
config.include Devise::Test::ControllerHelpers, type: :controller
2023-04-26 16:21:32 +00:00
config.include Devise::Test::ControllerHelpers, type: :helper
config.include Devise::Test::ControllerHelpers, type: :view
config.include Devise::Test::IntegrationHelpers, type: :feature
config.include Devise::Test::IntegrationHelpers, type: :request
2016-09-05 15:46:36 +00:00
config.include Paperclip::Shoulda::Matchers
config.include ActiveSupport::Testing::TimeHelpers
config.include Chewy::Rspec::Helpers
config.include Redisable
config.include SignedRequestHelpers, type: :request
config.around(:each, use_transactional_tests: false) do |example|
self.use_transactional_tests = false
example.run
self.use_transactional_tests = true
end
config.before :each, type: :cli do
stub_stdout
stub_reset_connection_pools
end
config.before :each, type: :feature do
2023-07-28 21:09:49 +00:00
Capybara.current_driver = :rack_test
end
2023-07-28 21:09:49 +00:00
config.around :each, type: :system do |example|
driven_by :selenium, using: :headless_chrome, screen_size: [1600, 1200]
# The streaming server needs access to the database
# but with use_transactional_tests every transaction
# is rolled-back, so the streaming server never sees the data
# So we disable this feature for system tests, and use DatabaseCleaner to clean
# the database tables between each test
self.use_transactional_tests = false
DatabaseCleaner.cleaning do
example.run
end
self.use_transactional_tests = true
end
2023-11-07 09:10:36 +00:00
config.before do |example|
unless example.metadata[:paperclip_processing]
allow_any_instance_of(Paperclip::Attachment).to receive(:post_process).and_return(true) # rubocop:disable RSpec/AnyInstance
end
end
2023-11-07 09:10:36 +00:00
config.after do
Rails.cache.clear
redis.del(redis.keys)
end
# Assign types based on dir name for non-inferred types
config.define_derived_metadata(file_path: %r{/spec/}) do |metadata|
unless metadata.key?(:type)
match = metadata[:location].match(%r{/spec/([^/]+)/})
metadata[:type] = match[1].singularize.to_sym
end
end
2016-02-24 23:17:01 +00:00
end
RSpec::Sidekiq.configure do |config|
config.warn_when_jobs_not_processed_by_sidekiq = false
end
Add WebAuthn as an alternative 2FA method (#14466) * feat: add possibility of adding WebAuthn security keys to use as 2FA This adds a basic UI for enabling WebAuthn 2FA. We did a little refactor to the Settings page for editing the 2FA methods – now it will list the methods that are available to the user (TOTP and WebAuthn) and from there they'll be able to add or remove any of them. Also, it's worth mentioning that for enabling WebAuthn it's required to have TOTP enabled, so the first time that you go to the 2FA Settings page, you'll be asked to set it up. This work was inspired by the one donde by Github in their platform, and despite it could be approached in different ways, we decided to go with this one given that we feel that this gives a great UX. Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com> * feat: add request for WebAuthn as second factor at login if enabled This commits adds the feature for using WebAuthn as a second factor for login when enabled. If users have WebAuthn enabled, now a page requesting for the use of a WebAuthn credential for log in will appear, although a link redirecting to the old page for logging in using a two-factor code will also be present. Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com> * feat: add possibility of deleting WebAuthn Credentials Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com> * feat: disable WebAuthn when an Admin disables 2FA for a user Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com> * feat: remove ability to disable TOTP leaving only WebAuthn as 2FA Following examples form other platforms like Github, we decided to make Webauthn 2FA secondary to 2FA with TOTP, so that we removed the possibility of removing TOTP authentication only, leaving users with just WEbAuthn as 2FA. Instead, users will have to click on 'Disable 2FA' in order to remove second factor auth. The reason for WebAuthn being secondary to TOPT is that in that way, users will still be able to log in using their code from their phone's application if they don't have their security keys with them – or maybe even lost them. * We had to change a little the flow for setting up TOTP, given that now it's possible to setting up again if you already had TOTP, in order to let users modify their authenticator app – given that now it's not possible for them to disable TOTP and set it up again with another authenticator app. So, basically, now instead of storing the new `otp_secret` in the user, we store it in the session until the process of set up is finished. This was because, as it was before, when users clicked on 'Edit' in the new two-factor methods lists page, but then went back without finishing the flow, their `otp_secret` had been changed therefore invalidating their previous authenticator app, making them unable to log in again using TOTP. Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com> * refactor: fix eslint errors The PR build was failing given that linting returning some errors. This commit attempts to fix them. * refactor: normalize i18n translations The build was failing given that i18n translations files were not normalized. This commits fixes that. * refactor: avoid having the webauthn gem locked to a specific version * refactor: use symbols for routes without '/' * refactor: avoid sending webauthn disabled email when 2FA is disabled When an admins disable 2FA for users, we were sending two mails to them, one notifying that 2FA was disabled and the other to notify that WebAuthn was disabled. As the second one is redundant since the first email includes it, we can remove it and send just one email to users. * refactor: avoid creating new env variable for webauthn_origin config * refactor: improve flash error messages for webauthn pages Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com>
2020-08-24 14:46:27 +00:00
RSpec::Matchers.define_negated_matcher :not_change, :change
def request_fixture(name)
Rails.root.join('spec', 'fixtures', 'requests', name).read
end
2016-10-09 12:48:43 +00:00
def attachment_fixture(name)
Rails.root.join('spec', 'fixtures', 'files', name).open
2016-10-09 12:48:43 +00:00
end
def stub_stdout
# TODO: Is there a bettery way to:
# - Avoid CLI command output being printed out
# - Allow rspec to assert things against STDOUT
# - Avoid disabling stdout for other desirable output (deprecation warnings, for example)
allow($stdout).to receive(:write)
end
def stub_reset_connection_pools
# TODO: Is there a better way to correctly run specs without stubbing this?
# (Avoids reset_connection_pools! in test env)
allow(ActiveRecord::Base).to receive(:establish_connection)
allow(RedisConfiguration).to receive(:establish_pool)
end