Class: FlashFlow::Deploy

Inherits:
Object
  • Object
show all
Defined in:
lib/flash_flow/deploy.rb

Defined Under Namespace

Classes: GitPushFailure, OutOfSyncWithRemote, UnmergeableBranch

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ Deploy

Returns a new instance of Deploy.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/flash_flow/deploy.rb', line 18

def initialize(opts={})
  @do_not_merge = opts[:do_not_merge]
  @force = opts[:force]
  @rerere_forget = opts[:rerere_forget]
  @stories = [opts[:stories]].flatten.compact

  @local_git = Git.new(Config.configuration.git, logger)
  @git = ShadowGit.new(Config.configuration.git, logger)
  @lock = Lock::Base.new(Config.configuration.lock)
  @notifier = Notifier::Base.new(Config.configuration.notifier)
  @data = Data::Base.new(Config.configuration.branches, Config.configuration.branch_info_file, @git, logger: logger)

  @release_branches = parse_branches(opts[:release_branches])
end

Instance Method Details

#check_branches ⇒ Object

Raises:

  • (RuntimeError) 


130
131
132
133
 
# File 'lib/flash_flow/deploy.rb', line 130

def check_branches
  requested_not_ready_branches = (@release_branches.map(&:ref) - shippable_branch_names)
  raise RuntimeError.new("The following branches are not ready to ship:\n#{requested_not_ready_branches.join("\n")}") unless requested_not_ready_branches.empty?
end

#check_repo ⇒ Object 



144
145
146
147
148
 
# File 'lib/flash_flow/deploy.rb', line 144

def check_repo
  if @local_git.staged_and_working_dir_files.any?
    raise RuntimeError.new('You have changes in your working directory. Please stash and try again')
  end
end

#check_version ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/flash_flow/deploy.rb', line 150

def check_version
  data_version = @data.version
  return if data_version.nil?

  written_version = data_version.split(".").map(&:to_i)
  running_version = FlashFlow::VERSION.split(".").map(&:to_i)

  unless written_version[0] < running_version[0] ||
      (written_version[0] == running_version[0] && written_version[1] <= running_version[1]) # Ignore the point release number
    raise RuntimeError.new("Your version of flash flow (#{FlashFlow::VERSION}) is behind the version that was last used (#{data_version}) by a member of your team. Please upgrade to at least #{written_version[0]}.#{written_version[1]}.0 and try again.")
  end
end

#commit_branch_info ⇒ Object 



163
164
165
166
167
168
 
# File 'lib/flash_flow/deploy.rb', line 163

def commit_branch_info
  @stories.each do |story_id|
    @data.add_story(@git.merge_remote, @git.working_branch, story_id)
  end
  @data.save!
end

#commit_message ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/flash_flow/deploy.rb', line 278

def commit_message
  message ="Flash Flow run from branch: \#{@local_git.working_branch}\n\nMerged branches:\n\#{@data.successes.empty? ? 'None' : @data.successes.sort_by(&:merge_order).map(&:ref).join(\"\\n\")}\n\nFailed branches:\n\#{@data.failures.empty? ? 'None' : @data.failures.map(&:ref).join(\"\\n\")}\n\nRemoved branches:\n\#{@data.removals.empty? ? 'None' : @data.removals.map(&:ref).join(\"\\n\")}\n  EOS\n  message.gsub(/'/, '')\nend\n"

#commit_rerere ⇒ Object 



170
171
172
173
174
175
 
# File 'lib/flash_flow/deploy.rb', line 170

def commit_rerere
  current_branches = @data.merged_branches.to_a.select { |branch| !@git.master_branch_contains?(branch.sha) && (Time.now - branch.updated_at < two_weeks) }
  current_rereres = current_branches.map { |branch| branch.resolutions.to_h.values }.flatten

  @git.commit_rerere(current_rereres)
end

#format_errors ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/flash_flow/deploy.rb', line 251

def format_errors
  errors = []
  branch_not_merged = nil
  @data.failures.each do |branch|
    if branch.ref == @local_git.working_branch
      branch_not_merged = "ERROR: Your branch did not merge to #{@local_git.merge_branch}. Run 'flash_flow --resolve', fix the merge conflict(s) and then re-run this script\n"
    else
      errors << "WARNING: Unable to merge branch #{branch.remote}/#{branch.ref} to #{@local_git.merge_branch} due to conflicts."
    end
  end
  errors << branch_not_merged if branch_not_merged

  if errors.empty?
    "Success!"
  else
    errors.join("\n")
  end
end

#git_merge(branch) ⇒ Object 



198
199
200
201
202
203
204
205
 
# File 'lib/flash_flow/deploy.rb', line 198

def git_merge(branch)
  merger = BranchMerger.new(@git, branch)
  forget_rerere = is_working_branch(branch) && @rerere_forget

  merger.do_merge(forget_rerere)

  merger
end

#is_working_branch(branch) ⇒ Object 



228
229
230
 
# File 'lib/flash_flow/deploy.rb', line 228

def is_working_branch(branch)
  branch.ref == @git.working_branch
end

#logger ⇒ Object 



33
34
35
 
# File 'lib/flash_flow/deploy.rb', line 33

def logger
  @logger ||= FlashFlow::Config.configuration.logger
end

#merge_branches(branches) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/flash_flow/deploy.rb', line 181

def merge_branches(branches)
  ordered_branches = MergeOrder.new(@git, branches).get_order
  ordered_branches.each_with_index do |branch, index|
    branch.merge_order = index + 1

    remote = @git.fetch_remote_for_url(branch.remote_url)
    if remote.nil?
      raise RuntimeError.new("No remote found for #{branch.remote_url}. Please run 'git remote add *your_remote_name* #{branch.remote_url}' and try again.")
    end

    @git.fetch(branch.remote)
    merger = git_merge(branch)

    yield(branch, merger)
  end
end

#open_pull_request ⇒ Object

Raises:



232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/flash_flow/deploy.rb', line 232

def open_pull_request
  return false if [@local_git.master_branch, @local_git.merge_branch].include?(@local_git.working_branch)

  # TODO - This should use the actual remote for the branch we're on
  @local_git.push(@local_git.working_branch, @force)
  raise OutOfSyncWithRemote.new("Your branch is out of sync with the remote. If you want to force push, run 'flash_flow -f'") unless @local_git.last_success?

  # TODO - This should use the actual remote for the branch we're on
  if @do_not_merge
    @data.remove_from_merge(@local_git.merge_remote, @local_git.working_branch)
  else
    @data.add_to_merge(@local_git.merge_remote, @local_git.working_branch)
  end
end

#parse_branches(user_branches) ⇒ Object 



37
38
39
40
41
 
# File 'lib/flash_flow/deploy.rb', line 37

def parse_branches(user_branches)
  branch_list = user_branches == ['ready'] ? shippable_branch_names : [user_branches].flatten.compact

  branch_list.map { |b| Data::Branch.new('origin', @git.remotes_hash['origin'], b) }
end

#print_errors ⇒ Object 



247
248
249
 
# File 'lib/flash_flow/deploy.rb', line 247

def print_errors
  puts format_errors
end

#process_result(branch, merger) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/flash_flow/deploy.rb', line 207

def process_result(branch, merger)
  case merger.result
    when :deleted
      @data.mark_deleted(branch)
      @notifier.deleted_branch(branch) unless is_working_branch(branch)

    when :success
      branch.sha = merger.sha
      @data.mark_success(branch)
      @data.set_resolutions(branch, merger.resolutions)

    when :conflict
      if is_working_branch(branch)
        @data.mark_failure(branch, merger.conflict_sha)
      else
        @data.mark_failure(branch, nil)
        @notifier.merge_conflict(branch)
      end
  end
end

#release_commit_message ⇒ Object 



270
271
272
273
274
275
276
 
# File 'lib/flash_flow/deploy.rb', line 270

def release_commit_message
  message ="Flash Flow merged these branches:\n\#{@release_branches.map(&:ref).join(\"\\n\")}\n  EOS\n  message.gsub(/'/, '')\nend\n"

#run ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/flash_flow/deploy.rb', line 91

def run
  check_version
  check_repo
  puts "Building #{@local_git.merge_branch}... Log can be found in #{FlashFlow::Config.configuration.log_file}"
  logger.info "\n\n### Beginning #{@local_git.merge_branch} merge ###\n\n"

  begin
    open_pull_request

    @lock.with_lock do
      @git.fetch(@git.merge_remote)
      @git.in_original_merge_branch do
        @git.initialize_rerere
      end

      @git.reset_temp_merge_branch
      @git.in_temp_merge_branch do
        merge_branches(@data.merged_branches.mergeable) do |branch, merger|
          process_result(branch, merger)
        end
        commit_branch_info
        commit_rerere
      end

      @git.copy_temp_to_branch(@git.merge_branch, commit_message)
      @git.delete_temp_merge_branch
      @git.push(@git.merge_branch, true)
    end

    print_errors
    logger.info "### Finished #{@local_git.merge_branch} merge ###"
  rescue Lock::Error, OutOfSyncWithRemote => e
    puts 'Failure!'
    puts e.message
  ensure
    @local_git.run("checkout #{@local_git.working_branch}")
  end
end

#run_release ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/flash_flow/deploy.rb', line 43

def run_release
  check_version
  check_branches
  puts "Merging these branches into #{@git.release_branch}:\n  #{@release_branches.map(&:ref).join("\n  ")}"
  logger.info "\n\n### Beginning #{@local_git.merge_branch} merge ###\n\n"

  begin
    mergers, errors = [], []

    @lock.with_lock do
      @git.fetch(@git.merge_remote)
      @git.in_original_merge_branch do
        @git.initialize_rerere
      end

      @git.reset_temp_merge_branch
      @git.in_temp_merge_branch do
        merge_branches(@release_branches) do |branch, merger|
          mergers << [branch, merger]
        end
      end

      errors = mergers.select { |m| m.last.result != :success }

      if errors.empty?
        @git.copy_temp_to_branch(@git.release_branch)
        @git.delete_temp_merge_branch
        unless @git.push(@git.release_branch, false)
          raise GitPushFailure.new("Unable to push to #{@git.release_branch}. See log for details.")
        end
      end
    end

    if errors.empty?
      puts 'Success!'
    else
      raise UnmergeableBranch.new("The following branches didn't merge successfully:\n  #{errors.map {|e| e.first.ref }.join("\n  ")}")
    end

    logger.info "### Finished #{@git.release_branch} merge ###"
  rescue Lock::Error, OutOfSyncWithRemote, UnmergeableBranch, GitPushFailure => e
    puts 'Failure!'
    puts e.message
  ensure
    @local_git.run("checkout #{@local_git.working_branch}")
  end
end

#shippable_branch_names ⇒ Object 



135
136
137
138
139
140
141
142
 
# File 'lib/flash_flow/deploy.rb', line 135

def shippable_branch_names
  @shippable_branch_names ||= begin
    status = MergeMaster::Status.new(Config.configuration.issue_tracker, Config.configuration.branches, Config.configuration.branch_info_file, Config.configuration.git, logger: logger)

    all_branches = status.branches
    all_branches.values.select { |b| b[:shippable?] }.map { |b| b[:name] }
  end
end

#two_weeks ⇒ Object 



177
178
179
 
# File 'lib/flash_flow/deploy.rb', line 177

def two_weeks
  60 * 60 * 24 * 14
end