git_reflow 0.7.4 → 0.7.5

data/spec/lgtm_git_reflow_spec.rb

@@ -0,0 +1,496 @@
+require 'spec_helper'
+
+describe GitReflow do
+  let(:git_server)       { GitReflow::GitServer::GitHub.new {} }
+  let(:github)           { Github.new basic_auth: "#{user}:#{password}" }
+  let(:user)             { 'reenhanced' }
+  let(:password)         { 'shazam' }
+  let(:oauth_token_hash) { Hashie::Mash.new({ token: 'a1b2c3d4e5f6g7h8i9j0', note: 'hostname.local git-reflow'}) }
+  let(:repo)             { 'repo' }
+  let(:base_branch)      { 'master' }
+  let(:feature_branch)   { 'new-feature' }
+  let(:enterprise_site)  { 'https://github.reenhanced.com' }
+  let(:enterprise_api)   { 'https://github.reenhanced.com' }
+  let(:hostname)         { 'hostname.local' }
+
+  let(:github_authorizations)  { Github::Client::Authorizations.new }
+  let(:existing_pull_requests) { Fixture.new('pull_requests/pull_requests.json').to_json_hashie }
+  let(:existing_pull_request)  { GitReflow::GitServer::GitHub::PullRequest.new existing_pull_requests.first }
+
+  before do
+
+    # Stubbing out minimum_approvals value to test 2 LGTM reviewers in gitconfig file
+    allow(GitReflow::Config).to receive(:get).with("constants.minimumApprovals").and_return("2")
+    allow(GitReflow::Config).to receive(:get).and_call_original
+
+    HighLine.any_instance.stub(:ask) do |terminal, question|
+      values = {
+        "Please enter your GitHub username: "                                                      => user,
+        "Please enter your GitHub password (we do NOT store this): "                               => password,
+        "Please enter your Enterprise site URL (e.g. https://github.company.com):"                 => enterprise_site,
+        "Please enter your Enterprise API endpoint (e.g. https://github.company.com/api/v3):"      => enterprise_api,
+        "Would you like to push this branch to your remote repo and cleanup your feature branch? " => 'yes',
+        "Would you like to open it in your browser?"                                               => 'n'
+      }
+     return_value = values[question] || values[terminal]
+     question = ""
+     return_value
+    end
+  end
+
+  context :deliver do
+    let(:branch)                { 'new-feature' }
+    let(:inputs)                { {} }
+    let!(:github) do
+      allow_any_instance_of(GitReflow::GitServer::GitHub::PullRequest).to receive(:build).and_return(Struct.new(:state, :description, :url).new)
+      stub_github_with({
+        :user         => user,
+        :password     => password,
+        :repo         => repo,
+        :branch       => branch,
+        :pull         => existing_pull_request
+      })
+    end
+
+
+    before do
+      GitReflow.stub(:append_to_squashed_commit_message).and_return(true)
+
+      module Kernel
+        def system(cmd)
+          "call #{cmd}"
+        end
+      end
+    end
+
+    subject { GitReflow.deliver inputs }
+
+    it "fetches the latest changes to the destination branch" do
+      GitReflow.should_receive(:fetch_destination).with('master')
+      subject
+    end
+
+    it "looks for a pull request matching the feature branch and destination branch" do
+      github.should_receive(:find_open_pull_request).with(from: branch, to: 'master')
+      subject
+    end
+
+    context "and pull request exists for the feature branch to the destination branch" do
+      before do
+        github.stub(:build_status).and_return(build_status)
+        github.should_receive(:find_open_pull_request).and_return(existing_pull_request)
+        existing_pull_request.stub(:has_comments?).and_return(true)
+        github.stub(:reviewers).and_return(['codenamev'])
+        
+        existing_pull_request.stub(:approvals).and_return(["Simon", "John"])
+        existing_pull_request.stub_chain(:last_comment, :match).and_return(true)
+      end
+
+      context 'and build status is not "success"' do
+        let(:build_status) { Hashie::Mash.new({ state: 'failure', description: 'Build resulted in failed test(s)' }) }
+
+        before do
+          existing_pull_request.stub(:build).and_return(build_status)
+          existing_pull_request.stub(:has_comments?).and_return(true)
+        end
+
+        it "halts delivery and notifies user of a failed build" do
+          expect { subject }.to have_said "#{build_status.description}: #{build_status.target_url}", :deliver_halted
+        end
+      end
+
+      context 'and build status is nil' do
+        let(:build_status) { nil }
+        let(:inputs) {{ 'skip_lgtm' => true }}
+
+        before do
+          # stubbing unrelated results so we can just test that it made it insdide the conditional block
+          existing_pull_request.stub(:has_comments?).and_return(true)
+          existing_pull_request.stub(:reviewers).and_return([])
+          GitReflow.stub(:update_destination).and_return(true)
+          GitReflow.stub(:merge_feature_branch).and_return(true)
+          GitReflow.stub(:append_to_squashed_commit_message).and_return(true)
+        end
+
+        it "ignores build status when not setup" do
+          expect { subject }.to have_said "Merge complete!", :success
+        end
+      end
+
+      context 'and build status is "success"' do
+        let(:build_status) { Hashie::Mash.new({ state: 'success' }) }
+
+        context 'and has comments' do
+          before do
+            existing_pull_request.stub(:has_comments?).and_return(true)
+          end
+
+          context 'but there are 2 LGTMs and irrelevant last comment' do
+            let(:lgtm_comment_authors) { ['nhance', 'Simon'] }
+            before do
+              existing_pull_request.stub(:build).and_return(build_status)
+              existing_pull_request.stub(:approvals).and_return(lgtm_comment_authors)
+              allow(GitReflow::GitServer::PullRequest).to receive(:minimum_approvals).and_return("2")
+              existing_pull_request.stub(:reviewers_pending_response).and_return([])
+              existing_pull_request.stub_chain(:last_comment, :match).and_return(nil)
+            end
+
+            it "doesn't include the pull request body in the commit message" do
+              squash_message = "#{existing_pull_request.body}\nCloses ##{existing_pull_request.number}\n\nLGTM given by: @nhance, @Simon\n"
+              GitReflow.should_receive(:append_to_squashed_commit_message).never.with(squash_message)
+              subject
+            end
+
+            context "and the pull request has no body" do
+              let(:first_commit_message) { "We'll do it live." }
+
+              before do
+                existing_pull_request.description = ''
+                github.stub(:find_open_pull_request).and_return(existing_pull_request)
+                GitReflow.stub(:get_first_commit_message).and_return(first_commit_message)
+                existing_pull_request.stub(:reviewers).and_return(lgtm_comment_authors)
+              end
+
+              it "doesn't include the first commit message for the new branch in the commit message of the merge" do
+                squash_message = "#{first_commit_message}\nCloses ##{existing_pull_request.number}\n\nLGTM given by: @nhance, @Simon\n"
+                GitReflow.should_receive(:append_to_squashed_commit_message).never.with(squash_message)
+                subject
+              end
+            end
+
+            it "doesn't notify user of the merge and performs it" do
+              GitReflow.should_receive(:merge_feature_branch).never.with('new-feature', {
+                destination_branch:  'master',
+                pull_request_number: existing_pull_request.number,
+                lgtm_authors:        ['nhance', 'Simon'],
+                message:             existing_pull_request.body
+              })
+
+              expect { subject }.to_not have_output "Merging pull request ##{existing_pull_request.number}: '#{existing_pull_request.title}', from '#{existing_pull_request.head.label}' into '#{existing_pull_request.base.label}'"
+            end
+
+            it "doesn't update the destination branch" do
+              GitReflow.should_receive(:update_destination).with('master').never
+              subject
+            end
+
+            context "and doesn't clean up feature branch" do
+              before do
+                HighLine.any_instance.stub(:ask) do |terminal, question|
+                  values = {
+                    "Please enter your GitHub username: "                                                      => user,
+                    "Please enter your GitHub password (we do NOT store this): "                               => password,
+                    "Please enter your Enterprise site URL (e.g. https://github.company.com):"                 => enterprise_site,
+                    "Please enter your Enterprise API endpoint (e.g. https://github.company.com/api/v3):"      => enterprise_api,
+                    "Would you like to push this branch to your remote repo and cleanup your feature branch? " => 'yes',
+                    "Would you like to open it in your browser?"                                               => 'no'
+                  }
+                 return_value = values[question] || values[terminal]
+                 question = ""
+                 return_value
+                end
+              end
+
+              context "not always" do
+                before do
+                  GitReflow::Config.stub(:get) { "false" }
+                end
+
+                it "doesn't push local squash merged base branch to remote repo" do
+                  expect { subject }.to_not have_run_command("git push origin master")
+                end
+
+                it "doesn't delete the remote feature branch" do
+                  expect { subject }.to_not have_run_command("git push origin :new-feature")
+                end
+
+                it "doesn't delete the local feature branch" do
+                  expect { subject }.to_not have_run_command("git branch -D new-feature")
+                end
+              end
+
+              context "always" do
+                before do
+                  GitReflow::Config.stub(:get) { "true" }
+                end
+
+                it "doesn't push local squash merged base branch to remote repo" do
+                  expect { subject }.to_not have_run_command("git push origin master")
+                end
+
+                it "doesn't delete the remote feature branch" do
+                  expect { subject }.to_not have_run_command("git push origin :new-feature")
+                end
+
+                it "doesn't delete the local feature branch" do
+                  expect { subject }.to_not have_run_command("git branch -D new-feature")
+                end
+              end
+
+            end
+
+            context "and not cleaning up feature branch" do
+              before do
+                HighLine.any_instance.stub(:ask) do |terminal, question|
+                  values = {
+                    "Please enter your GitHub username: "                                                      => user,
+                    "Please enter your GitHub password (we do NOT store this): "                               => password,
+                    "Please enter your Enterprise site URL (e.g. https://github.company.com):"                 => enterprise_site,
+                    "Please enter your Enterprise API endpoint (e.g. https://github.company.com/api/v3):"      => enterprise_api,
+                    "Would you like to push this branch to your remote repo and cleanup your feature branch? " => 'no',
+                    "Would you like to open it in your browser?"                                               => 'no'
+                  }
+                 return_value = values[question] || values[terminal]
+                 question = ""
+                 return_value
+                end
+              end
+
+              it "doesn't update the remote repo with the new squash merge" do
+                expect { subject }.to_not have_run_command('git push origin master')
+              end
+
+              it "doesn't delete the feature branch on the remote repo" do
+                expect { subject }.to_not have_run_command('git push origin :new-feature')
+              end
+
+              it "doesn't delete the local feature branch" do
+                expect { subject }.to_not have_run_command('git branch -D new-feature')
+              end
+
+              it "doesn't provide instructions to undo the steps taken" do
+                expect { subject }.to_not have_output("To reset and go back to your branch run \`git reset --hard origin/master && git checkout new-feature\`")
+              end
+            end
+
+            context "and there were issues commiting the squash merge to the base branch" do
+              before { stub_with_fallback(GitReflow, :run_command_with_label).with('git commit', {with_system: true}).and_return false }
+              it "doesn't notifies user of issues commiting the squash merge of the feature branch" do
+                expect { subject }.to_not have_said("There were problems commiting your feature... please check the errors above and try again.", :error)
+              end
+            end
+          end
+
+          context 'but there are 2 LGTMs and LGTM last comment' do
+            let(:lgtm_comment_authors) { ['nhance', 'Simon'] }
+            before do
+              existing_pull_request.stub(:approvals).and_return(lgtm_comment_authors)
+              existing_pull_request.stub(:reviewers_pending_response).and_return([])
+              existing_pull_request.stub_chain(:last_comment, :match).and_return(true)
+            end
+
+            it "includes the pull request body in the commit message" do
+              squash_message = "#{existing_pull_request.body}\nCloses ##{existing_pull_request.number}\n\nLGTM given by: @nhance, @Simon\n"
+              GitReflow.should_receive(:append_to_squashed_commit_message).with(squash_message)
+              subject
+            end
+
+            context "build status failure, testing description and target_url" do
+              let(:build_status) { Hashie::Mash.new({ state: 'failure', description: 'Build resulted in failed test(s)', target_url: "www.error.com" }) }
+
+              before do
+                existing_pull_request.stub(:build).and_return(build_status)
+                existing_pull_request.stub(:reviewers).and_return(lgtm_comment_authors)
+                existing_pull_request.stub(:has_comments?).and_return(true)
+              end
+
+              it "halts delivery and notifies user of a failed build" do
+                expect { subject }.to have_said "#{build_status.description}: #{build_status.url}", :deliver_halted
+              end
+            end
+
+            context "build status nil" do
+              let(:build_status) { nil }
+
+              before do
+                github.stub(:build).and_return(build_status)
+                existing_pull_request.stub(:reviewers_pending_response).and_return([])
+                existing_pull_request.stub(:has_comments_or_approvals).and_return(true)
+              end
+
+              it "commits the changes if the build status is nil but has comments/approvals and no pending response" do
+                expect{ subject }.to have_said 'Merge complete!', :success
+              end
+            end
+
+            context "and the pull request has no body" do
+              let(:first_commit_message) { "We'll do it live." }
+
+              before do
+                existing_pull_request.description = ''
+                github.stub(:find_open_pull_request).and_return(existing_pull_request)
+                GitReflow.stub(:get_first_commit_message).and_return(first_commit_message)
+                existing_pull_request.stub(:reviewers).and_return(lgtm_comment_authors)
+              end
+
+              it "includes the first commit message for the new branch in the commit message of the merge" do
+                squash_message = "#{first_commit_message}\nCloses ##{existing_pull_request.number}\n\nLGTM given by: @nhance, @Simon\n"
+                GitReflow.should_receive(:append_to_squashed_commit_message).with(squash_message)
+                subject
+              end
+            end
+
+            it "notifies user of the merge and performs it" do
+              GitReflow.should_receive(:merge_feature_branch).with('new-feature', {
+                destination_branch:  'master',
+                pull_request_number: existing_pull_request.number,
+                lgtm_authors:        ['nhance', 'Simon'],
+                message:             existing_pull_request.body
+              })
+
+              expect { subject }.to have_output "Merging pull request ##{existing_pull_request.number}: '#{existing_pull_request.title}', from '#{existing_pull_request.head.label}' into '#{existing_pull_request.base.label}'"
+            end
+
+            it "updates the destination branch" do
+              GitReflow.should_receive(:update_destination).with('master')
+              subject
+            end
+
+            it "commits the changes for the squash merge" do
+              expect{ subject }.to have_said 'Merge complete!', :success
+            end
+
+            context "and cleaning up feature branch" do
+              before do
+                HighLine.any_instance.stub(:ask) do |terminal, question|
+                  values = {
+                    "Please enter your GitHub username: "                                                      => user,
+                    "Please enter your GitHub password (we do NOT store this): "                               => password,
+                    "Please enter your Enterprise site URL (e.g. https://github.company.com):"                 => enterprise_site,
+                    "Please enter your Enterprise API endpoint (e.g. https://github.company.com/api/v3):"      => enterprise_api,
+                    "Would you like to push this branch to your remote repo and cleanup your feature branch? " => 'yes',
+                    "Would you like to open it in your browser?"                                               => 'no'
+                  }
+                 return_value = values[question] || values[terminal]
+                 question = ""
+                 return_value
+                end
+              end
+
+              context "not always" do
+                before do
+                  GitReflow::Config.stub(:get) { "false" }
+                end
+
+                it "pushes local squash merged base branch to remote repo" do
+                  expect { subject }.to have_run_command("git push origin master")
+                end
+
+                it "deletes the remote feature branch" do
+                  expect { subject }.to have_run_command("git push origin :new-feature")
+                end
+
+                it "deletes the local feature branch" do
+                  expect { subject }.to have_run_command("git branch -D new-feature")
+                end
+              end
+
+              context "always" do
+                before do
+                  GitReflow::Config.stub(:get) { "true" }
+                end
+
+                it "pushes local squash merged base branch to remote repo" do
+                  expect { subject }.to have_run_command("git push origin master")
+                end
+
+                it "deletes the remote feature branch" do
+                  expect { subject }.to have_run_command("git push origin :new-feature")
+                end
+
+                it "deletes the local feature branch" do
+                  expect { subject }.to have_run_command("git branch -D new-feature")
+                end
+              end
+            end
+
+            context "and not cleaning up feature branch" do
+              before do
+                HighLine.any_instance.stub(:ask) do |terminal, question|
+                  values = {
+                    "Please enter your GitHub username: "                                                      => user,
+                    "Please enter your GitHub password (we do NOT store this): "                               => password,
+                    "Please enter your Enterprise site URL (e.g. https://github.company.com):"                 => enterprise_site,
+                    "Please enter your Enterprise API endpoint (e.g. https://github.company.com/api/v3):"      => enterprise_api,
+                    "Would you like to push this branch to your remote repo and cleanup your feature branch? " => 'no',
+                    "Would you like to open it in your browser?"                                               => 'no'
+                  }
+                 return_value = values[question] || values[terminal]
+                 question = ""
+                 return_value
+                end
+              end
+
+              it "doesn't update the remote repo with the new squash merge" do
+                expect { subject }.to_not have_run_command('git push origin master')
+              end
+
+              it "doesn't delete the feature branch on the remote repo" do
+                expect { subject }.to_not have_run_command('git push origin :new-feature')
+              end
+
+              it "doesn't delete the local feature branch" do
+                expect { subject }.to_not have_run_command('git branch -D new-feature')
+              end
+
+              it "provides instructions to undo the steps taken" do
+                expect { subject }.to have_output("To reset and go back to your branch run \`git reset --hard origin/master && git checkout new-feature\`")
+              end
+            end
+
+            context "and there were issues commiting the squash merge to the base branch" do
+              before { stub_with_fallback(GitReflow, :run_command_with_label).with('git commit', {with_system: true}).and_return false }
+              it "notifies user of issues commiting the squash merge of the feature branch" do
+                expect { subject }.to have_said("There were problems commiting your feature... please check the errors above and try again.", :error)
+              end
+            end
+
+          end
+
+          context 'but there are still unaddressed comments' do
+            let(:open_comment_authors) { ['nhance', 'codenamev'] }
+            before { existing_pull_request.stub(:reviewers_pending_response).and_return(open_comment_authors) }
+            it "notifies the user to get their code reviewed" do
+              expect { subject }.to have_said "You still need a LGTM from: #{open_comment_authors.join(', ')}", :deliver_halted
+            end
+          end
+        end
+
+        context 'but has no comments' do
+          before do
+            existing_pull_request.stub(:has_comments?).and_return(false)
+            existing_pull_request.stub(:approvals).and_return(['John', 'Simon'])
+            existing_pull_request.stub(:reviewers_pending_response).and_return([])
+            existing_pull_request.stub(:build).and_return(build_status)
+          end
+
+          it "notifies the user to get their code reviewed" do
+            expect { subject }.to have_said "Merge complete!", :success
+          end
+        end
+
+        it "successfully finds a pull request for the current feature branch" do
+          expect { subject }.to have_output "Merging pull request #1: 'new-feature', from 'new-feature' into 'master'"
+        end
+
+        it "checks out the destination branch and updates any remote changes" do
+          GitReflow.should_receive(:update_destination)
+          subject
+        end
+
+        it "merges and squashes the feature branch into the master branch" do
+          GitReflow.should_receive(:merge_feature_branch)
+          subject
+        end
+      end
+    end
+
+    context "and no pull request exists for the feature branch to the destination branch" do
+      before { github.stub(:find_open_pull_request).and_return(nil) }
+
+      it "notifies the user of a missing pull request" do
+        expect { subject }.to have_said "No pull request exists for #{user}:#{branch}\nPlease submit your branch for review first with \`git reflow review\`", :deliver_halted
+      end
+    end
+  end
+end