2016-07-21 08:44:18 +00:00
|
|
|
require './spec/simplecov_env'
|
|
|
|
SimpleCovEnv.start!
|
2015-07-14 02:41:47 +00:00
|
|
|
|
2017-09-14 15:22:49 +00:00
|
|
|
ENV["RAILS_ENV"] = 'test'
|
2017-01-22 00:11:19 +00:00
|
|
|
ENV["IN_MEMORY_APPLICATION_SETTINGS"] = 'true'
|
2019-07-02 16:38:23 +00:00
|
|
|
ENV["RSPEC_ALLOW_INVALID_URLS"] = 'true'
|
2015-07-14 02:41:47 +00:00
|
|
|
|
2018-07-02 10:43:06 +00:00
|
|
|
require File.expand_path('../config/environment', __dir__)
|
2014-03-13 22:34:12 +00:00
|
|
|
require 'rspec/rails'
|
2015-06-10 05:38:36 +00:00
|
|
|
require 'shoulda/matchers'
|
2015-11-12 09:52:20 +00:00
|
|
|
require 'rspec/retry'
|
2017-08-10 17:23:56 +00:00
|
|
|
require 'rspec-parameterized'
|
2016-05-22 01:17:15 +00:00
|
|
|
|
2017-04-13 12:24:35 +00:00
|
|
|
rspec_profiling_is_configured =
|
2017-05-19 10:15:49 +00:00
|
|
|
ENV['RSPEC_PROFILING_POSTGRES_URL'].present? ||
|
2017-04-13 12:24:35 +00:00
|
|
|
ENV['RSPEC_PROFILING']
|
|
|
|
branch_can_be_profiled =
|
2017-04-28 18:05:39 +00:00
|
|
|
ENV['GITLAB_DATABASE'] == 'postgresql' &&
|
|
|
|
(ENV['CI_COMMIT_REF_NAME'] == 'master' ||
|
|
|
|
ENV['CI_COMMIT_REF_NAME'] =~ /rspec-profile/)
|
2017-04-13 12:24:35 +00:00
|
|
|
|
|
|
|
if rspec_profiling_is_configured && (!ENV.key?('CI') || branch_can_be_profiled)
|
2017-01-26 21:31:43 +00:00
|
|
|
require 'rspec_profiling/rspec'
|
|
|
|
end
|
|
|
|
|
2019-01-14 18:22:54 +00:00
|
|
|
if ENV['CI'] && ENV['KNAPSACK_GENERATE_REPORT'] && !ENV['NO_KNAPSACK']
|
2016-06-08 09:43:13 +00:00
|
|
|
require 'knapsack'
|
|
|
|
Knapsack::Adapters::RSpecAdapter.bind
|
|
|
|
end
|
2014-03-13 22:34:12 +00:00
|
|
|
|
2017-02-13 11:19:28 +00:00
|
|
|
# require rainbow gem String monkeypatch, so we can test SystemChecks
|
|
|
|
require 'rainbow/ext/string'
|
2018-08-14 23:39:59 +00:00
|
|
|
Rainbow.enabled = false
|
2017-02-13 11:19:28 +00:00
|
|
|
|
2014-03-13 22:34:12 +00:00
|
|
|
# Requires supporting ruby files with custom matchers and macros, etc,
|
|
|
|
# in spec/support/ and its subdirectories.
|
2018-03-29 09:47:54 +00:00
|
|
|
# Requires helpers, and shared contexts/examples first since they're used in other support files
|
2018-10-05 00:40:07 +00:00
|
|
|
|
|
|
|
# Load these first since they may be required by other helpers
|
|
|
|
require Rails.root.join("spec/support/helpers/git_helpers.rb")
|
|
|
|
|
|
|
|
# Then the rest
|
2018-03-29 09:47:54 +00:00
|
|
|
Dir[Rails.root.join("spec/support/helpers/*.rb")].each { |f| require f }
|
|
|
|
Dir[Rails.root.join("spec/support/shared_contexts/*.rb")].each { |f| require f }
|
|
|
|
Dir[Rails.root.join("spec/support/shared_examples/*.rb")].each { |f| require f }
|
2015-04-25 18:33:04 +00:00
|
|
|
Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
|
2014-03-13 22:34:12 +00:00
|
|
|
|
2019-05-22 12:16:49 +00:00
|
|
|
quality_level = Quality::TestLevel.new
|
|
|
|
|
2014-03-13 22:34:12 +00:00
|
|
|
RSpec.configure do |config|
|
2019-04-26 15:49:19 +00:00
|
|
|
config.use_transactional_fixtures = true
|
2014-06-06 17:55:49 +00:00
|
|
|
config.use_instantiated_fixtures = false
|
2018-08-16 09:08:38 +00:00
|
|
|
config.fixture_path = Rails.root
|
2014-03-13 22:34:12 +00:00
|
|
|
|
2015-11-12 09:52:20 +00:00
|
|
|
config.verbose_retry = true
|
|
|
|
config.display_try_failure_messages = true
|
|
|
|
|
2015-02-12 15:48:53 +00:00
|
|
|
config.infer_spec_type_from_file_location!
|
2019-05-03 06:49:45 +00:00
|
|
|
config.full_backtrace = !!ENV['CI']
|
2017-03-08 23:41:02 +00:00
|
|
|
|
2019-05-22 12:16:49 +00:00
|
|
|
config.define_derived_metadata(file_path: %r{(ee)?/spec/.+_spec\.rb\z}) do |metadata|
|
2017-09-19 14:50:26 +00:00
|
|
|
location = metadata[:location]
|
|
|
|
|
2019-05-22 12:16:49 +00:00
|
|
|
metadata[:level] = quality_level.level_for(location)
|
2017-09-19 14:50:26 +00:00
|
|
|
metadata[:api] = true if location =~ %r{/spec/requests/api/}
|
|
|
|
|
|
|
|
# do not overwrite type if it's already set
|
|
|
|
next if metadata.key?(:type)
|
|
|
|
|
|
|
|
match = location.match(%r{/spec/([^/]+)/})
|
|
|
|
metadata[:type] = match[1].singularize.to_sym if match
|
2017-03-08 23:41:02 +00:00
|
|
|
end
|
|
|
|
|
2019-03-28 13:18:50 +00:00
|
|
|
config.include LicenseHelpers
|
2018-03-29 09:47:54 +00:00
|
|
|
config.include ActiveJob::TestHelper
|
|
|
|
config.include ActiveSupport::Testing::TimeHelpers
|
|
|
|
config.include CycleAnalyticsHelpers
|
|
|
|
config.include ExpectOffense
|
|
|
|
config.include FactoryBot::Syntax::Methods
|
|
|
|
config.include FixtureHelpers
|
|
|
|
config.include GitlabRoutingHelper
|
|
|
|
config.include StubFeatureFlags
|
|
|
|
config.include StubGitlabCalls
|
|
|
|
config.include StubGitlabData
|
2018-06-14 13:04:44 +00:00
|
|
|
config.include ExpectNextInstanceOf
|
2018-03-29 09:47:54 +00:00
|
|
|
config.include TestEnv
|
|
|
|
config.include Devise::Test::ControllerHelpers, type: :controller
|
|
|
|
config.include Devise::Test::IntegrationHelpers, type: :feature
|
|
|
|
config.include LoginHelpers, type: :feature
|
|
|
|
config.include SearchHelpers, type: :feature
|
2019-04-18 10:23:12 +00:00
|
|
|
config.include WaitHelpers, type: :feature
|
2018-03-29 09:47:54 +00:00
|
|
|
config.include EmailHelpers, :mailer, type: :mailer
|
|
|
|
config.include Warden::Test::Helpers, type: :request
|
|
|
|
config.include Gitlab::Routing, type: :routing
|
|
|
|
config.include Devise::Test::ControllerHelpers, type: :view
|
|
|
|
config.include ApiHelpers, :api
|
|
|
|
config.include CookieHelper, :js
|
|
|
|
config.include InputHelper, :js
|
|
|
|
config.include SelectionHelper, :js
|
|
|
|
config.include InspectRequests, :js
|
|
|
|
config.include WaitForRequests, :js
|
|
|
|
config.include LiveDebugger, :js
|
|
|
|
config.include MigrationsHelpers, :migration
|
2018-05-04 08:02:08 +00:00
|
|
|
config.include RedisHelpers
|
2018-06-14 13:33:35 +00:00
|
|
|
config.include Rails.application.routes.url_helpers, type: :routing
|
2019-03-27 12:45:00 +00:00
|
|
|
config.include PolicyHelpers, type: :policy
|
2019-07-12 10:44:17 +00:00
|
|
|
config.include MemoryUsageHelper
|
2019-06-13 10:44:41 +00:00
|
|
|
config.include ExpectRequestWithStatus, type: :request
|
2014-03-13 22:34:12 +00:00
|
|
|
|
2017-07-19 17:51:59 +00:00
|
|
|
if ENV['CI']
|
2019-04-10 09:19:42 +00:00
|
|
|
# This includes the first try, i.e. tests will be run 4 times before failing.
|
|
|
|
config.default_retry_count = 4
|
2017-10-04 11:24:51 +00:00
|
|
|
config.reporter.register_listener(
|
|
|
|
RspecFlaky::Listener.new,
|
|
|
|
:example_passed,
|
|
|
|
:dump_summary)
|
2017-07-19 17:51:59 +00:00
|
|
|
end
|
|
|
|
|
2014-03-13 22:34:12 +00:00
|
|
|
config.before(:suite) do
|
2017-08-11 10:36:03 +00:00
|
|
|
Timecop.safe_mode = true
|
2014-07-31 16:24:53 +00:00
|
|
|
TestEnv.init
|
2014-03-13 22:34:12 +00:00
|
|
|
end
|
2016-08-09 21:08:33 +00:00
|
|
|
|
2018-03-28 02:04:57 +00:00
|
|
|
config.after(:all) do
|
|
|
|
TestEnv.clean_test_path
|
|
|
|
end
|
|
|
|
|
2019-02-21 21:07:26 +00:00
|
|
|
config.before do |example|
|
2017-07-13 07:58:05 +00:00
|
|
|
# Enable all features by default for testing
|
|
|
|
allow(Feature).to receive(:enabled?) { true }
|
2018-08-16 13:24:25 +00:00
|
|
|
|
2019-02-21 21:07:26 +00:00
|
|
|
enabled = example.metadata[:enable_rugged].present?
|
|
|
|
|
|
|
|
# Disable Rugged features by default
|
|
|
|
Gitlab::Git::RuggedImpl::Repository::FEATURE_FLAGS.each do |flag|
|
|
|
|
allow(Feature).to receive(:enabled?).with(flag).and_return(enabled)
|
|
|
|
end
|
|
|
|
|
2019-07-10 21:36:49 +00:00
|
|
|
allow(Gitlab::GitalyClient).to receive(:can_use_disk?).and_return(enabled)
|
|
|
|
|
2018-08-16 13:24:25 +00:00
|
|
|
# The following can be removed when we remove the staged rollout strategy
|
|
|
|
# and we can just enable it using instance wide settings
|
|
|
|
# (ie. ApplicationSetting#auto_devops_enabled)
|
|
|
|
allow(Feature).to receive(:enabled?)
|
|
|
|
.with(:force_autodevops_on_by_default, anything)
|
|
|
|
.and_return(false)
|
2019-07-01 19:17:37 +00:00
|
|
|
|
|
|
|
Gitlab::ThreadMemoryCache.cache_backend.clear
|
2017-07-12 12:45:42 +00:00
|
|
|
end
|
|
|
|
|
2019-08-02 09:54:40 +00:00
|
|
|
config.around(:example, :quarantine) do |example|
|
2019-01-14 18:06:32 +00:00
|
|
|
# Skip tests in quarantine unless we explicitly focus on them.
|
2019-08-02 09:54:40 +00:00
|
|
|
example.run if config.inclusion_filter[:quarantine]
|
2019-01-14 18:06:32 +00:00
|
|
|
end
|
|
|
|
|
2017-06-09 17:12:51 +00:00
|
|
|
config.before(:example, :request_store) do
|
|
|
|
RequestStore.begin!
|
|
|
|
end
|
|
|
|
|
|
|
|
config.after(:example, :request_store) do
|
|
|
|
RequestStore.end!
|
|
|
|
RequestStore.clear!
|
|
|
|
end
|
|
|
|
|
2018-12-11 06:29:58 +00:00
|
|
|
config.after do
|
2018-06-05 14:17:04 +00:00
|
|
|
Fog.unmock! if Fog.mock?
|
|
|
|
end
|
|
|
|
|
2018-12-11 06:29:58 +00:00
|
|
|
config.after do
|
2018-09-10 09:48:09 +00:00
|
|
|
Gitlab::CurrentSettings.clear_in_memory_application_settings!
|
|
|
|
end
|
|
|
|
|
2017-08-02 15:13:27 +00:00
|
|
|
config.before(:example, :mailer) do
|
|
|
|
reset_delivered_emails!
|
|
|
|
end
|
|
|
|
|
2018-05-09 05:29:30 +00:00
|
|
|
config.before(:example, :prometheus) do
|
|
|
|
matching_files = File.join(::Prometheus::Client.configuration.multiprocess_files_dir, "*.db")
|
|
|
|
Dir[matching_files].map { |filename| File.delete(filename) if File.file?(filename) }
|
|
|
|
|
|
|
|
Gitlab::Metrics.reset_registry!
|
|
|
|
end
|
|
|
|
|
2017-07-11 03:35:47 +00:00
|
|
|
config.around(:each, :use_clean_rails_memory_store_caching) do |example|
|
2016-08-09 21:08:33 +00:00
|
|
|
caching_store = Rails.cache
|
2017-07-11 03:35:47 +00:00
|
|
|
Rails.cache = ActiveSupport::Cache::MemoryStore.new
|
|
|
|
|
2016-08-09 21:08:33 +00:00
|
|
|
example.run
|
2017-07-11 03:35:47 +00:00
|
|
|
|
2016-08-09 21:08:33 +00:00
|
|
|
Rails.cache = caching_store
|
|
|
|
end
|
2016-10-25 14:01:24 +00:00
|
|
|
|
2017-07-11 03:35:47 +00:00
|
|
|
config.around(:each, :clean_gitlab_redis_cache) do |example|
|
2018-05-04 08:02:08 +00:00
|
|
|
redis_cache_cleanup!
|
2017-07-11 03:35:47 +00:00
|
|
|
|
|
|
|
example.run
|
|
|
|
|
2018-05-04 08:02:08 +00:00
|
|
|
redis_cache_cleanup!
|
2017-07-11 03:35:47 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
config.around(:each, :clean_gitlab_redis_shared_state) do |example|
|
2018-05-04 08:02:08 +00:00
|
|
|
redis_shared_state_cleanup!
|
2016-11-24 14:07:44 +00:00
|
|
|
|
2016-10-25 14:01:24 +00:00
|
|
|
example.run
|
2016-11-24 14:07:44 +00:00
|
|
|
|
2018-05-04 08:02:08 +00:00
|
|
|
redis_shared_state_cleanup!
|
|
|
|
end
|
|
|
|
|
|
|
|
config.around(:each, :clean_gitlab_redis_queues) do |example|
|
|
|
|
redis_queues_cleanup!
|
|
|
|
|
|
|
|
example.run
|
|
|
|
|
|
|
|
redis_queues_cleanup!
|
2016-10-25 14:01:24 +00:00
|
|
|
end
|
Use CTEs for nested groups and authorizations
This commit introduces the usage of Common Table Expressions (CTEs) to
efficiently retrieve nested group hierarchies, without having to rely on
the "routes" table (which is an _incredibly_ inefficient way of getting
the data). This requires a patch to ActiveRecord (found in the added
initializer) to work properly as ActiveRecord doesn't support WITH
statements properly out of the box.
Unfortunately MySQL provides no efficient way of getting nested groups.
For example, the old routes setup could easily take 5-10 seconds
depending on the amount of "routes" in a database. Providing vastly
different logic for both MySQL and PostgreSQL will negatively impact the
development process. Because of this the various nested groups related
methods return empty relations when used in combination with MySQL.
For project authorizations the logic is split up into two classes:
* Gitlab::ProjectAuthorizations::WithNestedGroups
* Gitlab::ProjectAuthorizations::WithoutNestedGroups
Both classes get the fresh project authorizations (= as they should be
in the "project_authorizations" table), including nested groups if
PostgreSQL is used. The logic of these two classes is quite different
apart from their public interface. This complicates development a bit,
but unfortunately there is no way around this.
This commit also introduces Gitlab::GroupHierarchy. This class can be
used to get the ancestors and descendants of a base relation, or both by
using a UNION. This in turn is used by methods such as:
* Namespace#ancestors
* Namespace#descendants
* User#all_expanded_groups
Again this class relies on CTEs and thus only works on PostgreSQL. The
Namespace methods will return an empty relation when MySQL is used,
while User#all_expanded_groups will return only the groups a user is a
direct member of.
Performance wise the impact is quite large. For example, on GitLab.com
Namespace#descendants used to take around 580 ms to retrieve data for a
particular user. Using CTEs we are able to reduce this down to roughly 1
millisecond, returning the exact same data.
== On The Fly Refreshing
Refreshing of authorizations on the fly (= when
users.authorized_projects_populated was not set) is removed with this
commit. This simplifies the code, and ensures any queries used for
authorizations are not mutated because they are executed in a Rails
scope (e.g. Project.visible_to_user).
This commit includes a migration to schedule refreshing authorizations
for all users, ensuring all of them have their authorizations in place.
Said migration schedules users in batches of 5000, with 5 minutes
between every batch to smear the load around a bit.
== Spec Changes
This commit also introduces some changes to various specs. For example,
some specs for ProjectTeam assumed that creating a personal project
would _not_ lead to the owner having access, which is incorrect. Because
we also no longer refresh authorizations on the fly for new users some
code had to be added to the "empty_project" factory. This chunk of code
ensures that the owner's permissions are refreshed after creating the
project, something that is normally done in Projects::CreateService.
2017-04-24 15:19:22 +00:00
|
|
|
|
2018-07-06 07:51:31 +00:00
|
|
|
config.around(:each, :use_clean_rails_memory_store_fragment_caching) do |example|
|
|
|
|
caching_store = ActionController::Base.cache_store
|
|
|
|
ActionController::Base.cache_store = ActiveSupport::Cache::MemoryStore.new
|
|
|
|
ActionController::Base.perform_caching = true
|
|
|
|
|
|
|
|
example.run
|
|
|
|
|
|
|
|
ActionController::Base.perform_caching = false
|
|
|
|
ActionController::Base.cache_store = caching_store
|
|
|
|
end
|
|
|
|
|
2019-06-25 21:47:17 +00:00
|
|
|
config.around(:each, :use_sql_query_cache) do |example|
|
|
|
|
ActiveRecord::Base.cache do
|
|
|
|
example.run
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-02-16 19:58:59 +00:00
|
|
|
# The :each scope runs "inside" the example, so this hook ensures the DB is in the
|
|
|
|
# correct state before any examples' before hooks are called. This prevents a
|
|
|
|
# problem where `ScheduleIssuesClosedAtTypeChange` (or any migration that depends
|
|
|
|
# on background migrations being run inline during test setup) can be broken by
|
|
|
|
# altering Sidekiq behavior in an unrelated spec like so:
|
|
|
|
#
|
|
|
|
# around do |example|
|
|
|
|
# Sidekiq::Testing.fake! do
|
|
|
|
# example.run
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
config.before(:context, :migration) do
|
|
|
|
schema_migrate_down!
|
|
|
|
end
|
|
|
|
|
|
|
|
# Each example may call `migrate!`, so we must ensure we are migrated down every time
|
2017-08-17 09:42:17 +00:00
|
|
|
config.before(:each, :migration) do
|
2018-12-14 17:01:04 +00:00
|
|
|
use_fake_application_settings
|
|
|
|
|
2017-08-16 11:05:18 +00:00
|
|
|
schema_migrate_down!
|
2017-06-13 08:18:43 +00:00
|
|
|
end
|
|
|
|
|
2017-08-16 10:49:06 +00:00
|
|
|
config.after(:context, :migration) do
|
2017-08-16 11:05:18 +00:00
|
|
|
schema_migrate_up!
|
2018-12-14 20:17:48 +00:00
|
|
|
|
|
|
|
Gitlab::CurrentSettings.clear_in_memory_application_settings!
|
2017-05-25 20:43:16 +00:00
|
|
|
end
|
2017-06-05 11:13:38 +00:00
|
|
|
|
2017-12-11 14:21:06 +00:00
|
|
|
# This makes sure the `ApplicationController#can?` method is stubbed with the
|
|
|
|
# original implementation for all view specs.
|
|
|
|
config.before(:each, type: :view) do
|
|
|
|
allow(view).to receive(:can?) do |*args|
|
|
|
|
Ability.allowed?(*args)
|
|
|
|
end
|
|
|
|
end
|
2018-01-03 08:07:03 +00:00
|
|
|
|
|
|
|
config.before(:each, :http_pages_enabled) do |_|
|
|
|
|
allow(Gitlab.config.pages).to receive(:external_http).and_return(['1.1.1.1:80'])
|
|
|
|
end
|
|
|
|
|
|
|
|
config.before(:each, :https_pages_enabled) do |_|
|
|
|
|
allow(Gitlab.config.pages).to receive(:external_https).and_return(['1.1.1.1:443'])
|
|
|
|
end
|
|
|
|
|
|
|
|
config.before(:each, :http_pages_disabled) do |_|
|
|
|
|
allow(Gitlab.config.pages).to receive(:external_http).and_return(false)
|
|
|
|
end
|
|
|
|
|
|
|
|
config.before(:each, :https_pages_disabled) do |_|
|
|
|
|
allow(Gitlab.config.pages).to receive(:external_https).and_return(false)
|
|
|
|
end
|
2019-04-26 15:49:19 +00:00
|
|
|
|
|
|
|
# We can't use an `around` hook here because the wrapping transaction
|
|
|
|
# is not yet opened at the time that is triggered
|
|
|
|
config.prepend_before do
|
|
|
|
Gitlab::Database.set_open_transactions_baseline
|
|
|
|
end
|
|
|
|
|
|
|
|
config.append_after do
|
|
|
|
Gitlab::Database.reset_open_transactions_baseline
|
|
|
|
end
|
2013-03-26 09:13:30 +00:00
|
|
|
end
|
2015-03-27 19:31:16 +00:00
|
|
|
|
2017-10-03 14:47:56 +00:00
|
|
|
# add simpler way to match asset paths containing digest strings
|
|
|
|
RSpec::Matchers.define :match_asset_path do |expected|
|
|
|
|
match do |actual|
|
|
|
|
path = Regexp.escape(expected)
|
|
|
|
extname = Regexp.escape(File.extname(expected))
|
|
|
|
digest_regex = Regexp.new(path.sub(extname, "(?:-\\h+)?#{extname}") << '$')
|
|
|
|
digest_regex =~ actual
|
|
|
|
end
|
|
|
|
|
|
|
|
failure_message do |actual|
|
|
|
|
"expected that #{actual} would include an asset path for #{expected}"
|
|
|
|
end
|
|
|
|
|
|
|
|
failure_message_when_negated do |actual|
|
|
|
|
"expected that #{actual} would not include an asset path for #{expected}"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-12-14 00:13:44 +00:00
|
|
|
FactoryBot::SyntaxRunner.class_eval do
|
2015-10-05 10:02:26 +00:00
|
|
|
include RSpec::Mocks::ExampleMethods
|
|
|
|
end
|
|
|
|
|
2015-03-27 19:31:16 +00:00
|
|
|
ActiveRecord::Migration.maintain_test_schema!
|
2017-07-24 11:19:09 +00:00
|
|
|
|
|
|
|
Shoulda::Matchers.configure do |config|
|
|
|
|
config.integrate do |with|
|
|
|
|
with.test_framework :rspec
|
|
|
|
with.library :rails
|
|
|
|
end
|
|
|
|
end
|
2017-11-30 12:58:51 +00:00
|
|
|
|
|
|
|
# Prevent Rugged from picking up local developer gitconfig.
|
|
|
|
Rugged::Settings['search_path_global'] = Rails.root.join('tmp/tests').to_s
|