octopolo 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1180ea8ecff06b1794c95afb8691c7577f9223c9
-  data.tar.gz: 1a5a2e430cfb10351f755df6c2614723f72872b8
+  metadata.gz: a4bcb4049924fd9baffda4bd06d42effabbe247a
+  data.tar.gz: a1c8a5438d4ea4bec64f5f452af13da939ee1aff
 SHA512:
-  metadata.gz: a21ed3bc2ce58fe993ec7212c78a71bb3598e5e3b88387ff9531ca4d28c467c32c8eb6277dfb1723f0e22a7f13bee03c8b24f5ef57e203ac3f6385ea4ccd5d0d
-  data.tar.gz: 11a8c5346bcd00e22bc3f1a257993aaa736f4d87a1d86c838001da4188b2ff9611dc6c120b4460e8b0eba4ec838a921f972ba36760b5fbb04daf3f353feabb2d
+  metadata.gz: 950c567a168527dc9f3424667510896ac39b0798bc622035be698e350ca78092bc47f14dbf97461074951ead90733cf273aa55aa3496d08cb1023231c745bc7f
+  data.tar.gz: 36e758529e0cd35400ba538044cbed8a428e76be589dd75332c698d33dedaa45b4264ecd63ee160db26e384a1901d3c0837cf8ef5f83d506415b0e64c31f8920

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+#### v1.4.0
+* Check PR status before marking deployable/accept-pull
+
+  > Arvind Menon: Brian Bergstrom, Chris Arcand: https://github.com/sportngin/octopolo/pull/107
+
 #### v1.3.0
 * IS-4641-spring-cleaning-jira-bomb
 

data/lib/octopolo/commands/accept_pull.rb

@@ -1,8 +1,9 @@
 arg :pull_request_id
 desc 'Accept pull requests. Merges the given pull request into master and updates the changelog.'
 command 'accept-pull' do |c|
+  c.switch [:f, :force], default_value: false, desc: 'Ignore the status checks on the pull request', negatable: false
   c.action do |global_options, options, args|
     require_relative '../scripts/accept_pull'
-    Octopolo::Scripts::AcceptPull.execute args.first
+    Octopolo::Scripts::AcceptPull.execute(args.first, options)
   end
 end

data/lib/octopolo/commands/deployable.rb

@@ -1,8 +1,9 @@
 arg :pull_request_id
 desc 'Merges PR into the deployable branch'
 command 'deployable' do |c|
+  c.switch [:f, :force], default_value: false, desc: 'Ignore the status checks on the pull request', negatable: false
   c.action do |global_options, options, args|
     require_relative '../scripts/deployable'
-    Octopolo::Scripts::Deployable.execute args.first
+    Octopolo::Scripts::Deployable.execute(args.first, options)
   end
 end

data/lib/octopolo/github.rb

@@ -117,6 +117,10 @@ module Octopolo
       client.search_issues *args
     end
 
+    def self.status *args
+      client.status *args
+    end
+
 
     # now that you've set up your credentials, try again
     TryAgain = Class.new(StandardError)

data/lib/octopolo/github/pull_request.rb

@@ -69,6 +69,14 @@ module Octopolo
         @commits ||= Commit.for_pull_request self
       end
 
+      def status_checks_passed?
+        status == 'success'
+      end
+
+      def status
+        GitHub.status(repo_name, data.head.sha)[:state]
+      end
+
       def self.current
         current_branch = Git.current_branch
         query = "repo:#{config.github_repo} type:pr is:open head:#{current_branch}"

data/lib/octopolo/scripts/accept_pull.rb

@@ -13,13 +13,14 @@ module Octopolo
 
       attr_accessor :pull_request_id
 
-      def self.execute(pull_request_id)
+      def self.execute(pull_request_id, options)
         pull_request_id ||= Integer(cli.prompt "Pull Request ID: ")
-        new(pull_request_id).execute
+        new(pull_request_id, options).execute
       end
 
-      def initialize(pull_request_id)
+      def initialize(pull_request_id, options={})
         @pull_request_id = pull_request_id
+        @force = options[:force]
       end
 
       # Public: Perform the script
@@ -36,10 +37,16 @@ module Octopolo
       def merge pull_request
         Git.fetch
         if pull_request.mergeable?
-          cli.perform "git merge --no-ff origin/#{pull_request.branch} -m \"Merge pull request ##{pull_request_id} from origin/#{pull_request.branch}\""
+          if pull_request.status_checks_passed? || @force
+            cli.perform "git merge --no-ff origin/#{pull_request.branch} -m \"Merge pull request ##{pull_request_id} from origin/#{pull_request.branch}\""
+          else
+            cli.say 'Status checks have not passed on this pull request.'
+            exit!
+          end
         else
           cli.say "There is a merge conflict with this branch and #{config.deploy_branch}."
           cli.say "Please update this branch with #{config.deploy_branch} or perform the merge manually and fix any conflicts"
+          exit!
         end
       end
 

data/lib/octopolo/scripts/deployable.rb

@@ -10,16 +10,17 @@ module Octopolo
 
       attr_accessor :pull_request_id
 
-      def self.execute(pull_request_id=nil)
-        new(pull_request_id).execute
+      def self.execute(pull_request_id=nil, options={})
+        new(pull_request_id, options).execute
       end
 
       def self.deployable_label
         Octopolo::GitHub::Label.new(name: "deployable", color: "428BCA")
       end
 
-      def initialize(pull_request_id=nil)
+      def initialize(pull_request_id=nil, options={})
         @pull_request_id = pull_request_id
+        @force = options[:force]
       end
 
       # Public: Perform the script
@@ -30,6 +31,10 @@ module Octopolo
         end
         self.pull_request_id ||= cli.prompt("Pull Request ID: ")
         GitHub.connect do
+          unless deployable? || @force
+            CLI.say 'Pull request status checks have not passed. Cannot be marked deployable.'
+            exit!
+          end
           if config.deployable_label
             with_labelling do
               merge
@@ -46,13 +51,22 @@ module Octopolo
       private :merge
 
       def with_labelling(&block)
-        pull_request = Octopolo::GitHub::PullRequest.new(config.github_repo, @pull_request_id)
         pull_request.add_labels(Deployable.deployable_label)
         unless yield
           pull_request.remove_labels(Deployable.deployable_label)
         end
       end
       private :with_labelling
+
+      def deployable?
+        pull_request.mergeable? && pull_request.status_checks_passed?
+      end
+      private :deployable?
+
+      def pull_request
+        @pull_request ||= Octopolo::GitHub::PullRequest.new(config.github_repo, @pull_request_id)
+      end
+      private :pull_request
     end
   end
 end

data/lib/octopolo/version.rb

@@ -1,3 +1,3 @@
 module Octopolo
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/spec/octopolo/scripts/accept_pull_spec.rb

@@ -47,8 +47,8 @@ module Octopolo
         let(:pull_request) { stub(branch: "foobranch") }
         before { subject.stub(:pull_request_id => pull_request_id) }
 
-        context "when mergeable" do
-          before { pull_request.stub(mergeable?: true) }
+        context "when mergeable and status checks passed" do
+          before { pull_request.stub(mergeable?: true, status_checks_passed?: true) }
 
           it "fetches and merges the request's branch" do
             Git.should_receive(:fetch)
@@ -59,7 +59,10 @@ module Octopolo
         end
 
         context "when not mergeable" do
-          before { pull_request.stub(mergeable?: false) }
+          before do
+            pull_request.stub(mergeable?: false)
+            allow(subject).to receive(:exit!)
+          end
 
           it "performs the merge and alerts about potential failures" do
             Git.should_receive(:fetch)
@@ -67,6 +70,36 @@ module Octopolo
             cli.should_not_receive(:perform).with "git merge --no-ff origin/#{pull_request.branch} -m \"Merge pull request ##{pull_request_id} from origin/#{pull_request.branch}\""
 
             cli.should_receive(:say).with /merge conflict/
+            expect(subject).to receive(:exit!)
+            subject.merge pull_request
+          end
+        end
+
+        context "when mergeable and status checks have not passed" do
+          before do
+            pull_request.stub(mergeable?: true, status_checks_passed?: false)
+            allow(subject).to receive(:exit!)
+          end
+
+          it "performs the merge and alerts about potential failures" do
+            Git.should_receive(:fetch)
+            cli.stub(:say)
+            cli.should_not_receive(:perform).with "git merge --no-ff origin/#{pull_request.branch} -m \"Merge pull request ##{pull_request_id} from origin/#{pull_request.branch}\""
+
+            cli.should_receive(:say).with 'Status checks have not passed on this pull request.'
+            expect(subject).to receive(:exit!)
+            subject.merge pull_request
+          end
+        end
+
+        context "when failed status checks should be ignored" do
+          subject { described_class.new(pull_request_id, force: true) }
+          before { pull_request.stub(mergeable?: true, status_checks_passed?: false) }
+
+          it "fetches and merges the request's branch" do
+            Git.should_receive(:fetch)
+            cli.should_receive(:perform).with "git merge --no-ff origin/#{pull_request.branch} -m \"Merge pull request ##{pull_request_id} from origin/#{pull_request.branch}\""
+
             subject.merge pull_request
           end
         end

data/spec/octopolo/scripts/deployable_spec.rb

@@ -10,7 +10,11 @@ module Octopolo
       let(:config) { stub(user_notifications: ['NickLaMuro'],
                           github_repo: 'grumpy_cat',
                           deployable_label: true) }
-      let(:pull_request) { stub(add_labels: true, remove_labels: true, number: 7) }
+      let(:pull_request) { stub(add_labels: true,
+                                remove_labels: true,
+                                number: 7,
+                                mergeable?: true,
+                                status_checks_passed?: true) }
       before do
         allow(subject).to receive(:cli) { cli }
         allow(subject).to receive(:config) { config }
@@ -97,6 +101,40 @@ module Octopolo
             pull_request.should_not_receive(:add_labels)
           end
         end
+
+        context "when pr is not mergeable" do
+          before do
+            pull_request.stub(mergeable?: false)
+            allow(subject).to receive(:exit!)
+          end
+
+          it "prints out an error and exits" do
+            expect(CLI).to receive(:say).with("Pull request status checks have not passed. Cannot be marked deployable.")
+            expect(subject).to receive(:exit!)
+          end
+        end
+
+        context "when pr has not passed status checks" do
+          before do
+            pull_request.stub(status_checks_passed?: false)
+            allow(subject).to receive(:exit!)
+          end
+
+          it "prints out an error and exits" do
+            expect(CLI).to receive(:say).with("Pull request status checks have not passed. Cannot be marked deployable.")
+            expect(subject).to receive(:exit!)
+          end
+        end
+
+        context "when failed status checks should be ignored" do
+          subject { described_class.new(42, force: true) }
+          before { pull_request.stub(status_checks_passed?: false) }
+
+          it "adds the deployable label" do
+            pull_request.should_receive(:add_labels)
+          end
+        end
+
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octopolo
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Patrick Byrne
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -220,7 +220,6 @@ files:
 - lib/octopolo/commands/octopolo_setup.rb
 - lib/octopolo/commands/pivotal_auth.rb
 - lib/octopolo/commands/pull_request.rb
-- lib/octopolo/commands/signoff.rb
 - lib/octopolo/commands/stage_up.rb
 - lib/octopolo/commands/stale_branches.rb
 - lib/octopolo/commands/sync_branch.rb
@@ -256,7 +255,6 @@ files:
 - lib/octopolo/scripts/octopolo_setup.rb
 - lib/octopolo/scripts/pivotal_auth.rb
 - lib/octopolo/scripts/pull_request.rb
-- lib/octopolo/scripts/signoff.rb
 - lib/octopolo/scripts/stage_up.rb
 - lib/octopolo/scripts/stale_branches.rb
 - lib/octopolo/scripts/sync_branch.rb
@@ -298,7 +296,6 @@ files:
 - spec/octopolo/scripts/octopolo_setup_spec.rb
 - spec/octopolo/scripts/pivotal_auth_spec.rb
 - spec/octopolo/scripts/pull_request_spec.rb
-- spec/octopolo/scripts/signoff_spec.rb
 - spec/octopolo/scripts/stage_up_spec.rb
 - spec/octopolo/scripts/stale_branches_spec.rb
 - spec/octopolo/scripts/sync_branch_spec.rb
@@ -368,7 +365,6 @@ test_files:
 - spec/octopolo/scripts/octopolo_setup_spec.rb
 - spec/octopolo/scripts/pivotal_auth_spec.rb
 - spec/octopolo/scripts/pull_request_spec.rb
-- spec/octopolo/scripts/signoff_spec.rb
 - spec/octopolo/scripts/stage_up_spec.rb
 - spec/octopolo/scripts/stale_branches_spec.rb
 - spec/octopolo/scripts/sync_branch_spec.rb

data/lib/octopolo/commands/signoff.rb

@@ -1,10 +0,0 @@
-arg :pull_request_id
-
-desc 'Provide standardized signoff message to a pull request.'
-long_desc "pull_request_id - The ID of the pull request to sign off on"
-command 'signoff' do |c|
-  c.action do |global_options, options, args|
-    require_relative '../scripts/signoff'
-    Octopolo::Scripts::Signoff.execute args.first
-  end
-end

data/lib/octopolo/scripts/signoff.rb

@@ -1,85 +0,0 @@
-require_relative "../scripts"
-require_relative "../github"
-
-module Octopolo
-  module Scripts
-    class Signoff
-      include ConfigWrapper
-      include CLIWrapper
-
-      attr_accessor :pull_request_id
-      attr_accessor :pull_request
-      attr_accessor :signoff_type
-
-      TYPES = [
-        "code review only",
-        "QA only",
-        "both code review and QA",
-      ]
-
-      def self.execute(pull_request_id=nil)
-        new(pull_request_id).execute
-      end
-
-      def initialize(pull_request_id=nil)
-        @pull_request_id = pull_request_id
-        @pull_request_id ||= cli.prompt("Pull Request ID: ")
-      end
-
-      def execute
-        preamble
-        ask_signoff_type
-        write_comment
-        open_pull_request
-      rescue WrongChoice
-        retry
-      end
-
-      # Private: Display information about the pull request
-      def preamble
-        cli.say %Q(Please review "#{pull_request.title}":)
-        cli.say pull_request.url
-        cli.spacer_line
-      end
-      private :preamble
-
-      # Private: Ask which type of signoff to perform
-      def ask_signoff_type
-        self.signoff_type = cli.ask "Which type of signoff are you performing?", TYPES
-      end
-      private :ask_signoff_type
-
-      # Private: Find the pull request to be signed off on
-      #
-      # Returns a GitHub::PullRequest
-      def pull_request
-        @pull_request ||= GitHub::PullRequest.new config.github_repo, Integer(pull_request_id)
-      end
-      private :pull_request
-      private :pull_request=
-
-      # Private: The body of the comment for the given signoff
-      #
-      # Returns a String
-      def comment_body
-        "Signing off on **#{signoff_type}**."
-      end
-      private :comment_body
-
-      # Private: Submit a comment to the pull request
-      def write_comment
-        pull_request.write_comment comment_body
-      end
-      private :write_comment
-
-      # Private: Open the pull request in the browser
-      def open_pull_request
-        cli.open pull_request.url
-      end
-
-      WrongChoice = Class.new StandardError
-    end
-  end
-end
-
-# vim: set ft=ruby: #

data/spec/octopolo/scripts/signoff_spec.rb

@@ -1,139 +0,0 @@
-require "spec_helper"
-require "octopolo/scripts/signoff"
-
-module Octopolo
-  module Scripts
-    describe Signoff do
-      # stub any attributes in the config that you need
-      let(:config) { stub(:config, github_repo: "sportngin/foo") }
-      let(:cli) { stub(:cli) }
-      let(:pull_request_id) { 123 }
-      let(:pull_request) { stub(:pull_request, url: "http://example.com") }
-
-      subject { Signoff.new }
-      before do
-        cli.stub(:prompt)
-        Signoff.any_instance.stub(:cli => cli, :config => config)
-      end
-
-      context "#new" do
-        it "sets the pull_request_id if passed in from args" do
-          expect(Signoff.new(pull_request_id.to_s).pull_request_id).to eq pull_request_id.to_s
-        end
-
-        it "prompts if no pull_request_id is given" do
-          cli.should_receive(:prompt)
-             .with("Pull Request ID: ")
-             .and_return("42")
-          expect(Signoff.new.pull_request_id).to eq "42"
-        end
-      end
-
-      context "#execute" do
-        it "asks which type of signoff is being performed and posts a prefab comment" do
-          subject.should_receive(:preamble)
-          subject.should_receive(:ask_signoff_type)
-          subject.should_receive(:write_comment)
-          subject.should_receive(:open_pull_request)
-          subject.execute
-        end
-      end
-
-      context "#preamble" do
-        before do
-          pull_request.stub({
-            title: "Test PR",
-            number: pull_request_id,
-            url: "http://example.com/",
-          })
-          subject.send(:pull_request=, pull_request)
-        end
-
-        it "displays information about the given pull request" do
-          cli.should_receive(:say).with(%Q(Please review "#{pull_request.title}":))
-          cli.should_receive(:say).with(pull_request.url)
-          cli.should_receive(:spacer_line)
-
-          subject.send(:preamble)
-        end
-      end
-
-      context "#ask_signoff_type" do
-        let(:selected_type) { Signoff::TYPES.first }
-
-        it "asks user to choose which signoff type to perform and remebers it" do
-          cli.should_receive(:ask).with("Which type of signoff are you performing?", Signoff::TYPES) { selected_type }
-          subject.send(:ask_signoff_type)
-          expect(subject.signoff_type).to eq selected_type
-        end
-      end
-
-      context "#write_comment" do
-        let(:body) { "asdf" }
-        before do
-          subject.send(:pull_request=, pull_request)
-          subject.stub(:comment_body) { body }
-        end
-
-        it "submits a comment that the pull request is signed off" do
-          pull_request.should_receive(:write_comment).with(body)
-
-          subject.send(:write_comment)
-        end
-      end
-
-      context "#comment_body" do
-        let(:selected_type) { Signoff::TYPES.first }
-
-        before do
-          subject.signoff_type = selected_type
-        end
-
-        it "injects the signoff type" do
-          expect(subject.send(:comment_body)).to eq "Signing off on **#{selected_type}**."
-        end
-      end
-
-      context "#open_pull_request" do
-        before do
-          subject.send(:pull_request=, pull_request)
-        end
-
-        it "opens the pull request in the browser" do
-          cli.should_receive(:open).with(pull_request.url)
-          subject.send(:open_pull_request)
-        end
-      end
-
-      context "#pull_request" do
-        before do
-          subject.pull_request_id = pull_request_id
-        end
-
-        it "fetches the pull request matching the ID" do
-          GitHub::PullRequest.should_receive(:new).with(config.github_repo, pull_request_id) { pull_request }
-          expect(subject.send(:pull_request)).to eq pull_request
-        end
-
-        it "caches that object" do
-          GitHub::PullRequest.should_receive(:new).once.and_return(pull_request)
-          subject.send(:pull_request)
-          subject.send(:pull_request)
-        end
-
-        it "remembers the pull request given to it" do
-          GitHub::PullRequest.should_not_receive(:new)
-          subject.send(:pull_request=, pull_request)
-          expect(subject.send(:pull_request)).to eq pull_request
-        end
-
-        it "fails if the pull_request_id is not an int" do
-          subject.pull_request_id = 'foo'
-          expect { subject.send(:pull_request) }.to raise_error ArgumentError
-        end
-      end
-    end
-  end
-end
-
-# vim: set ft=ruby : #