Speed up gitaly setup in tests

- Re-use the GDK's gitaly binaries if available. This avoids having to
compile gitaly from scratch

- Warn if the GDK gitaly binary does not match GITALY_SERVER_VERSION

Output a warning if the binary version does not match the current
GITALY_SERVER_VERSION. In most cases, this is not an issue but in some
cases it could be.

- Add FORCE_GITALY_INSTALL to use default install rake task

lib/tasks/gitlab/gitaly.rake

@@ -2,6 +2,42 @@
 
 namespace :gitlab do
   namespace :gitaly do
+    desc 'Installs gitaly for running tests within gitlab-development-kit'
+    task :test_install, [:dir, :storage_path, :repo] => :gitlab_environment do |t, args|
+      inside_gdk = Rails.env.test? && File.exist?(Rails.root.join('../GDK_ROOT'))
+
+      if ENV['FORCE_GITALY_INSTALL'] || !inside_gdk
+        Rake::Task["gitlab:gitaly:install"].invoke(*args)
+
+        next
+      end
+
+      gdk_gitaly_dir = ENV.fetch('GDK_GITALY', Rails.root.join('../gitaly'))
+
+      # Our test setup expects a git repo, so clone rather than copy
+      version = Gitlab::GitalyClient.expected_server_version
+      checkout_or_clone_version(version: version, repo: gdk_gitaly_dir, target_dir: args.dir, clone_opts: %w[--depth 1])
+
+      # We assume the GDK gitaly already compiled binaries
+      build_dir = File.join(gdk_gitaly_dir, '_build')
+      FileUtils.cp_r(build_dir, args.dir)
+
+      # We assume the GDK gitaly already ran bundle install
+      bundle_dir = File.join(gdk_gitaly_dir, 'ruby', '.bundle')
+      FileUtils.cp_r(bundle_dir, File.join(args.dir, 'ruby'))
+
+      # For completeness we copy this for gitaly's make target
+      ruby_bundle_file = File.join(gdk_gitaly_dir, '.ruby-bundle')
+      FileUtils.cp_r(ruby_bundle_file, args.dir)
+
+      gitaly_binary = File.join(build_dir, 'bin', 'gitaly')
+      warn_gitaly_out_of_date!(gitaly_binary, version)
+    rescue Errno::ENOENT => e
+      puts "Could not copy files, did you run `gdk update`? Error: #{e.message}"
+
+      raise
+    end
+
     desc 'GitLab | Gitaly | Install or upgrade gitaly'
     task :install, [:dir, :storage_path, :repo] => :gitlab_environment do |t, args|
       warn_user_is_not_gitlab
@@ -41,5 +77,24 @@ Usage: rake "gitlab:gitaly:install[/installation/dir,/storage/path]")
       _, status = Gitlab::Popen.popen(%w[which gmake])
       status == 0 ? 'gmake' : 'make'
     end
+
+    def warn_gitaly_out_of_date!(gitaly_binary, expected_version)
+      binary_version, exit_status = Gitlab::Popen.popen(%W[#{gitaly_binary} -version])
+
+      raise "Failed to run `#{gitaly_binary} -version`" unless exit_status == 0
+
+      binary_version = binary_version.strip
+
+      # See help for `git describe` for format
+      git_describe_sha = /g([a-f0-9]{5,40})\z/
+      match = binary_version.match(git_describe_sha)
+
+      # Just skip if the version does not have a sha component
+      return unless match
+
+      return if expected_version.start_with?(match[1])
+
+      puts "WARNING: #{binary_version.strip} does not exactly match repository version #{expected_version}"
+    end
   end
 end

spec/support/helpers/test_env.rb

@@ -158,7 +158,7 @@ module TestEnv
     component_timed_setup('Gitaly',
       install_dir: gitaly_dir,
       version: Gitlab::GitalyClient.expected_server_version,
-      task: "gitlab:gitaly:install",
+      task: "gitlab:gitaly:test_install",
       task_args: [gitaly_dir, repos_path, gitaly_url].compact) do
         Gitlab::SetupHelper::Gitaly.create_configuration(
           gitaly_dir,