gergich 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef236cdff9358a9799255dcd4ce0683f89eca6d2
-  data.tar.gz: 53cf76a1f2b0b490f03883f24b75b0d399b5e0fc
+  metadata.gz: 3c315c6166bed8d6a67b00c7356fce017a579139
+  data.tar.gz: 4c9825057793fa28ad9970a73ed2c68cae76f41a
 SHA512:
-  metadata.gz: fee27eccf19e051b3972975e4531de705ec5a20e517410994d3cc36d088d1e1fb3b9f06fa1a581930b1345b08be3793c01b432bfbf89fd33f608ca519170dd10
-  data.tar.gz: 90dc1b48b44b42504feb9d26b2aa0ebc39ff7acc7d2af648b818b0b1edcf71d8372ff1d0b2dca78c4ad27d6e7f08f15105f14a046ff08b0270e1338c4ed3bfb2
+  metadata.gz: 967db7d75cd976e2aa3ebe6413a9063eba44e7a418892c5565837f0a96b83ba449829fbfff57a9cf53b4bdc521357edf51025280135770e6f535b892c162db62
+  data.tar.gz: 7cf0feb214e120c58df7d33468bd27c156182f6f2e72fe142249258f64ca796a92b73fea2d277227e49b134166b56070788fc3ae870fb69bac94de0b2967b335

data/README.md

@@ -22,12 +22,14 @@ Gergich publishes the review to Gerrit.
 ## Limitations
 
 Because everything is synchronized/stored in a local sqlite db, you
-should only call Gergich from a single box/build per patchset. Gergich
-does a check when publishing to ensure he hasn't already posted on this
-patchset before; if he has, publish will be a no-op. This protects
-against reposts (say, on a retrigger), but it does mean that you shouldn't
-have completely different builds posting Gergich comments on the same
-revision, unless you set up different credentials for each.
+should only call Gergich from a single box/build per patchset unless you
+have a unique `GERGICH_COMMENT_PREFIX` set for each box/build per patchset.
+Gergich does a check when publishing to ensure he hasn't already posted on
+this patchset before (w/ the same `GERGICH_COMMENT_PREFIX`); if he has,
+publish will be a no-op. This protects against reposts (say, on a retrigger),
+but it does mean that you shouldn't have completely different builds posting
+Gergich comments on the same revision, unless you set up different
+credentials for each.
 
 ## Installation
 

data/bin/run_tests.sh

@@ -35,17 +35,21 @@ run_command bundle exec rubocop
 export COVERAGE=1
 
 run_command bundle exec rspec
-run_command bin/gergich citest
-run_command bin/master_bouncer check
-DRY_RUN=1 run_command bin/master_bouncer check_all
 
-# ensure gergich works without .git directories
-rm -rf .git
-run_command bin/gergich status
+# these actually hit gerrit; only run them in CI land (you can do it
+# locally if you set all the docker-compose env vars)
+if [[ "$GERRIT_PATCHSET_REVISION" ]]; then
+  run_command bin/gergich citest
+  run_command bin/master_bouncer check
+  DRY_RUN=1 run_command bin/master_bouncer check_all
+  # ensure gergich works without .git directories
+  rm -rf .git
+  run_command bin/gergich status
+fi
 
 run_command bin/check_coverage
 
-if [[ $GEMNASIUM_TOKEN && $GEMNASIUM_ENABLED ]]; then
+if [[ "$GEMNASIUM_TOKEN" && "$GEMNASIUM_ENABLED" ]]; then
   # Push our dependency specification files to gemnasium for analysis
   run_command gemnasium dependency_files push -f=gergich.gemspec
 fi

data/lib/gergich.rb

@@ -42,7 +42,10 @@ module Gergich
           change_id = ENV["GERRIT_CHANGE_ID"] \
             || raise(GergichError, "No .git directory, and GERRIT_CHANGE_ID not set")
         end
-        { revision_id: revision_id, change_id: change_id }
+        project = ENV["GERRIT_PROJECT"]
+        branch = ENV["GERRIT_BRANCH"]
+
+        { revision_id: revision_id, change_id: change_id, project: project, branch: branch }
       end
     end
 
@@ -65,14 +68,22 @@ module Gergich
 
     def revision_number
       @revision_number ||= begin
+        patchset_number = ENV["GERRIT_PATCHSET_NUMBER"]
+        return patchset_number unless patchset_number.nil?
+
         gerrit_info = API.get("/changes/?q=#{change_id}&o=ALL_REVISIONS")[0]
         raise GergichError, "Gerrit patchset not found" unless gerrit_info
+
         gerrit_info["revisions"][revision_id]["_number"]
       end
     end
 
     def change_id
-      info[:change_id]
+      if info[:project] && info[:branch]
+        "#{info[:project]}~#{info[:branch]}~#{info[:change_id]}"
+      else
+        info[:change_id]
+      end
     end
   end
 
@@ -87,10 +98,8 @@ module Gergich
     # Public: publish all draft comments/labels/messages
     def publish!(allow_repost = false)
       # only publish if we have something to say or if our last score was negative
-      return unless anything_to_publish? || previous_score_negative?
+      return unless anything_to_publish?
 
-      # TODO: rather than just bailing, fetch the comments and only post
-      # ones that don't exist (if any)
       return if already_commented? && !allow_repost
 
       API.post(generate_url, generate_payload)
@@ -109,8 +118,24 @@ module Gergich
 
     def anything_to_publish?
       !review_info[:comments].empty? ||
-        !review_info[:cover_message].empty? ||
-        review_info[:labels].any? { |_, score| score != 0 }
+        !review_info[:cover_message_parts].empty? ||
+        new_score?
+    end
+
+    def new_score?
+      if current_label_is_for_current_revision?
+        review_info[:score] < current_score.to_i
+      else
+        true
+      end
+    end
+
+    def upcoming_score
+      if current_label_is_for_current_revision?
+        [current_score.to_i, review_info[:score]].min
+      else
+        review_info[:score]
+      end
     end
 
     # Public: show the current draft for this patchset
@@ -133,7 +158,7 @@ module Gergich
 
       puts
       puts "Cover Message:"
-      puts review_info[:cover_message]
+      puts cover_message
 
       return if review_info[:comments].empty?
 
@@ -148,24 +173,28 @@ module Gergich
       end
     end
 
-    def previous_score
-      last_message = my_messages
-        .sort_by { |message| message["date"] }
-        .last
-
-      text = last_message && last_message["message"] || ""
-      text =~ /^-[12]/
-
-      ($& || "").to_i
+    def multi_build_setup?
+      # convert to boolean if this variable exists or not
+      !ENV["GERGICH_COMMENT_PREFIX"].nil?
     end
 
-    def previous_score_negative?
-      previous_score < 0
+    def unique_comment_prefix
+      ENV["GERGICH_COMMENT_PREFIX"]
     end
 
     def already_commented?
+      if multi_build_setup?
+        my_messages_on_current_revision.any? do |message|
+          message["message"] =~ /^#{unique_comment_prefix}/
+        end
+      else
+        my_messages_on_current_revision.any?
+      end
+    end
+
+    def my_messages_on_current_revision
       revision_number = commit.revision_number
-      my_messages.any? { |message| message["_revision_number"] == revision_number }
+      my_messages.select { |message| message["_revision_number"] == revision_number }
     end
 
     def my_messages
@@ -173,6 +202,61 @@ module Gergich
         .select { |message| message["author"] && message["author"]["username"] == GERGICH_USER }
     end
 
+    # currently, cover message only supports the GERGICH_REVIEW_LABEL.
+    # i.e., even if gergich has "Code-Review: -2"
+    def current_label
+      @current_label ||= begin
+        API.get("/changes/#{commit.change_id}/detail")["labels"]
+          .fetch(GERGICH_REVIEW_LABEL, {})
+          .fetch("all", [])
+          .select { |label| label["username"] == GERGICH_USER }
+          .first
+      end
+    end
+
+    def current_label_date
+      @current_label_date ||= current_label && current_label["date"]
+    end
+
+    # unfortunately, the revision is not a field in the label json.
+    # however, we can match the label timestamp w/ one of our comment timestamps,
+    # then grab the comment's revision.
+    def current_label_revision
+      @current_label_revision ||= begin
+        date = current_label_date
+        comment_for_current_label = my_messages.find { |message| message["date"] == date } ||
+                                    my_messages.last
+        comment_for_current_label["_revision_number"]
+      end
+    end
+
+    def current_label_is_for_current_revision?
+      return false unless current_label
+      current_label_revision == commit.revision_number
+    end
+
+    def current_score
+      current_label && current_label["value"] || 0
+    end
+
+    def cover_message
+      parts = review_info[:cover_message_parts]
+      prefix = cover_message_prefix
+      parts.unshift prefix if prefix != ""
+      parts.join("\n\n")
+    end
+
+    def cover_message_prefix
+      score = upcoming_score
+      prefix_parts = []
+      prefix_parts << unique_comment_prefix if multi_build_setup?
+      prefix_parts << score if score < 0
+      prefix_parts.join(":")
+      # [].join(":") => ""
+      # [-2].join(":") => "-2"
+      # ["some build prefix", -2].join(":") => "some build prefix:-2"
+    end
+
     def whats_his_face
       "#{%w[Garry Larry Terry Jerry].sample} Gergich (Bot)"
     end
@@ -187,7 +271,7 @@ module Gergich
 
     def generate_payload
       {
-        message: review_info[:cover_message],
+        message: cover_message,
         labels: review_info[:labels],
         comments: review_info[:comments],
         # we don't want the post to fail if another
@@ -434,7 +518,7 @@ module Gergich
 
         {
           comments: comments,
-          cover_message: cover_message,
+          cover_message_parts: cover_message_parts,
           total_comments: all_comments.map(&:count).inject(&:+),
           score: labels[GERGICH_REVIEW_LABEL],
           labels: labels
@@ -464,13 +548,10 @@ module Gergich
       message
     end
 
-    def cover_message
-      score = labels[GERGICH_REVIEW_LABEL]
+    def cover_message_parts
       parts = messages
-      parts.unshift score.to_s if score < 0
-
       parts << orphaned_message unless other_comments.empty?
-      parts.join("\n\n")
+      parts
     end
   end
 

data/lib/gergich/cli/master_bouncer.rb

@@ -42,15 +42,15 @@ def maybe_bounce_commit!(commit)
   end
 
   review = Gergich::Review.new(commit, draft)
-  previous_score = review.previous_score
+  current_score = review.current_score
 
-  puts "#{detail}, " + (score == previous_score ?
+  puts "#{detail}, " + (score == current_score ?
                         "score still #{score}" :
-                        "changing score from #{previous_score} to #{score}")
+                        "changing score from #{current_score} to #{score}")
 
   # since we run on a daily cron, we might be checking the same patchset
   # many times, so bail if nothing has changed
-  return if score == previous_score
+  return if score == current_score
 
   draft.add_label MASTER_BOUNCER_REVIEW_LABEL, score
   draft.add_message message if message

data/spec/gergich_spec.rb

@@ -8,6 +8,8 @@ RSpec.describe Gergich::API do
     end
 
     it "provides helpful error when Change-Id not found" do
+      # Get ride of CI_TEST_RUN environment variable so the api preforms normally
+      ENV["CI_TEST_RUN"] = nil
       expect { described_class.get("/a/changes/1234") }
         .to raise_error(/Cannot find Change-Id: 1234/)
     end
@@ -90,23 +92,29 @@ RSpec.describe Gergich::Draft do
       end
     end
 
-    describe "[:cover_message]" do
-      subject { super()[:cover_message] }
+    describe "[:cover_message_parts]" do
+      subject { super()[:cover_message_parts] }
+      let(:message_1) { "this is good" }
+      let(:message_2) { "loljk it's terrible" }
 
-      it "includes the Code-Review score if negative" do
-        draft.add_label "Code-Review", -1
-        expect(subject).to match(/^-1/)
-      end
+      it "includes explicitly added messages" do
+        draft.add_message message_1
+        draft.add_message message_2
 
-      it "doesn't include the score if not negative" do
-        draft.add_label "Code-Review", 0
-        expect(subject).to_not match(/^0/)
+        expect(subject).to include(message_1)
+        expect(subject).to include(message_2)
       end
 
-      it "includes explicitly added messages" do
-        draft.add_message "this is good"
-        draft.add_message "loljk it's terrible"
-        expect(subject).to include("this is good\n\nloljk it's terrible")
+      context "orphaned file comments exist" do
+        let(:orphaned_comment) { "fix invalid" }
+
+        before :each do
+          draft.add_comment "invalid.rb", 1, orphaned_comment, "info"
+        end
+
+        it "includes orphan file message" do
+          expect(subject.first).to match(/#{orphaned_comment}/)
+        end
       end
     end
 
@@ -182,3 +190,133 @@ RSpec.describe Gergich::Draft do
     end
   end
 end
+
+RSpec.describe Gergich::Review do
+  let!(:commit) do
+    double(
+      :commit,
+      files: [
+        "foo.rb",
+        "bar/baz.lol"
+      ],
+      revision_id: "test",
+      revision_number: 1,
+      change_id: "test"
+    )
+  end
+  let!(:draft) do
+    Gergich::Draft.new commit
+  end
+  let!(:review) { described_class.new(commit, draft) }
+
+  after do
+    draft.reset!
+  end
+
+  describe "#publish!" do
+    context "nothing to publish" do
+      before :each do
+        allow(review).to receive(:anything_to_publish?).and_return(false)
+      end
+
+      it "does nothing" do
+        expect(Gergich::API).not_to receive(:post)
+
+        review.publish!
+      end
+    end
+
+    context "something to publish" do
+      before :each do
+        allow(review).to receive(:anything_to_publish?).and_return(true)
+        allow(review).to receive(:already_commented?).and_return(false)
+        allow(review).to receive(:generate_payload).and_return({})
+      end
+
+      it "publishes via the api" do
+        expect(Gergich::API).to receive(:post)
+        allow(review).to receive(:change_name?).and_return(false)
+        review.publish!
+      end
+    end
+  end
+
+  describe "#anything_to_publish?" do
+    before :each do
+      allow(review).to receive(:current_label).and_return("BAHA")
+      allow(review).to receive(:current_label_revision).and_return("Revision trash stuff")
+    end
+
+    context "no comments exist" do
+      it "returns false" do
+        allow(review).to receive(:new_score?).and_return(false)
+        expect(review.anything_to_publish?).to eq false
+      end
+    end
+
+    context "comments exist" do
+      it "returns true" do
+        draft.info[:comments] = "Hello there this is a comment"
+        expect(review.anything_to_publish?).to eq true
+      end
+    end
+  end
+
+  describe "#new_score?" do
+    before :each do
+      allow(review).to receive(:current_label_is_for_current_revision?).and_return(true)
+      allow(review).to receive(:current_score).and_return(0)
+    end
+
+    context "score is the same" do
+      it "returns false" do
+        draft.info[:score] = 0
+        expect(review.new_score?).to eq false
+      end
+    end
+
+    context "score is different" do
+      it "returns true" do
+        draft.info[:score] = -1
+        expect(review.new_score?).to eq true
+      end
+    end
+  end
+
+  describe "#upcoming_score" do
+    context "current_label_is_for_current_revision? is true" do
+      it "Should return the min value of draft.info[:score] and current_score" do
+        allow(review).to receive(:current_label_is_for_current_revision?).and_return(true)
+        allow(review).to receive(:current_score).and_return(0)
+        review.draft.info[:score] = 1
+        expect(review.upcoming_score).to eq 0
+      end
+    end
+
+    context "current_label_is_for_current_revision? is false" do
+      it "Should return the value of draft.info[:score]" do
+        allow(review).to receive(:current_label_is_for_current_revision?).and_return(false)
+        review.draft.info[:score] = 1
+        expect(review.upcoming_score).to eq 1
+      end
+    end
+  end
+
+  describe "#cover_message" do
+    context "score is negative" do
+      it "includes the Code-Review score if negative" do
+        allow(review).to receive(:upcoming_score).and_return(-1)
+        review.draft.add_label "Code-Review", -1
+        expect(review.cover_message).to match(/^-1/)
+      end
+    end
+
+    context "score is non-negative" do
+      it "doesn't include the score if not negative" do
+        allow(review).to receive(:upcoming_score).and_return(0)
+        draft.add_label "Code-Review", 0
+        expect(subject).to_not match(/^0/)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gergich
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - Jon Jensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Command-line tool for adding Gerrit comments