git_helper 1.3.1 → 2.0.0

data/spec/git_helper/merge_request_spec.rb

@@ -0,0 +1,233 @@
+require_relative '../../lib/git_helper/merge_request.rb'
+
+describe GitHelper::GitLabMergeRequest do
+  let(:local_code) { double(:local_code, read_template: 'template') }
+  let(:highline_cli) { double(:highline_cli) }
+  let(:gitlab_client_client) { double(:gitlab_client_client, project: :project, merge_request: :merge_request, create_merge_request: :created) }
+  let(:gitlab_client) { double(:gitlab_client, client: gitlab_client_client) }
+  let(:options) do
+    {
+      local_project: 'emmasax4/git_helper',
+      local_branch: 'main',
+      local_code: local_code,
+      cli: highline_cli
+    }
+  end
+
+  subject { GitHelper::GitLabMergeRequest.new(options) }
+
+  before do
+    allow(GitHelper::GitLabClient).to receive(:new).and_return(gitlab_client)
+  end
+
+  describe '#create' do
+    it 'should call the gitlab client to create' do
+      allow(subject).to receive(:squash_merge_request).and_return(true)
+      allow(subject).to receive(:remove_source_branch).and_return(false)
+      allow(subject).to receive(:new_mr_body).and_return('')
+      expect(gitlab_client_client).to receive(:create_merge_request)
+      subject.create({base_branch: 'base', new_title: 'title'})
+    end
+
+    it 'should call various other methods' do
+      expect(subject).to receive(:squash_merge_request).and_return(true)
+      expect(subject).to receive(:remove_source_branch).and_return(false)
+      expect(subject).to receive(:new_mr_body).and_return('')
+      allow(gitlab_client_client).to receive(:create_merge_request)
+      subject.create({base_branch: 'base', new_title: 'title'})
+    end
+
+    it 'should catch the raised error if the creation does not work' do
+      allow(subject).to receive(:squash_merge_request).and_return(true)
+      allow(subject).to receive(:remove_source_branch).and_return(false)
+      allow(subject).to receive(:new_mr_body).and_return('')
+      allow(gitlab_client_client).to receive(:create_merge_request).and_raise(StandardError)
+      expect(subject.create({base_branch: 'base', new_title: 'title'})).to eq(nil)
+    end
+  end
+
+  describe '#merge' do
+    it 'should call the gitlab client to merge' do
+      allow(subject).to receive(:existing_mr).and_return(double(should_remove_source_branch: true, squash: false, title: 'title'))
+      allow(subject).to receive(:mr_id).and_return(123)
+      expect(gitlab_client_client).to receive(:accept_merge_request)
+      subject.merge
+    end
+
+    it 'should call various other methods' do
+      expect(subject).to receive(:existing_mr).and_return(double(should_remove_source_branch: true, squash: false, title: 'title')).at_least(:once)
+      expect(subject).to receive(:mr_id).and_return(123).at_least(:once)
+      allow(gitlab_client_client).to receive(:accept_merge_request)
+      subject.merge
+    end
+
+    it 'should catch the raised error if the merge does not work' do
+      allow(subject).to receive(:existing_mr).and_return(double(should_remove_source_branch: true, squash: false, title: 'title'))
+      allow(subject).to receive(:mr_id).and_return(123)
+      allow(gitlab_client_client).to receive(:accept_merge_request).and_raise(StandardError)
+      expect(subject.merge).to eq(nil)
+    end
+
+    it 'should try to merge multiple times if the first merge errors' do
+      allow(subject).to receive(:existing_mr).and_return(double(should_remove_source_branch: true, squash: false, title: 'title'))
+      allow(subject).to receive(:mr_id).and_return(123)
+      expect(gitlab_client_client).to receive(:accept_merge_request).and_return(double(merge_commit_sha: nil)).exactly(2).times
+      expect(subject.merge).to eq(nil)
+    end
+  end
+
+  describe '#new_mr_body' do
+    it 'should call the local code if the template to apply exists' do
+      allow(subject).to receive(:template_name_to_apply).and_return('')
+      expect(local_code).to receive(:read_template)
+      subject.send(:new_mr_body)
+    end
+
+    it 'should not call the local code if the template is nil' do
+      allow(subject).to receive(:template_name_to_apply).and_return(nil)
+      expect(local_code).not_to receive(:read_template)
+      subject.send(:new_mr_body)
+    end
+
+    it 'should return an empty string if the template is nil' do
+      allow(subject).to receive(:template_name_to_apply).and_return(nil)
+      expect(subject.send(:new_mr_body)).to eq('')
+    end
+  end
+
+  describe '#template_name_to_apply' do
+    context 'if MR template options are empty' do
+      it 'should return nil' do
+        allow(subject).to receive(:mr_template_options).and_return([])
+        expect(subject.send(:template_name_to_apply)).to eq(nil)
+      end
+    end
+
+    context 'if there is one template option' do
+      it 'should call the CLI to ask about a single template' do
+        allow(subject).to receive(:mr_template_options).and_return(['template1'])
+        expect(highline_cli).to receive(:apply_template?).and_return(true)
+        subject.send(:template_name_to_apply)
+      end
+
+      it 'should return the single template if the user says yes' do
+        allow(subject).to receive(:mr_template_options).and_return(['template1'])
+        allow(highline_cli).to receive(:apply_template?).and_return(true)
+        expect(subject.send(:template_name_to_apply)).to eq('template1')
+      end
+
+      it 'should return nil if the user says no' do
+        allow(subject).to receive(:mr_template_options).and_return(['template1'])
+        allow(highline_cli).to receive(:apply_template?).and_return(false)
+        expect(subject.send(:template_name_to_apply)).to eq(nil)
+      end
+    end
+
+    context 'if there are multiple template options' do
+      it 'should call the CLI to ask which of multiple templates to apply' do
+        allow(subject).to receive(:mr_template_options).and_return(['template1', 'template2'])
+        expect(highline_cli).to receive(:template_to_apply).and_return('template1')
+        subject.send(:template_name_to_apply)
+      end
+
+      it 'should return the answer template if the user says yes' do
+        allow(subject).to receive(:mr_template_options).and_return(['template1', 'template2'])
+        allow(highline_cli).to receive(:template_to_apply).and_return('template1')
+        expect(subject.send(:template_name_to_apply)).to eq('template1')
+      end
+
+      it 'should return nil if the user says no' do
+        allow(subject).to receive(:mr_template_options).and_return(['template1', 'template2'])
+        allow(highline_cli).to receive(:template_to_apply).and_return('None')
+        expect(subject.send(:template_name_to_apply)).to eq(nil)
+      end
+    end
+  end
+
+  describe '#mr_template_options' do
+    it 'should call the local code' do
+      expect(local_code).to receive(:template_options)
+      subject.send(:mr_template_options)
+    end
+  end
+
+  describe '#mr_id' do
+    it 'should ask the CLI for the code request ID' do
+      expect(highline_cli).to receive(:code_request_id).and_return(123)
+      subject.send(:mr_id)
+    end
+
+    it 'should equal an integer' do
+      expect(highline_cli).to receive(:code_request_id).and_return(123)
+      expect(subject.send(:mr_id)).to eq(123)
+    end
+  end
+
+  describe '#squash_merge_request' do
+    it 'should ask the CLI for the code request ID' do
+      expect(highline_cli).to receive(:squash_merge_request?).and_return(true)
+      subject.send(:squash_merge_request)
+    end
+
+    it 'should be a boolean' do
+      expect(highline_cli).to receive(:squash_merge_request?).and_return(false)
+      expect([true, false]).to include(subject.send(:squash_merge_request))
+    end
+  end
+
+  describe '#remove_source_branch' do
+    before do
+      allow(subject).to receive(:existing_project).and_return(double(remove_source_branch_after_merge: nil))
+    end
+
+    context 'when the existing project has no setting' do
+      it 'should ask the CLI for the code request ID' do
+        expect(highline_cli).to receive(:remove_source_branch?).and_return(true)
+        subject.send(:remove_source_branch)
+      end
+
+      it 'should be a boolean' do
+        allow(highline_cli).to receive(:remove_source_branch?).and_return(false)
+        expect([true, false]).to include(subject.send(:remove_source_branch))
+      end
+    end
+
+    it 'should ask the existing project' do
+      expect(subject).to receive(:existing_project).and_return(double(remove_source_branch_after_merge: true))
+      subject.send(:remove_source_branch)
+    end
+
+    it "should return the existing project's setting if it exists" do
+      allow(subject).to receive(:existing_project).and_return(double(remove_source_branch_after_merge: true))
+      expect(subject.send(:remove_source_branch)).to eq(true)
+    end
+
+    it "should return the existing project's setting if it exists" do
+      allow(subject).to receive(:existing_project).and_return(double(remove_source_branch_after_merge: false))
+      allow(highline_cli).to receive(:remove_source_branch?).and_return(true)
+      expect(subject.send(:remove_source_branch)).to eq(true)
+    end
+  end
+
+  describe '#existing_project' do
+    it 'should call the gitlab client' do
+      expect(gitlab_client_client).to receive(:project).and_return(:project)
+      subject.send(:existing_project)
+    end
+  end
+
+  describe '#existing_mr' do
+    it 'should call the gitlab client' do
+      allow(highline_cli).to receive(:code_request_id).and_return(123)
+      expect(gitlab_client_client).to receive(:merge_request).and_return(:merge_request)
+      subject.send(:existing_mr)
+    end
+  end
+
+  describe '#gitlab_client' do
+    it 'should call the gitlab client' do
+      expect(GitHelper::GitLabClient).to receive(:new).and_return(gitlab_client)
+      subject.send(:gitlab_client)
+    end
+  end
+end

data/spec/git_helper/new_branch_spec.rb

@@ -0,0 +1,43 @@
+require_relative '../../lib/git_helper/new_branch.rb'
+
+describe GitHelper::NewBranch do
+  let(:new_branch_name) { 'new-branch-name' }
+  let(:local_code) { double(:local_code, new_branch: :commit) }
+  let(:cli) { double(:highline_cli, new_branch_name: new_branch_name) }
+
+  subject { GitHelper::NewBranch.new }
+
+  before do
+    allow(GitHelper::LocalCode).to receive(:new).and_return(local_code)
+    allow(GitHelper::HighlineCli).to receive(:new).and_return(cli)
+  end
+
+  it 'should call GitHelper::LocalCode' do
+    expect(GitHelper::LocalCode).to receive(:new).and_return(local_code)
+    subject.execute
+  end
+
+  it 'should call the new_branch method from the local code class' do
+    expect(local_code).to receive(:new_branch)
+    subject.execute
+  end
+
+  context 'when no branch name is passed in' do
+    it 'should call the highline cli' do
+      expect(GitHelper::HighlineCli).to receive(:new).and_return(cli)
+      subject.execute
+    end
+
+    it 'should ask the highline cli what the new branch name should be' do
+      expect(cli).to receive(:new_branch_name)
+      subject.execute
+    end
+  end
+
+  context 'when there is a branch name passed in' do
+    it 'should not create a highline cli' do
+      expect(GitHelper::HighlineCli).not_to receive(:new)
+      subject.execute(new_branch_name)
+    end
+  end
+end

data/spec/git_helper/octokit_client_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../../lib/git_helper/octokit_client.rb'
+
+describe GitHelper::OctokitClient do
+  let(:git_config_reader) { double(:git_config_reader, github_token: :token) }
+
+  subject { GitHelper::OctokitClient.new }
+
+  before do
+    allow(GitHelper::GitConfigReader).to receive(:new).and_return(git_config_reader)
+  end
+
+  describe '#client' do
+    it 'should call the GitLab client to make a new client' do
+      expect(Octokit::Client).to receive(:new)
+      subject.client
+    end
+  end
+
+  describe '#git_config_reader' do
+    it 'should make a new git config reader' do
+      expect(GitHelper::GitConfigReader).to receive(:new)
+      subject.send(:git_config_reader)
+    end
+  end
+end

data/spec/git_helper/pull_request_spec.rb

@@ -0,0 +1,245 @@
+require_relative '../../lib/git_helper/pull_request.rb'
+
+describe GitHelper::GitHubPullRequest do
+  let(:local_code) { double(:local_code, read_template: 'template') }
+  let(:highline_cli) { double(:highline_cli) }
+  let(:octokit_client_client) { double(:octokit_client_client, project: :project, merge_request: :merge_request, create_merge_request: :created) }
+  let(:octokit_client) { double(:octokit_client, client: octokit_client_client) }
+  let(:options) do
+    {
+      local_project: 'emmasax4/git_helper',
+      local_branch: 'main',
+      local_code: local_code,
+      cli: highline_cli
+    }
+  end
+
+  subject { GitHelper::GitHubPullRequest.new(options) }
+
+  before do
+    allow(GitHelper::OctokitClient).to receive(:new).and_return(octokit_client)
+  end
+
+  describe '#create' do
+    it 'should call the octokit client to create' do
+      allow(subject).to receive(:new_pr_body).and_return('')
+      expect(octokit_client_client).to receive(:create_pull_request)
+      subject.create({base_branch: 'base', new_title: 'title'})
+    end
+
+    it 'should call various other methods' do
+      expect(subject).to receive(:new_pr_body).and_return('').at_least(:once)
+      allow(octokit_client_client).to receive(:create_pull_request)
+      subject.create({base_branch: 'base', new_title: 'title'})
+    end
+
+    it 'should catch the raised error if the creation does not work' do
+      allow(subject).to receive(:new_pr_body).and_return('')
+      allow(octokit_client_client).to receive(:create_pull_request).and_raise(StandardError)
+      expect(subject.create({base_branch: 'base', new_title: 'title'})).to eq(nil)
+    end
+  end
+
+  describe '#merge' do
+    it 'should call the octokit client to merge' do
+      allow(subject).to receive(:existing_pr).and_return(double(title: 'title'))
+      allow(subject).to receive(:merge_method).and_return('rebase')
+      allow(subject).to receive(:pr_id).and_return(123)
+      expect(octokit_client_client).to receive(:merge_pull_request)
+      subject.merge
+    end
+
+    it 'should call various other methods' do
+      expect(subject).to receive(:existing_pr).and_return(double(title: 'title')).at_least(:once)
+      expect(subject).to receive(:merge_method).and_return('rebase').at_least(:once)
+      expect(subject).to receive(:pr_id).and_return(123).at_least(:once)
+      allow(octokit_client_client).to receive(:merge_pull_request)
+      subject.merge
+    end
+
+    it 'should catch the raised error if the merge does not work' do
+      allow(subject).to receive(:existing_pr).and_return(double(title: 'title'))
+      allow(subject).to receive(:merge_method).and_return('rebase')
+      allow(subject).to receive(:pr_id).and_return(123)
+      allow(octokit_client_client).to receive(:merge_pull_request).and_raise(StandardError)
+      expect(subject.merge).to eq(nil)
+    end
+  end
+
+  describe '#new_pr_body' do
+    it 'should call the local code if the template to apply exists' do
+      allow(subject).to receive(:template_name_to_apply).and_return('')
+      expect(local_code).to receive(:read_template)
+      subject.send(:new_pr_body)
+    end
+
+    it 'should not call the local code if the template is nil' do
+      allow(subject).to receive(:template_name_to_apply).and_return(nil)
+      expect(local_code).not_to receive(:read_template)
+      subject.send(:new_pr_body)
+    end
+
+    it 'should return an empty string if the template is nil' do
+      allow(subject).to receive(:template_name_to_apply).and_return(nil)
+      expect(subject.send(:new_pr_body)).to eq('')
+    end
+  end
+
+  describe '#template_name_to_apply' do
+    context 'if PR template options are empty' do
+      it 'should return nil' do
+        allow(subject).to receive(:pr_template_options).and_return([])
+        expect(subject.send(:template_name_to_apply)).to eq(nil)
+      end
+    end
+
+    context 'if there is one template option' do
+      it 'should call the CLI to ask about a single template' do
+        allow(subject).to receive(:pr_template_options).and_return(['template1'])
+        expect(highline_cli).to receive(:apply_template?).and_return(true)
+        subject.send(:template_name_to_apply)
+      end
+
+      it 'should return the single template if the user says yes' do
+        allow(subject).to receive(:pr_template_options).and_return(['template1'])
+        allow(highline_cli).to receive(:apply_template?).and_return(true)
+        expect(subject.send(:template_name_to_apply)).to eq('template1')
+      end
+
+      it 'should return nil if the user says no' do
+        allow(subject).to receive(:pr_template_options).and_return(['template1'])
+        allow(highline_cli).to receive(:apply_template?).and_return(false)
+        expect(subject.send(:template_name_to_apply)).to eq(nil)
+      end
+    end
+
+    context 'if there are multiple template options' do
+      it 'should call the CLI to ask which of multiple templates to apply' do
+        allow(subject).to receive(:pr_template_options).and_return(['template1', 'template2'])
+        expect(highline_cli).to receive(:template_to_apply).and_return('template1')
+        subject.send(:template_name_to_apply)
+      end
+
+      it 'should return the answer template if the user says yes' do
+        allow(subject).to receive(:pr_template_options).and_return(['template1', 'template2'])
+        allow(highline_cli).to receive(:template_to_apply).and_return('template1')
+        expect(subject.send(:template_name_to_apply)).to eq('template1')
+      end
+
+      it 'should return nil if the user says no' do
+        allow(subject).to receive(:pr_template_options).and_return(['template1', 'template2'])
+        allow(highline_cli).to receive(:template_to_apply).and_return('None')
+        expect(subject.send(:template_name_to_apply)).to eq(nil)
+      end
+    end
+  end
+
+  describe '#pr_template_options' do
+    it 'should call the local code' do
+      expect(local_code).to receive(:template_options)
+      subject.send(:pr_template_options)
+    end
+  end
+
+  describe '#pr_id' do
+    it 'should ask the CLI for the code request ID' do
+      expect(highline_cli).to receive(:code_request_id).and_return(123)
+      subject.send(:pr_id)
+    end
+
+    it 'should equal an integer' do
+      expect(highline_cli).to receive(:code_request_id).and_return(123)
+      expect(subject.send(:pr_id)).to eq(123)
+    end
+  end
+
+  describe '#merge_method' do
+    let(:project) { double(:project, allow_merge_commit: true, allow_squash_merge: true, allow_rebase_merge: true) }
+
+    before do
+      allow(subject).to receive(:existing_project).and_return(project)
+      allow(highline_cli).to receive(:merge_method)
+    end
+
+    it 'should ask the CLI for the merge_method' do
+      expect(highline_cli).to receive(:merge_method).and_return('merge')
+      subject.send(:merge_method)
+    end
+
+    it 'should be a string' do
+      allow(highline_cli).to receive(:merge_method).and_return('merge')
+      expect(subject.send(:merge_method)).to be_a(String)
+    end
+
+    context "if there's only one item" do
+      let(:project) { double(:project, allow_merge_commit: true, allow_squash_merge: false, allow_rebase_merge: false) }
+
+      it 'should not ask the CLI anything' do
+        expect(highline_cli).not_to receive(:merge_method)
+        subject.send(:merge_method)
+      end
+    end
+  end
+
+  describe '#merge_options' do
+    let(:project) { double(:project, allow_merge_commit: true, allow_squash_merge: true, allow_rebase_merge: true) }
+
+    before do
+      allow(subject).to receive(:existing_project).and_return(project)
+    end
+
+    it 'should return an array' do
+      expect(subject.send(:merge_options)).to be_a(Array)
+    end
+
+    it 'should have three items' do
+      expect(subject.send(:merge_options).length).to eq(3)
+    end
+
+    context 'when two options are present' do
+      let(:project) { double(:project, allow_merge_commit: false, allow_squash_merge: true, allow_rebase_merge: true) }
+
+      it 'should have two items' do
+        expect(subject.send(:merge_options).length).to eq(2)
+      end
+    end
+
+    context 'when one option is present' do
+      let(:project) { double(:project, allow_merge_commit: false, allow_squash_merge: false, allow_rebase_merge: true) }
+
+      it 'should have one item' do
+        expect(subject.send(:merge_options).length).to eq(1)
+      end
+    end
+
+    context 'when no options are present' do
+      let(:project) { double(:project, allow_merge_commit: false, allow_squash_merge: false, allow_rebase_merge: false) }
+
+      it 'should have no items' do
+        expect(subject.send(:merge_options).length).to eq(0)
+      end
+    end
+  end
+
+  describe '#existing_project' do
+    it 'should call the octokit client' do
+      expect(octokit_client_client).to receive(:repository).and_return(:repository)
+      subject.send(:existing_project)
+    end
+  end
+
+  describe '#existing_pr' do
+    it 'should call the octokit client' do
+      allow(highline_cli).to receive(:code_request_id).and_return(123)
+      expect(octokit_client_client).to receive(:pull_request).and_return(:pull_request)
+      subject.send(:existing_pr)
+    end
+  end
+
+  describe '#octokit_client' do
+    it 'should call the octokit client' do
+      expect(GitHelper::OctokitClient).to receive(:new).and_return(octokit_client)
+      subject.send(:octokit_client)
+    end
+  end
+end