test_env.rb 5.79 KB
Newer Older
1 2
require 'rspec/mocks'

3 4 5
module TestEnv
  extend self

6 7
  # When developing the seed repository, comment out the branch you will modify.
  BRANCH_SHA = {
Sean McGivern's avatar
Sean McGivern committed
8 9 10 11 12 13 14 15 16 17 18 19 20
    'empty-branch'          => '7efb185',
    'flatten-dir'           => 'e56497b',
    'feature'               => '0b4bc9a',
    'feature_conflict'      => 'bb5206f',
    'fix'                   => '48f0be4',
    'improve/awesome'       => '5937ac0',
    'markdown'              => '0ed8c6c',
    'lfs'                   => 'be93687',
    'master'                => '5937ac0',
    "'test'"                => 'e56497b',
    'orphaned-branch'       => '45127a9',
    'binary-encoding'       => '7b1cf43',
    'gitattributes'         => '5a62481',
21 22
    'expand-collapse-diffs' => '4842455',
    'expand-collapse-files' => '025db92',
23
    'expand-collapse-lines' => '238e82d',
24 25
    'video'                 => '8879059',
    'crlf-diff'             => '5938907'
26 27
  }

28 29 30 31 32
  # 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 = {
    'add-submodule-version-bump' => '3f547c08',
33 34
    'master' => '5937ac0',
    'remove-submodule' => '2a33e0c0'
35
  }
36

37 38
  # Test environment
  #
39
  # See gitlab.yml.example test section for paths
40
  #
41
  def init(opts = {})
42 43 44
    # Disable mailer for spinach tests
    disable_mailer if opts[:mailer] == false

Robert Speicher's avatar
Robert Speicher committed
45
    clean_test_path
46

47
    FileUtils.mkdir_p(repos_path)
48
    FileUtils.mkdir_p(backup_path)
49

50 51 52
    # Setup GitLab shell for test instance
    setup_gitlab_shell

53 54
    # Create repository for FactoryGirl.create(:project)
    setup_factory_repo
55

56 57
    # Create repository for FactoryGirl.create(:forked_project_with_submodules)
    setup_forked_repo
58 59
  end

60
  def disable_mailer
61 62
    allow_any_instance_of(NotificationService).to receive(:mailer).
      and_return(double.as_null_object)
63
  end
64

65
  def enable_mailer
66 67
    allow_any_instance_of(NotificationService).to receive(:mailer).
      and_call_original
68 69
  end

70
  def disable_pre_receive
71
    allow_any_instance_of(Gitlab::Git::Hook).to receive(:trigger).and_return([true, nil])
72 73
  end

Robert Speicher's avatar
Robert Speicher committed
74 75 76 77 78 79 80
  # Clean /tmp/tests
  #
  # Keeps gitlab-shell and gitlab-test
  def clean_test_path
    tmp_test_path = Rails.root.join('tmp', 'tests', '**')

    Dir[tmp_test_path].each do |entry|
81
      unless File.basename(entry) =~ /\Agitlab-(shell|test|test-fork)\z/
Robert Speicher's avatar
Robert Speicher committed
82 83 84 85 86
        FileUtils.rm_rf(entry)
      end
    end
  end

87
  def setup_gitlab_shell
88
    unless File.directory?(Gitlab.config.gitlab_shell.path)
89
      `rake gitlab:shell:install`
Robert Speicher's avatar
Robert Speicher committed
90
    end
91
  end
92

93
  def setup_factory_repo
94 95 96 97 98 99 100 101 102 103 104 105 106
    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

  def setup_repo(repo_path, repo_path_bare, repo_name, branch_sha)
    clone_url = "https://gitlab.com/gitlab-org/#{repo_name}.git"
107

108
    unless File.directory?(repo_path)
109
      system(*%W(#{Gitlab.config.git.bin_path} clone -q #{clone_url} #{repo_path}))
110 111
    end

112 113
    Dir.chdir(repo_path) do
      branch_sha.each do |branch, sha|
114
        # Try to reset without fetching to avoid using the network.
115
        reset = %W(#{Gitlab.config.git.bin_path} update-ref refs/heads/#{branch} #{sha})
116
        unless system(*reset)
117
          if system(*%W(#{Gitlab.config.git.bin_path} fetch origin))
118 119 120 121 122 123 124 125 126
            unless system(*reset)
              raise 'The fetched test seed '\
              'does not contain the required revision.'
            end
          else
            raise 'Could not fetch test seed repository.'
          end
        end
      end
127
    end
128 129

    # We must copy bare repositories because we will push to them.
130
    system(git_env, *%W(#{Gitlab.config.git.bin_path} clone -q --bare #{repo_path} #{repo_path_bare}))
131 132
  end

133
  def copy_repo(project)
134
    base_repo_path = File.expand_path(factory_repo_path_bare)
135
    target_repo_path = File.expand_path(project.repository_storage_path + "/#{project.namespace.path}/#{project.path}.git")
136 137 138
    FileUtils.mkdir_p(target_repo_path)
    FileUtils.cp_r("#{base_repo_path}/.", target_repo_path)
    FileUtils.chmod_R 0755, target_repo_path
139 140
  end

141
  def repos_path
142
    Gitlab.config.repositories.storages.default
143
  end
144

145 146 147 148
  def backup_path
    Gitlab.config.backup.path
  end

149 150
  def copy_forked_repo_with_submodules(project)
    base_repo_path = File.expand_path(forked_repo_path_bare)
151
    target_repo_path = File.expand_path(project.repository_storage_path + "/#{project.namespace.path}/#{project.path}.git")
152 153 154 155 156
    FileUtils.mkdir_p(target_repo_path)
    FileUtils.cp_r("#{base_repo_path}/.", target_repo_path)
    FileUtils.chmod_R 0755, target_repo_path
  end

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
  # 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
  def warm_asset_cache
    return if warm_asset_cache?
    return unless defined?(Capybara)

    Capybara.current_session.driver.visit '/'
  end

  def warm_asset_cache?
    cache = Rails.root.join(*%w(tmp cache assets test))
    Dir.exist?(cache) && Dir.entries(cache).length > 2
  end

173 174 175
  private

  def factory_repo_path
176 177 178 179
    @factory_repo_path ||= Rails.root.join('tmp', 'tests', factory_repo_name)
  end

  def factory_repo_path_bare
Robert Speicher's avatar
Robert Speicher committed
180
    "#{factory_repo_path}_bare"
181 182 183 184 185
  end

  def factory_repo_name
    'gitlab-test'
  end
186

187 188 189 190 191 192 193 194 195 196 197 198
  def forked_repo_path
    @forked_repo_path ||= Rails.root.join('tmp', 'tests', forked_repo_name)
  end

  def forked_repo_path_bare
    "#{forked_repo_path}_bare"
  end

  def forked_repo_name
    'gitlab-test-fork'
  end

199 200 201
  # Prevent developer git configurations from being persisted to test
  # repositories
  def git_env
202
    { 'GIT_TEMPLATE_DIR' => '' }
203
  end
204
end