Commit lock author

[davidcornu]

Implements #860.

[davidcornu]

Done to match

shipit-engine/test/dummy/db/schema.rb

Line 206 in 5458ffe

t.integer "lock_author_id", limit: 4

[davidcornu]

Fixed the Rubocop violations

[casperisfine]

❤️

[casperisfine]

Wait, there is another code path, that might need change.

[casperisfine]

@davidcornu Here the other path that would need author handling:

shipit-engine/app/models/shipit/stack.rb

Line 254 in f6b93d8

if commits.where(id: commits_to_lock.map(&:id).uniq).update_all(locked: true) > 1

[davidcornu]

There's another code path that uses this

shipit-engine/app/jobs/shipit/github_sync_job.rb

Lines 15 to 22 in 868398f

	new_commits, shared_parent = fetch_missing_commits { @stack.github_commits }
	@stack.transaction do
	shared_parent&.detach_children!
	appended_commits = new_commits.map do |gh_commit|
	append_commit(gh_commit)
	end
	@stack.lock_reverted_commits! if appended_commits.any?(&:revert?)

I left that one as commits being locked as a result of syncing with GH don't have an obvious lock author.

[casperisfine]

syncing with GH don't have an obvious lock author.

I would have used the revert author, but both are fine.

[davidcornu]

🤔 Given appended_commits.any?(&:revert?), there could be multiple no?

[casperisfine]

In SyncJob yes, but here:

shipit-engine/app/models/shipit/stack.rb

Lines 248 to 249 in f6b93d8

	if revert = backlog.shift
	commits_to_lock += backlog.reverse.drop_while { |c| !revert.revert_of?(c) }

It's not ambiguous.

[davidcornu]

@casperisfine thoughts on this change? I refactored the logic to lock in batches rather than all at once so the lock_author can be set to the revert commit author.

Tests are gonna fail. Will fix after work.

[casperisfine]

LGTM. I'd use affected_rows rather than affected though /nitpick.

[davidcornu]

Ended up adding a bunch of test coverage here as there's some in

shipit-engine/test/jobs/github_sync_job_test.rb

Lines 39 to 87 in 22403f4

	test "#perform locks all commits leading to a revert" do
	@stack.deploys_and_rollbacks.destroy_all
	initial_queue = [
	["whoami", false],
	["fix all the things", false],
	["yoloshipit!", false],
	["fix it!", false],
	["sheep it!", false],
	["lets go", false],
	]
	assert_equal initial_queue, @stack.undeployed_commits.map { |c| [c.title, c.locked?] }
	author = stub(
	id: 1234,
	login: 'bob',
	name: 'Bob the Builder',
	email: 'bob@bob.com',
	date: '2011-04-14T16:00:49Z',
	)
	@job.expects(:fetch_missing_commits).returns([
	[
	stub(
	sha: '36514755579bfb5bc313f403b216f4347a027990',
	author: author,
	committer: author,
	stats: nil,
	commit: stub(
	sha: '36514755579bfb5bc313f403b216f4347a027990',
	message: 'Revert "fix it!"',
	author: author,
	committer: author,
	),
	),
	],
	shipit_commits(:fifth),
	])
	@job.perform(stack_id: @stack.id)
	final_queue = [
	['Revert "fix it!"', false],
	["fix all the things", true],
	["yoloshipit!", true],
	["fix it!", true],
	["sheep it!", false],
	["lets go", false],
	]
	assert_equal final_queue, @stack.reload.undeployed_commits.map { |c| [c.title, c.locked?] }
	end

and

shipit-engine/test/models/rollbacks_test.rb

Lines 22 to 56 in 22403f4

	test "when a rollback succeed reverted commits are locked" do
	@stack.tasks.where.not(id: shipit_tasks(:shipit_complete).id).delete_all
	deploy = @stack.deploys.success.last
	reverted_commit = deploy.until_commit
	@stack.commits.create!(
	sha: '50ce7d4440fcd8c734f8b7b76c86f8db46706e4f',
	message: %(Revert "#{reverted_commit.message_header}"),
	author: reverted_commit.author,
	committer: reverted_commit.committer,
	authored_at: Time.zone.now,
	committed_at: Time.zone.now,
	)
	expected = [
	['Revert "Merge pull request #7 from shipit-engine/yoloshipit"', false, nil],
	["whoami", false, nil],
	['fix all the things', false, nil],
	]
	assert_equal(expected, @stack.undeployed_commits.map { |c| [c.title, c.locked?, c.lock_author_id] })
	rollback = deploy.trigger_revert
	rollback.run!
	rollback.complete!
	user_id = reverted_commit.author.id
	expected = [
	['Revert "Merge pull request #7 from shipit-engine/yoloshipit"', false, nil],
	["whoami", true, user_id],
	['fix all the things', true, user_id],
	['yoloshipit!', true, user_id],
	]
	assert_equal(expected, @stack.undeployed_commits.map { |c| [c.title, c.locked?, c.lock_author_id] })
	end

but not enough to convince me that I wasn't breaking anything with the refactor.

I've also split the addition of these tests and the refactor into separate commits so it's more obvious what my changes actually did.

[DazWorrall]

This looks great, thanks for stepping up ✨