If TestEnv#set_repo_refs fails, clean test repos and retry

Sometimes, new references are not retrieved when a `git fetch` is called
in a bare repos. The easiest solution is to cleanup the test repos and
retry in this case. This only happens when a new ref is added to
TestEnv::BRANCH_SHA or TestEnv::FORKED_BRANCH_SHA.
Signed-off-by: Rémy Coutable <remy@rymai.me>

spec/factories/projects.rb

@@ -60,7 +60,9 @@ FactoryGirl.define do
 
     trait :test_repo do
       after :create do |project|
-        TestEnv.copy_repo(project)
+        TestEnv.copy_repo(project,
+          bare_repo: TestEnv.factory_repo_path_bare,
+          refs: TestEnv::BRANCH_SHA)
       end
     end
 
@@ -139,7 +141,9 @@ FactoryGirl.define do
     end
 
     after :create do |project, evaluator|
-      TestEnv.copy_repo(project)
+      TestEnv.copy_repo(project,
+        bare_repo: TestEnv.factory_repo_path_bare,
+        refs: TestEnv::BRANCH_SHA)
 
       if evaluator.create_template
         args = evaluator.create_template
@@ -172,7 +176,9 @@ FactoryGirl.define do
     path { 'forked-gitlabhq' }
 
     after :create do |project|
-      TestEnv.copy_repo(project, copy_fork: true)
+      TestEnv.copy_repo(project,
+        bare_repo: TestEnv.forked_repo_path_bare,
+        refs: TestEnv::FORKED_BRANCH_SHA)
     end
   end
 

spec/support/test_env.rb

@@ -155,14 +155,14 @@ module TestEnv
                FORKED_BRANCH_SHA)
   end
 
-  def setup_repo(repo_path, repo_path_bare, repo_name, branch_sha)
+  def setup_repo(repo_path, repo_path_bare, repo_name, refs)
     clone_url = "https://gitlab.com/gitlab-org/#{repo_name}.git"
 
     unless File.directory?(repo_path)
       system(*%W(#{Gitlab.config.git.bin_path} clone -q #{clone_url} #{repo_path}))
     end
 
-    set_repo_refs(repo_path, branch_sha)
+    set_repo_refs(repo_path, refs)
 
     unless File.directory?(repo_path_bare)
       # We must copy bare repositories because we will push to them.
@@ -170,13 +170,12 @@ module TestEnv
     end
   end
 
-  def copy_repo(project, copy_fork: false)
-    base_repo_path = File.expand_path(copy_fork ? forked_repo_path_bare : factory_repo_path_bare)
+  def copy_repo(project, bare_repo:, refs:)
     target_repo_path = File.expand_path(project.repository_storage_path + "/#{project.full_path}.git")
     FileUtils.mkdir_p(target_repo_path)
-    FileUtils.cp_r("#{base_repo_path}/.", target_repo_path)
+    FileUtils.cp_r("#{File.expand_path(bare_repo)}/.", target_repo_path)
     FileUtils.chmod_R 0755, target_repo_path
-    set_repo_refs(target_repo_path, copy_fork ? FORKED_BRANCH_SHA : BRANCH_SHA)
+    set_repo_refs(target_repo_path, refs)
   end
 
   def repos_path
@@ -202,16 +201,20 @@ module TestEnv
     Capybara.current_session.visit '/'
   end
 
+  def factory_repo_path_bare
+    "#{factory_repo_path}_bare"
+  end
+
+  def forked_repo_path_bare
+    "#{forked_repo_path}_bare"
+  end
+
   private
 
   def factory_repo_path
     @factory_repo_path ||= Rails.root.join('tmp', 'tests', factory_repo_name)
   end
 
-  def factory_repo_path_bare
-    "#{factory_repo_path}_bare"
-  end
-
   def factory_repo_name
     'gitlab-test'
   end
@@ -220,10 +223,6 @@ module TestEnv
     @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
@@ -235,19 +234,22 @@ module TestEnv
   end
 
   def set_repo_refs(repo_path, branch_sha)
-    instructions = branch_sha.map {|branch, sha| "update refs/heads/#{branch}\x00#{sha}\x00" }.join("\x00") << "\x00"
+    instructions = branch_sha.map { |branch, sha| "update refs/heads/#{branch}\x00#{sha}\x00" }.join("\x00") << "\x00"
     update_refs = %W(#{Gitlab.config.git.bin_path} update-ref --stdin -z)
     reset = proc do
-      IO.popen(update_refs, "w") {|io| io.write(instructions) }
-      $?.success?
+      Dir.chdir(repo_path) do
+        IO.popen(update_refs, "w") { |io| io.write(instructions) }
+        $?.success?
+      end
     end
 
-    Dir.chdir(repo_path) do
-      # 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} fetch origin))
-        raise 'The fetched test seed does not contain the required revision.' unless reset.call
-      end
+    # 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.
+      cleanup && init unless reset.call
     end
   end
 end