Merge branch 'ce-to-ee-merge-check-rake-task' into 'master'

CE to EE merge check rake task

## What does this MR do?

This merge request adds a Rake task that checks whether the current branch can be merged cleanly to EE/master.

If not, it checks if a `<ce_branch>-ee` branch exists in EE, tries to merge it to EE/master and then tries to merge `ce_branch` to EE/master.

If the result of the check is that the current branch cannot be merged cleanly to EE/master, the job will fail, display troubleshooting steps, and a warning will be shown in the merge request.

## Are there points in the code the reviewer needs to double check?

Probably the steps I used to do the various checks, and also the steps I suggest to create an EE-specific branch.

## Why was this MR needed?

The goal is to catch as early as possible the possible conflicts a CE MR will cause when CE/master will be merged to EE/master. This way, the developer is warned that he/she should open a MR against EE before or as soon as the CE is merged. In the end, this should lower the work of the CE->EE merger.

## What are the relevant issue numbers?

Part of gitlab-org/gitlab-ee#715, hopefully.

See merge request !6746

3 files changed, 118 insertions, 0 deletions

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 7d19f55aca3..8708eae1b2a 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -210,6 +210,13 @@ rake brakeman: *exec
 rake flay: *exec
 license_finder: *exec
 rake downtime_check: *exec
+rake ce_to_ee_merge_check:
+  <<: *exec
+  only:
+    - branches
+  except:
+    - tags
+  allow_failure: yes
 
 rake db:migrate:reset:
   stage: test
diff --git a/lib/tasks/ce_to_ee_merge_check.rake b/lib/tasks/ce_to_ee_merge_check.rake
new file mode 100644
index 00000000000..424e7883060
--- /dev/null
+++ b/lib/tasks/ce_to_ee_merge_check.rake
@@ -0,0 +1,4 @@
+desc 'Checks if the branch would apply cleanly to EE'
+task ce_to_ee_merge_check: :environment do
+  Rake::Task['gitlab:dev:ce_to_ee_merge_check'].invoke
+end
diff --git a/lib/tasks/gitlab/dev.rake b/lib/tasks/gitlab/dev.rake
new file mode 100644
index 00000000000..47bdb2d32d2
--- /dev/null
+++ b/lib/tasks/gitlab/dev.rake
@@ -0,0 +1,107 @@
+namespace :gitlab do
+  namespace :dev do
+    desc 'Checks if the branch would apply cleanly to EE'
+    task ce_to_ee_merge_check: :environment do
+      return if defined?(Gitlab::License)
+      return unless ENV['CI']
+
+      ce_repo = ENV['CI_BUILD_REPO']
+      ce_branch = ENV['CI_BUILD_REF_NAME']
+
+      ee_repo = 'https://gitlab.com/gitlab-org/gitlab-ee.git'
+      ee_branch = "#{ce_branch}-ee"
+      ee_dir = 'gitlab-ee-merge-check'
+
+      puts "\n=> Cloning #{ee_repo} into #{ee_dir}\n"
+      `git clone #{ee_repo} #{ee_dir} --depth 1`
+      Dir.chdir(ee_dir) do
+        puts "\n => Fetching #{ce_repo}/#{ce_branch}\n"
+        `git fetch #{ce_repo} #{ce_branch} --depth 1`
+
+        # Try to merge the current tested branch to EE/master...
+        puts "\n => Merging #{ce_repo}/#{ce_branch} into #{ee_repo}/master\n"
+        `git merge FETCH_HEAD`
+
+        exit 0 if $?.success?
+
+        # Check if the <branch>-ee branch exists...
+        puts "\n => Check if #{ee_repo}/#{ee_branch} exists\n"
+        `git rev-parse --verify #{ee_branch}`
+
+        # The <branch>-ee doesn't exist
+        unless $?.success?
+          puts
+          puts <<-MSG.strip_heredoc
+            =================================================================
+            The #{ce_branch} branch cannot be merged without conflicts to the
+            current EE/master, and no #{ee_branch} branch was detected in
+            the EE repository.
+
+            Please create a #{ee_branch} branch that includes changes from
+            #{ce_branch} but also specific changes than can be applied cleanly
+            to EE/master.
+
+            You can create this branch as follows:
+
+            1. In the EE repo:
+              $ git fetch origin
+              $ git fetch #{ce_repo} #{ce_branch}
+              $ git checkout -b #{ee_branch} FETCH_HEAD
+              $ git rebase origin/master
+            2. At this point you will likely have conflicts, solve them, and
+              continue/finish the rebase. Note: You can squash the CE commits
+              before rebasing.
+            3. You can squash all the original #{ce_branch} commits into a
+              single "Port of #{ce_branch} to EE".
+            4. Push your branch to #{ee_repo}:
+              $ git push origin #{ee_branch}
+            =================================================================\n
+          MSG
+
+          exit 1
+        end
+
+        # Try to merge the <branch>-ee branch to EE/master...
+        puts "\n => Merging #{ee_repo}/#{ee_branch} into #{ee_repo}/master\n"
+        `git merge #{ee_branch} master`
+
+        # The <branch>-ee cannot be merged cleanly to EE/master...
+        unless $?.success?
+          puts
+          puts <<-MSG.strip_heredoc
+            =================================================================
+            The #{ce_branch} branch cannot be merged without conflicts to
+            EE/master, and even though the #{ee_branch} branch exists in the EE
+            repository, it cannot be merged without conflicts to EE/master.
+
+            Please update the #{ee_branch}, push it again to #{ee_repo}, and
+            retry this job.
+            =================================================================\n
+          MSG
+
+          exit 2
+        end
+
+        puts "\n => Merging #{ce_repo}/#{ce_branch} into #{ee_repo}/master\n"
+        `git merge FETCH_HEAD`
+        exit 0 if $?.success?
+
+        # The <branch>-ee can be merged cleanly to EE/master, but <branch> still
+        # cannot be merged cleanly to EE/master...
+        puts
+        puts <<-MSG.strip_heredoc
+          =================================================================
+          The #{ce_branch} branch cannot be merged without conflicts to EE, and
+          even though the #{ee_branch} branch exists in the EE repository and
+          applies cleanly to EE/master, it doesn't prevent conflicts when
+          merging #{ce_branch} into EE.
+
+          We may be in a complex situation here.
+          =================================================================\n
+        MSG
+
+        exit 3
+      end
+    end
+  end
+end