2014-09-02 18:07:02 +05:30
require 'rspec/mocks'
2018-03-27 19:54:05 +05:30
require 'toml-rb'
2014-09-02 18:07:02 +05:30
module TestEnv
extend self
2018-03-17 18:26:18 +05:30
ComponentFailedToInstallError = Class . new ( StandardError )
2015-04-26 12:48:37 +05:30
# When developing the seed repository, comment out the branch you will modify.
BRANCH_SHA = {
2018-03-17 18:26:18 +05:30
'signed-commits' = > '2d1096e' ,
2016-11-03 12:29:30 +05:30
'not-merged-branch' = > 'b83d6e3' ,
'branch-merged' = > '498214d' ,
2016-09-13 17:45:13 +05:30
'empty-branch' = > '7efb185' ,
2016-09-29 09:46:39 +05:30
'ends-with.json' = > '98b0d8b' ,
2016-09-13 17:45:13 +05:30
'flatten-dir' = > 'e56497b' ,
'feature' = > '0b4bc9a' ,
'feature_conflict' = > 'bb5206f' ,
'fix' = > '48f0be4' ,
'improve/awesome' = > '5937ac0' ,
2018-03-17 18:26:18 +05:30
'merged-target' = > '21751bf' ,
2016-09-13 17:45:13 +05:30
'markdown' = > '0ed8c6c' ,
2018-03-17 18:26:18 +05:30
'lfs' = > '55bc176' ,
2016-11-03 12:29:30 +05:30
'master' = > 'b83d6e3' ,
'merge-test' = > '5937ac0' ,
2016-09-13 17:45:13 +05:30
" 'test' " = > 'e56497b' ,
'orphaned-branch' = > '45127a9' ,
'binary-encoding' = > '7b1cf43' ,
'gitattributes' = > '5a62481' ,
'expand-collapse-diffs' = > '4842455' ,
2017-08-17 22:00:37 +05:30
'symlink-expand-diff' = > '81e6355' ,
2016-09-13 17:45:13 +05:30
'expand-collapse-files' = > '025db92' ,
'expand-collapse-lines' = > '238e82d' ,
'video' = > '8879059' ,
2017-08-17 22:00:37 +05:30
'add-balsamiq-file' = > 'b89b56d' ,
2016-09-13 17:45:13 +05:30
'crlf-diff' = > '5938907' ,
2016-11-03 12:29:30 +05:30
'conflict-start' = > '824be60' ,
2016-09-13 17:45:13 +05:30
'conflict-resolvable' = > '1450cd6' ,
'conflict-binary-file' = > '259a6fb' ,
2016-11-03 12:29:30 +05:30
'conflict-contains-conflict-markers' = > '78a3086' ,
2016-09-13 17:45:13 +05:30
'conflict-missing-side' = > 'eb227b3' ,
'conflict-non-utf8' = > 'd0a293c' ,
'conflict-too-large' = > '39fa04f' ,
2017-08-17 22:00:37 +05:30
'deleted-image-test' = > '6c17798' ,
'wip' = > 'b9238ee' ,
'csv' = > '3dd0896' ,
'v1.1.0' = > 'b83d6e3' ,
2017-09-10 17:25:29 +05:30
'add-ipython-files' = > '93ee732' ,
'add-pdf-file' = > 'e774ebd' ,
2018-03-17 18:26:18 +05:30
'add-pdf-text-binary' = > '79faa7b' ,
'add_images_and_changes' = > '010d106'
2017-08-17 22:00:37 +05:30
} . freeze
2015-09-11 14:41:01 +05:30
# gitlab-test-fork is a fork of gitlab-fork, but we don't necessarily
# need to keep all the branches in sync.
# We currently only need a subset of the branches
FORKED_BRANCH_SHA = {
2016-09-29 09:46:39 +05:30
'add-submodule-version-bump' = > '3f547c0' ,
'master' = > '5937ac0' ,
'remove-submodule' = > '2a33e0c' ,
'conflict-resolvable-fork' = > '404fa3f'
2017-08-17 22:00:37 +05:30
} . freeze
2015-04-26 12:48:37 +05:30
2017-09-10 17:25:29 +05:30
TMP_TEST_PATH = Rails . root . join ( 'tmp' , 'tests' , '**' )
2018-05-09 12:01:36 +05:30
REPOS_STORAGE = 'default' . freeze
2017-09-10 17:25:29 +05:30
2014-09-02 18:07:02 +05:30
# Test environment
#
# See gitlab.yml.example test section for paths
#
def init ( opts = { } )
2018-03-17 18:26:18 +05:30
unless Rails . env . test?
puts " \n TestEnv.init can only be run if `RAILS_ENV` is set to 'test' not ' #{ Rails . env } '! \n "
exit 1
end
2014-09-02 18:07:02 +05:30
# Disable mailer for spinach tests
disable_mailer if opts [ :mailer ] == false
2015-04-26 12:48:37 +05:30
clean_test_path
2014-09-02 18:07:02 +05:30
# Setup GitLab shell for test instance
setup_gitlab_shell
2017-09-10 17:25:29 +05:30
setup_gitaly
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
# Create repository for FactoryBot.create(:project)
2014-09-02 18:07:02 +05:30
setup_factory_repo
2015-09-11 14:41:01 +05:30
2018-03-17 18:26:18 +05:30
# Create repository for FactoryBot.create(:forked_project_with_submodules)
2015-09-11 14:41:01 +05:30
setup_forked_repo
2014-09-02 18:07:02 +05:30
end
def disable_mailer
2017-09-10 17:25:29 +05:30
allow_any_instance_of ( NotificationService ) . to receive ( :mailer )
. and_return ( double . as_null_object )
2014-09-02 18:07:02 +05:30
end
def enable_mailer
2017-09-10 17:25:29 +05:30
allow_any_instance_of ( NotificationService ) . to receive ( :mailer )
. and_call_original
2015-04-26 12:48:37 +05:30
end
2015-09-25 12:07:36 +05:30
def disable_pre_receive
2016-08-24 12:49:21 +05:30
allow_any_instance_of ( Gitlab :: Git :: Hook ) . to receive ( :trigger ) . and_return ( [ true , nil ] )
2015-09-25 12:07:36 +05:30
end
2015-04-26 12:48:37 +05:30
# Clean /tmp/tests
#
# Keeps gitlab-shell and gitlab-test
def clean_test_path
2017-09-10 17:25:29 +05:30
Dir [ TMP_TEST_PATH ] . each do | entry |
2017-08-17 22:00:37 +05:30
unless File . basename ( entry ) =~ / \ A(gitaly|gitlab-(shell|test|test_bare|test-fork|test-fork_bare)) \ z /
2015-04-26 12:48:37 +05:30
FileUtils . rm_rf ( entry )
end
end
2017-08-17 22:00:37 +05:30
FileUtils . mkdir_p ( repos_path )
FileUtils . mkdir_p ( backup_path )
FileUtils . mkdir_p ( pages_path )
2018-03-17 18:26:18 +05:30
FileUtils . mkdir_p ( artifacts_path )
2014-09-02 18:07:02 +05:30
end
2017-09-10 17:25:29 +05:30
def clean_gitlab_test_path
Dir [ TMP_TEST_PATH ] . each do | entry |
if File . basename ( entry ) =~ / \ A(gitlab-(test|test_bare|test-fork|test-fork_bare)) \ z /
FileUtils . rm_rf ( entry )
2016-11-03 12:29:30 +05:30
end
2014-09-02 18:07:02 +05:30
end
end
2017-09-10 17:25:29 +05:30
def setup_gitlab_shell
2018-03-17 18:26:18 +05:30
component_timed_setup ( 'GitLab Shell' ,
install_dir : Gitlab . config . gitlab_shell . path ,
version : Gitlab :: Shell . version_required ,
task : 'gitlab:shell:install' )
2017-09-10 17:25:29 +05:30
end
2017-08-17 22:00:37 +05:30
def setup_gitaly
socket_path = Gitlab :: GitalyClient . address ( 'default' ) . sub ( / \ Aunix: / , '' )
gitaly_dir = File . dirname ( socket_path )
2018-03-17 18:26:18 +05:30
component_timed_setup ( 'Gitaly' ,
install_dir : gitaly_dir ,
version : Gitlab :: GitalyClient . expected_server_version ,
task : " gitlab:gitaly:install[ #{ gitaly_dir } ] " ) do
2017-09-10 17:25:29 +05:30
2018-03-17 18:26:18 +05:30
# Always re-create config, in case it's outdated. This is fast anyway.
Gitlab :: SetupHelper . create_gitaly_configuration ( gitaly_dir , force : true )
2017-09-10 17:25:29 +05:30
2018-03-17 18:26:18 +05:30
start_gitaly ( gitaly_dir )
2017-08-17 22:00:37 +05:30
end
end
def start_gitaly ( gitaly_dir )
2017-09-10 17:25:29 +05:30
if ENV [ 'CI' ] . present?
# Gitaly has been spawned outside this process already
return
end
spawn_script = Rails . root . join ( 'scripts/gitaly-test-spawn' ) . to_s
@gitaly_pid = Bundler . with_original_env { IO . popen ( [ spawn_script ] , & :read ) . to_i }
2018-03-17 18:26:18 +05:30
Kernel . at_exit { stop_gitaly }
wait_gitaly
end
def wait_gitaly
sleep_time = 10
sleep_interval = 0 . 1
socket = Gitlab :: GitalyClient . address ( 'default' ) . sub ( 'unix:' , '' )
Integer ( sleep_time / sleep_interval ) . times do
begin
Socket . unix ( socket )
return
rescue
sleep sleep_interval
end
end
raise " could not connect to gitaly at #{ socket . inspect } after #{ sleep_time } seconds "
2017-08-17 22:00:37 +05:30
end
def stop_gitaly
return unless @gitaly_pid
Process . kill ( 'KILL' , @gitaly_pid )
2018-03-17 18:26:18 +05:30
rescue Errno :: ESRCH
# The process can already be gone if the test run was INTerrupted.
2017-08-17 22:00:37 +05:30
end
2014-09-02 18:07:02 +05:30
def setup_factory_repo
2015-09-11 14:41:01 +05:30
setup_repo ( factory_repo_path , factory_repo_path_bare , factory_repo_name ,
BRANCH_SHA )
end
# This repo has a submodule commit that is not present in the main test
# repository.
def setup_forked_repo
setup_repo ( forked_repo_path , forked_repo_path_bare , forked_repo_name ,
FORKED_BRANCH_SHA )
end
2015-04-26 12:48:37 +05:30
2017-09-10 17:25:29 +05:30
def setup_repo ( repo_path , repo_path_bare , repo_name , refs )
2015-09-11 14:41:01 +05:30
clone_url = " https://gitlab.com/gitlab-org/ #{ repo_name } .git "
unless File . directory? ( repo_path )
2015-11-26 14:37:03 +05:30
system ( * %W( #{ Gitlab . config . git . bin_path } clone -q #{ clone_url } #{ repo_path } ) )
2015-04-26 12:48:37 +05:30
end
2014-09-02 18:07:02 +05:30
2017-09-10 17:25:29 +05:30
set_repo_refs ( repo_path , refs )
2015-04-26 12:48:37 +05:30
2017-08-17 22:00:37 +05:30
unless File . directory? ( repo_path_bare )
# We must copy bare repositories because we will push to them.
system ( git_env , * %W( #{ Gitlab . config . git . bin_path } clone -q --bare #{ repo_path } #{ repo_path_bare } ) )
end
2014-09-02 18:07:02 +05:30
end
2017-09-10 17:25:29 +05:30
def copy_repo ( project , bare_repo : , refs : )
2018-03-17 18:26:18 +05:30
target_repo_path = File . expand_path ( project . repository_storage_path + " / #{ project . disk_path } .git " )
2014-09-02 18:07:02 +05:30
FileUtils . mkdir_p ( target_repo_path )
2017-09-10 17:25:29 +05:30
FileUtils . cp_r ( " #{ File . expand_path ( bare_repo ) } /. " , target_repo_path )
2014-09-02 18:07:02 +05:30
FileUtils . chmod_R 0755 , target_repo_path
2017-09-10 17:25:29 +05:30
set_repo_refs ( target_repo_path , refs )
2014-09-02 18:07:02 +05:30
end
def repos_path
2018-05-09 12:01:36 +05:30
Gitlab . config . repositories . storages [ REPOS_STORAGE ] . legacy_disk_path
2014-09-02 18:07:02 +05:30
end
2015-04-26 12:48:37 +05:30
2015-09-11 14:41:01 +05:30
def backup_path
Gitlab . config . backup . path
end
2017-08-17 22:00:37 +05:30
def pages_path
Gitlab . config . pages . path
end
2018-03-17 18:26:18 +05:30
def artifacts_path
Gitlab . config . artifacts . storage_path
end
2016-04-02 18:10:28 +05:30
# When no cached assets exist, manually hit the root path to create them
#
# Otherwise they'd be created by the first test, often timing out and
# causing a transient test failure
2017-08-17 22:00:37 +05:30
def eager_load_driver_server
2016-04-02 18:10:28 +05:30
return unless defined? ( Capybara )
2017-08-17 22:00:37 +05:30
puts " Starting the Capybara driver server... "
Capybara . current_session . visit '/'
2016-04-02 18:10:28 +05:30
end
2017-09-10 17:25:29 +05:30
def factory_repo_path_bare
" #{ factory_repo_path } _bare "
end
def forked_repo_path_bare
" #{ forked_repo_path } _bare "
end
def with_empty_bare_repository ( name = nil )
path = Rails . root . join ( 'tmp/tests' , name || 'empty-bare-repository' ) . to_s
yield ( Rugged :: Repository . init_at ( path , :bare ) )
ensure
FileUtils . rm_rf ( path )
end
2015-04-26 12:48:37 +05:30
private
def factory_repo_path
@factory_repo_path || = Rails . root . join ( 'tmp' , 'tests' , factory_repo_name )
end
def factory_repo_name
'gitlab-test'
end
2015-09-11 14:41:01 +05:30
def forked_repo_path
@forked_repo_path || = Rails . root . join ( 'tmp' , 'tests' , forked_repo_name )
end
def forked_repo_name
'gitlab-test-fork'
end
2015-04-26 12:48:37 +05:30
# Prevent developer git configurations from being persisted to test
# repositories
def git_env
2015-09-11 14:41:01 +05:30
{ 'GIT_TEMPLATE_DIR' = > '' }
2015-04-26 12:48:37 +05:30
end
2016-09-29 09:46:39 +05:30
def set_repo_refs ( repo_path , branch_sha )
2017-09-10 17:25:29 +05:30
instructions = branch_sha . map { | branch , sha | " update refs/heads/ #{ branch } \x00 #{ sha } \x00 " } . join ( " \x00 " ) << " \x00 "
2017-08-17 22:00:37 +05:30
update_refs = %W( #{ Gitlab . config . git . bin_path } update-ref --stdin -z )
reset = proc do
2017-09-10 17:25:29 +05:30
Dir . chdir ( repo_path ) do
IO . popen ( update_refs , " w " ) { | io | io . write ( instructions ) }
$? . success?
end
2017-08-17 22:00:37 +05:30
end
2017-09-10 17:25:29 +05:30
# Try to reset without fetching to avoid using the network.
unless reset . call
raise 'Could not fetch test seed repository.' unless system ( * %W( #{ Gitlab . config . git . bin_path } -C #{ repo_path } fetch origin ) )
# Before we used Git clone's --mirror option, bare repos could end up
# with missing refs, clearing them and retrying should fix the issue.
2018-03-17 18:26:18 +05:30
clean_gitlab_test_path && init unless reset . call
end
end
def component_timed_setup ( component , install_dir : , version : , task : )
puts " \n ==> Setting up #{ component } ... "
start = Time . now
ensure_component_dir_name_is_correct! ( component , install_dir )
# On CI, once installed, components never need update
return if File . exist? ( install_dir ) && ENV [ 'CI' ]
if component_needs_update? ( install_dir , version )
# Cleanup the component entirely to ensure we start fresh
FileUtils . rm_rf ( install_dir )
unless system ( 'rake' , task )
raise ComponentFailedToInstallError
end
end
yield if block_given?
rescue ComponentFailedToInstallError
puts " \n #{ component } failed to install, cleaning up #{ install_dir } ! \n "
FileUtils . rm_rf ( install_dir )
exit 1
ensure
puts " #{ component } setup in #{ Time . now - start } seconds... \n "
end
def ensure_component_dir_name_is_correct! ( component , path )
actual_component_dir_name = File . basename ( path )
expected_component_dir_name = component . parameterize
unless actual_component_dir_name == expected_component_dir_name
puts " #{ component } install dir should be named ' #{ expected_component_dir_name } ', not ' #{ actual_component_dir_name } ' (full install path given was ' #{ path } ')! \n "
exit 1
2016-09-29 09:46:39 +05:30
end
end
2017-09-10 17:25:29 +05:30
def component_needs_update? ( component_folder , expected_version )
2018-03-17 18:26:18 +05:30
# Allow local overrides of the component for tests during development
return false if Rails . env . test? && File . symlink? ( component_folder )
2017-09-10 17:25:29 +05:30
version = File . read ( File . join ( component_folder , 'VERSION' ) ) . strip
# Notice that this will always yield true when using branch versions
# (`=branch_name`), but that actually makes sure the server is always based
# on the latest branch revision.
version != expected_version
rescue Errno :: ENOENT
true
end
2014-09-02 18:07:02 +05:30
end