BigW Consortium Gitlab

ee_compat_check.rb 7.84 KB
Newer Older
1
# rubocop: disable Rails/Output
2 3 4
module Gitlab
  # Checks if a set of migrations requires downtime or not.
  class EeCompatCheck
5
    CE_REPO = 'https://gitlab.com/gitlab-org/gitlab-ce.git'.freeze
6
    EE_REPO = 'https://gitlab.com/gitlab-org/gitlab-ee.git'.freeze
7 8 9
    CHECK_DIR = Rails.root.join('ee_compat_check')
    MAX_FETCH_DEPTH = 500
    IGNORED_FILES_REGEX = /(VERSION|CHANGELOG\.md:\d+)/.freeze
10

11
    attr_reader :repo_dir, :patches_dir, :ce_repo, :ce_branch
12

13 14 15
    def initialize(branch:, ce_repo: CE_REPO)
      @repo_dir = CHECK_DIR.join('repo')
      @patches_dir = CHECK_DIR.join('patches')
16
      @ce_branch = branch
17
      @ce_repo = ce_repo
18 19 20 21
    end

    def check
      ensure_ee_repo
22
      ensure_patches_dir
23 24 25

      generate_patch(ce_branch, ce_patch_full_path)

26 27
      Dir.chdir(repo_dir) do
        step("In the #{repo_dir} directory")
28 29 30

        status = catch(:halt_check) do
          ce_branch_compat_check!
31
          delete_ee_branch_locally!
32 33 34 35
          ee_branch_presence_check!
          ee_branch_compat_check!
        end

36
        delete_ee_branch_locally!
37 38 39 40 41 42 43 44 45 46 47 48

        if status.nil?
          true
        else
          false
        end
      end
    end

    private

    def ensure_ee_repo
49 50
      if Dir.exist?(repo_dir)
        step("#{repo_dir} already exists")
51
      else
52 53
        cmd = %W[git clone --branch master --single-branch --depth 200 #{EE_REPO} #{repo_dir}]
        step("Cloning #{EE_REPO} into #{repo_dir}", cmd)
54 55 56
      end
    end

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
    def ensure_patches_dir
      FileUtils.mkdir_p(patches_dir)
    end

    def generate_patch(branch, patch_path)
      FileUtils.rm(patch_path, force: true)

      depth = 0
      loop do
        depth += 50
        cmd = %W[git fetch --depth #{depth} origin --prune +refs/heads/master:refs/remotes/origin/master]
        Gitlab::Popen.popen(cmd)
        _, status = Gitlab::Popen.popen(%w[git merge-base FETCH_HEAD HEAD])

        raise "#{branch} is too far behind master, please rebase it!" if depth >= MAX_FETCH_DEPTH
        break if status.zero?
      end
74

75 76 77 78 79 80 81 82 83 84 85
      step("Generating the patch against master in #{patch_path}")
      output, status = Gitlab::Popen.popen(%w[git format-patch FETCH_HEAD --stdout])
      throw(:halt_check, :ko) unless status.zero?

      File.write(patch_path, output)
      throw(:halt_check, :ko) unless File.exist?(patch_path)
    end

    def ce_branch_compat_check!
      if check_patch(ce_patch_full_path).zero?
        puts applies_cleanly_msg(ce_branch)
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
        throw(:halt_check)
      end
    end

    def ee_branch_presence_check!
      status = step("Fetching origin/#{ee_branch}", %W[git fetch origin #{ee_branch}])

      unless status.zero?
        puts
        puts ce_branch_doesnt_apply_cleanly_and_no_ee_branch_msg

        throw(:halt_check, :ko)
      end
    end

    def ee_branch_compat_check!
      step("Checking out origin/#{ee_branch}", %W[git checkout -b #{ee_branch} FETCH_HEAD])

      generate_patch(ee_branch, ee_patch_full_path)

106
      unless check_patch(ee_patch_full_path).zero?
107 108 109 110 111 112 113
        puts
        puts ee_branch_doesnt_apply_cleanly_msg

        throw(:halt_check, :ko)
      end

      puts
114
      puts applies_cleanly_msg(ee_branch)
115 116
    end

117 118 119
    def check_patch(patch_path)
      step("Checking out master", %w[git checkout master])
      step("Reseting to latest master", %w[git reset --hard origin/master])
120

121 122
      step("Checking if #{patch_path} applies cleanly to EE/master")
      output, status = Gitlab::Popen.popen(%W[git apply --check #{patch_path}])
123

124 125 126 127 128 129 130 131
      unless status.zero?
        failed_files = output.lines.reduce([]) do |memo, line|
          if line.start_with?('error: patch failed:')
            file = line.sub(/\Aerror: patch failed: /, '')
            memo << file unless file =~ IGNORED_FILES_REGEX
          end
          memo
        end
132

133 134 135 136 137 138 139 140 141
        if failed_files.empty?
          status = 0
        else
          puts "\nConflicting files:"
          failed_files.each do |file|
            puts "  - #{file}"
          end
        end
      end
142

143
      status
144 145
    end

146
    def delete_ee_branch_locally!
147
      command(%w[git checkout master])
148 149 150 151
      step("Deleting the local #{ee_branch} branch", %W[git branch -D #{ee_branch}])
    end

    def ce_patch_name
152
      @ce_patch_name ||= patch_name_from_branch(ce_branch)
153 154 155
    end

    def ce_patch_full_path
156
      @ce_patch_full_path ||= patches_dir.join(ce_patch_name)
157 158 159 160 161 162 163
    end

    def ee_branch
      @ee_branch ||= "#{ce_branch}-ee"
    end

    def ee_patch_name
164
      @ee_patch_name ||= patch_name_from_branch(ee_branch)
165 166 167
    end

    def ee_patch_full_path
168
      @ee_patch_full_path ||= patches_dir.join(ee_patch_name)
169 170
    end

171 172 173 174
    def patch_name_from_branch(branch_name)
      branch_name.parameterize << '.patch'
    end

175 176 177 178
    def step(desc, cmd = nil)
      puts "\n=> #{desc}\n"

      if cmd
179
        start = Time.now
180
        puts "\n$ #{cmd.join(' ')}"
181 182 183
        status = command(cmd)
        puts "\nFinished in #{Time.now - start} seconds"
        status
184 185 186 187 188 189 190 191 192 193
      end
    end

    def command(cmd)
      output, status = Gitlab::Popen.popen(cmd)
      puts output

      status
    end

194
    def applies_cleanly_msg(branch)
195 196 197 198
      <<-MSG.strip_heredoc
        =================================================================
        🎉 Congratulations!! 🎉

199
        The #{branch} branch applies cleanly to EE/master!
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239

        Much ❤️!!
        =================================================================\n
      MSG
    end

    def ce_branch_doesnt_apply_cleanly_and_no_ee_branch_msg
      <<-MSG.strip_heredoc
        =================================================================
        💥 Oh no! 💥

        The #{ce_branch} branch does not apply cleanly to the current
        EE/master, and no #{ee_branch} branch was found 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.

        There are different ways to create such branch:

        1. Create a new branch based on the CE branch and rebase it on top of EE/master

          # In the EE repo
          $ git fetch #{ce_repo} #{ce_branch}
          $ git checkout -b #{ee_branch} FETCH_HEAD

          # You can squash the #{ce_branch} commits into a single "Port of #{ce_branch} to EE" commit
          # before rebasing to limit the conflicts-resolving steps during the rebase
          $ git fetch origin
          $ git rebase origin/master

          At this point you will likely have conflicts.
          Solve them, and continue/finish the rebase.

          You can squash the #{ce_branch} commits into a single "Port of #{ce_branch} to EE".

        2. Create a new branch from master and cherry-pick your CE commits

          # In the EE repo
          $ git fetch origin
240
          $ git checkout -b #{ee_branch} origin/master
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
          $ git fetch #{ce_repo} #{ce_branch}
          $ git cherry-pick SHA # Repeat for all the commits you want to pick

          You can squash the #{ce_branch} commits into a single "Port of #{ce_branch} to EE" commit.

        Don't forget to push your branch to #{EE_REPO}:

          # In the EE repo
          $ git push origin #{ee_branch}

        You can then retry this failed build, and hopefully it should pass.

        Stay 💪 !
        =================================================================\n
      MSG
    end

    def ee_branch_doesnt_apply_cleanly_msg
      <<-MSG.strip_heredoc
        =================================================================
        💥 Oh no! 💥

        The #{ce_branch} does not apply cleanly to the current
        EE/master, and even though a #{ee_branch} branch exists in the EE
        repository, it does not apply cleanly either to EE/master!

        Please update the #{ee_branch}, push it again to #{EE_REPO}, and
        retry this build.

        Stay 💪 !
        =================================================================\n
      MSG
    end
  end
end